typescript-to-gdscript 0.1.0

package/typings/classes/CharacterBody3D.d.ts

@@ -0,0 +1,201 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A 3D physics body specialized for characters moved by script. */
+declare class CharacterBody3D extends PhysicsBody3D {
+  /**
+   * If `true`, the body will be able to move on the floor only. This option avoids to be able to walk on walls, it will however allow to slide down along them.
+   */
+  floor_block_on_wall: boolean;
+  /**
+   * If `false` (by default), the body will move faster on downward slopes and slower on upward slopes.
+   * If `true`, the body will always move at the same speed on the ground no matter the slope. Note that you need to use {@link floor_snap_length} to stick along a downward slope at constant speed.
+   */
+  floor_constant_speed: boolean;
+  /**
+   * Maximum angle (in radians) where a slope is still considered a floor (or a ceiling), rather than a wall, when calling {@link move_and_slide}. The default value equals 45 degrees.
+   */
+  floor_max_angle: float;
+  /**
+   * Sets a snapping distance. When set to a value different from `0.0`, the body is kept attached to slopes when calling {@link move_and_slide}. The snapping vector is determined by the given distance along the opposite direction of the {@link up_direction}.
+   * As long as the snapping vector is in contact with the ground and the body moves against {@link up_direction}, the body will remain attached to the surface. Snapping is not applied if the body moves along {@link up_direction}, meaning it contains vertical rising velocity, so it will be able to detach from the ground when jumping or when the body is pushed up by something. If you want to apply a snap without taking into account the velocity, use {@link apply_floor_snap}.
+   */
+  floor_snap_length: float;
+  /**
+   * If `true`, the body will not slide on slopes when calling {@link move_and_slide} when the body is standing still.
+   * If `false`, the body will slide on floor's slopes when {@link velocity} applies a downward force.
+   */
+  floor_stop_on_slope: boolean;
+  /**
+   * Maximum number of times the body can change direction before it stops when calling {@link move_and_slide}. Must be greater than zero.
+   */
+  max_slides: int;
+  /** Sets the motion mode which defines the behavior of {@link move_and_slide}. */
+  motion_mode: int;
+  /**
+   * Collision layers that will be included for detecting floor bodies that will act as moving platforms to be followed by the {@link CharacterBody3D}. By default, all floor bodies are detected and propagate their velocity.
+   */
+  platform_floor_layers: int;
+  /**
+   * Sets the behavior to apply when you leave a moving platform. By default, to be physically accurate, when you leave the last platform velocity is applied.
+   */
+  platform_on_leave: int;
+  /**
+   * Collision layers that will be included for detecting wall bodies that will act as moving platforms to be followed by the {@link CharacterBody3D}. By default, all wall bodies are ignored.
+   */
+  platform_wall_layers: int;
+  /**
+   * Extra margin used for collision recovery when calling {@link move_and_slide}.
+   * If the body is at least this close to another body, it will consider them to be colliding and will be pushed away before performing the actual motion.
+   * A higher value means it's more flexible for detecting collision, which helps with consistently detecting walls and floors.
+   * A lower value forces the collision algorithm to use more exact detection, so it can be used in cases that specifically require precision, e.g at very low scale to avoid visible jittering, or for stability with a stack of character bodies.
+   */
+  safe_margin: float;
+  /**
+   * If `true`, during a jump against the ceiling, the body will slide, if `false` it will be stopped and will fall vertically.
+   */
+  slide_on_ceiling: boolean;
+  /**
+   * Vector pointing upwards, used to determine what is a wall and what is a floor (or a ceiling) when calling {@link move_and_slide}. Defaults to {@link Vector3.UP}. As the vector will be normalized it can't be equal to {@link Vector3.ZERO}, if you want all collisions to be reported as walls, consider using {@link MOTION_MODE_FLOATING} as {@link motion_mode}.
+   */
+  up_direction: Vector3;
+  /**
+   * Current velocity vector (typically meters per second), used and modified during calls to {@link move_and_slide}.
+   * **Note:** A common mistake is setting this property to the desired velocity multiplied by `delta`, which produces a motion vector (typically in meters).
+   */
+  velocity: Vector3;
+  /**
+   * Minimum angle (in radians) where the body is allowed to slide when it encounters a wall. The default value equals 15 degrees. When {@link motion_mode} is {@link MOTION_MODE_GROUNDED}, it only affects movement if {@link floor_block_on_wall} is `true`.
+   */
+  wall_min_slide_angle: float;
+  set_floor_block_on_wall_enabled(value: boolean): void;
+  is_floor_block_on_wall_enabled(): boolean;
+  set_floor_constant_speed_enabled(value: boolean): void;
+  is_floor_constant_speed_enabled(): boolean;
+  set_floor_max_angle(value: float): void;
+  get_floor_max_angle(): float;
+  set_floor_snap_length(value: float): void;
+  get_floor_snap_length(): float;
+  set_floor_stop_on_slope_enabled(value: boolean): void;
+  is_floor_stop_on_slope_enabled(): boolean;
+  set_max_slides(value: int): void;
+  get_max_slides(): int;
+  set_motion_mode(value: int): void;
+  get_motion_mode(): int;
+  set_platform_floor_layers(value: int): void;
+  get_platform_floor_layers(): int;
+  set_platform_on_leave(value: int): void;
+  get_platform_on_leave(): int;
+  set_platform_wall_layers(value: int): void;
+  get_platform_wall_layers(): int;
+  set_safe_margin(value: float): void;
+  get_safe_margin(): float;
+  set_slide_on_ceiling_enabled(value: boolean): void;
+  is_slide_on_ceiling_enabled(): boolean;
+  set_up_direction(value: Vector3 | Vector3i): void;
+  get_up_direction(): Vector3;
+  set_velocity(value: Vector3 | Vector3i): void;
+  get_velocity(): Vector3;
+  set_wall_min_slide_angle(value: float): void;
+  get_wall_min_slide_angle(): float;
+
+  /**
+   * Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when {@link is_on_floor} returns `true`.
+   */
+  apply_floor_snap(): void;
+  /**
+   * Returns the floor's collision angle at the last collision point according to `up_direction`, which is {@link Vector3.UP} by default. This value is always positive and only valid after calling {@link move_and_slide} and when {@link is_on_floor} returns `true`.
+   */
+  get_floor_angle(up_direction?: Vector3 | Vector3i): float;
+  /**
+   * Returns the collision normal of the floor at the last collision point. Only valid after calling {@link move_and_slide} and when {@link is_on_floor} returns `true`.
+   * **Warning:** The collision normal is not always the same as the surface normal.
+   */
+  get_floor_normal(): Vector3;
+  /**
+   * Returns the last motion applied to the {@link CharacterBody3D} during the last call to {@link move_and_slide}. The movement can be split into multiple motions when sliding occurs, and this method return the last one, which is useful to retrieve the current direction of the movement.
+   */
+  get_last_motion(): Vector3;
+  /**
+   * Returns a {@link KinematicCollision3D} if a collision occurred. The returned value contains information about the latest collision that occurred during the last call to {@link move_and_slide}. Returns `null` if no collision occurred. See also {@link get_slide_collision}.
+   */
+  get_last_slide_collision(): KinematicCollision3D | null;
+  /**
+   * Returns the angular velocity of the platform at the last collision point. Only valid after calling {@link move_and_slide}.
+   */
+  get_platform_angular_velocity(): Vector3;
+  /**
+   * Returns the linear velocity of the platform at the last collision point. Only valid after calling {@link move_and_slide}.
+   */
+  get_platform_velocity(): Vector3;
+  /** Returns the travel (position delta) that occurred during the last call to {@link move_and_slide}. */
+  get_position_delta(): Vector3;
+  /**
+   * Returns the current real velocity since the last call to {@link move_and_slide}. For example, when you climb a slope, you will move diagonally even though the velocity is horizontal. This method returns the diagonal movement, as opposed to {@link velocity} which returns the requested velocity.
+   */
+  get_real_velocity(): Vector3;
+  /**
+   * Returns a {@link KinematicCollision3D}, which contains information about a collision that occurred during the last call to {@link move_and_slide}. Since the body can collide several times in a single call to {@link move_and_slide}, you must specify the index of the collision in the range 0 to ({@link get_slide_collision_count} - 1). See also {@link get_last_slide_collision}.
+   */
+  get_slide_collision(slide_idx: int): KinematicCollision3D | null;
+  /**
+   * Returns the number of times the body collided and changed direction during the last call to {@link move_and_slide}.
+   */
+  get_slide_collision_count(): int;
+  /**
+   * Returns the collision normal of the wall at the last collision point. Only valid after calling {@link move_and_slide} and when {@link is_on_wall} returns `true`.
+   * **Warning:** The collision normal is not always the same as the surface normal.
+   */
+  get_wall_normal(): Vector3;
+  /**
+   * Returns `true` if the body collided with the ceiling on the last call of {@link move_and_slide}. Otherwise, returns `false`. The {@link up_direction} and {@link floor_max_angle} are used to determine whether a surface is "ceiling" or not.
+   */
+  is_on_ceiling(): boolean;
+  /**
+   * Returns `true` if the body collided only with the ceiling on the last call of {@link move_and_slide}. Otherwise, returns `false`. The {@link up_direction} and {@link floor_max_angle} are used to determine whether a surface is "ceiling" or not.
+   */
+  is_on_ceiling_only(): boolean;
+  /**
+   * Returns `true` if the body collided with the floor on the last call of {@link move_and_slide}. Otherwise, returns `false`. The {@link up_direction} and {@link floor_max_angle} are used to determine whether a surface is "floor" or not.
+   */
+  is_on_floor(): boolean;
+  /**
+   * Returns `true` if the body collided only with the floor on the last call of {@link move_and_slide}. Otherwise, returns `false`. The {@link up_direction} and {@link floor_max_angle} are used to determine whether a surface is "floor" or not.
+   */
+  is_on_floor_only(): boolean;
+  /**
+   * Returns `true` if the body collided with a wall on the last call of {@link move_and_slide}. Otherwise, returns `false`. The {@link up_direction} and {@link floor_max_angle} are used to determine whether a surface is "wall" or not.
+   */
+  is_on_wall(): boolean;
+  /**
+   * Returns `true` if the body collided only with a wall on the last call of {@link move_and_slide}. Otherwise, returns `false`. The {@link up_direction} and {@link floor_max_angle} are used to determine whether a surface is "wall" or not.
+   */
+  is_on_wall_only(): boolean;
+  /**
+   * Moves the body based on {@link velocity}. If the body collides with another, it will slide along the other body rather than stop immediately. If the other body is a {@link CharacterBody3D} or {@link RigidBody3D}, it will also be affected by the motion of the other body. You can use this to make moving and rotating platforms, or to make nodes push other nodes.
+   * This method should be used in {@link Node._physics_process} (or in a method called by {@link Node._physics_process}), as it uses the physics step's `delta` value automatically in calculations. Otherwise, the simulation will run at an incorrect speed.
+   * Modifies {@link velocity} if a slide collision occurred. To get the latest collision call {@link get_last_slide_collision}, for more detailed information about collisions that occurred, use {@link get_slide_collision}.
+   * When the body touches a moving platform, the platform's velocity is automatically added to the body motion. If a collision occurs due to the platform's motion, it will always be first in the slide collisions.
+   * Returns `true` if the body collided, otherwise, returns `false`.
+   */
+  move_and_slide(): boolean;
+
+  // enum MotionMode
+  /**
+   * Apply when notions of walls, ceiling and floor are relevant. In this mode the body motion will react to slopes (acceleration/slowdown). This mode is suitable for grounded games like platformers.
+   */
+  static readonly MOTION_MODE_GROUNDED: int;
+  /**
+   * Apply when there is no notion of floor or ceiling. All collisions will be reported as `on_wall`. In this mode, when you slide, the speed will always be constant. This mode is suitable for games without ground like space games.
+   */
+  static readonly MOTION_MODE_FLOATING: int;
+  // enum PlatformOnLeave
+  /** Add the last platform velocity to the {@link velocity} when you leave a moving platform. */
+  static readonly PLATFORM_ON_LEAVE_ADD_VELOCITY: int;
+  /**
+   * Add the last platform velocity to the {@link velocity} when you leave a moving platform, but any downward motion is ignored. It's useful to keep full jump height even when the platform is moving down.
+   */
+  static readonly PLATFORM_ON_LEAVE_ADD_UPWARD_VELOCITY: int;
+  /** Do nothing when leaving a platform. */
+  static readonly PLATFORM_ON_LEAVE_DO_NOTHING: int;
+}

package/typings/classes/CheckBox.d.ts

@@ -0,0 +1,8 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A button that represents a binary choice. */
+declare class CheckBox extends Button {
+  alignment: int;
+  toggle_mode: boolean;
+}

package/typings/classes/CheckButton.d.ts

@@ -0,0 +1,8 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A button that represents a binary choice. */
+declare class CheckButton extends Button {
+  alignment: int;
+  toggle_mode: boolean;
+}

package/typings/classes/CircleShape2D.d.ts

@@ -0,0 +1,10 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A 2D circle shape used for physics collision. */
+declare class CircleShape2D extends Shape2D {
+  /** The circle's radius. */
+  radius: float;
+  set_radius(value: float): void;
+  get_radius(): float;
+}

package/typings/classes/ClassDB.d.ts

@@ -0,0 +1,110 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A class information repository. */
+declare interface ClassDB extends GodotObject {
+  /**
+   * Returns `true` if objects can be instantiated from the specified `class`, otherwise returns `false`.
+   */
+  can_instantiate(class_: string): boolean;
+  /** Calls a static method on a class. */
+  class_call_static<R = unknown>(
+  class_: string,
+  method: string,
+  ...args: any[]
+  ): R;
+  /** Returns whether the specified `class` is available or not. */
+  class_exists(class_: string): boolean;
+  /** Returns the API type of the specified `class`. */
+  class_get_api_type(class_: string): int;
+  /** Returns an array with all the keys in `enum` of `class` or its ancestry. */
+  class_get_enum_constants(class_: string, enum_: string, no_inheritance?: boolean): PackedStringArray;
+  /** Returns an array with all the enums of `class` or its ancestry. */
+  class_get_enum_list(class_: string, no_inheritance?: boolean): PackedStringArray;
+  /**
+   * Returns the value of the integer constant `name` of `class` or its ancestry. Always returns 0 when the constant could not be found.
+   */
+  class_get_integer_constant(class_: string, name: string): int;
+  /** Returns which enum the integer constant `name` of `class` or its ancestry belongs to. */
+  class_get_integer_constant_enum(class_: string, name: string, no_inheritance?: boolean): string;
+  /** Returns an array with the names all the integer constants of `class` or its ancestry. */
+  class_get_integer_constant_list(class_: string, no_inheritance?: boolean): PackedStringArray;
+  /**
+   * Returns the number of arguments of the method `method` of `class` or its ancestry if `no_inheritance` is `false`.
+   */
+  class_get_method_argument_count(class_: string, method: string, no_inheritance?: boolean): int;
+  /**
+   * Returns an array with all the methods of `class` or its ancestry if `no_inheritance` is `false`. Every element of the array is a {@link Dictionary} with the following keys: `args`, `default_args`, `flags`, `id`, `name`, `return: (class_name, hint, hint_string, name, type, usage)`.
+   * **Note:** In exported release builds the debug info is not available, so the returned dictionaries will contain only method names.
+   */
+  class_get_method_list(class_: string, no_inheritance?: boolean): Array<Dictionary>;
+  /** Returns the value of `property` of `object` or its ancestry. */
+  class_get_property<V = unknown>(
+  object: GodotObject,
+  property: string,
+  ): V;
+  /** Returns the default value of `property` of `class` or its ancestor classes. */
+  class_get_property_default_value<V = unknown>(
+  class_: string,
+  property: string,
+  ): V;
+  /** Returns the getter method name of `property` of `class`. */
+  class_get_property_getter(class_: string, property: string): string;
+  /** Returns an array with all the properties of `class` or its ancestry if `no_inheritance` is `false`. */
+  class_get_property_list(class_: string, no_inheritance?: boolean): Array<Dictionary>;
+  /** Returns the setter method name of `property` of `class`. */
+  class_get_property_setter(class_: string, property: string): string;
+  /**
+   * Returns the `signal` data of `class` or its ancestry. The returned value is a {@link Dictionary} with the following keys: `args`, `default_args`, `flags`, `id`, `name`, `return: (class_name, hint, hint_string, name, type, usage)`.
+   */
+  class_get_signal(class_: string, signal: string): Dictionary;
+  /**
+   * Returns an array with all the signals of `class` or its ancestry if `no_inheritance` is `false`. Every element of the array is a {@link Dictionary} as described in {@link class_get_signal}.
+   */
+  class_get_signal_list(class_: string, no_inheritance?: boolean): Array<Dictionary>;
+  /** Returns whether `class` or its ancestry has an enum called `name` or not. */
+  class_has_enum(class_: string, name: string, no_inheritance?: boolean): boolean;
+  /** Returns whether `class` or its ancestry has an integer constant called `name` or not. */
+  class_has_integer_constant(class_: string, name: string): boolean;
+  /**
+   * Returns whether `class` (or its ancestry if `no_inheritance` is `false`) has a method called `method` or not.
+   */
+  class_has_method(class_: string, method: string, no_inheritance?: boolean): boolean;
+  /** Returns whether `class` or its ancestry has a signal called `signal` or not. */
+  class_has_signal(class_: string, signal: string): boolean;
+  /** Sets `property` value of `object` to `value`. */
+  class_set_property(object: GodotObject, property: string, value: unknown): int;
+  /**
+   * Returns the names of all engine classes available.
+   * **Note:** Script-defined classes with `class_name` are not included in this list. Use {@link ProjectSettings.get_global_class_list} to get a list of script-defined classes instead.
+   */
+  get_class_list(): PackedStringArray;
+  /** Returns the names of all engine classes that directly or indirectly inherit from `class`. */
+  get_inheriters_from_class(class_: string): PackedStringArray;
+  /** Returns the parent class of `class`. */
+  get_parent_class(class_: string): string;
+  /** Creates an instance of `class`. */
+  instantiate<T extends GodotObject = GodotObject>(class_: string): T;
+  /** Returns whether this `class` is enabled or not. */
+  is_class_enabled(class_: string): boolean;
+  /**
+   * Returns whether `class` (or its ancestor classes if `no_inheritance` is `false`) has an enum called `enum` that is a bitfield.
+   */
+  is_class_enum_bitfield(class_: string, enum_: string, no_inheritance?: boolean): boolean;
+  /** Returns whether `inherits` is an ancestor of `class` or not. */
+  is_parent_class(class_: string, inherits: string): boolean;
+
+  // enum APIType
+  /** Native Core class type. */
+  readonly API_CORE: int;
+  /** Native Editor class type. */
+  readonly API_EDITOR: int;
+  /** GDExtension class type. */
+  readonly API_EXTENSION: int;
+  /** GDExtension Editor class type. */
+  readonly API_EDITOR_EXTENSION: int;
+  /** Unknown class type. */
+  readonly API_NONE: int;
+}
+declare const ClassDB: ClassDB;
+