Class Payload

This class represents a parsed SeString payload.

Inheritance
System.Object
Payload
AutoTranslatePayload
ItemPayload
MapLinkPayload
PlayerPayload
RawPayload
StatusPayload
TextPayload
UIForegroundPayload
UIGlowPayload
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Dalamud.Game.Chat.SeStringHandling
Assembly: Dalamud.dll
Syntax
public abstract class Payload

Fields

| Improve this Doc View Source

END_BYTE

Declaration
protected const byte END_BYTE = 3
Field Value
Type Description
System.Byte
| Improve this Doc View Source

START_BYTE

Declaration
protected const byte START_BYTE = 2
Field Value
Type Description
System.Byte

Properties

| Improve this Doc View Source

Type

Declaration
public abstract PayloadType Type { get; }
Property Value
Type Description
PayloadType

Methods

| Improve this Doc View Source

Encode()

Declaration
public abstract byte[] Encode()
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

GetInteger(BinaryReader)

Declaration
protected static uint GetInteger(BinaryReader input)
Parameters
Type Name Description
System.IO.BinaryReader input
Returns
Type Description
System.UInt32
| Improve this Doc View Source

GetMarkerForIntegerBytes(Byte[])

Declaration
protected virtual byte GetMarkerForIntegerBytes(byte[] bytes)
Parameters
Type Name Description
System.Byte[] bytes
Returns
Type Description
System.Byte
| Improve this Doc View Source

GetMarkerForPackedIntegerBytes(Byte[])

Declaration
protected virtual byte GetMarkerForPackedIntegerBytes(byte[] bytes)
Parameters
Type Name Description
System.Byte[] bytes
Returns
Type Description
System.Byte
| Improve this Doc View Source

GetPackedIntegers(BinaryReader)

Declaration
protected (uint, uint) GetPackedIntegers(BinaryReader input)
Parameters
Type Name Description
System.IO.BinaryReader input
Returns
Type Description
System.ValueTuple<System.UInt32, System.UInt32>
| Improve this Doc View Source

MakeInteger(UInt32, Boolean, Boolean)

Declaration
protected virtual byte[] MakeInteger(uint value, bool withMarker = true, bool incrementSmallInts = true)
Parameters
Type Name Description
System.UInt32 value
System.Boolean withMarker
System.Boolean incrementSmallInts
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

MakePackedInteger(UInt32, UInt32, Boolean)

Declaration
protected byte[] MakePackedInteger(uint val1, uint val2, bool withMarker = true)
Parameters
Type Name Description
System.UInt32 val1
System.UInt32 val2
System.Boolean withMarker
Returns
Type Description
System.Byte[]
| Improve this Doc View Source

Process(BinaryReader)

Declaration
public static Payload Process(BinaryReader reader)
Parameters
Type Name Description
System.IO.BinaryReader reader
Returns
Type Description
Payload
| Improve this Doc View Source

ProcessChunkImpl(BinaryReader, Int64)

Declaration
protected abstract void ProcessChunkImpl(BinaryReader reader, long endOfStream)
Parameters
Type Name Description
System.IO.BinaryReader reader
System.Int64 endOfStream
| Improve this Doc View Source

Resolve()

Declaration
public abstract void Resolve()