typescript-to-gdscript 0.1.0

package/typings/classes/AnimationPlayer.d.ts

@@ -0,0 +1,203 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A node used for animation playback. */
+declare class AnimationPlayer extends AnimationMixer {
+  /**
+   * If playing, the current animation's key, otherwise, the animation last played. When set, this changes the animation, but will not play it unless already playing. See also {@link current_animation}.
+   */
+  assigned_animation: string;
+  /** The key of the animation to play when the scene loads. */
+  autoplay: string;
+  /**
+   * The key of the currently playing animation. If no animation is playing, the property's value is an empty string. Changing this value does not restart the animation. See {@link play} for more information on playing animations.
+   * **Note:** While this property appears in the Inspector, it's not meant to be edited, and it's not saved in the scene. This property is mainly used to get the currently playing animation, and internally for animation playback tracks. For more information, see {@link Animation}.
+   */
+  current_animation: string;
+  /** The length (in seconds) of the currently playing animation. */
+  current_animation_length: float;
+  /** The position (in seconds) of the currently playing animation. */
+  current_animation_position: float;
+  /**
+   * If `true` and the engine is running in Movie Maker mode (see {@link MovieWriter}), exits the engine with {@link SceneTree.quit} as soon as an animation is done playing in this {@link AnimationPlayer}. A message is printed when the engine quits for this reason.
+   * **Note:** This obeys the same logic as the {@link AnimationMixer.animation_finished} signal, so it will not quit the engine if the animation is set to be looping.
+   */
+  movie_quit_on_finish: boolean;
+  /**
+   * If `true`, performs {@link AnimationMixer.capture} before playback automatically. This means just {@link play_with_capture} is executed with default arguments instead of {@link play}.
+   * **Note:** Capture interpolation is only performed if the animation contains a capture track. See also {@link Animation.UPDATE_CAPTURE}.
+   */
+  playback_auto_capture: boolean;
+  /**
+   * See also {@link play_with_capture} and {@link AnimationMixer.capture}.
+   * If {@link playback_auto_capture_duration} is negative value, the duration is set to the interval between the current position and the first key.
+   */
+  playback_auto_capture_duration: float;
+  /** The ease type of the capture interpolation. See also {@link Tween.EaseType}. */
+  playback_auto_capture_ease_type: int;
+  /** The transition type of the capture interpolation. See also {@link Tween.TransitionType}. */
+  playback_auto_capture_transition_type: int;
+  /** The default time in which to blend animations. Ranges from 0 to 4096 with 0.01 precision. */
+  playback_default_blend_time: float;
+  /**
+   * The speed scaling ratio. For example, if this value is `1`, then the animation plays at normal speed. If it's `0.5`, then it plays at half speed. If it's `2`, then it plays at double speed.
+   * If set to a negative value, the animation is played in reverse. If set to `0`, the animation will not advance.
+   */
+  speed_scale: float;
+  set_assigned_animation(value: string): void;
+  get_assigned_animation(): string;
+  set_autoplay(value: string): void;
+  get_autoplay(): string;
+  set_current_animation(value: string): void;
+  get_current_animation(): string;
+  get_current_animation_length(): float;
+  get_current_animation_position(): float;
+  set_movie_quit_on_finish_enabled(value: boolean): void;
+  is_movie_quit_on_finish_enabled(): boolean;
+  set_auto_capture(value: boolean): void;
+  is_auto_capture(): boolean;
+  set_auto_capture_duration(value: float): void;
+  get_auto_capture_duration(): float;
+  set_auto_capture_ease_type(value: int): void;
+  get_auto_capture_ease_type(): int;
+  set_auto_capture_transition_type(value: int): void;
+  get_auto_capture_transition_type(): int;
+  set_default_blend_time(value: float): void;
+  get_default_blend_time(): float;
+  set_speed_scale(value: float): void;
+  get_speed_scale(): float;
+
+  /** Returns the key of the animation which is queued to play after the `animation_from` animation. */
+  animation_get_next(animation_from: string): string;
+  /** Triggers the `animation_to` animation when the `animation_from` animation completes. */
+  animation_set_next(animation_from: string, animation_to: string): void;
+  /** Clears all queued, unplayed animations. */
+  clear_queue(): void;
+  /** Returns the blend time (in seconds) between two animations, referenced by their keys. */
+  get_blend_time(animation_from: string, animation_to: string): float;
+  /** Returns the call mode used for "Call Method" tracks. */
+  get_method_call_mode(): int;
+  /**
+   * Returns the actual playing speed of current animation or `0` if not playing. This speed is the {@link speed_scale} property multiplied by `custom_speed` argument specified when calling the {@link play} method.
+   * Returns a negative value if the current animation is playing backwards.
+   */
+  get_playing_speed(): float;
+  /** Returns the process notification in which to update animations. */
+  get_process_callback(): int;
+  /** Returns a list of the animation keys that are currently queued to play. */
+  get_queue(): Array<string>;
+  /** Returns the node which node path references will travel from. */
+  get_root(): NodePath;
+  /** Returns the end time of the section currently being played. */
+  get_section_end_time(): float;
+  /** Returns the start time of the section currently being played. */
+  get_section_start_time(): float;
+  /** Returns `true` if an animation is currently playing with a section. */
+  has_section(): boolean;
+  /**
+   * Returns `true` if the an animation is currently active. An animation is active if it was played by calling {@link play} and was not finished yet, or was stopped by calling {@link stop}.
+   * This can be used to check whether an animation is currently paused or stopped.
+   */
+  is_animation_active(): boolean;
+  /**
+   * Returns `true` if an animation is currently playing (even if {@link speed_scale} and/or `custom_speed` are `0`).
+   */
+  is_playing(): boolean;
+  /**
+   * Pauses the currently playing animation. The {@link current_animation_position} will be kept and calling {@link play} or {@link play_backwards} without arguments or with the same animation name as {@link assigned_animation} will resume the animation.
+   * See also {@link stop}.
+   */
+  pause(): void;
+  /**
+   * Plays the animation with key `name`. Custom blend times and speed can be set.
+   * The `from_end` option only affects when switching to a new animation track, or if the same track but at the start or end. It does not affect resuming playback that was paused in the middle of an animation. If `custom_speed` is negative and `from_end` is `true`, the animation will play backwards (which is equivalent to calling {@link play_backwards}).
+   * The {@link AnimationPlayer} keeps track of its current or last played animation with {@link assigned_animation}. If this method is called with that same animation `name`, or with no `name` parameter, the assigned animation will resume playing if it was paused.
+   * **Note:** The animation will be updated the next time the {@link AnimationPlayer} is processed. If other variables are updated at the same time this is called, they may be updated too early. To perform the update immediately, call `advance(0)`.
+   */
+  play(name?: string, custom_blend?: float, custom_speed?: float, from_end?: boolean): void;
+  /**
+   * Plays the animation with key `name` in reverse.
+   * This method is a shorthand for {@link play} with `custom_speed = -1.0` and `from_end = true`, so see its description for more information.
+   */
+  play_backwards(name?: string, custom_blend?: float): void;
+  /**
+   * Plays the animation with key `name` and the section starting from `start_time` and ending on `end_time`. See also {@link play}.
+   * Setting `start_time` to a value outside the range of the animation means the start of the animation will be used instead, and setting `end_time` to a value outside the range of the animation means the end of the animation will be used instead. `start_time` cannot be equal to `end_time`.
+   */
+  play_section(name?: string, start_time?: float, end_time?: float, custom_blend?: float, custom_speed?: float, from_end?: boolean): void;
+  /**
+   * Plays the animation with key `name` and the section starting from `start_time` and ending on `end_time` in reverse.
+   * This method is a shorthand for {@link play_section} with `custom_speed = -1.0` and `from_end = true`, see its description for more information.
+   */
+  play_section_backwards(name?: string, start_time?: float, end_time?: float, custom_blend?: float): void;
+  /**
+   * Plays the animation with key `name` and the section starting from `start_marker` and ending on `end_marker`.
+   * If the start marker is empty, the section starts from the beginning of the animation. If the end marker is empty, the section ends on the end of the animation. See also {@link play}.
+   */
+  play_section_with_markers(name?: string, start_marker?: string, end_marker?: string, custom_blend?: float, custom_speed?: float, from_end?: boolean): void;
+  /**
+   * Plays the animation with key `name` and the section starting from `start_marker` and ending on `end_marker` in reverse.
+   * This method is a shorthand for {@link play_section_with_markers} with `custom_speed = -1.0` and `from_end = true`, see its description for more information.
+   */
+  play_section_with_markers_backwards(name?: string, start_marker?: string, end_marker?: string, custom_blend?: float): void;
+  /**
+   * See also {@link AnimationMixer.capture}.
+   * You can use this method to use more detailed options for capture than those performed by {@link playback_auto_capture}. When {@link playback_auto_capture} is `false`, this method is almost the same as the following:
+   * If `name` is blank, it specifies {@link assigned_animation}.
+   * If `duration` is a negative value, the duration is set to the interval between the current position and the first key, when `from_end` is `true`, uses the interval between the current position and the last key instead.
+   * **Note:** The `duration` takes {@link speed_scale} into account, but `custom_speed` does not, because the capture cache is interpolated with the blend result and the result may contain multiple animations.
+   */
+  play_with_capture(name?: string, duration?: float, custom_blend?: float, custom_speed?: float, from_end?: boolean, trans_type?: int, ease_type?: int): void;
+  /**
+   * Queues an animation for playback once the current animation and all previously queued animations are done.
+   * **Note:** If a looped animation is currently playing, the queued animation will never play unless the looped animation is stopped somehow.
+   */
+  queue(name: string): void;
+  /** Resets the current section. Does nothing if a section has not been set. */
+  reset_section(): void;
+  /**
+   * Seeks the animation to the `seconds` point in time (in seconds). If `update` is `true`, the animation updates too, otherwise it updates at process time. Events between the current frame and `seconds` are skipped.
+   * If `update_only` is `true`, the method / audio / animation playback tracks will not be processed.
+   * **Note:** Seeking to the end of the animation doesn't emit {@link AnimationMixer.animation_finished}. If you want to skip animation and emit the signal, use {@link AnimationMixer.advance}.
+   */
+  seek(seconds: float, update?: boolean, update_only?: boolean): void;
+  /** Specifies a blend time (in seconds) between two animations, referenced by their keys. */
+  set_blend_time(animation_from: string, animation_to: string, sec: float): void;
+  /** Sets the call mode used for "Call Method" tracks. */
+  set_method_call_mode(mode: int): void;
+  /** Sets the process notification in which to update animations. */
+  set_process_callback(mode: int): void;
+  /** Sets the node which node path references will travel from. */
+  set_root(path: NodePath | string): void;
+  /**
+   * Changes the start and end times of the section being played. The current playback position will be clamped within the new section. See also {@link play_section}.
+   */
+  set_section(start_time?: float, end_time?: float): void;
+  /**
+   * Changes the start and end markers of the section being played. The current playback position will be clamped within the new section. See also {@link play_section_with_markers}.
+   * If the argument is empty, the section uses the beginning or end of the animation. If both are empty, it means that the section is not set.
+   */
+  set_section_with_markers(start_marker?: string, end_marker?: string): void;
+  /**
+   * Stops the currently playing animation. The animation position is reset to `0` and the `custom_speed` is reset to `1.0`. See also {@link pause}.
+   * If `keep_state` is `true`, the animation state is not updated visually.
+   * **Note:** The method / audio / animation playback tracks will not be processed by this method.
+   */
+  stop(keep_state?: boolean): void;
+
+  /**
+   * Emitted when a queued animation plays after the previous animation finished. See also {@link AnimationPlayer.queue}.
+   * **Note:** The signal is not emitted when the animation is changed via {@link AnimationPlayer.play} or by an {@link AnimationTree}.
+   */
+  animation_changed: Signal<[string, string]>;
+  /** Emitted when {@link current_animation} changes. */
+  current_animation_changed: Signal<[string]>;
+
+  // enum AnimationProcessCallback
+  static readonly ANIMATION_PROCESS_PHYSICS: int;
+  static readonly ANIMATION_PROCESS_IDLE: int;
+  static readonly ANIMATION_PROCESS_MANUAL: int;
+  // enum AnimationMethodCallMode
+  static readonly ANIMATION_METHOD_CALL_DEFERRED: int;
+  static readonly ANIMATION_METHOD_CALL_IMMEDIATE: int;
+}

package/typings/classes/AnimationRootNode.d.ts

@@ -0,0 +1,8 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/**
+ * Base class for {@link AnimationNode}s that hold one or multiple composite animations. Usually used for {@link AnimationTree.tree_root}.
+ */
+declare class AnimationRootNode extends AnimationNode {
+}

package/typings/classes/AnimationTree.d.ts

@@ -0,0 +1,35 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A node used for advanced animation transitions in an {@link AnimationPlayer}. */
+declare class AnimationTree extends AnimationMixer {
+  /**
+   * The path to the {@link Node} used to evaluate the {@link AnimationNode} {@link Expression} if one is not explicitly specified internally.
+   */
+  advance_expression_base_node: NodePath;
+  /** The path to the {@link AnimationPlayer} used for animating. */
+  anim_player: NodePath;
+  /**
+   * <member name="deterministic" type="bool" setter="set_deterministic" getter="is_deterministic" overrides="AnimationMixer" default="true" />
+   * <member name="tree_root" type="AnimationRootNode" setter="set_tree_root" getter="get_tree_root">
+   * The root animation node of this {@link AnimationTree}. See {@link AnimationRootNode}.
+   */
+  callback_mode_discrete: int;
+  set_advance_expression_base_node(value: NodePath | string): void;
+  get_advance_expression_base_node(): NodePath;
+  set_animation_player(value: NodePath | string): void;
+  get_animation_player(): NodePath;
+
+  /** Returns the process notification in which to update animations. */
+  get_process_callback(): int;
+  /** Sets the process notification in which to update animations. */
+  set_process_callback(mode: int): void;
+
+  /** Emitted when the {@link anim_player} is changed. */
+  animation_player_changed: Signal<[]>;
+
+  // enum AnimationProcessCallback
+  static readonly ANIMATION_PROCESS_PHYSICS: int;
+  static readonly ANIMATION_PROCESS_IDLE: int;
+  static readonly ANIMATION_PROCESS_MANUAL: int;
+}

package/typings/classes/Area2D.d.ts

@@ -0,0 +1,166 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A region of 2D space that detects other {@link CollisionObject2D}s entering or exiting it. */
+declare class Area2D extends CollisionObject2D {
+  /**
+   * The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.
+   * See {@link ProjectSettings.physics/2d/default_angular_damp} for more details about damping.
+   */
+  angular_damp: float;
+  /** Override mode for angular damping calculations within this area. */
+  angular_damp_space_override: int;
+  /** The name of the area's audio bus. */
+  audio_bus_name: string;
+  /** If `true`, the area's audio bus overrides the default audio bus. */
+  audio_bus_override: boolean;
+  /**
+   * The area's gravity intensity (in pixels per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction.
+   */
+  gravity: float;
+  /** The area's gravity vector (not normalized). */
+  gravity_direction: Vector2;
+  /**
+   * If `true`, gravity is calculated from a point (set via {@link gravity_point_center}). See also {@link gravity_space_override}.
+   */
+  gravity_point: boolean;
+  /** If gravity is a point (see {@link gravity_point}), this will be the point of attraction. */
+  gravity_point_center: Vector2;
+  /**
+   * The distance at which the gravity strength is equal to {@link gravity}. For example, on a planet 100 pixels in radius with a surface gravity of 4.0 px/s², set the {@link gravity} to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 pixels from the center the gravity will be 1.0 px/s² (twice the distance, 1/4th the gravity), at 50 pixels it will be 16.0 px/s² (half the distance, 4x the gravity), and so on.
+   * The above is true only when the unit distance is a positive number. When this is set to 0.0, the gravity will be constant regardless of distance.
+   */
+  gravity_point_unit_distance: float;
+  /** Override mode for gravity calculations within this area. */
+  gravity_space_override: int;
+  /**
+   * The rate at which objects stop moving in this area. Represents the linear velocity lost per second.
+   * See {@link ProjectSettings.physics/2d/default_linear_damp} for more details about damping.
+   */
+  linear_damp: float;
+  /** Override mode for linear damping calculations within this area. */
+  linear_damp_space_override: int;
+  /** If `true`, other monitoring areas can detect this area. */
+  monitorable: boolean;
+  /** If `true`, the area detects bodies or areas entering and exiting it. */
+  monitoring: boolean;
+  /**
+   * The area's priority. Higher priority areas are processed first. The {@link World2D}'s physics is always processed last, after all areas.
+   */
+  priority: int;
+  set_angular_damp(value: float): void;
+  get_angular_damp(): float;
+  set_angular_damp_space_override_mode(value: int): void;
+  get_angular_damp_space_override_mode(): int;
+  set_audio_bus_name(value: string): void;
+  get_audio_bus_name(): string;
+  set_audio_bus_override(value: boolean): void;
+  is_overriding_audio_bus(): boolean;
+  set_gravity(value: float): void;
+  get_gravity(): float;
+  set_gravity_direction(value: Vector2 | Vector2i): void;
+  get_gravity_direction(): Vector2;
+  set_gravity_is_point(value: boolean): void;
+  is_gravity_a_point(): boolean;
+  set_gravity_point_center(value: Vector2 | Vector2i): void;
+  get_gravity_point_center(): Vector2;
+  set_gravity_point_unit_distance(value: float): void;
+  get_gravity_point_unit_distance(): float;
+  set_gravity_space_override_mode(value: int): void;
+  get_gravity_space_override_mode(): int;
+  set_linear_damp(value: float): void;
+  get_linear_damp(): float;
+  set_linear_damp_space_override_mode(value: int): void;
+  get_linear_damp_space_override_mode(): int;
+  set_monitorable(value: boolean): void;
+  is_monitorable(): boolean;
+  set_monitoring(value: boolean): void;
+  is_monitoring(): boolean;
+  set_priority(value: int): void;
+  get_priority(): int;
+
+  /**
+   * Returns a list of intersecting {@link Area2D}s. The overlapping area's {@link CollisionObject2D.collision_layer} must be part of this area's {@link CollisionObject2D.collision_mask} in order to be detected.
+   * For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+   */
+  get_overlapping_areas(): Array<Area2D>;
+  /**
+   * Returns a list of intersecting {@link PhysicsBody2D}s and {@link TileMap}s. The overlapping body's {@link CollisionObject2D.collision_layer} must be part of this area's {@link CollisionObject2D.collision_mask} in order to be detected.
+   * For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+   */
+  get_overlapping_bodies(): Array<Node2D>;
+  /**
+   * Returns `true` if intersecting any {@link Area2D}s, otherwise returns `false`. The overlapping area's {@link CollisionObject2D.collision_layer} must be part of this area's {@link CollisionObject2D.collision_mask} in order to be detected.
+   * For performance reasons (collisions are all processed at the same time) the list of overlapping areas is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+   */
+  has_overlapping_areas(): boolean;
+  /**
+   * Returns `true` if intersecting any {@link PhysicsBody2D}s or {@link TileMap}s, otherwise returns `false`. The overlapping body's {@link CollisionObject2D.collision_layer} must be part of this area's {@link CollisionObject2D.collision_mask} in order to be detected.
+   * For performance reasons (collisions are all processed at the same time) the list of overlapping bodies is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+   */
+  has_overlapping_bodies(): boolean;
+  /**
+   * Returns `true` if the given {@link Area2D} intersects or overlaps this {@link Area2D}, `false` otherwise.
+   * **Note:** The result of this test is not immediate after moving objects. For performance, the list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
+   */
+  overlaps_area(area: Node): boolean;
+  /**
+   * Returns `true` if the given physics body intersects or overlaps this {@link Area2D}, `false` otherwise.
+   * **Note:** The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
+   * The `body` argument can either be a {@link PhysicsBody2D} or a {@link TileMap} instance. While TileMaps are not physics bodies themselves, they register their tiles with collision shapes as a virtual physics body.
+   */
+  overlaps_body(body: Node): boolean;
+
+  /** Emitted when the received `area` enters this area. Requires {@link monitoring} to be set to `true`. */
+  area_entered: Signal<[Area2D]>;
+  /** Emitted when the received `area` exits this area. Requires {@link monitoring} to be set to `true`. */
+  area_exited: Signal<[Area2D]>;
+  /**
+   * Emitted when a {@link Shape2D} of the received `area` enters a shape of this area. Requires {@link monitoring} to be set to `true`.
+   * `local_shape_index` and `area_shape_index` contain indices of the interacting shapes from this area and the other area, respectively. `area_rid` contains the {@link RID} of the other area. These values can be used with the {@link PhysicsServer2D}.
+   * **Example:** Get the {@link CollisionShape2D} node from the shape index:
+   */
+  area_shape_entered: Signal<[RID, Area2D, int, int]>;
+  /**
+   * Emitted when a {@link Shape2D} of the received `area` exits a shape of this area. Requires {@link monitoring} to be set to `true`.
+   * See also {@link area_shape_entered}.
+   */
+  area_shape_exited: Signal<[RID, Area2D, int, int]>;
+  /**
+   * Emitted when the received `body` enters this area. `body` can be a {@link PhysicsBody2D} or a {@link TileMap}. {@link TileMap}s are detected if their {@link TileSet} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   */
+  body_entered: Signal<[Node2D]>;
+  /**
+   * Emitted when the received `body` exits this area. `body` can be a {@link PhysicsBody2D} or a {@link TileMap}. {@link TileMap}s are detected if their {@link TileSet} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   */
+  body_exited: Signal<[Node2D]>;
+  /**
+   * Emitted when a {@link Shape2D} of the received `body` enters a shape of this area. `body` can be a {@link PhysicsBody2D} or a {@link TileMap}. {@link TileMap}s are detected if their {@link TileSet} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * `local_shape_index` and `body_shape_index` contain indices of the interacting shapes from this area and the interacting body, respectively. `body_rid` contains the {@link RID} of the body. These values can be used with the {@link PhysicsServer2D}.
+   * **Example:** Get the {@link CollisionShape2D} node from the shape index:
+   */
+  body_shape_entered: Signal<[RID, Node2D, int, int]>;
+  /**
+   * Emitted when a {@link Shape2D} of the received `body` exits a shape of this area. `body` can be a {@link PhysicsBody2D} or a {@link TileMap}. {@link TileMap}s are detected if their {@link TileSet} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * See also {@link body_shape_entered}.
+   */
+  body_shape_exited: Signal<[RID, Node2D, int, int]>;
+
+  // enum SpaceOverride
+  /** This area does not affect gravity/damping. */
+  static readonly SPACE_OVERRIDE_DISABLED: int;
+  /**
+   * This area adds its gravity/damping values to whatever has been calculated so far (in {@link priority} order).
+   */
+  static readonly SPACE_OVERRIDE_COMBINE: int;
+  /**
+   * This area adds its gravity/damping values to whatever has been calculated so far (in {@link priority} order), ignoring any lower priority areas.
+   */
+  static readonly SPACE_OVERRIDE_COMBINE_REPLACE: int;
+  /** This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. */
+  static readonly SPACE_OVERRIDE_REPLACE: int;
+  /**
+   * This area replaces any gravity/damping calculated so far (in {@link priority} order), but keeps calculating the rest of the areas.
+   */
+  static readonly SPACE_OVERRIDE_REPLACE_COMBINE: int;
+}

package/typings/classes/Area3D.d.ts

@@ -0,0 +1,214 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** A region of 3D space that detects other {@link CollisionObject3D}s entering or exiting it. */
+declare class Area3D extends CollisionObject3D {
+  /**
+   * The rate at which objects stop spinning in this area. Represents the angular velocity lost per second.
+   * See {@link ProjectSettings.physics/3d/default_angular_damp} for more details about damping.
+   */
+  angular_damp: float;
+  /** Override mode for angular damping calculations within this area. */
+  angular_damp_space_override: int;
+  /** The name of the area's audio bus. */
+  audio_bus_name: string;
+  /** If `true`, the area's audio bus overrides the default audio bus. */
+  audio_bus_override: boolean;
+  /**
+   * The area's gravity intensity (in meters per second squared). This value multiplies the gravity direction. This is useful to alter the force of gravity without altering its direction.
+   */
+  gravity: float;
+  /** The area's gravity vector (not normalized). */
+  gravity_direction: Vector3;
+  /**
+   * If `true`, gravity is calculated from a point (set via {@link gravity_point_center}). See also {@link gravity_space_override}.
+   */
+  gravity_point: boolean;
+  /** If gravity is a point (see {@link gravity_point}), this will be the point of attraction. */
+  gravity_point_center: Vector3;
+  /**
+   * The distance at which the gravity strength is equal to {@link gravity}. For example, on a planet 100 meters in radius with a surface gravity of 4.0 m/s², set the {@link gravity} to 4.0 and the unit distance to 100.0. The gravity will have falloff according to the inverse square law, so in the example, at 200 meters from the center the gravity will be 1.0 m/s² (twice the distance, 1/4th the gravity), at 50 meters it will be 16.0 m/s² (half the distance, 4x the gravity), and so on.
+   * The above is true only when the unit distance is a positive number. When this is set to 0.0, the gravity will be constant regardless of distance.
+   */
+  gravity_point_unit_distance: float;
+  /** Override mode for gravity calculations within this area. */
+  gravity_space_override: int;
+  /**
+   * The rate at which objects stop moving in this area. Represents the linear velocity lost per second.
+   * See {@link ProjectSettings.physics/3d/default_linear_damp} for more details about damping.
+   */
+  linear_damp: float;
+  /** Override mode for linear damping calculations within this area. */
+  linear_damp_space_override: int;
+  /** If `true`, other monitoring areas can detect this area. */
+  monitorable: boolean;
+  /** If `true`, the area detects bodies or areas entering and exiting it. */
+  monitoring: boolean;
+  /**
+   * The area's priority. Higher priority areas are processed first. The {@link World3D}'s physics is always processed last, after all areas.
+   */
+  priority: int;
+  /**
+   * The degree to which this area applies reverb to its associated audio. Ranges from `0` to `1` with `0.1` precision.
+   */
+  reverb_bus_amount: float;
+  /** If `true`, the area applies reverb to its associated audio. */
+  reverb_bus_enabled: boolean;
+  /** The name of the reverb bus to use for this area's associated audio. */
+  reverb_bus_name: string;
+  /**
+   * The degree to which this area's reverb is a uniform effect. Ranges from `0` to `1` with `0.1` precision.
+   */
+  reverb_bus_uniformity: float;
+  /**
+   * The exponential rate at which wind force decreases with distance from its origin.
+   * **Note:** This wind force only applies to {@link SoftBody3D} nodes. Other physics bodies are currently not affected by wind.
+   */
+  wind_attenuation_factor: float;
+  /**
+   * The magnitude of area-specific wind force.
+   * **Note:** This wind force only applies to {@link SoftBody3D} nodes. Other physics bodies are currently not affected by wind.
+   */
+  wind_force_magnitude: float;
+  /**
+   * The {@link Node3D} which is used to specify the direction and origin of an area-specific wind force. The direction is opposite to the z-axis of the {@link Node3D}'s local transform, and its origin is the origin of the {@link Node3D}'s local transform.
+   * **Note:** This wind force only applies to {@link SoftBody3D} nodes. Other physics bodies are currently not affected by wind.
+   */
+  wind_source_path: NodePath;
+  set_angular_damp(value: float): void;
+  get_angular_damp(): float;
+  set_angular_damp_space_override_mode(value: int): void;
+  get_angular_damp_space_override_mode(): int;
+  set_audio_bus_name(value: string): void;
+  get_audio_bus_name(): string;
+  set_audio_bus_override(value: boolean): void;
+  is_overriding_audio_bus(): boolean;
+  set_gravity(value: float): void;
+  get_gravity(): float;
+  set_gravity_direction(value: Vector3 | Vector3i): void;
+  get_gravity_direction(): Vector3;
+  set_gravity_is_point(value: boolean): void;
+  is_gravity_a_point(): boolean;
+  set_gravity_point_center(value: Vector3 | Vector3i): void;
+  get_gravity_point_center(): Vector3;
+  set_gravity_point_unit_distance(value: float): void;
+  get_gravity_point_unit_distance(): float;
+  set_gravity_space_override_mode(value: int): void;
+  get_gravity_space_override_mode(): int;
+  set_linear_damp(value: float): void;
+  get_linear_damp(): float;
+  set_linear_damp_space_override_mode(value: int): void;
+  get_linear_damp_space_override_mode(): int;
+  set_monitorable(value: boolean): void;
+  is_monitorable(): boolean;
+  set_monitoring(value: boolean): void;
+  is_monitoring(): boolean;
+  set_priority(value: int): void;
+  get_priority(): int;
+  set_reverb_amount(value: float): void;
+  get_reverb_amount(): float;
+  set_use_reverb_bus(value: boolean): void;
+  is_using_reverb_bus(): boolean;
+  set_reverb_bus_name(value: string): void;
+  get_reverb_bus_name(): string;
+  set_reverb_uniformity(value: float): void;
+  get_reverb_uniformity(): float;
+  set_wind_attenuation_factor(value: float): void;
+  get_wind_attenuation_factor(): float;
+  set_wind_force_magnitude(value: float): void;
+  get_wind_force_magnitude(): float;
+  set_wind_source_path(value: NodePath | string): void;
+  get_wind_source_path(): NodePath;
+
+  /**
+   * Returns a list of intersecting {@link Area3D}s. The overlapping area's {@link CollisionObject3D.collision_layer} must be part of this area's {@link CollisionObject3D.collision_mask} in order to be detected.
+   * For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+   */
+  get_overlapping_areas(): Array<Area3D>;
+  /**
+   * Returns a list of intersecting {@link PhysicsBody3D}s, {@link SoftBody3D}s, and {@link GridMap}s. The overlapping body's {@link CollisionObject3D.collision_layer} must be part of this area's {@link CollisionObject3D.collision_mask} in order to be detected.
+   * For performance reasons (collisions are all processed at the same time) this list is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+   * **Note:** Godot Physics does not support reporting overlaps with {@link SoftBody3D}, so will not return any such bodies.
+   */
+  get_overlapping_bodies(): Array<Node3D>;
+  /**
+   * Returns `true` if intersecting any {@link Area3D}s, otherwise returns `false`. The overlapping area's {@link CollisionObject3D.collision_layer} must be part of this area's {@link CollisionObject3D.collision_mask} in order to be detected.
+   * For performance reasons (collisions are all processed at the same time) the list of overlapping areas is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+   */
+  has_overlapping_areas(): boolean;
+  /**
+   * Returns `true` if intersecting any {@link PhysicsBody3D}s, {@link SoftBody3D}s, or {@link GridMap}s, otherwise returns `false`. The overlapping body's {@link CollisionObject3D.collision_layer} must be part of this area's {@link CollisionObject3D.collision_mask} in order to be detected.
+   * For performance reasons (collisions are all processed at the same time) the list of overlapping bodies is modified once during the physics step, not immediately after objects are moved. Consider using signals instead.
+   * **Note:** Godot Physics does not support reporting overlaps with {@link SoftBody3D}, so will not consider such bodies.
+   */
+  has_overlapping_bodies(): boolean;
+  /**
+   * Returns `true` if the given {@link Area3D} intersects or overlaps this {@link Area3D}, `false` otherwise.
+   * **Note:** The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
+   */
+  overlaps_area(area: Node): boolean;
+  /**
+   * Returns `true` if the given physics body intersects or overlaps this {@link Area3D}, `false` otherwise.
+   * `body` argument can either be a {@link PhysicsBody3D}, {@link SoftBody3D}, or a {@link GridMap} instance. While GridMaps are not physics body themselves, they register their tiles with collision shapes as a virtual physics body.
+   * **Note:** The result of this test is not immediate after moving objects. For performance, list of overlaps is updated once per frame and before the physics step. Consider using signals instead.
+   * **Note:** Godot Physics does not support reporting overlaps with {@link SoftBody3D}, so will return `false` in such cases.
+   */
+  overlaps_body(body: Node): boolean;
+
+  /** Emitted when the received `area` enters this area. Requires {@link monitoring} to be set to `true`. */
+  area_entered: Signal<[Area3D]>;
+  /** Emitted when the received `area` exits this area. Requires {@link monitoring} to be set to `true`. */
+  area_exited: Signal<[Area3D]>;
+  /**
+   * Emitted when a {@link Shape3D} of the received `area` enters a shape of this area. Requires {@link monitoring} to be set to `true`.
+   * `local_shape_index` and `area_shape_index` contain indices of the interacting shapes from this area and the other area, respectively. `area_rid` contains the {@link RID} of the other area. These values can be used with the {@link PhysicsServer3D}.
+   * **Example:** Get the {@link CollisionShape3D} node from the shape index:
+   */
+  area_shape_entered: Signal<[RID, Area3D, int, int]>;
+  /**
+   * Emitted when a {@link Shape3D} of the received `area` exits a shape of this area. Requires {@link monitoring} to be set to `true`.
+   * See also {@link area_shape_entered}.
+   */
+  area_shape_exited: Signal<[RID, Area3D, int, int]>;
+  /**
+   * Emitted when the received `body` enters this area. `body` can be a {@link PhysicsBody3D}, {@link SoftBody3D} or {@link GridMap}. {@link GridMap}s are detected if their {@link MeshLibrary} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * **Note:** Godot Physics does not support reporting overlaps with {@link SoftBody3D}, so will not emit this signal in such cases.
+   */
+  body_entered: Signal<[Node3D]>;
+  /**
+   * Emitted when the received `body` exits this area. `body` can be a {@link PhysicsBody3D}, {@link SoftBody3D} or {@link GridMap}. {@link GridMap}s are detected if their {@link MeshLibrary} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * **Note:** Godot Physics does not support reporting overlaps with {@link SoftBody3D}, so will not emit this signal in such cases.
+   */
+  body_exited: Signal<[Node3D]>;
+  /**
+   * Emitted when a {@link Shape3D} of the received `body` enters a shape of this area. `body` can be a {@link PhysicsBody3D}, {@link SoftBody3D} or {@link GridMap}. {@link GridMap}s are detected if their {@link MeshLibrary} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * `local_shape_index` and `body_shape_index` contain indices of the interacting shapes from this area and the interacting body, respectively. `body_rid` contains the {@link RID} of the body. These values can be used with the {@link PhysicsServer3D}.
+   * **Note:** Godot Physics does not support reporting overlaps with {@link SoftBody3D}, so will not emit this signal in such cases.
+   * **Example:** Get the {@link CollisionShape3D} node from the shape index:
+   */
+  body_shape_entered: Signal<[RID, Node3D, int, int]>;
+  /**
+   * Emitted when a {@link Shape3D} of the received `body` exits a shape of this area. `body` can be a {@link PhysicsBody3D}, {@link SoftBody3D} or {@link GridMap}. {@link GridMap}s are detected if their {@link MeshLibrary} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * See also {@link body_shape_entered}.
+   * **Note:** Godot Physics does not support reporting overlaps with {@link SoftBody3D}, so will not emit this signal in such cases.
+   */
+  body_shape_exited: Signal<[RID, Node3D, int, int]>;
+
+  // enum SpaceOverride
+  /** This area does not affect gravity/damping. */
+  static readonly SPACE_OVERRIDE_DISABLED: int;
+  /**
+   * This area adds its gravity/damping values to whatever has been calculated so far (in {@link priority} order).
+   */
+  static readonly SPACE_OVERRIDE_COMBINE: int;
+  /**
+   * This area adds its gravity/damping values to whatever has been calculated so far (in {@link priority} order), ignoring any lower priority areas.
+   */
+  static readonly SPACE_OVERRIDE_COMBINE_REPLACE: int;
+  /** This area replaces any gravity/damping, even the defaults, ignoring any lower priority areas. */
+  static readonly SPACE_OVERRIDE_REPLACE: int;
+  /**
+   * This area replaces any gravity/damping calculated so far (in {@link priority} order), but keeps calculating the rest of the areas.
+   */
+  static readonly SPACE_OVERRIDE_REPLACE_COMBINE: int;
+}