Struct RentedSeStringBuilder
Provides a temporarily rented Lumina.Text.SeStringBuilder from a shared pool.
Assembly: Dalamud.dll​
public readonly struct RentedSeStringBuilder : IResettable, IDisposable
Implements:
Microsoft.Extensions.ObjectPool.IResettable, System.IDisposable
Properties​
Builder​
Gets the rented Lumina.Text.SeStringBuilder value from the shared pool.
public SeStringBuilder Builder { get; }
Methods​
Dispose()​
Returns the rented Lumina.Text.SeStringBuilder to the shared pool.
public void Dispose()
BeginMacro(MacroCode)​
Begins a macro.
public SeStringBuilder BeginMacro(MacroCode macroCode)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.Payloads.MacroCode | macroCode | The macro code. |
EndMacro()​
Ends a macro.
public SeStringBuilder EndMacro()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
AbortMacro()​
Aborts a macro build by discarding the current macro data and exiting the macro scope.
public SeStringBuilder AbortMacro()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
Clear(bool)​
Clears everything.
public SeStringBuilder Clear(bool zeroBuffer = false)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the clear operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Boolean | zeroBuffer | Whether to fill the underlying buffer with zeroes. |
GetViewAsMemory()​
Gets the view of SeString being built.
public ReadOnlyMemory<byte> GetViewAsMemory()
Returns​
System.ReadOnlyMemory<System.Byte>: View of the SeString being built.
Remarks​
<p>Returned view is invalidated upon any mutation to this builder, including Lumina.Text.SeStringBuilder.Clear(System.Boolean) and Lumina.Text.SeStringBuilder.Append(System.String). If
Lumina.Text.SeStringBuilder.SharedPool is being used, then returning to the pool also will invalidate the returned view.</p>
<p>After the last element (right after the end of the returned memory/span), NUL is present. You can pin the returned value and use the pointer
to the first element as a pointer to null-terminated string.</p>
GetViewAsSpan()​
Gets the view of SeString being built.
public ReadOnlySpan<byte> GetViewAsSpan()
Returns​
System.ReadOnlySpan<System.Byte>: View of the SeString being built.
Remarks​
<p>Returned view is invalidated upon any mutation to this builder, including Lumina.Text.SeStringBuilder.Clear(System.Boolean) and Lumina.Text.SeStringBuilder.Append(System.String). If
Lumina.Text.SeStringBuilder.SharedPool is being used, then returning to the pool also will invalidate the returned view.</p>
<p>After the last element (right after the end of the returned memory/span), NUL is present. You can pin the returned value and use the pointer
to the first element as a pointer to null-terminated string.</p>
ToArray()​
Gets the SeString as a new byte array.
public byte[] ToArray()
Returns​
System.Byte[]: A new byte array.
Remarks​
If the created value does not escape the code scope this function is being called, consider using Lumina.Text.SeStringBuilder.GetViewAsMemory or
Lumina.Text.SeStringBuilder.GetViewAsSpan.
ToReadOnlySeString()​
Gets the SeString as a new instance of Lumina.Text.ReadOnly.ReadOnlySeString.
public ReadOnlySeString ToReadOnlySeString()
Returns​
Lumina.Text.ReadOnly.ReadOnlySeString: A new instance of Lumina.Text.ReadOnly.ReadOnlySeString.
Remarks​
If the created value does not escape the code scope this function is being called, consider using Lumina.Text.SeStringBuilder.GetViewAsMemory or
Lumina.Text.SeStringBuilder.GetViewAsSpan.
TryReset()​
Reset the object to a neutral state, semantically similar to when the object was first constructed.
public bool TryReset()
Returns​
System.Boolean: true if the object was able to reset itself, otherwise false.
Remarks​
In general, this method is not expected to be thread-safe.
Append(ReadOnlySpan<char>)​
Adds the given UTF-16 char sequence.
public SeStringBuilder Append(ReadOnlySpan<char> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Char> | value | Text to add. |
Append(Span<char>)​
Adds the given UTF-16 char sequence.
public SeStringBuilder Append(Span<char> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Span<System.Char> | value | Text to add. |
Append(ReadOnlyMemory<char>)​
Adds the given UTF-16 char sequence.
public SeStringBuilder Append(ReadOnlyMemory<char> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlyMemory<System.Char> | value | Text to add. |
Append(Memory<char>)​
Adds the given UTF-16 char sequence.
public SeStringBuilder Append(Memory<char> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Memory<System.Char> | value | Text to add. |
Append(char[])​
Adds the given UTF-16 char sequence.
public SeStringBuilder Append(char[] value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Char[] | value | Text to add. |
Append(char[], int, int)​
Adds the given UTF-16 char sequence.
public SeStringBuilder Append(char[] value, int startIndex, int count)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Char[] | value | Text to add. |
System.Int32 | startIndex | The starting position of the substring within <code class="paramref">value</code>. |
System.Int32 | count | The number of characters in <code class="paramref">value</code> to append. |
Append(string?)​
Adds the given UTF-16 char sequence.
public SeStringBuilder Append(string? value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.String | value | Text to add. |
Append(string?, int, int)​
Adds the given UTF-16 char sequence.
public SeStringBuilder Append(string? value, int startIndex, int count)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.String | value | Text to add. |
System.Int32 | startIndex | The starting position of the substring within <code class="paramref">value</code>. |
System.Int32 | count | The number of characters in <code class="paramref">value</code> to append. |
Append(SeStringInterpolatedStringHandler)​
Adds the specified interpolated string.
public SeStringBuilder Append(SeStringBuilder.SeStringInterpolatedStringHandler handler)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.SeStringBuilder.SeStringInterpolatedStringHandler | handler | Interpolated string to append. |
Append(IFormatProvider?, SeStringInterpolatedStringHandler)​
Adds the specified interpolated string.
public SeStringBuilder Append(IFormatProvider? provider, SeStringBuilder.SeStringInterpolatedStringHandler handler)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | An object that supplies culture-specific formatting information. |
Lumina.Text.SeStringBuilder.SeStringInterpolatedStringHandler | handler | Interpolated string to append. |
Append(ReadOnlySpan<byte>)​
Adds the given UTF-8 byte sequence.
public SeStringBuilder Append(ReadOnlySpan<byte> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Byte> | value | Text to add. |
Append(Span<byte>)​
Adds the given UTF-8 byte sequence.
public SeStringBuilder Append(Span<byte> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Span<System.Byte> | value | Text to add. |
Append(ReadOnlyMemory<byte>)​
Adds the given UTF-8 byte sequence.
public SeStringBuilder Append(ReadOnlyMemory<byte> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlyMemory<System.Byte> | value | Text to add. |
Append(Memory<byte>)​
Adds the given UTF-8 byte sequence.
public SeStringBuilder Append(Memory<byte> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Memory<System.Byte> | value | Text to add. |
Append(byte[])​
Adds the given UTF-8 byte sequence.
public SeStringBuilder Append(byte[] value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte[] | value | Text to add. |
Append(byte[], int, int)​
Adds the given UTF-8 byte sequence.
public SeStringBuilder Append(byte[] value, int startIndex, int count)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte[] | value | Text to add. |
System.Int32 | startIndex | The starting position of the substring within <code class="paramref">value</code>. |
System.Int32 | count | The number of characters in <code class="paramref">value</code> to append. |
Append(StringBuilder)​
Adds the given SeString from the given StringBuilder.
public SeStringBuilder Append(StringBuilder value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Text.StringBuilder | value | The string builder that contains the substring to append. |
Append(StringBuilder, int, int)​
Adds the given SeString from the given StringBuilder.
public SeStringBuilder Append(StringBuilder value, int startIndex, int count)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Text.StringBuilder | value | The string builder that contains the substring to append. |
System.Int32 | startIndex | The starting position of the substring within <code class="paramref">value</code>. |
System.Int32 | count | The number of characters in <code class="paramref">value</code> to append. |
Append(ReadOnlySeString)​
Adds the given SeString.
public SeStringBuilder Append(ReadOnlySeString value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeString | value | Text to add. |
Append(ReadOnlySeStringSpan)​
Adds the given SeString.
public SeStringBuilder Append(ReadOnlySeStringSpan value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeStringSpan | value | Text to add. |
Append(ReadOnlySePayload)​
Adds the given SeString payload, wrapping in envelope as needed.
public SeStringBuilder Append(ReadOnlySePayload value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayload | value | Payload to add. |
Append(ReadOnlySePayloadSpan)​
Adds the given SeString payload, wrapping in envelope as needed.
public SeStringBuilder Append(ReadOnlySePayloadSpan value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayloadSpan | value | Payload to add. |
Append(scoped in UtfEnumerator)​
Appends the yielded characters from a Lumina.Text.UtfEnumerator.
public SeStringBuilder Append(scoped in UtfEnumerator enumerator)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.UtfEnumerator | enumerator | Enumerator to append text from. |
AppendChar(int)​
Adds the given character, or System.Text.Rune.ReplacementChar if the value is not valid.
public SeStringBuilder AppendChar(int codepoint)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | codepoint | Character to add. |
AppendChar(uint)​
Adds the given character.
public SeStringBuilder AppendChar(uint codepoint)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | codepoint | Character to add. |
AppendMacroString(ReadOnlySpan<byte>, scoped in MacroStringParseOptions)​
Adds the given value after parsing it as a macro string.
public SeStringBuilder AppendMacroString(ReadOnlySpan<byte> value, scoped in MacroStringParseOptions parseOptions = default)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Byte> | value | String to parse and add. |
Lumina.Text.Parse.MacroStringParseOptions | parseOptions | Parse options for . Defaults to interpreting <code class="paramref">value</code> as UTF-8. |
AppendMacroString(ReadOnlySpan<char>, scoped in MacroStringParseOptions)​
Adds the given value after parsing it as a macro string.
public SeStringBuilder AppendMacroString(ReadOnlySpan<char> value, scoped in MacroStringParseOptions parseOptions = default)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Char> | value | String to parse and add. |
Lumina.Text.Parse.MacroStringParseOptions | parseOptions | Parse options for . Defaults to interpreting <code class="paramref">value</code> as UTF-16. |
AppendLine(ReadOnlySpan<char>)​
Adds the given UTF-16 char sequence and a line break.
public SeStringBuilder AppendLine(ReadOnlySpan<char> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Char> | value | Text to add. |
AppendLine(Span<char>)​
Adds the given UTF-16 char sequence and a line break.
public SeStringBuilder AppendLine(Span<char> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Span<System.Char> | value | Text to add. |
AppendLine(ReadOnlyMemory<char>)​
Adds the given UTF-16 char sequence and a line break.
public SeStringBuilder AppendLine(ReadOnlyMemory<char> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlyMemory<System.Char> | value | Text to add. |
AppendLine(Memory<char>)​
Adds the given UTF-16 char sequence and a line break.
public SeStringBuilder AppendLine(Memory<char> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Memory<System.Char> | value | Text to add. |
AppendLine(char[])​
Adds the given UTF-16 char sequence and a line break.
public SeStringBuilder AppendLine(char[] value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Char[] | value | Text to add. |
AppendLine(char[], int, int)​
Adds the given UTF-16 char sequence and a line break.
public SeStringBuilder AppendLine(char[] value, int startIndex, int count)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Char[] | value | Text to add. |
System.Int32 | startIndex | The starting position of the substring within <code class="paramref">value</code>. |
System.Int32 | count | The number of characters in <code class="paramref">value</code> to append. |
AppendLine(string?)​
Adds the given UTF-16 char sequence and a line break.
public SeStringBuilder AppendLine(string? value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.String | value | Text to add. |
AppendLine(string?, int, int)​
Adds the given UTF-16 char sequence and a line break.
public SeStringBuilder AppendLine(string? value, int startIndex, int count)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.String | value | Text to add. |
System.Int32 | startIndex | The starting position of the substring within <code class="paramref">value</code>. |
System.Int32 | count | The number of characters in <code class="paramref">value</code> to append. |
AppendLine(SeStringInterpolatedStringHandler)​
Adds the specified interpolated string.
public SeStringBuilder AppendLine(SeStringBuilder.SeStringInterpolatedStringHandler handler)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.SeStringBuilder.SeStringInterpolatedStringHandler | handler | Interpolated string to append. |
AppendLine(IFormatProvider?, SeStringInterpolatedStringHandler)​
Adds the specified interpolated string.
public SeStringBuilder AppendLine(IFormatProvider? provider, SeStringBuilder.SeStringInterpolatedStringHandler handler)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.IFormatProvider | provider | An object that supplies culture-specific formatting information. |
Lumina.Text.SeStringBuilder.SeStringInterpolatedStringHandler | handler | Interpolated string to append. |
AppendLine(ReadOnlySpan<byte>)​
Adds the given UTF-8 byte sequence and a line break.
public SeStringBuilder AppendLine(ReadOnlySpan<byte> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Byte> | value | Text to add. |
AppendLine(Span<byte>)​
Adds the given UTF-8 byte sequence and a line break.
public SeStringBuilder AppendLine(Span<byte> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Span<System.Byte> | value | Text to add. |
AppendLine(ReadOnlyMemory<byte>)​
Adds the given UTF-8 byte sequence and a line break.
public SeStringBuilder AppendLine(ReadOnlyMemory<byte> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlyMemory<System.Byte> | value | Text to add. |
AppendLine(Memory<byte>)​
Adds the given UTF-8 byte sequence and a line break.
public SeStringBuilder AppendLine(Memory<byte> value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Memory<System.Byte> | value | Text to add. |
AppendLine(byte[])​
Adds the given UTF-8 byte sequence and a line break.
public SeStringBuilder AppendLine(byte[] value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte[] | value | Text to add. |
AppendLine(byte[], int, int)​
Adds the given UTF-8 byte sequence and a line break.
public SeStringBuilder AppendLine(byte[] value, int startIndex, int count)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte[] | value | Text to add. |
System.Int32 | startIndex | The starting position of the substring within <code class="paramref">value</code>. |
System.Int32 | count | The number of characters in <code class="paramref">value</code> to append. |
AppendLine(StringBuilder)​
Adds the given SeString from the given StringBuilder and a line break.
public SeStringBuilder AppendLine(StringBuilder value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Text.StringBuilder | value | The string builder that contains the substring to append. |
AppendLine(StringBuilder, int, int)​
Adds the given SeString from the given StringBuilder and a line break.
public SeStringBuilder AppendLine(StringBuilder value, int startIndex, int count)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Text.StringBuilder | value | The string builder that contains the substring to append. |
System.Int32 | startIndex | The starting position of the substring within <code class="paramref">value</code>. |
System.Int32 | count | The number of characters in <code class="paramref">value</code> to append. |
AppendLine(ReadOnlySeString)​
Adds the given SeString and a line break.
public SeStringBuilder AppendLine(ReadOnlySeString value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeString | value | Text to add. |
AppendLine(ReadOnlySePayload)​
Adds the given SeString payload, wrapping in envelope as needed, and a line break.
public SeStringBuilder AppendLine(ReadOnlySePayload value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayload | value | Payload to add. |
AppendLine(ReadOnlySePayloadSpan)​
Adds the given SeString payload, wrapping in envelope as needed, and a line break.
public SeStringBuilder AppendLine(ReadOnlySePayloadSpan value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayloadSpan | value | Payload to add. |
AppendLine(ReadOnlySeStringSpan)​
Adds the given SeString and a line break.
public SeStringBuilder AppendLine(ReadOnlySeStringSpan value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeStringSpan | value | Text to add. |
AppendLine(object?)​
Adds the given value and a line break.
public SeStringBuilder AppendLine(object? value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Object | value | Value to add. |
AppendLine<T>(scoped in T)​
Adds the given value and a line break.
public SeStringBuilder AppendLine<T>(scoped in T value) where T : struct
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
<T> | value | Value to add. |
Type Parameters​
T
Append(Rune)​
Adds the given character.
public SeStringBuilder Append(Rune rune)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Text.Rune | rune | Character to add. |
Append(Rune, int)​
Adds the given character.
public SeStringBuilder Append(Rune rune, int repeatCount)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Text.Rune | rune | Character to add. |
System.Int32 | repeatCount | Number of times to append <code class="paramref">rune</code>. |
Append(UtfValue)​
Adds the given System.Text.Rune, or System.Text.Rune.ReplacementChar if the value is not valid.
public SeStringBuilder Append(UtfValue utfValue)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.UtfValue | utfValue | Character to add. |
Append(scoped in Subsequence)​
Adds the given character.
public SeStringBuilder Append(scoped in UtfEnumerator.Subsequence subsequence)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.UtfEnumerator.Subsequence | subsequence | Character to add. |
Append(bool)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(bool value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Boolean | value | Value to add. |
Append(char)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(char value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Char | value | Value to add. |
Append(byte)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(byte value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | value | Value to add. |
Append(ushort)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(ushort value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt16 | value | Value to add. |
Append(uint)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(uint value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | value | Value to add. |
Append(ulong)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(ulong value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt64 | value | Value to add. |
Append(nuint)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(nuint value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UIntPtr | value | Value to add. |
Append(sbyte)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(sbyte value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.SByte | value | Value to add. |
Append(short)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(short value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int16 | value | Value to add. |
Append(int)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(int value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | value | Value to add. |
Append(long)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(long value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int64 | value | Value to add. |
Append(nint)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(nint value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.IntPtr | value | Value to add. |
Append(void*)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(void* value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Void* | value | Value to add. |
Append(Half)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(Half value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Half | value | Value to add. |
Append(float)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(float value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Single | value | Value to add. |
Append(double)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(double value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Double | value | Value to add. |
Append(scoped in decimal)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(scoped in decimal value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Decimal | value | Value to add. |
Append(scoped in BigInteger)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(scoped in BigInteger value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.BigInteger | value | Value to add. |
Append(DateOnly)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(DateOnly value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.DateOnly | value | Value to add. |
Append(TimeOnly)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(TimeOnly value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.TimeOnly | value | Value to add. |
Append(TimeSpan)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(TimeSpan value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.TimeSpan | value | Value to add. |
Append(DateTime)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(DateTime value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.DateTime | value | Value to add. |
Append(DateTimeOffset)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(DateTimeOffset value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.DateTimeOffset | value | Value to add. |
Append(scoped in Version)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(scoped in Version value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Version | value | Value to add. |
Append(scoped in Complex)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(scoped in Complex value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Complex | value | Value to add. |
Append(scoped in UInt128)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(scoped in UInt128 value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt128 | value | Value to add. |
Append(scoped in Int128)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(scoped in Int128 value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int128 | value | Value to add. |
Append(IPAddress)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(IPAddress value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Net.IPAddress | value | Value to add. |
Append(IPNetwork)​
Adds the string representation of a <code class="paramref">value</code> to this instance.
public SeStringBuilder Append(IPNetwork value)
Returns​
Lumina.Text.SeStringBuilder: A reference to this instance after the append operation has completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Net.IPNetwork | value | Value to add. |
Append(object?)​
Adds the given value.
public SeStringBuilder Append(object? value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Object | value | Value to add. |
Append<T>(scoped in T)​
Adds the given value.
public SeStringBuilder Append<T>(scoped in T value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
<T> | value | Value to add. |
Type Parameters​
T
AppendIntExpression(int)​
Appends an integer as an expression.
public SeStringBuilder AppendIntExpression(int value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | value | An integer value to append. |
AppendUIntExpression(uint)​
Appends an unsigned integer as an expression.
public SeStringBuilder AppendUIntExpression(uint value)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | value | An unsigned integer value to append. |
AppendNullaryExpression(ExpressionType)​
Appends a nullary expression.
public SeStringBuilder AppendNullaryExpression(ExpressionType expressionType)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.Expressions.ExpressionType | expressionType | A nullary expression type. |
BeginUnaryExpression(ExpressionType)​
Starts writing an unary expression.
public SeStringBuilder BeginUnaryExpression(ExpressionType expressionType)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.Expressions.ExpressionType | expressionType | An unary expression type. |
BeginBinaryExpression(ExpressionType)​
Starts writing a binary expression.
public SeStringBuilder BeginBinaryExpression(ExpressionType expressionType)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.Expressions.ExpressionType | expressionType | A binary expression type. |
ChangeBinaryExpression(ExpressionType)​
Changes the type of the binary expression being written.
public SeStringBuilder ChangeBinaryExpression(ExpressionType expressionType)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.Expressions.ExpressionType | expressionType | A binary expression type. |
BeginStringExpression()​
Starts writing a string expression.
public SeStringBuilder BeginStringExpression()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
EndExpression()​
Ends writing a unary, binary, or string expression.
public SeStringBuilder EndExpression()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
Remarks​
Use Lumina.Text.SeStringBuilder.AbortExpression to cancel writing this expression instead.
AbortExpression()​
Aborts an expression build by discarding the current expression data and exiting the expression scope.
public SeStringBuilder AbortExpression()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the operation is completed.
AppendLocalNumberExpression(int)​
Appends a local number unary expression.
public SeStringBuilder AppendLocalNumberExpression(int id)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | id | The value ID. |
AppendLocalStringExpression(int)​
Appends a local string unary expression.
public SeStringBuilder AppendLocalStringExpression(int id)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | id | The value ID. |
AppendGlobalNumberExpression(int)​
Appends a global number unary expression.
public SeStringBuilder AppendGlobalNumberExpression(int id)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | id | The value ID. |
AppendGlobalStringExpression(int)​
Appends a global string unary expression.
public SeStringBuilder AppendGlobalStringExpression(int id)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Int32 | id | The value ID. |
AppendStringExpression(ReadOnlySeStringSpan)​
Appends a string expression.
public SeStringBuilder AppendStringExpression(ReadOnlySeStringSpan rosss)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeStringSpan | rosss | The value. |
AppendStringExpression(ReadOnlySpan<char>)​
Appends a string expression.
public SeStringBuilder AppendStringExpression(ReadOnlySpan<char> str)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Char> | str | The value. |
AppendNewLine()​
Appends a line break.
public SeStringBuilder AppendNewLine()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
AppendIcon(uint)​
Appends an icon.
public SeStringBuilder AppendIcon(uint icon)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | icon | The icon ID. |
AppendItalicized(ReadOnlySeStringSpan)​
Appends an italicized text.
public SeStringBuilder AppendItalicized(ReadOnlySeStringSpan rosss)
Returns​
Lumina.Text.SeStringBuilder
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeStringSpan | rosss | The string to append italicized. |
AppendItalicized(ReadOnlySpan<char>)​
Appends an italicized text.
public SeStringBuilder AppendItalicized(ReadOnlySpan<char> str)
Returns​
Lumina.Text.SeStringBuilder
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Char> | str | The string to append italicized. |
AppendSetItalic(bool)​
Appends a payload to either turn italic on or off.
public SeStringBuilder AppendSetItalic(bool enable)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Boolean | enable | Whether to enable italics. |
AppendBold(ReadOnlySeStringSpan)​
Appends a bold text.
public SeStringBuilder AppendBold(ReadOnlySeStringSpan rosss)
Returns​
Lumina.Text.SeStringBuilder
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySeStringSpan | rosss | The string to append italicized. |
AppendBold(ReadOnlySpan<char>)​
Appends a bold text.
public SeStringBuilder AppendBold(ReadOnlySpan<char> str)
Returns​
Lumina.Text.SeStringBuilder
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Char> | str | The string to append italicized. |
AppendSetBold(bool)​
Appends a payload to either bold italic on or off.
public SeStringBuilder AppendSetBold(bool enable)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Boolean | enable | Whether to enable bold. |
PushLink(LinkMacroPayloadType, uint, uint, uint)​
Pushes a link.
public SeStringBuilder PushLink(LinkMacroPayloadType type, uint arg1, uint arg2, uint arg3)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.Payloads.LinkMacroPayloadType | type | Type of the link. |
System.UInt32 | arg1 | The 1st argument. |
System.UInt32 | arg2 | The 2nd argument. |
System.UInt32 | arg3 | The 3rd argument. |
Remarks​
Nested link can be done, but only the outermost link will be handled by the game, as of patch 6.58.
PushLink(LinkMacroPayloadType, uint, uint, uint, ReadOnlySeStringSpan)​
Pushes a link.
public SeStringBuilder PushLink(LinkMacroPayloadType type, uint arg1, uint arg2, uint arg3, ReadOnlySeStringSpan plainText)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.Payloads.LinkMacroPayloadType | type | Type of the link. |
System.UInt32 | arg1 | The 1st argument. |
System.UInt32 | arg2 | The 2nd argument. |
System.UInt32 | arg3 | The 3rd argument. |
Lumina.Text.ReadOnly.ReadOnlySeStringSpan | plainText | The optional plain text. |
Remarks​
Nested link can be done, but only the outermost link will be handled by the game, as of patch 6.58.
PushLink(LinkMacroPayloadType, uint, uint, uint, ReadOnlySpan<char>)​
Pushes a link.
public SeStringBuilder PushLink(LinkMacroPayloadType type, uint arg1, uint arg2, uint arg3, ReadOnlySpan<char> plainText)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
Lumina.Text.Payloads.LinkMacroPayloadType | type | Type of the link. |
System.UInt32 | arg1 | The 1st argument. |
System.UInt32 | arg2 | The 2nd argument. |
System.UInt32 | arg3 | The 3rd argument. |
System.ReadOnlySpan<System.Char> | plainText | The optional plain text. |
Remarks​
Nested link can be done, but only the outermost link will be handled by the game, as of patch 6.58.
PushLinkCharacter(ReadOnlySpan<char>, uint)​
Pushes a link to a character.
public SeStringBuilder PushLinkCharacter(ReadOnlySpan<char> characterName, uint worldId = 0)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.ReadOnlySpan<System.Char> | characterName | The name of the target player. |
System.UInt32 | worldId | Optional world ID. |
PushLinkItem(uint)​
Pushes a link to an item.
public SeStringBuilder PushLinkItem(uint itemId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | itemId | The item ID. |
PushLinkItem(uint, ReadOnlySpan<char>)​
Pushes a link to an item.
public SeStringBuilder PushLinkItem(uint itemId, ReadOnlySpan<char> plainText)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | itemId | The item ID. |
System.ReadOnlySpan<System.Char> | plainText | The item name that is copied to the clipboard. |
PushLinkMapPosition(uint, uint, int, int)​
Pushes a link to a map position.
public SeStringBuilder PushLinkMapPosition(uint territoryId, uint mapId, int rawX, int rawY)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | territoryId | The territory ID. |
System.UInt32 | mapId | The map ID. |
System.Int32 | rawX | The raw X coordinate. |
System.Int32 | rawY | The raw Y coordinate. |
PushLinkQuest(uint)​
Pushes a link to a quest.
public SeStringBuilder PushLinkQuest(uint questId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | questId | The quest ID. |
PushLinkAchievement(uint)​
Pushes a link to an achievement.
public SeStringBuilder PushLinkAchievement(uint achievementId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | achievementId | The achievement ID. |
PushLinkHowTo(uint)​
Pushes a link to a How-To entry.
public SeStringBuilder PushLinkHowTo(uint howToId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | howToId | The How-To entry ID. |
PushLinkPartyFinderNotification()​
Pushes a link to the party finder dialog.
public SeStringBuilder PushLinkPartyFinderNotification()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
PushLinkStatus(uint)​
Pushes a link to a status.
public SeStringBuilder PushLinkStatus(uint statusId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | statusId | The status ID. |
PushLinkPartyFinderCrossWorld(uint, uint)​
Pushes a link to a cross-world party finder listing entry.
public SeStringBuilder PushLinkPartyFinderCrossWorld(uint listingId, uint worldId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | listingId | The party finder listing ID. |
System.UInt32 | worldId | The party finder owner's world ID. |
PushLinkPartyFinder(uint)​
Pushes a link to a party finder listing entry.
public SeStringBuilder PushLinkPartyFinder(uint listingId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | listingId | The party finder listing ID. |
PushLinkAkatsukiNote(uint)​
Pushes a link to an AkatsukiNote entry.
public SeStringBuilder PushLinkAkatsukiNote(uint akatsukiNoteId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | akatsukiNoteId | The AkatsukiNote entry ID. |
PopLink()​
Pops a link.
public SeStringBuilder PopLink()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the pop operation is completed.
PushColorType(uint)​
Pushes a text foreground color from UIColor sheet.
public SeStringBuilder PushColorType(uint uiColorRowId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | uiColorRowId | The row ID in the UIColor sheet. Specifying 0 will pop the color. |
Remarks​
UIColor sheet contains color values as 0xRRGGBBAA (0xAA 0xBB 0xGG 0xRR), and should be treated as having ABGR pixel format. See RGB/BGR color model if the naming gets confusing.
PopColorType()​
Pops a text foreground color pushed with Lumina.Text.SeStringBuilder.PushColorType(System.UInt32).
public SeStringBuilder PopColorType()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the pop operation is completed.
PushEdgeColorType(uint)​
Pushes a text border color from UIColor sheet.
public SeStringBuilder PushEdgeColorType(uint uiColorRowId)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | uiColorRowId | The row ID in the UIColor sheet. Specifying 0 will pop the color. |
Remarks​
UIColor sheet contains color values as 0xRRGGBBAA (0xAA 0xBB 0xGG 0xRR), and should be treated as having ABGR pixel format. See RGB/BGR color model if the naming gets confusing.
PopEdgeColorType()​
Pops a text border color pushed with Lumina.Text.SeStringBuilder.PushEdgeColorType(System.UInt32).
public SeStringBuilder PopEdgeColorType()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the pop operation is completed.
AppendBgraIntExpressionFromRgba(Vector4)​
Appends a BGRA integer calculated from RGBA values as an expression.
public SeStringBuilder AppendBgraIntExpressionFromRgba(Vector4 rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector4 | rgba | A normalized RGBA System.Numerics.Vector4 value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
AppendBgraIntExpressionFromRgba(byte, byte, byte, byte)​
Appends a BGRA integer calculated from RGBA values as an expression.
public SeStringBuilder AppendBgraIntExpressionFromRgba(byte r, byte g, byte b, byte a)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | r | A red byte value to append. |
System.Byte | g | A green byte value to append. |
System.Byte | b | A blue byte value to append. |
System.Byte | a | A alpha byte value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
AppendBgraIntExpressionFromRgba(uint)​
Appends a BGRA integer calculated from RGBA values as an expression.
public SeStringBuilder AppendBgraIntExpressionFromRgba(uint rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | rgba | The RGBA color value, which is 0xAABBGGRR (0xRR 0xGG 0xBB 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
AppendBgraIntExpression(Vector4)​
Appends a BGRA integer calculated from BGRA values as an expression.
public SeStringBuilder AppendBgraIntExpression(Vector4 rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector4 | rgba | A normalized RGBA System.Numerics.Vector4 value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
AppendBgraIntExpression(byte, byte, byte, byte)​
Appends a BGRA integer calculated from BGRA values as an expression.
public SeStringBuilder AppendBgraIntExpression(byte b, byte g, byte r, byte a)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | b | A blue byte value to append. |
System.Byte | g | A green byte value to append. |
System.Byte | r | A red byte value to append. |
System.Byte | a | A alpha byte value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushColorBgra(byte, byte, byte, byte)​
Pushes a text foreground color.
public SeStringBuilder PushColorBgra(byte b, byte g, byte r, byte a)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | b | A blue byte value to append. |
System.Byte | g | A green byte value to append. |
System.Byte | r | A red byte value to append. |
System.Byte | a | A alpha byte value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushColorBgra(uint)​
Pushes a text foreground color.
public SeStringBuilder PushColorBgra(uint bgra)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | bgra | The BGRA color value, which is 0xAARRGGBB (0xBB 0xGG 0xRR 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushColorBgra(Vector4)​
Pushes a text foreground color.
public SeStringBuilder PushColorBgra(Vector4 bgra)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector4 | bgra | The BGRA color value, which is 0xAARRGGBB (0xBB 0xGG 0xRR 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushColorRgba(byte, byte, byte, byte)​
Pushes a text foreground color.
public SeStringBuilder PushColorRgba(byte r, byte g, byte b, byte a)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | r | A red byte value to append. |
System.Byte | g | A green byte value to append. |
System.Byte | b | A blue byte value to append. |
System.Byte | a | A alpha byte value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushColorRgba(uint)​
Pushes a text foreground color.
public SeStringBuilder PushColorRgba(uint rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | rgba | The RGBA color value, which is 0xAABBGGRR (0xRR 0xGG 0xBB 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushColorRgba(Vector4)​
Pushes a text foreground color.
public SeStringBuilder PushColorRgba(Vector4 rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector4 | rgba | The RGBA color value, which is 0xAABBGGRR (0xRR 0xGG 0xBB 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PopColor()​
Pops a text foreground color.
public SeStringBuilder PopColor()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the pop operation is completed.
PushEdgeColorBgra(byte, byte, byte, byte)​
Pushes a text edge color.
public SeStringBuilder PushEdgeColorBgra(byte b, byte g, byte r, byte a)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | b | A blue byte value to append. |
System.Byte | g | A green byte value to append. |
System.Byte | r | A red byte value to append. |
System.Byte | a | A alpha byte value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushEdgeColorBgra(uint)​
Pushes a text edge color.
public SeStringBuilder PushEdgeColorBgra(uint bgra)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | bgra | The BGRA color value, which is 0xAARRGGBB (0xBB 0xGG 0xRR 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushEdgeColorBgra(Vector4)​
Pushes a text edge color.
public SeStringBuilder PushEdgeColorBgra(Vector4 bgra)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector4 | bgra | The BGRA color value, which is 0xAARRGGBB (0xBB 0xGG 0xRR 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushEdgeColorRgba(byte, byte, byte, byte)​
Pushes a text edge color.
public SeStringBuilder PushEdgeColorRgba(byte r, byte g, byte b, byte a)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | r | A red byte value to append. |
System.Byte | g | A green byte value to append. |
System.Byte | b | A blue byte value to append. |
System.Byte | a | A alpha byte value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushEdgeColorRgba(uint)​
Pushes a text edge color.
public SeStringBuilder PushEdgeColorRgba(uint rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | rgba | The RGBA color value, which is 0xAABBGGRR (0xRR 0xGG 0xBB 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushEdgeColorRgba(Vector4)​
Pushes a text edge color.
public SeStringBuilder PushEdgeColorRgba(Vector4 rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector4 | rgba | The RGBA color value, which is 0xAABBGGRR (0xRR 0xGG 0xBB 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PopEdgeColor()​
Pops a text border color.
public SeStringBuilder PopEdgeColor()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the pop operation is completed.
PushShadowColorBgra(byte, byte, byte, byte)​
Pushes a text shadow color.
public SeStringBuilder PushShadowColorBgra(byte b, byte g, byte r, byte a)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | b | A blue byte value to append. |
System.Byte | g | A green byte value to append. |
System.Byte | r | A red byte value to append. |
System.Byte | a | A alpha byte value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushShadowColorBgra(uint)​
Pushes a text shadow color.
public SeStringBuilder PushShadowColorBgra(uint bgra)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | bgra | The BGRA color value, which is 0xAARRGGBB (0xBB 0xGG 0xRR 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushShadowColorBgra(Vector4)​
Pushes a text shadow color.
public SeStringBuilder PushShadowColorBgra(Vector4 bgra)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector4 | bgra | The BGRA color value, which is 0xAARRGGBB (0xBB 0xGG 0xRR 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushShadowColorRgba(byte, byte, byte, byte)​
Pushes a text shadow color.
public SeStringBuilder PushShadowColorRgba(byte r, byte g, byte b, byte a)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Byte | r | A red byte value to append. |
System.Byte | g | A green byte value to append. |
System.Byte | b | A blue byte value to append. |
System.Byte | a | A alpha byte value to append. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushShadowColorRgba(uint)​
Pushes a text shadow color.
public SeStringBuilder PushShadowColorRgba(uint rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.UInt32 | rgba | The RGBA color value, which is 0xAABBGGRR (0xRR 0xGG 0xBB 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PushShadowColorRgba(Vector4)​
Pushes a text shadow color.
public SeStringBuilder PushShadowColorRgba(Vector4 rgba)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the push operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
System.Numerics.Vector4 | rgba | The RGBA color value, which is 0xAABBGGRR (0xRR 0xGG 0xBB 0xAA) on Windows version. |
Remarks​
See RGB/BGR color model if the naming gets confusing.
PopShadowColor()​
Pops a text shadow color.
public SeStringBuilder PopShadowColor()
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the pop operation is completed.
AppendIcon(BitmapFontIcon)​
Appends an icon.
public SeStringBuilder AppendIcon(BitmapFontIcon icon)
Returns​
Lumina.Text.SeStringBuilder: A reference of this instance after the append operation is completed.
Parameters​
| Type | Name | Description |
|---|---|---|
| Dalamud.Game.Text.BitmapFontIcon | icon | The icon ID. |
Implements​
Microsoft.Extensions.ObjectPool.IResettableSystem.IDisposable