@defold-typescript/types 0.37.0 → 0.39.0

package/generated/sys.d.ts

@@ -1,5 +1,5 @@
 /** @noSelfInFile */
-import type { Opaque } from "../src/core-types";
+import type { Hash, Opaque } from "../src/core-types";
 
 declare global {
   /**
@@ -7,6 +7,7 @@ declare global {
    * error handling and debugging.
    */
   namespace sys {
+    type NetworkConnectivity = typeof sys.NETWORK_DISCONNECTED | typeof sys.NETWORK_CONNECTED_CELLULAR | typeof sys.NETWORK_CONNECTED;
     /**
      * network connected through other, non cellular, connection
      */
@@ -39,6 +40,7 @@ declare global {
      * @example
      * ```ts
      * // Deserialize a table that was previously serialized:
+     * const my_table = { score: 100, level: 3 };
      * const buffer = sys.serialize(my_table);
      * const table = sys.deserialize(buffer);
      * ```
@@ -53,6 +55,7 @@ declare global {
      * @example
      * ```ts
      * // Load data but return nil if path didn't exist
+     * const path = "/save/game.dat";
      * if (!sys.exists(path)) {
      *   return undefined;
      * }
@@ -228,7 +231,7 @@ declare global {
      * }
      * ```
      */
-    function get_connectivity(): number & { readonly __brand: "sys.NETWORK_DISCONNECTED" } | number & { readonly __brand: "sys.NETWORK_CONNECTED_CELLULAR" } | number & { readonly __brand: "sys.NETWORK_CONNECTED" };
+    function get_connectivity(): sys.NetworkConnectivity;
     /**
      * Returns a table with engine information.
      *
@@ -259,6 +262,7 @@ declare global {
      * @example
      * ```ts
      * // Save data on the host
+     * const mytable = { score: 100, level: 3 };
      * const host_path = sys.get_host_path("logs/test.txt");
      * sys.save(host_path, mytable);
      *
@@ -443,21 +447,23 @@ declare global {
      * @example
      * ```ts
      * // Load binary data from a custom project resource and update a texture resource:
-     * function my_callback(self, request_id, result) {
-     *   if (result.status === resource.REQUEST_STATUS_FINISHED) {
-     *     resource.set_texture("/my_texture", {}, result.buf); // texture args
+     * function my_callback(self: unknown, request_id: unknown, result: unknown) {
+     *   const { status, buf } = result as { status: number; buf: Opaque<"buffer"> };
+     *   if (status === resource.REQUEST_STATUS_FINISHED) {
+     *     resource.set_texture("/my_texture", {}, buf); // texture args
      *   }
      * }
      *
      * const my_request = sys.load_buffer_async("/assets/my_level_data.bin", my_callback);
      *
      * // Load binary data from non-custom resource files on disk:
-     * function my_callback(self, request_id, result) {
-     *   if (result.status !== sys.REQUEST_STATUS_FINISHED) {
+     * function my_callback(self: unknown, request_id: unknown, result: unknown) {
+     *   const { first_asset, second_asset } = self as { first_asset: Hash; second_asset: Hash };
+     *   if ((result as { status: number }).status !== sys.REQUEST_STATUS_FINISHED) {
      *     // uh oh! File could not be found, do something graceful
-     *   } else if (request_id === self.first_asset) {
+     *   } else if (request_id === first_asset) {
      *     // result.buffer contains data from my_level_asset.bin
-     *   } else if (request_id === self.second_asset) {
+     *   } else if (request_id === second_asset) {
      *     // result.buffer contains data from 'my_level.bin'
      *   }
      * }
@@ -623,7 +629,7 @@ declare global {
      * @example
      * ```ts
      * // Install error handler that just prints the errors
-     * function my_error_handler(source, message, traceback) {
+     * function my_error_handler(source: unknown, message: unknown, traceback: unknown) {
      *   print(source); //> lua
      *   print(message); //> main/my.script:10: attempt to perform arithmetic on a string value
      *   print(traceback); //> stack traceback:

package/generated/tilemap.d.ts

@@ -55,8 +55,10 @@ declare global {
      * @returns index of the tile
      * @example
      * ```ts
-     * // get the tile under the player.
-     * const tileno = tilemap.get_tile("/level#tilemap", "foreground", self.player_x, self.player_y);
+     * function tile_under_player(self: { player_x: number; player_y: number }) {
+     *   // get the tile under the player.
+     *   const tileno = tilemap.get_tile("/level#tilemap", "foreground", self.player_x, self.player_y);
+     * }
      * ```
      */
     function get_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number): number;
@@ -74,15 +76,17 @@ declare global {
      * @returns index of the tile
      * @example
      * ```ts
-     * // get the tile under the player.
-     * const tile_info = tilemap.get_tile_info("/level#tilemap", "foreground", self.player_x, self.player_y);
-     * pprint(tile_info);
-     * // {
-     * //    index = 0,
-     * //    h_flip = false,
-     * //    v_flip = true,
-     * //    rotate_90 = false
-     * // }
+     * function tile_info_under_player(self: { player_x: number; player_y: number }) {
+     *   // get the tile under the player.
+     *   const tile_info = tilemap.get_tile_info("/level#tilemap", "foreground", self.player_x, self.player_y);
+     *   pprint(tile_info);
+     *   // {
+     *   //    index = 0,
+     *   //    h_flip = false,
+     *   //    v_flip = true,
+     *   //    rotate_90 = false
+     *   // }
+     * }
      * ```
      */
     function get_tile_info(url: string | Hash | Url, layer: string | Hash, x: number, y: number): { index: number; h_flip: boolean; v_flip: boolean; rotate_90: boolean };
@@ -103,7 +107,7 @@ declare global {
      * let count = 0;
      * for (let row_index = bottom; row_index <= bottom + rows_count - 1; row_index++) {
      *   for (let column_index = left; column_index <= left + columns_count - 1; column_index++) {
-     *     tile = tiles[row_index][column_index];
+     *     tile = tiles.get(row_index)?.get(column_index) ?? 0;
      *     count = count + 1;
      *   }
      * }
@@ -155,14 +159,16 @@ declare global {
      * @param transform_bitmask - optional flip and/or rotation should be applied to the tile
      * @example
      * ```ts
-     * // Clear the tile under the player.
-     * tilemap.set_tile("/level#tilemap", "foreground", self.player_x, self.player_y, 0);
+     * function set_tiles(self: { player_x: number; player_y: number }, x: number, y: number) {
+     *   // Clear the tile under the player.
+     *   tilemap.set_tile("/level#tilemap", "foreground", self.player_x, self.player_y, 0);
      *
-     * // Set tile with different combination of flip and rotation
-     * tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.H_FLIP + tilemap.V_FLIP + tilemap.ROTATE_90);
-     * tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.H_FLIP + tilemap.ROTATE_270);
-     * tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.V_FLIP + tilemap.H_FLIP);
-     * tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.ROTATE_180);
+     *   // Set tile with different combination of flip and rotation
+     *   tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.H_FLIP + tilemap.V_FLIP + tilemap.ROTATE_90);
+     *   tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.H_FLIP + tilemap.ROTATE_270);
+     *   tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.V_FLIP + tilemap.H_FLIP);
+     *   tilemap.set_tile("#tilemap", "layer1", x, y, 0, tilemap.ROTATE_180);
+     * }
      * ```
      */
     function set_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number, tile: number, transform_bitmask?: number): void;

package/generated/timer.d.ts

@@ -20,11 +20,13 @@ declare global {
      * @returns if the timer was active, false if the timer is already cancelled / complete
      * @example
      * ```ts
-     * self.handle = timer.delay(1, true, () => print("print every second"));
-     * // ...
-     * const result = timer.cancel(self.handle);
-     * if (!result) {
-     *   print("the timer is already cancelled");
+     * function cancel_ticking(self: { handle: number }) {
+     *   self.handle = timer.delay(1, true, () => print("print every second"));
+     *   // ...
+     *   const result = timer.cancel(self.handle);
+     *   if (!result) {
+     *     print("the timer is already cancelled");
+     *   }
      * }
      * ```
      */
@@ -54,16 +56,19 @@ declare global {
      * timer.delay(1, false, () => print("print in one second"));
      *
      * // Repetitive timer which canceled after 10 calls
-     * function call_every_second(self, handle, time_elapsed) {
-     *   self.counter = self.counter + 1;
-     *   print("Call #", self.counter);
-     *   if (self.counter === 10) {
-     *     timer.cancel(handle); // cancel timer after 10 calls
+     * function call_every_second(self: unknown, handle: unknown, time_elapsed: unknown) {
+     *   const state = self as { counter: number };
+     *   state.counter = state.counter + 1;
+     *   print("Call #", state.counter);
+     *   if (state.counter === 10) {
+     *     timer.cancel(handle as number); // cancel timer after 10 calls
      *   }
      * }
      *
-     * self.counter = 0;
-     * timer.delay(1, true, call_every_second);
+     * function start_counting(self: { counter: number }) {
+     *   self.counter = 0;
+     *   timer.delay(1, true, call_every_second);
+     * }
      * ```
      */
     function delay(delay: number, repeating: boolean, callback: (self: unknown, handle: unknown, time_elapsed: unknown) => void): number;
@@ -81,13 +86,15 @@ declare global {
      * boolean true = repeat timer until cancel, false = one-shot timer.
      * @example
      * ```ts
-     * self.handle = timer.delay(1, true, () => print("print every second"));
-     * // ...
-     * const result = timer.get_info(self.handle);
-     * if (!result) {
-     *   print("the timer is already cancelled or complete");
-     * } else {
-     *   pprint(result); // delay, time_remaining, repeating
+     * function report_ticking(self: { handle: number }) {
+     *   self.handle = timer.delay(1, true, () => print("print every second"));
+     *   // ...
+     *   const result = timer.get_info(self.handle);
+     *   if (!result) {
+     *     print("the timer is already cancelled or complete");
+     *   } else {
+     *     pprint(result); // delay, time_remaining, repeating
+     *   }
      * }
      * ```
      */
@@ -99,11 +106,13 @@ declare global {
      * @returns if the timer was active, false if the timer is already cancelled / complete
      * @example
      * ```ts
-     * self.handle = timer.delay(1, true, () => print("print every second or manually by timer.trigger"));
-     * // ...
-     * const result = timer.trigger(self.handle);
-     * if (!result) {
-     *   print("the timer is already cancelled or complete");
+     * function trigger_ticking(self: { handle: number }) {
+     *   self.handle = timer.delay(1, true, () => print("print every second or manually by timer.trigger"));
+     *   // ...
+     *   const result = timer.trigger(self.handle);
+     *   if (!result) {
+     *     print("the timer is already cancelled or complete");
+     *   }
      * }
      * ```
      */

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

@@ -6,6 +6,7 @@ declare global {
    * Functions for manipulating buffers and streams
    */
   namespace buffer {
+    type ValueType = typeof buffer.VALUE_TYPE_FLOAT32 | typeof buffer.VALUE_TYPE_INT16 | typeof buffer.VALUE_TYPE_INT32 | typeof buffer.VALUE_TYPE_INT64 | typeof buffer.VALUE_TYPE_INT8 | typeof buffer.VALUE_TYPE_UINT16 | typeof buffer.VALUE_TYPE_UINT32 | typeof buffer.VALUE_TYPE_UINT64 | typeof buffer.VALUE_TYPE_UINT8;
     /**
      * Float, single precision, 4 bytes
      */
@@ -56,11 +57,15 @@ declare global {
      * @example
      * ```ts
      * // How to copy elements (e.g. vertices) from one buffer to another
+     * const element_count = 64;
+     * const srcbuffer = resource.get_buffer("/src.bufferc");
+     * const dstbuffer = resource.get_buffer("/dst.bufferc");
+     *
      * // copy entire buffer
-     * buffer.copy_buffer(dstbuffer, 0, srcbuffer, 0, srcbuffer.length);
+     * buffer.copy_buffer(dstbuffer, 0, srcbuffer, 0, element_count);
      *
      * // copy last 10 elements to the front of another buffer
-     * buffer.copy_buffer(dstbuffer, 0, srcbuffer, srcbuffer.length - 10, 10);
+     * buffer.copy_buffer(dstbuffer, 0, srcbuffer, element_count - 10, 10);
      * ```
      */
     function copy_buffer(dst: Opaque<"buffer">, dstoffset: number, src: Opaque<"buffer">, srcoffset: number, count: number): void;
@@ -77,6 +82,9 @@ declare global {
      * @example
      * ```ts
      * // How to update a texture of a sprite:
+     * const srcbuffer = resource.get_buffer("/src.bufferc");
+     * const dstbuffer = resource.get_buffer("/dst.bufferc");
+     *
      * // copy entire stream
      * const srcstream = buffer.get_stream(srcbuffer, hash("xyz"));
      * const dststream = buffer.get_stream(dstbuffer, hash("xyz"));
@@ -137,12 +145,14 @@ declare global {
      * @example
      * ```ts
      * // How to get a metadata entry from a buffer
+     * const buf = resource.get_buffer("/my.bufferc");
+     *
      * // retrieve a metadata entry named "somefloats" and its numeric type
      * const [values, type] = buffer.get_metadata(buf, hash("somefloats"));
      * if (values) print(`${values.length} values in 'somefloats'`);
      * ```
      */
-    function get_metadata(buf: Opaque<"buffer">, metadata_name: Hash | string): LuaMultiReturn<[number[] | undefined, number & { readonly __brand: "buffer.VALUE_TYPE_FLOAT32" } | number & { readonly __brand: "buffer.VALUE_TYPE_INT16" } | number & { readonly __brand: "buffer.VALUE_TYPE_INT32" } | number & { readonly __brand: "buffer.VALUE_TYPE_INT64" } | number & { readonly __brand: "buffer.VALUE_TYPE_INT8" } | number & { readonly __brand: "buffer.VALUE_TYPE_UINT16" } | number & { readonly __brand: "buffer.VALUE_TYPE_UINT32" } | number & { readonly __brand: "buffer.VALUE_TYPE_UINT64" } | number & { readonly __brand: "buffer.VALUE_TYPE_UINT8" } | undefined]>;
+    function get_metadata(buf: Opaque<"buffer">, metadata_name: Hash | string): LuaMultiReturn<[number[] | undefined, buffer.ValueType | undefined]>;
     /**
      * Get a specified stream from a buffer.
      *
@@ -162,6 +172,8 @@ declare global {
      * @example
      * ```ts
      * // How to set a metadata entry on a buffer
+     * const buf = resource.get_buffer("/my.bufferc");
+     *
      * // create a new metadata entry with three floats
      * buffer.set_metadata(buf, hash("somefloats"), [1.5, 3.2, 7.9], buffer.VALUE_TYPE_FLOAT32);
      * // ...
@@ -169,7 +181,7 @@ declare global {
      * buffer.set_metadata(buf, hash("somefloats"), [-2.5, 10.0, 32.2], buffer.VALUE_TYPE_FLOAT32);
      * ```
      */
-    function set_metadata(buf: Opaque<"buffer">, metadata_name: Hash | string, values: number[], value_type: number & { readonly __brand: "buffer.VALUE_TYPE_FLOAT32" } | number & { readonly __brand: "buffer.VALUE_TYPE_INT16" } | number & { readonly __brand: "buffer.VALUE_TYPE_INT32" } | number & { readonly __brand: "buffer.VALUE_TYPE_INT64" } | number & { readonly __brand: "buffer.VALUE_TYPE_INT8" } | number & { readonly __brand: "buffer.VALUE_TYPE_UINT16" } | number & { readonly __brand: "buffer.VALUE_TYPE_UINT32" } | number & { readonly __brand: "buffer.VALUE_TYPE_UINT64" } | number & { readonly __brand: "buffer.VALUE_TYPE_UINT8" }): void;
+    function set_metadata(buf: Opaque<"buffer">, metadata_name: Hash | string, values: number[], value_type: buffer.ValueType): void;
   }
 }
 

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

@@ -45,6 +45,7 @@ declare global {
      * @returns a table with all camera URLs
      * @example
      * ```ts
+     * const predicate = render.predicate([hash("my_tag")]);
      * for (const camera_id of camera.get_cameras()) {
      *   render.set_camera(camera_id);
      *   render.draw(predicate);

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

@@ -7,6 +7,7 @@ declare global {
    * used to dynamically spawn collections into the runtime.
    */
   namespace collectionfactory {
+    type Status = typeof collectionfactory.STATUS_UNLOADED | typeof collectionfactory.STATUS_LOADING | typeof collectionfactory.STATUS_LOADED;
     /**
      * loaded
      */
@@ -75,7 +76,9 @@ declare global {
      * });
      *
      * // How to delete a spawned collection:
-     * go.delete(self.enemy_ids);
+     * function delete_enemies(self: { enemy_ids: Hash[] }) {
+     *   go.delete(self.enemy_ids);
+     * }
      * ```
      */
     function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: Record<string | number, unknown>, scale?: number | Vector3): LuaMap<Hash, Hash>;
@@ -92,7 +95,7 @@ declare global {
      *
      * - `collectionfactory.STATUS_LOADED`
      */
-    function get_status(url?: string | Hash | Url): number & { readonly __brand: "collectionfactory.STATUS_UNLOADED" } | number & { readonly __brand: "collectionfactory.STATUS_LOADING" } | number & { readonly __brand: "collectionfactory.STATUS_LOADED" };
+    function get_status(url?: string | Hash | Url): collectionfactory.Status;
     /**
      * Resources loaded are referenced by the collection factory component until the existing (parent) collection is destroyed or collectionfactory.unload is called.
      * Calling this function when the factory is not marked as dynamic loading does nothing.

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

@@ -32,7 +32,7 @@ declare global {
      * collection was not excluded.
      * @example
      * ```ts
-     * function print_resources(self, cproxy) {
+     * function print_resources(self: unknown, cproxy: Url) {
      *   const resources = collectionproxy.get_resources(cproxy);
      *   for (const v of resources) {
      *     print(`Resource: ${v}`);

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

@@ -7,6 +7,7 @@ declare global {
    * dynamically spawn game objects into the runtime.
    */
   namespace factory {
+    type Status = typeof factory.STATUS_UNLOADED | typeof factory.STATUS_LOADING | typeof factory.STATUS_LOADED;
     /**
      * loaded
      */
@@ -71,7 +72,7 @@ declare global {
      *
      * - `factory.STATUS_LOADED`
      */
-    function get_status(url?: string | Hash | Url): number & { readonly __brand: "factory.STATUS_UNLOADED" } | number & { readonly __brand: "factory.STATUS_LOADING" } | number & { readonly __brand: "factory.STATUS_LOADED" };
+    function get_status(url?: string | Hash | Url): factory.Status;
     /**
      * Resources are referenced by the factory component until the existing (parent) collection is destroyed or factory.unload is called.
      * Calling this function when the factory is not marked as dynamic loading does nothing.