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

Class DalamudLinkPayload

Represents a custom chat link payload used within the Dalamud framework to trigger plugin-specific commands or actions when clicked.

Assembly: Dalamud.dll​
Declaration
public sealed class DalamudLinkPayload

Properties​

CommandId​

Gets the unique command identifier that determines which action or handler is triggered.

Declaration
public uint CommandId { get; init; }

PluginName​

Gets the internal name of the plugin that owns or processes this link.

Declaration
public string PluginName { get; init; }

Extra1​

Gets or sets additional integer metadata associated with the payload.

Declaration
public int Extra1 { get; set; }

Extra2​

Gets or sets secondary additional integer metadata associated with the payload.

Declaration
public int Extra2 { get; set; }

ExtraString​

Gets or sets additional string metadata associated with the payload.

Declaration
public string ExtraString { get; set; }

Fields​

LinkType​

Represents the custom Lumina.Text.Payloads.LinkMacroPayloadType identifier reserved for Dalamud links.

Declaration
public const LinkMacroPayloadType LinkType = (LinkMacroPayloadType)205