@defold-typescript/types 0.50.1 → 0.52.0

package/generated/sys.d.ts

@@ -57,6 +57,10 @@ declare global {
        * Whether the interface is running.
        */
       running: boolean;
+      /**
+       * Address family, absent for an interface that is neither IPv4 nor IPv6.
+       */
+      family?: "ipv4" | "ipv6";
     }
     /**
      * Asynchronous buffer-load result
@@ -69,7 +73,7 @@ declare global {
       /**
        * Loaded payload for a successful request.
        */
-      buffer?: Opaque<"buffer">;
+      buffer?: Opaque<"buffer"> & { length: LuaLengthMethod<number> };
     }
     /**
      * URL opening attributes
@@ -87,11 +91,11 @@ declare global {
       /**
        * Device model on iOS and Android.
        */
-      device_model?: string;
+      device_model: string;
       /**
        * Device manufacturer on iOS and Android.
        */
-      manufacturer?: string;
+      manufacturer: string;
       /**
        * Operating-system name.
        */
@@ -123,11 +127,11 @@ declare global {
       /**
        * Operating-system-protected device identifier.
        */
-      device_ident?: string;
+      device_ident: string;
       /**
        * HTTP user agent on HTML5.
        */
-      user_agent?: string;
+      user_agent: string;
     }
     /**
      * System-information options
@@ -313,7 +317,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
      *
@@ -326,7 +363,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.
@@ -439,7 +476,22 @@ declare global {
      * }
      * ```
      */
-    function get_sys_info(options?: sys.sys_info_options): sys.sys_info;
+    function get_sys_info(): sys.sys_info;
+    /**
+     * 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.sys_info_options): sys.sys_info;
     /**
      * 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.
@@ -485,7 +537,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
@@ -584,7 +636,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.open_url_attributes): 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

@@ -67,7 +67,7 @@ declare global {
      * }
      * ```
      */
-    function get_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number): number;
+    function get_tile(url: string | Hash | Url, layer: string | Hash, x: number, y: number): number | undefined;
     /**
      * Get the tile information at the specified position in the tilemap.
      * The position is identified by the tile index starting at origin
@@ -95,7 +95,7 @@ declare global {
      * }
      * ```
      */
-    function get_tile_info(url: string | Hash | Url, layer: string | Hash, x: number, y: number): { index: number; h_flip: boolean; v_flip: boolean; rotate_90: boolean };
+    function get_tile_info(url: string | Hash | Url, layer: string | Hash, x: number, y: number): { index: number; h_flip: boolean; v_flip: boolean; rotate_90: boolean } | undefined;
     /**
      * Retrieves all the tiles for the specified layer in the tilemap.
      * It returns a table of rows where the keys are the
@@ -113,13 +113,13 @@ declare global {
      * let count = 0;
      * for (let row_index = bottom; row_index <= bottom + rows_count - 1; row_index++) {
      *   for (let column_index = left; column_index <= left + columns_count - 1; column_index++) {
-     *     tile = tiles.get(row_index)?.get(column_index) ?? 0;
+     *     tile = tiles?.get(row_index)?.get(column_index) ?? 0;
      *     count = count + 1;
      *   }
      * }
      * ```
      */
-    function get_tiles(url: string | Hash | Url, layer: string | Hash): LuaTable<number, LuaTable<number, number>>;
+    function get_tiles(url: string | Hash | Url, layer: string | Hash): LuaTable<number, LuaTable<number, number>> | undefined;
     /**
      * Resets a shader constant for a tile map component.
      * The constant must be defined in the material assigned to the tile map.

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;
   }
 }
 

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

@@ -85,7 +85,7 @@ declare global {
      * }
      * ```
      */
-    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: LuaMap<Hash, Record<string | number, unknown>> | Record<string, Record<string | number, unknown>>, scale?: number | Vector3): LuaMap<Hash, Hash>;
+    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: LuaMap<Hash, Record<string | number, unknown>> | Record<string, Record<string | number, unknown>>, scale?: number | Vector3): LuaTable<Hash, Hash> & { get: LuaTableGetMethod<string, Hash> };
     /**
      * This returns status of the collection factory.
      * Calling this function when the factory is not marked as dynamic loading always returns COMP_COLLECTION_FACTORY_STATUS_LOADED.

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

@@ -64,7 +64,7 @@ declare global {
      * msg.post("/go#collectionproxy", "enable");
      * ```
      */
-    function set_collection(url: string | Hash | Url, prototype: string | undefined): LuaMultiReturn<[boolean, number]>;
+    function set_collection(url: string | Hash | Url, prototype: string | undefined): LuaMultiReturn<[boolean, number | undefined]>;
   }
 }
 

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

@@ -42,7 +42,9 @@ declare global {
      *     // create a new game object and provide property values
      *     const created = factory.create("#factory", undefined, undefined, { my_value: 1 });
      *     // communicate with the object
-     *     msg.post(created, "hello");
+     *     if (created !== undefined) {
+     *       msg.post(created, "hello");
+     *     }
      *   },
      * });
      * ```
@@ -58,7 +60,7 @@ declare global {
      * });
      * ```
      */
-    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: Record<string | number, unknown>, scale?: number | Vector3): Hash;
+    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: Record<string | number, unknown>, scale?: number | Vector3): Hash | undefined;
     /**
      * This returns status of the factory.
      * Calling this function when the factory is not marked as dynamic loading always returns