Class ReadOnlySePayloadExtensions
Extension functions for Lumina.Text.ReadOnly.ReadOnlySePayload.
Assembly: Dalamud.dll
public static class ReadOnlySePayloadExtensions
Methods
IsMacro(ReadOnlySePayload, MacroCode)
Determines whether the payload is a macro payload matching the specified macro code.
public static bool IsMacro(this ReadOnlySePayload 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.ReadOnlySePayload | payload | The payload span to evaluate. |
Lumina.Text.Payloads.MacroCode | macroCode | The macro code to check against. |
IsLink(ReadOnlySePayload, LinkMacroPayloadType)
Determines whether the payload is a link macro payload of the specified link type.
public static bool IsLink(this ReadOnlySePayload 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.ReadOnlySePayload | payload | The payload span to evaluate. |
Lumina.Text.Payloads.LinkMacroPayloadType | linkType | The link macro type to check against. |
IsLinkTerminator(ReadOnlySePayload)
Determines whether the specified payload represents a link terminator.
public static bool IsLinkTerminator(this ReadOnlySePayload payload)
Returns
System.Boolean: true if the payload is a link terminator; otherwise, false.
Parameters
| Type | Name | Description |
|---|---|---|
Lumina.Text.ReadOnly.ReadOnlySePayload | payload | The payload to check. |
TryReadLink(ReadOnlySePayload, out LinkMacroPayloadType, out ReadOnlySeExpressionSpan, out ReadOnlySeExpressionSpan, out ReadOnlySeExpressionSpan, out ReadOnlySeExpressionSpan)
Attempts to read link parameters from the specified payload.
public static bool TryReadLink(this ReadOnlySePayload 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.ReadOnlySePayload | 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(ReadOnlySePayload, out DalamudLinkPayload)
Attempts to read a Dalamud link payload from the specified payload.
public static bool TryReadDalamudLink(this ReadOnlySePayload rosp, 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.ReadOnlySePayload | rosp | |
| Dalamud.Game.Text.SeStringHandling.Payloads.DalamudLinkPayload | payload | The parsed Dalamud.Game.Text.SeStringHandling.Payloads.DalamudLinkPayload if parsing succeeded, or default if parsing failed. |