@defold-typescript/types 0.40.0 → 0.41.0

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

@@ -48,7 +48,7 @@ declare global {
      * });
      * ```
      */
-    function set_interaction_listener(callback?: (self: unknown) => void): void;
+    function set_interaction_listener(callback: ((self: unknown) => void) | undefined): void;
   }
 }
 

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

@@ -22,36 +22,23 @@ declare global {
      * table The response data. Contains the fields:
      *
      * - number `status`: the status of the response
-     *
      * - string `response`: the response data (if not saved on disc)
-     *
      * - table `headers`: all the returned headers (if status is 200 or 206)
-     *
      * - string `path`: the stored path (if saved to disc)
-     *
      * - string `error`: if any unforeseen errors occurred (e.g. file I/O)
-     *
      * - number `bytes_received`: the amount of bytes received/sent for a request, only if option `report_progress` is true
-     *
      * - number `bytes_total`: the total amount of bytes for a request, only if option `report_progress` is true
-     *
      * - number `range_start`: the start offset into the requested file
-     *
      * - number `range_end`: the end offset into the requested file (inclusive)
-     *
      * - number `document_size`: the full size of the requested file
      * @param headers - optional table with custom headers
      * @param post_data - optional data to send
      * @param options - optional table with request parameters. Supported entries:
      *
      * - number `timeout`: timeout in seconds
-     *
      * - string `path`: path on disc where to download the file. Only overwrites the path if status is 200. Path should be absolute
-     *
      * - boolean `ignore_cache`: don't return cached data if we get a 304. Not available in HTML5 build
-     *
      * - boolean `chunked_transfer`: use chunked transfer encoding for https requests larger than 16kb. Defaults to true. Not available in HTML5 build
-     *
      * - boolean `report_progress`: when it is true, the amount of bytes sent and/or received for a request will be passed into the callback function
      * @example
      * ```ts

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

@@ -9,19 +9,19 @@ declare global {
     /**
      * luminance image type
      */
-    const TYPE_LUMINANCE: number & { readonly __brand: "image.TYPE_LUMINANCE" };
+    const TYPE_LUMINANCE: string & { readonly __brand: "image.TYPE_LUMINANCE" };
     /**
      * luminance image type
      */
-    const TYPE_LUMINANCE_ALPHA: number & { readonly __brand: "image.TYPE_LUMINANCE_ALPHA" };
+    const TYPE_LUMINANCE_ALPHA: string & { readonly __brand: "image.TYPE_LUMINANCE_ALPHA" };
     /**
      * RGB image type
      */
-    const TYPE_RGB: number & { readonly __brand: "image.TYPE_RGB" };
+    const TYPE_RGB: string & { readonly __brand: "image.TYPE_RGB" };
     /**
      * RGBA image type
      */
-    const TYPE_RGBA: number & { readonly __brand: "image.TYPE_RGBA" };
+    const TYPE_RGBA: string & { readonly __brand: "image.TYPE_RGBA" };
     /**
      * get the header of an .astc buffer
      *
@@ -29,15 +29,10 @@ declare global {
      * @returns header or `nil` if buffer is not a valid .astc. The header has these fields:
      *
      * - number `width`: image width
-     *
      * - number `height`: image height
-     *
      * - number `depth`: image depth
-     *
      * - number `block_size_x`: block size x
-     *
      * - number `block_size_y`: block size y
-     *
      * - number `block_size_z`: block size z
      * @example
      * ```ts
@@ -63,19 +58,12 @@ declare global {
      * @returns object or `nil` if loading fails. The object is a table with the following fields:
      *
      * - number `width`: image width
-     *
      * - number `height`: image height
-     *
      * - constant `type`: image type
-     *
-     * - `image.TYPE_RGB`
-     *
-     * - `image.TYPE_RGBA`
-     *
-     * - `image.TYPE_LUMINANCE`
-     *
-     * - `image.TYPE_LUMINANCE_ALPHA`
-     *
+     *   - `image.TYPE_RGB`
+     *   - `image.TYPE_RGBA`
+     *   - `image.TYPE_LUMINANCE`
+     *   - `image.TYPE_LUMINANCE_ALPHA`
      * - string `buffer`: the raw image data
      * @example
      * ```ts
@@ -103,19 +91,12 @@ declare global {
      * @returns object or `nil` if loading fails. The object is a table with the following fields:
      *
      * - number `width`: image width
-     *
      * - number `height`: image height
-     *
      * - constant `type`: image type
-     *
-     * - `image.TYPE_RGB`
-     *
-     * - `image.TYPE_RGBA`
-     *
-     * - `image.TYPE_LUMINANCE`
-     *
-     * - `image.TYPE_LUMINANCE_ALPHA`
-     *
+     *   - `image.TYPE_RGB`
+     *   - `image.TYPE_RGBA`
+     *   - `image.TYPE_LUMINANCE`
+     *   - `image.TYPE_LUMINANCE_ALPHA`
      * - buffer `buffer`: the script buffer that holds the decompressed image data. See buffer.create how to use the buffer.
      * @example
      * ```ts
@@ -126,12 +107,14 @@ declare global {
      *     response.response !== undefined
      *       ? image.load_buffer(response.response, { flip_vertically: true })
      *       : undefined;
-     *   if (img !== undefined) {
+     *   // the engine registers a texture format only when the driver supports it
+     *   const format = graphics.TEXTURE_FORMAT_RGBA;
+     *   if (img !== undefined && format !== undefined) {
      *     const tparams = {
      *       width: img.width,
      *       height: img.height,
      *       type: graphics.TEXTURE_TYPE_2D,
-     *       format: graphics.TEXTURE_FORMAT_RGBA,
+     *       format,
      *     };
      *
      *     const my_texture_id = resource.create_texture("/my_custom_texture.texturec", tparams, img.buffer);

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

@@ -45,5 +45,6 @@ import "../../../src/go-overloads";
 import "../../../src/component-properties";
 import "../../../src/render-overloads";
 import "../../../src/vmath-overloads";
+import "../../../src/sys-overloads";
 
 export {};

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

@@ -18,8 +18,8 @@ declare global {
      * - boolean `decode_null_as_userdata`: wether to decode a JSON null value as json.null or nil (default is nil)
      * @returns decoded json
      * @example
+     * Converting a string containing JSON data into a Lua table:
      * ```ts
-     * // Converting a string containing JSON data into a table:
      * export default defineScript({
      *   init() {
      *     const jsonstring = '{"persons":[{"name":"John Doe"},{"name":"Darth Vader"}]}';
@@ -27,8 +27,10 @@ declare global {
      *     pprint(data);
      *   },
      * });
-     *
-     * // Results in the following printout:
+     * ```
+     * @example
+     * Results in the following printout:
+     * ```ts
      * // {
      * //   persons = {
      * //     1 = {
@@ -52,8 +54,8 @@ declare global {
      * - string `encode_empty_table_as_object`: wether to encode an empty table as an JSON object or array (default is object)
      * @returns encoded json
      * @example
+     * Convert a lua table to a JSON string:
      * ```ts
-     * // Convert a table to a JSON string:
      * export default defineScript({
      *   init() {
      *     const tbl = {
@@ -63,8 +65,10 @@ declare global {
      *     pprint(jsonstring);
      *   },
      * });
-     *
-     * // Results in the following printout:
+     * ```
+     * @example
+     * Results in the following printout:
+     * ```ts
      * // {"persons":[{"name":"John Doe"},{"name":"Darth Vader"}]}
      * ```
      */

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

@@ -68,10 +68,9 @@ declare global {
        */
       outline: Vector4;
       /**
-       * The scale of the label. The type of the property is number (uniform)
-       * or vector3 (non uniform).
+       * The scale of the label. `go.get` returns and `go.set` takes a vector3; `go.animate` also takes a number, which sets a uniform scale.
        */
-      scale: number | Vector3;
+      scale: Vector3;
       /**
        * The shadow color of the label. The type of the property is vector4.
        */

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

@@ -81,11 +81,13 @@ declare global {
      *
      * @returns Array of mounts
      * @example
+     * Output the current resource mounts
      * ```ts
-     * // Output the current resource mounts
      * pprint("MOUNTS", liveupdate.get_mounts());
-     *
-     * // Give an output like:
+     * ```
+     * @example
+     * Give an output like:
+     * ```ts
      * // DEBUG:SCRIPT: MOUNTS,
      * // {
      * //   1 = {

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

@@ -82,7 +82,7 @@ declare global {
      * });
      * ```
      */
-    function get_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash | Url): boolean;
+    function get_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash): boolean;
     /**
      * Plays an animation on a model component with specified playback
      * mode and parameters.
@@ -94,9 +94,7 @@ declare global {
      * animations that play with the following playback modes:
      *
      * - `go.PLAYBACK_ONCE_FORWARD`
-     *
      * - `go.PLAYBACK_ONCE_BACKWARD`
-     *
      * - `go.PLAYBACK_ONCE_PINGPONG`
      *
      * @param url - the model for which to play the animation
@@ -104,15 +102,10 @@ declare global {
      * @param playback - playback mode of the animation
      *
      * - `go.PLAYBACK_ONCE_FORWARD`
-     *
      * - `go.PLAYBACK_ONCE_BACKWARD`
-     *
      * - `go.PLAYBACK_ONCE_PINGPONG`
-     *
      * - `go.PLAYBACK_LOOP_FORWARD`
-     *
      * - `go.PLAYBACK_LOOP_BACKWARD`
-     *
      * - `go.PLAYBACK_LOOP_PINGPONG`
      * @param play_properties - optional table with properties
      * Play properties table:
@@ -133,7 +126,6 @@ declare global {
      * table Information about the completion:
      *
      * - hash `animation_id` - the animation that was completed.
-     *
      * - constant `playback` - the playback mode for the animation.
      *
      * `sender`
@@ -181,7 +173,7 @@ declare global {
      * });
      * ```
      */
-    function set_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash | Url, enabled: boolean): void;
+    function set_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash, enabled: boolean): void;
     interface properties {
       /**
        * The current animation set on the component. The type of the property is hash.

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

@@ -1,5 +1,5 @@
 /** @noSelfInFile */
-import type { Hash, Url, Vector4 } from "../../../src/core-types";
+import type { Hash, Matrix4, Url, Vector4 } from "../../../src/core-types";
 
 declare global {
   /**
@@ -42,11 +42,8 @@ declare global {
      * constant the new state of the emitter:
      *
      * - `particlefx.EMITTER_STATE_SLEEPING`
-     *
      * - `particlefx.EMITTER_STATE_PRESPAWN`
-     *
      * - `particlefx.EMITTER_STATE_SPAWNING`
-     *
      * - `particlefx.EMITTER_STATE_POSTSPAWN`
      * @example
      * ```ts
@@ -118,7 +115,7 @@ declare global {
      * });
      * ```
      */
-    function set_constant(url: string | Hash | Url, emitter: string | Hash, constant: string | Hash, value: Vector4): void;
+    function set_constant(url: string | Hash | Url, emitter: string | Hash, constant: string | Hash, value: Vector4 | Matrix4): void;
     /**
      * Stops a particle FX component from playing.
      * Stopping a particle FX does not remove already spawned particles.

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

@@ -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 };
     /**
@@ -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.
@@ -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
      *
@@ -443,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
@@ -460,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
      *
@@ -518,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 {
@@ -551,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

@@ -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