@defold-typescript/types 0.39.0 → 0.41.0

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

@@ -17,7 +17,7 @@ declare global {
    * require "builtins.scripts.socket"
    * ```
    *
-   * LuaSocket is Copyright © 2004-2007 Diego Nehab. All rights reserved.
+   * LuaSocket is Copyright © 2004-2007 Diego Nehab. All rights reserved.
    * LuaSocket is free software, released under the MIT license (same license as the Lua core).
    */
   namespace socket {
@@ -47,11 +47,8 @@ declare global {
        * @param option - the name of the option to get:
        *
        * - `"keepalive"`
-       *
        * - `"linger"`
-       *
        * - `"reuseaddr"`
-       *
        * - `"tcp-nodelay"`
        */
       getoption(option: string): LuaMultiReturn<[unknown, string | undefined]>;
@@ -94,8 +91,12 @@ declare global {
        * Output is not buffered. For small strings, it is always better to concatenate them in Lua (with the `..` operator) and send the result in one call instead of calling the method several times.
        *
        * @param data - the string to be sent.
-       * @param i - optional starting index of the string.
-       * @param j - optional end index of string.
+       * @param i - optional starting index of the string. **⚠️ 1-based; passed to Defold unchanged.**
+       * @param j - optional end index of string. **⚠️ 1-based; passed to Defold unchanged.**
+       * @returns `[index, error, lastindex]`:
+       * - `index` — the index of the last byte within [i, j] that has been sent, or `nil` in case of error. Notice that, if `i` is 1 or absent, this is effectively the total number of bytes sent. **⚠️ 1-based; passed to Defold unchanged.**
+       * - `error` — the error message, or `nil` if no error occurred. The error message can be `"closed"` in case the connection was closed before the transmission was completed or the string `"timeout"` in case there was a timeout during the operation.
+       * - `lastindex` — in case of error, the index of the last byte within [i, j] that has been sent. You might want to try again from the byte following that. `nil` if no error occurred. **⚠️ 1-based; passed to Defold unchanged.**
        */
       send(data: string, i?: number, j?: number): LuaMultiReturn<[number | undefined, string | undefined, number | undefined]>;
       /**
@@ -115,7 +116,6 @@ declare global {
        * Controls the action taken when unsent data are queued on a socket and a close is performed. The value is a table with the following keys:
        *
        * - boolean `on`
-       *
        * - number `timeout` (seconds)
        *
        * If the 'on' field is set to true, the system will block the process on the close attempt until it is able to transmit the data or until `timeout` has passed. If 'on' is false and a close is issued, the system will process the close in a manner that allows the process to continue as quickly as possible. It is not advised to set this to anything other than zero;
@@ -179,23 +179,14 @@ declare global {
        * @param option - the name of the option to get:
        *
        * - `"dontroute"`
-       *
        * - `"broadcast"`
-       *
        * - `"reuseaddr"`
-       *
        * - `"reuseport"`
-       *
        * - `"ip-multicast-loop"`
-       *
        * - `"ipv6-v6only"`
-       *
        * - `"ip-multicast-if"`
-       *
        * - `"ip-multicast-ttl"`
-       *
        * - `"ip-add-membership"`
-       *
        * - `"ip-drop-membership"`
        */
       getoption(option: string): LuaMultiReturn<[unknown, string | undefined]>;
@@ -251,14 +242,12 @@ declare global {
        * `"ip-add-membership"`: Joins the multicast group specified. Receives a table with fields:
        *
        * - string `multiaddr` (IP address)
-       *
        * - string `interface` (IP address)
        *
        * "'ip-drop-membership"`
        * Leaves the multicast group specified. Receives a table with fields:
        *
        * - string `multiaddr` (IP address)
-       *
        * - string `interface` (IP address)
        * @param value - the value to set for the specified option.
        */
@@ -393,11 +382,8 @@ declare global {
        * @param option - the name of the option to get:
        *
        * - `"keepalive"`
-       *
        * - `"linger"`
-       *
        * - `"reuseaddr"`
-       *
        * - `"tcp-nodelay"`
        */
       getoption(option: string): LuaMultiReturn<[unknown, string | undefined]>;
@@ -430,7 +416,6 @@ declare global {
        * Controls the action taken when unsent data are queued on a socket and a close is performed. The value is a table with the following keys:
        *
        * - boolean `on`
-       *
        * - number `timeout` (seconds)
        *
        * If the 'on' field is set to true, the system will block the process on the close attempt until it is able to transmit the data or until `timeout` has passed. If 'on' is false and a close is issued, the system will process the close in a manner that allows the process to continue as quickly as possible. It is not advised to set this to anything other than zero;
@@ -480,23 +465,14 @@ declare global {
        * @param option - the name of the option to get:
        *
        * - `"dontroute"`
-       *
        * - `"broadcast"`
-       *
        * - `"reuseaddr"`
-       *
        * - `"reuseport"`
-       *
        * - `"ip-multicast-loop"`
-       *
        * - `"ipv6-v6only"`
-       *
        * - `"ip-multicast-if"`
-       *
        * - `"ip-multicast-ttl"`
-       *
        * - `"ip-add-membership"`
-       *
        * - `"ip-drop-membership"`
        */
       getoption(option: string): LuaMultiReturn<[unknown, string | undefined]>;
@@ -553,14 +529,12 @@ declare global {
        * `"ip-add-membership"`: Joins the multicast group specified. Receives a table with fields:
        *
        * - string `multiaddr` (IP address)
-       *
        * - string `interface` (IP address)
        *
        * "'ip-drop-membership"`
        * Leaves the multicast group specified. Receives a table with fields:
        *
        * - string `multiaddr` (IP address)
-       *
        * - string `interface` (IP address)
        * @param value - the value to set for the specified option.
        */
@@ -640,15 +614,18 @@ declare global {
      *   // create a try function that closes 'c' on error
      *   const try_ = socket.newtry(() => c.close());
      *   // do everything reassured c will be closed
-     *   try_(c.send("hello there?\r\n"));
-     *   const answer = try_(c.receive());
+     *   const [sent, sendError, lastByte] = c.send("hello there?\r\n");
+     *   try_(sent, sendError, lastByte);
+     *   const [line, receiveError, partial] = c.receive();
+     *   const answer = try_(line, receiveError, partial);
      *   // ...
-     *   try_(c.send("good bye\r\n"));
+     *   const [byeSent, byeError, byeLastByte] = c.send("good bye\r\n");
+     *   try_(byeSent, byeError, byeLastByte);
      *   c.close();
      * }
      * ```
      */
-    function newtry(finalizer: () => void): (...args: unknown[]) => unknown;
+    function newtry(finalizer?: () => void): <T>(value: T | undefined, ...rest: T extends { readonly __tstlMultiReturn: unknown } ? [boxedMultiReturn: never] : unknown[]) => T;
     /**
      * Converts a function that throws exceptions into a safe function. This function only catches exceptions thrown by try functions. It does not catch normal Lua errors.
      * Beware that if your function performs some illegal operation that raises an error, the protected function will catch the error and return it as a string. This is because try functions uses errors as the mechanism to throw exceptions.
@@ -659,17 +636,20 @@ declare global {
      * ```ts
      * const dostuff = socket.protect(() => {
      *   let try_ = socket.newtry();
-     *   const c = try_(socket.connect("myserver.com", 80));
+     *   const [conn, connectError] = socket.connect("myserver.com", 80);
+     *   const c = try_(conn, connectError);
      *   try_ = socket.newtry(() => c.close());
-     *   try_(c.send("hello?\r\n"));
-     *   const answer = try_(c.receive());
+     *   const [sent, sendError, lastByte] = c.send("hello?\r\n");
+     *   try_(sent, sendError, lastByte);
+     *   const [line, receiveError, partial] = c.receive();
+     *   const answer = try_(line, receiveError, partial);
      *   c.close();
      * });
      *
      * const [n, error] = dostuff();
      * ```
      */
-    function protect(func: (...args: unknown[]) => unknown): (arg0: unknown) => void;
+    function protect(func: (...args: unknown[]) => unknown): (...args: unknown[]) => LuaMultiReturn<[unknown, string | undefined]>;
     /**
      * The function returns a list with the sockets ready for reading, a list with the sockets ready for writing and an error message. The error message is "timeout" if a timeout condition was met and nil otherwise. The returned tables are doubly keyed both by integers and also by the sockets themselves, to simplify the test if a specific socket has changed status.
      * `Recvt` and `sendt` parameters can be empty tables or `nil`. Non-socket values (or values with non-numeric indices) in these arrays will be silently ignored.
@@ -696,14 +676,16 @@ declare global {
      * @param ret2 - argument 2.
      * @param retN - argument N.
      * @example
+     * Instead of doing the following with dummy variables:
      * ```ts
      * const line = "250 OK";
-     *
-     * // Instead of doing the following with dummy variables:
      * // get the status code and separator from SMTP server reply
      * const [dummy1, dummy2, code, sep] = string.find(line, "^(%d%d%d)(.?)");
-     *
-     * // You can skip a number of variables:
+     * ```
+     * @example
+     * You can skip a number of variables:
+     * ```ts
+     * const line = "250 OK";
      * // get the status code and separator from SMTP server reply
      * const [code, sep] = socket.skip(2, string.find(line, "^(%d%d%d)(.?)"));
      * ```
@@ -739,18 +721,19 @@ declare global {
        * The supplied address can be an IPv4 or IPv6 address or host name.
        * The function returns a table with all information returned by the resolver:
        *
-       * `{
-       * [1] = {
-       * family = family-name-1,
-       * addr = address-1
-       * },
-       * ...
-       * [n] = {
-       * family = family-name-n,
-       * addr = address-n
-       * }
+       * ```lua
+       * {
+       *  [1] = {
+       *     family = family-name-1,
+       *     addr = address-1
+       *   },
+       *   ...
+       *   [n] = {
+       *     family = family-name-n,
+       *     addr = address-n
+       *   }
        * }
-       * `
+       * ```
        *
        * Here, family contains the string `"inet"` for IPv4 addresses, and `"inet6"` for IPv6 addresses.
        * In case of error, the function returns nil followed by an error message.
@@ -769,12 +752,13 @@ declare global {
        * The supplied address can be an IPv4 or IPv6 address or host name.
        * The function returns a table with all information returned by the resolver:
        *
-       * `{
-       * [1] = host-name-1,
-       * ...
-       * [n] = host-name-n,
+       * ```lua
+       * {
+       *   [1] = host-name-1,
+       *   ...
+       *   [n] = host-name-n,
        * }
-       * `
+       * ```
        *
        * @param address - a hostname or an IPv4 or IPv6 address.
        */

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

@@ -38,7 +38,7 @@ declare global {
      * }
      * ```
      */
-    function get_group_name(group: string | Hash): string;
+    function get_group_name(group: Hash): string;
     /**
      * Get a table of all mixer group names (hashes).
      *
@@ -83,7 +83,7 @@ declare global {
      * square root of the mean (average) value of the squared function of
      * the instantaneous values.
      * For instance: for a sinewave signal with a peak gain of -1.94 dB (0.8 linear),
-     * the RMS is `0.8 × 1/sqrt(2)` which is about 0.566.
+     * the RMS is `0.8 × 1/sqrt(2)` which is about 0.566.
      * Note the returned value might be an approximation and in particular
      * the effective window might be larger than specified.
      *
@@ -108,7 +108,6 @@ declare global {
      * The best time to call this function is:
      *
      * - In the `init` function of your main collection script before any sounds are triggered
-     *
      * - In a window listener callback when the window.WINDOW_EVENT_FOCUS_GAINED event is received
      *
      * Both those times will give you a correct reading of the state even when your application is
@@ -187,12 +186,13 @@ declare global {
      * url The invoker of the callback: the sound component.
      * @returns The identifier for the sound voice
      * @example
+     * Assuming the script belongs to an instance with a sound-component with id "sound", this will make the component play its sound after 1 second:
      * ```ts
-     * // Assuming the script belongs to an instance with a sound-component with id
-     * // "sound", this will make the component play its sound after 1 second:
      * sound.play("#sound", { delay: 1, gain: 0.9, pan: -1.0 });
-     *
-     * // Using the callback argument, you can chain several sounds together:
+     * ```
+     * @example
+     * Using the callback argument, you can chain several sounds together:
+     * ```ts
      * function sound_done(self: unknown, message_id: unknown, message: unknown, sender: unknown) {
      *   // play 'boom' sound fx when the countdown has completed
      *   const { play_id } = message as { play_id: number };
@@ -202,8 +202,8 @@ declare global {
      * }
      *
      * export default defineScript({
-     *   init(self) {
-     *     self.countdown_id = sound.play("#countdown", undefined, sound_done);
+     *   init() {
+     *     return { countdown_id: sound.play("#countdown", undefined, sound_done) };
      *   },
      * });
      * ```
@@ -221,7 +221,7 @@ declare global {
      * sound.set_gain("#sound", 0.9);
      * ```
      */
-    function set_gain(url: string | Hash | Url, gain?: number): void;
+    function set_gain(url: string | Hash | Url, gain: number): void;
     /**
      * Set mixer group gain
      *
@@ -247,7 +247,7 @@ declare global {
      * sound.set_pan("#sound", 0.5); // pan to the right
      * ```
      */
-    function set_pan(url: string | Hash | Url, pan?: number): void;
+    function set_pan(url: string | Hash | Url, pan: number): void;
     /**
      * Stop playing all active voices or just one voice if `play_id` provided
      *

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

@@ -24,7 +24,6 @@ declare global {
      * table Information about the completion:
      *
      * - number `current_tile` - the current tile of the sprite.
-     *
      * - hash `id` - id of the animation that was completed.
      *
      * `sender`
@@ -36,9 +35,20 @@ declare global {
      * `playback_rate`
      * number the rate with which the animation will be played. Must be positive.
      * @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
-     * // Assuming the sprite has id "sprite": play the "jump" animation followed by the
-     * // "run" animation:
      * export default defineScript({
      *   init() {
      *     const url = msg.url("#sprite");
@@ -52,7 +62,7 @@ declare global {
      * });
      * ```
      */
-    function play_flipbook(url: string | Hash | Url, id: string | Hash, complete_function?: (self: unknown, message_id: unknown, message: unknown, sender: unknown) => void, play_properties?: { offset?: number; playback_rate?: number }): 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, play_properties?: { offset?: number; playback_rate?: number }): void;
     /**
      * Sets horizontal flipping of the provided sprite's animations.
      * The sprite is identified by its URL.
@@ -65,6 +75,10 @@ declare global {
      * // How to flip a sprite so it faces the horizontal movement (it is assumed that
      * // the sprite component has id "sprite" and the original animation faces right):
      * export default defineScript({
+     *   init() {
+     *     return { velocity: vmath.vector3() };
+     *   },
+     *
      *   update(self, dt) {
      *     // calculate self.velocity somehow
      *     sprite.set_hflip("#sprite", self.velocity.x < 0);
@@ -86,6 +100,10 @@ declare global {
      * // assumed that the sprite component has id "sprite" and the original animation
      * // is up-right):
      * export default defineScript({
+     *   init() {
+     *     return { up_side_down: false };
+     *   },
+     *
      *   update(self, dt) {
      *     // calculate self.up_side_down somehow, then:
      *     sprite.set_vflip("#sprite", self.up_side_down);
@@ -98,7 +116,7 @@ declare global {
       /**
        * READ ONLY The current animation id. An animation that plays currently for the sprite. The type of the property is hash.
        */
-      animation: Hash;
+      readonly animation: Hash;
       /**
        * The normalized animation cursor. The type of the property is number.
        */
@@ -106,7 +124,7 @@ declare global {
       /**
        * READ ONLY The frame count of the currently playing animation.
        */
-      frame_count: number;
+      readonly frame_count: number;
       /**
        * The image used when rendering the sprite. The type of the property is hash.
        */

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

@@ -55,11 +55,12 @@ declare global {
      * @example
      * ```ts
      * // Load data but return nil if path didn't exist
-     * const path = "/save/game.dat";
-     * if (!sys.exists(path)) {
-     *   return undefined;
+     * function load_data(path: string) {
+     *   if (!sys.exists(path)) {
+     *     return undefined;
+     *   }
+     *   return sys.load(path); // returns {} if it failed
      * }
-     * return sys.load(path); // returns {} if it failed
      * ```
      */
     function exists(path: string): boolean;
@@ -94,10 +95,10 @@ declare global {
      * `installed`
      * boolean `true` if the application is installed, `false` otherwise.
      * @example
+     * Check if twitter is installed:
      * ```ts
-     * // Check if twitter is installed:
      * const sysinfo = sys.get_sys_info();
-     * let twitter = {};
+     * let twitter: { installed?: boolean } = {};
      *
      * if (sysinfo.system_name === "Android") {
      *   twitter = sys.get_application_info("com.twitter.android");
@@ -108,8 +109,10 @@ declare global {
      * if (twitter.installed) {
      *   // twitter is installed!
      * }
-     *
-     * // Info.plist for the iOS app needs to list the schemes that are queried:
+     * ```
+     * @example
+     * Info.plist for the iOS app needs to list the schemes that are queried:
+     * ```ts
      * // ...
      * // <key>LSApplicationQueriesSchemes</key>
      * //  <array>
@@ -168,10 +171,12 @@ declare global {
      * @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
-     * // Get user config value
      * 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
@@ -192,25 +197,6 @@ declare global {
      * ```
      */
     function get_config_number(key: string, default_value?: number): number;
-    /**
-     * Get string 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 a string. default_value if the config key does not exist. nil if no default value was supplied.
-     * @example
-     * ```ts
-     * // Get user config value
-     * const text = sys.get_config_string("my_game.text", "default text");
-     *
-     * // Start the engine with a bootstrap config override and add a custom config value
-     * // $ dmengine --config=bootstrap.main_collection=/mytest.collectionc --config=mygame.testmode=1
-     *
-     * // Read the custom config value from the command line
-     * const testmode = sys.get_config_int("mygame.testmode");
-     * ```
-     */
-    function get_config_string(key: string, default_value?: string): string;
     /**
      * Returns the current network connectivity status
      * on mobile platforms.
@@ -219,9 +205,7 @@ declare global {
      * @returns network connectivity status:
      *
      * - `sys.NETWORK_DISCONNECTED` (no network connection is found)
-     *
      * - `sys.NETWORK_CONNECTED_CELLULAR` (connected through mobile cellular)
-     *
      * - `sys.NETWORK_CONNECTED` (otherwise, Wifi)
      * @example
      * ```ts
@@ -260,13 +244,15 @@ declare global {
      * @param filename - file to read from
      * @returns the path prefixed with the proper host mount
      * @example
+     * Save data on the host
      * ```ts
-     * // Save data on the host
      * const mytable = { score: 100, level: 3 };
      * const host_path = sys.get_host_path("logs/test.txt");
      * sys.save(host_path, mytable);
-     *
-     * // Load data from the host
+     * ```
+     * @example
+     * Load data from the host
+     * ```ts
      * const host_path = sys.get_host_path("logs/test.txt");
      * const table = sys.load(host_path);
      * ```
@@ -402,13 +388,15 @@ declare global {
      * @param path - the path to load the buffer from
      * @returns the buffer with data
      * @example
+     * Load binary data from a custom project resource:
      * ```ts
-     * // Load binary data from a custom project resource:
      * const my_buffer = sys.load_buffer("/assets/my_level_data.bin");
      * const data_str = buffer.get_bytes(my_buffer, "data");
      * const has_my_header = data_str.slice(0, 6) === "D3F0LD";
-     *
-     * // Load binary data from non-custom resource files on disk:
+     * ```
+     * @example
+     * Load binary data from non-custom resource files on disk:
+     * ```ts
      * const asset_1 = sys.load_buffer("folder_next_to_binary/my_level_asset.txt");
      * const asset_2 = sys.load_buffer("/my/absolute/path");
      * ```
@@ -436,27 +424,27 @@ declare global {
      * number The status of the request, supported values are:
      *
      * - `resource.REQUEST_STATUS_FINISHED`
-     *
      * - `resource.REQUEST_STATUS_ERROR_IO_ERROR`
-     *
      * - `resource.REQUEST_STATUS_ERROR_NOT_FOUND`
      *
      * `buffer`
      * buffer If the request was successfull, this will contain the request payload in a buffer object, and nil otherwise. Make sure to check the status before doing anything with the buffer value!
      * @returns a handle to the request
      * @example
+     * 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: unknown, result: unknown) {
      *   const { status, buf } = result as { status: number; buf: Opaque<"buffer"> };
-     *   if (status === resource.REQUEST_STATUS_FINISHED) {
-     *     resource.set_texture("/my_texture", {}, buf); // texture args
+     *   if (status === sys.REQUEST_STATUS_FINISHED) {
+     *     resource.set_texture("/my_texture", { type: graphics.TEXTURE_TYPE_2D, width: 128, height: 128, format: graphics.TEXTURE_FORMAT_RGBA }, buf);
      *   }
      * }
      *
      * const my_request = sys.load_buffer_async("/assets/my_level_data.bin", my_callback);
-     *
-     * // Load binary data from non-custom resource files on disk:
+     * ```
+     * @example
+     * Load binary data from non-custom resource files on disk:
+     * ```ts
      * function my_callback(self: unknown, request_id: unknown, result: unknown) {
      *   const { first_asset, second_asset } = self as { first_asset: Hash; second_asset: Hash };
      *   if ((result as { status: number }).status !== sys.REQUEST_STATUS_FINISHED) {
@@ -469,11 +457,15 @@ declare global {
      * }
      *
      * export default defineScript({
-     *   init(self) {
-     *     self.first_asset = hash("folder_next_to_binary/my_level_asset.bin");
-     *     self.second_asset = hash("/some_absolute_path/my_level.bin");
-     *     self.first_request = sys.load_buffer_async(self.first_asset, my_callback);
-     *     self.second_request = sys.load_buffer_async(self.second_asset, my_callback);
+     *   init() {
+     *     const first_path = "folder_next_to_binary/my_level_asset.bin";
+     *     const second_path = "/some_absolute_path/my_level.bin";
+     *     return {
+     *       first_asset: hash(first_path),
+     *       second_asset: hash(second_path),
+     *       first_request: sys.load_buffer_async(first_path, my_callback),
+     *       second_request: sys.load_buffer_async(second_path, my_callback),
+     *     };
      *   },
      * });
      * ```
@@ -572,7 +564,7 @@ declare global {
      * sys.save(my_file_path, my_table);
      * ```
      */
-    function save(filename: string, table: Record<string | number, unknown>): void;
+    function save(filename: string, table: Record<string | number, unknown> | readonly unknown[]): boolean;
     /**
      * The buffer can later deserialized by `sys.deserialize`.
      * This function has all the same limitations as `sys.save`.
@@ -588,7 +580,7 @@ declare global {
      * const buffer = sys.serialize(my_table);
      * ```
      */
-    function serialize(table: Record<string | number, unknown>): string;
+    function serialize(table: Record<string | number, unknown> | readonly unknown[]): string;
     /**
      * Sets the host that is used to check for network connectivity against.
      *
@@ -599,21 +591,6 @@ declare global {
      * ```
      */
     function set_connectivity_host(host: string): void;
-    /**
-     * Enables engine throttling.
-     *
-     * @param enable - true if throttling should be enabled
-     * @param cooldown - the time period to do update + render for (seconds)
-     * @example
-     * ```ts
-     * // Disable throttling
-     * sys.set_engine_throttle(false);
-     *
-     * // Enable throttling
-     * sys.set_engine_throttle(true, 1.5);
-     * ```
-     */
-    function set_engine_throttle(enable: boolean, cooldown?: number): void;
     /**
      * Set the Lua error handler function.
      * The error handler is a function which is called whenever a lua runtime error occurs.
@@ -657,10 +634,10 @@ declare global {
      * @example
      * ```ts
      * // Disable rendering
-     * sys.set_render_enable(false);
+     * sys.set_render_enabled(false);
      * ```
      */
-    function set_render_enable(enable: boolean): void;
+    function set_render_enabled(enable: boolean): void;
     /**
      * Set game update-frequency (frame cap). This option is equivalent to `display.update_frequency` in
      * the "game.project" settings but set in run-time. If `Vsync` checked in "game.project", the rate will