Skip to main content

Class IconPayload

SeString payload representing a bitmap icon from fontIcon.

Assembly: Dalamud.dll
Declaration
public class IconPayload : Payload

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

Properties

Type

Gets the type of this payload.

Declaration
public override PayloadType Type { get; }

Icon

Gets or sets the icon the payload represents.

Declaration
public BitmapFontIcon Icon { get; set; }

Methods

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.