@defold-typescript/types 0.5.4 → 0.6.0

package/generated/tilemap.d.ts

@@ -2,6 +2,9 @@
 import type { Hash, Url } from "../src/core-types";
 
 declare global {
+  /**
+   * Functions and messages used to manipulate tile map components.
+   */
   namespace tilemap {
     /**
      * flip tile horizontally
@@ -32,9 +35,9 @@ declare global {
      *
      * @param url - the tile map
      * @example
-     * ```lua
-     * -- get the level bounds.
-     * local x, y, w, h = tilemap.get_bounds("/level#tilemap")
+     * ```ts
+     * // get the level bounds.
+     * const [x, y, w, h] = tilemap.get_bounds("/level#tilemap");
      * ```
      */
     function get_bounds(url: string | Hash | Url): LuaMultiReturn<[number, number, number, number]>;
@@ -51,9 +54,9 @@ declare global {
      * @param y - y-coordinate of the tile
      * @returns index of the tile
      * @example
-     * ```lua
-     * -- get the tile under the player.
-     * local tileno = tilemap.get_tile("/level#tilemap", "foreground", self.player_x, self.player_y)
+     * ```ts
+     * // 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;
@@ -70,19 +73,19 @@ declare global {
      * @param y - y-coordinate of the tile
      * @returns index of the tile
      * @example
-     * ```lua
-     * -- get the tile under the player.
-     * local 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
-     * -- }
+     * ```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 get_tile_info(url: string | Hash | Url, layer: string | Hash, x: number, y: number): Record<string | number, unknown>;
+    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 };
     /**
      * Retrieves all the tiles for the specified layer in the tilemap.
      * It returns a table of rows where the keys are the
@@ -93,19 +96,20 @@ declare global {
      * @param layer - the name of the layer for the tiles
      * @returns a table of rows representing the layer
      * @example
-     * ```lua
-     * local left, bottom, columns_count, rows_count = tilemap.get_bounds("#tilemap")
-     * local tiles = tilemap.get_tiles("#tilemap", "layer")
-     * local tile, count = 0, 0
-     * for row_index = bottom, bottom + rows_count - 1 do
-     *     for column_index = left, left + columns_count - 1 do
-     *         tile = tiles[row_index][column_index]
-     *         count = count + 1
-     *     end
-     * end
+     * ```ts
+     * const [left, bottom, columns_count, rows_count] = tilemap.get_bounds("#tilemap");
+     * const tiles = tilemap.get_tiles("#tilemap", "layer");
+     * let tile = 0;
+     * 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];
+     *     count = count + 1;
+     *   }
+     * }
      * ```
      */
-    function get_tiles(url: string | Hash | Url, layer: string | Hash): Record<string | number, unknown>;
+    function get_tiles(url: string | Hash | Url, layer: string | Hash): LuaMap<number, LuaMap<number, number>>;
     /**
      * Replace a tile in a tile map with a new tile.
      * The coordinates of the tiles are indexed so that the "first" tile just
@@ -134,15 +138,15 @@ declare global {
      * @param tile - index of new tile to set. 0 resets the cell
      * @param transform_bitmask - optional flip and/or rotation should be applied to the tile
      * @example
-     * ```lua
-     * -- Clear the tile under the player.
-     * tilemap.set_tile("/level#tilemap", "foreground", self.player_x, self.player_y, 0)
+     * ```ts
+     * // 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;
@@ -153,9 +157,9 @@ declare global {
      * @param layer - name of the layer for the tile
      * @param visible - should the layer be visible
      * @example
-     * ```lua
-     * -- Disable rendering of the layer
-     * tilemap.set_visible("/level#tilemap", "foreground", false)
+     * ```ts
+     * // Disable rendering of the layer
+     * tilemap.set_visible("/level#tilemap", "foreground", false);
      * ```
      */
     function set_visible(url: string | Hash | Url, layer: string | Hash, visible: boolean): void;

package/generated/timer.d.ts

@@ -1,5 +1,11 @@
 /** @noSelfInFile */
 declare global {
+  /**
+   * Timers allow you to set a delay and a callback to be called when the timer completes.
+   * The timers created with this API are updated with the collection timer where they
+   * are created. If you pause or speed up the collection (using `set_time_step`) it will
+   * also affect the new timer.
+   */
   namespace timer {
     /**
      * Indicates an invalid timer handle
@@ -12,13 +18,13 @@ declare global {
      * @param handle - the timer handle returned by timer.delay()
      * @returns if the timer was active, false if the timer is already cancelled / complete
      * @example
-     * ```lua
-     * self.handle = timer.delay(1, true, function() print("print every second") end)
-     * ...
-     * local result = timer.cancel(self.handle)
-     * if not result then
-     *    print("the timer is already cancelled")
-     * end
+     * ```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(handle: number): boolean;
@@ -41,21 +47,21 @@ declare global {
      * number The elapsed time - on first trigger it is time since timer.delay call, otherwise time since last trigger
      * @returns identifier for the create timer, returns timer.INVALID_TIMER_HANDLE if the timer can not be created
      * @example
-     * ```lua
-     * A simple one-shot timer
-     * timer.delay(1, false, function() print("print in one second") end)
+     * ```ts
+     * // A simple one-shot timer
+     * timer.delay(1, false, () => print("print in one second"));
      *
-     * Repetitive timer which canceled after 10 calls
-     * local function call_every_second(self, handle, time_elapsed)
-     *   self.counter = self.counter + 1
-     *   print("Call #", self.counter)
-     *   if self.counter == 10 then
-     *     timer.cancel(handle) -- cancel timer after 10 calls
-     *   end
-     * end
+     * // 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
+     *   }
+     * }
      *
-     * self.counter = 0
-     * timer.delay(1, true, call_every_second)
+     * 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;
@@ -71,15 +77,15 @@ declare global {
      * `repeating`
      * boolean true = repeat timer until cancel, false = one-shot timer.
      * @example
-     * ```lua
-     * self.handle = timer.delay(1, true, function() print("print every second") end)
-     * ...
-     * local result = timer.get_info(self.handle)
-     * if not result then
-     *    print("the timer is already cancelled or complete")
-     * else
-     *    pprint(result) -- delay, time_remaining, repeating
-     * end
+     * ```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 get_info(handle: number): { time_remaining: number; delay: number; repeating: boolean } | unknown;
@@ -89,13 +95,13 @@ declare global {
      * @param handle - the timer handle returned by timer.delay()
      * @returns if the timer was active, false if the timer is already cancelled / complete
      * @example
-     * ```lua
-     * self.handle = timer.delay(1, true, function() print("print every second or manually by timer.trigger") end)
-     * ...
-     * local result = timer.trigger(self.handle)
-     * if not result then
-     *    print("the timer is already cancelled or complete")
-     * end
+     * ```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(handle: number): boolean;