@ringozz/godot 0.1.0

package/gen/classes/RichTextLabel.ts

@@ -0,0 +1,860 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R, _G } from '../../src/runtime.ts';
+import { Control } from './Control.ts';
+import type { HorizontalAlignment, InlineAlignment, VerticalAlignment } from '../global-enums.ts';
+import type { GodotArray, GodotDictionary, PackedFloat32Array, PackedStringArray, Signal, Variant } from '../heap-types/index.ts';
+import type { Color, Rect2, Rect2i, Vector2, Vector2i } from '../value-types/index.ts';
+import type { TextDirection } from './Control.ts';
+import type { Font } from './Font.ts';
+import type { PopupMenu } from './PopupMenu.ts';
+import type { RichTextEffect } from './RichTextEffect.ts';
+import type { AutowrapMode, JustificationFlag, LineBreakFlag, StructuredTextParser, VisibleCharactersBehavior } from './TextServer.ts';
+import type { Texture2D } from './Texture2D.ts';
+import type { VScrollBar } from './VScrollBar.ts';
+
+/**
+ * A control for displaying text that can contain custom fonts, images, and basic formatting. {@link RichTextLabel} manages these as an internal tag stack. It also adapts itself to given width/heights.
+ * **Note:** {@link newline}, {@link pushParagraph}, `"\n"`, `"\r\n"`, `p` tag, and alignment tags start a new paragraph. Each paragraph is processed independently, in its own BiDi context. If you want to force line wrapping within paragraph, any other line breaking character can be used, for example, Form Feed (U+000C), Next Line (U+0085), Line Separator (U+2028).
+ * **Note:** Assignments to {@link text} clear the tag stack and reconstruct it from the property's contents. Any edits made to {@link text} will erase previous edits made from other manual sources such as {@link appendText} and the `push_*` / {@link pop} methods.
+ * **Note:** RichTextLabel doesn't support entangled BBCode tags. For example, instead of using {@link code skip-lint}**bold[i]bold italic[/i]italic**, use {@link code skip-lint}**bold[i]bold italic[/i]***italic*.
+ * **Note:** `push_*\/pop_*` functions won't affect BBCode.
+ * **Note:** While {@link bbcodeEnabled} is enabled, alignment tags such as {@link code skip-lint}{@link center} will take priority over the {@link horizontalAlignment} setting which determines the default text alignment.
+ */
+export class RichTextLabel extends Control {
+    constructor(name = 670) { super(name); }
+
+    /**
+     * Returns the text without BBCode mark-up.
+     */
+    getParsedText(): string { return _C(this, 5830) as string; }
+
+    /**
+     * Adds raw non-BBCode-parsed text to the tag stack.
+     */
+    addText(text: string): void { _C(this, 1307, text); }
+
+    /**
+     * Adds a horizontal rule that can be used to separate content.
+     * If `widthInPercent` is set, `width` values are percentages of the control width instead of pixels.
+     * If `heightInPercent` is set, `height` values are percentages of the control width instead of pixels.
+     */
+    addHr(width?: number /* = 90 */, height?: number /* = 2 */, color?: Color /* = Color(1, 1, 1, 1) */, alignment?: HorizontalAlignment /* = 1 */, widthInPercent?: boolean /* = true */, heightInPercent?: boolean /* = false */): void { _C(this, 1226, width, height, color, alignment, widthInPercent, heightInPercent); }
+
+    /**
+     * Adds an image's opening and closing tags to the tag stack, optionally providing a `width` and `height` to resize the image, a `color` to tint the image and a `region` to only use parts of the image.
+     * If `width` or `height` is set to 0, the image size will be adjusted in order to keep the original aspect ratio.
+     * If `width` and `height` are not set, but `region` is, the region's rect will be used.
+     * `key` is an optional identifier, that can be used to modify the image via {@link updateImage}.
+     * If `pad` is set, and the image is smaller than the size specified by `width` and `height`, the image padding is added to match the size instead of upscaling.
+     * Parameters `widthUnit` and `heightUnit` determine the units used to calculate the image width and height, respectively.
+     * `altText` is used as the image description for assistive apps.
+     */
+    addImage(image: Texture2D, width?: number /* = 0 */, height?: number /* = 0 */, color?: Color /* = Color(1, 1, 1, 1) */, inlineAlign?: InlineAlignment /* = 5 */, region?: Rect2 /* = Rect2(0, 0, 0, 0) */, key?: Variant /* = null */, pad?: boolean /* = false */, tooltip?: string /* = "" */, widthUnit?: ImageUnit /* = 0 */, heightUnit?: ImageUnit /* = 0 */, altText?: string /* = "" */): void { _C(this, 1235, image, width, height, color, inlineAlign, region, key, pad, tooltip, widthUnit, heightUnit, altText); }
+
+    /**
+     * Updates the existing images with the key `key`. Only properties specified by `mask` bits are updated. See {@link addImage}.
+     */
+    updateImage(key: Variant, mask: ImageUpdateMask, image: Texture2D, width?: number /* = 0 */, height?: number /* = 0 */, color?: Color /* = Color(1, 1, 1, 1) */, inlineAlign?: InlineAlignment /* = 5 */, region?: Rect2 /* = Rect2(0, 0, 0, 0) */, pad?: boolean /* = false */, tooltip?: string /* = "" */, widthUnit?: ImageUnit /* = 0 */, heightUnit?: ImageUnit /* = 0 */): void { _C(this, 14516, key, mask, image, width, height, color, inlineAlign, region, pad, tooltip, widthUnit, heightUnit); }
+
+    /**
+     * Adds a newline tag to the tag stack.
+     */
+    newline(): void { _C(this, 9069); }
+
+    /**
+     * Removes a paragraph of content from the label. Returns `true` if the paragraph exists.
+     * The `paragraph` argument is the index of the paragraph to remove, it can take values in the interval `[0, get_paragraph_count() - 1]`.
+     * If `noInvalidate` is set to `true`, cache for the subsequent paragraphs is not invalidated. Use it for faster updates if deleted paragraph is fully self-contained (have no unclosed tags), or this call is part of the complex edit operation and {@link invalidateParagraph} will be called at the end of operation.
+     */
+    removeParagraph(paragraph: number, noInvalidate?: boolean /* = false */): boolean { return _C(this, 9942, paragraph, noInvalidate) as boolean; }
+
+    /**
+     * Invalidates `paragraph` and all subsequent paragraphs cache.
+     */
+    invalidateParagraph(paragraph: number): boolean { return _C(this, 7712, paragraph) as boolean; }
+
+    /**
+     * Adds a {@link code skip-lint}{@link font}[/code] tag to the tag stack. Overrides default fonts for its duration.
+     * Passing `0` to `fontSize` will use the existing default font size.
+     */
+    pushFont(font: Font, fontSize?: number /* = 0 */): void { _C(this, 9642, font, fontSize); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link font_size}[/code] tag to the tag stack. Overrides default font size for its duration.
+     */
+    pushFontSize(fontSize: number): void { _C(this, 9643, fontSize); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link font}[/code] tag with a normal font to the tag stack.
+     */
+    pushNormal(): void { _C(this, 9654); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link font}[/code] tag with a bold font to the tag stack. This is the same as adding a {@link code skip-lint}{@link b}[/code] tag if not currently in a {@link code skip-lint}{@link i}[/code] tag.
+     */
+    pushBold(): void { _C(this, 9632); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link font}[/code] tag with a bold italics font to the tag stack.
+     */
+    pushBoldItalics(): void { _C(this, 9633); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link font}[/code] tag with an italics font to the tag stack. This is the same as adding an {@link code skip-lint}{@link i}[/code] tag if not currently in a {@link code skip-lint}{@link b}[/code] tag.
+     */
+    pushItalics(): void { _C(this, 9649); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link font}[/code] tag with a monospace font to the tag stack.
+     */
+    pushMono(): void { _C(this, 9653); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link color}[/code] tag to the tag stack.
+     */
+    pushColor(color: Color): void { _C(this, 9636, color); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link outline_size}[/code] tag to the tag stack. Overrides default text outline size for its duration.
+     */
+    pushOutlineSize(outlineSize: number): void { _C(this, 9656, outlineSize); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link outline_color}[/code] tag to the tag stack. Adds text outline for its duration.
+     */
+    pushOutlineColor(color: Color): void { _C(this, 9655, color); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link p}[/code] tag to the tag stack.
+     */
+    pushParagraph(alignment: HorizontalAlignment, baseDirection?: TextDirection /* = 0 */, language?: string /* = "" */, stParser?: StructuredTextParser /* = 0 */, justificationFlags?: JustificationFlag /* = 163 */, tabStops?: PackedFloat32Array /* = PackedFloat32Array() */): void { _C(this, 9657, alignment, baseDirection, language, stParser, justificationFlags, tabStops); }
+
+    /**
+     * Adds an {@link code skip-lint}{@link indent}[/code] tag to the tag stack. Multiplies `level` by current {@link tabSize} to determine new margin length.
+     */
+    pushIndent(level: number): void { _C(this, 9647, level); }
+
+    /**
+     * Adds {@link code skip-lint}{@link ol}[/code] or {@link code skip-lint}{@link ul}[/code] tag to the tag stack. Multiplies `level` by current {@link tabSize} to determine new margin length.
+     */
+    pushList(level: number, type: ListType, capitalize: boolean, bullet?: string /* = "•" */): void { _C(this, 9651, level, type, capitalize, bullet); }
+
+    /**
+     * Adds a meta tag to the tag stack. Similar to the BBCode {@link code skip-lint}[{text}](something)[/code], but supports non-{@link String} metadata types.
+     * If {@link metaUnderlined} is `true`, meta tags display an underline. This behavior can be customized with `underlineMode`.
+     * **Note:** Meta tags do nothing by default when clicked. To assign behavior when clicked, connect {@link meta_clicked} to a function that is called when the meta tag is clicked.
+     */
+    pushMeta(data: Variant, underlineMode?: MetaUnderline /* = 1 */, tooltip?: string /* = "" */): void { _C(this, 9652, data, underlineMode, tooltip); }
+
+    /**
+     * Adds a {@link code skip-lint} tag to the tag stack. Same as BBCode {@link code skip-lint}[/code].
+     */
+    pushHint(description: string): void { _C(this, 9646, description); }
+
+    /**
+     * Adds language code used for text shaping algorithm and Open-Type font features.
+     */
+    pushLanguage(language: string): void { _C(this, 9650, language); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link u}[/code] tag to the tag stack. If `color`'s alpha value is `0.0`, the current font's color with its alpha multiplied by {@link underline_alpha} is used.
+     */
+    pushUnderline(color?: Color /* = Color(0, 0, 0, 0) */): void { _C(this, 9661, color); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link s}[/code] tag to the tag stack. If `color`'s alpha value is `0.0`, the current font's color with its alpha multiplied by {@link strikethrough_alpha} is used.
+     */
+    pushStrikethrough(color?: Color /* = Color(0, 0, 0, 0) */): void { _C(this, 9658, color); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link table}[/code] tag to the tag stack. Use {@link setTableColumnExpand} to set column expansion ratio. Use {@link pushCell} to add cells. `name` is used as the table name for assistive apps.
+     */
+    pushTable(columns: number, inlineAlign?: InlineAlignment /* = 0 */, alignToRow?: number /* = -1 */, name?: string /* = "" */): void { _C(this, 9659, columns, inlineAlign, alignToRow, name); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link dropcap}[/code] tag to the tag stack. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text.
+     */
+    pushDropcap(string: string, font: Font, size: number, dropcapMargins?: Rect2 /* = Rect2(0, 0, 0, 0) */, color?: Color /* = Color(1, 1, 1, 1) */, outlineSize?: number /* = 0 */, outlineColor?: Color /* = Color(0, 0, 0, 0) */): void { _C(this, 9639, string, font, size, dropcapMargins, color, outlineSize, outlineColor); }
+
+    /**
+     * Edits the selected column's expansion options. If `expand` is `true`, the column expands in proportion to its expansion ratio versus the other columns' ratios.
+     * For example, 2 columns with ratios 3 and 4 plus 70 pixels in available width would expand 30 and 40 pixels, respectively.
+     * If `expand` is `false`, the column will not contribute to the total ratio.
+     */
+    setTableColumnExpand(column: number, expand: boolean, ratio?: number /* = 1 */, shrink?: boolean /* = true */): void { _C(this, 12985, column, expand, ratio, shrink); }
+
+    /**
+     * Sets table column name for assistive apps.
+     */
+    setTableColumnName(column: number, name: string): void { _C(this, 12986, column, name); }
+
+    /**
+     * Sets color of a table cell. Separate colors for alternating rows can be specified.
+     */
+    setCellRowBackgroundColor(oddRowBg: Color, evenRowBg: Color): void { _C(this, 10826, oddRowBg, evenRowBg); }
+
+    /**
+     * Sets color of a table cell border.
+     */
+    setCellBorderColor(color: Color): void { _C(this, 10821, color); }
+
+    /**
+     * Sets minimum and maximum size overrides for a table cell.
+     */
+    setCellSizeOverride(minSize: Vector2, maxSize: Vector2): void { _C(this, 10830, minSize, maxSize); }
+
+    /**
+     * Sets inner padding of a table cell.
+     */
+    setCellPadding(padding: Rect2): void { _C(this, 10825, padding); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link cell}[/code] tag to the tag stack. Must be inside a {@link code skip-lint}{@link table}[/code] tag. See {@link pushTable} for details. Use {@link setTableColumnExpand} to set column expansion ratio, {@link setCellBorderColor} to set cell border, {@link setCellRowBackgroundColor} to set cell background, {@link setCellSizeOverride} to override cell size, and {@link setCellPadding} to set padding.
+     */
+    pushCell(): void { _C(this, 9635); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link fgcolor}[/code] tag to the tag stack.
+     * **Note:** The foreground color has padding applied by default, which is controlled using {@link text_highlight_h_padding} and {@link text_highlight_v_padding}. This can lead to overlapping highlights if foreground colors are placed on neighboring lines/columns, so consider setting those theme items to `0` if you want to avoid this.
+     */
+    pushFgcolor(fgcolor: Color): void { _C(this, 9641, fgcolor); }
+
+    /**
+     * Adds a {@link code skip-lint}{@link bgcolor}[/code] tag to the tag stack.
+     * **Note:** The background color has padding applied by default, which is controlled using {@link text_highlight_h_padding} and {@link text_highlight_v_padding}. This can lead to overlapping highlights if background colors are placed on neighboring lines/columns, so consider setting those theme items to `0` if you want to avoid this.
+     */
+    pushBgcolor(bgcolor: Color): void { _C(this, 9631, bgcolor); }
+
+    /**
+     * Adds a custom effect tag to the tag stack. The effect does not need to be in {@link customEffects}. The environment is directly passed to the effect.
+     */
+    pushCustomfx(effect: RichTextEffect, env: GodotDictionary): void { _C(this, 9638, effect, env); }
+
+    /**
+     * Adds a context marker to the tag stack. See {@link popContext}.
+     */
+    pushContext(): void { _C(this, 9637); }
+
+    /**
+     * Terminates tags opened after the last {@link pushContext} call (including context marker), or all tags if there's no context marker on the stack.
+     */
+    popContext(): void { _C(this, 9479); }
+
+    /**
+     * Terminates the current tag. Use after `push_*` methods to close BBCodes manually. Does not need to follow `add_*` methods.
+     */
+    pop(): void { _C(this, 9475); }
+
+    /**
+     * Terminates all tags opened by `push_*` methods.
+     */
+    popAll(): void { _C(this, 9476); }
+
+    /**
+     * Clears the tag stack, causing the label to display nothing.
+     * **Note:** This method does not affect {@link text}, and its contents will show again if the label is redrawn. However, setting {@link text} to an empty {@link String} also clears the stack.
+     */
+    clear(): void { _C(this, 2232); }
+
+    /**
+     * Returns the vertical scrollbar.
+     * **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their {@link CanvasItem.visible} property.
+     */
+    getVScrollBar(): VScrollBar { return _C(this, 7014) as VScrollBar; }
+
+    /**
+     * Scrolls the window's top line to match `line`.
+     */
+    scrollToLine(line: number): void { _C(this, 10296, line); }
+
+    /**
+     * Scrolls the window's top line to match first line of the `paragraph`.
+     */
+    scrollToParagraph(paragraph: number): void { _C(this, 10297, paragraph); }
+
+    /**
+     * Scrolls to the beginning of the current selection.
+     */
+    scrollToSelection(): void { _C(this, 10299); }
+
+    /**
+     * Returns the current selection first character index if a selection is active, `-1` otherwise. Does not include BBCodes.
+     */
+    getSelectionFrom(): number { return _C(this, 6332) as number; }
+
+    /**
+     * Returns the current selection last character index if a selection is active, `-1` otherwise. Does not include BBCodes.
+     */
+    getSelectionTo(): number { return _C(this, 6340) as number; }
+
+    /**
+     * Returns the current selection vertical line offset if a selection is active, `-1.0` otherwise.
+     */
+    getSelectionLineOffset(): number { return _C(this, 6336) as number; }
+
+    /**
+     * Select all the text.
+     * If {@link selectionEnabled} is `false`, no selection will occur.
+     */
+    selectAll(): void { _C(this, 10354); }
+
+    /**
+     * Returns the current selection text. Does not include BBCodes.
+     */
+    getSelectedText(): string { return _C(this, 6329) as string; }
+
+    /**
+     * Clears the current selection.
+     */
+    deselect(): void { _C(this, 2755); }
+
+    /**
+     * The assignment version of {@link appendText}. Clears the tag stack and inserts the new content.
+     */
+    parseBbcode(bbcode: string): void { _C(this, 9278, bbcode); }
+
+    /**
+     * Parses `bbcode` and adds tags to the tag stack as needed.
+     * **Note:** Using this method, you can't close a tag that was opened in a previous {@link appendText} call. This is done to improve performance, especially when updating large RichTextLabels since rebuilding the whole BBCode every time would be slower. If you absolutely need to close a tag in a future method call, append the {@link text} instead of using {@link appendText}.
+     */
+    appendText(bbcode: string): void { _C(this, 1525, bbcode); }
+
+    /**
+     * If {@link threaded} is enabled, returns `true` if the background thread has finished text processing, otherwise always return `true`.
+     */
+    isReady(): boolean { return _C(this, 8228) as boolean; }
+
+    /**
+     * If {@link threaded} is enabled, returns `true` if the background thread has finished text processing, otherwise always return `true`.
+     */
+    isFinished(): boolean { return _C(this, 7950) as boolean; }
+
+    /**
+     * Returns the line number of the character position provided. Line and character numbers are both zero-indexed.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getCharacterLine(character: number): number { return _C(this, 4144, character) as number; }
+
+    /**
+     * Returns the paragraph number of the character position provided. Paragraph and character numbers are both zero-indexed.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getCharacterParagraph(character: number): number { return _C(this, 4145, character) as number; }
+
+    /**
+     * Returns the total number of characters from text tags. Does not include BBCodes.
+     */
+    getTotalCharacterCount(): number { return _C(this, 6850) as number; }
+
+    /**
+     * Returns the total number of lines in the text. Wrapped text is counted as multiple lines.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getLineCount(): number { return _C(this, 5355) as number; }
+
+    /**
+     * Returns the indexes of the first and last visible characters for the given `line`, as a {@link Vector2i}.
+     * **Note:** If {@link visibleCharactersBehavior} is set to {@link TextServer.VC_CHARS_BEFORE_SHAPING} only visible wrapped lines are counted.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getLineRange(line: number): Vector2i { return _C(this, 5368, line) as Vector2i; }
+
+    /**
+     * Returns the number of visible lines.
+     * **Note:** This method returns a correct value only after the label has been drawn.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getVisibleLineCount(): number { return _C(this, 7108) as number; }
+
+    /**
+     * Returns the total number of paragraphs (newlines or `p` tags in the tag stack's text tags). Considers wrapped text as one paragraph.
+     */
+    getParagraphCount(): number { return _C(this, 5805) as number; }
+
+    /**
+     * Returns the number of visible paragraphs. A paragraph is considered visible if at least one of its lines is visible.
+     * **Note:** This method returns a correct value only after the label has been drawn.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getVisibleParagraphCount(): number { return _C(this, 7110) as number; }
+
+    /**
+     * Returns the height of the content.
+     * **Note:** This method always returns the full content size, and is not affected by {@link visibleRatio} and {@link visibleCharacters}. To get the visible content size, use {@link getVisibleContentRect}.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getContentHeight(): number { return _C(this, 4310) as number; }
+
+    /**
+     * Returns the width of the content.
+     * **Note:** This method always returns the full content size, and is not affected by {@link visibleRatio} and {@link visibleCharacters}. To get the visible content size, use {@link getVisibleContentRect}.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getContentWidth(): number { return _C(this, 4317) as number; }
+
+    /**
+     * Returns the height of the line found at the provided index.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether the document is fully loaded.
+     */
+    getLineHeight(line: number): number { return _C(this, 5362, line) as number; }
+
+    /**
+     * Returns the width of the line found at the provided index.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether the document is fully loaded.
+     */
+    getLineWidth(line: number): number { return _C(this, 5376, line) as number; }
+
+    /**
+     * Returns the bounding rectangle of the visible content.
+     * **Note:** This method returns a correct value only after the label has been drawn.
+     *
+     *
+     * ```gdscript
+     *
+     * extends RichTextLabel
+     *
+     * @export var background_panel: Panel
+     *
+     * func _ready():
+     * 	await draw
+     * 	background_panel.position = get_visible_content_rect().position
+     * 	background_panel.size = get_visible_content_rect().size
+     *
+     * ```
+     */
+    getVisibleContentRect(): Rect2i { return _C(this, 7106) as Rect2i; }
+
+    /**
+     * Returns the vertical offset of the line found at the provided index.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getLineOffset(line: number): number { return _C(this, 5367, line) as number; }
+
+    /**
+     * Returns the vertical offset of the paragraph found at the provided index.
+     * **Note:** If {@link threaded} is enabled, this method returns a value for the loaded part of the document. Use {@link isFinished} or {@link finished} to determine whether document is fully loaded.
+     */
+    getParagraphOffset(paragraph: number): number { return _C(this, 5806, paragraph) as number; }
+
+    /**
+     * Parses BBCode parameter `expressions` into a dictionary.
+     */
+    parseExpressionsForValues(expressions: PackedStringArray): GodotDictionary { return _C(this, 9279, expressions) as GodotDictionary; }
+
+    /**
+     * Installs a custom effect. This can also be done in the Inspector through the {@link customEffects} property. `effect` should be a valid {@link RichTextEffect}.
+     * **Example:** With the following script extending from {@link RichTextEffect}:
+     *
+     * ```text
+     *
+     * # effect.gd
+     * class_name MyCustomEffect
+     * extends RichTextEffect
+     *
+     * var bbcode = "my_custom_effect"
+     *
+     * # ...
+     *
+     * ```
+     *
+     * The above effect can be installed in {@link RichTextLabel} from a script:
+     *
+     * ```text
+     *
+     * # rich_text_label.gd
+     * extends RichTextLabel
+     *
+     * func _ready():
+     * 	install_effect(MyCustomEffect.new())
+     *
+     * 	# Alternatively, if not using `class_name` in the script that extends RichTextEffect:
+     * 	install_effect(preload("res://effect.gd").new())
+     *
+     * ```
+     */
+    installEffect(effect: Variant): void { _C(this, 7639, effect); }
+
+    /**
+     * Reloads custom effects. Useful when {@link customEffects} is modified manually.
+     */
+    reloadEffects(): void { _C(this, 9872); }
+
+    /**
+     * Returns the {@link PopupMenu} of this {@link RichTextLabel}. By default, this menu is displayed when right-clicking on the {@link RichTextLabel}.
+     * You can add custom menu items or remove standard ones. Make sure your IDs don't conflict with the standard ones (see {@link MenuItems}). For example:
+     *
+     *
+     * ```gdscript
+     *
+     * func _ready():
+     * 	var menu = get_menu()
+     * 	# Remove "Select All" item.
+     * 	menu.remove_item(MENU_SELECT_ALL)
+     * 	# Add custom items.
+     * 	menu.add_separator()
+     * 	menu.add_item("Duplicate Text", MENU_MAX + 1)
+     * 	# Connect callback.
+     * 	menu.id_pressed.connect(_on_item_pressed)
+     *
+     * func _on_item_pressed(id):
+     * 	if id == MENU_MAX + 1:
+     * 		add_text("\n" + get_parsed_text())
+     *
+     * ```
+     *
+     *
+     *
+     * **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their {@link Window.visible} property.
+     */
+    getMenu(): PopupMenu { return _C(this, 5505) as PopupMenu; }
+
+    /**
+     * Returns whether the menu is visible. Use this instead of `get_menu().visible` to improve performance (so the creation of the menu is avoided).
+     */
+    isMenuVisible(): boolean { return _C(this, 8101) as boolean; }
+
+    /**
+     * Executes a given action as defined in the {@link MenuItems} enum.
+     */
+    menuOption(option: number): void { _C(this, 8849, option); }
+
+    /**
+     * If `true`, the label uses BBCode formatting.
+     * **Note:** This only affects the contents of {@link text}, not the tag stack.
+     */
+    get bbcodeEnabled(): boolean { return _C(this, 8394) as boolean; }
+    set bbcodeEnabled(v: boolean) { _C(this, 13199, v); }
+
+    /**
+     * The label's text in BBCode format. Is not representative of manual modifications to the internal tag stack. Erases changes made by other methods when edited.
+     * **Note:** If {@link bbcodeEnabled} is `true`, it is unadvised to use the `+=` operator with {@link text} (e.g. `text += "some string"`) as it replaces the whole text and can cause slowdowns. It will also erase all BBCode that was added to stack using `push_*` methods. Use {@link appendText} for adding text instead, unless you absolutely need to close a tag that was opened in an earlier method call.
+     */
+    get text(): string { return _C(this, 6718) as string; }
+    set text(v: string) { _C(this, 13020, v); }
+
+    /**
+     * If `true`, the label's minimum size will be automatically updated to fit its content, matching the behavior of {@link Label}.
+     * **Note:** RichTextLabels with autowrapping and {@link fitContent} enabled must have a custom maximum width configured to work correctly, either through the RichTextLabel's own {@link Control.customMaximumSize} or as a result of a propagated maximum size from a parent Control with {@link Control.propagateMaximumSize} enabled.
+     */
+    get fitContent(): boolean { return _C(this, 7952) as boolean; }
+    set fitContent(v: boolean) { _C(this, 11397, v); }
+
+    /**
+     * If `true`, the scrollbar is visible. Setting this to `false` does not block scrolling completely. See {@link scrollToLine}.
+     */
+    get scrollActive(): boolean { return _C(this, 8272) as boolean; }
+    set scrollActive(v: boolean) { _C(this, 12633, v); }
+
+    /**
+     * If `true`, the window scrolls down to display new content automatically.
+     */
+    get scrollFollowing(): boolean { return _C(this, 8273) as boolean; }
+    set scrollFollowing(v: boolean) { _C(this, 12636, v); }
+
+    /**
+     * If `true`, the window scrolls to display the last visible line when {@link visibleCharacters} or {@link visibleRatio} is changed.
+     */
+    get scrollFollowingVisibleCharacters(): boolean { return _C(this, 8274) as boolean; }
+    set scrollFollowingVisibleCharacters(v: boolean) { _C(this, 12637, v); }
+
+    /**
+     * If set to something other than {@link TextServer.AUTOWRAP_OFF}, the text gets wrapped inside the node's bounding rectangle.
+     * **Note:** RichTextLabels with autowrapping and {@link fitContent} enabled must have a custom maximum width configured to work correctly, either through the RichTextLabel's own {@link Control.customMaximumSize} or as a result of a propagated maximum size from a parent Control with {@link Control.propagateMaximumSize} enabled.
+     */
+    get autowrapMode(): AutowrapMode { return _C(this, 3847) as AutowrapMode; }
+    set autowrapMode(v: AutowrapMode) { _C(this, 10596, v); }
+
+    /**
+     * Autowrap space trimming flags. See {@link TextServer.BREAK_TRIM_START_EDGE_SPACES} and {@link TextServer.BREAK_TRIM_END_EDGE_SPACES} for more info.
+     */
+    get autowrapTrimFlags(): LineBreakFlag { return _C(this, 3848) as LineBreakFlag; }
+    set autowrapTrimFlags(v: LineBreakFlag) { _C(this, 10597, v); }
+
+    /**
+     * The number of spaces associated with a single tab length. Does not affect `\t` in text tags, only indent tags.
+     */
+    get tabSize(): number { return _C(this, 6682) as number; }
+    set tabSize(v: number) { _C(this, 12980, v); }
+
+    /**
+     * If `true`, a right-click displays the context menu.
+     */
+    get contextMenuEnabled(): boolean { return _C(this, 7860) as boolean; }
+    set contextMenuEnabled(v: boolean) { _C(this, 10959, v); }
+
+    /**
+     * If `true`, shortcut keys for context menu items are enabled, even if the context menu is disabled.
+     */
+    get shortcutKeysEnabled(): boolean { return _C(this, 8305) as boolean; }
+    set shortcutKeysEnabled(v: boolean) { _C(this, 12728, v); }
+
+    /**
+     * Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify).
+     */
+    get horizontalAlignment(): HorizontalAlignment { return _C(this, 5044) as HorizontalAlignment; }
+    set horizontalAlignment(v: HorizontalAlignment) { _C(this, 11638, v); }
+
+    /**
+     * Controls the text's vertical alignment. Supports top, center, bottom, and fill.
+     */
+    get verticalAlignment(): VerticalAlignment { return _C(this, 7063) as VerticalAlignment; }
+    set verticalAlignment(v: VerticalAlignment) { _C(this, 13303, v); }
+
+    /**
+     * Line fill alignment rules.
+     */
+    get justificationFlags(): JustificationFlag { return _C(this, 5279) as JustificationFlag; }
+    set justificationFlags(v: JustificationFlag) { _C(this, 11853, v); }
+
+    /**
+     * Aligns text to the given tab-stops.
+     */
+    get tabStops(): PackedFloat32Array { return _C(this, 6683) as PackedFloat32Array; }
+    set tabStops(v: PackedFloat32Array) { _C(this, 12981, v); }
+
+    /**
+     * The currently installed custom effects. This is an array of {@link RichTextEffect}s.
+     * To add a custom effect, it's more convenient to use {@link installEffect}.
+     */
+    get customEffects(): GodotArray { return _C(this, 4607) as GodotArray; }
+    set customEffects(v: GodotArray) { _C(this, 11224, v); }
+
+    /**
+     * If `true`, the label underlines meta tags such as {@link code skip-lint}[{text}]({text}). These tags can call a function when clicked if {@link meta_clicked} is connected to a function.
+     */
+    get metaUnderlined(): boolean { return _C(this, 8104) as boolean; }
+    set metaUnderlined(v: boolean) { _C(this, 12034, v); }
+
+    /**
+     * If `true`, the label underlines hint tags such as {@link code skip-lint}.
+     */
+    get hintUnderlined(): boolean { return _C(this, 7998) as boolean; }
+    set hintUnderlined(v: boolean) { _C(this, 11633, v); }
+
+    /**
+     * If `true`, text processing is done in a background thread.
+     */
+    get threaded(): boolean { return _C(this, 8363) as boolean; }
+    set threaded(v: boolean) { _C(this, 13058, v); }
+
+    /**
+     * The delay after which the loading progress bar is displayed, in milliseconds. Set to `-1` to disable progress bar entirely.
+     * **Note:** Progress bar is displayed only if {@link threaded} is enabled.
+     */
+    get progressBarDelay(): number { return _C(this, 6037) as number; }
+    set progressBarDelay(v: number) { _C(this, 12437, v); }
+
+    /**
+     * If `true`, the label allows text selection.
+     */
+    get selectionEnabled(): boolean { return _C(this, 8289) as boolean; }
+    set selectionEnabled(v: boolean) { _C(this, 12690, v); }
+
+    /**
+     * If `true`, the selected text will be deselected when focus is lost.
+     */
+    get deselectOnFocusLossEnabled(): boolean { return _C(this, 7879) as boolean; }
+    set deselectOnFocusLossEnabled(v: boolean) { _C(this, 11099, v); }
+
+    /**
+     * If `true`, allow drag and drop of selected text.
+     */
+    get dragAndDropSelectionEnabled(): boolean { return _C(this, 7893) as boolean; }
+    set dragAndDropSelectionEnabled(v: boolean) { _C(this, 11161, v); }
+
+    /**
+     * The number of characters to display. If set to `-1`, all characters are displayed. This can be useful when animating the text appearing in a dialog box.
+     * **Note:** Setting this property updates {@link visibleRatio} accordingly.
+     * **Note:** Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings.
+     */
+    get visibleCharacters(): number { return _C(this, 7104) as number; }
+    set visibleCharacters(v: number) { _C(this, 13332, v); }
+
+    /**
+     * The clipping behavior when {@link visibleCharacters} or {@link visibleRatio} is set.
+     */
+    get visibleCharactersBehavior(): VisibleCharactersBehavior { return _C(this, 7105) as VisibleCharactersBehavior; }
+    set visibleCharactersBehavior(v: VisibleCharactersBehavior) { _C(this, 13333, v); }
+
+    /**
+     * The fraction of characters to display, relative to the total number of characters (see {@link getTotalCharacterCount}). If set to `1.0`, all characters are displayed. If set to `0.5`, only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box.
+     * **Note:** Setting this property updates {@link visibleCharacters} accordingly.
+     */
+    get visibleRatio(): number { return _C(this, 7111) as number; }
+    set visibleRatio(v: number) { _C(this, 13335, v); }
+
+    /**
+     * Base text writing direction.
+     */
+    get textDirection(): TextDirection { return _C(this, 6720) as TextDirection; }
+    set textDirection(v: TextDirection) { _C(this, 13022, v); }
+
+    /**
+     * Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
+     */
+    get language(): string { return _C(this, 5299) as string; }
+    set language(v: string) { _C(this, 11871, v); }
+
+    /**
+     * Set BiDi algorithm override for the structured text.
+     */
+    get structuredTextBidiOverride(): StructuredTextParser { return _C(this, 6585) as StructuredTextParser; }
+    set structuredTextBidiOverride(v: StructuredTextParser) { _C(this, 12913, v); }
+
+    /**
+     * Set additional options for BiDi override.
+     */
+    get structuredTextBidiOverrideOptions(): GodotArray { return _C(this, 6586) as GodotArray; }
+    set structuredTextBidiOverrideOptions(v: GodotArray) { _C(this, 12914, v); }
+
+    /**
+     * Triggered when the user clicks on content between meta (URL) tags. If the meta is defined in BBCode, e.g. {@link code skip-lint}[Text](value"})[/code], then the parameter for this signal will always be a {@link String} type. If a particular type or an object is desired, the {@link pushMeta} method must be used to manually insert the data into the tag stack. Alternatively, you can convert the {@link String} input to the desired type based on its contents (such as calling {@link JSON.parse} on it).
+     * For example, the following method can be connected to {@link meta_clicked} to open clicked URLs using the user's default web browser:
+     *
+     *
+     * ```gdscript
+     *
+     * # This assumes RichTextLabel's `meta_clicked` signal was connected to
+     * # the function below using the signal connection dialog.
+     * func _richtextlabel_on_meta_clicked(meta):
+     * 	# `meta` is of Variant type, so convert it to a String to avoid script errors at run-time.
+     * 	OS.shell_open(str(meta))
+     *
+     * ```
+     */
+    get metaClicked(): Signal<(meta: Variant) => void> { return _G(this, 8893) as Signal<(meta: Variant) => void>; }
+    set metaClicked(v: ((meta: Variant) => void) | null) { _G(this, 8893, v); }
+
+    /**
+     * Triggers when the mouse enters a meta tag.
+     */
+    get metaHoverStarted(): Signal<(meta: Variant) => void> { return _G(this, 8895) as Signal<(meta: Variant) => void>; }
+    set metaHoverStarted(v: ((meta: Variant) => void) | null) { _G(this, 8895, v); }
+
+    /**
+     * Triggers when the mouse exits a meta tag.
+     */
+    get metaHoverEnded(): Signal<(meta: Variant) => void> { return _G(this, 8894) as Signal<(meta: Variant) => void>; }
+    set metaHoverEnded(v: ((meta: Variant) => void) | null) { _G(this, 8894, v); }
+
+    /**
+     * Triggered when the document is fully loaded.
+     * **Note:** This can happen before the text is processed for drawing. Scrolling values may not be valid until the document is drawn for the first time after this signal.
+     */
+    get finished(): Signal<() => void> { return _G(this, 3310) as Signal<() => void>; }
+    set finished(v: (() => void) | null) { _G(this, 3310, v); }
+
+    static readonly name = _R(670, RichTextLabel);
+}
+
+export const ListType = {
+    /**
+     * Each list item has a number marker.
+     */
+    LIST_NUMBERS: 0,
+    /**
+     * Each list item has a letter marker.
+     */
+    LIST_LETTERS: 1,
+    /**
+     * Each list item has a roman number marker.
+     */
+    LIST_ROMAN: 2,
+    /**
+     * Each list item has a filled circle marker.
+     */
+    LIST_DOTS: 3,
+} as const;
+
+export type ListType = (typeof ListType)[keyof typeof ListType];
+
+export const MenuItems = {
+    /**
+     * Copies the selected text.
+     */
+    MENU_COPY: 0,
+    /**
+     * Selects the whole {@link RichTextLabel} text.
+     */
+    MENU_SELECT_ALL: 1,
+    /**
+     * Represents the size of the {@link MenuItems} enum.
+     */
+    MENU_MAX: 2,
+} as const;
+
+export type MenuItems = (typeof MenuItems)[keyof typeof MenuItems];
+
+export const MetaUnderline = {
+    /**
+     * Meta tag does not display an underline, even if {@link metaUnderlined} is `true`.
+     */
+    META_UNDERLINE_NEVER: 0,
+    /**
+     * If {@link metaUnderlined} is `true`, meta tag always display an underline.
+     */
+    META_UNDERLINE_ALWAYS: 1,
+    /**
+     * If {@link metaUnderlined} is `true`, meta tag display an underline when the mouse cursor is over it.
+     */
+    META_UNDERLINE_ON_HOVER: 2,
+} as const;
+
+export type MetaUnderline = (typeof MetaUnderline)[keyof typeof MetaUnderline];
+
+export const ImageUpdateMask = {
+    /**
+     * If this bit is set, {@link updateImage} changes image texture.
+     */
+    UPDATE_TEXTURE: 1,
+    /**
+     * If this bit is set, {@link updateImage} changes image size.
+     */
+    UPDATE_SIZE: 2,
+    /**
+     * If this bit is set, {@link updateImage} changes image color.
+     */
+    UPDATE_COLOR: 4,
+    /**
+     * If this bit is set, {@link updateImage} changes image inline alignment.
+     */
+    UPDATE_ALIGNMENT: 8,
+    /**
+     * If this bit is set, {@link updateImage} changes image texture region.
+     */
+    UPDATE_REGION: 16,
+    /**
+     * If this bit is set, {@link updateImage} changes image padding.
+     */
+    UPDATE_PAD: 32,
+    /**
+     * If this bit is set, {@link updateImage} changes image tooltip.
+     */
+    UPDATE_TOOLTIP: 64,
+    /**
+     * If this bit is set, {@link updateImage} changes the units used to calculate image size.
+     */
+    UPDATE_WIDTH_UNIT: 128,
+} as const;
+
+export type ImageUpdateMask = (typeof ImageUpdateMask)[keyof typeof ImageUpdateMask];
+
+export const ImageUnit = {
+    /**
+     * Images drawn with this unit will be in pixels.
+     */
+    IMAGE_UNIT_PIXEL: 0,
+    /**
+     * Images drawn with this unit will be in percentages of the control width.
+     */
+    IMAGE_UNIT_PERCENT: 1,
+    /**
+     * Images drawn with this unit will be in percentages of the surrounding font size.
+     */
+    IMAGE_UNIT_EM: 2,
+} as const;
+
+export type ImageUnit = (typeof ImageUnit)[keyof typeof ImageUnit];
+