@defold-typescript/types 0.51.0 → 0.53.0

package/generated/sound.d.ts

@@ -11,7 +11,7 @@ declare global {
      * Data passed to the completion callback of sound.play. The callback's
      * `message_id` indicates whether playback finished or was stopped manually.
      */
-    interface play_completion {
+    interface PlayCompletion {
       /**
        * The sequential play identifier for the playback.
        */
@@ -20,7 +20,7 @@ declare global {
     /**
      * Sound playback properties
      */
-    interface play_properties {
+    interface PlayProperties {
       /**
        * Delay in seconds before playback starts. The default is 0.
        */
@@ -49,7 +49,7 @@ declare global {
     /**
      * Sound stop properties
      */
-    interface stop_properties {
+    interface StopProperties {
       /**
        * Sequential playback identifier returned by sound.play.
        */
@@ -241,7 +241,7 @@ declare global {
      * });
      * ```
      */
-    function play(url: string | Hash | Url, play_properties?: sound.play_properties, complete_function?: (self: unknown, message_id: Hash, message: sound.play_completion, sender: Url) => void): number;
+    function play(url: string | Hash | Url, play_properties?: sound.PlayProperties, complete_function?: (self: unknown, message_id: Hash, message: sound.PlayCompletion, sender: Url) => void): number;
     /**
      * Set gain on all active playing voices of a sound.
      *
@@ -295,8 +295,8 @@ declare global {
      * sound.stop("#sound", { play_id: id });
      * ```
      */
-    function stop(url: string | Hash | Url, stop_properties?: sound.stop_properties): void;
-    interface properties {
+    function stop(url: string | Hash | Url, stop_properties?: sound.StopProperties): void;
+    interface Properties {
       /**
        * The gain on the sound-component. Note that gain is in linear scale,
        * between 0 and 1.

package/generated/sprite.d.ts

@@ -9,7 +9,7 @@ declare global {
     /**
      * Sprite flipbook playback properties
      */
-    interface play_properties {
+    interface PlayProperties {
       /**
        * Normalized initial animation cursor.
        */
@@ -66,7 +66,55 @@ declare global {
      * });
      * ```
      */
-    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?: sprite.play_properties): 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): void;
+    /**
+     * Play an animation on a sprite component from its tile set
+     * An optional completion callback function can be provided that will be called when
+     * the animation has completed playing. If no function is provided,
+     * a animation_done message is sent to the script that started the animation.
+     *
+     * @param url - the sprite that should play the animation
+     * @param id - hashed id of the animation to play
+     * @param complete_function - function to call when the animation has completed.
+     *
+     * `self`
+     * script_instance The current script instance.
+     * `message_id`
+     * hash The name of the completion message, `"animation_done"`.
+     * `message`
+     * message.sprite.animation_done Information about the completion.
+     * `sender`
+     * url The invoker of the callback: the sprite component.
+     * @param play_properties - optional playback properties
+     * @example
+     * The following examples assumes that the model has id "sprite".
+     * How to play the "jump" animation followed by the "run" animation:
+     * ```ts
+     * const url = msg.url("#sprite");
+     *
+     * function anim_done(self: unknown, message_id: Hash, message: { id: Hash }) {
+     *   if (message_id === hash("animation_done") && message.id === hash("jump")) {
+     *     // jump animation done, chain with "run"
+     *     sprite.play_flipbook(url, "run");
+     *   }
+     * }
+     * ```
+     * @example
+     * ```ts
+     * export default defineScript({
+     *   init() {
+     *     const url = msg.url("#sprite");
+     *     sprite.play_flipbook(url, "jump", (self, message_id, message) => {
+     *       if (message_id === hash("animation_done") && message.id === hash("jump")) {
+     *         // jump animation done, chain with "run"
+     *         sprite.play_flipbook(url, "run");
+     *       }
+     *     });
+     *   },
+     * });
+     * ```
+     */
+    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) | undefined, play_properties: sprite.PlayProperties): void;
     /**
      * Resets a shader constant for a sprite component.
      * The constant must be defined in the material assigned to the sprite.
@@ -130,7 +178,7 @@ declare global {
      * ```
      */
     function set_vflip(url: string | Hash | Url, flip: boolean): void;
-    interface properties {
+    interface Properties {
       /**
        * READ ONLY The current animation id. An animation that plays currently for the sprite. The type of the property is hash.
        */

package/generated/sys.d.ts

@@ -10,7 +10,7 @@ declare global {
     /**
      * Application information
      */
-    interface application_info {
+    interface ApplicationInfo {
       /**
        * Whether the queried application is installed.
        */
@@ -19,7 +19,7 @@ declare global {
     /**
      * Engine information
      */
-    interface engine_info {
+    interface EngineInfo {
       /**
        * Defold engine version.
        */
@@ -36,7 +36,7 @@ declare global {
     /**
      * Network-interface information
      */
-    interface interface_info {
+    interface InterfaceInfo {
       /**
        * Interface name.
        */
@@ -65,20 +65,20 @@ declare global {
     /**
      * Asynchronous buffer-load result
      */
-    interface load_buffer_result {
+    interface LoadBufferResult {
       /**
        * Request status.
        */
-      status: sys.REQUEST_STATUS;
+      status: sys.RequestStatus;
       /**
        * Loaded payload for a successful request.
        */
-      buffer?: Opaque<"buffer">;
+      buffer?: Opaque<"buffer"> & { length: LuaLengthMethod<number> };
     }
     /**
      * URL opening attributes
      */
-    interface open_url_attributes {
+    interface OpenUrlAttributes {
       /**
        * HTML5 browsing context: `_self`, `_blank`, `_parent`, `_top`, or a named window.
        */
@@ -87,7 +87,7 @@ declare global {
     /**
      * System information
      */
-    interface sys_info {
+    interface SysInfo {
       /**
        * Device model on iOS and Android.
        */
@@ -136,15 +136,14 @@ declare global {
     /**
      * System-information options
      */
-    interface sys_info_options {
+    interface SysInfoOptions {
       /**
        * Omit operating-system-protected values such as `device_ident`.
        */
       ignore_secure?: boolean;
     }
-    type NetworkConnectivity = typeof sys.NETWORK_DISCONNECTED | typeof sys.NETWORK_CONNECTED_CELLULAR | typeof sys.NETWORK_CONNECTED;
-    type NETWORK = typeof sys.NETWORK_CONNECTED | typeof sys.NETWORK_CONNECTED_CELLULAR | typeof sys.NETWORK_DISCONNECTED;
-    type REQUEST_STATUS = typeof sys.REQUEST_STATUS_ERROR_IO_ERROR | typeof sys.REQUEST_STATUS_ERROR_NOT_FOUND | typeof sys.REQUEST_STATUS_FINISHED;
+    type Network = typeof sys.NETWORK_CONNECTED | typeof sys.NETWORK_CONNECTED_CELLULAR | typeof sys.NETWORK_DISCONNECTED;
+    type RequestStatus = typeof sys.REQUEST_STATUS_ERROR_IO_ERROR | typeof sys.REQUEST_STATUS_ERROR_NOT_FOUND | typeof sys.REQUEST_STATUS_FINISHED;
     /**
      * Connected through Wi-Fi or another non-cellular network.
      */
@@ -255,7 +254,7 @@ declare global {
      * // ...
      * ```
      */
-    function get_application_info(app_string: string): sys.application_info;
+    function get_application_info(app_string: string): sys.ApplicationInfo;
     /**
      * The path from which the application is run.
      * This function will raise a Lua error if unable to get the application support path.
@@ -317,7 +316,40 @@ declare global {
      * }
      * ```
      */
-    function get_config_int(key: string, default_value?: number): number;
+    function get_config_int(key: string): number;
+    /**
+     * Get integer config value from the game.project configuration file with optional default value
+     *
+     * @param key - key to get value for. The syntax is SECTION.KEY
+     * @param default_value - (optional) default value to return if the value does not exist
+     * @returns config value as an integer. default_value if the config key does not exist. 0 if no default value was supplied.
+     * @example
+     * Get user config value
+     * ```ts
+     * const speed = sys.get_config_int("my_game.speed", 20); // with default value
+     * ```
+     * @example
+     * ```ts
+     * const testmode = sys.get_config_int("my_game.testmode"); // without default value
+     * if (testmode !== undefined) {
+     *   // do stuff
+     * }
+     * ```
+     */
+    function get_config_int(key: string, default_value: number): number;
+    /**
+     * Get number config value from the game.project configuration file with optional default value
+     *
+     * @param key - key to get value for. The syntax is SECTION.KEY
+     * @param default_value - (optional) default value to return if the value does not exist
+     * @returns config value as an number. default_value if the config key does not exist. 0 if no default value was supplied.
+     * @example
+     * ```ts
+     * // Get user config value
+     * const speed = sys.get_config_number("my_game.speed", 20.0);
+     * ```
+     */
+    function get_config_number(key: string): number;
     /**
      * Get number config value from the game.project configuration file with optional default value
      *
@@ -330,7 +362,7 @@ declare global {
      * const speed = sys.get_config_number("my_game.speed", 20.0);
      * ```
      */
-    function get_config_number(key: string, default_value?: number): number;
+    function get_config_number(key: string, default_value: number): number;
     /**
      * Returns the current network connectivity status
      * on mobile platforms.
@@ -345,7 +377,7 @@ declare global {
      * }
      * ```
      */
-    function get_connectivity(): sys.NETWORK;
+    function get_connectivity(): sys.Network;
     /**
      * Returns a table with engine information.
      *
@@ -359,7 +391,7 @@ declare global {
      * gui.set_text(gui.get_node("version"), version_str);
      * ```
      */
-    function get_engine_info(): sys.engine_info;
+    function get_engine_info(): sys.EngineInfo;
     /**
      * Create a path to the host device for unit testing
      * Useful for saving logs etc during development
@@ -396,7 +428,7 @@ declare global {
      * }
      * ```
      */
-    function get_ifaddrs(): sys.interface_info[];
+    function get_ifaddrs(): sys.InterfaceInfo[];
     /**
      * The save-file path is operating system specific and is typically located under the user's home directory.
      * This function will raise a Lua error if unable to get the save file path.
@@ -443,7 +475,22 @@ declare global {
      * }
      * ```
      */
-    function get_sys_info(options?: sys.sys_info_options): sys.sys_info;
+    function get_sys_info(): sys.SysInfo;
+    /**
+     * Returns a table with system information.
+     *
+     * @param options - optional system-information options
+     * @returns system information
+     * @example
+     * ```ts
+     * // How to get system information:
+     * const info = sys.get_sys_info();
+     * if (info.system_name === "HTML5") {
+     *   // We are running in a browser.
+     * }
+     * ```
+     */
+    function get_sys_info(options: sys.SysInfoOptions): sys.SysInfo;
     /**
      * If the file exists, it must have been created by `sys.save` to be loaded.
      * This function will raise a Lua error if an error occurs while loading the file.
@@ -489,7 +536,7 @@ declare global {
      * const asset_2 = sys.load_buffer("/my/absolute/path");
      * ```
      */
-    function load_buffer(path: string): Opaque<"buffer">;
+    function load_buffer(path: string): Opaque<"buffer"> & { length: LuaLengthMethod<number> };
     /**
      * The sys.load_buffer function will first try to load the resource
      * from any of the mounted resource locations and return the data if
@@ -512,7 +559,7 @@ declare global {
      * Load binary data from a custom project resource and update a texture resource:
      * ```ts
      * // Load binary data from a custom project resource and update a texture resource:
-     * function my_callback(self: unknown, request_id: number, result: sys.load_buffer_result) {
+     * function my_callback(self: unknown, request_id: number, result: sys.LoadBufferResult) {
      *   const format = graphics.TEXTURE_FORMAT_RGBA;
      *   if (result.status === sys.REQUEST_STATUS_FINISHED && result.buffer !== undefined && format !== undefined) {
      *     resource.set_texture("/my_texture", { type: graphics.TEXTURE_TYPE_2D, width: 128, height: 128, format }, result.buffer);
@@ -525,7 +572,7 @@ declare global {
      * Load binary data from non-custom resource files on disk:
      * ```ts
      * // Load binary data from non-custom resource files on disk:
-     * function my_callback(self: unknown, request_id: number, result: sys.load_buffer_result) {
+     * function my_callback(self: unknown, request_id: number, result: sys.LoadBufferResult) {
      *   const { first_request, second_request } = self as { first_request: number; second_request: number };
      *   if (result.status !== sys.REQUEST_STATUS_FINISHED) {
      *     // uh oh! File could not be found, do something graceful
@@ -546,7 +593,7 @@ declare global {
      * });
      * ```
      */
-    function load_buffer_async(path: string, status_callback: (self: unknown, request_id: number, result: sys.load_buffer_result) => void): number;
+    function load_buffer_async(path: string, status_callback: (self: unknown, request_id: number, result: sys.LoadBufferResult) => void): number;
     /**
      * Loads a custom resource. Specify the full filename of the resource that you want
      * to load. When loaded, the file data is returned as a string.
@@ -588,7 +635,23 @@ declare global {
      * }
      * ```
      */
-    function open_url(url: string, attributes?: sys.open_url_attributes): boolean;
+    function open_url(url: string): boolean;
+    /**
+     * Open URL in default application, typically a browser
+     *
+     * @param url - url to open
+     * @param attributes - optional URL opening attributes
+     * @returns a boolean indicating if the url could be opened or not
+     * @example
+     * ```ts
+     * // Open an URL:
+     * const success = sys.open_url("http://www.defold.com", { target: "_blank" });
+     * if (!success) {
+     *   // could not open the url...
+     * }
+     * ```
+     */
+    function open_url(url: string, attributes: sys.OpenUrlAttributes): boolean;
     /**
      * Reboots the game engine with a specified set of arguments.
      * Arguments will be translated into command line arguments. Calling reboot

package/generated/tilemap.d.ts

@@ -6,7 +6,7 @@ declare global {
    * Functions and messages used to manipulate tile map components.
    */
   namespace tilemap {
-    type TRANSFORM = typeof tilemap.H_FLIP | typeof tilemap.ROTATE_180 | typeof tilemap.ROTATE_270 | typeof tilemap.ROTATE_90 | typeof tilemap.V_FLIP;
+    type Transform = typeof tilemap.H_FLIP | typeof tilemap.ROTATE_180 | typeof tilemap.ROTATE_270 | typeof tilemap.ROTATE_90 | typeof tilemap.V_FLIP;
     /**
      * flip tile horizontally
      */
@@ -176,7 +176,7 @@ declare global {
      * }
      * ```
      */
-    function set_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number, tile: number, transform_bitmask?: tilemap.TRANSFORM | number): boolean;
+    function set_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number, tile: number, transform_bitmask?: tilemap.Transform | number): boolean;
     /**
      * Sets the visibility of the tilemap layer
      *
@@ -190,7 +190,7 @@ declare global {
      * ```
      */
     function set_visible(url: string | Hash | Url, layer: string | Hash, visible: boolean): void;
-    interface properties {
+    interface Properties {
       /**
        * The material used when rendering the tile map. The type of the property is hash.
        */

package/generated/timer.d.ts

@@ -11,7 +11,7 @@ declare global {
     /**
      * Timer information
      */
-    interface info {
+    interface Info {
       /**
        * Time remaining until the next callback.
        */
@@ -25,7 +25,7 @@ declare global {
        */
       repeating: boolean;
     }
-    type timer_handle = number;
+    type TimerHandle = number;
     /**
      * Indicates an invalid timer handle
      */
@@ -111,7 +111,7 @@ declare global {
      * }
      * ```
      */
-    function get_info(handle: number): timer.info | undefined;
+    function get_info(handle: number): timer.Info | undefined;
     /**
      * Manual triggering a callback for a timer.
      *

package/generated/versions/defold-1.12.4/b2d.d.ts

@@ -6,8 +6,8 @@ declare global {
    * Functions for interacting with Box2D.
    */
   namespace b2d {
-    type b2Body = Opaque<"b2Body">;
-    type b2World = Opaque<"b2World">;
+    type B2Body = Opaque<"b2Body">;
+    type B2World = Opaque<"b2World">;
     /**
      * Get the Box2D body from a collision object
      *

package/generated/versions/defold-1.12.4/b2d_body.d.ts

@@ -6,8 +6,8 @@ declare global {
    * Functions for interacting with Box2D bodies.
    */
   namespace b2d.body {
-    type b2Body = Opaque<"b2Body">;
-    type b2World = Opaque<"b2World">;
+    type B2Body = Opaque<"b2Body">;
+    type B2World = Opaque<"b2World">;
     /**
      * Dynamic body
      */

package/generated/versions/defold-1.12.4/buffer.d.ts

@@ -68,7 +68,7 @@ declare global {
      * buffer.copy_buffer(dstbuffer, 0, srcbuffer, element_count - 10, 10);
      * ```
      */
-    function copy_buffer(dst: Opaque<"buffer">, dstoffset: number, src: Opaque<"buffer">, srcoffset: number, count: number): void;
+    function copy_buffer(dst: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, dstoffset: number, src: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, srcoffset: number, count: number): void;
     /**
      * Copy a specified amount of data from one stream to another.
      * The value type and size must match between source and destination streams.
@@ -129,15 +129,15 @@ declare global {
      * });
      * ```
      */
-    function create(element_count: number, declaration: { name?: Hash | string; type: buffer.ValueType; count?: number }[]): Opaque<"buffer">;
+    function create(element_count: number, declaration: [{ name?: Hash | string; type: buffer.ValueType; count?: number }, ...{ name?: Hash | string; type: buffer.ValueType; count?: number }[]]): Opaque<"buffer"> & { length: LuaLengthMethod<number> };
     /**
-     * Get a copy of all the bytes from a specified stream as a Lua string.
+     * Get a copy of all the bytes of the buffer, every stream included, as a Lua string.
      *
      * @param buffer - the source buffer
-     * @param stream_name - the name of the stream
+     * @param stream_name - the name of the stream; the engine ignores it and returns every byte of the buffer
      * @returns the buffer data as a Lua string
      */
-    function get_bytes(buffer: Opaque<"buffer">, stream_name: Hash | string): string;
+    function get_bytes(buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, stream_name?: Hash | string): string;
     /**
      * Get a named metadata entry from a buffer along with its type.
      *
@@ -153,7 +153,7 @@ declare global {
      * if (values) print(`${values.length} values in 'somefloats'`);
      * ```
      */
-    function get_metadata(buf: Opaque<"buffer">, metadata_name: Hash | string): LuaMultiReturn<[number[] | undefined, buffer.ValueType | undefined]>;
+    function get_metadata(buf: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, metadata_name: Hash | string): LuaMultiReturn<[number[] | undefined, buffer.ValueType | undefined]>;
     /**
      * Get a specified stream from a buffer.
      *
@@ -161,7 +161,7 @@ declare global {
      * @param stream_name - the stream name
      * @returns the data stream
      */
-    function get_stream(buffer: Opaque<"buffer">, stream_name: Hash | string): Opaque<"bufferstream"> & { [index: number]: number; length: LuaLengthMethod<number> };
+    function get_stream(buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, stream_name: Hash | string): Opaque<"bufferstream"> & { [index: number]: number; length: LuaLengthMethod<number> };
     /**
      * Creates or updates a metadata array entry on a buffer.
      * The value type and count given when updating the entry should match those used when first creating it.
@@ -182,7 +182,7 @@ declare global {
      * buffer.set_metadata(buf, hash("somefloats"), [-2.5, 10.0, 32.2], buffer.VALUE_TYPE_FLOAT32);
      * ```
      */
-    function set_metadata(buf: Opaque<"buffer">, metadata_name: Hash | string, values: number[], value_type: buffer.ValueType): void;
+    function set_metadata(buf: Opaque<"buffer"> & { length: LuaLengthMethod<number> }, metadata_name: Hash | string, values: [number, ...number[]], value_type: Exclude<buffer.ValueType, typeof buffer.VALUE_TYPE_INT64 | typeof buffer.VALUE_TYPE_UINT64>): void;
   }
 }