@defold-typescript/types 0.39.0 → 0.41.0

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

@@ -18,7 +18,9 @@ declare global {
      * const res = html5.run("10 + 20"); // returns the string "30"
      * print(res);
      * const res_num = tonumber(res); // convert to number
-     * print(res_num - 20); // prints 10
+     * if (res_num !== undefined) {
+     *   print(res_num - 20); // prints 10
+     * }
      * ```
      */
     function run(code: string): string;
@@ -46,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

@@ -1,4 +1,6 @@
 /** @noSelfInFile */
+import type { Hash } from "../../../src/core-types";
+
 declare global {
   /**
    * Functions for performing HTTP and HTTPS requests.
@@ -20,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
@@ -65,7 +54,7 @@ declare global {
      *       "http://www.google.com",
      *       "GET",
      *       (self, _id, response) => {
-     *         if (response.bytes_total !== undefined) {
+     *         if (response.bytes_received !== undefined && response.bytes_total !== undefined) {
      *           update_my_progress_bar(self, response.bytes_received / response.bytes_total);
      *         } else {
      *           print(response.status);
@@ -81,7 +70,7 @@ declare global {
      * });
      * ```
      */
-    function request(url: string, method: string, callback: (self: unknown, id: unknown, response: unknown) => void, headers?: LuaMap<string, string>, post_data?: string, options?: { timeout?: number; path?: string; ignore_cache?: boolean; chunked_transfer?: boolean; report_progress?: boolean }): void;
+    function request(url: string, method: string, callback: (self: unknown, id: Hash, response: { status: number; response?: string; headers?: LuaMap<string, string>; path?: string; error?: string; bytes_received?: number; bytes_total?: number; range_start?: number; range_end?: number; document_size?: number }) => void, headers?: LuaMap<string, string> | Record<string, string>, post_data?: string, options?: { timeout?: number; path?: string; ignore_cache?: boolean; chunked_transfer?: boolean; report_progress?: boolean }): void;
   }
 }
 

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,22 +29,19 @@ 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
      * // How to get the block size and dimensions from a .astc file
      * const [s] = sys.load_resource("/assets/cat.astc");
-     * const header = image.get_astc_header(s);
-     * pprint(s);
+     * if (s !== undefined) {
+     *   const header = image.get_astc_header(s);
+     *   pprint(s);
+     * }
      * ```
      */
     function get_astc_header(buffer: string): { width: number; height: number; depth: number; block_size_x: number; block_size_y: number; block_size_z: number } | undefined;
@@ -61,27 +58,22 @@ 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
      * // How to load an image from an URL and create a GUI texture from it:
      * const imgurl = "http://www.site.com/image.png";
      * http.request(imgurl, "GET", (self, id, response) => {
-     *   const img = image.load(response.response);
-     *   const tx = gui.new_texture("image_node", img.width, img.height, img.type, img.buffer);
+     *   const img = response.response !== undefined ? image.load(response.response) : undefined;
+     *   if (img !== undefined) {
+     *     const tx = gui.new_texture("image_node", img.width, img.height, img.type, img.buffer);
+     *   }
      * });
      * ```
      */
@@ -99,36 +91,36 @@ 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
      * // Load an image from an URL as a buffer and create a texture resource from it:
      * const imgurl = "http://www.site.com/image.png";
      * http.request(imgurl, "GET", (self, id, response) => {
-     *   const img = image.load_buffer(response.response, { flip_vertically: true });
-     *   const tparams = {
-     *     width: img.width,
-     *     height: img.height,
-     *     type: graphics.TEXTURE_TYPE_2D,
-     *     format: graphics.TEXTURE_FORMAT_RGBA,
-     *   };
-     *
-     *   const my_texture_id = resource.create_texture("/my_custom_texture.texturec", tparams, img.buffer);
-     *   // Apply the texture to a model
-     *   go.set("/go1#model", "texture0", my_texture_id);
+     *   const img =
+     *     response.response !== undefined
+     *       ? image.load_buffer(response.response, { flip_vertically: true })
+     *       : 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,
+     *     };
+     *
+     *     const my_texture_id = resource.create_texture("/my_custom_texture.texturec", tparams, img.buffer);
+     *     // Apply the texture to a model
+     *     go.set("/go1#model", "texture0", my_texture_id);
+     *   }
      * });
      * ```
      */

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

@@ -42,7 +42,9 @@ import "../../../src/message-guard";
 import "../../../src/window-event-guard";
 import "../../../src/scene-addresses";
 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

@@ -72,16 +72,17 @@ declare global {
      * const game = { data: { weapons: { Sword: { damage: 10 } } } };
      *
      * export default defineScript({
-     *   init(self) {
+     *   init() {
      *     if (model.get_mesh_enabled("#model", "Sword")) {
      *       // set properties specific for the sword
-     *       self.weapon_properties = game.data.weapons["Sword"];
+     *       return { weapon_properties: game.data.weapons["Sword"] };
      *     }
+     *     return { weapon_properties: undefined };
      *   },
      * });
      * ```
      */
-    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.
@@ -93,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
@@ -103,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:
@@ -132,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`
@@ -180,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.
@@ -202,7 +195,35 @@ declare global {
       /**
        * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
        */
-      textureN: Hash;
+      texture0: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture1: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture2: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture3: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture4: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture5: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture6: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture7: 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.