@defold-typescript/types 0.5.4 → 0.6.0

package/generated/http.d.ts

@@ -1,5 +1,8 @@
 /** @noSelfInFile */
 declare global {
+  /**
+   * Functions for performing HTTP and HTTPS requests.
+   */
   namespace http {
     /**
      * Perform a HTTP/HTTPS request.
@@ -33,22 +36,29 @@ declare global {
      * - boolean `chunked_transfer`: use chunked transfer encoding for https requests larger than 16kb. Defaults to true. Not available in HTML5 build
      * - boolean `report_progress`: when it is true, the amount of bytes sent and/or received for a request will be passed into the callback function
      * @example
-     * ```lua
-     * Basic HTTP-GET request. The callback receives a table with the response
-     * in the fields status, the response (the data) and headers (a table).
-     * local function http_result(self, _, response)
-     *     if response.bytes_total ~= nil then
-     *         update_my_progress_bar(self, response.bytes_received / response.bytes_total)
-     *     else
-     *         print(response.status)
-     *         print(response.response)
-     *         pprint(response.headers)
-     *     end
-     * end
-     *
-     * function init(self)
-     *     http.request("http://www.google.com", "GET", http_result, nil, nil, { report_progress = true })
-     * end
+     * ```ts
+     * // Basic HTTP-GET request. The callback receives a table with the response
+     * // in the fields status, the response (the data) and headers (a table).
+     * export default defineScript({
+     *   init() {
+     *     http.request(
+     *       "http://www.google.com",
+     *       "GET",
+     *       (self, _id, response) => {
+     *         if (response.bytes_total !== undefined) {
+     *           update_my_progress_bar(self, response.bytes_received / response.bytes_total);
+     *         } else {
+     *           print(response.status);
+     *           print(response.response);
+     *           pprint(response.headers);
+     *         }
+     *       },
+     *       undefined,
+     *       undefined,
+     *       { report_progress: true },
+     *     );
+     *   },
+     * });
      * ```
      */
     function request(url: string, method: string, callback: (self: unknown, id: unknown, response: unknown) => void, headers?: Record<string | number, unknown>, post_data?: string, options?: { timeout?: number; path?: string; ignore_cache?: boolean; chunked_transfer?: boolean; report_progress?: boolean }): void;

package/generated/iac.d.ts

@@ -1,5 +1,8 @@
 /** @noSelfInFile */
 declare global {
+  /**
+   * Functions and constants for doing inter-app communication. Supported on iOS and Android. [icon:ios] [icon:android]
+   */
   namespace iac {
     /**
      * Sets the listener function for inter-app communication events.

package/generated/iap.d.ts

@@ -2,26 +2,29 @@
 import type { Opaque } from "../src/core-types";
 
 declare global {
+  /**
+   * Functions and constants for doing in-app purchases. Supported on iOS, Android (Google Play and Amazon) and Facebook Canvas platforms. [icon:ios] [icon:googleplay] [icon:amazon] [icon:facebook]
+   */
   namespace iap {
     /**
      * Acknowledge a transaction. [icon:attention] Calling iap.acknowledge is required on a successful transaction on Google Play unless iap.finish is called. The transaction.state field must equal iap.TRANS_STATE_PURCHASED.
      *
      * @param transaction - transaction table parameter as supplied in listener callback
      */
-    function acknowledge(transaction: Record<string | number, unknown>): void;
+    function acknowledge(transaction: { ident?: string; state?: number; trans_ident?: string; date?: string; original_trans?: string; receipt?: string; signature?: string; user_id?: string }): void;
     /**
      * Purchase a product.
      *
      * @param id - product to buy
      * @param options - optional parameters as properties. The following parameters can be set
      */
-    function buy(id: string, options: Record<string | number, unknown>): void;
+    function buy(id: string, options: { request_id?: string; token?: string }): void;
     /**
      * Explicitly finish a product transaction. [icon:attention] Calling iap.finish is required on a successful transaction if `auto_finish_transactions` is disabled in project settings. Calling this function with `auto_finish_transactions` set will be ignored and a warning is printed. The `transaction.state` field must equal `iap.TRANS_STATE_PURCHASED`.
      *
      * @param transaction - transaction table parameter as supplied in listener callback
      */
-    function finish(transaction: Record<string | number, unknown>): void;
+    function finish(transaction: { ident?: string; state?: number; trans_ident?: string; date?: string; original_trans?: string; receipt?: string; signature?: string; user_id?: string }): void;
     /**
      * Get current iap provider
      *

package/generated/image.d.ts

@@ -2,6 +2,9 @@
 import type { Opaque } from "../src/core-types";
 
 declare global {
+  /**
+   * Functions for creating image objects.
+   */
   namespace image {
     /**
      * luminance image type
@@ -31,11 +34,11 @@ declare global {
      * - number `block_size_y`: block size y
      * - number `block_size_z`: block size z
      * @example
-     * ```lua
-     * How to get the block size and dimensions from a .astc file
-     * local s = sys.load_resource("/assets/cat.astc")
-     * local header = image.get_astc_header(s)
-     * pprint(s)
+     * ```ts
+     * // How to get the block size and dimensions from a .astc file
+     * const [s] = sys.load_resource("/assets/cat.astc");
+     * const header = image.get_astc_header(s);
+     * pprint(s);
      * ```
      */
     function get_astc_header(buffer: string): { width: number; height: number; depth: number; block_size_x: number; block_size_y: number; block_size_z: number } | unknown;
@@ -58,13 +61,13 @@ declare global {
      * - `image.TYPE_LUMINANCE_ALPHA`
      * - string `buffer`: the raw image data
      * @example
-     * ```lua
-     * How to load an image from an URL and create a GUI texture from it:
-     * local imgurl = "http://www.site.com/image.png"
-     * http.request(imgurl, "GET", function(self, id, response)
-     *         local img = image.load(response.response)
-     *         local tx = gui.new_texture("image_node", img.width, img.height, img.type, img.buffer)
-     *     end)
+     * ```ts
+     * // How to load an image from an URL and create a GUI texture from it:
+     * const imgurl = "http://www.site.com/image.png";
+     * http.request(imgurl, "GET", (self, id, response) => {
+     *   const img = image.load(response.response);
+     *   const tx = gui.new_texture("image_node", img.width, img.height, img.type, img.buffer);
+     * });
      * ```
      */
     function load(buffer: string, options?: { premultiply_alpha?: boolean; flip_vertically?: boolean }): { width: number; height: number; type: Opaque<"constant">; buffer: string } | unknown;
@@ -87,21 +90,22 @@ declare global {
      * - `image.TYPE_LUMINANCE_ALPHA`
      * - buffer `buffer`: the script buffer that holds the decompressed image data. See buffer.create how to use the buffer.
      * @example
-     * ```lua
-     * Load an image from an URL as a buffer and create a texture resource from it:
-     * local imgurl = "http://www.site.com/image.png"
-     * http.request(imgurl, "GET", function(self, id, response)
-     *         local img = image.load_buffer(response.response, { flip_vertically = true })
-     *         local tparams = {
-     *             width  = img.width,
-     *             height = img.height,
-     *             type   = graphics.TEXTURE_TYPE_2D,
-     *             format = graphics.TEXTURE_FORMAT_RGBA }
+     * ```ts
+     * // Load an image from an URL as a buffer and create a texture resource from it:
+     * const imgurl = "http://www.site.com/image.png";
+     * http.request(imgurl, "GET", (self, id, response) => {
+     *   const img = image.load_buffer(response.response, { flip_vertically: true });
+     *   const tparams = {
+     *     width: img.width,
+     *     height: img.height,
+     *     type: graphics.TEXTURE_TYPE_2D,
+     *     format: graphics.TEXTURE_FORMAT_RGBA,
+     *   };
      *
-     *         local my_texture_id = resource.create_texture("/my_custom_texture.texturec", tparams, img.buffer)
-     *         -- Apply the texture to a model
-     *         go.set("/go1#model", "texture0", my_texture_id)
-     *     end)
+     *   const my_texture_id = resource.create_texture("/my_custom_texture.texturec", tparams, img.buffer);
+     *   // Apply the texture to a model
+     *   go.set("/go1#model", "texture0", my_texture_id);
+     * });
      * ```
      */
     function load_buffer(buffer: string, options?: { premultiply_alpha?: boolean; flip_vertically?: boolean }): { width: number; height: number; type: Opaque<"constant">; buffer: Opaque<"buffer"> } | unknown;

package/generated/json.d.ts

@@ -1,5 +1,8 @@
 /** @noSelfInFile */
 declare global {
+  /**
+   * Manipulation of JSON data strings.
+   */
   namespace json {
     /**
      * Represents the null primitive from a json file
@@ -14,25 +17,27 @@ declare global {
      * - boolean `decode_null_as_userdata`: wether to decode a JSON null value as json.null or nil (default is nil)
      * @returns decoded json
      * @example
-     * ```lua
-     * Converting a string containing JSON data into a Lua table:
-     * function init(self)
-     *     local jsonstring = '{"persons":[{"name":"John Doe"},{"name":"Darth Vader"}]}'
-     *     local data = json.decode(jsonstring)
-     *     pprint(data)
-     * end
+     * ```ts
+     * // Converting a string containing JSON data into a table:
+     * export default defineScript({
+     *   init() {
+     *     const jsonstring = '{"persons":[{"name":"John Doe"},{"name":"Darth Vader"}]}';
+     *     const data = json.decode(jsonstring);
+     *     pprint(data);
+     *   },
+     * });
      *
-     * Results in the following printout:
-     * {
-     *   persons = {
-     *     1 = {
-     *       name = John Doe,
-     *     }
-     *     2 = {
-     *       name = Darth Vader,
-     *     }
-     *   }
-     * }
+     * // Results in the following printout:
+     * // {
+     * //   persons = {
+     * //     1 = {
+     * //       name = John Doe,
+     * //     }
+     * //     2 = {
+     * //       name = Darth Vader,
+     * //     }
+     * //   }
+     * // }
      * ```
      */
     export function decode(json: string, options?: { decode_null_as_userdata?: boolean }): Record<string | number, unknown>;
@@ -45,21 +50,20 @@ declare global {
      * - string `encode_empty_table_as_object`: wether to encode an empty table as an JSON object or array (default is object)
      * @returns encoded json
      * @example
-     * ```lua
-     * Convert a lua table to a JSON string:
-     * function init(self)
-     *      local tbl = {
-     *           persons = {
-     *                { name = "John Doe"},
-     *                { name = "Darth Vader"}
-     *           }
-     *      }
-     *      local jsonstring = json.encode(tbl)
-     *      pprint(jsonstring)
-     * end
+     * ```ts
+     * // Convert a table to a JSON string:
+     * export default defineScript({
+     *   init() {
+     *     const tbl = {
+     *       persons: [{ name: "John Doe" }, { name: "Darth Vader" }],
+     *     };
+     *     const jsonstring = json.encode(tbl);
+     *     pprint(jsonstring);
+     *   },
+     * });
      *
-     * Results in the following printout:
-     * {"persons":[{"name":"John Doe"},{"name":"Darth Vader"}]}
+     * // Results in the following printout:
+     * // {"persons":[{"name":"John Doe"},{"name":"Darth Vader"}]}
      * ```
      */
     export function encode(tbl: Record<string | number, unknown>, options?: { encode_empty_table_as_object?: string }): string;

package/generated/kinds/gui-script.d.ts

@@ -1,9 +1,5 @@
-import "../../src/go-overloads";
-import "../../src/message-guard";
-import "../../src/msg-overloads";
 import "../b2d";
 import "../buffer";
-import "../builtin-messages";
 import "../camera";
 import "../collectionfactory";
 import "../collectionproxy";
@@ -35,6 +31,12 @@ import "../vmath";
 import "../webview";
 import "../window";
 import "../zlib";
+import "../../src/engine-globals";
+import "../../src/go-overloads";
+import "../../src/message-guard";
+import "../../src/msg-overloads";
+import "../builtin-messages";
 import "../gui";
 
-export {};
+export { defineGuiScript } from "../../src/lifecycle";
+export type { ScriptProperties, ScriptProperty } from "../../src/lifecycle";

package/generated/kinds/render-script.d.ts

@@ -1,9 +1,5 @@
-import "../../src/go-overloads";
-import "../../src/message-guard";
-import "../../src/msg-overloads";
 import "../b2d";
 import "../buffer";
-import "../builtin-messages";
 import "../camera";
 import "../collectionfactory";
 import "../collectionproxy";
@@ -35,6 +31,12 @@ import "../vmath";
 import "../webview";
 import "../window";
 import "../zlib";
+import "../../src/engine-globals";
+import "../../src/go-overloads";
+import "../../src/message-guard";
+import "../../src/msg-overloads";
+import "../builtin-messages";
 import "../render";
 
-export {};
+export { defineRenderScript } from "../../src/lifecycle";
+export type { ScriptProperties, ScriptProperty } from "../../src/lifecycle";

package/generated/kinds/script.d.ts

@@ -1,9 +1,5 @@
-import "../../src/go-overloads";
-import "../../src/message-guard";
-import "../../src/msg-overloads";
 import "../b2d";
 import "../buffer";
-import "../builtin-messages";
 import "../camera";
 import "../collectionfactory";
 import "../collectionproxy";
@@ -35,5 +31,11 @@ import "../vmath";
 import "../webview";
 import "../window";
 import "../zlib";
+import "../../src/engine-globals";
+import "../../src/go-overloads";
+import "../../src/message-guard";
+import "../../src/msg-overloads";
+import "../builtin-messages";
 
-export {};
+export { defineScript } from "../../src/lifecycle";
+export type { ScriptProperties, ScriptProperty } from "../../src/lifecycle";

package/generated/label.d.ts

@@ -2,6 +2,9 @@
 import type { Hash, Url, Vector3, Vector4 } from "../src/core-types";
 
 declare global {
+  /**
+   * Functions to manipulate a label component.
+   */
   namespace label {
     /**
      * Gets the text from a label component
@@ -9,11 +12,13 @@ declare global {
      * @param url - the label to get the text from
      * @returns the label text
      * @example
-     * ```lua
-     * function init(self)
-     *     local text = label.get_text("#label")
-     *     print(text)
-     * end
+     * ```ts
+     * export default defineScript({
+     *   init(self) {
+     *     const text = label.get_text("#label");
+     *     print(text);
+     *   },
+     * });
      * ```
      */
     function get_text(url: string | Hash | Url): string;
@@ -25,10 +30,12 @@ declare global {
      * @param url - the label that should have a constant set
      * @param text - the text
      * @example
-     * ```lua
-     * function init(self)
-     *     label.set_text("#label", "Hello World!")
-     * end
+     * ```ts
+     * export default defineScript({
+     *   init(self) {
+     *     label.set_text("#label", "Hello World!");
+     *   },
+     * });
      * ```
      */
     function set_text(url: string | Hash | Url, text: string | number): void;

package/generated/liveupdate.d.ts

@@ -1,5 +1,8 @@
 /** @noSelfInFile */
 declare global {
+  /**
+   * Functions and constants to access resources.
+   */
   namespace liveupdate {
     /**
      * Mismatch between between expected bundled resources and actual bundled resources. The manifest expects a resource to be in the bundle, but it was not found in the bundle. This is typically the case when a non-excluded resource was modified between publishing the bundle and publishing the manifest.
@@ -64,11 +67,11 @@ declare global {
      * @param callback - Callback after the asynchronous request completed
      * @returns The result of the request
      * @example
-     * ```lua
-     * Add multiple mounts. Higher priority takes precedence.
-     * liveupdate.add_mount("common", "zip:/path/to/common_stuff.zip", 10, function (result) end) -- base pack
-     * liveupdate.add_mount("levelpack_1", "zip:/path/to/levels_1_to_20.zip", 20, function (result) end) -- level pack
-     * liveupdate.add_mount("season_pack_1", "zip:/path/to/easter_pack_1.zip", 30, function (result) end) -- season pack, overriding content in the other packs
+     * ```ts
+     * // Add multiple mounts. Higher priority takes precedence.
+     * liveupdate.add_mount("common", "zip:/path/to/common_stuff.zip", 10, (result) => {}); // base pack
+     * liveupdate.add_mount("levelpack_1", "zip:/path/to/levels_1_to_20.zip", 20, (result) => {}); // level pack
+     * liveupdate.add_mount("season_pack_1", "zip:/path/to/easter_pack_1.zip", 30, (result) => {}); // season pack, overriding content in the other packs
      * ```
      */
     function add_mount(name: string, uri: string, priority: number, callback: (...args: unknown[]) => unknown): number;
@@ -78,27 +81,27 @@ declare global {
      *
      * @returns Array of mounts
      * @example
-     * ```lua
-     * Output the current resource mounts
-     * pprint("MOUNTS", liveupdate.get_mounts())
+     * ```ts
+     * // Output the current resource mounts
+     * pprint("MOUNTS", liveupdate.get_mounts());
      *
-     * Give an output like:
-     * DEBUG:SCRIPT: MOUNTS,
-     * { --[[0x119667bf0]]
-     *   1 = { --[[0x119667c50]]
-     *     name = "liveupdate",
-     *     uri = "zip:/device/path/to/acchives/liveupdate.zip",
-     *     priority = 5
-     *   },
-     *   2 = { --[[0x119667d50]]
-     *     name = "_base",
-     *     uri = "archive:build/default/game.dmanifest",
-     *     priority = -10
-     *   }
-     * }
+     * // Give an output like:
+     * // DEBUG:SCRIPT: MOUNTS,
+     * // {
+     * //   1 = {
+     * //     name = "liveupdate",
+     * //     uri = "zip:/device/path/to/acchives/liveupdate.zip",
+     * //     priority = 5
+     * //   },
+     * //   2 = {
+     * //     name = "_base",
+     * //     uri = "archive:build/default/game.dmanifest",
+     * //     priority = -10
+     * //   }
+     * // }
      * ```
      */
-    function get_mounts(): Record<string | number, unknown>;
+    function get_mounts(): { name: string; uri: string; priority: number }[];
     /**
      * Remove a mount the resource system.
      * The remaining mounts are persisted between sessions.
@@ -107,9 +110,9 @@ declare global {
      * @param name - Unique name of the mount
      * @returns The result of the call
      * @example
-     * ```lua
-     * Add multiple mounts. Higher priority takes precedence.
-     * liveupdate.remove_mount("season_pack_1")
+     * ```ts
+     * // Add multiple mounts. Higher priority takes precedence.
+     * liveupdate.remove_mount("season_pack_1");
      * ```
      */
     function remove_mount(name: string): number;

package/generated/model.d.ts

@@ -1,7 +1,10 @@
 /** @noSelfInFile */
-import type { Hash, Opaque, Url } from "../src/core-types";
+import type { Hash, Opaque, Url, Vector3 } from "../src/core-types";
 
 declare global {
+  /**
+   * Functions and messages for interacting with model components.
+   */
   namespace model {
     /**
      * Cancels all animation on a model component.
@@ -16,12 +19,12 @@ declare global {
      * @param url - the model
      * @returns A table containing AABB of the model. If model has no meshes - return vmath.vector3(0,0,0) for min and max fields.
      * @example
-     * ```lua
-     * model.get_aabb("#model") -> { min = vmath.vector3(-2.5, -3.0, 0), max = vmath.vector3(1.5, 5.5, 0) }
-     * model.get_aabb("#empty") -> { min = vmath.vector3(0, 0, 0), max = vmath.vector3(0, 0, 0) }
+     * ```ts
+     * model.get_aabb("#model"); // => { min = vmath.vector3(-2.5, -3.0, 0), max = vmath.vector3(1.5, 5.5, 0) }
+     * model.get_aabb("#empty"); // => { min = vmath.vector3(0, 0, 0), max = vmath.vector3(0, 0, 0) }
      * ```
      */
-    function get_aabb(url: string | Hash | Url): Record<string | number, unknown>;
+    function get_aabb(url: string | Hash | Url): { min: Vector3; max: Vector3 };
     /**
      * Gets the id of the game object that corresponds to a model skeleton bone.
      * The returned game object can be used for parenting and transform queries.
@@ -32,13 +35,16 @@ declare global {
      * @param bone_id - id of the corresponding bone
      * @returns id of the game object
      * @example
-     * ```lua
-     * The following examples assumes that the model component has id "model".
-     * How to parent the game object of the calling script to the "right_hand" bone of the model in a player game object:
-     * function init(self)
-     *     local parent = model.get_go("player#model", "right_hand")
-     *     msg.post(".", "set_parent", {parent_id = parent})
-     * end
+     * ```ts
+     * // The following examples assume that the model component has id "model".
+     * // How to parent the game object of the calling script to the "right_hand" bone
+     * // of the model in a player game object:
+     * export default defineScript({
+     *   init(self) {
+     *     const parent = model.get_go("player#model", "right_hand");
+     *     msg.post(".", "set_parent", { parent_id: parent });
+     *   },
+     * });
      * ```
      */
     function get_go(url: string | Hash | Url, bone_id: string | Hash): Hash;
@@ -49,11 +55,11 @@ declare global {
      * @param url - the model
      * @returns A table containing info about all AABB in the format
      * @example
-     * ```lua
-     * model.get_mesh_aabb("#model") -> { hash("Sword") = { min = vmath.vector3(-0.5, -0.5, 0), max = vmath.vector3(0.5, 0.5, 0) }, hash("Shield") = { min = vmath.vector3(-0.5, -0.5, -0.5), max = vmath.vector3(0.5, 0.5, 0.5) } }
+     * ```ts
+     * model.get_mesh_aabb("#model"); // => { hash("Sword") = { min = vmath.vector3(-0.5, -0.5, 0), max = vmath.vector3(0.5, 0.5, 0) }, hash("Shield") = { min = vmath.vector3(-0.5, -0.5, -0.5), max = vmath.vector3(0.5, 0.5, 0.5) } }
      * ```
      */
-    function get_mesh_aabb(url: string | Hash | Url): Record<string | number, unknown>;
+    function get_mesh_aabb(url: string | Hash | Url): LuaMap<Hash, { min: Vector3; max: Vector3 }>;
     /**
      * Get the enabled state of a mesh
      *
@@ -61,13 +67,15 @@ declare global {
      * @param mesh_id - the id of the mesh
      * @returns true if the mesh is visible, false otherwise
      * @example
-     * ```lua
-     * function init(self)
-     *     if model.get_mesh_enabled("#model", "Sword") then
-     *        -- set properties specific for the sword
-     *        self.weapon_properties = game.data.weapons["Sword"]
-     *     end
-     * end
+     * ```ts
+     * export default defineScript({
+     *   init(self) {
+     *     if (model.get_mesh_enabled("#model", "Sword")) {
+     *       // set properties specific for the sword
+     *       self.weapon_properties = game.data.weapons["Sword"];
+     *     }
+     *   },
+     * });
      * ```
      */
     function get_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash | Url): boolean;
@@ -113,25 +121,27 @@ declare global {
      * `sender`
      * url The invoker of the callback: the model component.
      * @example
-     * ```lua
-     * The following examples assumes that the model has id "model".
-     * How to play the "jump" animation followed by the "run" animation:
-     * local function anim_done(self, message_id, message, sender)
-     *   if message_id == hash("model_animation_done") then
-     *     if message.animation_id == hash("jump") then
-     *       -- open animation done, chain with "run"
-     *       local properties = { blend_duration = 0.2 }
-     *       model.play_anim(url, "run", go.PLAYBACK_LOOP_FORWARD, properties, anim_done)
-     *     end
-     *   end
-     * end
+     * ```ts
+     * // The following examples assume that the model has id "model".
+     * // How to play the "jump" animation followed by the "run" animation:
+     * function anim_done(self, message_id, message, sender) {
+     *   if (message_id === hash("model_animation_done")) {
+     *     if (message.animation_id === hash("jump")) {
+     *       // open animation done, chain with "run"
+     *       const properties = { blend_duration: 0.2 };
+     *       model.play_anim(url, "run", go.PLAYBACK_LOOP_FORWARD, properties, anim_done);
+     *     }
+     *   }
+     * }
      *
-     * function init(self)
-     *     local url = msg.url("#model")
-     *     local play_properties = { blend_duration = 0.1 }
-     *     -- first blend during 0.1 sec into the jump, then during 0.2 s into the run animation
-     *     model.play_anim(url, "jump", go.PLAYBACK_ONCE_FORWARD, play_properties, anim_done)
-     * end
+     * export default defineScript({
+     *   init(self) {
+     *     const url = msg.url("#model");
+     *     const play_properties = { blend_duration: 0.1 };
+     *     // first blend during 0.1 sec into the jump, then during 0.2 s into the run animation
+     *     model.play_anim(url, "jump", go.PLAYBACK_ONCE_FORWARD, play_properties, anim_done);
+     *   },
+     * });
      * ```
      */
     function play_anim(url: string | Hash | Url, anim_id: string | Hash, playback: Opaque<"constant">, play_properties?: { blend_duration?: number; offset?: number; playback_rate?: number }, complete_function?: (self: unknown, message_id: unknown, message: unknown, sender: unknown) => void): void;
@@ -142,11 +152,13 @@ declare global {
      * @param mesh_id - the id of the mesh
      * @param enabled - true if the mesh should be visible, false if it should be hideen
      * @example
-     * ```lua
-     * function init(self)
-     *     model.set_mesh_enabled("#model", "Sword", false) -- hide the sword
-     *     model.set_mesh_enabled("#model", "Axe", true)    -- show the axe
-     * end
+     * ```ts
+     * export default defineScript({
+     *   init(self) {
+     *     model.set_mesh_enabled("#model", "Sword", false); // hide the sword
+     *     model.set_mesh_enabled("#model", "Axe", true); // show the axe
+     *   },
+     * });
      * ```
      */
     function set_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash | Url, enabled: boolean): void;