@defold-typescript/types 0.38.0 → 0.40.0

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

@@ -17,7 +17,7 @@ declare global {
    * require "builtins.scripts.socket"
    * ```
    *
-   * LuaSocket is Copyright © 2004-2007 Diego Nehab. All rights reserved.
+   * LuaSocket is Copyright © 2004-2007 Diego Nehab. All rights reserved.
    * LuaSocket is free software, released under the MIT license (same license as the Lua core).
    */
   namespace socket {
@@ -635,17 +635,23 @@ declare global {
      * @example
      * ```ts
      * // Perform operations on an open socket c:
-     * // create a try function that closes 'c' on error
-     * const try_ = socket.newtry(() => c.close());
-     * // do everything reassured c will be closed
-     * try_(c.send("hello there?\r\n"));
-     * const answer = try_(c.receive());
-     * // ...
-     * try_(c.send("good bye\r\n"));
-     * c.close();
+     * const [c] = socket.connect("localhost", 80);
+     * if (c !== undefined) {
+     *   // create a try function that closes 'c' on error
+     *   const try_ = socket.newtry(() => c.close());
+     *   // do everything reassured c will be closed
+     *   const [sent, sendError, lastByte] = c.send("hello there?\r\n");
+     *   try_(sent, sendError, lastByte);
+     *   const [line, receiveError, partial] = c.receive();
+     *   const answer = try_(line, receiveError, partial);
+     *   // ...
+     *   const [byeSent, byeError, byeLastByte] = c.send("good bye\r\n");
+     *   try_(byeSent, byeError, byeLastByte);
+     *   c.close();
+     * }
      * ```
      */
-    function newtry(finalizer: () => void): (...args: unknown[]) => unknown;
+    function newtry(finalizer?: () => void): <T>(value: T | undefined, ...rest: T extends { readonly __tstlMultiReturn: unknown } ? [boxedMultiReturn: never] : unknown[]) => T;
     /**
      * Converts a function that throws exceptions into a safe function. This function only catches exceptions thrown by try functions. It does not catch normal Lua errors.
      * Beware that if your function performs some illegal operation that raises an error, the protected function will catch the error and return it as a string. This is because try functions uses errors as the mechanism to throw exceptions.
@@ -656,17 +662,20 @@ declare global {
      * ```ts
      * const dostuff = socket.protect(() => {
      *   let try_ = socket.newtry();
-     *   const c = try_(socket.connect("myserver.com", 80));
+     *   const [conn, connectError] = socket.connect("myserver.com", 80);
+     *   const c = try_(conn, connectError);
      *   try_ = socket.newtry(() => c.close());
-     *   try_(c.send("hello?\r\n"));
-     *   const answer = try_(c.receive());
+     *   const [sent, sendError, lastByte] = c.send("hello?\r\n");
+     *   try_(sent, sendError, lastByte);
+     *   const [line, receiveError, partial] = c.receive();
+     *   const answer = try_(line, receiveError, partial);
      *   c.close();
      * });
      *
      * const [n, error] = dostuff();
      * ```
      */
-    function protect(func: (...args: unknown[]) => unknown): (arg0: unknown) => void;
+    function protect(func: (...args: unknown[]) => unknown): (...args: unknown[]) => LuaMultiReturn<[unknown, string | undefined]>;
     /**
      * The function returns a list with the sockets ready for reading, a list with the sockets ready for writing and an error message. The error message is "timeout" if a timeout condition was met and nil otherwise. The returned tables are doubly keyed both by integers and also by the sockets themselves, to simplify the test if a specific socket has changed status.
      * `Recvt` and `sendt` parameters can be empty tables or `nil`. Non-socket values (or values with non-numeric indices) in these arrays will be silently ignored.
@@ -694,13 +703,19 @@ declare global {
      * @param retN - argument N.
      * @example
      * ```ts
+     * const line = "250 OK";
+     *
      * // Instead of doing the following with dummy variables:
-     * // get the status code and separator from SMTP server reply
-     * const [dummy1, dummy2, code, sep] = string.find(line, "^(%d%d%d)(.?)");
+     * {
+     *   // get the status code and separator from SMTP server reply
+     *   const [dummy1, dummy2, code, sep] = string.find(line, "^(%d%d%d)(.?)");
+     * }
      *
      * // You can skip a number of variables:
-     * // get the status code and separator from SMTP server reply
-     * const [code, sep] = socket.skip(2, string.find(line, "^(%d%d%d)(.?)"));
+     * {
+     *   // get the status code and separator from SMTP server reply
+     *   const [code, sep] = socket.skip(2, string.find(line, "^(%d%d%d)(.?)"));
+     * }
      * ```
      */
     function skip(d: number, ret1?: unknown, ret2?: unknown, retN?: unknown): LuaMultiReturn<[unknown, unknown, unknown]>;

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

@@ -83,7 +83,7 @@ declare global {
      * square root of the mean (average) value of the squared function of
      * the instantaneous values.
      * For instance: for a sinewave signal with a peak gain of -1.94 dB (0.8 linear),
-     * the RMS is `0.8 × 1/sqrt(2)` which is about 0.566.
+     * the RMS is `0.8 × 1/sqrt(2)` which is about 0.566.
      * Note the returned value might be an approximation and in particular
      * the effective window might be larger than specified.
      *
@@ -193,16 +193,17 @@ declare global {
      * sound.play("#sound", { delay: 1, gain: 0.9, pan: -1.0 });
      *
      * // Using the callback argument, you can chain several sounds together:
-     * function sound_done(self, message_id, message, sender) {
+     * function sound_done(self: unknown, message_id: unknown, message: unknown, sender: unknown) {
      *   // play 'boom' sound fx when the countdown has completed
-     *   if (message_id === hash("sound_done") && message.play_id === self.countdown_id) {
+     *   const { play_id } = message as { play_id: number };
+     *   if (message_id === hash("sound_done") && play_id === (self as { countdown_id: number }).countdown_id) {
      *     sound.play("#boom", undefined, sound_done);
      *   }
      * }
      *
      * export default defineScript({
-     *   init(self) {
-     *     self.countdown_id = sound.play("#countdown", undefined, sound_done);
+     *   init() {
+     *     return { countdown_id: sound.play("#countdown", undefined, sound_done) };
      *   },
      * });
      * ```

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

@@ -52,7 +52,7 @@ declare global {
      * });
      * ```
      */
-    function play_flipbook(url: string | Hash | Url, id: string | Hash, complete_function?: (self: unknown, message_id: unknown, message: unknown, sender: unknown) => void, play_properties?: { offset?: number; playback_rate?: number }): void;
+    function play_flipbook(url: string | Hash | Url, id: string | Hash, complete_function?: (self: unknown, message_id: Hash, message: { current_tile: number; id: Hash }, sender: Url) => void, play_properties?: { offset?: number; playback_rate?: number }): void;
     /**
      * Resets a shader constant for a sprite component.
      * The constant must be defined in the material assigned to the sprite.
@@ -79,6 +79,10 @@ declare global {
      * // How to flip a sprite so it faces the horizontal movement (it is assumed that
      * // the sprite component has id "sprite" and the original animation faces right):
      * export default defineScript({
+     *   init() {
+     *     return { velocity: vmath.vector3() };
+     *   },
+     *
      *   update(self, dt) {
      *     // calculate self.velocity somehow
      *     sprite.set_hflip("#sprite", self.velocity.x < 0);
@@ -100,6 +104,10 @@ declare global {
      * // assumed that the sprite component has id "sprite" and the original animation
      * // is up-right):
      * export default defineScript({
+     *   init() {
+     *     return { up_side_down: false };
+     *   },
+     *
      *   update(self, dt) {
      *     // calculate self.up_side_down somehow, then:
      *     sprite.set_vflip("#sprite", self.up_side_down);

package/generated/versions/defold-1.13.0/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,10 +55,12 @@ declare global {
      * @example
      * ```ts
      * // Load data but return nil if path didn't exist
-     * if (!sys.exists(path)) {
-     *   return undefined;
+     * function load_data(path: string) {
+     *   if (!sys.exists(path)) {
+     *     return undefined;
+     *   }
+     *   return sys.load(path); // returns {} if it failed
      * }
-     * return sys.load(path); // returns {} if it failed
      * ```
      */
     function exists(path: string): boolean;
@@ -94,7 +98,7 @@ declare global {
      * ```ts
      * // Check if twitter is installed:
      * const sysinfo = sys.get_sys_info();
-     * let twitter = {};
+     * let twitter: { installed?: boolean } = {};
      *
      * if (sysinfo.system_name === "Android") {
      *   twitter = sys.get_application_info("com.twitter.android");
@@ -228,7 +232,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,12 +263,17 @@ declare global {
      * @example
      * ```ts
      * // Save data on the host
-     * const host_path = sys.get_host_path("logs/test.txt");
-     * sys.save(host_path, mytable);
+     * {
+     *   const mytable = { score: 100, level: 3 };
+     *   const host_path = sys.get_host_path("logs/test.txt");
+     *   sys.save(host_path, mytable);
+     * }
      *
      * // Load data from the host
-     * const host_path = sys.get_host_path("logs/test.txt");
-     * const table = sys.load(host_path);
+     * {
+     *   const host_path = sys.get_host_path("logs/test.txt");
+     *   const table = sys.load(host_path);
+     * }
      * ```
      */
     function get_host_path(filename: string): string;
@@ -443,31 +452,39 @@ 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 === sys.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);
+     *   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'
      *   }
      * }
      *
      * export default defineScript({
-     *   init(self) {
-     *     self.first_asset = hash("folder_next_to_binary/my_level_asset.bin");
-     *     self.second_asset = hash("/some_absolute_path/my_level.bin");
-     *     self.first_request = sys.load_buffer_async(self.first_asset, my_callback);
-     *     self.second_request = sys.load_buffer_async(self.second_asset, my_callback);
+     *   init() {
+     *     const first_path = "folder_next_to_binary/my_level_asset.bin";
+     *     const second_path = "/some_absolute_path/my_level.bin";
+     *     return {
+     *       first_asset: hash(first_path),
+     *       second_asset: hash(second_path),
+     *       first_request: sys.load_buffer_async(first_path, my_callback),
+     *       second_request: sys.load_buffer_async(second_path, my_callback),
+     *     };
      *   },
      * });
      * ```
@@ -566,7 +583,7 @@ declare global {
      * sys.save(my_file_path, my_table);
      * ```
      */
-    function save(filename: string, table: Record<string | number, unknown>): void;
+    function save(filename: string, table: Record<string | number, unknown> | readonly unknown[]): void;
     /**
      * The buffer can later deserialized by `sys.deserialize`.
      * This function has all the same limitations as `sys.save`.
@@ -582,7 +599,7 @@ declare global {
      * const buffer = sys.serialize(my_table);
      * ```
      */
-    function serialize(table: Record<string | number, unknown>): string;
+    function serialize(table: Record<string | number, unknown> | readonly unknown[]): string;
     /**
      * Sets the host that is used to check for network connectivity against.
      *
@@ -623,7 +640,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/versions/defold-1.13.0/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/versions/defold-1.13.0/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.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,8 +70,8 @@ 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.
      *
@@ -84,6 +84,9 @@ declare global {
      * @returns dot product
      * @example
      * ```ts
+     * const vector1 = vmath.vector3(1, 0, 0);
+     * const vector2 = vmath.vector3(0, 1, 0);
+     *
      * if (vmath.dot(vector1, vector2) === 0) {
      *   // The two vectors are perpendicular (at right-angles to each other)
      *   // ...
@@ -119,12 +122,14 @@ declare global {
      * @returns length
      * @example
      * ```ts
-     * if (vmath.length(self.velocity) < max_velocity) {
-     *   // The speed (velocity vector) is below max.
+     * function below_max_speed(self: { velocity: Vector3 }, max_velocity: number) {
+     *   if (vmath.length(self.velocity) < max_velocity) {
+     *     // The speed (velocity vector) is below max.
      *
-     *   // TODO: max_velocity can be expressed as squared
-     *   // so we can compare with length_sqr() instead.
-     *   // ...
+     *     // TODO: max_velocity can be expressed as squared
+     *     // so we can compare with length_sqr() instead.
+     *     // ...
+     *   }
      * }
      * ```
      */
@@ -136,6 +141,9 @@ declare global {
      * @returns squared length
      * @example
      * ```ts
+     * const vector1 = vmath.vector3(1, 0, 0);
+     * const vector2 = vmath.vector3(0, 2, 0);
+     *
      * if (vmath.length_sqr(vector1) < vmath.length_sqr(vector2)) {
      *   // Vector 1 has less magnitude than vector 2
      *   // ...
@@ -429,8 +437,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 &#x03B8; / |Q|`
-     * where &#x03B8; 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

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

@@ -5,6 +5,8 @@ declare global {
    * 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.
      */
@@ -56,7 +58,7 @@ declare global {
      *
      * - `window.DIMMING_OFF`
      */
-    function get_dim_mode(): number & { readonly __brand: "window.DIMMING_UNKNOWN" } | number & { readonly __brand: "window.DIMMING_ON" } | number & { readonly __brand: "window.DIMMING_OFF" };
+    function get_dim_mode(): window.DimModeState;
     /**
      * This returns the content scale of the current display.
      *
@@ -111,7 +113,7 @@ declare global {
      *
      * - `window.DIMMING_OFF`
      */
-    function set_dim_mode(mode: number & { readonly __brand: "window.DIMMING_ON" } | number & { readonly __brand: "window.DIMMING_OFF" }): void;
+    function set_dim_mode(mode: window.DimModeStateSettable): void;
     /**
      * Sets a window event listener. Only one window event listener can be set at a time.
      *
@@ -140,7 +142,7 @@ declare global {
      * - number `height`: The height of a resize event. nil otherwise.
      * @example
      * ```ts
-     * function window_callback(self, event, data) {
+     * 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) {

package/generated/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,8 +70,8 @@ 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.
      *
@@ -84,6 +84,9 @@ declare global {
      * @returns dot product
      * @example
      * ```ts
+     * const vector1 = vmath.vector3(1, 0, 0);
+     * const vector2 = vmath.vector3(0, 1, 0);
+     *
      * if (vmath.dot(vector1, vector2) === 0) {
      *   // The two vectors are perpendicular (at right-angles to each other)
      *   // ...
@@ -119,12 +122,14 @@ declare global {
      * @returns length
      * @example
      * ```ts
-     * if (vmath.length(self.velocity) < max_velocity) {
-     *   // The speed (velocity vector) is below max.
+     * function below_max_speed(self: { velocity: Vector3 }, max_velocity: number) {
+     *   if (vmath.length(self.velocity) < max_velocity) {
+     *     // The speed (velocity vector) is below max.
      *
-     *   // TODO: max_velocity can be expressed as squared
-     *   // so we can compare with length_sqr() instead.
-     *   // ...
+     *     // TODO: max_velocity can be expressed as squared
+     *     // so we can compare with length_sqr() instead.
+     *     // ...
+     *   }
      * }
      * ```
      */
@@ -136,6 +141,9 @@ declare global {
      * @returns squared length
      * @example
      * ```ts
+     * const vector1 = vmath.vector3(1, 0, 0);
+     * const vector2 = vmath.vector3(0, 2, 0);
+     *
      * if (vmath.length_sqr(vector1) < vmath.length_sqr(vector2)) {
      *   // Vector 1 has less magnitude than vector 2
      *   // ...
@@ -429,8 +437,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 &#x03B8; / |Q|`
-     * where &#x03B8; 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