Class ReadOnlySePayloadSpanExtensions
Extension functions for Lumina.Text.ReadOnly.ReadOnlySePayloadSpan.
Assembly: Dalamud.dll
public static class ReadOnlySePayloadSpanExtensions
Methods
IsMacro(ReadOnlySePayloadSpan, MacroCode)
Determines whether the payload is a macro payload matching the specified macro code.
public static bool IsMacro(this ReadOnlySePayloadSpan payload, MacroCode macroCode)
Returns
System.Boolean: true if the payload is a macro matching <code class="paramref">macroCode</code>; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayloadSpan | payload | The payload span to evaluate. |
Lumina.Text.Payloads.MacroCode | macroCode | The macro code to check against. |
IsLink(ReadOnlySePayloadSpan, LinkMacroPayloadType)
Determines whether the payload is a link macro payload of the specified link type.
public static bool IsLink(this ReadOnlySePayloadSpan payload, LinkMacroPayloadType linkType)
Returns
System.Boolean: true if the payload is a link macro matching <code class="paramref">linkType</code>; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayloadSpan | payload | The payload span to evaluate. |
Lumina.Text.Payloads.LinkMacroPayloadType | linkType | The link macro type to check against. |
IsLinkTerminator(ReadOnlySePayloadSpan)
Determines whether the specified payload represents a link terminator.
public static bool IsLinkTerminator(this ReadOnlySePayloadSpan payload)
Returns
System.Boolean: true if the payload is a link terminator; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayloadSpan | payload | The payload to check. |
TryReadLink(ReadOnlySePayloadSpan, out LinkMacroPayloadType, out ReadOnlySeExpressionSpan, out ReadOnlySeExpressionSpan, out ReadOnlySeExpressionSpan, out ReadOnlySeExpressionSpan)
Attempts to read link parameters from the specified payload.
public static bool TryReadLink(this ReadOnlySePayloadSpan payload, out LinkMacroPayloadType linkType, out ReadOnlySeExpressionSpan expr1, out ReadOnlySeExpressionSpan expr2, out ReadOnlySeExpressionSpan expr3, out ReadOnlySeExpressionSpan expr4)
Returns
System.Boolean: true if the payload is a link and its expressions were successfully read; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayloadSpan | payload | The payload to read from. |
Lumina.Text.Payloads.LinkMacroPayloadType | linkType | The link type. |
Lumina.Text.ReadOnly.ReadOnlySeExpressionSpan | expr1 | The first integer expression. |
Lumina.Text.ReadOnly.ReadOnlySeExpressionSpan | expr2 | The second integer expression. |
Lumina.Text.ReadOnly.ReadOnlySeExpressionSpan | expr3 | The third integer expression. |
Lumina.Text.ReadOnly.ReadOnlySeExpressionSpan | expr4 | An optional string expression. |
TryReadDalamudLink(ReadOnlySePayloadSpan, out DalamudLinkPayload)
Attempts to read a Dalamud link payload from the specified payload.
public static bool TryReadDalamudLink(this ReadOnlySePayloadSpan rosps, out DalamudLinkPayload payload)
Returns
System.Boolean: true if the payload was successfully parsed into a Dalamud.Game.Text.SeStringHandling.Payloads.DalamudLinkPayload; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayloadSpan | rosps | The payload to read from. |
| Dalamud.Game.Text.SeStringHandling.Payloads.DalamudLinkPayload | payload | The parsed Dalamud.Game.Text.SeStringHandling.Payloads.DalamudLinkPayload if parsing succeeded, or default if parsing failed. |