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
View Source
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.

View Source
Declaration
public static RawPayload LinkTerminator { get; }

Type

Gets the type of this payload.

View Source
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.

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

Methods

Equals(object)

Determines whether the specified object is equal to the current object.

View Source
Declaration
public override bool Equals(object obj)
Returns

System.Boolean: true if the specified object is equal to the current object; otherwise, false.

Parameters
TypeNameDescription
System.ObjectobjThe object to compare with the current object.

GetHashCode()

Serves as the default hash function.

View Source
Declaration
public override int GetHashCode()
Returns

System.Int32: A hash code for the current object.### 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
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.