Skip to main content

Class RawPayload

An SeString Payload representing unhandled raw payload data. Mainly useful for constructing unhandled hardcoded payloads, or forwarding any unknown payloads without modification.

Assembly: Dalamud.dll
Declaration
public class RawPayload : Payload

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

Properties

LinkTerminator

Gets a fixed Payload representing a common link-termination sequence, found in many payload chains.

Declaration
public static RawPayload LinkTerminator { get; }

Type

Gets the type of this payload.

Declaration
public override PayloadType Type { get; }

Data

Gets the entire payload byte sequence for this payload. The returned data is a clone and modifications will not be persisted.

Declaration
[JsonIgnore]
public byte[] Data { get; }

Methods

Equals(object)

Declaration
public override bool Equals(object obj)
Returns

System.Boolean

Parameters
TypeName
System.Objectobj

GetHashCode()

Declaration
public override int GetHashCode()
Returns

System.Int32

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.