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

Class PlayerPayload

An SeString Payload representing a player link.

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

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

Properties​

World​

Gets the Lumina object representing the player's home server.

Declaration
[JsonIgnore]
public RowRef<World> World { get; }

PlayerName​

Gets or sets the player's displayed name. This does not contain the server name.

Declaration
[JsonIgnore]
public string PlayerName { get; set; }

DisplayedName​

Gets the text representation of this player link matching how it might appear in-game. The world name will always be present.

Declaration
[JsonIgnore]
public string DisplayedName { get; }

Type​

Gets the type of this payload.

Declaration
public override PayloadType Type { 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.