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

Class PartyFinderPayload

An SeString Payload representing an interactable party finder link.

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

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

Properties​

ListingId​

Gets the party finder listing ID.

Declaration
[JsonProperty]
public uint ListingId { get; }

LinkType​

Gets the link type.

Declaration
[JsonProperty]
public PartyFinderPayload.PartyFinderLinkType LinkType { get; }

Type​

Gets the type of this payload.

Declaration
public override PayloadType Type { get; }

Fields​

FLAG_DELIMITER​

Delimiting byte for party finder payload flags.

Declaration
protected const byte FLAG_DELIMITER = 1

Methods​

ToString()​

Declaration
public override string ToString()
Returns​

System.String

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.

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.