Skip to main content
Version: 15.x (API 15) [Legacy]

Class ReadOnlySePayloadExtensions

Extension functions for Lumina.Text.ReadOnly.ReadOnlySePayload.

Assembly: Dalamud.dll
Declaration
public static class ReadOnlySePayloadExtensions

Methods

IsMacro(ReadOnlySePayload, MacroCode)

Determines whether the payload is a macro payload matching the specified macro code.

Declaration
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
TypeNameDescription
Lumina.Text.ReadOnly.ReadOnlySePayloadpayloadThe payload span to evaluate.
Lumina.Text.Payloads.MacroCodemacroCodeThe macro code to check against.

IsLink(ReadOnlySePayload, LinkMacroPayloadType)

Determines whether the payload is a link macro payload of the specified link type.

Declaration
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
TypeNameDescription
Lumina.Text.ReadOnly.ReadOnlySePayloadpayloadThe payload span to evaluate.
Lumina.Text.Payloads.LinkMacroPayloadTypelinkTypeThe link macro type to check against.

TryParseDalamudLink(ReadOnlySePayload, out DalamudLinkPayload)

Attempts to parse a Dalamud link payload from the specified payload span.

Declaration
public static bool TryParseDalamudLink(this ReadOnlySePayload rosp, out DalamudLinkPayload payload)
Returns

System.Boolean: true if the payload was successfully parsed into a Dalamud.Game.Text.DalamudLinkPayload; otherwise, false.

Parameters
TypeNameDescription
Lumina.Text.ReadOnly.ReadOnlySePayloadrosp
Dalamud.Game.Text.DalamudLinkPayloadpayloadWhen this method returns, contains the parsed Dalamud.Game.Text.DalamudLinkPayload if parsing succeeded, or default if parsing failed.