typescript-to-gdscript 0.1.0 → 0.1.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (158) hide show
  1. package/README.md +229 -103
  2. package/dist/converter/common/index.d.ts +17 -1
  3. package/dist/converter/common/index.d.ts.map +1 -1
  4. package/dist/converter/common/index.js +69 -19
  5. package/dist/converter/common/index.js.map +1 -1
  6. package/dist/converter/ts-to-gd/class-members.d.ts.map +1 -1
  7. package/dist/converter/ts-to-gd/class-members.js +5 -5
  8. package/dist/converter/ts-to-gd/class-members.js.map +1 -1
  9. package/dist/converter/ts-to-gd/expressions.d.ts.map +1 -1
  10. package/dist/converter/ts-to-gd/expressions.js +1 -1
  11. package/dist/converter/ts-to-gd/expressions.js.map +1 -1
  12. package/dist/converter/ts-to-gd/file-scope.d.ts.map +1 -1
  13. package/dist/converter/ts-to-gd/file-scope.js +1 -1
  14. package/dist/converter/ts-to-gd/file-scope.js.map +1 -1
  15. package/dist/converter/ts-to-gd/gd-getset.js +2 -2
  16. package/dist/converter/ts-to-gd/gd-getset.js.map +1 -1
  17. package/dist/converter/ts-to-gd/index.d.ts.map +1 -1
  18. package/dist/converter/ts-to-gd/index.js +1 -0
  19. package/dist/converter/ts-to-gd/index.js.map +1 -1
  20. package/dist/converter/ts-to-gd/parameters.d.ts.map +1 -1
  21. package/dist/converter/ts-to-gd/parameters.js +2 -2
  22. package/dist/converter/ts-to-gd/parameters.js.map +1 -1
  23. package/dist/converter/ts-to-gd/statements.d.ts.map +1 -1
  24. package/dist/converter/ts-to-gd/statements.js +1 -1
  25. package/dist/converter/ts-to-gd/statements.js.map +1 -1
  26. package/dist/typings/override-system.d.ts.map +1 -1
  27. package/dist/typings/override-system.js +6 -0
  28. package/dist/typings/override-system.js.map +1 -1
  29. package/package.json +6 -1
  30. package/typings/classes/AnimationNodeBlendSpace1D.d.ts +2 -17
  31. package/typings/classes/AnimationNodeBlendSpace2D.d.ts +2 -17
  32. package/typings/classes/Area3D.d.ts +7 -14
  33. package/typings/classes/ArrayMesh.d.ts +0 -15
  34. package/typings/classes/AudioEffectAmplify.d.ts +2 -2
  35. package/typings/classes/AudioEffectBandLimitFilter.d.ts +1 -1
  36. package/typings/classes/AudioEffectBandPassFilter.d.ts +1 -1
  37. package/typings/classes/AudioEffectCapture.d.ts +9 -10
  38. package/typings/classes/AudioEffectChorus.d.ts +28 -57
  39. package/typings/classes/AudioEffectCompressor.d.ts +9 -11
  40. package/typings/classes/AudioEffectDelay.d.ts +15 -21
  41. package/typings/classes/AudioEffectDistortion.d.ts +10 -19
  42. package/typings/classes/AudioEffectEQ.d.ts +2 -2
  43. package/typings/classes/AudioEffectEQ10.d.ts +2 -2
  44. package/typings/classes/AudioEffectEQ21.d.ts +2 -2
  45. package/typings/classes/AudioEffectEQ6.d.ts +2 -2
  46. package/typings/classes/AudioEffectFilter.d.ts +9 -25
  47. package/typings/classes/AudioEffectHardLimiter.d.ts +5 -8
  48. package/typings/classes/AudioEffectHighPassFilter.d.ts +1 -1
  49. package/typings/classes/AudioEffectHighShelfFilter.d.ts +1 -1
  50. package/typings/classes/AudioEffectLimiter.d.ts +4 -9
  51. package/typings/classes/AudioEffectLowPassFilter.d.ts +1 -1
  52. package/typings/classes/AudioEffectLowShelfFilter.d.ts +1 -1
  53. package/typings/classes/AudioEffectNotchFilter.d.ts +1 -1
  54. package/typings/classes/AudioEffectPanner.d.ts +2 -7
  55. package/typings/classes/AudioEffectPhaser.d.ts +7 -9
  56. package/typings/classes/AudioEffectPitchShift.d.ts +3 -3
  57. package/typings/classes/AudioEffectReverb.d.ts +8 -17
  58. package/typings/classes/AudioEffectSpectrumAnalyzer.d.ts +5 -4
  59. package/typings/classes/AudioEffectStereoEnhance.d.ts +4 -7
  60. package/typings/classes/AudioServer.d.ts +2 -2
  61. package/typings/classes/AudioStreamPlaybackResampled.d.ts +0 -8
  62. package/typings/classes/BaseButton.d.ts +1 -1
  63. package/typings/classes/Basis.d.ts +0 -4
  64. package/typings/classes/Camera3D.d.ts +1 -1
  65. package/typings/classes/CameraAttributes.d.ts +0 -1
  66. package/typings/classes/CameraFeed.d.ts +0 -4
  67. package/typings/classes/CanvasItem.d.ts +1 -1
  68. package/typings/classes/CodeEdit.d.ts +0 -4
  69. package/typings/classes/CollisionObject2D.d.ts +0 -6
  70. package/typings/classes/CollisionPolygon2D.d.ts +0 -5
  71. package/typings/classes/CollisionShape2D.d.ts +0 -5
  72. package/typings/classes/Container.d.ts +0 -6
  73. package/typings/classes/Control.d.ts +0 -59
  74. package/typings/classes/DPITexture.d.ts +0 -14
  75. package/typings/classes/Decal.d.ts +0 -1
  76. package/typings/classes/Dictionary.d.ts +0 -1
  77. package/typings/classes/DisplayServer.d.ts +1 -128
  78. package/typings/classes/EditorDock.d.ts +2 -8
  79. package/typings/classes/EditorExportPlugin.d.ts +0 -5
  80. package/typings/classes/EditorFileSystem.d.ts +0 -2
  81. package/typings/classes/EditorInterface.d.ts +2 -4
  82. package/typings/classes/EditorSettings.d.ts +133 -197
  83. package/typings/classes/EditorSpinSlider.d.ts +0 -6
  84. package/typings/classes/Environment.d.ts +2 -7
  85. package/typings/classes/FileAccess.d.ts +1 -1
  86. package/typings/classes/FileDialog.d.ts +1 -1
  87. package/typings/classes/FoldableContainer.d.ts +1 -1
  88. package/typings/classes/Font.d.ts +2 -2
  89. package/typings/classes/GPUParticles3D.d.ts +0 -4
  90. package/typings/classes/GeometryInstance3D.d.ts +1 -1
  91. package/typings/classes/GradientTexture2D.d.ts +0 -2
  92. package/typings/classes/Image.d.ts +0 -1
  93. package/typings/classes/ImageTexture.d.ts +2 -0
  94. package/typings/classes/ImporterMesh.d.ts +0 -6
  95. package/typings/classes/Input.d.ts +13 -148
  96. package/typings/classes/InputEvent.d.ts +0 -8
  97. package/typings/classes/InputEventGesture.d.ts +3 -2
  98. package/typings/classes/InputEventMouse.d.ts +3 -2
  99. package/typings/classes/InputEventWithModifiers.d.ts +3 -2
  100. package/typings/classes/InputMap.d.ts +0 -3
  101. package/typings/classes/ItemList.d.ts +2 -9
  102. package/typings/classes/Joint3D.d.ts +0 -1
  103. package/typings/classes/LookAtModifier3D.d.ts +1 -2
  104. package/typings/classes/MainLoop.d.ts +0 -4
  105. package/typings/classes/NativeMenu.d.ts +3 -10
  106. package/typings/classes/Node.d.ts +5 -9
  107. package/typings/classes/OS.d.ts +2 -2
  108. package/typings/classes/Object.d.ts +2 -5
  109. package/typings/classes/OptionButton.d.ts +0 -6
  110. package/typings/classes/PCKPacker.d.ts +0 -4
  111. package/typings/classes/ParticleProcessMaterial.d.ts +0 -5
  112. package/typings/classes/PhysicsDirectBodyState2D.d.ts +1 -2
  113. package/typings/classes/PhysicsDirectBodyState3D.d.ts +1 -2
  114. package/typings/classes/PhysicsServer2D.d.ts +2 -2
  115. package/typings/classes/PhysicsServer2DExtension.d.ts +1 -1
  116. package/typings/classes/PhysicsServer3D.d.ts +42 -145
  117. package/typings/classes/PopupMenu.d.ts +8 -22
  118. package/typings/classes/PopupPanel.d.ts +0 -2
  119. package/typings/classes/PortableCompressedTexture2D.d.ts +2 -0
  120. package/typings/classes/ProjectSettings.d.ts +60 -44
  121. package/typings/classes/RDShaderSPIRV.d.ts +0 -30
  122. package/typings/classes/RDShaderSource.d.ts +0 -10
  123. package/typings/classes/RenderingDevice.d.ts +0 -104
  124. package/typings/classes/RenderingServer.d.ts +11 -213
  125. package/typings/classes/Resource.d.ts +2 -2
  126. package/typings/classes/ResourceImporterDynamicFont.d.ts +1 -3
  127. package/typings/classes/ResourceImporterSVG.d.ts +0 -10
  128. package/typings/classes/ResourceImporterTexture.d.ts +2 -2
  129. package/typings/classes/SceneTree.d.ts +29 -5
  130. package/typings/classes/ScriptEditor.d.ts +0 -6
  131. package/typings/classes/Shader.d.ts +0 -2
  132. package/typings/classes/Shape3D.d.ts +0 -1
  133. package/typings/classes/SplitContainer.d.ts +0 -6
  134. package/typings/classes/String.d.ts +1 -1
  135. package/typings/classes/SubViewport.d.ts +0 -4
  136. package/typings/classes/TextEdit.d.ts +0 -3
  137. package/typings/classes/TextServer.d.ts +0 -2
  138. package/typings/classes/TextServerExtension.d.ts +0 -2
  139. package/typings/classes/Texture2D.d.ts +0 -14
  140. package/typings/classes/TextureRect.d.ts +1 -4
  141. package/typings/classes/Tree.d.ts +2 -9
  142. package/typings/classes/TreeItem.d.ts +0 -8
  143. package/typings/classes/Tween.d.ts +0 -13
  144. package/typings/classes/Viewport.d.ts +0 -10
  145. package/typings/classes/VisualShader.d.ts +0 -2
  146. package/typings/classes/VisualShaderNodeColorFunc.d.ts +2 -2
  147. package/typings/classes/VoxelGIData.d.ts +0 -10
  148. package/typings/classes/Window.d.ts +0 -23
  149. package/typings/classes/XRCamera3D.d.ts +1 -1
  150. package/typings/classes/XRServer.d.ts +0 -2
  151. package/typings/classes/_globals.d.ts +86 -45
  152. package/typings/classes/index.d.ts +0 -5
  153. package/typings/godot-class-registry.json +108 -1254
  154. package/typings/classes/AccessibilityServer.d.ts +0 -405
  155. package/typings/classes/AwaitTweener.d.ts +0 -10
  156. package/typings/classes/BlitMaterial.d.ts +0 -22
  157. package/typings/classes/DrawableTexture2D.d.ts +0 -47
  158. package/typings/classes/VirtualJoystick.d.ts +0 -94
@@ -2,23 +2,21 @@
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
4
  /**
5
- * Adds a distortion audio effect to an audio bus.
6
- * Remaps audio samples using a nonlinear function to achieve a distorted sound.
5
+ * Adds a distortion audio effect to an Audio bus.
6
+ * Modifies the sound to make it distorted.
7
7
  */
8
8
  declare class AudioEffectDistortion extends AudioEffect {
9
- /**
10
- * 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.
11
- */
9
+ /** Distortion power. Value can range from 0 to 1. */
12
10
  drive: float;
13
11
  /**
14
12
  * High-pass filter, in Hz. Frequencies higher than this value will not be affected by the distortion. Value can range from 1 to 20000.
15
13
  */
16
14
  keep_hf_hz: float;
17
- /** Distortion type. Changes the nonlinear function used to distort the waveform. See {@link Mode}. */
15
+ /** Distortion type. */
18
16
  mode: int;
19
- /** Gain after the effect, in dB. Value can range from -80 to 24. */
17
+ /** Increases or decreases the volume after the effect, in decibels. Value can range from -80 to 24. */
20
18
  post_gain: float;
21
- /** Gain before the effect, in dB. Value can range from -60 to 60. */
19
+ /** Increases or decreases the volume before the effect, in decibels. Value can range from -60 to 60. */
22
20
  pre_gain: float;
23
21
  set_drive(value: float): void;
24
22
  get_drive(): float;
@@ -32,24 +30,17 @@ declare class AudioEffectDistortion extends AudioEffect {
32
30
  get_pre_gain(): float;
33
31
 
34
32
  // enum Mode
35
- /**
36
- * 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.
37
- */
33
+ /** Digital distortion effect which cuts off peaks at the top and bottom of the waveform. */
38
34
  static readonly MODE_CLIP: int;
39
- /**
40
- * 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.
41
- */
42
35
  static readonly MODE_ATAN: int;
43
36
  /**
44
- * 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.
37
+ * Low-resolution digital distortion effect (bit depth reduction). You can use it to emulate the sound of early digital audio devices.
45
38
  */
46
39
  static readonly MODE_LOFI: int;
47
40
  /**
48
- * 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.
41
+ * 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.
49
42
  */
50
43
  static readonly MODE_OVERDRIVE: int;
51
- /**
52
- * Flattens the waveform in a smooth manner, until it reaches a sharp peak at `drive = 1`, following a generic absolute sigmoid function.
53
- */
44
+ /** Waveshaper distortions are used mainly by electronic musicians to achieve an extra-abrasive sound. */
54
45
  static readonly MODE_WAVESHAPE: int;
55
46
  }
@@ -2,8 +2,8 @@
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
4
  /**
5
- * Base class for audio equalizers (EQ). Gives you control over frequencies.
6
- * Use it to create a custom equalizer if {@link AudioEffectEQ6}, {@link AudioEffectEQ10}, or {@link AudioEffectEQ21} don't fit your needs.
5
+ * Base class for audio equalizers. Gives you control over frequencies.
6
+ * Use it to create a custom equalizer if {@link AudioEffectEQ6}, {@link AudioEffectEQ10} or {@link AudioEffectEQ21} don't fit your needs.
7
7
  */
8
8
  declare class AudioEffectEQ extends AudioEffect {
9
9
  /** Returns the number of bands of the equalizer. */
@@ -2,8 +2,8 @@
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
4
  /**
5
- * Adds a 10-band equalizer audio effect to an audio bus.
6
- * Gives you control over frequencies from 31 Hz to 16000 Hz. Each frequency can be modulated between -60/+24 dB.
5
+ * Adds a 10-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 31 Hz to 16000 Hz.
6
+ * Each frequency can be modulated between -60/+24 dB.
7
7
  */
8
8
  declare class AudioEffectEQ10 extends AudioEffectEQ {
9
9
  }
@@ -2,8 +2,8 @@
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
4
  /**
5
- * Adds a 21-band equalizer audio effect to an audio bus.
6
- * Gives you control over frequencies from 22 Hz to 22000 Hz. Each frequency can be modulated between -60/+24 dB.
5
+ * Adds a 21-band equalizer audio effect to an Audio bus. Gives you control over frequencies from 22 Hz to 22000 Hz.
6
+ * Each frequency can be modulated between -60/+24 dB.
7
7
  */
8
8
  declare class AudioEffectEQ21 extends AudioEffectEQ {
9
9
  }
@@ -2,8 +2,8 @@
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
4
  /**
5
- * Adds a 6-band equalizer audio effect to an audio bus.
6
- * Gives you control over frequencies from 32 Hz to 10000 Hz. Each frequency can be modulated between -60/+24 dB.
5
+ * Adds a 6-band equalizer audio effect to an audio bus. Gives you control over frequencies from 32 Hz to 10000 Hz.
6
+ * Each frequency can be modulated between -60/+24 dB.
7
7
  */
8
8
  declare class AudioEffectEQ6 extends AudioEffectEQ {
9
9
  }
@@ -1,25 +1,17 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /** Base class for filters. Use effects that inherit this class instead of using it directly. */
4
+ /** Adds a filter to the audio bus. */
5
5
  declare class AudioEffectFilter extends AudioEffect {
6
- /** Frequency threshold for the filter, in Hz. Value can range from 1 to 20500. */
6
+ /** Threshold frequency for the filter, in Hz. */
7
7
  cutoff_hz: float;
8
8
  /**
9
- * Steepness of the cutoff curve in dB per octave (twice the frequency above {@link cutoff_hz}, or half the frequency below {@link cutoff_hz}), also known as the "order" of the filter. Higher orders have a more aggressive cutoff.
9
+ * Steepness of the cutoff curve in dB per octave, also known as the order of the filter. Higher orders have a more aggressive cutoff.
10
10
  */
11
11
  db: int;
12
- /**
13
- * Gain of the frequencies affected by the filter. This property is only available for {@link AudioEffectLowShelfFilter} and {@link AudioEffectHighShelfFilter}. Value can range from 0 to 4.
14
- */
12
+ /** Gain amount of the frequencies after the filter. */
15
13
  gain: float;
16
- /**
17
- * Gain at or directly next to the {@link cutoff_hz} frequency threshold. Value can range from 0 to 1.
18
- * Its exact behavior depends on the selected filter type:
19
- * - For shelf filters, it accentuates or masks the order by increasing frequencies right next to the {@link cutoff_hz} frequency and decreasing frequencies on the opposite side.
20
- * - For the band-pass and notch filters, it widens or narrows the filter at the {@link cutoff_hz} frequency threshold.
21
- * - For low/high-pass filters, it increases or decreases frequencies at the {@link cutoff_hz} frequency threshold.
22
- */
14
+ /** Amount of boost in the frequency range near the cutoff frequency. */
23
15
  resonance: float;
24
16
  set_cutoff(value: float): void;
25
17
  get_cutoff(): float;
@@ -31,20 +23,12 @@ declare class AudioEffectFilter extends AudioEffect {
31
23
  get_resonance(): float;
32
24
 
33
25
  // enum FilterDB
34
- /**
35
- * Cutting off at 6 dB per octave. One octave is twice the frequency above {@link cutoff_hz}, or half the frequency below {@link cutoff_hz}.
36
- */
26
+ /** Cutting off at 6dB per octave. */
37
27
  static readonly FILTER_6DB: int;
38
- /**
39
- * Cutting off at 12 dB per octave. One octave is twice the frequency above {@link cutoff_hz}, or half the frequency below {@link cutoff_hz}.
40
- */
28
+ /** Cutting off at 12dB per octave. */
41
29
  static readonly FILTER_12DB: int;
42
- /**
43
- * Cutting off at 18 dB per octave. One octave is twice the frequency above {@link cutoff_hz}, or half the frequency below {@link cutoff_hz}.
44
- */
30
+ /** Cutting off at 18dB per octave. */
45
31
  static readonly FILTER_18DB: int;
46
- /**
47
- * Cutting off at 24 dB per octave. One octave is twice the frequency above {@link cutoff_hz}, or half the frequency below {@link cutoff_hz}.
48
- */
32
+ /** Cutting off at 24dB per octave. */
49
33
  static readonly FILTER_24DB: int;
50
34
  }
@@ -1,19 +1,16 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /**
5
- * Adds a limiter audio effect to an audio bus.
6
- * Prevents audio signals from exceeding a specified volume level.
7
- */
4
+ /** Adds a hard limiter audio effect to an Audio bus. */
8
5
  declare class AudioEffectHardLimiter extends AudioEffect {
9
6
  /**
10
- * The waveform's maximum allowed value, in dB. This value can range from -24 to 0.
11
- * The default value of -0.3 prevents potential inter-sample peaks (ISP) from crossing over 0 dB, which can cause slight distortion on some older hardware.
7
+ * The waveform's maximum allowed value, in decibels. This value can range from `-24.0` to `0.0`.
8
+ * The default value of `-0.3` prevents potential inter-sample peaks (ISP) from crossing over 0 dB, which can cause slight distortion on some older hardware.
12
9
  */
13
10
  ceiling_db: float;
14
- /** Gain before limiting, in dB. Value can range from -24 to 24. */
11
+ /** Gain to apply before limiting, in decibels. */
15
12
  pre_gain_db: float;
16
- /** Time it takes in seconds for the gain reduction to fully release. Value can range from 0.01 to 3. */
13
+ /** Time it takes in seconds for the gain reduction to fully release. */
17
14
  release: float;
18
15
  set_ceiling_db(value: float): void;
19
16
  get_ceiling_db(): float;
@@ -1,6 +1,6 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /** Adds a high-pass filter to an audio bus. */
4
+ /** Adds a high-pass filter to the audio bus. */
5
5
  declare class AudioEffectHighPassFilter extends AudioEffectFilter {
6
6
  }
@@ -1,6 +1,6 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /** Adds a high-shelf filter to an audio bus. */
4
+ /** Adds a high-shelf filter to the audio bus. */
5
5
  declare class AudioEffectHighShelfFilter extends AudioEffectFilter {
6
6
  }
@@ -1,19 +1,14 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /** Adds a soft-clip limiter audio effect to an audio bus. */
4
+ /** Adds a soft-clip limiter audio effect to an Audio bus. */
5
5
  declare class AudioEffectLimiter extends AudioEffect {
6
- /** The waveform's maximum allowed value, in dB. Value can range from -20 to -0.1. */
6
+ /** The waveform's maximum allowed value, in decibels. Value can range from -20 to -0.1. */
7
7
  ceiling_db: float;
8
- /** Modifies the volume of the limited waves, in dB. Value can range from 0 to 6. */
8
+ /** Applies a gain to the limited waves, in decibels. Value can range from 0 to 6. */
9
9
  soft_clip_db: float;
10
- /**
11
- * This property has no effect on the audio. Use {@link AudioEffectHardLimiter} instead, as this Limiter effect is deprecated.
12
- */
13
10
  soft_clip_ratio: float;
14
- /**
15
- * The volume threshold level from which the limiter begins to be active, in dB. Value can range from -30 to 0.
16
- */
11
+ /** Threshold from which the limiter begins to be active, in decibels. Value can range from -30 to 0. */
17
12
  threshold_db: float;
18
13
  set_ceiling_db(value: float): void;
19
14
  get_ceiling_db(): float;
@@ -1,6 +1,6 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /** Adds a low-pass filter to an audio bus. */
4
+ /** Adds a low-pass filter to the audio bus. */
5
5
  declare class AudioEffectLowPassFilter extends AudioEffectFilter {
6
6
  }
@@ -1,6 +1,6 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /** Adds a low-shelf filter to an audio bus. */
4
+ /** Adds a low-shelf filter to the audio bus. */
5
5
  declare class AudioEffectLowShelfFilter extends AudioEffectFilter {
6
6
  }
@@ -1,6 +1,6 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /** Adds a notch filter to an audio bus. */
4
+ /** Adds a notch filter to the Audio bus. */
5
5
  declare class AudioEffectNotchFilter extends AudioEffectFilter {
6
6
  }
@@ -1,14 +1,9 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /**
5
- * Adds a panner audio effect to an audio bus.
6
- * Pans the sound left or right.
7
- */
4
+ /** Adds a panner audio effect to an audio bus. Pans sound left or right. */
8
5
  declare class AudioEffectPanner extends AudioEffect {
9
- /**
10
- * Pan position. Negative values pan the sound to the left, positive pan to the right. Value can range from -1 to 1.
11
- */
6
+ /** Pan position. Value can range from -1 (fully left) to 1 (fully right). */
12
7
  pan: float;
13
8
  set_pan(value: float): void;
14
9
  get_pan(): float;
@@ -3,26 +3,24 @@
3
3
 
4
4
  /**
5
5
  * Adds a phaser audio effect to an audio bus.
6
- * Creates several notch and peak filters that sweep across the spectrum.
6
+ * Combines the original signal with a copy that is slightly out of phase with the original.
7
7
  */
8
8
  declare class AudioEffectPhaser extends AudioEffect {
9
- /** Intensity of the effect. Value can range from 0.1 to 4.0. */
10
- depth: float;
11
9
  /**
12
- * The volume ratio of the filtered audio that is fed back to the all-pass filters. The higher the value, the sharper and louder the peak filters created by the effect. Value can range from 0.1 to 0.9.
10
+ * Determines how high the filter frequencies sweep. Low value will primarily affect bass frequencies. High value can sweep high into the treble. Value can range from `0.1` to `4.0`.
13
11
  */
12
+ depth: float;
13
+ /** Output percent of modified sound. Value can range from 0.1 to 0.9. */
14
14
  feedback: float;
15
15
  /**
16
- * Determines the maximum frequency affected by the low-frequency oscillator modulations, in Hz. Value can range from 10 to 10000.
16
+ * Determines the maximum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
17
17
  */
18
18
  range_max_hz: float;
19
19
  /**
20
- * Determines the minimum frequency affected by the low-frequency oscillator modulations, in Hz. Value can range from 10 to 10000.
20
+ * Determines the minimum frequency affected by the LFO modulations, in Hz. Value can range from 10 to 10000.
21
21
  */
22
22
  range_min_hz: float;
23
- /**
24
- * Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range. Value can range from 0.01 to 20.
25
- */
23
+ /** Adjusts the rate in Hz at which the effect sweeps up and down across the frequency range. */
26
24
  rate_hz: float;
27
25
  set_depth(value: float): void;
28
26
  get_depth(): float;
@@ -3,11 +3,11 @@
3
3
 
4
4
  /**
5
5
  * Adds a pitch-shifting audio effect to an audio bus.
6
- * Raises or lowers the pitch of the input audio.
6
+ * Raises or lowers the pitch of original sound.
7
7
  */
8
8
  declare class AudioEffectPitchShift extends AudioEffect {
9
9
  /**
10
- * The size of the Fast Fourier transform (https://en.wikipedia.org/wiki/Fast_Fourier_transform) buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on audio signals that have sudden amplitude changes.
10
+ * The size of the Fast Fourier transform (https://en.wikipedia.org/wiki/Fast_Fourier_transform) buffer. Higher values smooth out the effect over time, but have greater latency. The effects of this higher latency are especially noticeable on sounds that have sudden amplitude changes.
11
11
  */
12
12
  fft_size: int;
13
13
  /**
@@ -15,7 +15,7 @@ declare class AudioEffectPitchShift extends AudioEffect {
15
15
  */
16
16
  oversampling: int;
17
17
  /**
18
- * The pitch scale to use. `1.0` is the default pitch and plays sounds unaffected. {@link pitch_scale} can range from 0 (infinitely low pitch, inaudible) to 16 (16 times higher than the initial pitch).
18
+ * The pitch scale to use. `1.0` is the default pitch and plays sounds unaffected. {@link pitch_scale} can range from `0.0` (infinitely low pitch, inaudible) to `16` (16 times higher than the initial pitch).
19
19
  */
20
20
  pitch_scale: float;
21
21
  set_fft_size(value: int): void;
@@ -1,39 +1,30 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /**
5
- * Adds a reverberation audio effect to an audio bus.
6
- * Emulates an echo by playing a blurred version of the input audio.
7
- */
4
+ /** Adds a reverberation audio effect to an Audio bus. */
8
5
  declare class AudioEffectReverb extends AudioEffect {
9
- /**
10
- * Defines how reflective the imaginary room's walls are. The more reflective, the more high frequency content the reverb has. Value can range from 0 to 1.
11
- */
6
+ /** Defines how reflective the imaginary room's walls are. Value can range from 0 to 1. */
12
7
  damping: float;
13
8
  /**
14
- * The volume ratio of the original audio. At 0, only the modified audio is outputted. Value can range from 0 to 1.
9
+ * Output percent of original sound. At 0, only modified sound is outputted. Value can range from 0 to 1.
15
10
  */
16
11
  dry: float;
17
12
  /**
18
- * High-pass filter allows frequencies higher than a certain cutoff threshold and attenuates frequencies lower than the cutoff threshold. Value can range from 0 to 1.
13
+ * High-pass filter passes signals with a frequency higher than a certain cutoff frequency and attenuates signals with frequencies lower than the cutoff frequency. Value can range from 0 to 1.
19
14
  */
20
15
  hipass: float;
21
- /**
22
- * Gain of early reflection copies. At higher values, early reflection copies are louder and ring out for longer. Value can range from 0 to 1.
23
- */
16
+ /** Output percent of predelay. Value can range from 0 to 1. */
24
17
  predelay_feedback: float;
25
- /**
26
- * Time between the original audio and the early reflections of the reverb signal, in milliseconds. Value can range from 20 to 500.
27
- */
18
+ /** Time between the original signal and the early reflections of the reverb signal, in milliseconds. */
28
19
  predelay_msec: float;
29
20
  /** Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1. */
30
21
  room_size: float;
31
22
  /**
32
- * Widens or narrows the stereo image of the reverb tail. At 1, it fully widens. Value can range from 0 to 1.
23
+ * Widens or narrows the stereo image of the reverb tail. 1 means fully widens. Value can range from 0 to 1.
33
24
  */
34
25
  spread: float;
35
26
  /**
36
- * The volume ratio of the modified audio. At 0, only the original audio is outputted. Value can range from 0 to 1.
27
+ * Output percent of modified sound. At 0, only original sound is outputted. Value can range from 0 to 1.
37
28
  */
38
29
  wet: float;
39
30
  set_damping(value: float): void;
@@ -1,22 +1,23 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /**
5
- * Creates an {@link AudioEffectInstance} which performs frequency analysis and exposes results to be accessed in real-time.
6
- */
4
+ /** Audio effect that can be used for real-time audio visualizations. */
7
5
  declare class AudioEffectSpectrumAnalyzer extends AudioEffect {
8
6
  /**
9
- * The length of the buffer to keep, in seconds. Higher values keep data around for longer, but require more memory. Value can range from 0.1 to 4.
7
+ * The length of the buffer to keep (in seconds). Higher values keep data around for longer, but require more memory.
10
8
  */
11
9
  buffer_length: float;
12
10
  /**
13
11
  * The size of the Fast Fourier transform (https://en.wikipedia.org/wiki/Fast_Fourier_transform) buffer. Higher values smooth out the spectrum analysis over time, but have greater latency. The effects of this higher latency are especially noticeable with sudden amplitude changes.
14
12
  */
15
13
  fft_size: int;
14
+ tap_back_pos: float;
16
15
  set_buffer_length(value: float): void;
17
16
  get_buffer_length(): float;
18
17
  set_fft_size(value: int): void;
19
18
  get_fft_size(): int;
19
+ set_tap_back_pos(value: float): void;
20
+ get_tap_back_pos(): float;
20
21
 
21
22
  // enum FFTSize
22
23
  /**
@@ -1,21 +1,18 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /**
5
- * Adds a stereo manipulation audio effect to an audio bus.
6
- * Controls gain of the side channels, and widens the stereo image.
7
- */
4
+ /** An audio effect that can be used to adjust the intensity of stereo panning. */
8
5
  declare class AudioEffectStereoEnhance extends AudioEffect {
9
6
  /**
10
- * Gain of the side channels, if they exist. A value of 0 will downmix stereo to mono. Value can range from 0 to 4.
7
+ * Amplifies the difference between stereo channels, increasing or decreasing existing panning. A value of 0.0 will downmix stereo to mono. Does not affect a mono signal.
11
8
  */
12
9
  pan_pullout: float;
13
10
  /**
14
- * Widens the stereo image through phase shifting in conjunction with {@link time_pullout_ms}. Just pans sound to the left channel if {@link time_pullout_ms} is 0. Value can range from 0 to 1.
11
+ * Widens sound stage through phase shifting in conjunction with {@link time_pullout_ms}. Just pans sound to the left channel if {@link time_pullout_ms} is 0.
15
12
  */
16
13
  surround: float;
17
14
  /**
18
- * Widens the stereo image through phase shifting in conjunction with {@link surround}. Just delays the right channel if {@link surround} is 0. Value is in milliseconds, and can range from 0 to 50.
15
+ * Widens sound stage through phase shifting in conjunction with {@link surround}. Just delays the right channel if {@link surround} is 0.
19
16
  */
20
17
  time_pullout_ms: float;
21
18
  set_pan_pullout(value: float): void;
@@ -96,9 +96,9 @@ declare interface AudioServer extends GodotObject {
96
96
  get_output_latency(): float;
97
97
  /** Returns the speaker configuration. */
98
98
  get_speaker_mode(): int;
99
- /** Returns the relative time since the last mix occurred, in seconds. */
99
+ /** Returns the relative time since the last mix occurred. */
100
100
  get_time_since_last_mix(): float;
101
- /** Returns the relative time until the next mix occurs, in seconds. */
101
+ /** Returns the relative time until the next mix occurs. */
102
102
  get_time_to_next_mix(): float;
103
103
  /** If `true`, the bus at index `bus_idx` is bypassing effects. */
104
104
  is_bus_bypassing_effects(bus_idx: int): boolean;
@@ -1,16 +1,8 @@
1
1
  // AUTO-GENERATED from Godot class documentation.
2
2
  // Manual overrides applied from typings-overrides/*.d.ts
3
3
 
4
- /** Playback class used for resampled {@link AudioStream}s. */
5
4
  declare class AudioStreamPlaybackResampled extends AudioStreamPlayback {
6
- /** Returns an {@link AudioStream}'s sample rate, in Hz. Used to perform resampling. */
7
5
  _get_stream_sampling_rate(): float;
8
- /**
9
- * Called by {@link begin_resample} to mix an {@link AudioStream} to {@link AudioServer.get_mix_rate}. Uses {@link _get_stream_sampling_rate} as the source sample rate. Returns the number of mixed frames.
10
- */
11
6
  _mix_resampled(dst_buffer: unknown, frame_count: int): int;
12
- /**
13
- * Called when an {@link AudioStream} is played. Clears the cubic interpolation history and starts mixing by calling {@link _mix_resampled}.
14
- */
15
7
  begin_resample(): void;
16
8
  }
@@ -38,7 +38,7 @@ declare class BaseButton extends Control {
38
38
  */
39
39
  shortcut_feedback: boolean;
40
40
  /**
41
- * If `true`, the button will add information about its shortcut in the tooltip. This includes the shortcut's events and its {@link Resource.resource_name}. If both events and name are empty, the shortcut will not be included.
41
+ * If `true`, the button will add information about its shortcut in the tooltip.
42
42
  * **Note:** This property does nothing when the tooltip control is customized using {@link Control._make_custom_tooltip}.
43
43
  */
44
44
  shortcut_in_tooltip: boolean;
@@ -61,10 +61,6 @@ declare interface Basis {
61
61
  * Returns `true` if this basis is finite, by calling {@link @GlobalScope.is_finite} on all vector components.
62
62
  */
63
63
  is_finite(): boolean;
64
- /**
65
- * Returns `true` if this basis is orthonormal. An orthonormal basis is both *orthogonal* (the axes are perpendicular to each other) and *normalized* (the length of every axis is `1.0`). This method can be especially useful during physics calculations.
66
- */
67
- is_orthonormal(): boolean;
68
64
  /**
69
65
  * Returns the orthonormalized version of this basis. An orthonormal basis is both *orthogonal* (the axes are perpendicular to each other) and *normalized* (the axes have a length of `1.0`), which also means it can only represent a rotation.
70
66
  * It is often useful to call this method to avoid rounding errors on a rotating basis:
@@ -155,7 +155,7 @@ declare class Camera3D extends Node3D {
155
155
  */
156
156
  set_cull_mask_value(layer_number: int, value: boolean): void;
157
157
  /**
158
- * Sets the camera projection to frustum mode (see {@link PROJECTION_FRUSTUM}), by specifying a `size`, an `offset`, and the `z_near` and `z_far` clip planes in world space units. The `size` parameter represents the size of the near plane, either its width or height depending on the value of {@link keep_aspect}. See also {@link frustum_offset}.
158
+ * Sets the camera projection to frustum mode (see {@link PROJECTION_FRUSTUM}), by specifying a `size`, an `offset`, and the `z_near` and `z_far` clip planes in world space units. See also {@link frustum_offset}.
159
159
  */
160
160
  set_frustum(size: float, offset: Vector2 | Vector2i, z_near: float, z_far: float): void;
161
161
  /**
@@ -5,7 +5,6 @@
5
5
  declare class CameraAttributes extends Resource {
6
6
  /**
7
7
  * If `true`, enables the tonemapping auto exposure mode of the scene renderer. If `true`, the renderer will automatically determine the exposure setting to adapt to the scene's illumination and the observed light.
8
- * **Note:** Auto-exposure is only supported in the Forward+ rendering method, not Mobile or Compatibility.
9
8
  */
10
9
  auto_exposure_enabled: boolean;
11
10
  /** The scale of the auto exposure effect. Affects the intensity of auto exposure. */
@@ -19,10 +19,6 @@ declare class CameraFeed extends RefCounted {
19
19
  _activate_feed(): boolean;
20
20
  /** Called when the camera feed is deactivated. */
21
21
  _deactivate_feed(): void;
22
- /** Override this method to define supported formats of the camera feed. */
23
- _get_formats(): Array<unknown>;
24
- /** Override this method to set the format of the camera feed. */
25
- _set_format(index: int, parameters: Dictionary): boolean;
26
22
  /** Returns feed image data type. */
27
23
  get_datatype(): int;
28
24
  /** Returns the unique ID for this feed. */
@@ -444,7 +444,7 @@ declare class CanvasItem extends Node {
444
444
  /** Represents the size of the {@link TextureFilter} enum. */
445
445
  static readonly TEXTURE_FILTER_MAX: int;
446
446
  // enum TextureRepeat
447
- /** The {@link CanvasItem} will inherit the repeat mode from its parent. */
447
+ /** The {@link CanvasItem} will inherit the filter from its parent. */
448
448
  static readonly TEXTURE_REPEAT_PARENT_NODE: int;
449
449
  /**
450
450
  * The texture does not repeat. Sampling the texture outside its extents will result in "stretching" of the edge pixels. You can avoid this by ensuring a 1-pixel fully transparent border on each side of the texture.
@@ -282,10 +282,6 @@ declare class CodeEdit extends TextEdit {
282
282
  is_line_executing(line: int): boolean;
283
283
  /** Returns `true` if the given line is folded. See {@link fold_line}. */
284
284
  is_line_folded(line: int): boolean;
285
- /**
286
- * Joins all selected lines or lines containing a caret with their next line. Whitespace in between will be removed. If the next line has content, the `line_ending` will be inserted in between.
287
- */
288
- join_lines(line_ending?: string | NodePath): void;
289
285
  /** Moves all lines down that are selected or have a caret on them. */
290
286
  move_lines_down(): void;
291
287
  /** Moves all lines up that are selected or have a caret on them. */
@@ -71,8 +71,6 @@ declare class CollisionObject2D extends Node2D {
71
71
  get_collision_mask_value(layer_number: int): boolean;
72
72
  /** Returns the object's {@link RID}. */
73
73
  get_rid(): RID;
74
- /** Returns the `one_way_collision_direction` of the shape owner identified by the given `owner_id`. */
75
- get_shape_owner_one_way_collision_direction(owner_id: int): Vector2;
76
74
  /** Returns the `one_way_collision_margin` of the shape owner identified by given `owner_id`. */
77
75
  get_shape_owner_one_way_collision_margin(owner_id: int): float;
78
76
  /**
@@ -119,10 +117,6 @@ declare class CollisionObject2D extends Node2D {
119
117
  * If `enable` is `true`, collisions for the shape owner originating from this {@link CollisionObject2D} will not be reported to collided with {@link CollisionObject2D}s.
120
118
  */
121
119
  shape_owner_set_one_way_collision(owner_id: int, enable: boolean): void;
122
- /**
123
- * Sets the `one_way_collision_direction` of the shape owner identified by the given `owner_id` to `p_direction`.
124
- */
125
- shape_owner_set_one_way_collision_direction(owner_id: int, p_direction: Vector2 | Vector2i): void;
126
120
  /**
127
121
  * Sets the `one_way_collision_margin` of the shape owner identified by given `owner_id` to `margin` pixels.
128
122
  */
@@ -12,11 +12,8 @@ declare class CollisionPolygon2D extends Node2D {
12
12
  /**
13
13
  * If `true`, only edges that face up, relative to {@link CollisionPolygon2D}'s rotation, will collide with other objects.
14
14
  * **Note:** This property has no effect if this {@link CollisionPolygon2D} is a child of an {@link Area2D} node.
15
- * **Note:** The one way collision direction can be configured by setting {@link one_way_collision_direction}.
16
15
  */
17
16
  one_way_collision: boolean;
18
- /** The direction used for one-way collision. */
19
- one_way_collision_direction: Vector2;
20
17
  /**
21
18
  * The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the polygon at a high velocity.
22
19
  */
@@ -32,8 +29,6 @@ declare class CollisionPolygon2D extends Node2D {
32
29
  is_disabled(): boolean;
33
30
  set_one_way_collision(value: boolean): void;
34
31
  is_one_way_collision_enabled(): boolean;
35
- set_one_way_collision_direction(value: Vector2 | Vector2i): void;
36
- get_one_way_collision_direction(): Vector2;
37
32
  set_one_way_collision_margin(value: float): void;
38
33
  get_one_way_collision_margin(): float;
39
34
  set_polygon(value: PackedVector2Array | Array<unknown>): void;
@@ -15,11 +15,8 @@ declare class CollisionShape2D extends Node2D {
15
15
  /**
16
16
  * Sets whether this collision shape should only detect collision on one side (top or bottom).
17
17
  * **Note:** This property has no effect if this {@link CollisionShape2D} is a child of an {@link Area2D} node.
18
- * **Note:** The one way collision direction can be configured by setting {@link one_way_collision_direction}.
19
18
  */
20
19
  one_way_collision: boolean;
21
- /** The direction used for one-way collision. */
22
- one_way_collision_direction: Vector2;
23
20
  /**
24
21
  * The margin used for one-way collision (in pixels). Higher values will make the shape thicker, and work better for colliders that enter the shape at a high velocity.
25
22
  */
@@ -32,8 +29,6 @@ declare class CollisionShape2D extends Node2D {
32
29
  is_disabled(): boolean;
33
30
  set_one_way_collision(value: boolean): void;
34
31
  is_one_way_collision_enabled(): boolean;
35
- set_one_way_collision_direction(value: Vector2 | Vector2i): void;
36
- get_one_way_collision_direction(): Vector2;
37
32
  set_one_way_collision_margin(value: float): void;
38
33
  get_one_way_collision_margin(): float;
39
34
  set_shape(value: Shape2D | null): void;