@defold-typescript/types 0.39.0 → 0.41.0

package/generated/versions/defold-1.13.1/b2d_chain.d.ts

@@ -0,0 +1,106 @@
+/** @noSelfInFile */
+import type { Opaque } from "../../../src/core-types";
+
+declare global {
+  /**
+   * Functions for Box2D v3 chains. A chain owns multiple connected segment
+   * shapes, so it is represented by a separate `b2Chain` handle.
+   */
+  namespace b2d.chain {
+    type b2Chain = Opaque<"b2Chain">;
+    /**
+     * Destroying a chain removes all segment shapes owned by the chain. Destroying
+     * any segment shape through `b2d.body.destroy_shape` also destroys its parent chain.
+     *
+     * @param chain - chain
+     */
+    function destroy(chain: Opaque<"b2Chain">): void;
+    /**
+     * Returns `nil` if the shape is not a chain segment.
+     *
+     * @param shape_id - shape handle from a shape info table, or pass `body, shape_index`
+     * @returns parent chain, or `nil` if the shape is not a chain segment
+     */
+    function from_shape(shape_id: Opaque<"b2Shape">): Opaque<"b2Chain"> | undefined;
+    /**
+     * Get chain friction.
+     *
+     * @param chain - chain
+     * @returns chain friction
+     */
+    function get_friction(chain: Opaque<"b2Chain">): number;
+    /**
+     * Returns a chain geometry table with `loop`, `segment_count`, and `vertices`.
+     * Open chains also include `prev_vertex` and `next_vertex` ghost vertices.
+     *
+     * @param chain - chain
+     * @returns chain geometry table
+     */
+    function get_geometry(chain: Opaque<"b2Chain">): Record<string | number, unknown>;
+    /**
+     * Get chain material id.
+     *
+     * @param chain - chain
+     * @returns chain material id
+     */
+    function get_material(chain: Opaque<"b2Chain">): number;
+    /**
+     * Get chain restitution.
+     *
+     * @param chain - chain
+     * @returns chain restitution
+     */
+    function get_restitution(chain: Opaque<"b2Chain">): number;
+    /**
+     * Get the number of segment shapes in a chain.
+     *
+     * @param chain - chain
+     * @returns segment count
+     */
+    function get_segment_count(chain: Opaque<"b2Chain">): number;
+    /**
+     * Get the segment shapes owned by a chain.
+     *
+     * @param chain - chain
+     * @returns array of shape info tables for the chain segments. Each entry includes `shape_id`.
+     */
+    function get_segments(chain: Opaque<"b2Chain">): { shape_id: number }[];
+    /**
+     * Get the world owning a chain.
+     *
+     * @param chain - chain
+     * @returns owning world
+     */
+    function get_world(chain: Opaque<"b2Chain">): Opaque<"b2World">;
+    /**
+     * Validate a chain handle.
+     *
+     * @param chain - chain
+     * @returns true if the chain handle still refers to a live Box2D chain
+     */
+    function is_valid(chain: Opaque<"b2Chain">): boolean;
+    /**
+     * Set chain friction.
+     *
+     * @param chain - chain
+     * @param friction - chain friction
+     */
+    function set_friction(chain: Opaque<"b2Chain">, friction: number): void;
+    /**
+     * Set chain material id.
+     *
+     * @param chain - chain
+     * @param material - chain material id
+     */
+    function set_material(chain: Opaque<"b2Chain">, material: number): void;
+    /**
+     * Set chain restitution.
+     *
+     * @param chain - chain
+     * @param restitution - chain restitution
+     */
+    function set_restitution(chain: Opaque<"b2Chain">, restitution: number): void;
+  }
+}
+
+export {};

package/generated/versions/defold-1.13.1/b2d_fixture.d.ts

@@ -0,0 +1,157 @@
+/** @noSelfInFile */
+import type { Opaque, Vector3 } from "../../../src/core-types";
+
+declare global {
+  /**
+   * Functions for interacting with fixtures attached to Box2D bodies.
+   * Fixtures are addressed functionally by `(body, fixture_index)` rather than persistent Lua handles.
+   */
+  namespace b2d.fixture {
+    /**
+     * Get fixture AABB for a child shape.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param child_index - 1-based child shape index. **⚠️ 1-based; passed to Defold unchanged.**
+     * @returns table with `lower` and `upper`
+     */
+    function get_aabb(body: Opaque<"b2Body">, fixture_index: number, child_index: number): { lower: Vector3; upper: Vector3 };
+    /**
+     * Get fixture density.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @returns density in kg/m^2
+     */
+    function get_density(body: Opaque<"b2Body">, fixture_index: number): number;
+    /**
+     * Get fixture filter data for a child shape.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param child_index - 1-based child shape index. **⚠️ 1-based; passed to Defold unchanged.**
+     * @returns table with `category_bits`, `mask_bits`, and `group_index`
+     */
+    function get_filter_data(body: Opaque<"b2Body">, fixture_index: number, child_index: number): { category_bits: number; mask_bits: number; group_index: number };
+    /**
+     * Get fixture friction.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     */
+    function get_friction(body: Opaque<"b2Body">, fixture_index: number): number;
+    /**
+     * Get fixture restitution.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     */
+    function get_restitution(body: Opaque<"b2Body">, fixture_index: number): number;
+    /**
+     * Get the fixture shape as a functional shape table.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @returns shape table with numeric `type` from `b2d.shape.SHAPE_TYPE_*`,
+     * suitable for reuse in `b2d.body.create_fixture`.
+     * Circle shapes use `radius` and `center`, edge shapes use `v1`, `v2`, optional `v0`, `v3`,
+     * polygon shapes use `vertices`, and chain shapes use `vertices`, `loop`, optional `prev_vertex`, and `next_vertex`.
+     * Any angle values are in radians.
+     */
+    function get_shape(body: Opaque<"b2Body">, fixture_index: number): { type: number; radius?: number; center?: Vector3; v0?: Vector3; v1?: Vector3; v2?: Vector3; v3?: Vector3; vertices?: Vector3[]; hx?: number; hy?: number; angle?: number; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3; center1?: Vector3; center2?: Vector3 };
+    /**
+     * Get the fixture type.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     */
+    function get_type(body: Opaque<"b2Body">, fixture_index: number): number;
+    /**
+     * Check if a fixture is a sensor.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     */
+    function is_sensor(body: Opaque<"b2Body">, fixture_index: number): boolean;
+    /**
+     * Refilter a fixture.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param touch_proxies - if true, touch broad-phase proxies
+     */
+    function refilter(body: Opaque<"b2Body">, fixture_index: number, touch_proxies: boolean): void;
+    /**
+     * Set fixture density.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param density - density in kg/m^2
+     * @param update_mass - if true, reset body mass data after the change
+     */
+    function set_density(body: Opaque<"b2Body">, fixture_index: number, density: number, update_mass?: boolean): void;
+    /**
+     * Set fixture filter data for a child shape.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param child_index - 1-based child shape index. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param filter - table with `category_bits`, `mask_bits`, and `group_index`
+     */
+    function set_filter_data(body: Opaque<"b2Body">, fixture_index: number, child_index: number, filter: { category_bits: number; mask_bits: number; group_index: number }): void;
+    /**
+     * Set fixture friction.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     */
+    function set_friction(body: Opaque<"b2Body">, fixture_index: number, friction: number): void;
+    /**
+     * Set fixture restitution.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     */
+    function set_restitution(body: Opaque<"b2Body">, fixture_index: number, restitution: number): void;
+    /**
+     * Set sensor mode for a fixture.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     */
+    function set_sensor(body: Opaque<"b2Body">, fixture_index: number, enabled: boolean): void;
+    /**
+     * This updates the existing Box2D v2 shape using the same table format as
+     * `b2d.body.create_fixture` and `b2d.fixture.get_shape`.
+     * The shape type must match the current fixture shape type. Polygon updates must
+     * keep the same vertex count. Chain shape geometry cannot be updated in-place.
+     * The body mass is not updated unless `update_mass` is true.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param shape - shape table with numeric `type` from `b2d.shape.SHAPE_TYPE_*`
+     * @param update_mass - if true, reset body mass data after the change
+     * @example
+     * ```ts
+     * const body = b2d.get_body("#collisionobject");
+     * if (body !== undefined) {
+     *   const circle = b2d.fixture.get_shape(body, 1);
+     *   const radius = "radius" in circle ? circle.radius : undefined;
+     *   b2d.fixture.set_shape(body, 1, { type: b2d.shape.SHAPE_TYPE_CIRCLE, radius: radius ?? 16, center: vmath.vector3(24, 0, 0) }, true);
+     *   b2d.fixture.set_shape(body, 2, { type: b2d.shape.SHAPE_TYPE_EDGE, v1: vmath.vector3(-32, 0, 0), v2: vmath.vector3(32, 0, 0) });
+     * }
+     * ```
+     */
+    function set_shape(body: Opaque<"b2Body">, fixture_index: number, shape: { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; hx: number; hy: number; center?: Vector3; angle?: number } | { type: typeof b2d.shape.SHAPE_TYPE_POLYGON | typeof b2d.shape.SHAPE_TYPE_BOX; vertices: Vector3[] } | { type: typeof b2d.shape.SHAPE_TYPE_CIRCLE; radius: number; center?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_EDGE; v1: Vector3; v2: Vector3; v0?: Vector3; v3?: Vector3 } | { type: typeof b2d.shape.SHAPE_TYPE_CHAIN; vertices: Vector3[]; loop?: boolean; prev_vertex?: Vector3; next_vertex?: Vector3 }, update_mass?: boolean): void;
+    /**
+     * Test a point against a fixture.
+     *
+     * @param body - body
+     * @param fixture_index - 1-based fixture index from `b2d.body.get_fixtures`. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param point - point in world coordinates
+     */
+    function test_point(body: Opaque<"b2Body">, fixture_index: number, point: Vector3): boolean;
+  }
+}
+
+export {};