Class DalamudLinkPayload

This class represents a custom Dalamud clickable chat link.

Assembly: Dalamud.dll

View Source

Declaration

public class DalamudLinkPayload : Payload

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

Properties

Type

Gets the type of this payload.

View Source

Declaration

public override PayloadType Type { get; }

CommandId

Gets the plugin command ID to be linked.

View Source

Declaration

public uint CommandId { get; }

Extra1

Gets an optional extra integer value 1.

View Source

Declaration

public int Extra1 { get; }

Extra2

Gets an optional extra integer value 2.

View Source

Declaration

public int Extra2 { get; }

Plugin

Gets the plugin name to be linked.

View Source

Declaration

public string Plugin { get; }

ExtraString

Gets an optional extra string.

View Source

Declaration

public string ExtraString { get; }

Methods

ToString()

Returns a string that represents the current object.

View Source

Declaration

public override string ToString()

Returns

System.String: A string that represents the current object.### EncodeImpl() Encodes the internal state of this payload into a byte[] suitable for sending to in-game handlers such as the chat log.

View Source

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.

View Source

Declaration

protected override void DecodeImpl(BinaryReader reader, long endOfStream)

Parameters

Type	Name	Description
System.IO.BinaryReader	reader	A BinaryReader containing at least all the data for this payload.
System.Int64	endOfStream	The location holding the end of the data for this payload.