CharFXTransform

public CharFXTransform();

Creates a separate context container. For effects, use the callback argument: constructing one does not attach it to RichTextLabel.

public Color Color { get; set; }

Current glyph color after earlier settings/effects. Preserve the required alpha in a replacement Color. Changes this drawing pass rather than every following character.

public double ElapsedTime { get; set; }

Effect-span elapsed time in seconds for animation. Neither frame delta nor system time. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public Reckfell.Collections.Dictionary Env { get; set; }

Effect-span parameter dictionary, supplied by BBCode or PushCustomfx env. Shared by reference; do not mutate it as a temporary snapshot. CharFXTransform destruction clears the dictionary: supply a separate Dictionary for independent data. Replacing Env does not edit source BBCode.

public Rid Font { get; set; }

Borrowed RID of the current font for glyph queries. Do not free it through a server. Changing the field does not switch the drawing font; use RichTextLabel formatting for another font.

public byte GlyphCount { get; set; }

Text-system glyph count for the associated cluster, not source-string length. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public ushort GlyphFlags { get; set; }

Text-system glyph flags such as direction and cluster boundaries. Not effect flags. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public uint GlyphIndex { get; set; }

Glyph index in the current font, not a Unicode value or C# char index. May be replaced with another valid glyph in that font; layout and advance are not recomputed.

public Vector2 Offset { get; set; }

Additional glyph drawing offset in pixels. Add to the incoming Offset to retain preceding effects. Does not move a character in logical text.

public bool Outline { get; set; }

true for outline or shadow passes, false for the main text. One glyph may invoke the callback several times per frame. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public Vector2I Range { get; set; }

Logical character range represented by the glyph: X start, Y end. Not C# UTF-16 string indices or screen coordinates. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public int RelativeIndex { get; set; }

Glyph-start offset from the effect span start in logical characters. Not a callback invocation counter: drawing passes can repeat. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public Transform2D Transform { get; set; }

Current glyph transform, already containing its base position. Modify relative to the incoming value; replacing it with Identity can lose positioning. Does not change wrapping or line sizes.

public bool Visible { get; set; }

Allows drawing this glyph. false hides it while retaining its occupied space. true cannot restore a glyph already hidden by an earlier effect or visibility limit.

public Color GetColor();

Current glyph color after earlier settings/effects. Preserve the required alpha in a replacement Color. Changes this drawing pass rather than every following character.

public double GetElapsedTime();

Effect-span elapsed time in seconds for animation. Neither frame delta nor system time. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public Reckfell.Collections.Dictionary GetEnvironment();

Effect-span parameter dictionary, supplied by BBCode or PushCustomfx env. Shared by reference; do not mutate it as a temporary snapshot. CharFXTransform destruction clears the dictionary: supply a separate Dictionary for independent data. Replacing Env does not edit source BBCode.

public Rid GetFont();

Borrowed RID of the current font for glyph queries. Do not free it through a server. Changing the field does not switch the drawing font; use RichTextLabel formatting for another font.

public byte GetGlyphCount();

Text-system glyph count for the associated cluster, not source-string length. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public ushort GetGlyphFlags();

Text-system glyph flags such as direction and cluster boundaries. Not effect flags. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public uint GetGlyphIndex();

Glyph index in the current font, not a Unicode value or C# char index. May be replaced with another valid glyph in that font; layout and advance are not recomputed.

public Vector2 GetOffset();

Additional glyph drawing offset in pixels. Add to the incoming Offset to retain preceding effects. Does not move a character in logical text.

public Vector2I GetRange();

Logical character range represented by the glyph: X start, Y end. Not C# UTF-16 string indices or screen coordinates. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public int GetRelativeIndex();

Glyph-start offset from the effect span start in logical characters. Not a callback invocation counter: drawing passes can repeat. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public Transform2D GetTransform();

Current glyph transform, already containing its base position. Modify relative to the incoming value; replacing it with Identity can lose positioning. Does not change wrapping or line sizes.

public bool IsOutline();

true for outline or shadow passes, false for the main text. One glyph may invoke the callback several times per frame. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public bool IsVisible();

Allows drawing this glyph. false hides it while retaining its occupied space. true cannot restore a glyph already hidden by an earlier effect or visibility limit.

public void SetColor(Color color);

Current glyph color after earlier settings/effects. Preserve the required alpha in a replacement Color. Changes this drawing pass rather than every following character.

public void SetElapsedTime(double time);

Effect-span elapsed time in seconds for animation. Neither frame delta nor system time. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public void SetEnvironment(Reckfell.Collections.Dictionary environment);

Effect-span parameter dictionary, supplied by BBCode or PushCustomfx env. Shared by reference; do not mutate it as a temporary snapshot. CharFXTransform destruction clears the dictionary: supply a separate Dictionary for independent data. Replacing Env does not edit source BBCode.

public void SetFont(Rid font);

Borrowed RID of the current font for glyph queries. Do not free it through a server. Changing the field does not switch the drawing font; use RichTextLabel formatting for another font.

public void SetGlyphCount(byte glyphCount);

Text-system glyph count for the associated cluster, not source-string length. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public void SetGlyphFlags(ushort glyphFlags);

Text-system glyph flags such as direction and cluster boundaries. Not effect flags. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public void SetGlyphIndex(uint glyphIndex);

Glyph index in the current font, not a Unicode value or C# char index. May be replaced with another valid glyph in that font; layout and advance are not recomputed.

public void SetOffset(Vector2 offset);

Additional glyph drawing offset in pixels. Add to the incoming Offset to retain preceding effects. Does not move a character in logical text.

public void SetOutline(bool outline);

true for outline or shadow passes, false for the main text. One glyph may invoke the callback several times per frame. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public void SetRange(Vector2I range);

Logical character range represented by the glyph: X start, Y end. Not C# UTF-16 string indices or screen coordinates. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public void SetRelativeIndex(int relativeIndex);

Glyph-start offset from the effect span start in logical characters. Not a callback invocation counter: drawing passes can repeat. Input context for the current glyph; writing the setter does not change text layout and is overwritten by the next engine callback.

public void SetTransform(Transform2D transform);

Current glyph transform, already containing its base position. Modify relative to the incoming value; replacing it with Identity can lose positioning. Does not change wrapping or line sizes.

public void SetVisibility(bool visibility);

Allows drawing this glyph. false hides it while retaining its occupied space. true cannot restore a glyph already hidden by an earlier effect or visibility limit.