@defold-typescript/types 0.39.0 → 0.41.0

package/generated/versions/defold-1.13.0/tilemap.d.ts

@@ -34,6 +34,11 @@ declare global {
      * the bounds are calculated as if all layers were collapsed into one.
      *
      * @param url - the tile map
+     * @returns `[x, y, w, h]`:
+     * - `x` — x coordinate of the bottom left corner. **⚠️ 1-based; passed to Defold unchanged.**
+     * - `y` — y coordinate of the bottom left corner. **⚠️ 1-based; passed to Defold unchanged.**
+     * - `w` — number of columns (width) in the tile map
+     * - `h` — number of rows (height) in the tile map
      * @example
      * ```ts
      * // get the level bounds.
@@ -50,8 +55,8 @@ declare global {
      *
      * @param url - the tile map
      * @param layer - name of the layer for the tile
-     * @param x - x-coordinate of the tile
-     * @param y - y-coordinate of the tile
+     * @param x - x-coordinate of the tile. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param y - y-coordinate of the tile. **⚠️ 1-based; passed to Defold unchanged.**
      * @returns index of the tile
      * @example
      * ```ts
@@ -71,8 +76,8 @@ declare global {
      *
      * @param url - the tile map
      * @param layer - name of the layer for the tile
-     * @param x - x-coordinate of the tile
-     * @param y - y-coordinate of the tile
+     * @param x - x-coordinate of the tile. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param y - y-coordinate of the tile. **⚠️ 1-based; passed to Defold unchanged.**
      * @returns index of the tile
      * @example
      * ```ts
@@ -134,15 +139,17 @@ declare global {
      * above and to the right of origin has coordinates 1,1.
      * Tiles to the left of and below origin are indexed 0, -1, -2 and so forth.
      *
+     * ```text
      * +-------+-------+------+------+
-     * | 0,3 | 1,3 | 2,3 | 3,3 |
+     * |  0,3  |  1,3  | 2,3  | 3,3  |
      * +-------+-------+------+------+
-     * | 0,2 | 1,2 | 2,2 | 3,2 |
+     * |  0,2  |  1,2  | 2,2  | 3,2  |
      * +-------+-------+------+------+
-     * | 0,1 | 1,1 | 2,1 | 3,1 |
+     * |  0,1  |  1,1  | 2,1  | 3,1  |
      * +-------O-------+------+------+
-     * | 0,0 | 1,0 | 2,0 | 3,0 |
+     * |  0,0  |  1,0  | 2,0  | 3,0  |
      * +-------+-------+------+------+
+     * ```
      *
      * The coordinates must be within the bounds of the tile map as it were created.
      * That is, it is not possible to extend the size of a tile map by setting tiles outside the edges.
@@ -153,8 +160,8 @@ declare global {
      *
      * @param url - the tile map
      * @param layer - name of the layer for the tile
-     * @param x - x-coordinate of the tile
-     * @param y - y-coordinate of the tile
+     * @param x - x-coordinate of the tile. **⚠️ 1-based; passed to Defold unchanged.**
+     * @param y - y-coordinate of the tile. **⚠️ 1-based; passed to Defold unchanged.**
      * @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
@@ -171,7 +178,7 @@ declare global {
      * }
      * ```
      */
-    function set_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number, tile: number, transform_bitmask?: number): void;
+    function set_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number, tile: number, transform_bitmask?: number): boolean;
     /**
      * Sets the visibility of the tilemap layer
      *

package/generated/versions/defold-1.13.0/timer.d.ts

@@ -51,11 +51,13 @@ 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
+     * A simple one-shot timer
      * ```ts
-     * // A simple one-shot timer
      * timer.delay(1, false, () => print("print in one second"));
-     *
-     * // Repetitive timer which canceled after 10 calls
+     * ```
+     * @example
+     * Repetitive timer which canceled after 10 calls
+     * ```ts
      * function call_every_second(self: unknown, handle: unknown, time_elapsed: unknown) {
      *   const state = self as { counter: number };
      *   state.counter = state.counter + 1;

package/generated/versions/defold-1.13.0/vmath.d.ts

@@ -49,7 +49,7 @@ declare global {
     function conj(q1: Quaternion): Quaternion;
     /**
      * Given two linearly independent vectors P and Q, the cross product,
-     * P × Q, is a vector that is perpendicular to both P and Q and
+     * P × Q, is a vector that is perpendicular to both P and Q and
      * therefore normal to the plane containing them.
      * If the two vectors have the same direction (or have the exact
      * opposite direction from one another, i.e. are not linearly independent)
@@ -70,13 +70,11 @@ declare global {
     function cross(v1: Vector3, v2: Vector3): Vector3;
     /**
      * The returned value is a scalar defined as:
-     * `P ⋅ Q = |P| |Q| cos θ`
-     * where θ is the angle between the vectors P and Q.
+     * `P ⋅ Q = |P| |Q| cos θ`
+     * where θ is the angle between the vectors P and Q.
      *
      * - If the dot product is positive then the angle between the vectors is below 90 degrees.
-     *
      * - If the dot product is zero the vectors are perpendicular (at right-angles to each other).
-     *
      * - If the dot product is negative then the angle between the vectors is more than 90 degrees.
      *
      * @param v1 - first vector
@@ -437,8 +435,8 @@ declare global {
     /**
      * Calculates the extent the projection of the first vector onto the second.
      * The returned value is a scalar p defined as:
-     * `p = |P| cos θ / |Q|`
-     * where θ is the angle between the vectors P and Q.
+     * `p = |P| cos θ / |Q|`
+     * where θ is the angle between the vectors P and Q.
      *
      * @param v1 - vector to be projected on the second
      * @param v2 - vector onto which the first will be projected, must not have zero length
@@ -643,25 +641,6 @@ declare global {
      * ```
      */
     function rotate(q: Quaternion, v1: Vector3): Vector3;
-    /**
-     * Creates a vector of arbitrary size. The vector is initialized
-     * with numeric values from a table.
-     * The table values are converted to floating point
-     * values. If a value cannot be converted, a 0 is stored in that
-     * value position in the vector.
-     *
-     * @param t - table of numbers
-     * @returns new vector
-     * @example
-     * ```ts
-     * // How to create a vector with custom data to be used for animation easing:
-     * const values = [0, 0.5, 0];
-     * const vec = vmath.vector(values);
-     * print(vec); // => vmath.vector (size: 3)
-     * print(vec[2]); // => 0.5
-     * ```
-     */
-    function vector(t: number[]): Vector;
     /**
      * Creates a new zero vector with all components set to 0.
      *

package/generated/versions/defold-1.13.0/window.d.ts

@@ -53,9 +53,7 @@ declare global {
      * @returns The mode for screen dimming
      *
      * - `window.DIMMING_UNKNOWN`
-     *
      * - `window.DIMMING_ON`
-     *
      * - `window.DIMMING_OFF`
      */
     function get_dim_mode(): window.DimModeState;
@@ -82,19 +80,12 @@ declare global {
      * table table containing these keys:
      *
      * - number `x`
-     *
      * - number `y`
-     *
      * - number `width`
-     *
      * - number `height`
-     *
      * - number `inset_left`
-     *
      * - number `inset_top`
-     *
      * - number `inset_right`
-     *
      * - number `inset_bottom`
      */
     function get_safe_area(): { x: number; y: number; width: number; height: number; inset_left: number; inset_top: number; inset_right: number; inset_bottom: number };
@@ -110,7 +101,6 @@ declare global {
      * @param mode - The mode for screen dimming
      *
      * - `window.DIMMING_ON`
-     *
      * - `window.DIMMING_OFF`
      */
     function set_dim_mode(mode: window.DimModeStateSettable): void;
@@ -125,20 +115,15 @@ declare global {
      * constant The type of event. Can be one of these:
      *
      * - `window.WINDOW_EVENT_FOCUS_LOST`
-     *
      * - `window.WINDOW_EVENT_FOCUS_GAINED`
-     *
      * - `window.WINDOW_EVENT_RESIZED`
-     *
      * - `window.WINDOW_EVENT_ICONIFIED`
-     *
      * - `window.WINDOW_EVENT_DEICONIFIED`
      *
      * `data`
      * table The callback value `data` is a table which currently holds these values
      *
      * - number `width`: The width of a resize event. nil otherwise.
-     *
      * - number `height`: The height of a resize event. nil otherwise.
      * @example
      * ```ts
@@ -163,7 +148,7 @@ declare global {
      * });
      * ```
      */
-    function set_listener(callback?: (self: unknown, event: typeof WINDOW_EVENT_FOCUS_LOST | typeof WINDOW_EVENT_FOCUS_GAINED | typeof WINDOW_EVENT_RESIZED | typeof WINDOW_EVENT_ICONFIED | typeof WINDOW_EVENT_DEICONIFIED, data: Record<string | number, unknown>) => void): void;
+    function set_listener(callback: ((self: unknown, event: (typeof window)[Extract<keyof typeof window, `WINDOW_EVENT_${string}`>], data: Record<string | number, unknown>) => void) | undefined): void;
     /**
      * Set the locking state for current mouse cursor on a PC platform.
      * This function locks or unlocks the mouse cursor to the center point of the window. While the cursor is locked,

package/generated/versions/defold-1.13.1/b2d.d.ts

@@ -0,0 +1,33 @@
+/** @noSelfInFile */
+import type { Hash, Opaque, Url } from "../../../src/core-types";
+
+declare global {
+  /**
+   * Functions for interacting with Box2D.
+   */
+  namespace b2d {
+    type b2Body = Opaque<"b2Body">;
+    type b2World = Opaque<"b2World">;
+    /**
+     * Get the Box2D body from a collision object
+     *
+     * @param url - the url to the game object collision component
+     * @returns the body if successful. Otherwise `nil`.
+     */
+    function get_body(url: string | Hash | Url): Opaque<"b2Body"> | undefined;
+    /**
+     * Get the Box2D version information for the active backend.
+     *
+     * @returns version info with fields `version`, `major`, `middle`, and `minor`
+     */
+    function get_version(): { version: number; major: number; middle: number; minor: number };
+    /**
+     * Get the Box2D world from the current collection
+     *
+     * @returns the world if successful. Otherwise `nil`.
+     */
+    function get_world(): Opaque<"b2World">;
+  }
+}
+
+export {};