docs: Explain what the UI*Payloads actually are.

This commit is contained in:
Kaz Wolfe 2025-03-25 09:35:21 -07:00
parent 67561af32f
commit c5af536032
No known key found for this signature in database
GPG key ID: 258813F53A16EBB4
2 changed files with 4 additions and 2 deletions

View file

@ -10,7 +10,8 @@ using Newtonsoft.Json;
namespace Dalamud.Game.Text.SeStringHandling.Payloads;
/// <summary>
/// An SeString Payload representing a UI foreground color applied to following text payloads.
/// An SeString Payload that allows text to have a specific color. The color selected will be determined by the
/// <see cref="Lumina.Excel.Sheets.UIColor.Dark"/> theme's coloring, regardless of the active theme.
/// </summary>
public class UIForegroundPayload : Payload
{

View file

@ -10,7 +10,8 @@ using Newtonsoft.Json;
namespace Dalamud.Game.Text.SeStringHandling.Payloads;
/// <summary>
/// An SeString Payload representing a UI glow color applied to following text payloads.
/// An SeString Payload that allows text to have a specific edge glow. The color selected will be determined by the
/// <see cref="Lumina.Excel.Sheets.UIColor.Light"/> theme's coloring, regardless of the active theme.
/// </summary>
public class UIGlowPayload : Payload
{