@defold-typescript/types 0.39.0 → 0.41.0

package/generated/versions/defold-1.12.4/physics.d.ts

@@ -72,7 +72,7 @@ declare global {
      *   init(self) {
      *     let gravity = physics.get_gravity();
      *     // Inverse gravity!
-     *     gravity = -gravity;
+     *     gravity = vmath.vector3(-gravity.x, -gravity.y, -gravity.z);
      *     physics.set_gravity(gravity);
      *   },
      * });
@@ -85,11 +85,12 @@ declare global {
      * @param url - the collision object to return the group of.
      * @returns hash value of the group.
      *
-     * `local function check_is_enemy()
-     * local group = physics.get_group("#collisionobject")
-     * return group == hash("enemy")
-     * end
-     * `
+     * ```ts
+     * function check_is_enemy(): boolean {
+     *   const group = physics.get_group("#collisionobject");
+     *   return group === hash("enemy");
+     * }
+     * ```
      */
     function get_group(url: string | Hash | Url): Hash;
     /**
@@ -132,14 +133,15 @@ declare global {
      * @param group - the name of the group to check for.
      * @returns boolean value of the maskbit. 'true' if present, 'false' otherwise.
      *
-     * `local function is_invincible()
-     * -- check if the collisionobject would collide with the "bullet" group
-     * local invincible = physics.get_maskbit("#collisionobject", "bullet")
-     * return invincible
-     * end
-     * `
+     * ```ts
+     * function is_invincible(): boolean {
+     *   // check if the collisionobject would collide with the "bullet" group
+     *   const invincible = physics.get_maskbit("#collisionobject", "bullet");
+     *   return invincible;
+     * }
+     * ```
      */
-    function get_maskbit(url: string | Hash | Url, group: string): boolean;
+    function get_maskbit(url: string | Hash | Url, group: string | Hash): boolean;
     /**
      * Gets collision shape data from a collision object
      *
@@ -151,11 +153,8 @@ declare global {
      * number The shape type. Supported values:
      *
      * - `physics.SHAPE_TYPE_SPHERE`
-     *
      * - `physics.SHAPE_TYPE_BOX`
-     *
      * - `physics.SHAPE_TYPE_CAPSULE` *Only supported for 3D physics*
-     *
      * - `physics.SHAPE_TYPE_HULL`
      *
      * The returned table contains different fields depending on which type the shape is.
@@ -176,12 +175,13 @@ declare global {
      * `height`
      * number the height of the capsule
      *
-     * `local function get_shape_meta()
-     * local sphere = physics.get_shape("#collisionobject", "my_sphere_shape")
-     * -- returns a table with sphere.diameter
-     * return sphere
-     * end
-     * `
+     * ```ts
+     * function get_shape_meta() {
+     *   const sphere = physics.get_shape("#collisionobject", "my_sphere_shape");
+     *   // returns a table with sphere.diameter
+     *   return sphere;
+     * }
+     * ```
      */
     function get_shape(url: string | Hash | Url, shape: string | Hash): { type: number; diameter?: number; dimensions?: Vector3; height?: number };
     /**
@@ -208,8 +208,8 @@ declare global {
      *
      * // How to perform a ray cast synchronously:
      * export default defineScript({
-     *   init(self) {
-     *     self.groups = [hash("world"), hash("enemy")];
+     *   init() {
+     *     return { groups: [hash("world"), hash("enemy")] };
      *   },
      *
      *   update(self, dt) {
@@ -218,7 +218,8 @@ declare global {
      *     const to = vmath.vector3(from.x, from.y - 100, from.z);
      *     const results = physics.raycast(from, to, self.groups, { all: true });
      *     if (results !== undefined) {
-     *       for (const result of results) {
+     *       // with `all` set, the ray cast returns every hit as a list
+     *       for (const result of Array.isArray(results) ? results : [results]) {
      *         handle_result(result);
      *       }
      *     }
@@ -236,7 +237,6 @@ declare global {
      * The actual ray cast will be performed during the physics-update.
      *
      * - If an object is hit, the result will be reported via a ray_cast_response message.
-     *
      * - If there is no object hit, the result will be reported via a ray_cast_missed message.
      *
      * NOTE: Ray casts will ignore collision objects that contain the starting point of the ray. This is a limitation in Box2D.
@@ -249,8 +249,8 @@ declare global {
      * ```ts
      * // How to perform a ray cast asynchronously:
      * export default defineScript({
-     *   init(self) {
-     *     self.my_groups = [hash("my_group1"), hash("my_group2")];
+     *   init() {
+     *     return { my_groups: [hash("my_group1"), hash("my_group2")] };
      *   },
      *
      *   update(self, dt) {
@@ -283,13 +283,9 @@ declare global {
      * constant The type of event. Can be one of these messages:
      *
      * - contact_point_event
-     *
      * - collision_event
-     *
      * - trigger_event
-     *
      * - ray_cast_response
-     *
      * - ray_cast_missed
      *
      * `data`
@@ -402,12 +398,13 @@ declare global {
      * @param url - the collision object affected.
      * @param group - the new group name to be assigned.
      *
-     * `local function change_collision_group()
-     * physics.set_group("#collisionobject", "enemy")
-     * end
-     * `
+     * ```ts
+     * function change_collision_group() {
+     *   physics.set_group("#collisionobject", "enemy");
+     * }
+     * ```
      */
-    function set_group(url: string | Hash | Url, group: string): void;
+    function set_group(url: string | Hash | Url, group: string | Hash): void;
     /**
      * Flips the collision shapes horizontally for a collision object
      *
@@ -416,9 +413,10 @@ declare global {
      * @example
      * ```ts
      * export default defineScript({
-     *   init(self) {
-     *     self.fliph = true; // set on some condition
-     *     physics.set_hflip("#collisionobject", self.fliph);
+     *   init() {
+     *     const fliph = true; // set on some condition
+     *     physics.set_hflip("#collisionobject", fliph);
+     *     return { fliph };
      *   },
      * });
      * ```
@@ -442,13 +440,14 @@ declare global {
      * @param group - the name of the group (maskbit) to modify in the mask.
      * @param maskbit - boolean value of the new maskbit. 'true' to enable, 'false' to disable.
      *
-     * `local function make_invincible()
-     * -- no longer collide with the "bullet" group
-     * physics.set_maskbit("#collisionobject", "bullet", false)
-     * end
-     * `
+     * ```ts
+     * function make_invincible() {
+     *   // no longer collide with the "bullet" group
+     *   physics.set_maskbit("#collisionobject", "bullet", false);
+     * }
+     * ```
      */
-    function set_maskbit(url: string | Hash | Url, group: string, maskbit: boolean): void;
+    function set_maskbit(url: string | Hash | Url, group: string | Hash, maskbit: boolean): void;
     /**
      * Sets collision shape data for a collision object. Please note that updating data in 3D
      * can be quite costly for box and capsules. Because of the physics engine, the cost
@@ -459,29 +458,30 @@ declare global {
      * @param table - the shape data to update the shape with.
      * See physics.get_shape for a detailed description of each field in the data table.
      *
-     * `local function set_shape_data()
-     * -- set capsule shape data
-     * local data = {}
-     * data.type = physics.SHAPE_TYPE_CAPSULE
-     * data.diameter = 10
-     * data.height = 20
-     * physics.set_shape("#collisionobject", "my_capsule_shape", data)
-     *
-     * -- set sphere shape data
-     * data = {}
-     * data.type = physics.SHAPE_TYPE_SPHERE
-     * data.diameter = 10
-     * physics.set_shape("#collisionobject", "my_sphere_shape", data)
-     *
-     * -- set box shape data
-     * data = {}
-     * data.type = physics.SHAPE_TYPE_BOX
-     * data.dimensions = vmath.vector3(10, 10, 5)
-     * physics.set_shape("#collisionobject", "my_box_shape", data)
-     * end
-     * `
+     * ```ts
+     * function set_shape_data() {
+     *   // set capsule shape data
+     *   physics.set_shape("#collisionobject", "my_capsule_shape", {
+     *     type: physics.SHAPE_TYPE_CAPSULE,
+     *     diameter: 10,
+     *     height: 20,
+     *   });
+     *
+     *   // set sphere shape data
+     *   physics.set_shape("#collisionobject", "my_sphere_shape", {
+     *     type: physics.SHAPE_TYPE_SPHERE,
+     *     diameter: 10,
+     *   });
+     *
+     *   // set box shape data
+     *   physics.set_shape("#collisionobject", "my_box_shape", {
+     *     type: physics.SHAPE_TYPE_BOX,
+     *     dimensions: vmath.vector3(10, 10, 5),
+     *   });
+     * }
+     * ```
      */
-    function set_shape(url: string | Hash | Url, shape: string | Hash, table: { type?: number; diameter?: number; dimensions?: Vector3; height?: number }): void;
+    function set_shape(url: string | Hash | Url, shape: string | Hash, table: { type: typeof physics.SHAPE_TYPE_SPHERE; diameter: number } | { type: typeof physics.SHAPE_TYPE_BOX; dimensions: Vector3 } | { type: typeof physics.SHAPE_TYPE_CAPSULE; diameter: number; height: number }): void;
     /**
      * Flips the collision shapes vertically for a collision object
      *
@@ -490,9 +490,10 @@ declare global {
      * @example
      * ```ts
      * export default defineScript({
-     *   init(self) {
-     *     self.flipv = true; // set on some condition
-     *     physics.set_vflip("#collisionobject", self.flipv);
+     *   init() {
+     *     const flipv = true; // set on some condition
+     *     physics.set_vflip("#collisionobject", flipv);
+     *     return { flipv };
      *   },
      * });
      * ```
@@ -516,12 +517,15 @@ declare global {
      *
      * @param url - the collision object to wake.
      *
-     * `function on_input(self, action_id, action)
-     * if action_id == hash("test") and action.pressed then
-     * physics.wakeup("#collisionobject")
-     * end
-     * end
-     * `
+     * ```ts
+     * export default defineScript({
+     *   on_input(self, action_id, action) {
+     *     if (action_id === hash("test") && action.pressed) {
+     *       physics.wakeup("#collisionobject");
+     *     }
+     *   },
+     * });
+     * ```
      */
     function wakeup(url: string | Hash | Url): void;
     interface properties {
@@ -549,7 +553,7 @@ declare global {
       /**
        * READ ONLY Returns the defined physical mass of the collision object component as a number.
        */
-      mass: number;
+      readonly mass: number;
     }
   }
 }

package/generated/versions/defold-1.12.4/profiler.d.ts

@@ -129,7 +129,7 @@ declare global {
      * ```ts
      * // Show the last recorded frame
      * const recorded_frame_count = profiler.recorded_frame_count();
-     * profiler.view_recorded_frame(recorded_frame_count);
+     * profiler.view_recorded_frame({ frame: recorded_frame_count });
      * ```
      */
     function recorded_frame_count(): number;
@@ -160,11 +160,8 @@ declare global {
      * @param mode - the mode to set the ui profiler in
      *
      * - `profiler.MODE_RUN` This is default mode that continously shows the last frame
-     *
      * - `profiler.MODE_PAUSE` Pauses on the currently displayed frame
-     *
      * - `profiler.MODE_SHOW_PEAK_FRAME` Pauses on the currently displayed frame but shows a new frame if that frame is slower
-     *
      * - `profiler.MODE_RECORD` Records all incoming frames to the recording buffer
      *
      * To stop recording, switch to a different mode such as `MODE_PAUSE` or `MODE_RUN`.
@@ -188,7 +185,6 @@ declare global {
      * @param mode - the view mode to set the ui profiler in
      *
      * - `profiler.VIEW_MODE_FULL` The default mode which displays all the ui profiler details
-     *
      * - `profiler.VIEW_MODE_MINIMIZED` Minimized mode which only shows the top header (fps counters and ui profiler mode)
      * @example
      * ```ts
@@ -224,8 +220,9 @@ declare global {
      * @param frame_index - a table where you specify one of the following parameters:
      *
      * - `distance` The offset from the currently displayed frame (this is truncated between zero and the number of recorded frames)
-     *
      * - `frame` The frame index in the recording buffer (1 is first recorded frame)
+     *
+     * **⚠️ `frame` is 1-based; passed to Defold unchanged.**
      * @example
      * ```ts
      * // Go back one frame