Class PlayerPayload

An SeString Payload representing a player link.

Inheritance
System.Object
Payload
PlayerPayload
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: Dalamud.Game.Text.SeStringHandling.Payloads
Assembly: Dalamud.dll
Syntax
public class PlayerPayload : Payload

Constructors

| Improve this Doc View Source

PlayerPayload(String, UInt32)

Initializes a new instance of the PlayerPayload class. Create a PlayerPayload link for the specified player.

Declaration
public PlayerPayload(string playerName, uint serverId)
Parameters
Type Name Description
System.String playerName

The player's displayed name.
System.UInt32 serverId

The player's home server id.

Properties

| Improve this Doc View Source

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; }
Property Value
Type Description
System.String
| Improve this Doc View Source

PlayerName

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

Declaration
[JsonIgnore]
public string PlayerName { get; set; }
Property Value
Type Description
System.String
| Improve this Doc View Source

Type

Gets the type of this payload.

Declaration
public override PayloadType Type { get; }
Property Value
Type Description
PayloadType
Overrides
| Improve this Doc View Source

World

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

Declaration
[JsonIgnore]
public World World { get; }
Property Value
Type Description
Lumina.Excel.GeneratedSheets.World
Remarks

Value is evaluated lazily and cached.

Methods

| Improve this Doc View Source

DecodeImpl(BinaryReader, Int64)

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

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.
Overrides
| Improve this Doc View Source

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
Type Description
System.Byte[]

Encoded binary payload data suitable for use with in-game handlers.
Overrides
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()