Class IconPayload

SeString payload representing a bitmap icon from fontIcon

Inheritance
System.Object
Payload
IconPayload
Inherited Members
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.Text.SeStringHandling.Payloads
Assembly: Dalamud.dll
Syntax
public class IconPayload : Payload

Constructors

| Improve this Doc View Source

IconPayload(BitmapFontIcon)

Create a Icon payload for the specified icon.

Declaration
public IconPayload(BitmapFontIcon icon)
Parameters
Type Name Description
BitmapFontIcon icon

The Icon
| Improve this Doc View Source

IconPayload(UInt32)

Create a Icon payload for the specified icon.

Declaration
[Obsolete("IconPayload(uint) is deprecated, please use IconPayload(BitmapFontIcon).")]
public IconPayload(uint iconIndex)
Parameters
Type Name Description
System.UInt32 iconIndex

Index of the icon

Properties

| Improve this Doc View Source

Icon

Icon the payload represents.

Declaration
public BitmapFontIcon Icon { get; set; }
Property Value
Type Description
BitmapFontIcon
| Improve this Doc View Source

IconIndex

Index of the icon

Declaration
[Obsolete("Use IconPayload.Icon")]
public uint IconIndex { get; }
Property Value
Type Description
System.UInt32
| Improve this Doc View Source

Type

The type of this payload.

Declaration
public override PayloadType Type { get; }
Property Value
Type Description
PayloadType
Overrides

Methods

| Improve this Doc View Source

DecodeImpl(BinaryReader, Int64)

Decodes a byte stream from the game into a payload object.

Declaration
protected override void DecodeImpl(BinaryReader reader, long endOfStream)
Parameters
Type Name Description
System.IO.BinaryReader reader

A BinaryReader containing at least all the data for this payload.
System.Int64 endOfStream

The location holding the end of the data for this payload.
Overrides
| Improve this Doc View Source

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
Type Description
System.Byte[]

Encoded binary payload data suitable for use with in-game handlers.
Overrides
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String
Overrides
System.Object.ToString()