@ringozz/godot 0.1.0

package/gen/classes/SpriteBase3D.ts

@@ -0,0 +1,205 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { GeometryInstance3D } from './GeometryInstance3D.ts';
+import type { Color, Rect2, Vector2 } from '../value-types/index.ts';
+import type { AlphaAntiAliasing, BillboardMode } from './BaseMaterial3D.ts';
+import type { TriangleMesh } from './TriangleMesh.ts';
+import type { TextureFilter } from './VisualShaderNodeTextureParameter.ts';
+
+/**
+ * A node that displays 2D texture information in a 3D environment. See also {@link Sprite3D} where many other properties are defined.
+ */
+export class SpriteBase3D extends GeometryInstance3D {
+
+    /**
+     * Returns the rectangle representing this sprite.
+     */
+    getItemRect(): Rect2 { return _C(this, 5208) as Rect2; }
+
+    /**
+     * Returns a {@link TriangleMesh} with the sprite's vertices following its current configuration (such as its {@link axis} and {@link pixelSize}).
+     */
+    generateTriangleMesh(): TriangleMesh { return _C(this, 3642) as TriangleMesh; }
+
+    /**
+     * If `true`, texture will be centered.
+     */
+    get centered(): boolean { return _C(this, 7827) as boolean; }
+    set centered(v: boolean) { _C(this, 10847, v); }
+
+    /**
+     * The texture's drawing offset.
+     * **Note:** When you increase {@link offset}.y in Sprite3D, the sprite moves upward in world space (i.e., +Y is up).
+     */
+    get offset(): Vector2 { return _C(this, 5703) as Vector2; }
+    set offset(v: Vector2) { _C(this, 12170, v); }
+
+    /**
+     * If `true`, texture is flipped horizontally.
+     */
+    get flipH(): boolean { return _C(this, 7957) as boolean; }
+    set flipH(v: boolean) { _C(this, 11417, v); }
+
+    /**
+     * If `true`, texture is flipped vertically.
+     */
+    get flipV(): boolean { return _C(this, 7958) as boolean; }
+    set flipV(v: boolean) { _C(this, 11418, v); }
+
+    /**
+     * A color value used to *multiply* the texture's colors. Can be used for mood-coloring or to simulate the color of ambient light.
+     * **Note:** Unlike {@link CanvasItem.modulate} for 2D, colors with values above `1.0` (overbright) are not supported.
+     * **Note:** If a {@link GeometryInstance3D.materialOverride} is defined on the {@link SpriteBase3D}, the material override must be configured to take vertex colors into account for albedo. Otherwise, the color defined in {@link modulate} will be ignored. For a {@link BaseMaterial3D}, {@link BaseMaterial3D.vertexColorUseAsAlbedo} must be `true`. For a {@link ShaderMaterial}, `ALBEDO *= COLOR.rgb;` must be inserted in the shader's `fragment()` function.
+     */
+    get modulate(): Color { return _C(this, 5576) as Color; }
+    set modulate(v: Color) { _C(this, 12081, v); }
+
+    /**
+     * The size of one pixel's width on the sprite to scale it in 3D.
+     */
+    get pixelSize(): number { return _C(this, 5914) as number; }
+    set pixelSize(v: number) { _C(this, 12334, v); }
+
+    /**
+     * The direction in which the front of the texture faces.
+     */
+    get axis(): number { return _C(this, 3859) as number; }
+    set axis(v: number) { _C(this, 10604, v); }
+
+    /**
+     * The billboard mode to use for the sprite.
+     * **Note:** When billboarding is enabled and the material also casts shadows, billboards will face **the** camera in the scene when rendering shadows. In scenes with multiple cameras, the intended shadow cannot be determined and this will result in undefined behavior. See [GitHub Pull Request #72638](https://github.com/godotengine/godot/pull/72638) for details.
+     */
+    get billboard(): BillboardMode { return _C(this, 3913) as BillboardMode; }
+    set billboard(v: BillboardMode) { _C(this, 10659, v); }
+
+    /**
+     * If `true`, the texture's transparency and the opacity are used to make those parts of the sprite invisible.
+     */
+    get transparent(): boolean { return _C(this, 4565, 0) as boolean; }
+    set transparent(v: boolean) { _C(this, 11188, 0, v); }
+
+    /**
+     * If `true`, the {@link Light3D} in the {@link Environment} has effects on the sprite.
+     */
+    get shaded(): boolean { return _C(this, 4565, 1) as boolean; }
+    set shaded(v: boolean) { _C(this, 11188, 1, v); }
+
+    /**
+     * If `true`, texture can be seen from the back as well, if `false`, it is invisible when looking at it from behind.
+     */
+    get doubleSided(): boolean { return _C(this, 4565, 2) as boolean; }
+    set doubleSided(v: boolean) { _C(this, 11188, 2, v); }
+
+    /**
+     * If `true`, depth testing is disabled and the object will be drawn in render order.
+     */
+    get noDepthTest(): boolean { return _C(this, 4565, 3) as boolean; }
+    set noDepthTest(v: boolean) { _C(this, 11188, 3, v); }
+
+    /**
+     * If `true`, the texture is rendered at the same size regardless of distance. The texture's size on screen is the same as if the camera was `1.0` units away from the texture's origin, regardless of the actual distance from the camera. The {@link Camera3D}'s field of view (or {@link Camera3D.size} when in orthogonal/frustum mode) still affects the size the sprite is drawn at.
+     */
+    get fixedSize(): boolean { return _C(this, 4565, 4) as boolean; }
+    set fixedSize(v: boolean) { _C(this, 11188, 4, v); }
+
+    /**
+     * The alpha cutting mode to use for the sprite.
+     */
+    get alphaCut(): AlphaCutMode { return _C(this, 3727) as AlphaCutMode; }
+    set alphaCut(v: AlphaCutMode) { _C(this, 10468, v); }
+
+    /**
+     * Threshold at which the alpha scissor will discard values.
+     */
+    get alphaScissorThreshold(): number { return _C(this, 3729) as number; }
+    set alphaScissorThreshold(v: number) { _C(this, 10470, v); }
+
+    /**
+     * The hashing scale for Alpha Hash. Recommended values between `0` and `2`.
+     */
+    get alphaHashScale(): number { return _C(this, 3728) as number; }
+    set alphaHashScale(v: number) { _C(this, 10469, v); }
+
+    /**
+     * The type of alpha antialiasing to apply.
+     */
+    get alphaAntialiasingMode(): AlphaAntiAliasing { return _C(this, 3722) as AlphaAntiAliasing; }
+    set alphaAntialiasingMode(v: AlphaAntiAliasing) { _C(this, 10463, v); }
+
+    /**
+     * Threshold at which antialiasing will be applied on the alpha channel.
+     */
+    get alphaAntialiasingEdge(): number { return _C(this, 3723) as number; }
+    set alphaAntialiasingEdge(v: number) { _C(this, 10464, v); }
+
+    /**
+     * Filter flags for the texture.
+     * **Note:** Linear filtering may cause artifacts around the edges, which are especially noticeable on opaque textures. To prevent this, use textures with transparent or identical colors around the edges.
+     */
+    get textureFilter(): TextureFilter { return _C(this, 6730) as TextureFilter; }
+    set textureFilter(v: TextureFilter) { _C(this, 13027, v); }
+
+    /**
+     * Sets the render priority for the sprite. Higher priority objects will be sorted in front of lower priority objects.
+     * **Note:** This only applies if {@link alphaCut} is set to {@link ALPHA_CUT_DISABLED} (default value).
+     * **Note:** This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
+     */
+    get renderPriority(): number { return _C(this, 6131) as number; }
+    set renderPriority(v: number) { _C(this, 12520, v); }
+
+    static readonly name = _R(738, SpriteBase3D);
+}
+
+export const DrawFlags = {
+    /**
+     * If set, the texture's transparency and the opacity are used to make those parts of the sprite invisible.
+     */
+    FLAG_TRANSPARENT: 0,
+    /**
+     * If set, lights in the environment affect the sprite.
+     */
+    FLAG_SHADED: 1,
+    /**
+     * If set, texture can be seen from the back as well. If not, the texture is invisible when looking at it from behind.
+     */
+    FLAG_DOUBLE_SIDED: 2,
+    /**
+     * Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it.
+     */
+    FLAG_DISABLE_DEPTH_TEST: 3,
+    /**
+     * Label is scaled by depth so that it always appears the same size on screen.
+     */
+    FLAG_FIXED_SIZE: 4,
+    /**
+     * Represents the size of the {@link DrawFlags} enum.
+     */
+    FLAG_MAX: 5,
+} as const;
+
+export type DrawFlags = (typeof DrawFlags)[keyof typeof DrawFlags];
+
+export const AlphaCutMode = {
+    /**
+     * This mode performs standard alpha blending. It can display translucent areas, but transparency sorting issues may be visible when multiple transparent materials are overlapping.
+     */
+    ALPHA_CUT_DISABLED: 0,
+    /**
+     * This mode only allows fully transparent or fully opaque pixels. Harsh edges will be visible unless some form of screen-space antialiasing is enabled (see {@link ProjectSettings.rendering/antiAliasing/quality/screenSpaceAa}). On the bright side, this mode doesn't suffer from transparency sorting issues when multiple transparent materials are overlapping. This mode is also known as *alpha testing* or *1-bit transparency*.
+     */
+    ALPHA_CUT_DISCARD: 1,
+    /**
+     * This mode draws fully opaque pixels in the depth prepass. This is slower than {@link ALPHA_CUT_DISABLED} or {@link ALPHA_CUT_DISCARD}, but it allows displaying translucent areas and smooth edges while using proper sorting.
+     */
+    ALPHA_CUT_OPAQUE_PREPASS: 2,
+    /**
+     * This mode draws cuts off all values below a spatially-deterministic threshold, the rest will remain opaque.
+     */
+    ALPHA_CUT_HASH: 3,
+} as const;
+
+export type AlphaCutMode = (typeof AlphaCutMode)[keyof typeof AlphaCutMode];
+

package/gen/classes/SpriteFrames.ts

@@ -0,0 +1,147 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { Resource } from './Resource.ts';
+import type { GodotArray, PackedStringArray, StringName } from '../heap-types/index.ts';
+import type { Texture2D } from './Texture2D.ts';
+
+/**
+ * Sprite frame library for an {@link AnimatedSprite2D} or {@link AnimatedSprite3D} node. Contains frames and animation data for playback.
+ */
+export class SpriteFrames extends Resource {
+    constructor(name = 739) { super(name); }
+
+    /**
+     * Adds a new `anim` animation to the library.
+     */
+    addAnimation(anim: StringName): void { _C(this, 1179, anim); }
+
+    /**
+     * Returns `true` if the `anim` animation exists.
+     */
+    hasAnimation(anim: StringName): boolean { return _C(this, 7356, anim) as boolean; }
+
+    /**
+     * Duplicates the animation `animFrom` to a new animation named `animTo`. Fails if `animTo` already exists, or if `animFrom` does not exist.
+     */
+    duplicateAnimation(animFrom: StringName, animTo: StringName): void { _C(this, 2981, animFrom, animTo); }
+
+    /**
+     * Removes the `anim` animation.
+     */
+    removeAnimation(anim: StringName): void { _C(this, 9884, anim); }
+
+    /**
+     * Changes the `anim` animation's name to `newname`.
+     */
+    renameAnimation(anim: StringName, newname: StringName): void { _C(this, 9993, anim, newname); }
+
+    /**
+     * Returns an array containing the names associated to each animation. Values are placed in alphabetical order.
+     */
+    getAnimationNames(): PackedStringArray { return _C(this, 3766) as PackedStringArray; }
+
+    /**
+     * Sets the speed for the `anim` animation in frames per second.
+     */
+    setAnimationSpeed(anim: StringName, fps: number /* double */): void { _C(this, 10507, anim, fps); }
+
+    /**
+     * Returns the speed in frames per second for the `anim` animation.
+     */
+    getAnimationSpeed(anim: StringName): number { return _C(this, 3770, anim) as number; }
+
+    /**
+     * If `loop` is `false` equivalent to `set_animation_loop_mode(LOOP_NONE)`.
+     * If `loop` is `true` equivalent to `set_animation_loop_mode(LOOP_LINEAR)`.
+     */
+    setAnimationLoop(anim: StringName, loop: boolean): void { _C(this, 10503, anim, loop); }
+
+    /**
+     * Returns `true` if `get_animation_loop_mode(anim) == LOOP_LINEAR`. Otherwise, returns `false`.
+     */
+    getAnimationLoop(anim: StringName): boolean { return _C(this, 3764, anim) as boolean; }
+
+    /**
+     * Sets the `loopMode` for the `anim` animation.
+     */
+    setAnimationLoopMode(anim: StringName, loopMode: LoopMode): void { _C(this, 10504, anim, loopMode); }
+
+    /**
+     * Returns the loop mode for the `anim` animation.
+     */
+    getAnimationLoopMode(anim: StringName): LoopMode { return _C(this, 3765, anim) as LoopMode; }
+
+    /**
+     * Adds a frame to the `anim` animation. If `atPosition` is `-1`, the frame will be added to the end of the animation. `duration` specifies the relative duration, see {@link getFrameDuration} for details.
+     */
+    addFrame(anim: StringName, texture: Texture2D, duration?: number /* = 1.0 */, atPosition?: number /* = -1 */): void { _C(this, 1222, anim, texture, duration, atPosition); }
+
+    /**
+     * Sets the `texture` and the `duration` of the frame `idx` in the `anim` animation. `duration` specifies the relative duration, see {@link getFrameDuration} for details.
+     */
+    setFrame(anim: StringName, idx: number, texture: Texture2D, duration?: number /* = 1.0 */): void { _C(this, 11480, anim, idx, texture, duration); }
+
+    /**
+     * Removes the `anim` animation's frame `idx`.
+     */
+    removeFrame(anim: StringName, idx: number): void { _C(this, 9914, anim, idx); }
+
+    /**
+     * Returns the number of frames for the `anim` animation.
+     */
+    getFrameCount(anim: StringName): number { return _C(this, 4880, anim) as number; }
+
+    /**
+     * Returns the texture of the frame `idx` in the `anim` animation.
+     */
+    getFrameTexture(anim: StringName, idx: number): Texture2D { return _C(this, 4888, anim, idx) as Texture2D; }
+
+    /**
+     * Returns a relative duration of the frame `idx` in the `anim` animation (defaults to `1.0`). For example, a frame with a duration of `2.0` is displayed twice as long as a frame with a duration of `1.0`. You can calculate the absolute duration (in seconds) of a frame using the following formula:
+     *
+     * ```text
+     *
+     * absolute_duration = relative_duration / (animation_fps * abs(playing_speed))
+     *
+     * ```
+     *
+     * In this example, `playing_speed` refers to either {@link AnimatedSprite2D.getPlayingSpeed} or {@link AnimatedSprite3D.getPlayingSpeed}.
+     */
+    getFrameDuration(anim: StringName, idx: number): number { return _C(this, 4882, anim, idx) as number; }
+
+    /**
+     * Removes all frames from the `anim` animation.
+     */
+    clear(anim: StringName): void { _C(this, 2232, anim); }
+
+    /**
+     * Removes all animations. An empty `default` animation will be created.
+     */
+    clearAll(): void { _C(this, 2233); }
+
+    get animations(): GodotArray { return _C(this, 995) as GodotArray; }
+    set animations(v: GodotArray) { _C(this, 1021, v); }
+
+    static readonly name = _R(739, SpriteFrames);
+}
+
+export const LoopMode = {
+    /**
+     * The animation plays once and stops when it reaches the end, or the start if played in reverse.
+     */
+    LOOP_NONE: 0,
+    /**
+     * The animation restarts from the beginning when it reaches the end, or from the end if played in reverse, repeating continuously.
+     */
+    LOOP_LINEAR: 1,
+    /**
+     * The animation alternates direction each time it reaches the end or start, playing forward and then in reverse repeatedly.
+     * **Note:** Both {@link AnimatedSprite2D} and {@link AnimatedSprite3D} play the first/last frame for its duration only once at each end of the animation loop (instead of twice, once per forward/backward animation direction).
+     */
+    LOOP_PINGPONG: 2,
+} as const;
+
+export type LoopMode = (typeof LoopMode)[keyof typeof LoopMode];
+

package/gen/classes/StandardMaterial3D.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 { BaseMaterial3D } from './BaseMaterial3D.ts';
+
+/**
+ * {@link StandardMaterial3D}'s properties are inherited from {@link BaseMaterial3D}. {@link StandardMaterial3D} uses separate textures for ambient occlusion, roughness and metallic maps. To use a single ORM map for all 3 textures, use an {@link ORMMaterial3D} instead.
+ */
+export class StandardMaterial3D extends BaseMaterial3D {
+    constructor(name = 740) { super(name); }
+
+    static readonly name = _R(740, StandardMaterial3D);
+}

package/gen/classes/StaticBody2D.ts

@@ -0,0 +1,37 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { PhysicsBody2D } from './PhysicsBody2D.ts';
+import type { Vector2 } from '../value-types/index.ts';
+import type { PhysicsMaterial } from './PhysicsMaterial.ts';
+
+/**
+ * A static 2D physics body. It can't be moved by external forces or contacts, but can be moved manually by other means such as code, {@link AnimationMixer}s (with {@link AnimationMixer.callbackModeProcess} set to {@link AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS}), and {@link RemoteTransform2D}.
+ * When {@link StaticBody2D} is moved, it is teleported to its new position without affecting other physics bodies in its path. If this is not desired, use {@link AnimatableBody2D} instead.
+ * {@link StaticBody2D} is useful for completely static objects like floors and walls, as well as moving surfaces like conveyor belts and circular revolving platforms (by using {@link constantLinearVelocity} and {@link constantAngularVelocity}).
+ */
+export class StaticBody2D extends PhysicsBody2D {
+    constructor(name = 741) { super(name); }
+
+    /**
+     * The physics material override for the body.
+     * If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one.
+     */
+    get physicsMaterialOverride(): PhysicsMaterial { return _C(this, 5897) as PhysicsMaterial; }
+    set physicsMaterialOverride(v: PhysicsMaterial) { _C(this, 12317, v); }
+
+    /**
+     * The body's constant linear velocity. This does not move the body, but affects touching bodies, as if it were moving.
+     */
+    get constantLinearVelocity(): Vector2 { return _C(this, 4287) as Vector2; }
+    set constantLinearVelocity(v: Vector2) { _C(this, 10946, v); }
+
+    /**
+     * The body's constant angular velocity. This does not rotate the body, but affects touching bodies, as if it were rotating.
+     */
+    get constantAngularVelocity(): number { return _C(this, 4284) as number; }
+    set constantAngularVelocity(v: number) { _C(this, 10943, v); }
+
+    static readonly name = _R(741, StaticBody2D);
+}

package/gen/classes/StaticBody3D.ts

@@ -0,0 +1,37 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R } from '../../src/runtime.ts';
+import { PhysicsBody3D } from './PhysicsBody3D.ts';
+import type { Vector3 } from '../value-types/index.ts';
+import type { PhysicsMaterial } from './PhysicsMaterial.ts';
+
+/**
+ * A static 3D physics body. It can't be moved by external forces or contacts, but can be moved manually by other means such as code, {@link AnimationMixer}s (with {@link AnimationMixer.callbackModeProcess} set to {@link AnimationMixer.ANIMATION_CALLBACK_MODE_PROCESS_PHYSICS}), and {@link RemoteTransform3D}.
+ * When {@link StaticBody3D} is moved, it is teleported to its new position without affecting other physics bodies in its path. If this is not desired, use {@link AnimatableBody3D} instead.
+ * {@link StaticBody3D} is useful for completely static objects like floors and walls, as well as moving surfaces like conveyor belts and circular revolving platforms (by using {@link constantLinearVelocity} and {@link constantAngularVelocity}).
+ */
+export class StaticBody3D extends PhysicsBody3D {
+    constructor(name = 742) { super(name); }
+
+    /**
+     * The physics material override for the body.
+     * If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one.
+     */
+    get physicsMaterialOverride(): PhysicsMaterial { return _C(this, 5897) as PhysicsMaterial; }
+    set physicsMaterialOverride(v: PhysicsMaterial) { _C(this, 12317, v); }
+
+    /**
+     * The body's constant linear velocity. This does not move the body, but affects touching bodies, as if it were moving.
+     */
+    get constantLinearVelocity(): Vector3 { return _C(this, 4287) as Vector3; }
+    set constantLinearVelocity(v: Vector3) { _C(this, 10946, v); }
+
+    /**
+     * The body's constant angular velocity. This does not rotate the body, but affects touching bodies, as if it were rotating.
+     */
+    get constantAngularVelocity(): Vector3 { return _C(this, 4284) as Vector3; }
+    set constantAngularVelocity(v: Vector3) { _C(this, 10943, v); }
+
+    static readonly name = _R(742, StaticBody3D);
+}

package/gen/classes/StatusIndicator.ts

@@ -0,0 +1,50 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R, _G } from '../../src/runtime.ts';
+import { Node } from './Node.ts';
+import type { NodePath, Signal } from '../heap-types/index.ts';
+import type { Rect2, Vector2i } from '../value-types/index.ts';
+import type { Texture2D } from './Texture2D.ts';
+
+export class StatusIndicator extends Node {
+    constructor(name = 743) { super(name); }
+
+    /**
+     * Returns the status indicator rectangle in screen coordinates. If this status indicator is not visible, returns an empty {@link Rect2}.
+     */
+    getRect(): Rect2 { return _C(this, 6092) as Rect2; }
+
+    /**
+     * Status indicator tooltip.
+     */
+    get tooltip(): string { return _C(this, 6843) as string; }
+    set tooltip(v: string) { _C(this, 13112, v); }
+
+    /**
+     * Status indicator icon.
+     */
+    get icon(): Texture2D { return _C(this, 5051) as Texture2D; }
+    set icon(v: Texture2D) { _C(this, 11645, v); }
+
+    /**
+     * Status indicator native popup menu. If this is set, the {@link pressed} signal is not emitted.
+     * **Note:** Native popup is only supported if {@link NativeMenu} supports {@link NativeMenu.FEATURE_POPUP_MENU} feature.
+     */
+    get menu(): NodePath { return _C(this, 5505) as NodePath; }
+    set menu(v: NodePath) { _C(this, 12019, v); }
+
+    /**
+     * If `true`, the status indicator is visible.
+     */
+    get visible(): boolean { return _C(this, 8450) as boolean; }
+    set visible(v: boolean) { _C(this, 13331, v); }
+
+    /**
+     * Emitted when the status indicator is pressed.
+     */
+    get pressed(): Signal<(mouseButton: number, mousePosition: Vector2i) => void> { return _G(this, 9542) as Signal<(mouseButton: number, mousePosition: Vector2i) => void>; }
+    set pressed(v: ((mouseButton: number, mousePosition: Vector2i) => void) | null) { _G(this, 9542, v); }
+
+    static readonly name = _R(743, StatusIndicator);
+}