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

Class DalamudLinkPayload

This class represents a custom Dalamud clickable chat link.

Assembly: Dalamud.dll​
Declaration
public class DalamudLinkPayload : Payload

Inheritance: System.Object -> Dalamud.Game.Text.SeStringHandling.Payload

Properties​

Type​

Gets the type of this payload.

Declaration
public override PayloadType Type { get; }

CommandId​

Gets the plugin command ID to be linked.

Declaration
public uint CommandId { get; }

Extra1​

Gets an optional extra integer value 1.

Declaration
public int Extra1 { get; }

Extra2​

Gets an optional extra integer value 2.

Declaration
public int Extra2 { get; }

Plugin​

Gets the plugin name to be linked.

Declaration
public string Plugin { get; }

ExtraString​

Gets an optional extra string.

Declaration
public string ExtraString { get; }

Methods​

ToString()​

Declaration
public override string ToString()
Returns​

System.String

EncodeImpl()​

Encodes the internal state of this payload into a byte[] suitable for sending to in-game handlers such as the chat log.

Declaration
protected override byte[] EncodeImpl()
Returns​

System.Byte[]: Encoded binary payload data suitable for use with in-game handlers.

DecodeImpl(BinaryReader, long)​

Decodes a byte stream from the game into a payload object.

Declaration
protected override void DecodeImpl(BinaryReader reader, long endOfStream)
Parameters​
TypeNameDescription
System.IO.BinaryReaderreaderA BinaryReader containing at least all the data for this payload.
System.Int64endOfStreamThe location holding the end of the data for this payload.