Show / Hide Table of Contents

# Class UIForegroundPayload

An SeString Payload representing a UI foreground color applied to following text payloads.

##### Inheritance

System.Object
Payload
UIForegroundPayload

##### Inherited Members

Payload.Dirty
Payload.dataResolver
Payload.Encode(Boolean)
Payload.Decode(BinaryReader)
Payload.START_BYTE
Payload.END_BYTE
Payload.GetInteger(BinaryReader)
Payload.MakeInteger(UInt32, Boolean, Boolean)
Payload.GetMarkerForPackedIntegerBytes(Byte[])
Payload.GetPackedIntegers(BinaryReader)
Payload.MakePackedInteger(UInt32, UInt32, Boolean)
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.Payloads

###### Assembly: Dalamud.dll

##### Syntax

    public class UIForegroundPayload : Payload

### Constructors

| Improve this Doc View Source

#### UIForegroundPayload(UInt16)

Creates a new UIForegroundPayload for the given UIColor key.

##### Declaration

    public UIForegroundPayload(ushort colorKey)

##### Parameters

Type | Name | Description
--- | --- | ---
System.UInt16 | colorKey |

### Properties

| Improve this Doc View Source

#### ColorKey

The color key used as a lookup in the UIColor table for this foreground color.

##### Declaration

    public ushort ColorKey { get; set; }

##### Property Value

Type | Description
--- | ---
System.UInt16 |

| Improve this Doc View Source

#### IsEnabled

Whether or not this payload represents applying a foreground color, or disabling one.

##### Declaration

    public bool IsEnabled { get; }

##### Property Value

Type | Description
--- | ---
System.Boolean |

| Improve this Doc View Source

#### RGB

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

##### Declaration

    public uint RGB { get; }

##### Property Value

Type | Description
--- | ---
System.UInt32 |

| Improve this Doc View Source

#### Type

##### Declaration

    public override PayloadType Type { get; }

##### Property Value

Type | Description
--- | ---
PayloadType |

##### Overrides

Payload.Type
| Improve this Doc View Source

#### UIColor

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

##### Declaration

    public UIColor UIColor { get; }

##### Property Value

Type | Description
--- | ---
Lumina.Excel.GeneratedSheets.UIColor |

##### Remarks

Value is evaluated lazily and cached.

| Improve this Doc View Source

#### UIForegroundOff

Payload representing disabling foreground color on following text.

##### Declaration

    public static UIForegroundPayload UIForegroundOff { get; }

##### Property Value

Type | Description
--- | ---
UIForegroundPayload |

### Methods

| Improve this Doc View Source

#### DecodeImpl(BinaryReader, Int64)

##### Declaration

    protected override void DecodeImpl(BinaryReader reader, long endOfStream)

##### Parameters

Type | Name | Description
--- | --- | ---
System.IO.BinaryReader | reader |
System.Int64 | endOfStream |

##### Overrides

Payload.DecodeImpl(BinaryReader, Int64)
| Improve this Doc View Source

#### EncodeImpl()

##### Declaration

    protected override byte[] EncodeImpl()

##### Returns

Type | Description
--- | ---
System.Byte[] |

##### Overrides

Payload.EncodeImpl()
| Improve this Doc View Source

#### GetMarkerForIntegerBytes(Byte[])

##### Declaration

    protected override byte GetMarkerForIntegerBytes(byte[] bytes)

##### Parameters

Type | Name | Description
--- | --- | ---
System.Byte[] | bytes |

##### Returns

Type | Description
--- | ---
System.Byte |

##### Overrides

Payload.GetMarkerForIntegerBytes(Byte[])
| Improve this Doc View Source

#### ToString()

##### Declaration

    public override string ToString()

##### Returns

Type | Description
--- | ---
System.String |

##### Overrides

System.Object.ToString()