Class PlayerPayload

An SeString Payload representing a player link.

Assembly: Dalamud.dll

View Source

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.

View Source

Declaration

[JsonIgnore]
public World World { get; }

PlayerName

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

View Source

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.

View Source

Declaration

[JsonIgnore]
public string DisplayedName { get; }

Type

Gets the type of this payload.

View Source

Declaration

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