@ringozz/godot 0.1.0

package/gen/classes/AudioEffectRecord.ts

@@ -0,0 +1,39 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { AudioEffect } from './AudioEffect.ts';
+import type { AudioStreamWAV, Format } from './AudioStreamWAV.ts';
+
+/**
+ * Allows the user to record the sound from an audio bus into an {@link AudioStreamWAV}. When used on the Master audio bus, this includes all audio output by Godot.
+ * Unlike {@link AudioEffectCapture}, this effect encodes the recording with the given format (8-bit, 16-bit, or compressed) instead of giving access to the raw audio samples.
+ * Can be used (with an {@link AudioStreamMicrophone}) to record from a microphone.
+ * **Note:** {@link ProjectSettings.audio/driver/enableInput} must be `true` for audio input to work. See also that setting's description for caveats related to permissions and operating system privacy settings.
+ */
+export class AudioEffectRecord extends AudioEffect {
+    constructor(name = 112) { super(name); }
+
+    /**
+     * If `true`, the sound will be recorded. Note that restarting the recording will remove the previously recorded sample.
+     */
+    setRecordingActive(record: boolean): void { _C(this, 12485, record); }
+
+    /**
+     * Returns whether the recording is active or not.
+     */
+    isRecordingActive(): boolean { return _C(this, 8229) as boolean; }
+
+    /**
+     * Returns the recorded sample.
+     */
+    getRecording(): AudioStreamWAV { return _C(this, 6091) as AudioStreamWAV; }
+
+    /**
+     * Specifies the format in which the sample will be recorded.
+     */
+    get format(): Format { return _C(this, 4861) as Format; }
+    set format(v: Format) { _C(this, 11465, v); }
+
+    static readonly name = _R(112, AudioEffectRecord);
+}

package/gen/classes/AudioEffectReverb.ts

@@ -0,0 +1,63 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { AudioEffect } from './AudioEffect.ts';
+
+/**
+ * A "reverb" effect plays the input audio back continuously, decaying over a period of time. It simulates sounds in different kinds of spaces, ranging from small rooms, to big caverns.
+ * See also {@link AudioEffectDelay} for a non-blurry type of echo.
+ */
+export class AudioEffectReverb extends AudioEffect {
+    constructor(name = 113) { super(name); }
+
+    /**
+     * Time between the original audio and the early reflections of the reverb signal, in milliseconds. Value can range from 20 to 500.
+     */
+    get predelayMsec(): number { return _C(this, 5987) as number; }
+    set predelayMsec(v: number) { _C(this, 12395, v); }
+
+    /**
+     * 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.
+     */
+    get predelayFeedback(): number { return _C(this, 5986) as number; }
+    set predelayFeedback(v: number) { _C(this, 12394, v); }
+
+    /**
+     * Dimensions of simulated room. Bigger means more echoes. Value can range from 0 to 1.
+     */
+    get roomSize(): number { return _C(this, 6187) as number; }
+    set roomSize(v: number) { _C(this, 12564, v); }
+
+    /**
+     * 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.
+     */
+    get damping(): number { return _C(this, 4405) as number; }
+    set damping(v: number) { _C(this, 11029, v); }
+
+    /**
+     * Widens or narrows the stereo image of the reverb tail. At 1, it fully widens. Value can range from 0 to 1.
+     */
+    get spread(): number { return _C(this, 6502) as number; }
+    set spread(v: number) { _C(this, 12845, v); }
+
+    /**
+     * 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.
+     */
+    get hipass(): number { return _C(this, 5049) as number; }
+    set hipass(v: number) { _C(this, 11642, v); }
+
+    /**
+     * The volume ratio of the original audio. At 0, only the modified audio is outputted. Value can range from 0 to 1.
+     */
+    get dry(): number { return _C(this, 4587) as number; }
+    set dry(v: number) { _C(this, 11201, v); }
+
+    /**
+     * The volume ratio of the modified audio. At 0, only the original audio is outputted. Value can range from 0 to 1.
+     */
+    get wet(): number { return _C(this, 7145) as number; }
+    set wet(v: number) { _C(this, 13370, v); }
+
+    static readonly name = _R(113, AudioEffectReverb);
+}

package/gen/classes/AudioEffectSpectrumAnalyzer.ts

@@ -0,0 +1,57 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { AudioEffect } from './AudioEffect.ts';
+
+/**
+ * Calculates a Fourier Transform of the audio signal. This effect does not alter the audio. Can be used for creating real-time audio visualizations, like a spectrogram.
+ * This resource configures an {@link AudioEffectSpectrumAnalyzerInstance}, which performs the actual analysis at runtime. An instance should be obtained with {@link AudioServer.getBusEffectInstance} to make use of this effect.
+ */
+export class AudioEffectSpectrumAnalyzer extends AudioEffect {
+    constructor(name = 114) { super(name); }
+
+    /**
+     * 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.
+     */
+    get bufferLength(): number { return _C(this, 4004) as number; }
+    set bufferLength(v: number) { _C(this, 10742, v); }
+
+    /**
+     * 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.
+     */
+    get fftSize(): FFTSize { return _C(this, 4769) as FFTSize; }
+    set fftSize(v: FFTSize) { _C(this, 11377, v); }
+
+    static readonly name = _R(114, AudioEffectSpectrumAnalyzer);
+}
+
+export const FFTSize = {
+    /**
+     * Use a buffer of 256 samples for the Fast Fourier transform. Lowest latency, but least stable over time.
+     */
+    FFT_SIZE_256: 0,
+    /**
+     * Use a buffer of 512 samples for the Fast Fourier transform. Low latency, but less stable over time.
+     */
+    FFT_SIZE_512: 1,
+    /**
+     * Use a buffer of 1024 samples for the Fast Fourier transform. This is a compromise between latency and stability over time.
+     */
+    FFT_SIZE_1024: 2,
+    /**
+     * Use a buffer of 2048 samples for the Fast Fourier transform. High latency, but stable over time.
+     */
+    FFT_SIZE_2048: 3,
+    /**
+     * Use a buffer of 4096 samples for the Fast Fourier transform. Highest latency, but most stable over time.
+     */
+    FFT_SIZE_4096: 4,
+    /**
+     * Represents the size of the {@link FFTSize} enum.
+     */
+    FFT_SIZE_MAX: 5,
+} as const;
+
+export type FFTSize = (typeof FFTSize)[keyof typeof FFTSize];
+

package/gen/classes/AudioEffectSpectrumAnalyzerInstance.ts

@@ -0,0 +1,35 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { AudioEffectInstance } from './AudioEffectInstance.ts';
+import type { Vector2 } from '../value-types/index.ts';
+
+/**
+ * The runtime part of an {@link AudioEffectSpectrumAnalyzer}, which can be used to query the magnitude of a frequency range on its host bus.
+ * An instance of this class can be obtained with {@link AudioServer.getBusEffectInstance}.
+ */
+export class AudioEffectSpectrumAnalyzerInstance extends AudioEffectInstance {
+
+    /**
+     * Returns the magnitude of the frequencies from `fromHz` to `toHz` in linear energy as a Vector2. The `x` component of the return value represents the left stereo channel, and `y` represents the right channel.
+     * `mode` determines how the frequency range will be processed.
+     */
+    getMagnitudeForFrequencyRange(fromHz: number, toHz: number, mode?: MagnitudeMode /* = 1 */): Vector2 { return _C(this, 5431, fromHz, toHz, mode) as Vector2; }
+
+    static readonly name = _R(115, AudioEffectSpectrumAnalyzerInstance);
+}
+
+export const MagnitudeMode = {
+    /**
+     * Use the average value across the frequency range as magnitude.
+     */
+    MAGNITUDE_AVERAGE: 0,
+    /**
+     * Use the maximum value of the frequency range as magnitude.
+     */
+    MAGNITUDE_MAX: 1,
+} as const;
+
+export type MagnitudeMode = (typeof MagnitudeMode)[keyof typeof MagnitudeMode];
+

package/gen/classes/AudioEffectStereoEnhance.ts

@@ -0,0 +1,32 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { AudioEffect } from './AudioEffect.ts';
+
+/**
+ * Adjusts gain of the left and right channels, and makes mono sounds stereo through phase shifting.
+ */
+export class AudioEffectStereoEnhance extends AudioEffect {
+    constructor(name = 116) { super(name); }
+
+    /**
+     * Gain of the side channels, if they exist. A value of 0 will downmix stereo to mono. Value can range from 0 to 4.
+     */
+    get panPullout(): number { return _C(this, 5801) as number; }
+    set panPullout(v: number) { _C(this, 12241, v); }
+
+    /**
+     * 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.
+     */
+    get timePulloutMs(): number { return _C(this, 6812) as number; }
+    set timePulloutMs(v: number) { _C(this, 13086, v); }
+
+    /**
+     * Widens the stereo image through phase shifting in conjunction with {@link timePulloutMs}. Just pans sound to the left channel if {@link timePulloutMs} is 0. Value can range from 0 to 1.
+     */
+    get surround(): number { return _C(this, 6636) as number; }
+    set surround(v: number) { _C(this, 12942, v); }
+
+    static readonly name = _R(116, AudioEffectStereoEnhance);
+}

package/gen/classes/AudioListener2D.ts

@@ -0,0 +1,31 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { Node2D } from './Node2D.ts';
+
+/**
+ * Once added to the scene tree and enabled using {@link makeCurrent}, this node will override the location sounds are heard from. Only one {@link AudioListener2D} can be current. Using {@link makeCurrent} will disable the previous {@link AudioListener2D}.
+ * If there is no active {@link AudioListener2D} in the current {@link Viewport}, center of the screen will be used as a hearing point for the audio. {@link AudioListener2D} needs to be inside {@link SceneTree} to function.
+ */
+export class AudioListener2D extends Node2D {
+    constructor(name = 117) { super(name); }
+
+    /**
+     * Makes the {@link AudioListener2D} active, setting it as the hearing point for the sounds. If there is already another active {@link AudioListener2D}, it will be disabled.
+     * This method will have no effect if the {@link AudioListener2D} is not added to {@link SceneTree}.
+     */
+    makeCurrent(): void { _C(this, 8729); }
+
+    /**
+     * Disables the {@link AudioListener2D}. If it's not set as current, this method will have no effect.
+     */
+    clearCurrent(): void { _C(this, 2256); }
+
+    /**
+     * Returns `true` if this {@link AudioListener2D} is currently active.
+     */
+    isCurrent(): boolean { return _C(this, 7862) as boolean; }
+
+    static readonly name = _R(117, AudioListener2D);
+}

package/gen/classes/AudioListener3D.ts

@@ -0,0 +1,61 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { Node3D } from './Node3D.ts';
+import type { Transform3D } from '../value-types/index.ts';
+
+/**
+ * Once added to the scene tree and enabled using {@link makeCurrent}, this node will override the location sounds are heard from. This can be used to listen from a location different from the {@link Camera3D}.
+ */
+export class AudioListener3D extends Node3D {
+    constructor(name = 118) { super(name); }
+
+    /**
+     * Enables the listener. This will override the current camera's listener.
+     */
+    makeCurrent(): void { _C(this, 8729); }
+
+    /**
+     * Disables the listener to use the current camera's listener instead.
+     */
+    clearCurrent(): void { _C(this, 2256); }
+
+    /**
+     * Returns `true` if the listener was made current using {@link makeCurrent}, `false` otherwise.
+     * **Note:** There may be more than one AudioListener3D marked as "current" in the scene tree, but only the one that was made current last will be used.
+     */
+    isCurrent(): boolean { return _C(this, 7862) as boolean; }
+
+    /**
+     * Returns the listener's global orthonormalized {@link Transform3D}.
+     */
+    getListenerTransform(): Transform3D { return _C(this, 5390) as Transform3D; }
+
+    /**
+     * If not {@link DOPPLER_TRACKING_DISABLED}, this listener will simulate the [Doppler effect](https://en.wikipedia.org/wiki/Doppler_effect) for objects changed in particular `_process` methods.
+     * **Note:** The Doppler effect will only be heard on {@link AudioStreamPlayer3D}s if {@link AudioStreamPlayer3D.dopplerTracking} is not set to {@link AudioStreamPlayer3D.DOPPLER_TRACKING_DISABLED}.
+     */
+    get dopplerTracking(): DopplerTracking { return _C(this, 4545) as DopplerTracking; }
+    set dopplerTracking(v: DopplerTracking) { _C(this, 11155, v); }
+
+    static readonly name = _R(118, AudioListener3D);
+}
+
+export const DopplerTracking = {
+    /**
+     * Disables [Doppler effect](https://en.wikipedia.org/wiki/Doppler_effect) simulation (default).
+     */
+    DOPPLER_TRACKING_DISABLED: 0,
+    /**
+     * Simulate [Doppler effect](https://en.wikipedia.org/wiki/Doppler_effect) by tracking positions of objects that are changed in `_process`. Changes in the relative velocity of this listener compared to those objects affect how audio is perceived (changing the audio's {@link AudioStreamPlayer3D.pitchScale}).
+     */
+    DOPPLER_TRACKING_IDLE_STEP: 1,
+    /**
+     * Simulate [Doppler effect](https://en.wikipedia.org/wiki/Doppler_effect) by tracking positions of objects that are changed in `_physics_process`. Changes in the relative velocity of this listener compared to those objects affect how audio is perceived (changing the audio's {@link AudioStreamPlayer3D.pitchScale}).
+     */
+    DOPPLER_TRACKING_PHYSICS_STEP: 2,
+} as const;
+
+export type DopplerTracking = (typeof DopplerTracking)[keyof typeof DopplerTracking];
+

package/gen/classes/AudioSample.ts

@@ -0,0 +1,14 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { RefCounted } from './RefCounted.ts';
+
+/**
+ * Base class for audio samples.
+ */
+export class AudioSample extends RefCounted {
+    constructor(name = 119) { super(name); }
+
+    static readonly name = _R(119, AudioSample);
+}

package/gen/classes/AudioSamplePlayback.ts

@@ -0,0 +1,14 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { RefCounted } from './RefCounted.ts';
+
+/**
+ * Meta class for playing back audio samples.
+ */
+export class AudioSamplePlayback extends RefCounted {
+    constructor(name = 120) { super(name); }
+
+    static readonly name = _R(120, AudioSamplePlayback);
+}