@defold-typescript/types 0.25.0 → 0.27.0

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

@@ -0,0 +1,71 @@
+/** @noSelfInFile */
+import type { Hash, Url } from "../../../src/core-types";
+
+declare global {
+  /**
+   * Messages for controlling and interacting with collection proxies
+   * which are used to dynamically load collections into the runtime.
+   */
+  namespace collectionproxy {
+    /**
+     * It's impossible to change the collection if the collection is already loaded.
+     */
+    const RESULT_ALREADY_LOADED: number & { readonly __brand: "collectionproxy.RESULT_ALREADY_LOADED" };
+    /**
+     * It's impossible to change the collection while the collection proxy is loading.
+     */
+    const RESULT_LOADING: number & { readonly __brand: "collectionproxy.RESULT_LOADING" };
+    /**
+     * It's impossible to change the collection for a proxy that isn't excluded.
+     */
+    const RESULT_NOT_EXCLUDED: number & { readonly __brand: "collectionproxy.RESULT_NOT_EXCLUDED" };
+    /**
+     * return an indexed table of resources for a collection proxy where the
+     * referenced collection has been excluded using LiveUpdate. Each entry is a
+     * hexadecimal string that represents the data of the specific resource.
+     * This representation corresponds with the filename for each individual
+     * resource that is exported when you bundle an application with LiveUpdate
+     * functionality.
+     *
+     * @param collectionproxy - the collectionproxy to check for resources.
+     * @returns the resources, or an empty list if the
+     * collection was not excluded.
+     * @example
+     * ```ts
+     * function print_resources(self, cproxy) {
+     *   const resources = collectionproxy.get_resources(cproxy);
+     *   for (const v of resources) {
+     *     print(`Resource: ${v}`);
+     *   }
+     * }
+     * ```
+     */
+    function get_resources(collectionproxy: Url): Hash[];
+    /**
+     * The collection should be loaded by the collection proxy.
+     * Setting the collection to "nil" will revert it back to the original collection.
+     * The collection proxy shouldn't be loaded and should have the 'Exclude' checkbox checked.
+     * This functionality is designed to simplify the management of Live Update resources.
+     *
+     * @param url - the collection proxy component
+     * @param prototype - the path to the new collection, or `nil`
+     * @example
+     * ```ts
+     * // The example assumes the script belongs to an instance with a
+     * // collection-proxy-component with id "proxy".
+     * const [ok, error] = collectionproxy.set_collection("/go#collectionproxy", "/LU/3.collectionc");
+     * if (ok) {
+     *   print("The collection has been changed to /LU/3.collectionc");
+     * } else {
+     *   print("Error changing collection to /LU/3.collectionc ", error);
+     * }
+     * msg.post("/go#collectionproxy", "load");
+     * msg.post("/go#collectionproxy", "init");
+     * msg.post("/go#collectionproxy", "enable");
+     * ```
+     */
+    function set_collection(url?: string | Hash | Url, prototype?: string): LuaMultiReturn<[boolean, number]>;
+  }
+}
+
+export {};

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

@@ -0,0 +1,306 @@
+/** @noSelfInFile */
+import type { Hash, Matrix4, Vector3, Vector4 } from "../../../src/core-types";
+
+declare global {
+  /**
+   * Functions for interacting with compute programs.
+   */
+  namespace compute {
+    /**
+     * Returns a table of all the shader constants in the compute program.
+     *
+     * @param path - The path to the resource
+     * @returns A table of tables, where each entry contains info about the shader constants:
+     *
+     * `name`
+     * hash the hashed name of the constant
+     * `type`
+     * 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`
+     * vmath.vector4 | vmath.matrix4 the value(s) of the constant. If the constant is an array, the value will be a table of vmath.vector4 or vmath.matrix4 if the type is `material.CONSTANT_TYPE_USER_MATRIX4`.
+     * @example
+     * ```ts
+     * const constants = compute.get_constants("/my_compute.computec");
+     * ```
+     */
+    function get_constants(path: Hash | string): { name: Hash; type: number; value: Vector4 | Matrix4 }[];
+    /**
+     * Returns a table of all the texture samplers in the compute program. This function will return all the texture samplers
+     * that are available, even the ones that have not been specified in the compute resource.
+     *
+     * @param path - The path to the resource
+     * @returns A table of tables, where each entry contains info about the texture samplers:
+     *
+     * `name`
+     * hash the hashed name of the texture sampler
+     * `u_wrap`
+     * 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`
+     * number the max anisotropy of the texture sampler
+     * @example
+     * ```ts
+     * const samplers = compute.get_samplers("/my_compute.computec");
+     * ```
+     */
+    function get_samplers(path: Hash | string): { name: Hash; u_wrap: number; v_wrap: number; min_filter: number; mag_filter: number; max_anisotropy: number }[];
+    /**
+     * Returns a table of all the textures from the compute program.
+     *
+     * @param path - The path to the resource
+     * @returns A table of tables, where each entry contains info about the compute textures:
+     *
+     * `path`
+     * hash the resource path of the texture. Only available if the texture is a resource.
+     * `handle`
+     * hash the runtime handle of the texture.
+     * `width`
+     * number the width of the texture
+     * `height`
+     * number the height of the texture
+     * `depth`
+     * number the depth of the texture. Corresponds to the number of layers in an array texture.
+     * `mipmaps`
+     * number the number of mipmaps in the texture
+     * `type`
+     * 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
+     * const textures = compute.get_textures("/my_compute.computec");
+     * ```
+     */
+    function get_textures(path: Hash | string): { path: Hash; handle: Hash; width: number; height: number; depth: number; mipmaps: number; type: number; flags: number }[];
+    /**
+     * Sets shader constants in a compute program, if the constants exist.
+     *
+     * @param path - The path to the resource
+     * @param constants - A table keyed by constant name with args tables as values. Constants can be partially updated. Supported entries:
+     *
+     * `type`
+     * 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`
+     * vmath.vector4 | vmath.vector3 | vmath.matrix4 | number | table the value(s) of the constant. If the shader constant is an array, the amount of values to update depends on how many values that are passed in the 'value' field.
+     * @example
+     * ```ts
+     * compute.set_constants("/my_compute.computec", { tint: { value: vmath.vector4(1, 0, 0, 1) } });
+     * ```
+     */
+    function set_constants(path: Hash | string, constants: Record<string, { type?: number; value?: Vector4 | Vector3 | Matrix4 | number | (Vector4 | Matrix4)[] }>): void;
+    /**
+     * Sets texture samplers in a compute program, if the samplers exist. Use this function to change the settings of texture samplers.
+     * To set actual textures that should be bound to the samplers, use the `compute.set_textures` function instead.
+     *
+     * @param path - The path to the resource
+     * @param samplers - A table keyed by sampler name with args tables as values. Partial updates are supported. Supported entries:
+     *
+     * `u_wrap`
+     * 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`
+     * number the max anisotropy of the texture sampler
+     * @example
+     * ```ts
+     * compute.set_samplers("/my_compute.computec", { texture_sampler: { u_wrap: graphics.TEXTURE_WRAP_REPEAT, v_wrap: graphics.TEXTURE_WRAP_MIRRORED_REPEAT } });
+     * ```
+     */
+    function set_samplers(path: Hash | string, samplers: Record<string, { u_wrap?: number; v_wrap?: number; min_filter?: number; mag_filter?: number; max_anisotropy?: number }>): void;
+    /**
+     * Sets textures in a compute program, if the samplers exist.
+     *
+     * @param path - The path to the resource
+     * @param textures - A table keyed by sampler name with texture resources as values.
+     * @example
+     * ```ts
+     * compute.set_textures("/my_compute.computec", { my_texture: resource.texture() });
+     * ```
+     */
+    function set_textures(path: Hash | string, textures: LuaMap<string, Hash>): void;
+  }
+}
+
+export {};

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

@@ -0,0 +1,143 @@
+/** @noSelfInFile */
+declare global {
+  /**
+   * Native crash logging functions and constants.
+   */
+  namespace crash {
+    /**
+     * android build fingerprint
+     */
+    const SYSFIELD_ANDROID_BUILD_FINGERPRINT: number & { readonly __brand: "crash.SYSFIELD_ANDROID_BUILD_FINGERPRINT" };
+    /**
+     * system device language as reported by sys.get_sys_info
+     */
+    const SYSFIELD_DEVICE_LANGUAGE: number & { readonly __brand: "crash.SYSFIELD_DEVICE_LANGUAGE" };
+    /**
+     * device model as reported by sys.get_sys_info
+     */
+    const SYSFIELD_DEVICE_MODEL: number & { readonly __brand: "crash.SYSFIELD_DEVICE_MODEL" };
+    /**
+     * engine version as hash
+     */
+    const SYSFIELD_ENGINE_HASH: number & { readonly __brand: "crash.SYSFIELD_ENGINE_HASH" };
+    /**
+     * engine version as release number
+     */
+    const SYSFIELD_ENGINE_VERSION: number & { readonly __brand: "crash.SYSFIELD_ENGINE_VERSION" };
+    /**
+     * system language as reported by sys.get_sys_info
+     */
+    const SYSFIELD_LANGUAGE: number & { readonly __brand: "crash.SYSFIELD_LANGUAGE" };
+    /**
+     * device manufacturer as reported by sys.get_sys_info
+     */
+    const SYSFIELD_MANUFACTURER: number & { readonly __brand: "crash.SYSFIELD_MANUFACTURER" };
+    /**
+     * The max number of sysfields.
+     */
+    const SYSFIELD_MAX: number & { readonly __brand: "crash.SYSFIELD_MAX" };
+    /**
+     * system name as reported by sys.get_sys_info
+     */
+    const SYSFIELD_SYSTEM_NAME: number & { readonly __brand: "crash.SYSFIELD_SYSTEM_NAME" };
+    /**
+     * system version as reported by sys.get_sys_info
+     */
+    const SYSFIELD_SYSTEM_VERSION: number & { readonly __brand: "crash.SYSFIELD_SYSTEM_VERSION" };
+    /**
+     * system territory as reported by sys.get_sys_info
+     */
+    const SYSFIELD_TERRITORY: number & { readonly __brand: "crash.SYSFIELD_TERRITORY" };
+    /**
+     * The max number of user fields.
+     */
+    const USERFIELD_MAX: number & { readonly __brand: "crash.USERFIELD_MAX" };
+    /**
+     * The max size of a single user field.
+     */
+    const USERFIELD_SIZE: number & { readonly __brand: "crash.USERFIELD_SIZE" };
+    /**
+     * A table is returned containing the addresses of the call stack.
+     *
+     * @param handle - crash dump handle
+     * @returns table containing the backtrace
+     */
+    function get_backtrace(handle: number): Record<string | number, unknown>;
+    /**
+     * The format of read text blob is platform specific
+     * and not guaranteed
+     * but can be useful for manual inspection.
+     *
+     * @param handle - crash dump handle
+     * @returns string with the platform specific data
+     */
+    function get_extra_data(handle: number): string;
+    /**
+     * The function returns a table containing entries with sub-tables that
+     * have fields 'name' and 'address' set for all loaded modules.
+     *
+     * @param handle - crash dump handle
+     * @returns module table
+     */
+    function get_modules(handle: number): Record<string | number, unknown>;
+    /**
+     * read signal number from a crash report
+     *
+     * @param handle - crash dump handle
+     * @returns signal number
+     */
+    function get_signum(handle: number): number;
+    /**
+     * reads a system field from a loaded crash dump
+     *
+     * @param handle - crash dump handle
+     * @param index - system field enum. Must be less than crash.SYSFIELD_MAX
+     * @returns value recorded in the crash dump, or `nil` if it didn't exist
+     */
+    function get_sys_field(handle: number, index: number): string | undefined;
+    /**
+     * reads user field from a loaded crash dump
+     *
+     * @param handle - crash dump handle
+     * @param index - user data slot index
+     * @returns user data value recorded in the crash dump
+     */
+    function get_user_field(handle: number, index: number): string;
+    /**
+     * The crash dump will be removed from disk upon a successful
+     * load, so loading is one-shot.
+     *
+     * @returns handle to the loaded dump, or `nil` if no dump was found
+     */
+    function load_previous(): number | undefined;
+    /**
+     * releases a previously loaded crash dump
+     *
+     * @param handle - handle to loaded crash dump
+     */
+    function release(handle: number): void;
+    /**
+     * Crashes occuring before the path is set will be stored to a default engine location.
+     *
+     * @param path - file path to use
+     */
+    function set_file_path(path: string): void;
+    /**
+     * Store a user value that will get written to a crash dump when
+     * 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 value - string value to store
+     */
+    function set_user_field(index: number, value: string): void;
+    /**
+     * Performs the same steps as if a crash had just occured but
+     * allows the program to continue.
+     * The generated dump can be read by crash.load_previous
+     */
+    function write_dump(): void;
+  }
+}
+
+export {};

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

@@ -0,0 +1,56 @@
+/** @noSelfInFile */
+declare global {
+  /**
+   * Editor scripting documentation
+   */
+  namespace http {
+    /**
+     * Perform an HTTP request
+     *
+     * @param url - request URL
+     * @param opts - Additional request options, a table with the following keys:`method string`request method, defaults to `"GET"``headers table`request headers, a table with string keys and values`body string`request body`as string`response body converter, either `"string"` or `"json"`
+     * @returns HTTP response, a table with the following keys:`status integer`response code`headers table`response headers, a table where each key is a lower-cased string, and each value is either a string or an array of strings if the header was repeated`body string, any, nil`response body, present only when `as` option was provided, either a string or a parsed json value
+     */
+    function request(url: string, opts?: Record<string | number, unknown>): Record<string | number, unknown>;
+    namespace server {
+      /**
+       * Create HTTP response that will stream the content of a file defined by the path
+       *
+       * @param path - External file path, resolved against project root if relative
+       * @param status - HTTP status code, an integer, default 200
+       * @param headers - HTTP response headers, a table from lower-case header names to header values
+       * @returns HTTP response value, userdata
+       */
+      function external_file_response(path: string, status?: number, headers?: unknown): unknown;
+      /**
+       * Create HTTP response with a JSON value
+       *
+       * @param value - Any Lua value that may be represented as JSON
+       * @param status - HTTP status code, an integer, default 200
+       * @param headers - HTTP response headers, a table from lower-case header names to header values
+       * @returns HTTP response value, userdata
+       */
+      function json_response(value: unknown, status?: number, headers?: unknown): unknown;
+      /**
+       * Create HTTP response that will stream the content of a resource defined by the resource path
+       *
+       * @param resource_path - Resource path (starting with `/`)
+       * @param status - HTTP status code, an integer, default 200
+       * @param headers - HTTP response headers, a table from lower-case header names to header values
+       * @returns HTTP response value, userdata
+       */
+      function resource_response(resource_path: string, status?: number, headers?: unknown): unknown;
+      /**
+       * Create HTTP response
+       *
+       * @param status - HTTP status code, an integer, default 200
+       * @param headers - HTTP response headers, a table from lower-case header names to header values
+       * @param body - HTTP response body
+       * @returns HTTP response value, userdata
+       */
+      function response(status?: number, headers?: unknown, body?: string): unknown;
+    }
+  }
+}
+
+export {};

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

@@ -0,0 +1,10 @@
+/** @noSelfInFile */
+declare global {
+  /**
+   * Editor scripting documentation
+   */
+  namespace json {
+  }
+}
+
+export {};

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

@@ -0,0 +1,42 @@
+/** @noSelfInFile */
+import type { Opaque } from "../../../../src/core-types";
+
+declare global {
+  /**
+   * Editor scripting documentation
+   */
+  namespace localization {
+    /**
+     * Create a message pattern that renders a list with the "and" conjunction (for example: a, b, and c) once it is stringified
+     *
+     * @param items - ] array of values; each value may be `nil`, `boolean`, `number`, `string`, or another `message` instance
+     * @returns a userdata value that, when stringified with `tostring()`, will produce a localized text according to the currently selected language in the editor
+     */
+    function and_list(items: unknown[]): Opaque<"message">;
+    /**
+     * Create a message pattern that concatenates values (similar to `table.concat`) and performs the actual concatenation when stringified
+     *
+     * @param items - ] array of values; each value may be `nil`, `boolean`, `number`, `string`, or another `message` instance
+     * @param separator - optional separator inserted between values; defaults to an empty string
+     * @returns a userdata value that, when stringified with `tostring()`, will produce a localized text according to the currently selected language in the editor
+     */
+    function concat(items: unknown[], separator?: boolean | number | string | Opaque<"message">): Opaque<"message">;
+    /**
+     * Create a message pattern for a localization key defined in an `.editor_localization` file; the actual localization happens when the returned value is stringified
+     *
+     * @param key - localization key defined in an `.editor_localization` file
+     * @param vars - optional table with variables to be substituted in the localized string that uses ICU Message Format syntax; keys must be strings; values must be either `nil`, `boolean`, `number`, `string`, or another `message` instance
+     * @returns a userdata value that, when stringified with `tostring()`, will produce a localized text according to the currently selected language in the editor
+     */
+    function message(key: string, vars?: Record<string | number, unknown>): Opaque<"message">;
+    /**
+     * Create a message pattern that renders a list with the "or" conjunction (for example: a, b, or c) once it is stringified
+     *
+     * @param items - ] array of values; each value may be `nil`, `boolean`, `number`, `string`, or another `message` instance
+     * @returns a userdata value that, when stringified with `tostring()`, will produce a localized text according to the currently selected language in the editor
+     */
+    function or_list(items: unknown[]): Opaque<"message">;
+  }
+}
+
+export {};