Class UIForegroundPayload

An SeString Payload that allows text to have a specific color. The color selected will be determined by the Lumina.Excel.Sheets.UIColor.Dark theme's coloring, regardless of the active theme.

Assembly: Dalamud.dll

View Source

Declaration

public class UIForegroundPayload : Payload

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

Properties

UIForegroundOff

Gets a payload representing disabling foreground color on following text.

View Source

Declaration

public static UIForegroundPayload UIForegroundOff { get; }

Type

Gets the type of this payload.

View Source

Declaration

public override PayloadType Type { get; }

IsEnabled

Gets a value indicating whether this payload represents applying a foreground color, or disabling one.

View Source

Declaration

public bool IsEnabled { get; }

UIColor

Gets a Lumina UIColor object representing this payload. The actual color data is at UIColor.UIForeground.

View Source

Declaration

[JsonIgnore]
public RowRef<UIColor> UIColor { get; }

ColorKey

Gets or sets the color key used as a lookup in the UIColor table for this foreground color.

View Source

Declaration

[JsonIgnore]
public ushort ColorKey { get; set; }

RGBA

Gets the Red/Green/Blue/Alpha values for this foreground color, encoded as a typical hex color.

View Source

Declaration

[JsonIgnore]
public uint RGBA { get; }

ABGR

Gets the ABGR value for this foreground color, as ImGui requires it in PushColor.

View Source

Declaration

[JsonIgnore]
public uint ABGR { get; }

Methods

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

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.