typescript-to-gdscript 0.1.0

package/typings/classes/TextLine.d.ts

@@ -0,0 +1,100 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Holds a line of text. */
+declare class TextLine extends RefCounted {
+  /** Sets text alignment within the line as if the line was horizontal. */
+  alignment: int;
+  /** Text writing direction. */
+  direction: int;
+  /** Ellipsis character used for text clipping. */
+  ellipsis_char: string;
+  /** Line alignment rules. For more info see {@link TextServer}. */
+  flags: int;
+  /** Text orientation. */
+  orientation: int;
+  /** If set to `true` text will display control characters. */
+  preserve_control: boolean;
+  /** If set to `true` text will display invalid characters. */
+  preserve_invalid: boolean;
+  /** The clipping behavior when the text exceeds the text line's set width. */
+  text_overrun_behavior: int;
+  /** Text line width. */
+  width: float;
+  set_horizontal_alignment(value: int): void;
+  get_horizontal_alignment(): int;
+  set_direction(value: int): void;
+  get_direction(): int;
+  set_ellipsis_char(value: string | NodePath): void;
+  get_ellipsis_char(): string;
+  set_flags(value: int): void;
+  get_flags(): int;
+  set_orientation(value: int): void;
+  get_orientation(): int;
+  set_preserve_control(value: boolean): void;
+  get_preserve_control(): boolean;
+  set_preserve_invalid(value: boolean): void;
+  get_preserve_invalid(): boolean;
+  set_text_overrun_behavior(value: int): void;
+  get_text_overrun_behavior(): int;
+  set_width(value: float): void;
+  get_width(): float;
+
+  /**
+   * Adds inline object to the text buffer, `key` must be unique. In the text, object is represented as `length` object replacement characters.
+   */
+  add_object(key: unknown, size: Vector2 | Vector2i, inline_align: int, length?: int, baseline?: float): boolean;
+  /** Adds text span and font to draw it. */
+  add_string(text: string | NodePath, font: Font, font_size: int, language?: string | NodePath, meta?: unknown): boolean;
+  /** Clears text line (removes text and inline objects). */
+  clear(): void;
+  /**
+   * Draw text into a canvas item at a given position, with `color`. `pos` specifies the top left corner of the bounding box. If `oversampling` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
+   */
+  draw(canvas: RID, pos: Vector2 | Vector2i, color?: Color, oversampling?: float): void;
+  /**
+   * Draw text into a canvas item at a given position, with `color`. `pos` specifies the top left corner of the bounding box. If `oversampling` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
+   */
+  draw_outline(canvas: RID, pos: Vector2 | Vector2i, outline_size?: int, color?: Color, oversampling?: float): void;
+  /** Duplicates this {@link TextLine}. */
+  duplicate(): TextLine;
+  /** Returns the text writing direction inferred by the BiDi algorithm. */
+  get_inferred_direction(): int;
+  /**
+   * Returns the text ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
+   */
+  get_line_ascent(): float;
+  /**
+   * Returns the text descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
+   */
+  get_line_descent(): float;
+  /** Returns pixel offset of the underline below the baseline. */
+  get_line_underline_position(): float;
+  /** Returns thickness of the underline. */
+  get_line_underline_thickness(): float;
+  /** Returns width (for horizontal layout) or height (for vertical) of the text. */
+  get_line_width(): float;
+  /** Returns bounding rectangle of the inline object. */
+  get_object_rect(key: unknown): Rect2;
+  /** Returns array of inline objects. */
+  get_objects(): Array<unknown>;
+  /** Returns TextServer buffer RID. */
+  get_rid(): RID;
+  /** Returns size of the bounding box of the text. */
+  get_size(): Vector2;
+  /** Returns `true` if an object with `key` is embedded in this line. */
+  has_object(key: unknown): boolean;
+  /**
+   * Returns caret character offset at the specified pixel offset at the baseline. This function always returns a valid position.
+   */
+  hit_test(coords: float): int;
+  /** Sets new size and alignment of embedded object. */
+  resize_object(key: unknown, size: Vector2 | Vector2i, inline_align: int, baseline?: float): boolean;
+  /**
+   * Overrides BiDi for the structured text.
+   * Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
+   */
+  set_bidi_override(override: Array<unknown> | PackedByteArray | PackedColorArray | PackedFloat32Array | PackedFloat64Array | PackedInt32Array | PackedInt64Array | PackedStringArray | PackedVector2Array | PackedVector3Array | PackedVector4Array): void;
+  /** Aligns text to the given tab-stops. */
+  tab_align(tab_stops: PackedFloat32Array | Array<unknown>): void;
+}

package/typings/classes/TextMesh.d.ts

@@ -0,0 +1,103 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Generate a {@link PrimitiveMesh} from the text. */
+declare class TextMesh extends PrimitiveMesh {
+  /**
+   * If set to something other than {@link TextServer.AUTOWRAP_OFF}, the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text.
+   */
+  autowrap_mode: int;
+  /**
+   * Step (in pixels) used to approximate Bézier curves. Lower values result in smoother curves, but is slower to generate and render. Consider adjusting this according to the font size and the typical viewing distance.
+   * **Note:** Changing this property will regenerate the mesh, which is a slow operation, especially with large font sizes and long texts.
+   */
+  curve_step: float;
+  /**
+   * Depths of the mesh, if set to `0.0` only front surface, is generated, and UV layout is changed to use full texture for the front face only.
+   */
+  depth: float;
+  /** Font configuration used to display text. */
+  font: Font | null;
+  /**
+   * Font size of the {@link TextMesh}'s text. This property works in tandem with {@link pixel_size}. Higher values will result in a more detailed font, regardless of {@link curve_step} and {@link pixel_size}. Consider keeping this value below 63 (inclusive) for good performance, and adjust {@link pixel_size} as needed to enlarge text.
+   * **Note:** Changing this property will regenerate the mesh, which is a slow operation, especially with large font sizes and long texts. To change the text's size in real-time efficiently, change the node's {@link Node3D.scale} instead.
+   */
+  font_size: int;
+  /**
+   * Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify).
+   */
+  horizontal_alignment: int;
+  /** Line fill alignment rules. */
+  justification_flags: int;
+  /**
+   * Language code used for line-breaking and text shaping algorithms. If left empty, the current locale is used instead.
+   */
+  language: string;
+  /**
+   * Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.
+   */
+  line_spacing: float;
+  /**
+   * The text drawing offset (in pixels).
+   * **Note:** Changing this property will regenerate the mesh, which is a slow operation. To change the text's position in real-time efficiently, change the node's {@link Node3D.position} instead.
+   */
+  offset: Vector2;
+  /**
+   * The size of one pixel's width on the text to scale it in 3D. This property works in tandem with {@link font_size}.
+   * **Note:** Changing this property will regenerate the mesh, which is a slow operation, especially with large font sizes and long texts. To change the text's size in real-time efficiently, change the node's {@link Node3D.scale} instead.
+   */
+  pixel_size: float;
+  /** Set BiDi algorithm override for the structured text. */
+  structured_text_bidi_override: int;
+  /** Set additional options for BiDi override. */
+  structured_text_bidi_override_options: Array<unknown>;
+  /**
+   * The text to generate mesh from.
+   * **Note:** Due to being a {@link Resource}, it doesn't follow the rules of {@link Node.auto_translate_mode}. If disabling translation is desired, it should be done manually with {@link Object.set_message_translation}.
+   */
+  text: string;
+  /** Base text writing direction. */
+  text_direction: int;
+  /** If `true`, all the text displays as UPPERCASE. */
+  uppercase: boolean;
+  /** Controls the text's vertical alignment. Supports top, center, and bottom. */
+  vertical_alignment: int;
+  /** Text width (in pixels), used for fill alignment. */
+  width: float;
+  set_autowrap_mode(value: int): void;
+  get_autowrap_mode(): int;
+  set_curve_step(value: float): void;
+  get_curve_step(): float;
+  set_depth(value: float): void;
+  get_depth(): float;
+  set_font(value: Font | null): void;
+  get_font(): Font | null;
+  set_font_size(value: int): void;
+  get_font_size(): int;
+  set_horizontal_alignment(value: int): void;
+  get_horizontal_alignment(): int;
+  set_justification_flags(value: int): void;
+  get_justification_flags(): int;
+  set_language(value: string | NodePath): void;
+  get_language(): string;
+  set_line_spacing(value: float): void;
+  get_line_spacing(): float;
+  set_offset(value: Vector2 | Vector2i): void;
+  get_offset(): Vector2;
+  set_pixel_size(value: float): void;
+  get_pixel_size(): float;
+  set_structured_text_bidi_override(value: int): void;
+  get_structured_text_bidi_override(): int;
+  set_structured_text_bidi_override_options(value: Array<unknown> | PackedByteArray | PackedColorArray | PackedFloat32Array | PackedFloat64Array | PackedInt32Array | PackedInt64Array | PackedStringArray | PackedVector2Array | PackedVector3Array | PackedVector4Array): void;
+  get_structured_text_bidi_override_options(): Array<unknown>;
+  set_text(value: string | NodePath): void;
+  get_text(): string;
+  set_text_direction(value: int): void;
+  get_text_direction(): int;
+  set_uppercase(value: boolean): void;
+  is_uppercase(): boolean;
+  set_vertical_alignment(value: int): void;
+  get_vertical_alignment(): int;
+  set_width(value: float): void;
+  get_width(): float;
+}

package/typings/classes/TextParagraph.d.ts

@@ -0,0 +1,160 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Holds a paragraph of text. */
+declare class TextParagraph extends RefCounted {
+  /** Paragraph horizontal alignment. */
+  alignment: int;
+  /** Line breaking rules. For more info see {@link TextServer}. */
+  break_flags: int;
+  /**
+   * Custom punctuation character list, used for word breaking. If set to empty string, server defaults are used.
+   */
+  custom_punctuation: string;
+  /** Text writing direction. */
+  direction: int;
+  /** Ellipsis character used for text clipping. */
+  ellipsis_char: string;
+  /** Line fill alignment rules. */
+  justification_flags: int;
+  /**
+   * Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative.
+   */
+  line_spacing: float;
+  /** Limits the lines of text shown. */
+  max_lines_visible: int;
+  /** Text orientation. */
+  orientation: int;
+  /** If set to `true` text will display control characters. */
+  preserve_control: boolean;
+  /** If set to `true` text will display invalid characters. */
+  preserve_invalid: boolean;
+  /** The clipping behavior when the text exceeds the paragraph's set width. */
+  text_overrun_behavior: int;
+  /** Paragraph width. */
+  width: float;
+  set_alignment(value: int): void;
+  get_alignment(): int;
+  set_break_flags(value: int): void;
+  get_break_flags(): int;
+  set_custom_punctuation(value: string | NodePath): void;
+  get_custom_punctuation(): string;
+  set_direction(value: int): void;
+  get_direction(): int;
+  set_ellipsis_char(value: string | NodePath): void;
+  get_ellipsis_char(): string;
+  set_justification_flags(value: int): void;
+  get_justification_flags(): int;
+  set_line_spacing(value: float): void;
+  get_line_spacing(): float;
+  set_max_lines_visible(value: int): void;
+  get_max_lines_visible(): int;
+  set_orientation(value: int): void;
+  get_orientation(): int;
+  set_preserve_control(value: boolean): void;
+  get_preserve_control(): boolean;
+  set_preserve_invalid(value: boolean): void;
+  get_preserve_invalid(): boolean;
+  set_text_overrun_behavior(value: int): void;
+  get_text_overrun_behavior(): int;
+  set_width(value: float): void;
+  get_width(): float;
+
+  /**
+   * Adds inline object to the text buffer, `key` must be unique. In the text, object is represented as `length` object replacement characters.
+   */
+  add_object(key: unknown, size: Vector2 | Vector2i, inline_align: int, length?: int, baseline?: float): boolean;
+  /** Adds text span and font to draw it. */
+  add_string(text: string | NodePath, font: Font, font_size: int, language?: string | NodePath, meta?: unknown): boolean;
+  /** Clears text paragraph (removes text and inline objects). */
+  clear(): void;
+  /** Removes dropcap. */
+  clear_dropcap(): void;
+  /**
+   * Draw all lines of the text and drop cap into a canvas item at a given position, with `color`. `pos` specifies the top left corner of the bounding box. If `oversampling` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
+   */
+  draw(canvas: RID, pos: Vector2 | Vector2i, color?: Color, dc_color?: Color, oversampling?: float): void;
+  /**
+   * Draw drop cap into a canvas item at a given position, with `color`. `pos` specifies the top left corner of the bounding box. If `oversampling` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
+   */
+  draw_dropcap(canvas: RID, pos: Vector2 | Vector2i, color?: Color, oversampling?: float): void;
+  /**
+   * Draw drop cap outline into a canvas item at a given position, with `color`. `pos` specifies the top left corner of the bounding box. If `oversampling` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
+   */
+  draw_dropcap_outline(canvas: RID, pos: Vector2 | Vector2i, outline_size?: int, color?: Color, oversampling?: float): void;
+  /**
+   * Draw single line of text into a canvas item at a given position, with `color`. `pos` specifies the top left corner of the bounding box. If `oversampling` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
+   */
+  draw_line(canvas: RID, pos: Vector2 | Vector2i, line: int, color?: Color, oversampling?: float): void;
+  /**
+   * Draw outline of the single line of text into a canvas item at a given position, with `color`. `pos` specifies the top left corner of the bounding box. If `oversampling` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
+   */
+  draw_line_outline(canvas: RID, pos: Vector2 | Vector2i, line: int, outline_size?: int, color?: Color, oversampling?: float): void;
+  /**
+   * Draw outlines of all lines of the text and drop cap into a canvas item at a given position, with `color`. `pos` specifies the top left corner of the bounding box. If `oversampling` is greater than zero, it is used as font oversampling factor, otherwise viewport oversampling settings are used.
+   */
+  draw_outline(canvas: RID, pos: Vector2 | Vector2i, outline_size?: int, color?: Color, dc_color?: Color, oversampling?: float): void;
+  /** Duplicates this {@link TextParagraph}. */
+  duplicate(): TextParagraph;
+  /** Returns number of lines used by dropcap. */
+  get_dropcap_lines(): int;
+  /** Returns drop cap text buffer RID. */
+  get_dropcap_rid(): RID;
+  /** Returns drop cap bounding box size. */
+  get_dropcap_size(): Vector2;
+  /** Returns the text writing direction inferred by the BiDi algorithm. */
+  get_inferred_direction(): int;
+  /**
+   * Returns the text line ascent (number of pixels above the baseline for horizontal layout or to the left of baseline for vertical).
+   */
+  get_line_ascent(line: int): float;
+  /** Returns number of lines in the paragraph. */
+  get_line_count(): int;
+  /**
+   * Returns the text line descent (number of pixels below the baseline for horizontal layout or to the right of baseline for vertical).
+   */
+  get_line_descent(line: int): float;
+  /** Returns bounding rectangle of the inline object. */
+  get_line_object_rect(line: int, key: unknown): Rect2;
+  /** Returns array of inline objects in the line. */
+  get_line_objects(line: int): Array<unknown>;
+  /** Returns character range of the line. */
+  get_line_range(line: int): Vector2i;
+  /** Returns TextServer line buffer RID. */
+  get_line_rid(line: int): RID;
+  /** Returns size of the bounding box of the line of text. Returned size is rounded up. */
+  get_line_size(line: int): Vector2;
+  /** Returns pixel offset of the underline below the baseline. */
+  get_line_underline_position(line: int): float;
+  /** Returns thickness of the underline. */
+  get_line_underline_thickness(line: int): float;
+  /** Returns width (for horizontal layout) or height (for vertical) of the line of text. */
+  get_line_width(line: int): float;
+  /** Returns the size of the bounding box of the paragraph, without line breaks. */
+  get_non_wrapped_size(): Vector2;
+  /** Returns the character range of the paragraph. */
+  get_range(): Vector2i;
+  /** Returns TextServer full string buffer RID. */
+  get_rid(): RID;
+  /** Returns the size of the bounding box of the paragraph. */
+  get_size(): Vector2;
+  /** Returns `true` if an object with `key` is embedded in this shaped text buffer. */
+  has_object(key: unknown): boolean;
+  /**
+   * Returns caret character offset at the specified coordinates. This function always returns a valid position.
+   */
+  hit_test(coords: Vector2 | Vector2i): int;
+  /** Sets new size and alignment of embedded object. */
+  resize_object(key: unknown, size: Vector2 | Vector2i, inline_align: int, baseline?: float): boolean;
+  /**
+   * Overrides BiDi for the structured text.
+   * Override ranges should cover full source text without overlaps. BiDi algorithm will be used on each range separately.
+   */
+  set_bidi_override(override: Array<unknown> | PackedByteArray | PackedColorArray | PackedFloat32Array | PackedFloat64Array | PackedInt32Array | PackedInt64Array | PackedStringArray | PackedVector2Array | PackedVector3Array | PackedVector4Array): void;
+  /**
+   * Sets drop cap, overrides previously set drop cap. Drop cap (dropped capital) is a decorative element at the beginning of a paragraph that is larger than the rest of the text.
+   */
+  set_dropcap(text: string | NodePath, font: Font, font_size: int, dropcap_margins?: Rect2 | Rect2i, language?: string | NodePath): boolean;
+  /** Aligns paragraph to the given tab-stops. */
+  tab_align(tab_stops: PackedFloat32Array | Array<unknown>): void;
+}