typescript-to-gdscript 0.1.1 → 0.1.3

package/typings/classes/AnimationNodeBlendSpace2D.d.ts

@@ -11,6 +11,10 @@ declare class AnimationNodeBlendSpace2D extends AnimationRootNode {
   auto_triangles: boolean;
   /** Controls the interpolation between animations. */
   blend_mode: int;
+  /**
+   * The cycle length in seconds used by {@link SYNC_MODE_CYCLIC_CONSTANT}. All animations are time-scaled so they complete one full cycle in this duration. Must be greater than `0` for cyclic sync to take effect.
+   */
+  cyclic_length: float;
   /** The blend space's X and Y axes' upper limit for the points' position. See {@link add_blend_point}. */
   max_space: Vector2;
   /** The blend space's X and Y axes' lower limit for the points' position. See {@link add_blend_point}. */
@@ -18,10 +22,11 @@ declare class AnimationNodeBlendSpace2D extends AnimationRootNode {
   /** Position increment to snap to when moving a point. */
   snap: Vector2;
   /**
-   * If `false`, the blended animations' frame are stopped when the blend value is `0`.
-   * If `true`, forcing the blended animations to advance frame.
+   * If `true`, sync mode is enabled (equivalent to {@link SYNC_MODE_INDEPENDENT}). This property is kept for backward compatibility.
    */
   sync: boolean;
+  /** Controls how animations are synced when blended. See {@link SyncMode} for available options. */
+  sync_mode: int;
   /** Name of the blend space's X axis. */
   x_label: string;
   /** Name of the blend space's Y axis. */
@@ -30,6 +35,8 @@ declare class AnimationNodeBlendSpace2D extends AnimationRootNode {
   get_auto_triangles(): boolean;
   set_blend_mode(value: int): void;
   get_blend_mode(): int;
+  set_cyclic_length(value: float): void;
+  get_cyclic_length(): float;
   set_max_space(value: Vector2 | Vector2i): void;
   get_max_space(): Vector2;
   set_min_space(value: Vector2 | Vector2i): void;
@@ -38,21 +45,30 @@ declare class AnimationNodeBlendSpace2D extends AnimationRootNode {
   get_snap(): Vector2;
   set_use_sync(value: boolean): void;
   is_using_sync(): boolean;
+  set_sync_mode(value: int): void;
+  get_sync_mode(): int;
   set_x_label(value: string | NodePath): void;
   get_x_label(): string;
   set_y_label(value: string | NodePath): void;
   get_y_label(): string;
 
   /**
-   * Adds a new point that represents a `node` at the position set by `pos`. You can insert it at a specific index using the `at_index` argument. If you use the default value for `at_index`, the point is inserted at the end of the blend points array.
+   * Adds a new point with `name` that represents a `node` at the position set by `pos`. You can insert it at a specific index using the `at_index` argument. If you use the default value for `at_index`, the point is inserted at the end of the blend points array.
+   * **Note:** If no name is provided, safe index is used as reference. In the future, empty names will be deprecated, so explicitly passing a name is recommended.
    */
-  add_blend_point(node: AnimationRootNode, pos: Vector2 | Vector2i, at_index?: int): void;
+  add_blend_point(node: AnimationRootNode, pos: Vector2 | Vector2i, at_index?: int, name?: string): void;
   /**
    * Creates a new triangle using three points `x`, `y`, and `z`. Triangles can overlap. You can insert the triangle at a specific index using the `at_index` argument. If you use the default value for `at_index`, the point is inserted at the end of the blend points array.
    */
   add_triangle(x: int, y: int, z: int, at_index?: int): void;
+  /**
+   * Returns the index of the blend point with the given `name`. Returns `-1` if no blend point with that name is found.
+   */
+  find_blend_point_by_name(name: string): int;
   /** Returns the number of points in the blend space. */
   get_blend_point_count(): int;
+  /** Returns the name of the blend point at index `point`. */
+  get_blend_point_name(point: int): string;
   /** Returns the {@link AnimationRootNode} referenced by the point at index `point`. */
   get_blend_point_node(point: int): AnimationRootNode | null;
   /** Returns the position of the point at index `point`. */
@@ -65,6 +81,14 @@ declare class AnimationNodeBlendSpace2D extends AnimationRootNode {
   remove_blend_point(point: int): void;
   /** Removes the triangle at index `triangle` from the blend space. */
   remove_triangle(triangle: int): void;
+  /**
+   * Swaps the blend points at indices `from_index` and `to_index`, exchanging their positions and properties.
+   */
+  reorder_blend_point(from_index: int, to_index: int): void;
+  /**
+   * Sets the name of the blend point at index `point`. If the name conflicts with an existing point, a unique name will be generated automatically.
+   */
+  set_blend_point_name(point: int, name: string): void;
   /** Changes the {@link AnimationNode} referenced by the point at index `point`. */
   set_blend_point_node(point: int, node: AnimationRootNode): void;
   /** Updates the position of the point at index `point` in the blend space. */
@@ -86,4 +110,21 @@ declare class AnimationNodeBlendSpace2D extends AnimationRootNode {
    * Similar to {@link BLEND_MODE_DISCRETE}, but starts the new animation at the last animation's playback position.
    */
   static readonly BLEND_MODE_DISCRETE_CARRY: int;
+  // enum SyncMode
+  /** Inactive animations are frozen and do not advance. */
+  static readonly SYNC_MODE_NONE: int;
+  /**
+   * Inactive animations advance with a weight of `0`. This is equivalent to the previous `sync = true` behavior.
+   */
+  static readonly SYNC_MODE_INDEPENDENT: int;
+  /**
+   * All animations are time-scaled so they stay in sync, with the cycle length dynamically computed from active blend weights. This is self-normalizing: a solo animation plays at normal speed.
+   * **Note:** If you apply {@link AnimationNodeTimeSeek} to the result when handling animations of different lengths, synchronization will be broken. In such cases, it is recommended to use {@link AnimationNodeAnimation.use_custom_timeline} to align the animation lengths.
+   */
+  static readonly SYNC_MODE_CYCLIC_MUTABLE: int;
+  /**
+   * All animations are time-scaled so they complete one cycle in {@link cyclic_length} seconds, keeping them in sync regardless of their individual lengths.
+   * **Note:** If you apply {@link AnimationNodeTimeSeek} to the result when handling animations of different lengths, synchronization will be broken. In such cases, it is recommended to use {@link AnimationNodeAnimation.use_custom_timeline} to align the animation lengths.
+   */
+  static readonly SYNC_MODE_CYCLIC_CONSTANT: int;
 }

package/typings/classes/Area3D.d.ts

@@ -126,8 +126,9 @@ declare class Area3D extends CollisionObject3D {
    */
   get_overlapping_areas(): Array<Area3D>;
   /**
-   * Returns a list of intersecting {@link PhysicsBody3D}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.
+   * 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>;
   /**
@@ -136,8 +137,9 @@ declare class Area3D extends CollisionObject3D {
    */
   has_overlapping_areas(): boolean;
   /**
-   * Returns `true` if intersecting any {@link PhysicsBody3D}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.
+   * 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;
   /**
@@ -147,8 +149,9 @@ declare class Area3D extends CollisionObject3D {
   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.
-   * The `body` argument can either be a {@link PhysicsBody3D} 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:** Godot Physics does not support reporting overlaps with {@link SoftBody3D}, so will return `false` in such cases.
    */
   overlaps_body(body: Node): boolean;
 
@@ -168,22 +171,26 @@ declare class Area3D extends CollisionObject3D {
    */
   area_shape_exited: Signal<[RID, Area3D, int, int]>;
   /**
-   * Emitted when the received `body` enters this area. `body` can be a {@link PhysicsBody3D} or a {@link GridMap}. {@link GridMap}s are detected if their {@link MeshLibrary} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * 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} or a {@link GridMap}. {@link GridMap}s are detected if their {@link MeshLibrary} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * 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} or a {@link GridMap}. {@link GridMap}s are detected if their {@link MeshLibrary} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * 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} or a {@link GridMap}. {@link GridMap}s are detected if their {@link MeshLibrary} has collision shapes configured. Requires {@link monitoring} to be set to `true`.
+   * 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]>;
 

package/typings/classes/AreaLight3D.d.ts

@@ -0,0 +1,37 @@
+// AUTO-GENERATED from Godot class documentation.
+// Manual overrides applied from typings-overrides/*.d.ts
+
+/** An area light, such as a neon light tube or a screen. */
+declare class AreaLight3D extends Light3D {
+  /**
+   * Controls the distance attenuation function for this area light.
+   * A value of `0.0` will maintain a constant brightness through most of the range, but will smoothly attenuate the light at the edge of the range. Use a value of `2.0` for physically accurate lights as it results in the proper inverse square attenuation.
+   * **Note:** Setting attenuation to `2.0` or higher may result in distant objects receiving minimal light, even when within range. For example, with a range of `4096`, an object at `100` units is attenuated by a factor of `0.0001`. With a default brightness of `1`, the light would not be visible at that distance.
+   * **Note:** Using negative values or values higher than `10.0` may lead to unexpected results.
+   */
+  area_attenuation: float;
+  /**
+   * Defines whether the energy is normalized (divided) by the surface area of the light. If set to `true`, changing the size does not affect the total energy output, and does not dramatically alter the brightness of the scene.
+   */
+  area_normalize_energy: boolean;
+  /**
+   * The range of the area in meters. This determines the maximum distance from any point on the area at which the area can still emit light.
+   */
+  area_range: float;
+  /** The extents (width and height) of the area in meters. */
+  area_size: Vector2;
+  /**
+   * An optional texture to use as a light source. Changing the texture at runtime might impact performance, as it needs to be drawn to the area light atlas with filtered mipmaps.
+   * If no texture is assigned, the area light emits uniform light across its surface.
+   * **Note:** Area light textures are only supported in the Forward+ and Mobile rendering methods, not Compatibility. To reduce the performance impact of switching textures at runtime, make sure each dimension of an area texture is either a multiple of 128 pixels, or a power of two. This removes the need for a scaling pass, which slows down texture changes. The textures don't necessarily have to be square to be optimal. Examples of optimal texture sizes include 32x64, 128x128, and 256x384.
+   */
+  area_texture: Texture2D | null;
+  light_size: float;
+  shadow_normal_bias: float;
+  set_area_normalize_energy(value: boolean): void;
+  is_area_normalizing_energy(): boolean;
+  set_area_size(value: Vector2 | Vector2i): void;
+  get_area_size(): Vector2;
+  set_area_texture(value: Texture2D | null): void;
+  get_area_texture(): Texture2D | null;
+}

package/typings/classes/ArrayMesh.d.ts

@@ -73,7 +73,22 @@ declare class ArrayMesh extends Mesh {
   surface_remove(surf_idx: int): void;
   /** Sets a name for a given surface. */
   surface_set_name(surf_idx: int, name: string | NodePath): void;
+  /**
+   * Updates the attribute buffer of this mesh's surface with the given `data`. The expected data per attribute is 12 or 8 bytes (4 bytes per float, 2 floats per {@link Vector2}, and 3 floats per {@link Vector3}) depending on if the mesh is using {@link Vector3} or {@link Vector2} vertices. This value can be determined with {@link RenderingServer.mesh_surface_get_format_attribute_stride}.
+   * The starting point of the updates can be changed with `offset`. The value of `offset` should be a multiple of 12 bytes in most cases to align to each attribute.
+   * A {@link PackedVector3Array} of attribute locations can be converted into a {@link PackedByteArray} using {@link PackedVector3Array.to_byte_array} for use in `data`.
+   */
   surface_update_attribute_region(surf_idx: int, offset: int, data: PackedByteArray | Array<unknown>): void;
+  /**
+   * Updates the skin buffer of this mesh's surface with the given `data`. The expected data per skin is 12 or 8 bytes (4 bytes per float, 2 floats per {@link Vector2}, and 3 floats per {@link Vector3}) depending on if the mesh is using {@link Vector3} or {@link Vector2} vertices. This value can be determined with {@link RenderingServer.mesh_surface_get_format_skin_stride}.
+   * The starting point of the updates can be changed with `offset`. The value of `offset` should be a multiple of 12 bytes in most cases to align to each skin.
+   * A {@link PackedVector3Array} of skin locations can be converted into a {@link PackedByteArray} using {@link PackedVector3Array.to_byte_array} for use in `data`.
+   */
   surface_update_skin_region(surf_idx: int, offset: int, data: PackedByteArray | Array<unknown>): void;
+  /**
+   * Updates the vertex buffer of this mesh's surface with the given `data`. The expected data per vertex is 12 or 8 bytes (4 bytes per float, 2 floats per {@link Vector2}, and 3 floats per {@link Vector3}) depending on if the mesh is using {@link Vector3} or {@link Vector2} vertices. This value can be determined with {@link RenderingServer.mesh_surface_get_format_vertex_stride}.
+   * The starting point of the updates can be changed with `offset`. The value of `offset` should be a multiple of 12 bytes in most cases to align to each vertex.
+   * A {@link PackedVector3Array} of vertex locations can be converted into a {@link PackedByteArray} using {@link PackedVector3Array.to_byte_array} for use in `data`.
+   */
   surface_update_vertex_region(surf_idx: int, offset: int, data: PackedByteArray | Array<unknown>): void;
 }

package/typings/classes/AudioEffectAmplify.d.ts

@@ -1,10 +1,10 @@
 // AUTO-GENERATED from Godot class documentation.
 // Manual overrides applied from typings-overrides/*.d.ts
 
-/** Adds an amplifying audio effect to an audio bus. */
+/** Adds a volume manipulation audio effect to an audio bus. */
 declare class AudioEffectAmplify extends AudioEffect {
   /**
-   * Amount of amplification in decibels. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.
+   * Amount of amplification in dB. Positive values make the sound louder, negative values make it quieter. Value can range from -80 to 24.
    */
   volume_db: float;
   /**

package/typings/classes/AudioEffectBandLimitFilter.d.ts

@@ -1,6 +1,6 @@
 // AUTO-GENERATED from Godot class documentation.
 // Manual overrides applied from typings-overrides/*.d.ts
 
-/** Adds a band limit filter to the audio bus. */
+/** Adds a band-limit filter to an audio bus. */
 declare class AudioEffectBandLimitFilter extends AudioEffectFilter {
 }

package/typings/classes/AudioEffectBandPassFilter.d.ts

@@ -1,6 +1,6 @@
 // AUTO-GENERATED from Godot class documentation.
 // Manual overrides applied from typings-overrides/*.d.ts
 
-/** Adds a band pass filter to the audio bus. */
+/** Adds a band-pass filter to an audio bus. */
 declare class AudioEffectBandPassFilter extends AudioEffectFilter {
 }

package/typings/classes/AudioEffectCapture.d.ts

@@ -1,16 +1,17 @@
 // AUTO-GENERATED from Godot class documentation.
 // Manual overrides applied from typings-overrides/*.d.ts
 
-/** Captures audio from an audio bus in real-time. */
+/** Exposes audio samples from an audio bus in real-time, such that it can be accessed as data. */
 declare class AudioEffectCapture extends AudioEffect {
   /**
-   * Length of the internal ring buffer, in seconds. Setting the buffer length will have no effect if already initialized.
+   * Length of the internal ring buffer, in seconds. Higher values keep data around for longer, but require more memory. Value can range from 0.01 to 10.
+   * **Note:** Setting the buffer length will have no effect if already initialized.
    */
   buffer_length: float;
   set_buffer_length(value: float): void;
   get_buffer_length(): float;
 
-  /** Returns `true` if at least `frames` audio frames are available to read in the internal ring buffer. */
+  /** Returns `true` if at least `frames` samples are available to read in the internal ring buffer. */
   can_get_buffer(frames: int): boolean;
   /**
    * Clears the internal ring buffer.
@@ -18,17 +19,17 @@ declare class AudioEffectCapture extends AudioEffect {
    */
   clear_buffer(): void;
   /**
-   * Gets the next `frames` audio samples from the internal ring buffer.
-   * Returns a {@link PackedVector2Array} containing exactly `frames` audio samples if available, or an empty {@link PackedVector2Array} if insufficient data was available.
+   * Gets the next `frames` samples from the internal ring buffer.
+   * Returns a {@link PackedVector2Array} containing exactly `frames` samples if available, or an empty {@link PackedVector2Array} if insufficient data was available.
    * The samples are signed floating-point PCM between `-1` and `1`. You will have to scale them if you want to use them as 8 or 16-bit integer samples. (`v = 0x7fff * samples[0].x`)
    */
   get_buffer(frames: int): PackedVector2Array;
-  /** Returns the total size of the internal ring buffer in frames. */
+  /** Returns the total size of the internal ring buffer in number of samples. */
   get_buffer_length_frames(): int;
-  /** Returns the number of audio frames discarded from the audio bus due to full buffer. */
+  /** Returns the number of samples discarded from the audio bus due to full buffer. */
   get_discarded_frames(): int;
-  /** Returns the number of frames available to read using {@link get_buffer}. */
+  /** Returns the number of samples available to read using {@link get_buffer}. */
   get_frames_available(): int;
-  /** Returns the number of audio frames inserted from the audio bus. */
+  /** Returns the number of samples inserted from the audio bus. */
   get_pushed_frames(): int;
 }

package/typings/classes/AudioEffectChorus.d.ts

@@ -1,61 +1,64 @@
 // AUTO-GENERATED from Godot class documentation.
 // Manual overrides applied from typings-overrides/*.d.ts
 
-/** Adds a chorus audio effect. */
+/**
+ * Adds a chorus audio effect to an audio bus.
+ * Gives the impression of multiple audio sources.
+ */
 declare class AudioEffectChorus extends AudioEffect {
-  /** The effect's raw signal. */
+  /** The volume ratio of the original audio. Value can range from 0 to 1. */
   dry: float;
-  /** The voice's cutoff frequency. */
+  /** The frequency threshold of the voice's low-pass filter in Hz. */
   'voice/1/cutoff_hz': float;
-  /** The voice's signal delay. */
+  /** The delay of the voice in milliseconds, compared to the original audio. */
   'voice/1/delay_ms': float;
-  /** The voice filter's depth. */
+  /** The depth of the voice's low-frequency oscillator in milliseconds. */
   'voice/1/depth_ms': float;
-  /** The voice's volume. */
+  /** The gain of the voice in dB. */
   'voice/1/level_db': float;
-  /** The voice's pan level. */
+  /** The pan position of the voice. */
   'voice/1/pan': float;
-  /** The voice's filter rate. */
+  /** The rate of the voice's low-frequency oscillator in Hz. */
   'voice/1/rate_hz': float;
-  /** The voice's cutoff frequency. */
+  /** The frequency threshold of the voice's low-pass filter in Hz. */
   'voice/2/cutoff_hz': float;
-  /** The voice's signal delay. */
+  /** The delay of the voice in milliseconds, compared to the original audio. */
   'voice/2/delay_ms': float;
-  /** The voice filter's depth. */
+  /** The depth of the voice's low-frequency oscillator in milliseconds. */
   'voice/2/depth_ms': float;
-  /** The voice's volume. */
+  /** The gain of the voice in dB. */
   'voice/2/level_db': float;
-  /** The voice's pan level. */
+  /** The pan position of the voice. */
   'voice/2/pan': float;
-  /** The voice's filter rate. */
+  /** The rate of the voice's low-frequency oscillator in Hz. */
   'voice/2/rate_hz': float;
-  /** The voice's cutoff frequency. */
+  /** The frequency threshold of the voice's low-pass filter in Hz. */
   'voice/3/cutoff_hz': float;
-  /** The voice's signal delay. */
+  /** The delay of the voice in milliseconds, compared to the original audio. */
   'voice/3/delay_ms': float;
-  /** The voice filter's depth. */
+  /** The depth of the voice's low-frequency oscillator in milliseconds. */
   'voice/3/depth_ms': float;
-  /** The voice's volume. */
+  /** The gain of the voice in dB. */
   'voice/3/level_db': float;
-  /** The voice's pan level. */
+  /** The pan position of the voice. */
   'voice/3/pan': float;
-  /** The voice's filter rate. */
+  /** The rate of the voice's low-frequency oscillator in Hz. */
   'voice/3/rate_hz': float;
-  /** The voice's cutoff frequency. */
+  /** The frequency threshold of the voice's low-pass filter in Hz. */
   'voice/4/cutoff_hz': float;
-  /** The voice's signal delay. */
+  /** The delay of the voice in milliseconds, compared to the original audio. */
   'voice/4/delay_ms': float;
-  /** The voice filter's depth. */
+  /** The depth of the voice's low-frequency oscillator in milliseconds. */
   'voice/4/depth_ms': float;
-  /** The voice's volume. */
+  /** The gain of the voice in dB. */
   'voice/4/level_db': float;
-  /** The voice's pan level. */
+  /** The pan position of the voice. */
   'voice/4/pan': float;
-  /** The voice's filter rate. */
+  /** The rate of the voice's low-frequency oscillator in Hz. */
   'voice/4/rate_hz': float;
-  /** The number of voices in the effect. */
+  /** The number of voices in the effect. Value can range from 1 to 4. */
   voice_count: int;
-  /** The effect's processed signal. */
+  /** The volume ratio of all voices. Value can range from 0 to 1. */
   wet: float;
   set_dry(value: float): void;
   get_dry(): float;
@@ -64,16 +67,42 @@ declare class AudioEffectChorus extends AudioEffect {
   set_wet(value: float): void;
   get_wet(): float;
 
+  /**
+   * Returns the frequency threshold of a given `voice_idx`'s low-pass filter in Hz. Frequencies above this value are removed from the voice.
+   */
   get_voice_cutoff_hz(voice_idx: int): float;
+  /** Returns the delay of a given `voice_idx` in milliseconds, compared to the original audio. */
   get_voice_delay_ms(voice_idx: int): float;
+  /** Returns the depth of a given `voice_idx`'s low-frequency oscillator in milliseconds. */
   get_voice_depth_ms(voice_idx: int): float;
+  /** Returns the gain of a given `voice_idx` in dB. */
   get_voice_level_db(voice_idx: int): float;
+  /**
+   * Returns the pan position of a given `voice_idx`. Negative values mean the left channel, positive mean the right.
+   */
   get_voice_pan(voice_idx: int): float;
+  /** Returns the rate of a given `voice_idx`'s low-frequency oscillator in Hz. */
   get_voice_rate_hz(voice_idx: int): float;
+  /**
+   * Sets the frequency threshold of a given `voice_idx`'s low-pass filter in Hz. Frequencies above `cutoff_hz` are removed from `voice_idx`. Value can range from 1 to 20500.
+   */
   set_voice_cutoff_hz(voice_idx: int, cutoff_hz: float): void;
+  /**
+   * Sets the delay of a given `voice_idx` in milliseconds, compared to the original audio. Value can range from 0 to 50.
+   */
   set_voice_delay_ms(voice_idx: int, delay_ms: float): void;
+  /**
+   * Sets the depth of a given `voice_idx`'s low-frequency oscillator in milliseconds. Value can range from 0 to 20.
+   */
   set_voice_depth_ms(voice_idx: int, depth_ms: float): void;
+  /** Sets the gain of a given `voice_idx` in dB. Value can range from -60 to 24. */
   set_voice_level_db(voice_idx: int, level_db: float): void;
+  /**
+   * Sets the pan position of a given `voice_idx`. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.
+   */
   set_voice_pan(voice_idx: int, pan: float): void;
+  /**
+   * Sets the rate of a given `voice_idx`'s low-frequency oscillator in Hz. Value can range from 0.1 to 20.
+   */
   set_voice_rate_hz(voice_idx: int, rate_hz: float): void;
 }

package/typings/classes/AudioEffectCompressor.d.ts

@@ -2,31 +2,33 @@
 // Manual overrides applied from typings-overrides/*.d.ts
 
 /**
- * Adds a compressor audio effect to an audio bus.
- * Reduces sounds that exceed a certain threshold level, smooths out the dynamics and increases the overall volume.
+ * Adds a downward compressor audio effect to an audio bus.
+ * Allows control of the dynamic range via a volume threshold and timing controls.
  */
 declare class AudioEffectCompressor extends AudioEffect {
   /**
-   * Compressor's reaction time when the signal exceeds the threshold, in microseconds. Value can range from 20 to 2000.
+   * Compressor's reaction time when the audio exceeds the volume threshold level, in microseconds. Value can range from 20 to 2000.
    */
   attack_us: float;
-  /** Gain applied to the output signal. */
+  /** Gain of the audio signal, in dB. Value can range from -20 to 20. */
   gain: float;
   /**
-   * Balance between original signal and effect signal. Value can range from 0 (totally dry) to 1 (totally wet).
+   * Balance between the original audio and the compressed audio. Value can range from 0 (totally dry) to 1 (totally wet).
    */
   mix: float;
   /**
-   * Amount of compression applied to the audio once it passes the threshold level. The higher the ratio, the more the loud parts of the audio will be compressed. Value can range from 1 to 48.
+   * Amount of compression applied to the audio once it passes the volume threshold level. The higher the ratio, the stronger the compression applied to audio signals that pass the volume threshold level. Value can range from 1 to 48.
    */
   ratio: float;
   /**
-   * Compressor's delay time to stop reducing the signal after the signal level falls below the threshold, in milliseconds. Value can range from 20 to 2000.
+   * Compressor's delay time to stop decreasing the volume after the it falls below the volume threshold level, in milliseconds. Value can range from 20 to 2000.
    */
   release_ms: float;
-  /** Reduce the sound level using another audio bus for threshold detection. */
+  /** Audio bus to use for the volume threshold detection. */
   sidechain: string;
-  /** The level above which compression is applied to the audio. Value can range from -60 to 0. */
+  /**
+   * The volume level above which compression is applied to the audio, in dB. Value can range from -60 to 0.
+   */
   threshold: float;
   set_attack_us(value: float): void;
   get_attack_us(): float;

package/typings/classes/AudioEffectDelay.d.ts

@@ -2,39 +2,45 @@
 // Manual overrides applied from typings-overrides/*.d.ts
 
 /**
- * Adds a delay audio effect to an audio bus. Plays input signal back after a period of time.
- * Two tap delay and feedback options.
+ * Adds a delay audio effect to an audio bus.
+ * Emulates an echo by playing the input audio back after a period of time.
  */
 declare class AudioEffectDelay extends AudioEffect {
-  /**
-   * Output percent of original sound. At 0, only delayed sounds are output. Value can range from 0 to 1.
-   */
+  /** The volume ratio of the original audio. Value can range from 0 to 1. */
   dry: float;
-  /** If `true`, feedback is enabled. */
+  /** If `true`, feedback is enabled, repeating taps after they are played. */
   feedback_active: boolean;
-  /** Feedback delay time in milliseconds. */
+  /** Feedback delay time in milliseconds. Value can range from 0 to 1500. */
   feedback_delay_ms: float;
-  /** Sound level for feedback. */
+  /** Gain for feedback, in dB. Value can range from -60 to 0. */
   feedback_level_db: float;
   /**
-   * Low-pass filter for feedback, in Hz. Frequencies below this value are filtered out of the source signal.
+   * Low-pass filter for feedback, in Hz. Frequencies above this value are filtered out. Value can range from 1 to 16000.
    */
   feedback_lowpass: float;
   /** If `true`, the first tap will be enabled. */
   tap1_active: boolean;
-  /** First tap delay time in milliseconds. */
+  /**
+   * First tap delay time in milliseconds, compared to the original audio. Value can range from 0 to 1500.
+   */
   tap1_delay_ms: float;
-  /** Sound level for the first tap. */
+  /** Gain for the first tap, in dB. Value can range from -60 to 0. */
   tap1_level_db: float;
-  /** Pan position for the first tap. Value can range from -1 (fully left) to 1 (fully right). */
+  /**
+   * Pan position for the first tap. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.
+   */
   tap1_pan: float;
   /** If `true`, the second tap will be enabled. */
   tap2_active: boolean;
-  /** Second tap delay time in milliseconds. */
+  /**
+   * Second tap delay time in milliseconds, compared to the original audio. Value can range from 0 to 1500.
+   */
   tap2_delay_ms: float;
-  /** Sound level for the second tap. */
+  /** Gain for the second tap, in dB. Value can range from -60 to 0. */
   tap2_level_db: float;
-  /** Pan position for the second tap. Value can range from -1 (fully left) to 1 (fully right). */
+  /**
+   * Pan position for the second tap. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.
+   */
   tap2_pan: float;
   set_dry(value: float): void;
   get_dry(): float;

package/typings/classes/AudioEffectDistortion.d.ts

@@ -2,21 +2,23 @@
 // Manual overrides applied from typings-overrides/*.d.ts
 
 /**
- * Adds a distortion audio effect to an Audio bus.
- * Modifies the sound to make it distorted.
+ * Adds a distortion audio effect to an audio bus.
+ * Remaps audio samples using a nonlinear function to achieve a distorted sound.
  */
 declare class AudioEffectDistortion extends AudioEffect {
-  /** Distortion power. Value can range from 0 to 1. */
+  /**
+   * Distortion intensity. Controls how much of the input audio is affected by the distortion curve by moving from a linear function to a nonlinear one. Value can range from 0 to 1.
+   */
   drive: float;
   /**
    * High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.
    */
   keep_hf_hz: float;
-  /** Distortion type. */
+  /** Distortion type. Changes the nonlinear function used to distort the waveform. See {@link Mode}. */
   mode: int;
-  /** Increases or decreases the volume after the effect, in decibels. Value can range from -80 to 24. */
+  /** Gain after the effect, in dB. Value can range from -80 to 24. */
   post_gain: float;
-  /** Increases or decreases the volume before the effect, in decibels. Value can range from -60 to 60. */
+  /** Gain before the effect, in dB. Value can range from -60 to 60. */
   pre_gain: float;
   set_drive(value: float): void;
   get_drive(): float;
@@ -30,17 +32,24 @@ declare class AudioEffectDistortion extends AudioEffect {
   get_pre_gain(): float;
 
   // enum Mode
-  /** Digital distortion effect which cuts off peaks at the top and bottom of the waveform. */
+  /**
+   * Flattens the waveform at 0 dB in a sharp manner. {@link drive} increases amplitude of samples exponentially. This mode functions as a hard clipper if {@link drive} is set to 0, and is the only mode that clips audio signals at 0 dB.
+   */
   static readonly MODE_CLIP: int;
+  /**
+   * Flattens the waveform in a smooth manner, following an arctangent curve. The audio decreases in volume, before flattening peaks to `PI * 4.0` (linear value), if it was normalized beforehand.
+   */
   static readonly MODE_ATAN: int;
   /**
-   * Low-resolution digital distortion effect (bit depth reduction). You can use it to emulate the sound of early digital audio devices.
+   * Decreases audio bit depth to achieve a low-resolution audio signal, going from 16-bit to 2-bit. Can be used to emulate the sound of early digital audio devices.
    */
   static readonly MODE_LOFI: int;
   /**
-   * Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. The {@link drive} property has no effect in this mode.
+   * Emulates the warm distortion produced by a field effect transistor, which is commonly used in solid-state musical instrument amplifiers. {@link drive} has no effect in this mode.
    */
   static readonly MODE_OVERDRIVE: int;
-  /** Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound. */
+  /**
+   * Flattens the waveform in a smooth manner, until it reaches a sharp peak at `drive = 1`, following a generic absolute sigmoid function.
+   */
   static readonly MODE_WAVESHAPE: int;
 }

package/typings/classes/AudioEffectEQ.d.ts

@@ -2,8 +2,8 @@
 // Manual overrides applied from typings-overrides/*.d.ts
 
 /**
- * Base class for audio equalizers. Gives you control over frequencies.
- * Use it to create a custom equalizer if {@link AudioEffectEQ6}, {@link AudioEffectEQ10} or {@link AudioEffectEQ21} don't fit your needs.
+ * Base class for audio equalizers (EQ). Gives you control over frequencies.
+ * Use it to create a custom equalizer if {@link AudioEffectEQ6}, {@link AudioEffectEQ10}, or {@link AudioEffectEQ21} don't fit your needs.
  */
 declare class AudioEffectEQ extends AudioEffect {
   /** Returns the number of bands of the equalizer. */