@defold-typescript/types 0.40.0 → 0.41.0

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

@@ -1,5 +1,5 @@
 /** @noSelfInFile */
-import type { Matrix4, Url, Vector3 } from "../../../src/core-types";
+import type { Hash, Matrix4, Url, Vector3 } from "../../../src/core-types";
 
 declare global {
   /**
@@ -30,7 +30,7 @@ declare global {
      * @param camera - camera id
      * @returns the effective aspect ratio.
      */
-    function get_aspect_ratio(camera?: Url | number): number;
+    function get_aspect_ratio(camera?: Url | number | string | Hash): number;
     /**
      * Returns whether auto aspect ratio is enabled. When enabled, the camera automatically
      * calculates aspect ratio from render target dimensions. When disabled, uses the
@@ -39,7 +39,7 @@ declare global {
      * @param camera - camera id
      * @returns true if auto aspect ratio is enabled
      */
-    function get_auto_aspect_ratio(camera?: Url | number): boolean;
+    function get_auto_aspect_ratio(camera?: Url | number | string | Hash): boolean;
     /**
      * This function returns a table with all the camera URLs that have been
      * registered in the render context.
@@ -62,28 +62,28 @@ declare global {
      * @param camera - camera id
      * @returns true if the camera is enabled
      */
-    function get_enabled(camera?: Url | number): boolean;
+    function get_enabled(camera?: Url | number | string | Hash): boolean;
     /**
      * get far z
      *
      * @param camera - camera id
      * @returns the far z.
      */
-    function get_far_z(camera?: Url | number): number;
+    function get_far_z(camera?: Url | number | string | Hash): number;
     /**
      * get field of view
      *
      * @param camera - camera id
      * @returns the field of view.
      */
-    function get_fov(camera?: Url | number): number;
+    function get_fov(camera?: Url | number | string | Hash): number;
     /**
      * get near z
      *
      * @param camera - camera id
      * @returns the near z.
      */
-    function get_near_z(camera?: Url | number): number;
+    function get_near_z(camera?: Url | number | string | Hash): number;
     /**
      * Gets the orthographic zoom calculated from the current window and project dimensions
      * in auto-fit and auto-cover modes. Returns 1.0 in fixed mode.
@@ -91,7 +91,7 @@ declare global {
      * @param camera - camera id
      * @returns the calculated orthographic auto zoom.
      */
-    function get_orthographic_auto_zoom(camera?: Url | number): number;
+    function get_orthographic_auto_zoom(camera?: Url | number | string | Hash): number;
     /**
      * get orthographic zoom mode
      *
@@ -99,7 +99,7 @@ declare global {
      * @returns one of camera.ORTHO_MODE_FIXED, camera.ORTHO_MODE_AUTO_FIT or
      * camera.ORTHO_MODE_AUTO_COVER
      */
-    function get_orthographic_mode(camera?: Url | number): number;
+    function get_orthographic_mode(camera?: Url | number | string | Hash): number;
     /**
      * Gets the positive user-controlled orthographic zoom multiplier. In auto-fit and auto-cover
      * modes, this value is multiplied with camera.get_orthographic_auto_zoom(camera).
@@ -107,21 +107,21 @@ declare global {
      * @param camera - camera id
      * @returns the positive zoom multiplier when the camera uses orthographic projection.
      */
-    function get_orthographic_zoom(camera?: Url | number): number;
+    function get_orthographic_zoom(camera?: Url | number | string | Hash): number;
     /**
      * get projection matrix
      *
      * @param camera - camera id
      * @returns the projection matrix.
      */
-    function get_projection(camera?: Url | number): Matrix4;
+    function get_projection(camera?: Url | number | string | Hash): Matrix4;
     /**
      * get view matrix
      *
      * @param camera - camera id
      * @returns the view matrix.
      */
-    function get_view(camera?: Url | number): Matrix4;
+    function get_view(camera?: Url | number | string | Hash): Matrix4;
     /**
      * Converts a screen-space 2D point with view depth to a 3D world point.
      * z is the view depth in world units measured from the camera plane along the camera forward axis.
@@ -154,7 +154,7 @@ declare global {
      * });
      * ```
      */
-    function screen_to_world(pos: Vector3, camera?: Url | number): Vector3;
+    function screen_to_world(pos: Vector3, camera?: Url | number | string | Hash): Vector3;
     /**
      * Converts 2D screen coordinates (x,y) to the 3D world-space point on the camera's near plane for that pixel.
      * If a camera isn't specified, the last enabled camera is used.
@@ -178,7 +178,7 @@ declare global {
      * });
      * ```
      */
-    function screen_xy_to_world(x: number, y: number, camera?: Url | number): Vector3;
+    function screen_xy_to_world(x: number, y: number, camera?: Url | number | string | Hash): Vector3;
     /**
      * Sets the manual aspect ratio for the camera. This value is only used when
      * auto aspect ratio is disabled. To disable auto aspect ratio and use this
@@ -187,7 +187,7 @@ declare global {
      * @param camera - camera id
      * @param aspect_ratio - the manual aspect ratio value.
      */
-    function set_aspect_ratio(camera: Url | number | undefined, aspect_ratio: number): void;
+    function set_aspect_ratio(camera: Url | number | string | Hash | undefined, aspect_ratio: number): void;
     /**
      * Enables or disables automatic aspect ratio calculation. When enabled (true),
      * the camera automatically calculates aspect ratio from render target dimensions.
@@ -196,35 +196,35 @@ declare global {
      * @param camera - camera id
      * @param auto_aspect_ratio - true to enable auto aspect ratio
      */
-    function set_auto_aspect_ratio(camera: Url | number | undefined, auto_aspect_ratio: boolean): void;
+    function set_auto_aspect_ratio(camera: Url | number | string | Hash | undefined, auto_aspect_ratio: boolean): void;
     /**
      * set far z
      *
      * @param camera - camera id
      * @param far_z - the far z.
      */
-    function set_far_z(camera: Url | number | undefined, far_z: number): void;
+    function set_far_z(camera: Url | number | string | Hash | undefined, far_z: number): void;
     /**
      * set field of view
      *
      * @param camera - camera id
      * @param fov - the field of view.
      */
-    function set_fov(camera: Url | number | undefined, fov: number): void;
+    function set_fov(camera: Url | number | string | Hash | undefined, fov: number): void;
     /**
      * set near z
      *
      * @param camera - camera id
      * @param near_z - the near z.
      */
-    function set_near_z(camera: Url | number | undefined, near_z: number): void;
+    function set_near_z(camera: Url | number | string | Hash | undefined, near_z: number): void;
     /**
      * set orthographic zoom mode
      *
      * @param camera - camera id
      * @param mode - camera.ORTHO_MODE_FIXED, camera.ORTHO_MODE_AUTO_FIT or camera.ORTHO_MODE_AUTO_COVER
      */
-    function set_orthographic_mode(camera: Url | number | undefined, mode: number): void;
+    function set_orthographic_mode(camera: Url | number | string | Hash | undefined, mode: number): void;
     /**
      * Sets the positive user-controlled orthographic zoom multiplier. In auto-fit and auto-cover
      * modes, this value is multiplied with camera.get_orthographic_auto_zoom(camera).
@@ -232,7 +232,7 @@ declare global {
      * @param camera - camera id
      * @param orthographic_zoom - the positive zoom multiplier when the camera uses orthographic projection.
      */
-    function set_orthographic_zoom(camera: Url | number | undefined, orthographic_zoom: number): void;
+    function set_orthographic_zoom(camera: Url | number | string | Hash | undefined, orthographic_zoom: number): void;
     /**
      * Converts a 3D world position to screen-space coordinates with view depth.
      * Returns a vector3 where x and y are in screen pixels and z is the view depth in world units
@@ -251,7 +251,7 @@ declare global {
      * const screen_pos = camera.world_to_screen(world_pos);
      * ```
      */
-    function world_to_screen(world_pos: Vector3, camera?: Url | number): Vector3;
+    function world_to_screen(world_pos: Vector3, camera?: Url | number | string | Hash): Vector3;
     interface properties {
       /**
        * The ratio between the frustum width and height. Used when calculating the
@@ -279,7 +279,7 @@ declare global {
        * in auto fit and auto cover modes. The value is 1.0 in fixed mode.
        * The type of the property is float.
        */
-      orthographic_auto_zoom: number;
+      readonly orthographic_auto_zoom: number;
       /**
        * Positive zoom multiplier when using an orthographic projection. In auto fit and auto cover
        * modes, this value is multiplied with the calculated orthographic_auto_zoom value.
@@ -290,12 +290,12 @@ declare global {
        * READ ONLY The calculated projection matrix of the camera.
        * The type of the property is matrix4.
        */
-      projection: Matrix4;
+      readonly projection: Matrix4;
       /**
        * READ ONLY The calculated view matrix of the camera.
        * The type of the property is matrix4.
        */
-      view: Matrix4;
+      readonly view: Matrix4;
     }
   }
 }

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

@@ -43,8 +43,8 @@ declare global {
      * @param scale - uniform scaling to apply to the newly spawned collection (must be greater than 0).
      * @returns a table mapping the id:s from the collection to the new instance id:s
      * @example
+     * How to spawn a collection of game objects:
      * ```ts
-     * // How to spawn a collection of game objects:
      * export default defineScript({
      *   init() {
      *     // Spawn a small group of enemies.
@@ -76,8 +76,10 @@ declare global {
      *     return { enemy_ids };
      *   },
      * });
-     *
-     * // How to delete a spawned collection:
+     * ```
+     * @example
+     * How to delete a spawned collection:
+     * ```ts
      * function delete_enemies(self: { enemy_ids: Hash[] }) {
      *   go.delete(self.enemy_ids);
      * }
@@ -92,12 +94,10 @@ declare global {
      * @returns status of the collection factory component
      *
      * - `collectionfactory.STATUS_UNLOADED`
-     *
      * - `collectionfactory.STATUS_LOADING`
-     *
      * - `collectionfactory.STATUS_LOADED`
      */
-    function get_status(url?: string | Hash | Url): collectionfactory.Status;
+    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.
@@ -117,7 +117,7 @@ declare global {
      * collectionfactory.load("#factory", (self, url, result) => {});
      * ```
      */
-    function load(url?: string | Hash | Url, complete_function?: (self: unknown, url: unknown, result: unknown) => void): void;
+    function load(url: string | Hash | Url, complete_function: (self: unknown, url: unknown, result: unknown) => void): void;
     /**
      * Changes the prototype for the collection factory.
      * Setting the prototype to "nil" will revert back to the original prototype.
@@ -132,7 +132,7 @@ declare global {
      * const ids = collectionfactory.create("#factory", go.get_world_position(), vmath.quat());
      * ```
      */
-    function set_prototype(url?: string | Hash | Url, prototype?: string): void;
+    function set_prototype(url: string | Hash | Url, prototype: string | undefined): void;
     /**
      * This decreases the reference count for each resource loaded with collectionfactory.load. If reference is zero, the resource is destroyed.
      * Calling this function when the factory is not marked as dynamic loading does nothing.
@@ -144,7 +144,7 @@ declare global {
      * collectionfactory.unload("#factory");
      * ```
      */
-    function unload(url?: string | Hash | Url): void;
+    function unload(url: string | Hash | Url): void;
   }
 }
 

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

@@ -40,7 +40,7 @@ declare global {
      * }
      * ```
      */
-    function get_resources(collectionproxy: Url): Hash[];
+    function get_resources(collectionproxy: Url | string | Hash): string[];
     /**
      * The collection should be loaded by the collection proxy.
      * Setting the collection to "nil" will revert it back to the original collection.
@@ -64,7 +64,7 @@ declare global {
      * msg.post("/go#collectionproxy", "enable");
      * ```
      */
-    function set_collection(url?: string | Hash | Url, prototype?: string): LuaMultiReturn<[boolean, number]>;
+    function set_collection(url: string | Hash | Url, prototype: string | undefined): LuaMultiReturn<[boolean, number]>;
   }
 }
 

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

@@ -18,37 +18,21 @@ declare global {
      * number the type of the constant. Supported values:
      *
      * - `material.CONSTANT_TYPE_USER`
-     *
      * - `material.CONSTANT_TYPE_USER_MATRIX4`
-     *
      * - `material.CONSTANT_TYPE_VIEWPROJ`
-     *
      * - `material.CONSTANT_TYPE_WORLD`
-     *
      * - `material.CONSTANT_TYPE_TEXTURE`
-     *
      * - `material.CONSTANT_TYPE_VIEW`
-     *
      * - `material.CONSTANT_TYPE_PROJECTION`
-     *
      * - `material.CONSTANT_TYPE_NORMAL`
-     *
      * - `material.CONSTANT_TYPE_WORLDVIEW`
-     *
      * - `material.CONSTANT_TYPE_WORLDVIEWPROJ`
-     *
      * - `material.CONSTANT_TYPE_TIME`
-     *
      * - `material.CONSTANT_TYPE_WORLD_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_VIEW_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_PROJECTION_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_VIEWPROJ_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_WORLDVIEW_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_WORLDVIEWPROJ_INVERSE`
      *
      * `value`
@@ -72,48 +56,34 @@ declare global {
      * number the u wrap mode of the texture sampler. Supported values:
      *
      * - `graphics.TEXTURE_WRAP_CLAMP_TO_BORDER`
-     *
      * - `graphics.TEXTURE_WRAP_CLAMP_TO_EDGE`
-     *
      * - `graphics.TEXTURE_WRAP_MIRRORED_REPEAT`
-     *
      * - `graphics.TEXTURE_WRAP_REPEAT`
      *
      * `v_wrap`
      * number the v wrap mode of the texture sampler. Supported values:
      *
      * - `graphics.TEXTURE_WRAP_CLAMP_TO_BORDER`
-     *
      * - `graphics.TEXTURE_WRAP_CLAMP_TO_EDGE`
-     *
      * - `graphics.TEXTURE_WRAP_MIRRORED_REPEAT`
-     *
      * - `graphics.TEXTURE_WRAP_REPEAT`
      *
      * `min_filter`
      * number the min filter mode of the texture sampler. Supported values:
      *
      * - `graphics.TEXTURE_FILTER_DEFAULT`
-     *
      * - `graphics.TEXTURE_FILTER_NEAREST`
-     *
      * - `graphics.TEXTURE_FILTER_LINEAR`
-     *
      * - `graphics.TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST`
-     *
      * - `graphics.TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR`
-     *
      * - `graphics.TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST`
-     *
      * - `graphics.TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR`
      *
      * `mag_filter`
      * number the mag filter mode of the texture sampler
      *
      * - `graphics.TEXTURE_FILTER_DEFAULT`
-     *
      * - `graphics.TEXTURE_FILTER_NEAREST`
-     *
      * - `graphics.TEXTURE_FILTER_LINEAR`
      *
      * `max_anisotropy`
@@ -146,28 +116,19 @@ declare global {
      * number the type of the texture. Supported values:
      *
      * - `graphics.TEXTURE_TYPE_2D`
-     *
      * - `graphics.TEXTURE_TYPE_2D_ARRAY`
-     *
      * - `graphics.TEXTURE_TYPE_CUBE_MAP`
-     *
      * - `graphics.TEXTURE_TYPE_IMAGE_2D`
-     *
      * - `graphics.TEXTURE_TYPE_3D`
-     *
      * - `graphics.TEXTURE_TYPE_IMAGE_3D`
      *
      * `flags`
      * number the flags of the texture. This field is a bit mask of these supported flags:
      *
      * - `graphics.TEXTURE_USAGE_FLAG_SAMPLE`
-     *
      * - `graphics.TEXTURE_USAGE_FLAG_MEMORYLESS`
-     *
      * - `graphics.TEXTURE_USAGE_FLAG_STORAGE`
-     *
      * - `graphics.TEXTURE_USAGE_FLAG_INPUT`
-     *
      * - `graphics.TEXTURE_USAGE_FLAG_COLOR`
      * @example
      * ```ts
@@ -185,37 +146,21 @@ declare global {
      * number the type of the constant. Supported values:
      *
      * - `material.CONSTANT_TYPE_USER`
-     *
      * - `material.CONSTANT_TYPE_USER_MATRIX4`
-     *
      * - `material.CONSTANT_TYPE_VIEWPROJ`
-     *
      * - `material.CONSTANT_TYPE_WORLD`
-     *
      * - `material.CONSTANT_TYPE_TEXTURE`
-     *
      * - `material.CONSTANT_TYPE_VIEW`
-     *
      * - `material.CONSTANT_TYPE_PROJECTION`
-     *
      * - `material.CONSTANT_TYPE_NORMAL`
-     *
      * - `material.CONSTANT_TYPE_WORLDVIEW`
-     *
      * - `material.CONSTANT_TYPE_WORLDVIEWPROJ`
-     *
      * - `material.CONSTANT_TYPE_TIME`
-     *
      * - `material.CONSTANT_TYPE_WORLD_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_VIEW_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_PROJECTION_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_VIEWPROJ_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_WORLDVIEW_INVERSE`
-     *
      * - `material.CONSTANT_TYPE_WORLDVIEWPROJ_INVERSE`
      *
      * `value`
@@ -237,48 +182,34 @@ declare global {
      * number the u wrap mode of the texture sampler. Supported values:
      *
      * - `graphics.TEXTURE_WRAP_CLAMP_TO_BORDER`
-     *
      * - `graphics.TEXTURE_WRAP_CLAMP_TO_EDGE`
-     *
      * - `graphics.TEXTURE_WRAP_MIRRORED_REPEAT`
-     *
      * - `graphics.TEXTURE_WRAP_REPEAT`
      *
      * `v_wrap`
      * number the v wrap mode of the texture sampler. Supported values:
      *
      * - `graphics.TEXTURE_WRAP_CLAMP_TO_BORDER`
-     *
      * - `graphics.TEXTURE_WRAP_CLAMP_TO_EDGE`
-     *
      * - `graphics.TEXTURE_WRAP_MIRRORED_REPEAT`
-     *
      * - `graphics.TEXTURE_WRAP_REPEAT`
      *
      * `min_filter`
      * number the min filter mode of the texture sampler. Supported values:
      *
      * - `graphics.TEXTURE_FILTER_DEFAULT`
-     *
      * - `graphics.TEXTURE_FILTER_NEAREST`
-     *
      * - `graphics.TEXTURE_FILTER_LINEAR`
-     *
      * - `graphics.TEXTURE_FILTER_NEAREST_MIPMAP_NEAREST`
-     *
      * - `graphics.TEXTURE_FILTER_NEAREST_MIPMAP_LINEAR`
-     *
      * - `graphics.TEXTURE_FILTER_LINEAR_MIPMAP_NEAREST`
-     *
      * - `graphics.TEXTURE_FILTER_LINEAR_MIPMAP_LINEAR`
      *
      * `mag_filter`
      * number the mag filter mode of the texture sampler
      *
      * - `graphics.TEXTURE_FILTER_DEFAULT`
-     *
      * - `graphics.TEXTURE_FILTER_NEAREST`
-     *
      * - `graphics.TEXTURE_FILTER_LINEAR`
      *
      * `max_anisotropy`

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

@@ -99,7 +99,7 @@ declare global {
      * reads user field from a loaded crash dump
      *
      * @param handle - crash dump handle
-     * @param index - user data slot index
+     * @param index - user data slot index. **0️⃣ 0-based; passed to Defold unchanged.**
      * @returns user data value recorded in the crash dump
      */
     function get_user_field(handle: number, index: number): string;
@@ -127,7 +127,7 @@ declare global {
      * a crash occurs. This can be user id:s, breadcrumb data etc.
      * There are 32 slots indexed from 0. Each slot stores at most 255 characters.
      *
-     * @param index - slot index. 0-indexed
+     * @param index - slot index. 0-indexed. **0️⃣ 0-based; passed to Defold unchanged.**
      * @param value - string value to store
      */
     function set_user_field(index: number, value: string): void;

package/generated/versions/defold-1.13.0/editor-vm/tilemap_tiles.d.ts

@@ -17,7 +17,7 @@ declare global {
      * @param tiles - unbounded 2d grid of tiles
      * @param x - x coordinate of a tile
      * @param y - y coordinate of a tile
-     * @returns full tile information table with the following keys:`index integer`1-indexed tile index of a tilemap's tilesource`h_flip boolean`horizontal flip`v_flip boolean`vertical flip`rotate_90 boolean`whether the tile is rotated 90 degrees clockwise
+     * @returns full tile information table with the following keys:`index integer`1-indexed tile index of a tilemap's tilesource`h_flip boolean`horizontal flip`v_flip boolean`vertical flip`rotate_90 boolean`whether the tile is rotated 90 degrees clockwise. **⚠️ `index` is 1-based; passed to Defold unchanged.**
      */
     export function get_info(tiles: unknown, x: number, y: number): Record<string | number, unknown>;
     /**
@@ -26,7 +26,7 @@ declare global {
      * @param tiles - unbounded 2d grid of tiles
      * @param x - x coordinate of a tile
      * @param y - y coordinate of a tile
-     * @returns 1-indexed tile index of a tilemap's tilesource
+     * @returns 1-indexed tile index of a tilemap's tilesource. **⚠️ 1-based; passed to Defold unchanged.**
      */
     export function get_tile(tiles: unknown, x: number, y: number): number;
     /**
@@ -69,7 +69,7 @@ declare global {
      * @param tiles - unbounded 2d grid of tiles
      * @param x - x coordinate of a tile
      * @param y - y coordinate of a tile
-     * @param tile_or_info - Either 1-indexed tile index of a tilemap's tilesource or full tile information table with the following keys:`index integer`1-indexed tile index of a tilemap's tilesource`h_flip boolean`horizontal flip`v_flip boolean`vertical flip`rotate_90 boolean`whether the tile is rotated 90 degrees clockwise
+     * @param tile_or_info - Either 1-indexed tile index of a tilemap's tilesource or full tile information table with the following keys:`index integer`1-indexed tile index of a tilemap's tilesource`h_flip boolean`horizontal flip`v_flip boolean`vertical flip`rotate_90 boolean`whether the tile is rotated 90 degrees clockwise. **⚠️ 1-based; passed to Defold unchanged.** **⚠️ `index` is 1-based; passed to Defold unchanged.**
      * @returns unbounded 2d grid of tiles
      */
     export function set(tiles: unknown, x: number, y: number, tile_or_info: number | Record<string | number, unknown>): unknown;

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

@@ -22,7 +22,7 @@ declare global {
      * - `"arm64-macos"`
      * - `"x86_64-linux"`
      */
-    const platform: unknown;
+    const platform: "x86_64-win32" | "x86_64-macos" | "arm64-macos" | "x86_64-linux";
     /**
      * A string, version name of Defold
      */
@@ -34,22 +34,26 @@ declare global {
      * @param options - table of command line options for bob, without the leading dashes (`--`). You can use snake_case instead of kebab-case for option keys. Only long option names are supported (i.e. `output`, not `o`). Supported value types are strings, integers and booleans. If an option takes no arguments, use a boolean (i.e. `true`). If an option may be repeated, you can use an array of values.
      * @param commands - bob commands, e.g. `"resolve"` or `"build"`
      * @example
+     * Print help in the console:
      * ```ts
-     * // Print help in the console:
      * editor.bob({ help: true });
-     *
-     * // Bundle the game for the host platform:
+     * ```
+     * @example
+     * Bundle the game for the host platform:
+     * ```ts
      * const opts = { archive: true, platform: editor.platform };
      * editor.bob(opts, "distclean", "resolve", "build", "bundle");
-     *
-     * // Using snake_cased and repeated options:
-     * const bundleOpts = {
+     * ```
+     * @example
+     * Using snake_cased and repeated options:
+     * ```ts
+     * const opts = {
      *   archive: true,
      *   platform: editor.platform,
      *   build_server: "https://build.my-company.com",
      *   settings: ["test.ini", "headless.ini"],
      * };
-     * editor.bob(bundleOpts, "distclean", "resolve", "build");
+     * editor.bob(opts, "distclean", "resolve", "build");
      * ```
      */
     function bob(options?: Record<string | number, unknown>, ...commands: string[]): void;
@@ -111,15 +115,19 @@ declare global {
      *
      * @param resources - ] Array of resource paths (strings starting with `/`) or resource definitions, lua tables with the following keys:`1 string`required, resource path (starting with `/`)`2 string`optional, created resource content
      * @example
+     * Create a single resource from template:
      * ```ts
-     * // Create a single resource from template:
      * editor.create_resources(["/npc.go"]);
-     *
-     * // Create multiple resources:
+     * ```
+     * @example
+     * Create multiple resources:
+     * ```ts
      * editor.create_resources(["/npc.go", "/levels/1.collection", "/levels/2.collection"]);
-     *
-     * // Create a resource with custom content:
-     * editor.create_resources([["/npc.script", "go.property('hp', 100)"]]);
+     * ```
+     * @example
+     * Create a resource with custom content:
+     * ```ts
+     * editor.create_resources([{ 1: "/npc.script", 2: "go.property('hp', 100)" }]);
      * ```
      */
     function create_resources(resources: unknown): void;
@@ -144,20 +152,22 @@ declare global {
      * @param options - Optional options table. Supported entries:
      * - boolean `reload_resources`: make the editor reload the resources from disk after the command is executed, default `true`
      * - string `out`: standard output mode, either:
-     * - `"pipe"`: the output is piped to the editor console (this is the default behavior).
-     * - `"capture"`: capture and return the output to the editor script with trailing newlines trimmed.
-     * - `"discard"`: the output is discarded completely.
+     *   - `"pipe"`: the output is piped to the editor console (this is the default behavior).
+     *   - `"capture"`: capture and return the output to the editor script with trailing newlines trimmed.
+     *   - `"discard"`: the output is discarded completely.
      * - string `err`: standard error output mode, either:
-     * - `"pipe"`: the error output is piped to the editor console (this is the default behavior).
-     * - `"stdout"`: the error output is redirected to the standard output of the process.
-     * - `"discard"`: the error output is discarded completely.
+     *   - `"pipe"`: the error output is piped to the editor console (this is the default behavior).
+     *   - `"stdout"`: the error output is redirected to the standard output of the process.
+     *   - `"discard"`: the error output is discarded completely.
      * @returns If `out` option is set to `"capture"`, returns the output as string with trimmed trailing newlines. Otherwise, returns `nil`.
      * @example
+     * Make a directory with spaces in it:
      * ```ts
-     * // Make a directory with spaces in it:
      * editor.execute("mkdir", "new dir");
-     *
-     * // Read the git status:
+     * ```
+     * @example
+     * Read the git status:
+     * ```ts
      * const status = editor.execute("git", "status", "--porcelain", {
      *   reload_resources: false,
      *   out: "capture",
@@ -840,7 +850,7 @@ declare global {
        *
        * const counterButton = editor.ui.component((props) => {
        *   const [count, setCount] = editor.ui.use_state((props as { count: unknown }).count);
-       *   const onPressed = editor.ui.use_memo(makeListener, setCount);
+       *   const onPressed = editor.ui.use_memo(makeListener, setCount) as () => void;
        *   return editor.ui.button({
        *     text: tostring(count),
        *     on_pressed: onPressed,