RichTextLabel

public RichTextLabel();

Creates a rich-text label; add it to a parent with AddChild. Enable BbcodeEnabled to parse Text as BBCode. Does not automatically open files or links.

public TextServer.AutowrapMode AutowrapMode { get; set; }

Wrapping rule for available width: off, arbitrary or word-based. Changes display rows and metrics while retaining source Text. Give the label a layout width for predictable results.

public TextServer.LineBreakFlag AutowrapTrimFlags { get; set; }

Flags for edge-whitespace/indent handling during wrapping. The setter retains only TextServer trim-mask bits; other LineBreakFlag values do not select a separate wrapping mode here. Source text is not trimmed.

public bool BbcodeEnabled { get; set; }

Controls BBCode parsing of the Text property. Does not make manual AddText parse markup; AppendText parses markup independently. Toggling does not guarantee rebuilding a manually modified stack.

public bool ContextMenuEnabled { get; set; }

Allows opening the built-in user menu. false neither deletes the PopupMenu nor prohibits programmatic GetMenu/MenuOption. An interface setting rather than a restriction on application data copying.

public Reckfell.Collections.Array CustomEffects { get; set; }

Custom BBCode effect resources. The setter replaces the array and calls ReloadEffects; the getter shares the array, so mutating it does not itself reparse text. Duplicate names are ambiguous: the first matching name is used. Use PushCustomfx for direct programmatic application.

public bool DeselectOnFocusLossEnabled { get; set; }

Allows deselection on focus loss. Switching false to true while unfocused immediately clears an existing selection. Use false to retain it when moving to another control.

public bool DragAndDropSelectionEnabled { get; set; }

Allows dragging selected plain text out of the label. Requires SelectionEnabled; does not enable editing or arbitrary file drops. Assignment does not initiate a drag.

public bool FitContent { get; set; }

Includes content in the label’s minimum size. A parent container may expand it; does not set an exact Size or shrink the font. Account for wrapping and parent constraints.

public bool HintUnderlined { get; set; }

Allows visual underlining of PushHint spans. Does not enable/disable tooltip content or edit text.

public HorizontalAlignment HorizontalAlignment { get; set; }

Default horizontal text alignment; local paragraph formatting may override it. Fill uses JustificationFlags for justification. Does not move the Control in its parent container.

public TextServer.JustificationFlag JustificationFlags { get; set; }

Line-stretching rules for justified text, such as word and final-line handling. Work with the corresponding alignment rather than setting label width.

public string Language { get; set; }

Language hint for text shaping and wrapping. Does not translate the string; UI translation of source Text is a separate mechanism.

public int MaximumFontSize { get; set; }

Upper font-fitting bound with ResizeFontToFit. Keep consistent with MinimumFontSize; constrains fitting rather than universally prohibiting local BBCode font sizes.

public bool MetaUnderlined { get; set; }

Allows underlining metadata spans according to their MetaUnderline policy. Does not create links or open URLs. An explicit PushUnderline span is separate formatting.

public int MinimumFontSize { get; set; }

Lower font-fitting bound with ResizeFontToFit. Supply a positive value no greater than MaximumFontSize. Assignment does not mean this exact size is already drawn.

public int ProgressBarDelay { get; set; }

Delay before displaying background-loading progress, in milliseconds. A positive value waits that interval; zero and negative values disable the indicator. Does not set parsing speed or character-reveal timing.

public bool ResizeFontToFit { get; set; }

Allows choosing a base font size for the available area within MinimumFontSize–MaximumFontSize. Unlike FitContent, adjusts the font rather than the minimum-size requirement. Fitting depends on width and height; a tiny minimum does not ensure legibility.

public bool ScrollActive { get; set; }

Allows built-in vertical scrolling. Toggling reapplies source Text: when mixed with manual AddText/Push, content may rebuild from the stored string. Set the mode before manual construction. Does not mean all content fits without a scrollbar.

public bool ScrollFollowing { get; set; }

Allows following the end of appended text. If the user scrolls upward, actual following can pause until returning to the bottom. The getter reports the setting rather than whether the view is currently at the bottom.

public bool ScrollFollowingVisibleCharacters { get; set; }

Scrolls to content revealed through VisibleCharacters. Differs from following the full text end; intended for progressive reveal. Setting true may immediately change scrolling.

public bool SelectionEnabled { get; set; }

Allows selecting displayed text and using SelectAll. Enabling sets FocusMode.All; disabling clears active selection and switches to accessibility focus mode. Does not make the label editable or change Text.

public bool ShortcutKeysEnabled { get; set; }

Allows the label’s built-in command shortcuts. Does not automatically enable SelectionEnabled or prohibit direct SelectAll/MenuOption calls.

public TextServer.StructuredTextParser StructuredTextBidiOverride { get; set; }

Selects parsing of structured bidirectional text, such as addresses or paths. A shaping setting rather than a regex replacement of source text. StructuredTextBidiOverrideOptions supplies parameters.

public Reckfell.Collections.Array StructuredTextBidiOverrideOptions { get; set; }

Structured BiDi-parser parameters. The array is shared; in-place mutation does not automatically trigger recalculation. Assign a new array with different content to update: the setter may skip equal content.

public int TabSize { get; set; }

Default tab width measured in spaces; use a positive value. Changes tab presentation without replacing tabs with spaces in Text. Use TabStops for explicit positions.

public float[] TabStops { get; set; }

Explicit tab positions in text-area pixels; supply increasing positive values. C# float[] transfers data and the getter returns values: mutating the result does not reconfigure the label. Does not set source-line indentation.

public string Text { get; set; }

Source string for rebuilding the label, including UI translation and BBCode parsing when BbcodeEnabled. Assignment replaces manual content; assigning the same nonempty string may not rebuild it. AddText, AppendText and Push methods do not append their result to this property. Use GetParsedText for resulting plain text.

public Control.TextDirection TextDirection { get; set; }

Text direction for BiDi shaping. Does not manually reverse source characters or translate text. Configure structured-text parsing separately.

public bool Threaded { get; set; }

Allows background text layout; defaults to false. Does not make arbitrary RichTextLabel calls thread-safe or move all drawing to another thread. Check IsFinished; until completion, metrics may cover only the processed portion.

public VerticalAlignment VerticalAlignment { get; set; }

Vertical placement of text content inside the label. Does not change Control alignment in its parent or enable automatic scrolling.

public int VisibleCharacters { get; set; }

Progressive-reveal limit: -1 shows all, zero hides text, a nonnegative value sets a limit. VisibleCharactersBehavior chooses behavior before/after glyph shaping. Not a frame count or Text’s UTF-16 Length. The setter updates VisibleRatio but does not explicitly clamp oversized values; keep animation values between zero and GetTotalCharacterCount.

public TextServer.VisibleCharactersBehavior VisibleCharactersBehavior { get; set; }

Chooses whether reveal limits apply before shaping or to shaped characters/glyphs. Before shaping may change layout; after shaping retains full-line context, with reveal units depending on mode. Account for ligatures, composite characters and RTL; do not assume one C# char per visible glyph.

public float VisibleRatio { get; set; }

Reveal fraction: values from zero to one convert to integer VisibleCharacters by truncation. One or greater shows all; a negative value hides text. Creates no timer: animate the fraction from your application. Refers to the content counter rather than necessarily the number of visually distinct letters.

public void AddHr(int width = 90, int height = 2, Color? color = default, HorizontalAlignment alignment = HorizontalAlignment.Center, bool widthInPercent = true, bool heightInPercent = false);

Adds a horizontal rule as separate paragraph content. Defaults to 90% of available text width and a height of two pixels. A percentage height also uses width rather than label height. The command closes its internal paragraph span: needs no extra Pop.

public void AddImage(Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region);

Adds an inline image from a valid Texture2D with nonzero dimensions. Zero width/height uses natural sizing; specifying one side preserves aspect ratio. Pixel means pixels, Percent means percentages of available text width for both axes, and Em multiplies the current font size (one means one em). Supply a unique key for later updates. Content rather than a Push span: needs no extra Pop. Open a cell first when inside a table.

public void AddImage(Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region, Variant key, bool pad, string tooltip, bool sizeInPercent);

Adds an inline image from a valid Texture2D with nonzero dimensions. Zero width/height uses natural sizing; specifying one side preserves aspect ratio. Pixel means pixels, Percent means percentages of available text width for both axes, and Em multiplies the current font size (one means one em). Supply a unique key for later updates. Content rather than a Push span: needs no extra Pop. Open a cell first when inside a table.

public void AddImage(Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region, Variant key, bool pad, string tooltip, bool widthInPercent, bool heightInPercent, string altText);

Adds an inline image from a valid Texture2D with nonzero dimensions. Zero width/height uses natural sizing; specifying one side preserves aspect ratio. Pixel means pixels, Percent means percentages of available text width for both axes, and Em multiplies the current font size (one means one em). Supply a unique key for later updates. Content rather than a Push span: needs no extra Pop. Open a cell first when inside a table.

public void AddImage(Texture2D image, int width, int height, Color? color, InlineAlignment inlineAlign, Rect2? region, Variant key, bool pad, string tooltip, bool sizeInPercent, string altText);

Adds an inline image from a valid Texture2D with nonzero dimensions. Zero width/height uses natural sizing; specifying one side preserves aspect ratio. Pixel means pixels, Percent means percentages of available text width for both axes, and Em multiplies the current font size (one means one em). Supply a unique key for later updates. Content rather than a Push span: needs no extra Pop. Open a cell first when inside a table.

public void AddImage(Texture2D image, float width = 0f, float height = 0f, Color? color = default, InlineAlignment inlineAlign = InlineAlignment.Center, Rect2? region = default, Variant key = default, bool pad = false, string tooltip = "", RichTextLabel.ImageUnit widthUnit = RichTextLabel.ImageUnit.Pixel, RichTextLabel.ImageUnit heightUnit = RichTextLabel.ImageUnit.Pixel, string altText = "");

Adds an inline image from a valid Texture2D with nonzero dimensions. Zero width/height uses natural sizing; specifying one side preserves aspect ratio. Pixel means pixels, Percent means percentages of available text width for both axes, and Em multiplies the current font size (one means one em). Supply a unique key for later updates. Content rather than a Push span: needs no extra Pop. Open a cell first when inside a table.

public void AddText(string text);

Adds literal text in the current formatting span. Square-bracket tags are not parsed. Suitable for user text inside Push/Pop without treating it as markup. Does not update Text; a table needs a cell before adding text directly.

public void AppendText(string bbcode);

Parses a BBCode fragment and appends formatted content without a full reset. Does not append the fragment to Text. Use AddText for data intended to display literally. Keep tags balanced; Push/Pop is convenient for programmatic spans.

public void Clear();

Removes constructed content and formatting spans, resetting selection and current text effects. Retains the stored source Text string; assign Text to an empty string to clear that. Does not clear registered CustomEffects.

public void Deselect();

Clears current selection without changing text, scrolling or the SelectionEnabled setting.

public TextServer.AutowrapMode GetAutowrapMode();

Wrapping rule for available width: off, arbitrary or word-based. Changes display rows and metrics while retaining source Text. Give the label a layout width for predictable results.

public TextServer.LineBreakFlag GetAutowrapTrimFlags();

Flags for edge-whitespace/indent handling during wrapping. The setter retains only TextServer trim-mask bits; other LineBreakFlag values do not select a separate wrapping mode here. Source text is not trimmed.

public int GetCharacterLine(int character);

Returns the display-row index containing a content position, or -1 when not found in calculated data. The character index is not an offset into source BBCode or UTF-16. With Threaded, read final metrics after IsFinished; changing text, width or fonts makes them pending again.

public int GetCharacterParagraph(int character);

Returns a content position’s paragraph index, or -1. A paragraph may contain multiple wrapped display rows. With Threaded, read final metrics after IsFinished; changing text, width or fonts makes them pending again.

public int GetContentHeight();

Calculated content height in pixels including theme spacing. Not the scroll viewport height. With Threaded, read final metrics after IsFinished; changing text, width or fonts makes them pending again.

public int GetContentWidth();

Calculated content width in control pixels rather than a Control size constraint. With Threaded, read final metrics after IsFinished; changing text, width or fonts makes them pending again.

public Reckfell.Collections.Array GetEffects();

Custom BBCode effect resources. The setter replaces the array and calls ReloadEffects; the getter shares the array, so mutating it does not itself reparse text. Duplicate names are ambiguous: the first matching name is used. Use PushCustomfx for direct programmatic application.

public HorizontalAlignment GetHorizontalAlignment();

Default horizontal text alignment; local paragraph formatting may override it. Fill uses JustificationFlags for justification. Does not move the Control in its parent container.

public TextServer.JustificationFlag GetJustificationFlags();

Line-stretching rules for justified text, such as word and final-line handling. Work with the corresponding alignment rather than setting label width.

public string GetLanguage();

Language hint for text shaping and wrapping. Does not translate the string; UI translation of source Text is a separate mechanism.

public int GetLineCount();

Number of calculated display rows in the main flow, including wrapping. Unlike TextEdit, not a file’s logical line count. Depends on width, fonts and reveal mode. With Threaded, read final metrics after IsFinished; changing text, width or fonts makes them pending again.

public int GetLineHeight(int line);

Display-row height: ascent + descent + theme line separation. Formatting can make heights differ between rows. Supply an existing index. With Threaded, read final metrics after IsFinished; changing text, width or fonts makes them pending again.

public float GetLineOffset(int line);

Vertical display-row offset within content, in pixels. Neither a global screen position nor a coordinate already adjusted for scrolling. Validate the index first: zero is also a valid first-row offset.

public Vector2I GetLineRange(int line);

Content-position range for a calculated display row: X start, Y end. Not source-BBCode or UTF-16 indices. Validate zero <= line < GetLineCount first; (0, 0) is not a reliable error sentinel. With Threaded, read final metrics after IsFinished; changing text, width or fonts makes them pending again.

public int GetLineWidth(int line);

Pixel width of an existing calculated display row. Supply an index from zero through GetLineCount() - 1 rather than a paragraph index. With Threaded, read final metrics after IsFinished; changing text, width or fonts makes them pending again.

public int GetMaximumFontSize();

Upper font-fitting bound with ResizeFontToFit. Keep consistent with MinimumFontSize; constrains fitting rather than universally prohibiting local BBCode font sizes.

public PopupMenu GetMenu();

Returns the built-in PopupMenu, creating it on first access without showing it. The label owns and frees it; do not Free/Dispose this borrowed reference.

public int GetMinimumFontSize();

Lower font-fitting bound with ResizeFontToFit. Supply a positive value no greater than MaximumFontSize. Assignment does not mean this exact size is already drawn.

public int GetParagraphCount();

Number of paragraphs in the main content flow. Automatic wrapping within a paragraph does not create another paragraph. Not the number of all display rows or nested table cells.

public float GetParagraphOffset(int paragraph);

Calculated paragraph’s vertical offset in content pixels. Validate index and readiness; zero can mean either the start or an unavailable result.

public string GetParsedText();

Returns plain text from constructed content without tags. Inline images become spaces; lists/indents may add tabs. Not a reverse conversion to source BBCode or a copy of Text.

public int GetProgressBarDelay();

Delay before displaying background-loading progress, in milliseconds. A positive value waits that interval; zero and negative values disable the indicator. Does not set parsing speed or character-reveal timing.

public int GetRenderedFontSize();

Current calculated base-font fitting value. Does not describe every locally formatted span. Disabling fitting resets the cache to zero; do not use zero as a real size when creating another font.

public string GetSelectedText();

Returns selected plain text without tags, or an empty string when selection is absent/disabled. Inline images become spaces; tables are traversed as content. Not a slice of source Text containing BBCode.

public int GetSelectionFrom();

Returns the active selection’s starting content-model position, or -1. Not a source-BBCode or UTF-16 string index; use GetSelectedText to retrieve text, especially with tables and inline objects.

public float GetSelectionLineOffset();

Vertical pixel offset of the selection start in content, accounting for wrapping and nested frames. -1 means no suitable selection. Neither a line number nor a global screen coordinate.

public int GetSelectionTo();

Returns the active selection’s inclusive final position, or -1. For an ordinary content range, length is to - from + 1; unlike TextEdit’s exclusive endpoint. Do not use directly as a C# source-string slice index.

public TextServer.StructuredTextParser GetStructuredTextBidiOverride();

Selects parsing of structured bidirectional text, such as addresses or paths. A shaping setting rather than a regex replacement of source text. StructuredTextBidiOverrideOptions supplies parameters.

public Reckfell.Collections.Array GetStructuredTextBidiOverrideOptions();

Structured BiDi-parser parameters. The array is shared; in-place mutation does not automatically trigger recalculation. Assign a new array with different content to update: the setter may skip equal content.

public int GetTabSize();

Default tab width measured in spaces; use a positive value. Changes tab presentation without replacing tabs with spaces in Text. Use TabStops for explicit positions.

public float[] GetTabStops();

Explicit tab positions in text-area pixels; supply increasing positive values. C# float[] transfers data and the getter returns values: mutating the result does not reconfigure the label. Does not set source-line indentation.

public string GetText();

Source string for rebuilding the label, including UI translation and BBCode parsing when BbcodeEnabled. Assignment replaces manual content; assigning the same nonempty string may not rebuild it. AddText, AppendText and Push methods do not append their result to this property. Use GetParsedText for resulting plain text.

public Control.TextDirection GetTextDirection();

Text direction for BiDi shaping. Does not manually reverse source characters or translate text. Configure structured-text parsing separately.

public int GetTotalCharacterCount();

Counts content without BBCode tags: text code points, line breaks and one position per inline image. Not Text.Length, glyph count or the number of already visible letters. Use as a reveal limit rather than a source-BBCode slice index.

public VScrollBar GetVScrollBar();

Returns the label-owned VScrollBar. Do not Free/Dispose it or reparent it. Its value uses content pixels; the usable range accounts for the scrollbar page size.

public VerticalAlignment GetVerticalAlignment();

Vertical placement of text content inside the label. Does not change Control alignment in its parent or enable automatic scrolling.

public int GetVisibleCharacters();

Progressive-reveal limit: -1 shows all, zero hides text, a nonnegative value sets a limit. VisibleCharactersBehavior chooses behavior before/after glyph shaping. Not a frame count or Text’s UTF-16 Length. The setter updates VisibleRatio but does not explicitly clamp oversized values; keep animation values between zero and GetTotalCharacterCount.

public TextServer.VisibleCharactersBehavior GetVisibleCharactersBehavior();

Chooses whether reveal limits apply before shaping or to shaped characters/glyphs. Before shaping may change layout; after shaping retains full-line context, with reveal units depending on mode. Account for ligatures, composite characters and RTL; do not assume one C# char per visible glyph.

public Rect2I GetVisibleContentRect();

Cached rectangle of drawn visible content in label coordinates. Neither full content size nor a screen rectangle. Before an updated draw, may be empty or belong to the previous frame; IsFinished alone does not update this cache.

public int GetVisibleLineCount();

Visible-row count from drawing results. Neither viewport row capacity nor total GetLineCount. Returns zero when Visible is false; after text/size changes, wait for an updated frame. IsFinished confirms calculation, not that a new frame exists.

public int GetVisibleParagraphCount();

Visible paragraph count from drawing, not wrapped row count. Requires a frame after content/scroll changes for a current result; returns zero when Visible is false.

public float GetVisibleRatio();

Reveal fraction: values from zero to one convert to integer VisibleCharacters by truncation. One or greater shows all; a negative value hides text. Creates no timer: animate the fraction from your application. Refers to the content counter rather than necessarily the number of visually distinct letters.

public void InstallEffect(Variant effect);

Appends a RichTextEffect resource to registered effects and calls ReloadEffects. Does not automatically replace an existing resource with the same tag name. The effect script defines its BBCode name; use PushCustomfx to bypass name lookup.

public bool InvalidateParagraph(int paragraph);

Marks shaping, sizing and font caches stale starting at the supplied paragraph. Does not remove it, change Text or fully reparse BBCode. true means an accepted index rather than completed recalculation; test IsFinished separately.

public bool IsContextMenuEnabled();

Allows opening the built-in user menu. false neither deletes the PopupMenu nor prohibits programmatic GetMenu/MenuOption. An interface setting rather than a restriction on application data copying.

public bool IsDeselectOnFocusLossEnabled();

Allows deselection on focus loss. Switching false to true while unfocused immediately clears an existing selection. Use false to retain it when moving to another control.

public bool IsDragAndDropSelectionEnabled();

Allows dragging selected plain text out of the label. Requires SelectionEnabled; does not enable editing or arbitrary file drops. Assignment does not initiate a drag.

public bool IsFinished();

Tests whether current shaping, sizing and font calculations are complete. The query may itself initiate cache updates; neither a blocking wait nor a test of VisibleCharacters animation completion. When subscribing to Finished, account for text that may already be ready.

public bool IsFitContentEnabled();

Includes content in the label’s minimum size. A parent container may expand it; does not set an exact Size or shrink the font. Account for wrapping and parent constraints.

public bool IsHintUnderlined();

Allows visual underlining of PushHint spans. Does not enable/disable tooltip content or edit text.

public bool IsMenuVisible();

Tests the existing menu’s actual visibility without creating it. false before creation does not mean ContextMenuEnabled is disabled.

public bool IsMetaUnderlined();

Allows underlining metadata spans according to their MetaUnderline policy. Does not create links or open URLs. An explicit PushUnderline span is separate formatting.

public bool IsReady();

Obsolete alias for IsFinished. Use IsFinished; this concerns layout readiness rather than entity lifecycle readiness or entering the tree.

public bool IsResizeFontToFitEnabled();

Allows choosing a base font size for the available area within MinimumFontSize–MaximumFontSize. Unlike FitContent, adjusts the font rather than the minimum-size requirement. Fitting depends on width and height; a tiny minimum does not ensure legibility.

public bool IsScrollActive();

Allows built-in vertical scrolling. Toggling reapplies source Text: when mixed with manual AddText/Push, content may rebuild from the stored string. Set the mode before manual construction. Does not mean all content fits without a scrollbar.

public bool IsScrollFollowing();

Allows following the end of appended text. If the user scrolls upward, actual following can pause until returning to the bottom. The getter reports the setting rather than whether the view is currently at the bottom.

public bool IsScrollFollowingVisibleCharacters();

Scrolls to content revealed through VisibleCharacters. Differs from following the full text end; intended for progressive reveal. Setting true may immediately change scrolling.

public bool IsSelectionEnabled();

Allows selecting displayed text and using SelectAll. Enabling sets FocusMode.All; disabling clears active selection and switches to accessibility focus mode. Does not make the label editable or change Text.

public bool IsShortcutKeysEnabled();

Allows the label’s built-in command shortcuts. Does not automatically enable SelectionEnabled or prohibit direct SelectAll/MenuOption calls.

public bool IsThreaded();

Allows background text layout; defaults to false. Does not make arbitrary RichTextLabel calls thread-safe or move all drawing to another thread. Check IsFinished; until completion, metrics may cover only the processed portion.

public bool IsUsingBbcode();

Controls BBCode parsing of the Text property. Does not make manual AddText parse markup; AppendText parses markup independently. Toggling does not guarantee rebuilding a manually modified stack.

public void MenuOption(int option);

Executes an int MenuItems command ID rather than a menu row index. Copy copies selected text or, when empty, all GetParsedText even if SelectionEnabled is disabled. SelectAll requires selection permission. Does not open the menu; ContextMenuEnabled does not block a direct call.

public void Newline();

Adds an explicit newline to constructed content and starts the next paragraph in the current frame. Does not update source Text; not automatic width-based wrapping.

public void ParseBbcode(string bbcode);

Clears the displayed content and parses the supplied markup. A full parse rather than AppendText appending. Does not assign Text; set Text with BbcodeEnabled to retain the source string.

public Reckfell.Collections.Dictionary ParseExpressionsForValues(ReadOnlySpan<string> expressions);

Parses key=value parameters without executing code or mathematical expressions. Recognizes exact true/false, numbers, #RGB/#RRGGBB and $path as EntityPath; other values remain strings. Comma-separated values become an Array. An invalid number of = signs returns the Dictionary accumulated so far. Array and Span overloads use the same parser; do not assume arbitrary whitespace trimming.

public Reckfell.Collections.Dictionary ParseExpressionsForValues(string[] expressions);

Parses key=value parameters without executing code or mathematical expressions. Recognizes exact true/false, numbers, #RGB/#RRGGBB and $path as EntityPath; other values remain strings. Comma-separated values become an Array. An invalid number of = signs returns the Dictionary accumulated so far. Array and Span overloads use the same parser; do not assume arbitrary whitespace trimming.

public void Pop();

Closes one current formatting span while retaining its content. Call only after a corresponding Push: the root has no parent. Does not delete the last character.

public void PopAll();

Returns the current construction span to the root without removing content. Resets the construction position rather than clearing text or reliably repairing malformed BBCode.

public void PopContext();

Leaves nested spans through the nearest PushContext boundary. Without one, ascends to the root. Retains text already added.

public void PushBgcolor(Color bgcolor);

Opens a rectangular background-color span behind text rather than changing glyph color through PushColor. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushBold();

Opens a theme bold-font span; combines with active italics. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushBoldItalics();

Opens a theme bold-italic font span. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushCell();

Opens the next cell only when the current span is a table. Apply SetCell settings immediately, then add text/formatting; Pop returns to the table. Every column-count cells starts another row. A nested table may be opened within a cell.

public void PushColor(Color color);

Opens a text-glyph color span, including alpha. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushContext();

Places a context boundary for subsequent Push spans. PopContext closes nested spans through that boundary; does not undo text already added.

public void PushCustomfx(RichTextEffect effect, Reckfell.Collections.Dictionary env);

Opens an effect span: call PushCustomfx, add text with AddText, then close it with Pop. Uses the resource directly without registering a BBCode tag. env is shared by reference; create a separate dictionary for independent parameters. Does not create text or apply the effect to already completed spans.

public void PushDropcap(string @string, Font font, int size, Rect2? dropcapMargins = default, Color? color = default, int outlineSize = 0, Color? outlineColor = default);

Adds a decorative drop cap as standalone content: requires nonempty text, a valid Font and a positive size. Unlike ordinary Push spans, requires no corresponding Pop. Does not alter an existing first letter or append source Text.

public void PushFgcolor(Color fgcolor);

Opens a foreground rectangular-color span over text. Use PushColor for ordinary letter color; an opaque foreground fill can cover letters. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushFont(Font font, int fontSize = 0);

Opens a span using a Font resource and optional size. The resource is shared; do not free a borrowed label resource. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushFontSize(int fontSize);

Opens a positive pixel font-size span while retaining the selected font. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushHint(string description);

Opens a tooltip span for following content. Add text, then call Pop. Does not add a character or navigation handler.

public void PushIndent(int level);

Opens an indentation span with a nonnegative level. Does not insert spaces into source Text. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushItalics();

Opens a theme italic-font span; combines with active bold. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushLanguage(string language);

Opens a text-shaping language-hint span. Does not translate its contents. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushList(int level, RichTextLabel.ListType type, bool capitalize);

Opens a list with a specified type and level. Add item text separated by Newline; bullets/numbering are presentation rather than source-BBCode characters. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushList(int level, RichTextLabel.ListType type, bool capitalize, string bullet = "\u2022");

Opens a list with a specified type and level. Add item text separated by Newline; bullets/numbering are presentation rather than source-BBCode characters. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushMeta(Variant data);

Opens a metadata span for following text; close it with Pop. data is passed to MetaClicked/MetaHoverStarted/MetaHoverEnded. It may be an ID or URL, but RichTextLabel does not open it automatically. underlineMode controls link appearance; tooltip supplies a hint.

public void PushMeta(Variant data, RichTextLabel.MetaUnderline underlineMode);

Opens a metadata span for following text; close it with Pop. data is passed to MetaClicked/MetaHoverStarted/MetaHoverEnded. It may be an ID or URL, but RichTextLabel does not open it automatically. underlineMode controls link appearance; tooltip supplies a hint.

public void PushMeta(Variant data, RichTextLabel.MetaUnderline underlineMode = RichTextLabel.MetaUnderline.Always, string tooltip = "");

Opens a metadata span for following text; close it with Pop. data is passed to MetaClicked/MetaHoverStarted/MetaHoverEnded. It may be an ID or URL, but RichTextLabel does not open it automatically. underlineMode controls link appearance; tooltip supplies a hint.

public void PushMono();

Opens a theme monospace-font span. Does not enable code highlighting or language analysis. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushNormal();

Opens a theme normal-font span. Does not reset every other color, indent or nested span. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushOutlineColor(Color color);

Opens a glyph-outline color span. Does not itself set a nonzero outline width. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushOutlineSize(int outlineSize);

Opens a pixel outline-width span; zero disables the outline in this span. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushParagraph(HorizontalAlignment alignment, Control.TextDirection baseDirection, string language, TextServer.StructuredTextParser stParser);

Opens paragraph settings: alignment, direction, language, BiDi parser, justification and tab positions. These configure content rather than a Control container. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushParagraph(HorizontalAlignment alignment, Control.TextDirection baseDirection, string language, TextServer.StructuredTextParser stParser, TextServer.JustificationFlag justificationFlags, ReadOnlySpan<float> tabStops);

Opens paragraph settings: alignment, direction, language, BiDi parser, justification and tab positions. These configure content rather than a Control container. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushParagraph(HorizontalAlignment alignment, Control.TextDirection baseDirection = Control.TextDirection.Auto, string language = "", TextServer.StructuredTextParser stParser = TextServer.StructuredTextParser.Default, TextServer.JustificationFlag justificationFlags = TextServer.JustificationFlag.Kashida | TextServer.JustificationFlag.WordBound | TextServer.JustificationFlag.SkipLastLine | TextServer.JustificationFlag.DoNotSkipSingleLine, float[] tabStops = null);

Opens paragraph settings: alignment, direction, language, BiDi parser, justification and tab positions. These configure content rather than a Control container. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushStrikethrough();

Opens text strikethrough. Does not remove characters from GetParsedText or selection. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushStrikethrough(Color? color = default);

Opens text strikethrough. Does not remove characters from GetParsedText or selection. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushTable(int columns, InlineAlignment inlineAlign, int alignToRow);

Opens a table with a positive column count. Configure columns, then for each cell call PushCell, add content and Pop the cell; another Pop after all cells closes the table. Cells fill in row order; there is no separate PushRow. alignToRow selects an alignment row, with -1 using the last. name supplies an accessibility description rather than a visible heading.

public void PushTable(int columns, InlineAlignment inlineAlign = InlineAlignment.TopTo, int alignToRow = -1, string name = "");

Opens a table with a positive column count. Configure columns, then for each cell call PushCell, add content and Pop the cell; another Pop after all cells closes the table. Cells fill in row order; there is no separate PushRow. alignToRow selects an alignment row, with -1 using the last. name supplies an accessibility description rather than a visible heading.

public void PushUnderline();

Opens text underlining. A color with alpha zero uses the current text color and theme alpha rather than drawing an invisible line. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void PushUnderline(Color? color = default);

Opens text underlining. A color with alpha zero uses the current text color and theme alpha rather than drawing an invisible line. Add content and close the span with Pop. Does not rewrite earlier items or source Text.

public void ReloadEffects();

Reparses stored Text only when BBCode is enabled and the stack has not been externally modified. Not a universal reload for manually constructed spans: rebuild the required content explicitly.

public bool RemoveParagraph(int paragraph);

Removes a main-flow paragraph and its owned content, clearing selection. Later paragraph indices shift; removing the only one leaves empty content with one paragraph. Does not rewrite source Text and has no built-in Undo. noInvalidate false invalidates affected caches; true retains them for an optimized path requiring separate cache-freshness management. Returns false for an invalid index.

public bool RemoveParagraph(int paragraph, bool noInvalidate = false);

Removes a main-flow paragraph and its owned content, clearing selection. Later paragraph indices shift; removing the only one leaves empty content with one paragraph. Does not rewrite source Text and has no built-in Undo. noInvalidate false invalidates affected caches; true retains them for an optimized path requiring separate cache-freshness management. Returns false for an invalid index.

public void ScrollToLine(int line);

Scrolls to a wrapped display row rather than a logical source-BBCode line. Values <= zero go to the start; an oversized index goes to the end of available layout. Wait for readiness first when an exact position is needed.

public void ScrollToParagraph(int paragraph);

Scrolls to a main-flow paragraph. Values <= zero go to the start; values beyond calculated paragraphs go to the scrollbar end. Does not select or edit text.

public void ScrollToSelection();

Scrolls to the current selection start using GetSelectionLineOffset. Does nothing without a selection. Does not create selection or edit content.

public void SelectAll();

Selects constructed content when SelectionEnabled. Does not copy to the clipboard. With background layout, wait for IsFinished so selection bounds cover ready content.

public void SetAutowrapMode(TextServer.AutowrapMode autowrapMode);

Wrapping rule for available width: off, arbitrary or word-based. Changes display rows and metrics while retaining source Text. Give the label a layout width for predictable results.

public void SetAutowrapTrimFlags(TextServer.LineBreakFlag autowrapTrimFlags);

Flags for edge-whitespace/indent handling during wrapping. The setter retains only TextServer trim-mask bits; other LineBreakFlag values do not select a separate wrapping mode here. Source text is not trimmed.

public void SetCellBorderColor(Color color);

Sets only the current cell’s border color. Color(0,0,0,0) restores the theme color, so does not guarantee hiding a nonzero theme border. Configure directly in the cell before opening nested Push spans.

public void SetCellPadding(Rect2 padding);

Sets current-cell padding: Rect2.Position.X/Y are left/top, Rect2.Size.X/Y are right/bottom. Packs four edge values rather than an ordinary width/height rectangle. Use nonnegative values and configure immediately after PushCell.

public void SetCellRowBackgroundColor(Color oddRowBg, Color evenRowBg);

Sets two background colors for the current cell; drawing chooses one according to table-row parity. Does not automatically recolor other cells in the row. Color(0,0,0,0) restores the corresponding theme background.

public void SetCellSizeOverride(Vector2 minSize, Vector2 maxSize);

Stores current-cell size constraints. Current layout consumes positive Y values as minimum/maximum height; X does not set column width. A nonpositive Y leaves that bound unset. In a multi-paragraph cell, Y bounds calculated individual paragraph heights rather than their sum. Configure columns for width and keep bounds consistent. Call immediately after PushCell.

public void SetContextMenuEnabled(bool enabled);

Allows opening the built-in user menu. false neither deletes the PopupMenu nor prohibits programmatic GetMenu/MenuOption. An interface setting rather than a restriction on application data copying.

public void SetDeselectOnFocusLossEnabled(bool enable);

Allows deselection on focus loss. Switching false to true while unfocused immediately clears an existing selection. Use false to retain it when moving to another control.

public void SetDragAndDropSelectionEnabled(bool enable);

Allows dragging selected plain text out of the label. Requires SelectionEnabled; does not enable editing or arbitrary file drops. Assignment does not initiate a drag.

public void SetEffects(Reckfell.Collections.Array effects);

Custom BBCode effect resources. The setter replaces the array and calls ReloadEffects; the getter shares the array, so mutating it does not itself reparse text. Duplicate names are ambiguous: the first matching name is used. Use PushCustomfx for direct programmatic application.

public void SetFitContent(bool enabled);

Includes content in the label’s minimum size. A parent container may expand it; does not set an exact Size or shrink the font. Account for wrapping and parent constraints.

public void SetHintUnderline(bool enable);

Allows visual underlining of PushHint spans. Does not enable/disable tooltip content or edit text.

public void SetHorizontalAlignment(HorizontalAlignment alignment);

Default horizontal text alignment; local paragraph formatting may override it. Fill uses JustificationFlags for justification. Does not move the Control in its parent container.

public void SetJustificationFlags(TextServer.JustificationFlag justificationFlags);

Line-stretching rules for justified text, such as word and final-line handling. Work with the corresponding alignment rather than setting label width.

public void SetLanguage(string language);

Language hint for text shaping and wrapping. Does not translate the string; UI translation of source Text is a separate mechanism.

public void SetMaximumFontSize(int size);

Upper font-fitting bound with ResizeFontToFit. Keep consistent with MinimumFontSize; constrains fitting rather than universally prohibiting local BBCode font sizes.

public void SetMetaUnderline(bool enable);

Allows underlining metadata spans according to their MetaUnderline policy. Does not create links or open URLs. An explicit PushUnderline span is separate formatting.

public void SetMinimumFontSize(int size);

Lower font-fitting bound with ResizeFontToFit. Supply a positive value no greater than MaximumFontSize. Assignment does not mean this exact size is already drawn.

public void SetProgressBarDelay(int delayMs);

Delay before displaying background-loading progress, in milliseconds. A positive value waits that interval; zero and negative values disable the indicator. Does not set parsing speed or character-reveal timing.

public void SetResizeFontToFit(bool enabled);

Allows choosing a base font size for the available area within MinimumFontSize–MaximumFontSize. Unlike FitContent, adjusts the font rather than the minimum-size requirement. Fitting depends on width and height; a tiny minimum does not ensure legibility.

public void SetScrollActive(bool active);

Allows built-in vertical scrolling. Toggling reapplies source Text: when mixed with manual AddText/Push, content may rebuild from the stored string. Set the mode before manual construction. Does not mean all content fits without a scrollbar.

public void SetScrollFollow(bool follow);

Allows following the end of appended text. If the user scrolls upward, actual following can pause until returning to the bottom. The getter reports the setting rather than whether the view is currently at the bottom.

public void SetScrollFollowVisibleCharacters(bool follow);

Scrolls to content revealed through VisibleCharacters. Differs from following the full text end; intended for progressive reveal. Setting true may immediately change scrolling.

public void SetSelectionEnabled(bool enabled);

Allows selecting displayed text and using SelectAll. Enabling sets FocusMode.All; disabling clears active selection and switches to accessibility focus mode. Does not make the label editable or change Text.