@ringozz/godot 0.1.0

package/gen/classes/RigidBody2D.ts

@@ -0,0 +1,359 @@
+// Auto-generated from extension_api.json - DO NOT EDIT
+// Generated by dev/codegen.ts
+
+import { _C, _R, _G } from '../../src/runtime.ts';
+import { PhysicsBody2D } from './PhysicsBody2D.ts';
+import type { GodotArray, RID, Signal } from '../heap-types/index.ts';
+import type { Vector2 } from '../value-types/index.ts';
+import type { Node } from './Node.ts';
+import type { Node2D } from './Node2D.ts';
+import type { PhysicsDirectBodyState2D } from './PhysicsDirectBodyState2D.ts';
+import type { PhysicsMaterial } from './PhysicsMaterial.ts';
+
+/**
+ * {@link RigidBody2D} implements full 2D physics. It cannot be controlled directly, instead, you must apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting movement, rotation, react to collisions, and affect other physics bodies in its path.
+ * The body's behavior can be adjusted via {@link lockRotation}, {@link freeze}, and {@link freezeMode}. By changing various properties of the object, such as {@link mass}, you can control how the physics simulation acts on it.
+ * A rigid body will always maintain its shape and size, even when forces are applied to it. It is useful for objects that can be interacted with in an environment, such as a tree that can be knocked over or a stack of crates that can be pushed around.
+ * If you need to directly affect the body, prefer {@link _integrateForces} as it allows you to directly access the physics state.
+ * If you need to override the default physics behavior, you can write a custom force integration function. See {@link customIntegrator}.
+ * **Note:** Changing the 2D transform or {@link linearVelocity} of a {@link RigidBody2D} very often may lead to some unpredictable behaviors. This also happens when a {@link RigidBody2D} is the descendant of a constantly moving node, like another {@link RigidBody2D}, as that will cause its global transform to be set whenever its ancestor moves.
+ */
+export class RigidBody2D extends PhysicsBody2D {
+    constructor(name = 671) { super(name); }
+
+    /**
+     * Returns the number of contacts this body has with other bodies. By default, this returns 0 unless bodies are configured to monitor contacts (see {@link contactMonitor}).
+     * **Note:** To retrieve the colliding bodies, use {@link getCollidingBodies}.
+     */
+    getContactCount(): number { return _C(this, 4301) as number; }
+
+    /**
+     * Sets the body's velocity on the given axis. The velocity in the given vector axis will be set as the given vector length. This is useful for jumping behavior.
+     */
+    setAxisVelocity(axisVelocity: Vector2): void { _C(this, 10608, axisVelocity); }
+
+    /**
+     * Applies a directional impulse without affecting rotation.
+     * An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
+     * This is equivalent to using {@link applyImpulse} at the body's center of mass.
+     */
+    applyCentralImpulse(impulse?: Vector2 /* = Vector2(0, 0) */): void { _C(this, 1529, impulse); }
+
+    /**
+     * Applies a positioned impulse to the body.
+     * An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
+     * `position` is the offset from the body origin in global coordinates.
+     */
+    applyImpulse(impulse: Vector2, position?: Vector2 /* = Vector2(0, 0) */): void { _C(this, 1533, impulse, position); }
+
+    /**
+     * Applies a rotational impulse to the body without affecting the position.
+     * An impulse is time-independent! Applying an impulse every frame would result in a framerate-dependent force. For this reason, it should only be used when simulating one-time impacts (use the "_force" functions otherwise).
+     * **Note:** {@link inertia} is required for this to work. To have {@link inertia}, an active {@link CollisionShape2D} must be a child of the node, or you can manually set {@link inertia}.
+     */
+    applyTorqueImpulse(torque: number): void { _C(this, 1537, torque); }
+
+    /**
+     * Applies a directional force without affecting rotation. A force is time dependent and meant to be applied every physics update.
+     * This is equivalent to using {@link applyForce} at the body's center of mass.
+     */
+    applyCentralForce(force: Vector2): void { _C(this, 1528, force); }
+
+    /**
+     * Applies a positioned force to the body. A force is time dependent and meant to be applied every physics update.
+     * `position` is the offset from the body origin in global coordinates.
+     */
+    applyForce(force: Vector2, position?: Vector2 /* = Vector2(0, 0) */): void { _C(this, 1531, force, position); }
+
+    /**
+     * Applies a rotational force without affecting position. A force is time dependent and meant to be applied every physics update.
+     * **Note:** {@link inertia} is required for this to work. To have {@link inertia}, an active {@link CollisionShape2D} must be a child of the node, or you can manually set {@link inertia}.
+     */
+    applyTorque(torque: number): void { _C(this, 1536, torque); }
+
+    /**
+     * Adds a constant directional force without affecting rotation that keeps being applied over time until cleared with `constant_force = Vector2(0, 0)`.
+     * This is equivalent to using {@link addConstantForce} at the body's center of mass.
+     */
+    addConstantCentralForce(force: Vector2): void { _C(this, 1202, force); }
+
+    /**
+     * Adds a constant positioned force to the body that keeps being applied over time until cleared with `constant_force = Vector2(0, 0)`.
+     * `position` is the offset from the body origin in global coordinates.
+     */
+    addConstantForce(force: Vector2, position?: Vector2 /* = Vector2(0, 0) */): void { _C(this, 1203, force, position); }
+
+    /**
+     * Adds a constant rotational force without affecting position that keeps being applied over time until cleared with `constant_torque = 0`.
+     */
+    addConstantTorque(torque: number): void { _C(this, 1204, torque); }
+
+    /**
+     * Returns a list of the bodies colliding with this one. Requires {@link contactMonitor} to be set to `true` and {@link maxContactsReported} to be set high enough to detect all the collisions.
+     * **Note:** The result of this test is not immediate after moving objects. For performance, list of collisions is updated once per frame and before the physics step. Consider using signals instead.
+     */
+    getCollidingBodies(): GodotArray<Node2D> { return _C(this, 4194) as GodotArray<Node2D>; }
+
+    /**
+     * The body's mass.
+     */
+    get mass(): number { return _C(this, 5451) as number; }
+    set mass(v: number) { _C(this, 11977, v); }
+
+    /**
+     * 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); }
+
+    /**
+     * Multiplies the gravity applied to the body. The body's gravity is calculated from the {@link ProjectSettings.physics/2d/defaultGravity} project setting and/or any additional gravity vector applied by {@link Area2D}s.
+     */
+    get gravityScale(): number { return _C(this, 4976) as number; }
+    set gravityScale(v: number) { _C(this, 11559, v); }
+
+    /**
+     * Defines the way the body's center of mass is set.
+     */
+    get centerOfMassMode(): CenterOfMassMode { return _C(this, 4128) as CenterOfMassMode; }
+    set centerOfMassMode(v: CenterOfMassMode) { _C(this, 10841, v); }
+
+    /**
+     * The body's custom center of mass, relative to the body's origin position, when {@link centerOfMassMode} is set to {@link CENTER_OF_MASS_MODE_CUSTOM}. This is the balanced point of the body, where applied forces only cause linear acceleration. Applying forces outside of the center of mass causes angular acceleration.
+     * When {@link centerOfMassMode} is set to {@link CENTER_OF_MASS_MODE_AUTO} (default value), the center of mass is automatically determined, but this does not update the value of {@link centerOfMass}.
+     */
+    get centerOfMass(): Vector2 { return _C(this, 4126) as Vector2; }
+    set centerOfMass(v: Vector2) { _C(this, 10840, v); }
+
+    /**
+     * The body's moment of inertia. This is like mass, but for rotation: it determines how much torque it takes to rotate the body. The moment of inertia is usually computed automatically from the mass and the shapes, but this property allows you to set a custom value.
+     * If set to `0`, inertia is automatically computed (default value).
+     * **Note:** This value does not change when inertia is automatically computed. Use {@link PhysicsServer2D} to get the computed inertia.
+     *
+     *
+     * ```gdscript
+     *
+     * @onready var ball = $Ball
+     *
+     * func get_ball_inertia():
+     * 	return 1.0 / PhysicsServer2D.body_get_direct_state(ball.get_rid()).inverse_inertia
+     *
+     * ```
+     */
+    get inertia(): number { return _C(this, 5092) as number; }
+    set inertia(v: number) { _C(this, 11694, v); }
+
+    /**
+     * If `true`, the body will not move and will not calculate forces until woken up by another body through, for example, a collision, or by using the {@link applyImpulse} or {@link applyForce} methods.
+     */
+    get sleeping(): boolean { return _C(this, 8319) as boolean; }
+    set sleeping(v: boolean) { _C(this, 12778, v); }
+
+    /**
+     * If `true`, the body can enter sleep mode when there is no movement. See {@link sleeping}.
+     */
+    get canSleep(): boolean { return _C(this, 7726) as boolean; }
+    set canSleep(v: boolean) { _C(this, 10790, v); }
+
+    /**
+     * If `true`, the body cannot rotate. Gravity and forces only apply linear movement.
+     */
+    get lockRotation(): boolean { return _C(this, 8092) as boolean; }
+    set lockRotation(v: boolean) { _C(this, 11946, v); }
+
+    /**
+     * If `true`, the body is frozen. Gravity and forces are not applied anymore.
+     * See {@link freezeMode} to set the body's behavior when frozen.
+     * **Note:** For a body that is always frozen, use {@link StaticBody2D} or {@link AnimatableBody2D} instead.
+     */
+    get freeze(): boolean { return _C(this, 7972) as boolean; }
+    set freeze(v: boolean) { _C(this, 11487, v); }
+
+    /**
+     * The body's freeze mode. Determines the body's behavior when {@link freeze} is `true`.
+     * **Note:** For a body that is always frozen, use {@link StaticBody2D} or {@link AnimatableBody2D} instead.
+     */
+    get freezeMode(): FreezeMode { return _C(this, 4895) as FreezeMode; }
+    set freezeMode(v: FreezeMode) { _C(this, 11488, v); }
+
+    /**
+     * If `true`, the standard force integration (like gravity or damping) will be disabled for this body. Other than collision response, the body will only move as determined by the {@link _integrateForces} method, if that virtual method is overridden.
+     * Setting this property will call the method {@link PhysicsServer2D.bodySetOmitForceIntegration} internally.
+     */
+    get customIntegrator(): boolean { return _C(this, 8399) as boolean; }
+    set customIntegrator(v: boolean) { _C(this, 13205, v); }
+
+    /**
+     * Continuous collision detection mode.
+     * Continuous collision detection tries to predict where a moving body will collide instead of moving it and correcting its movement after collision. Continuous collision detection is slower, but more precise and misses fewer collisions with small, fast-moving objects. Raycasting and shapecasting methods are available.
+     */
+    get continuousCd(): CCDMode { return _C(this, 4319) as CCDMode; }
+    set continuousCd(v: CCDMode) { _C(this, 10960, v); }
+
+    /**
+     * If `true`, the RigidBody2D will emit signals when it collides with another body.
+     * **Note:** By default the maximum contacts reported is set to 0, meaning nothing will be recorded, see {@link maxContactsReported}.
+     */
+    get contactMonitor(): boolean { return _C(this, 7859) as boolean; }
+    set contactMonitor(v: boolean) { _C(this, 10951, v); }
+
+    /**
+     * The maximum number of contacts that will be recorded. Requires a value greater than 0 and {@link contactMonitor} to be set to `true` to start to register contacts. Use {@link getContactCount} to retrieve the count or {@link getCollidingBodies} to retrieve bodies that have been collided with.
+     * **Note:** The number of contacts is different from the number of collisions. Collisions between parallel edges will result in two contacts (one at each end), and collisions between parallel faces will result in four contacts (one at each corner).
+     */
+    get maxContactsReported(): number { return _C(this, 5463) as number; }
+    set maxContactsReported(v: number) { _C(this, 11988, v); }
+
+    /**
+     * The body's linear velocity in pixels per second. Can be used sporadically, but **don't set this every frame**, because physics may run in another thread and runs at a different granularity. Use {@link _integrateForces} as your process loop for precise control of the body state.
+     */
+    get linearVelocity(): Vector2 { return _C(this, 5386) as Vector2; }
+    set linearVelocity(v: Vector2) { _C(this, 11935, v); }
+
+    /**
+     * Defines how {@link linearDamp} is applied.
+     */
+    get linearDampMode(): DampMode { return _C(this, 5383) as DampMode; }
+    set linearDampMode(v: DampMode) { _C(this, 11932, v); }
+
+    /**
+     * Damps the body's movement. By default, the body will use the {@link ProjectSettings.physics/2d/defaultLinearDamp} setting or any value override set by an {@link Area2D} the body is in. Depending on {@link linearDampMode}, you can set {@link linearDamp} to be added to or to replace the body's damping value.
+     * See {@link ProjectSettings.physics/2d/defaultLinearDamp} for more details about damping.
+     */
+    get linearDamp(): number { return _C(this, 5382) as number; }
+    set linearDamp(v: number) { _C(this, 11931, v); }
+
+    /**
+     * The body's rotational velocity in *radians* per second.
+     */
+    get angularVelocity(): number { return _C(this, 3757) as number; }
+    set angularVelocity(v: number) { _C(this, 10500, v); }
+
+    /**
+     * Defines how {@link angularDamp} is applied.
+     */
+    get angularDampMode(): DampMode { return _C(this, 3752) as DampMode; }
+    set angularDampMode(v: DampMode) { _C(this, 10494, v); }
+
+    /**
+     * Damps the body's rotation. By default, the body will use the {@link ProjectSettings.physics/2d/defaultAngularDamp} setting or any value override set by an {@link Area2D} the body is in. Depending on {@link angularDampMode}, you can set {@link angularDamp} to be added to or to replace the body's damping value.
+     * See {@link ProjectSettings.physics/2d/defaultAngularDamp} for more details about damping.
+     */
+    get angularDamp(): number { return _C(this, 3751) as number; }
+    set angularDamp(v: number) { _C(this, 10493, v); }
+
+    /**
+     * The body's total constant positional forces applied during each physics update.
+     * See {@link addConstantForce} and {@link addConstantCentralForce}.
+     */
+    get constantForce(): Vector2 { return _C(this, 4285) as Vector2; }
+    set constantForce(v: Vector2) { _C(this, 10944, v); }
+
+    /**
+     * The body's total constant rotational forces applied during each physics update.
+     * See {@link addConstantTorque}.
+     */
+    get constantTorque(): number { return _C(this, 4289) as number; }
+    set constantTorque(v: number) { _C(this, 10947, v); }
+
+    /**
+     * Emitted when one of this RigidBody2D's {@link Shape2D}s collides with another {@link PhysicsBody2D} or {@link TileMap}'s {@link Shape2D}s. Requires {@link contactMonitor} to be set to `true` and {@link maxContactsReported} to be set high enough to detect all the collisions. {@link TileMap}s are detected if the {@link TileSet} has Collision {@link Shape2D}s.
+     * `bodyRid` the {@link RID} of the other {@link PhysicsBody2D} or {@link TileSet}'s {@link CollisionObject2D} used by the {@link PhysicsServer2D}.
+     * `body` the {@link Node}, if it exists in the tree, of the other {@link PhysicsBody2D} or {@link TileMap}.
+     * `bodyShapeIndex` the index of the {@link Shape2D} of the other {@link PhysicsBody2D} or {@link TileMap} used by the {@link PhysicsServer2D}. Get the {@link CollisionShape2D} node with `body.shape_owner_get_owner(body.shape_find_owner(body_shape_index))`.
+     * `localShapeIndex` the index of the {@link Shape2D} of this RigidBody2D used by the {@link PhysicsServer2D}. Get the {@link CollisionShape2D} node with `self.shape_owner_get_owner(self.shape_find_owner(local_shape_index))`.
+     */
+    get bodyShapeEntered(): Signal<(bodyRid: RID, body: Node, bodyShapeIndex: number, localShapeIndex: number) => void> { return _G(this, 1869) as Signal<(bodyRid: RID, body: Node, bodyShapeIndex: number, localShapeIndex: number) => void>; }
+    set bodyShapeEntered(v: ((bodyRid: RID, body: Node, bodyShapeIndex: number, localShapeIndex: number) => void) | null) { _G(this, 1869, v); }
+
+    /**
+     * Emitted when the collision between one of this RigidBody2D's {@link Shape2D}s and another {@link PhysicsBody2D} or {@link TileMap}'s {@link Shape2D}s ends. Requires {@link contactMonitor} to be set to `true` and {@link maxContactsReported} to be set high enough to detect all the collisions. {@link TileMap}s are detected if the {@link TileSet} has Collision {@link Shape2D}s.
+     * `bodyRid` the {@link RID} of the other {@link PhysicsBody2D} or {@link TileSet}'s {@link CollisionObject2D} used by the {@link PhysicsServer2D}.
+     * `body` the {@link Node}, if it exists in the tree, of the other {@link PhysicsBody2D} or {@link TileMap}.
+     * `bodyShapeIndex` the index of the {@link Shape2D} of the other {@link PhysicsBody2D} or {@link TileMap} used by the {@link PhysicsServer2D}. Get the {@link CollisionShape2D} node with `body.shape_owner_get_owner(body.shape_find_owner(body_shape_index))`.
+     * `localShapeIndex` the index of the {@link Shape2D} of this RigidBody2D used by the {@link PhysicsServer2D}. Get the {@link CollisionShape2D} node with `self.shape_owner_get_owner(self.shape_find_owner(local_shape_index))`.
+     */
+    get bodyShapeExited(): Signal<(bodyRid: RID, body: Node, bodyShapeIndex: number, localShapeIndex: number) => void> { return _G(this, 1870) as Signal<(bodyRid: RID, body: Node, bodyShapeIndex: number, localShapeIndex: number) => void>; }
+    set bodyShapeExited(v: ((bodyRid: RID, body: Node, bodyShapeIndex: number, localShapeIndex: number) => void) | null) { _G(this, 1870, v); }
+
+    /**
+     * Emitted when a collision with another {@link PhysicsBody2D} or {@link TileMap} occurs. Requires {@link contactMonitor} to be set to `true` and {@link maxContactsReported} to be set high enough to detect all the collisions. {@link TileMap}s are detected if the {@link TileSet} has Collision {@link Shape2D}s.
+     * `body` the {@link Node}, if it exists in the tree, of the other {@link PhysicsBody2D} or {@link TileMap}.
+     */
+    get bodyEntered(): Signal<(body: Node) => void> { return _G(this, 1820) as Signal<(body: Node) => void>; }
+    set bodyEntered(v: ((body: Node) => void) | null) { _G(this, 1820, v); }
+
+    /**
+     * Emitted when the collision with another {@link PhysicsBody2D} or {@link TileMap} ends. Requires {@link contactMonitor} to be set to `true` and {@link maxContactsReported} to be set high enough to detect all the collisions. {@link TileMap}s are detected if the {@link TileSet} has Collision {@link Shape2D}s.
+     * `body` the {@link Node}, if it exists in the tree, of the other {@link PhysicsBody2D} or {@link TileMap}.
+     */
+    get bodyExited(): Signal<(body: Node) => void> { return _G(this, 1821) as Signal<(body: Node) => void>; }
+    set bodyExited(v: ((body: Node) => void) | null) { _G(this, 1821, v); }
+
+    /**
+     * Emitted when the physics engine changes the body's sleeping state.
+     * **Note:** Changing the value {@link sleeping} will not trigger this signal. It is only emitted if the sleeping state is changed by the physics engine or `emit_signal("sleeping_state_changed")` is used.
+     */
+    get sleepingStateChanged(): Signal<() => void> { return _G(this, 13655) as Signal<() => void>; }
+    set sleepingStateChanged(v: (() => void) | null) { _G(this, 13655, v); }
+
+    static readonly name = _R(671, RigidBody2D);
+}
+
+export const FreezeMode = {
+    /**
+     * Static body freeze mode (default). The body is not affected by gravity and forces. It can be only moved by user code and doesn't collide with other bodies along its path.
+     */
+    FREEZE_MODE_STATIC: 0,
+    /**
+     * Kinematic body freeze mode. Similar to {@link FREEZE_MODE_STATIC}, but collides with other bodies along its path when moved. Useful for a frozen body that needs to be animated.
+     */
+    FREEZE_MODE_KINEMATIC: 1,
+} as const;
+
+export type FreezeMode = (typeof FreezeMode)[keyof typeof FreezeMode];
+
+export const CenterOfMassMode = {
+    /**
+     * In this mode, the body's center of mass is calculated automatically based on its shapes. This assumes that the shapes' origins are also their center of mass.
+     */
+    CENTER_OF_MASS_MODE_AUTO: 0,
+    /**
+     * In this mode, the body's center of mass is set through {@link centerOfMass}. Defaults to the body's origin position.
+     */
+    CENTER_OF_MASS_MODE_CUSTOM: 1,
+} as const;
+
+export type CenterOfMassMode = (typeof CenterOfMassMode)[keyof typeof CenterOfMassMode];
+
+export const DampMode = {
+    /**
+     * In this mode, the body's damping value is added to any value set in areas or the default value.
+     */
+    DAMP_MODE_COMBINE: 0,
+    /**
+     * In this mode, the body's damping value replaces any value set in areas or the default value.
+     */
+    DAMP_MODE_REPLACE: 1,
+} as const;
+
+export type DampMode = (typeof DampMode)[keyof typeof DampMode];
+
+export const CCDMode = {
+    /**
+     * Continuous collision detection disabled. This is the fastest way to detect body collisions, but can miss small, fast-moving objects.
+     */
+    CCD_MODE_DISABLED: 0,
+    /**
+     * Continuous collision detection enabled using raycasting. This is faster than shapecasting but less precise.
+     */
+    CCD_MODE_CAST_RAY: 1,
+    /**
+     * Continuous collision detection enabled using shapecasting. This is the slowest CCD method and the most precise.
+     */
+    CCD_MODE_CAST_SHAPE: 2,
+} as const;
+
+export type CCDMode = (typeof CCDMode)[keyof typeof CCDMode];
+