@defold-typescript/types 0.8.3 → 0.9.0

package/generated/html5.d.ts

@@ -2,6 +2,7 @@
 declare global {
   /**
    * HTML5 platform specific functions.
+   *
    * [icon:html5] The following functions are only available on HTML5 builds, the `html5.*` Lua namespace will not be available on other platforms.
    */
   namespace html5 {
@@ -13,11 +14,11 @@ declare global {
      * @param code - Javascript code to run
      * @returns result as string
      * @example
-     * ```lua
-     * local res = html5.run("10 + 20") -- returns the string "30"
-     * print(res)
-     * local res_num = tonumber(res) -- convert to number
-     * print(res_num - 20) -- prints 10
+     * ```ts
+     * const res = html5.run("10 + 20"); // returns the string "30"
+     * print(res);
+     * const res_num = tonumber(res); // convert to number
+     * print(res_num - 20); // prints 10
      * ```
      */
     function run(code: string): string;
@@ -28,18 +29,21 @@ declare global {
      * or start playing sounds the first time the callback is invoked.
      *
      * @param callback - The interaction callback. Pass an empty function or `nil` if you no longer wish to receive callbacks.
+     *
      * `self`
      * object The calling script
      * @example
-     * ```lua
-     * local function on_interaction(self)
-     *     print("on_interaction called")
-     *     html5.set_interaction_listener(nil)
-     * end
+     * ```ts
+     * function on_interaction(self) {
+     *   print("on_interaction called");
+     *   html5.set_interaction_listener(undefined);
+     * }
      *
-     * function init(self)
-     *     html5.set_interaction_listener(on_interaction)
-     * end
+     * export default defineScript({
+     *   init() {
+     *     html5.set_interaction_listener(on_interaction);
+     *   },
+     * });
      * ```
      */
     function set_interaction_listener(callback?: (self: unknown) => void): void;

package/generated/http.d.ts

@@ -11,29 +11,45 @@ declare global {
      * @param url - target url
      * @param method - HTTP/HTTPS method, e.g. "GET", "PUT", "POST" etc.
      * @param callback - response callback function
+     *
      * `self`
      * object The script instance
      * `id`
      * hash Internal message identifier. Do not use!
      * `response`
      * table The response data. Contains the fields:
+     *
      * - number `status`: the status of the response
+     *
      * - string `response`: the response data (if not saved on disc)
+     *
      * - table `headers`: all the returned headers (if status is 200 or 206)
+     *
      * - string `path`: the stored path (if saved to disc)
+     *
      * - string `error`: if any unforeseen errors occurred (e.g. file I/O)
+     *
      * - number `bytes_received`: the amount of bytes received/sent for a request, only if option `report_progress` is true
+     *
      * - number `bytes_total`: the total amount of bytes for a request, only if option `report_progress` is true
+     *
      * - number `range_start`: the start offset into the requested file
+     *
      * - number `range_end`: the end offset into the requested file (inclusive)
+     *
      * - number `document_size`: the full size of the requested file
      * @param headers - optional table with custom headers
      * @param post_data - optional data to send
      * @param options - optional table with request parameters. Supported entries:
+     *
      * - number `timeout`: timeout in seconds
+     *
      * - string `path`: path on disc where to download the file. Only overwrites the path if status is 200. Path should be absolute
+     *
      * - boolean `ignore_cache`: don't return cached data if we get a 304. Not available in HTML5 build
+     *
      * - 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
      * ```ts

package/generated/image.d.ts

@@ -27,11 +27,17 @@ declare global {
      *
      * @param buffer - .astc file data buffer
      * @returns header or `nil` if buffer is not a valid .astc. The header has these fields:
+     *
      * - number `width`: image width
+     *
      * - number `height`: image height
+     *
      * - number `depth`: image depth
+     *
      * - number `block_size_x`: block size x
+     *
      * - number `block_size_y`: block size y
+     *
      * - number `block_size_z`: block size z
      * @example
      * ```ts
@@ -47,18 +53,27 @@ declare global {
      *
      * @param buffer - image data buffer
      * @param options - An optional table containing parameters for loading the image. Supported entries:
+     *
      * `premultiply_alpha`
      * boolean True if alpha should be premultiplied into the color components. Defaults to `false`.
      * `flip_vertically`
      * boolean True if the image contents should be flipped vertically. Defaults to `false`.
      * @returns object or `nil` if loading fails. The object is a table with the following fields:
+     *
      * - number `width`: image width
+     *
      * - number `height`: image height
+     *
      * - constant `type`: image type
+     *
      * - `image.TYPE_RGB`
+     *
      * - `image.TYPE_RGBA`
+     *
      * - `image.TYPE_LUMINANCE`
+     *
      * - `image.TYPE_LUMINANCE_ALPHA`
+     *
      * - string `buffer`: the raw image data
      * @example
      * ```ts
@@ -76,18 +91,27 @@ declare global {
      *
      * @param buffer - image data buffer
      * @param options - An optional table containing parameters for loading the image. Supported entries:
+     *
      * `premultiply_alpha`
      * boolean True if alpha should be premultiplied into the color components. Defaults to `false`.
      * `flip_vertically`
      * boolean True if the image contents should be flipped vertically. Defaults to `false`.
      * @returns object or `nil` if loading fails. The object is a table with the following fields:
+     *
      * - number `width`: image width
+     *
      * - number `height`: image height
+     *
      * - constant `type`: image type
+     *
      * - `image.TYPE_RGB`
+     *
      * - `image.TYPE_RGBA`
+     *
      * - `image.TYPE_LUMINANCE`
+     *
      * - `image.TYPE_LUMINANCE_ALPHA`
+     *
      * - buffer `buffer`: the script buffer that holds the decompressed image data. See buffer.create how to use the buffer.
      * @example
      * ```ts

package/generated/json.d.ts

@@ -14,6 +14,7 @@ declare global {
      *
      * @param json - json data
      * @param options - table with decode options
+     *
      * - boolean `decode_null_as_userdata`: wether to decode a JSON null value as json.null or nil (default is nil)
      * @returns decoded json
      * @example
@@ -47,6 +48,7 @@ declare global {
      *
      * @param tbl - lua table to encode
      * @param options - table with encode options
+     *
      * - 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

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

@@ -1,12 +1,14 @@
 /// <reference types="lua-types/5.1" />
 /// <reference types="lua-types/special/jit-only" />
 import "../b2d";
+import "../b2d_body";
 import "../buffer";
 import "../camera";
 import "../collectionfactory";
 import "../collectionproxy";
 import "../crash";
 import "../factory";
+import "../font";
 import "../go";
 import "../graphics";
 import "../html5";
@@ -39,6 +41,7 @@ import "../../src/engine-globals";
 import "../../src/go-overloads";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/window-event-guard";
 import "../builtin-messages";
 import "../gui";
 

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

@@ -1,12 +1,14 @@
 /// <reference types="lua-types/5.1" />
 /// <reference types="lua-types/special/jit-only" />
 import "../b2d";
+import "../b2d_body";
 import "../buffer";
 import "../camera";
 import "../collectionfactory";
 import "../collectionproxy";
 import "../crash";
 import "../factory";
+import "../font";
 import "../go";
 import "../graphics";
 import "../html5";
@@ -39,6 +41,7 @@ import "../../src/engine-globals";
 import "../../src/go-overloads";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/window-event-guard";
 import "../builtin-messages";
 import "../render";
 

package/generated/kinds/script.d.ts

@@ -1,12 +1,14 @@
 /// <reference types="lua-types/5.1" />
 /// <reference types="lua-types/special/jit-only" />
 import "../b2d";
+import "../b2d_body";
 import "../buffer";
 import "../camera";
 import "../collectionfactory";
 import "../collectionproxy";
 import "../crash";
 import "../factory";
+import "../font";
 import "../go";
 import "../graphics";
 import "../html5";
@@ -39,6 +41,7 @@ import "../../src/engine-globals";
 import "../../src/go-overloads";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/window-event-guard";
 import "../builtin-messages";
 
 export { defineScript } from "../../src/lifecycle";

package/generated/model.d.ts

@@ -88,21 +88,31 @@ declare global {
      * The callback is not called (or message sent) if the animation is
      * cancelled with model.cancel. The callback is called (or message sent) only for
      * animations that play with the following playback modes:
+     *
      * - `go.PLAYBACK_ONCE_FORWARD`
+     *
      * - `go.PLAYBACK_ONCE_BACKWARD`
+     *
      * - `go.PLAYBACK_ONCE_PINGPONG`
      *
      * @param url - the model for which to play the animation
      * @param anim_id - id of the animation to play
      * @param playback - playback mode of the animation
+     *
      * - `go.PLAYBACK_ONCE_FORWARD`
+     *
      * - `go.PLAYBACK_ONCE_BACKWARD`
+     *
      * - `go.PLAYBACK_ONCE_PINGPONG`
+     *
      * - `go.PLAYBACK_LOOP_FORWARD`
+     *
      * - `go.PLAYBACK_LOOP_BACKWARD`
+     *
      * - `go.PLAYBACK_LOOP_PINGPONG`
      * @param play_properties - optional table with properties
      * Play properties table:
+     *
      * `blend_duration`
      * number Duration of a linear blend between the current and new animation.
      * `offset`
@@ -110,14 +120,18 @@ declare global {
      * `playback_rate`
      * number The rate with which the animation will be played. Must be positive.
      * @param complete_function - function to call when the animation has completed.
+     *
      * `self`
      * object The current object.
      * `message_id`
      * hash The name of the completion message, `"model_animation_done"`.
      * `message`
      * table Information about the completion:
+     *
      * - hash `animation_id` - the animation that was completed.
+     *
      * - constant `playback` - the playback mode for the animation.
+     *
      * `sender`
      * url The invoker of the callback: the model component.
      * @example

package/generated/msg.d.ts

@@ -12,35 +12,41 @@ declare global {
      *
      * @returns a new URL
      * @example
-     * ```lua
-     * Create a new URL which will address the current script:
-     * local my_url = msg.url()
-     * print(my_url) --> url: [current_collection:/my_instance#my_component]
+     * ```ts
+     * // Create a new URL which will address the current script:
+     * const my_url = msg.url();
+     * print(my_url); // => url: [current_collection:/my_instance#my_component]
      * ```
      */
     function url(): Url;
     /**
      * The format of the string must be `[socket:][path][#fragment]`, which is similar to a HTTP URL.
      * When addressing instances:
+     *
      * - `socket` is the name of a valid world (a collection)
+     *
      * - `path` is the id of the instance, which can either be relative the instance of the calling script or global
+     *
      * - `fragment` would be the id of the desired component
+     *
      * In addition, the following shorthands are available:
+     *
      * - `"."` the current game object
+     *
      * - `"#"` the current component
      *
      * @param urlstring - string to create the url from
      * @returns a new URL
      * @example
-     * ```lua
-     * local my_url = msg.url("#my_component")
-     * print(my_url) --> url: [current_collection:/my_instance#my_component]
+     * ```ts
+     * const my_url = msg.url("#my_component");
+     * print(my_url); // => url: [current_collection:/my_instance#my_component]
      *
-     * local my_url = msg.url("my_collection:/my_sub_collection/my_instance#my_component")
-     * print(my_url) --> url: [my_collection:/my_sub_collection/my_instance#my_component]
+     * const my_collection_url = msg.url("my_collection:/my_sub_collection/my_instance#my_component");
+     * print(my_collection_url); // => url: [my_collection:/my_sub_collection/my_instance#my_component]
      *
-     * local my_url = msg.url("my_socket:")
-     * print(my_url) --> url: [my_collection:]
+     * const my_socket_url = msg.url("my_socket:");
+     * print(my_socket_url); // => url: [my_collection:]
      * ```
      */
     function url(urlstring: string): Url;

package/generated/particlefx.d.ts

@@ -31,6 +31,7 @@ declare global {
      *
      * @param url - the particle fx that should start playing.
      * @param emitter_state_function - optional callback function that will be called when an emitter attached to this particlefx changes state.
+     *
      * `self`
      * object The current object
      * `id`
@@ -39,9 +40,13 @@ declare global {
      * hash The id of the emitter
      * `state`
      * constant the new state of the emitter:
+     *
      * - `particlefx.EMITTER_STATE_SLEEPING`
+     *
      * - `particlefx.EMITTER_STATE_PRESPAWN`
+     *
      * - `particlefx.EMITTER_STATE_SPAWNING`
+     *
      * - `particlefx.EMITTER_STATE_POSTSPAWN`
      * @example
      * ```ts
@@ -121,6 +126,7 @@ declare global {
      *
      * @param url - the particle fx that should stop playing
      * @param options - Options when stopping the particle fx. Supported options:
+     *
      * - boolean `clear`: instantly clear spawned particles
      * @example
      * ```ts

package/generated/physics.d.ts

@@ -84,6 +84,7 @@ declare global {
      *
      * @param url - the collision object to return the group of.
      * @returns hash value of the group.
+     *
      * `local function check_is_enemy()
      * local group = physics.get_group("#collisionobject")
      * return group == hash("enemy")
@@ -99,6 +100,7 @@ declare global {
      * @param collisionobject - collision object where the joint exist
      * @param joint_id - id of the joint
      * @returns properties table. See the joint types for what fields are available, the only field available for all types is:
+     *
      * - boolean `collide_connected`: Set this flag to true if the attached bodies should collide.
      */
     function get_joint_properties(collisionobject: string | Hash | Url, joint_id: string | Hash): { collide_connected: boolean };
@@ -129,6 +131,7 @@ declare global {
      * @param url - the collision object to check the mask of.
      * @param group - the name of the group to check for.
      * @returns boolean value of the maskbit. 'true' if present, 'false' otherwise.
+     *
      * `local function is_invincible()
      * -- check if the collisionobject would collide with the "bullet" group
      * local invincible = physics.get_maskbit("#collisionobject", "bullet")
@@ -143,24 +146,36 @@ declare global {
      * @param url - the collision object.
      * @param shape - the name of the shape to get data for.
      * @returns A table containing meta data about the physics shape
+     *
      * `type`
      * number The shape type. Supported values:
+     *
      * - `physics.SHAPE_TYPE_SPHERE`
+     *
      * - `physics.SHAPE_TYPE_BOX`
+     *
      * - `physics.SHAPE_TYPE_CAPSULE` *Only supported for 3D physics*
+     *
      * - `physics.SHAPE_TYPE_HULL`
+     *
      * The returned table contains different fields depending on which type the shape is.
      * If the shape is a sphere:
+     *
      * `diameter`
      * number the diameter of the sphere shape
+     *
      * If the shape is a box:
+     *
      * `dimensions`
      * vector3 a `vmath.vector3` of the box dimensions
+     *
      * If the shape is a capsule:
+     *
      * `diameter`
      * number the diameter of the capsule poles
      * `height`
      * number the height of the capsule
+     *
      * `local function get_shape_meta()
      * local sphere = physics.get_shape("#collisionobject", "my_sphere_shape")
      * -- returns a table with sphere.diameter
@@ -181,6 +196,7 @@ declare global {
      * @param to - the world position of the end of the ray
      * @param groups - a lua table containing the hashed groups for which to test collisions against
      * @param options - a lua table containing options for the raycast.
+     *
      * `all`
      * boolean Set to `true` to return all ray cast hits. If `false`, it will only return the closest hit.
      * @returns It returns a list. If missed it returns `nil`. See ray_cast_response for details on the returned values.
@@ -213,8 +229,11 @@ declare global {
      * Which collision objects to hit is filtered by their collision groups and can be configured
      * through `groups`.
      * The actual ray cast will be performed during the physics-update.
+     *
      * - If an object is hit, the result will be reported via a ray_cast_response message.
+     *
      * - If there is no object hit, the result will be reported via a ray_cast_missed message.
+     *
      * NOTE: Ray casts will ignore collision objects that contain the starting point of the ray. This is a limitation in Box2D.
      *
      * @param from - the world position of the start of the ray
@@ -250,15 +269,22 @@ declare global {
      * Only one physics world event listener can be set at a time.
      *
      * @param callback - A callback that receives an information about all the physics interactions in this physics world.
+     *
      * `self`
      * object The calling script
      * `event`
      * constant The type of event. Can be one of these messages:
+     *
      * - contact_point_event
+     *
      * - collision_event
+     *
      * - trigger_event
+     *
      * - ray_cast_response
+     *
      * - ray_cast_missed
+     *
      * `data`
      * table The callback value data is a table that contains event-related data. See the documentation for details on the messages.
      * @example
@@ -368,6 +394,7 @@ declare global {
      *
      * @param url - the collision object affected.
      * @param group - the new group name to be assigned.
+     *
      * `local function change_collision_group()
      * physics.set_group("#collisionobject", "enemy")
      * end
@@ -407,6 +434,7 @@ declare global {
      * @param url - the collision object to change the mask of.
      * @param group - the name of the group (maskbit) to modify in the mask.
      * @param maskbit - boolean value of the new maskbit. 'true' to enable, 'false' to disable.
+     *
      * `local function make_invincible()
      * -- no longer collide with the "bullet" group
      * physics.set_maskbit("#collisionobject", "bullet", false)
@@ -423,6 +451,7 @@ declare global {
      * @param shape - the name of the shape to get data for.
      * @param table - the shape data to update the shape with.
      * See physics.get_shape for a detailed description of each field in the data table.
+     *
      * `local function set_shape_data()
      * -- set capsule shape data
      * local data = {}
@@ -430,11 +459,13 @@ declare global {
      * data.diameter = 10
      * data.height = 20
      * physics.set_shape("#collisionobject", "my_capsule_shape", data)
+     *
      * -- set sphere shape data
      * data = {}
      * data.type = physics.SHAPE_TYPE_SPHERE
      * data.diameter = 10
      * physics.set_shape("#collisionobject", "my_sphere_shape", data)
+     *
      * -- set box shape data
      * data = {}
      * data.type = physics.SHAPE_TYPE_BOX
@@ -477,6 +508,7 @@ declare global {
      * efficiency reasons. This function wakes them up.
      *
      * @param url - the collision object to wake.
+     *
      * `function on_input(self, action_id, action)
      * if action_id == hash("test") and action.pressed then
      * physics.wakeup("#collisionobject")

package/generated/profiler.d.ts

@@ -82,15 +82,20 @@ declare global {
      * Get the amount of memory used (resident/working set) by the application in bytes, as reported by the OS.
      * This function is not available on HTML5.
      * The values are gathered from internal OS functions which correspond to the following;
+     *
      * OS
      * Value
+     *
      * iOS
      * MacOS
+     *
      * Android
      * Linux
      * Resident memory
+     *
      * Windows
      * Working set
+     *
      * HTML5
      * Not available
      *
@@ -148,10 +153,15 @@ declare global {
      * Set the on-screen profile mode - run, pause, record or show peak frame
      *
      * @param mode - the mode to set the ui profiler in
+     *
      * - `profiler.MODE_RUN` This is default mode that continously shows the last frame
+     *
      * - `profiler.MODE_PAUSE` Pauses on the currently displayed frame
+     *
      * - `profiler.MODE_SHOW_PEAK_FRAME` Pauses on the currently displayed frame but shows a new frame if that frame is slower
+     *
      * - `profiler.MODE_RECORD` Records all incoming frames to the recording buffer
+     *
      * To stop recording, switch to a different mode such as `MODE_PAUSE` or `MODE_RUN`.
      * You can also use the `view_recorded_frame` function to display a recorded frame. Doing so stops the recording as well.
      * Every time you switch to recording mode the recording buffer is cleared.
@@ -171,7 +181,9 @@ declare global {
      * Set the on-screen profile view mode - minimized or expanded
      *
      * @param mode - the view mode to set the ui profiler in
+     *
      * - `profiler.VIEW_MODE_FULL` The default mode which displays all the ui profiler details
+     *
      * - `profiler.VIEW_MODE_MINIMIZED` Minimized mode which only shows the top header (fps counters and ui profiler mode)
      * @example
      * ```ts
@@ -205,7 +217,9 @@ declare global {
      * The frame to show can either be an absolute frame or a relative frame to the current frame.
      *
      * @param frame_index - a table where you specify one of the following parameters:
+     *
      * - `distance` The offset from the currently displayed frame (this is truncated between zero and the number of recorded frames)
+     *
      * - `frame` The frame index in the recording buffer (1 is first recorded frame)
      * @example
      * ```ts