@defold-typescript/types 0.39.0 → 0.41.0

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

@@ -0,0 +1,183 @@
+/** @noSelfInFile */
+declare global {
+  /**
+   * Functions and constants to access the window, window event listeners
+   * and screen dimming.
+   */
+  namespace window {
+    type DimModeState = typeof window.DIMMING_UNKNOWN | typeof window.DIMMING_ON | typeof window.DIMMING_OFF;
+    type DimModeStateSettable = typeof window.DIMMING_ON | typeof window.DIMMING_OFF;
+    /**
+     * Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
+     */
+    const DIMMING_OFF: number & { readonly __brand: "window.DIMMING_OFF" };
+    /**
+     * Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
+     */
+    const DIMMING_ON: number & { readonly __brand: "window.DIMMING_ON" };
+    /**
+     * Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
+     * This mode indicates that the dim mode can't be determined, or that the platform doesn't support dimming.
+     */
+    const DIMMING_UNKNOWN: number & { readonly __brand: "window.DIMMING_UNKNOWN" };
+    /**
+     * This event is sent to a window event listener when the game window or app screen is
+     * restored after being iconified.
+     */
+    const WINDOW_EVENT_DEICONIFIED: number & { readonly __brand: "window.WINDOW_EVENT_DEICONIFIED" };
+    /**
+     * This event is sent to a window event listener when the game window or app screen has
+     * gained focus.
+     * This event is also sent at game startup and the engine gives focus to the game.
+     */
+    const WINDOW_EVENT_FOCUS_GAINED: number & { readonly __brand: "window.WINDOW_EVENT_FOCUS_GAINED" };
+    /**
+     * This event is sent to a window event listener when the game window or app screen has lost focus.
+     */
+    const WINDOW_EVENT_FOCUS_LOST: number & { readonly __brand: "window.WINDOW_EVENT_FOCUS_LOST" };
+    /**
+     * This event is sent to a window event listener when the game window or app screen is
+     * iconified (reduced to an application icon in a toolbar, application tray or similar).
+     */
+    const WINDOW_EVENT_ICONFIED: number & { readonly __brand: "window.WINDOW_EVENT_ICONFIED" };
+    /**
+     * This event is sent to a window event listener when the game window or app screen is resized.
+     * The new size is passed along in the data field to the event listener.
+     */
+    const WINDOW_EVENT_RESIZED: number & { readonly __brand: "window.WINDOW_EVENT_RESIZED" };
+    /**
+     * Returns the current dimming mode set on a mobile device.
+     * The dimming mode specifies whether or not a mobile device should dim the screen after a period without user interaction.
+     * On platforms that does not support dimming, `window.DIMMING_UNKNOWN` is always returned.
+     *
+     * @returns The mode for screen dimming
+     *
+     * - `window.DIMMING_UNKNOWN`
+     * - `window.DIMMING_ON`
+     * - `window.DIMMING_OFF`
+     */
+    function get_dim_mode(): window.DimModeState;
+    /**
+     * This returns the content scale of the current display.
+     *
+     * @returns The display scale
+     */
+    function get_display_scale(): number;
+    /**
+     * This returns the current lock state of the mouse cursor
+     *
+     * @returns The lock state
+     */
+    function get_mouse_lock(): boolean;
+    /**
+     * This returns the safe area rectangle (x, y, width, height) and the inset
+     * values relative to the window edges. On platforms without a safe area,
+     * this returns the full window size and zero insets.
+     *
+     * @returns safe area data
+     *
+     * `safe_area`
+     * 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 };
+    /**
+     * This returns the current window size (width and height).
+     */
+    function get_size(): LuaMultiReturn<[number, number]>;
+    /**
+     * Sets the dimming mode on a mobile device.
+     * The dimming mode specifies whether or not a mobile device should dim the screen after a period without user interaction. The dimming mode will only affect the mobile device while the game is in focus on the device, but not when the game is running in the background.
+     * This function has no effect on platforms that does not support dimming.
+     *
+     * @param mode - The mode for screen dimming
+     *
+     * - `window.DIMMING_ON`
+     * - `window.DIMMING_OFF`
+     */
+    function set_dim_mode(mode: window.DimModeStateSettable): void;
+    /**
+     * Sets a window event listener. Only one window event listener can be set at a time.
+     *
+     * @param callback - A callback which receives info about window events. Pass an empty function or `nil` if you no longer wish to receive callbacks.
+     *
+     * `self`
+     * object The calling script
+     * `event`
+     * 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
+     * function window_callback(self: unknown, event: unknown, data: Record<string | number, unknown>) {
+     *   if (event === window.WINDOW_EVENT_FOCUS_LOST) {
+     *     print("window.WINDOW_EVENT_FOCUS_LOST");
+     *   } else if (event === window.WINDOW_EVENT_FOCUS_GAINED) {
+     *     print("window.WINDOW_EVENT_FOCUS_GAINED");
+     *   } else if (event === window.WINDOW_EVENT_ICONFIED) {
+     *     print("window.WINDOW_EVENT_ICONFIED");
+     *   } else if (event === window.WINDOW_EVENT_DEICONIFIED) {
+     *     print("window.WINDOW_EVENT_DEICONIFIED");
+     *   } else if (event === window.WINDOW_EVENT_RESIZED) {
+     *     print("Window resized: ", data.width, data.height);
+     *   }
+     * }
+     *
+     * export default defineScript({
+     *   init() {
+     *     window.set_listener(window_callback);
+     *   },
+     * });
+     * ```
+     */
+    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,
+     * mouse position updates will still be sent to the scripts as usual.
+     *
+     * @param flag - The lock state for the mouse cursor
+     */
+    function set_mouse_lock(flag: boolean): void;
+    /**
+     * Sets the window position.
+     *
+     * @param x - Horizontal position of window
+     * @param y - Vertical position of window
+     */
+    function set_position(x: number, y: number): void;
+    /**
+     * Sets the window size. Works on desktop platforms only.
+     *
+     * @param width - Width of window
+     * @param height - Height of window
+     */
+    function set_size(width: number, height: number): void;
+    /**
+     * Sets the window title. Works on desktop platforms.
+     *
+     * @param title - The title, encoded as UTF-8
+     */
+    function set_title(title: string): void;
+  }
+}
+
+export {};

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

@@ -0,0 +1,41 @@
+/** @noSelfInFile */
+declare global {
+  /**
+   * Functions for compression and decompression of string buffers.
+   */
+  namespace zlib {
+    /**
+     * A lua error is raised is on error
+     *
+     * @param buf - buffer to deflate
+     * @returns deflated buffer
+     * @example
+     * ```ts
+     * const data = "This is a string with uncompressed data.";
+     * const compressed_data = zlib.deflate(data);
+     * let s = "";
+     * for (const c of compressed_data) {
+     *   s = s + "\\" + c.charCodeAt(0);
+     * }
+     * print(s); //> \120\94\11\201\200\44\86\0\162\68\133\226\146\162 ...
+     * ```
+     */
+    function deflate(buf: string): string;
+    /**
+     * A lua error is raised is on error
+     *
+     * @param buf - buffer to inflate
+     * @returns inflated buffer
+     * @example
+     * ```ts
+     * const data =
+     *   "\x78\x5e\x0b\xc9\xc8\x2c\x56\x00\xa2\x44\x85\xe2\x92\xa2\xcc\xbc\x74\x85\xf2\xcc\x92\x0c\x85\xd2\xbc\xe4\xfc\xdc\x82\xa2\xd4\xe2\xe2\xd4\x14\x85\x94\xc4\x92\x44\x3d\x00\x2c\x43\x0e\xc9";
+     * const uncompressed_data = zlib.inflate(data);
+     * print(uncompressed_data); //> This is a string with uncompressed data.
+     * ```
+     */
+    function inflate(buf: string): string;
+  }
+}
+
+export {};

package/generated/vmath.d.ts

@@ -32,6 +32,7 @@ declare global {
    * : indexed by number 1 to the vector length. Example: `v[3]`
    */
   namespace vmath {
+    type vector = Vector;
     /**
      * Calculates the conjugate of a quaternion. The result is a
      * quaternion with the same magnitudes but with the sign of
@@ -49,7 +50,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 +71,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 +436,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 +642,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/window.d.ts

@@ -5,44 +5,95 @@ declare global {
    * and screen dimming.
    */
   namespace window {
+    /**
+     * Width and height are present for window.WINDOW_EVENT_RESIZED and
+     * absent for other window events.
+     */
+    interface event_data {
+      /**
+       * Window width after a resize.
+       */
+      width?: number;
+      /**
+       * Window height after a resize.
+       */
+      height?: number;
+    }
+    /**
+     * Window safe-area data
+     */
+    interface safe_area {
+      /**
+       * Safe-area x-coordinate.
+       */
+      x: number;
+      /**
+       * Safe-area y-coordinate.
+       */
+      y: number;
+      /**
+       * Safe-area width.
+       */
+      width: number;
+      /**
+       * Safe-area height.
+       */
+      height: number;
+      /**
+       * Inset from the left window edge.
+       */
+      inset_left: number;
+      /**
+       * Inset from the top window edge.
+       */
+      inset_top: number;
+      /**
+       * Inset from the right window edge.
+       */
+      inset_right: number;
+      /**
+       * Inset from the bottom window edge.
+       */
+      inset_bottom: number;
+    }
     type DimModeState = typeof window.DIMMING_UNKNOWN | typeof window.DIMMING_ON | typeof window.DIMMING_OFF;
     type DimModeStateSettable = typeof window.DIMMING_ON | typeof window.DIMMING_OFF;
+    type DIMMING = typeof window.DIMMING_OFF | typeof window.DIMMING_ON | typeof window.DIMMING_UNKNOWN;
+    type WINDOW_EVENT = typeof window.WINDOW_EVENT_DEICONIFIED | typeof window.WINDOW_EVENT_FOCUS_GAINED | typeof window.WINDOW_EVENT_FOCUS_LOST | typeof window.WINDOW_EVENT_ICONIFIED | typeof window.WINDOW_EVENT_RESIZED;
     /**
-     * Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
+     * dimming mode off Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
      */
     const DIMMING_OFF: number & { readonly __brand: "window.DIMMING_OFF" };
     /**
-     * Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
+     * dimming mode on Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
      */
     const DIMMING_ON: number & { readonly __brand: "window.DIMMING_ON" };
     /**
-     * Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction.
-     * This mode indicates that the dim mode can't be determined, or that the platform doesn't support dimming.
+     * dimming mode unknown Dimming mode is used to control whether or not a mobile device should dim the screen after a period without user interaction. This mode indicates that the dim mode can't be determined, or that the platform doesn't support dimming.
      */
     const DIMMING_UNKNOWN: number & { readonly __brand: "window.DIMMING_UNKNOWN" };
     /**
-     * This event is sent to a window event listener when the game window or app screen is
-     * restored after being iconified.
+     * deiconified window event This event is sent to a window event listener when the game window or app screen is restored after being iconified.
      */
     const WINDOW_EVENT_DEICONIFIED: number & { readonly __brand: "window.WINDOW_EVENT_DEICONIFIED" };
     /**
-     * This event is sent to a window event listener when the game window or app screen has
-     * gained focus.
-     * This event is also sent at game startup and the engine gives focus to the game.
+     * focus gained window event This event is sent to a window event listener when the game window or app screen has gained focus. This event is also sent at game startup and the engine gives focus to the game.
      */
     const WINDOW_EVENT_FOCUS_GAINED: number & { readonly __brand: "window.WINDOW_EVENT_FOCUS_GAINED" };
     /**
-     * This event is sent to a window event listener when the game window or app screen has lost focus.
+     * focus lost window event This event is sent to a window event listener when the game window or app screen has lost focus.
      */
     const WINDOW_EVENT_FOCUS_LOST: number & { readonly __brand: "window.WINDOW_EVENT_FOCUS_LOST" };
     /**
-     * This event is sent to a window event listener when the game window or app screen is
-     * iconified (reduced to an application icon in a toolbar, application tray or similar).
+     * Deprecated misspelling of `window.WINDOW_EVENT_ICONIFIED`, with the same value. The engine still registers it.
+     */
+    const WINDOW_EVENT_ICONFIED: typeof window.WINDOW_EVENT_ICONIFIED;
+    /**
+     * iconify window event This event is sent to a window event listener when the game window or app screen is iconified (reduced to an application icon in a toolbar, application tray or similar).
      */
-    const WINDOW_EVENT_ICONFIED: number & { readonly __brand: "window.WINDOW_EVENT_ICONFIED" };
+    const WINDOW_EVENT_ICONIFIED: number & { readonly __brand: "window.WINDOW_EVENT_ICONIFIED" };
     /**
-     * This event is sent to a window event listener when the game window or app screen is resized.
-     * The new size is passed along in the data field to the event listener.
+     * resized window event This event is sent to a window event listener when the game window or app screen is resized. The new size is passed along in the data field to the event listener.
      */
     const WINDOW_EVENT_RESIZED: number & { readonly __brand: "window.WINDOW_EVENT_RESIZED" };
     /**
@@ -51,14 +102,8 @@ declare global {
      * On platforms that does not support dimming, `window.DIMMING_UNKNOWN` is always returned.
      *
      * @returns The mode for screen dimming
-     *
-     * - `window.DIMMING_UNKNOWN`
-     *
-     * - `window.DIMMING_ON`
-     *
-     * - `window.DIMMING_OFF`
      */
-    function get_dim_mode(): window.DimModeState;
+    function get_dim_mode(): window.DIMMING;
     /**
      * This returns the content scale of the current display.
      *
@@ -77,27 +122,8 @@ declare global {
      * this returns the full window size and zero insets.
      *
      * @returns safe area data
-     *
-     * `safe_area`
-     * 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 };
+    function get_safe_area(): window.safe_area;
     /**
      * This returns the current window size (width and height).
      */
@@ -108,38 +134,12 @@ declare global {
      * This function has no effect on platforms that does not support dimming.
      *
      * @param mode - The mode for screen dimming
-     *
-     * - `window.DIMMING_ON`
-     *
-     * - `window.DIMMING_OFF`
      */
     function set_dim_mode(mode: window.DimModeStateSettable): void;
     /**
      * Sets a window event listener. Only one window event listener can be set at a time.
      *
      * @param callback - A callback which receives info about window events. Pass an empty function or `nil` if you no longer wish to receive callbacks.
-     *
-     * `self`
-     * object The calling script
-     * `event`
-     * 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
      * function window_callback(self: unknown, event: unknown, data: Record<string | number, unknown>) {
@@ -147,8 +147,8 @@ declare global {
      *     print("window.WINDOW_EVENT_FOCUS_LOST");
      *   } else if (event === window.WINDOW_EVENT_FOCUS_GAINED) {
      *     print("window.WINDOW_EVENT_FOCUS_GAINED");
-     *   } else if (event === window.WINDOW_EVENT_ICONFIED) {
-     *     print("window.WINDOW_EVENT_ICONFIED");
+     *   } else if (event === window.WINDOW_EVENT_ICONIFIED) {
+     *     print("window.WINDOW_EVENT_ICONIFIED");
      *   } else if (event === window.WINDOW_EVENT_DEICONIFIED) {
      *     print("window.WINDOW_EVENT_DEICONIFIED");
      *   } else if (event === window.WINDOW_EVENT_RESIZED) {
@@ -163,7 +163,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,