typescript-to-gdscript 0.1.0

package/typings/classes/ColorRect.d.ts

@@ -0,0 +1,10 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A control that displays a solid color rectangle. */
+declare class ColorRect extends Control {
+  /** The fill color of the rectangle. */
+  color: Color;
+  set_color(value: Color): void;
+  get_color(): Color;
+}

package/typings/classes/Compositor.d.ts

@@ -0,0 +1,12 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Stores attributes used to customize how a Viewport is rendered. */
+declare class Compositor extends Resource {
+  /**
+   * The custom {@link CompositorEffect}s that are applied during rendering of viewports using this compositor.
+   */
+  compositor_effects: Array<CompositorEffect>;
+  set_compositor_effects(value: Array<CompositorEffect>): void;
+  get_compositor_effects(): Array<CompositorEffect>;
+}

package/typings/classes/CompositorEffect.d.ts

@@ -0,0 +1,76 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** This resource allows for creating a custom rendering effect. */
+declare class CompositorEffect extends Resource {
+  /**
+   * If `true` and MSAA is enabled, this will trigger a color buffer resolve before the effect is run.
+   * **Note:** In {@link _render_callback}, to access the resolved buffer use:
+   */
+  access_resolved_color: boolean;
+  /**
+   * If `true` and MSAA is enabled, this will trigger a depth buffer resolve before the effect is run.
+   * **Note:** In {@link _render_callback}, to access the resolved buffer use:
+   */
+  access_resolved_depth: boolean;
+  /**
+   * The type of effect that is implemented, determines at what stage of rendering the callback is called.
+   */
+  effect_callback_type: int;
+  /** If `true` this rendering effect is applied to any viewport it is added to. */
+  enabled: boolean;
+  /**
+   * If `true` this triggers motion vectors being calculated during the opaque render state.
+   * **Note:** In {@link _render_callback}, to access the motion vector buffer use:
+   */
+  needs_motion_vectors: boolean;
+  /**
+   * If `true` this triggers normal and roughness data to be output during our depth pre-pass, only applicable for the Forward+ renderer.
+   * **Note:** In {@link _render_callback}, to access the roughness buffer use:
+   * The raw normal and roughness buffer is stored in an optimized format, different than the one available in Spatial shaders. When sampling the buffer, a conversion function must be applied. Use this function, copied from here (https://github.com/godotengine/godot/blob/da5f39889f155658cef7f7ec3cc1abb94e17d815/servers/rendering/renderer_rd/shaders/forward_clustered/scene_forward_clustered_inc.glsl#L334-L341):
+   */
+  needs_normal_roughness: boolean;
+  /**
+   * If `true` this triggers specular data being rendered to a separate buffer and combined after effects have been applied, only applicable for the Forward+ renderer.
+   */
+  needs_separate_specular: boolean;
+  set_access_resolved_color(value: boolean): void;
+  get_access_resolved_color(): boolean;
+  set_access_resolved_depth(value: boolean): void;
+  get_access_resolved_depth(): boolean;
+  set_effect_callback_type(value: int): void;
+  get_effect_callback_type(): int;
+  set_enabled(value: boolean): void;
+  get_enabled(): boolean;
+  set_needs_motion_vectors(value: boolean): void;
+  get_needs_motion_vectors(): boolean;
+  set_needs_normal_roughness(value: boolean): void;
+  get_needs_normal_roughness(): boolean;
+  set_needs_separate_specular(value: boolean): void;
+  get_needs_separate_specular(): boolean;
+
+  /**
+   * Implement this function with your custom rendering code. `effect_callback_type` should always match the effect callback type you've specified in {@link effect_callback_type}. `render_data` provides access to the rendering state, it is only valid during rendering and should not be stored.
+   */
+  _render_callback(effect_callback_type: int, render_data: RenderData): void;
+
+  // enum EffectCallbackType
+  /** The callback is called before our opaque rendering pass, but after depth prepass (if applicable). */
+  static readonly EFFECT_CALLBACK_TYPE_PRE_OPAQUE: int;
+  /** The callback is called after our opaque rendering pass, but before our sky is rendered. */
+  static readonly EFFECT_CALLBACK_TYPE_POST_OPAQUE: int;
+  /**
+   * The callback is called after our sky is rendered, but before our back buffers are created (and if enabled, before subsurface scattering and/or screen space reflections).
+   */
+  static readonly EFFECT_CALLBACK_TYPE_POST_SKY: int;
+  /**
+   * The callback is called before our transparent rendering pass, but after our sky is rendered and we've created our back buffers.
+   */
+  static readonly EFFECT_CALLBACK_TYPE_PRE_TRANSPARENT: int;
+  /**
+   * The callback is called after our transparent rendering pass, but before any built-in post-processing effects and output to our render target.
+   */
+  static readonly EFFECT_CALLBACK_TYPE_POST_TRANSPARENT: int;
+  /** Represents the size of the {@link EffectCallbackType} enum. */
+  static readonly EFFECT_CALLBACK_TYPE_MAX: int;
+}

package/typings/classes/CompressedCubemap.d.ts

@@ -0,0 +1,6 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** An optionally compressed {@link Cubemap}. */
+declare class CompressedCubemap extends CompressedTextureLayered {
+}

package/typings/classes/CompressedCubemapArray.d.ts

@@ -0,0 +1,6 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** An optionally compressed {@link CubemapArray}. */
+declare class CompressedCubemapArray extends CompressedTextureLayered {
+}

package/typings/classes/CompressedTexture2D.d.ts

@@ -0,0 +1,13 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Texture with 2 dimensions, optionally compressed. */
+declare class CompressedTexture2D extends Texture2D {
+  /** The {@link CompressedTexture2D}'s file path to a `.ctex` file. */
+  load_path: string;
+  resource_local_to_scene: boolean;
+  get_load_path(): string;
+
+  /** Loads the texture from the specified `path`. */
+  load(path: string | NodePath): int;
+}

package/typings/classes/CompressedTexture2DArray.d.ts

@@ -0,0 +1,6 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Array of 2-dimensional textures, optionally compressed. */
+declare class CompressedTexture2DArray extends CompressedTextureLayered {
+}

package/typings/classes/CompressedTexture3D.d.ts

@@ -0,0 +1,12 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Texture with 3 dimensions, optionally compressed. */
+declare class CompressedTexture3D extends Texture3D {
+  /** The {@link CompressedTexture3D}'s file path to a `.ctex3d` file. */
+  load_path: string;
+  get_load_path(): string;
+
+  /** Loads the texture from the specified `path`. */
+  load(path: string | NodePath): int;
+}

package/typings/classes/CompressedTextureLayered.d.ts

@@ -0,0 +1,12 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Base class for texture arrays that can optionally be compressed. */
+declare class CompressedTextureLayered extends TextureLayered {
+  /** The path the texture should be loaded from. */
+  load_path: string;
+  get_load_path(): string;
+
+  /** Loads the texture at `path`. */
+  load(path: string | NodePath): int;
+}

package/typings/classes/ConcavePolygonShape2D.d.ts

@@ -0,0 +1,12 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A 2D polyline shape used for physics collision. */
+declare class ConcavePolygonShape2D extends Shape2D {
+  /**
+   * The array of points that make up the {@link ConcavePolygonShape2D}'s line segments. The array (of length divisible by two) is naturally divided into pairs (one pair for each segment); each pair consists of the starting point of a segment and the endpoint of a segment.
+   */
+  segments: PackedVector2Array;
+  set_segments(value: PackedVector2Array | Array<unknown>): void;
+  get_segments(): PackedVector2Array;
+}

package/typings/classes/ConcavePolygonShape3D.d.ts

@@ -0,0 +1,21 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A 3D trimesh shape used for physics collision. */
+declare class ConcavePolygonShape3D extends Shape3D {
+  /**
+   * If set to `true`, collisions occur on both sides of the concave shape faces. Otherwise they occur only along the face normals.
+   */
+  backface_collision: boolean;
+  set_backface_collision_enabled(value: boolean): void;
+  is_backface_collision_enabled(): boolean;
+
+  /**
+   * Returns the faces of the trimesh shape as an array of vertices. The array (of length divisible by three) is naturally divided into triples; each triple of vertices defines a triangle.
+   */
+  get_faces(): PackedVector3Array;
+  /**
+   * Sets the faces of the trimesh shape from an array of vertices. The `faces` array should be composed of triples such that each triple of vertices defines a triangle.
+   */
+  set_faces(faces: PackedVector3Array | Array<unknown>): void;
+}

package/typings/classes/ConeTwistJoint3D.d.ts

@@ -0,0 +1,63 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/**
+ * A physics joint that connects two 3D physics bodies in a way that simulates a ball-and-socket joint.
+ */
+declare class ConeTwistJoint3D extends Joint3D {
+  /**
+   * The speed with which the swing or twist will take place.
+   * The higher, the faster.
+   */
+  bias: float;
+  /** Defines, how fast the swing- and twist-speed-difference on both sides gets synced. */
+  relaxation: float;
+  /**
+   * The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
+   */
+  softness: float;
+  /**
+   * Swing is rotation from side to side, around the axis perpendicular to the twist axis.
+   * The swing span defines, how much rotation will not get corrected along the swing axis.
+   * Could be defined as looseness in the {@link ConeTwistJoint3D}.
+   * If below 0.05, this behavior is locked.
+   */
+  swing_span: float;
+  /**
+   * Twist is the rotation around the twist axis, this value defined how far the joint can twist.
+   * Twist is locked if below 0.05.
+   */
+  twist_span: float;
+
+  /** Returns the value of the specified parameter. */
+  get_param(param: int): float;
+  /** Sets the value of the specified parameter. */
+  set_param(param: int, value: float): void;
+
+  // enum Param
+  /**
+   * Swing is rotation from side to side, around the axis perpendicular to the twist axis.
+   * The swing span defines, how much rotation will not get corrected along the swing axis.
+   * Could be defined as looseness in the {@link ConeTwistJoint3D}.
+   * If below 0.05, this behavior is locked.
+   */
+  static readonly PARAM_SWING_SPAN: int;
+  /**
+   * Twist is the rotation around the twist axis, this value defined how far the joint can twist.
+   * Twist is locked if below 0.05.
+   */
+  static readonly PARAM_TWIST_SPAN: int;
+  /**
+   * The speed with which the swing or twist will take place.
+   * The higher, the faster.
+   */
+  static readonly PARAM_BIAS: int;
+  /**
+   * The ease with which the joint starts to twist. If it's too low, it takes more force to start twisting the joint.
+   */
+  static readonly PARAM_SOFTNESS: int;
+  /** Defines, how fast the swing- and twist-speed-difference on both sides gets synced. */
+  static readonly PARAM_RELAXATION: int;
+  /** Represents the size of the {@link Param} enum. */
+  static readonly PARAM_MAX: int;
+}

package/typings/classes/ConfigFile.d.ts

@@ -0,0 +1,71 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Helper class to handle INI-style files. */
+declare class ConfigFile extends RefCounted {
+  /** Removes the entire contents of the config. */
+  clear(): void;
+  /** Obtain the text version of this config file (the same text that would be written to a file). */
+  encode_to_text(): string;
+  /**
+   * Deletes the specified section along with all the key-value pairs inside. Raises an error if the section does not exist.
+   */
+  erase_section(section: string | NodePath): void;
+  /**
+   * Deletes the specified key in a section. Raises an error if either the section or the key do not exist.
+   */
+  erase_section_key(section: string | NodePath, key: string | NodePath): void;
+  /**
+   * Returns an array of all defined key identifiers in the specified section. Raises an error and returns an empty array if the section does not exist.
+   */
+  get_section_keys(section: string | NodePath): PackedStringArray;
+  /** Returns an array of all defined section identifiers. */
+  get_sections(): PackedStringArray;
+  /**
+   * Returns the current value for the specified section and key. If either the section or the key do not exist, the method returns the fallback `default` value. If `default` is not specified or set to `null`, an error is also raised.
+   */
+  get_value(section: string | NodePath, key: string | NodePath, default_?: unknown): unknown;
+  /** Returns `true` if the specified section exists. */
+  has_section(section: string | NodePath): boolean;
+  /** Returns `true` if the specified section-key pair exists. */
+  has_section_key(section: string | NodePath, key: string | NodePath): boolean;
+  /**
+   * Loads the config file specified as a parameter. The file's contents are parsed and loaded in the {@link ConfigFile} object which the method was called on.
+   * Returns {@link OK} on success, or one of the other {@link Error} values if the operation failed.
+   */
+  load(path: string | NodePath): int;
+  /**
+   * Loads the encrypted config file specified as a parameter, using the provided `key` to decrypt it. The file's contents are parsed and loaded in the {@link ConfigFile} object which the method was called on.
+   * Returns {@link OK} on success, or one of the other {@link Error} values if the operation failed.
+   */
+  load_encrypted(path: string | NodePath, key: PackedByteArray | Array<unknown>): int;
+  /**
+   * Loads the encrypted config file specified as a parameter, using the provided `password` to decrypt it. The file's contents are parsed and loaded in the {@link ConfigFile} object which the method was called on.
+   * Returns {@link OK} on success, or one of the other {@link Error} values if the operation failed.
+   */
+  load_encrypted_pass(path: string | NodePath, password: string | NodePath): int;
+  /**
+   * Parses the passed string as the contents of a config file. The string is parsed and loaded in the ConfigFile object which the method was called on.
+   * Returns {@link OK} on success, or one of the other {@link Error} values if the operation failed.
+   */
+  parse(data: string | NodePath): int;
+  /**
+   * Saves the contents of the {@link ConfigFile} object to the file specified as a parameter. The output file uses an INI-style structure.
+   * Returns {@link OK} on success, or one of the other {@link Error} values if the operation failed.
+   */
+  save(path: string | NodePath): int;
+  /**
+   * Saves the contents of the {@link ConfigFile} object to the AES-256 encrypted file specified as a parameter, using the provided `key` to encrypt it. The output file uses an INI-style structure.
+   * Returns {@link OK} on success, or one of the other {@link Error} values if the operation failed.
+   */
+  save_encrypted(path: string | NodePath, key: PackedByteArray | Array<unknown>): int;
+  /**
+   * Saves the contents of the {@link ConfigFile} object to the AES-256 encrypted file specified as a parameter, using the provided `password` to encrypt it. The output file uses an INI-style structure.
+   * Returns {@link OK} on success, or one of the other {@link Error} values if the operation failed.
+   */
+  save_encrypted_pass(path: string | NodePath, password: string | NodePath): int;
+  /**
+   * Assigns a value to the specified key of the specified section. If either the section or the key do not exist, they are created. Passing a `null` value deletes the specified key if it exists, and deletes the section if it ends up empty once the key has been removed.
+   */
+  set_value(section: string | NodePath, key: string | NodePath, value: unknown): void;
+}

package/typings/classes/ConfirmationDialog.d.ts

@@ -0,0 +1,19 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A dialog used for confirmation of actions. */
+declare class ConfirmationDialog extends AcceptDialog {
+  /** The text displayed by the cancel button (see {@link get_cancel_button}). */
+  cancel_button_text: string;
+  min_size: Vector2i;
+  size: Vector2i;
+  title: string;
+  set_cancel_button_text(value: string | NodePath): void;
+  get_cancel_button_text(): string;
+
+  /**
+   * Returns the cancel button.
+   * **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.
+   */
+  get_cancel_button(): Button;
+}

package/typings/classes/Container.d.ts

@@ -0,0 +1,42 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** Base class for all GUI containers. */
+declare class Container extends Control {
+  /**
+   * If `true`, this container is marked as a region for accessibility. Use {@link Control.accessibility_name} to give the region a descriptive name. Screen readers can navigate between regions using landmark navigation.
+   */
+  accessibility_region: boolean;
+  mouse_filter: int;
+  set_accessibility_region(value: boolean): void;
+  is_accessibility_region(): boolean;
+
+  /**
+   * Implement to return a list of allowed horizontal {@link Control.SizeFlags} for child nodes. This doesn't technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock.
+   * **Note:** Having no size flags is equal to having {@link Control.SIZE_SHRINK_BEGIN}. As such, this value is always implicitly allowed.
+   */
+  _get_allowed_size_flags_horizontal(): PackedInt32Array;
+  /**
+   * Implement to return a list of allowed vertical {@link Control.SizeFlags} for child nodes. This doesn't technically prevent the usages of any other size flags, if your implementation requires that. This only limits the options available to the user in the Inspector dock.
+   * **Note:** Having no size flags is equal to having {@link Control.SIZE_SHRINK_BEGIN}. As such, this value is always implicitly allowed.
+   */
+  _get_allowed_size_flags_vertical(): PackedInt32Array;
+  /** Fit a child control in a given rect. This is mainly a helper for creating custom container classes. */
+  fit_child_in_rect(child: Control, rect: Rect2 | Rect2i): void;
+  /**
+   * Queue resort of the contained children. This is called automatically anyway, but can be called upon request.
+   */
+  queue_sort(): void;
+
+  /** Emitted when children are going to be sorted. */
+  pre_sort_children: Signal<[]>;
+  /** Emitted when sorting the children is needed. */
+  sort_children: Signal<[]>;
+
+  /**
+   * Notification just before children are going to be sorted, in case there's something to process beforehand.
+   */
+  static readonly NOTIFICATION_PRE_SORT_CHILDREN: int;
+  /** Notification for when sorting the children, it must be obeyed immediately. */
+  static readonly NOTIFICATION_SORT_CHILDREN: int;
+}