@defold-typescript/types 0.37.0 → 0.39.0

package/generated/resource.d.ts

@@ -18,6 +18,7 @@ declare global {
      * @param path - optional resource path string to the resource
      * @returns a path hash to the binary version of the resource
      * @example
+     * Load an atlas and set it to a sprite:
      * ```ts
      * // Load an atlas and set it to a sprite:
      * go.property("my_atlas", resource.atlas("/atlas.atlas"));
@@ -27,7 +28,10 @@ declare global {
      *     go.set("#sprite", "image", self.my_atlas);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Load an atlas and set it to a gui:
+     * ```ts
      * // Load an atlas and set it to a gui:
      * go.property("my_atlas", resource.atlas("/atlas.atlas"));
      *
@@ -78,109 +82,67 @@ declare global {
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the atlas. Supported entries:
      *
-     * -
-     *
-     * `texture`
+     * - `texture`
      * string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
      *
-     * -
-     *
-     * `animations`
+     * - `animations`
      * table a list of the animations in the atlas. Supports the following fields:
      *
-     * -
-     *
-     * `id`
+     * - `id`
      * string the id of the animation, used in e.g sprite.play_animation
      *
-     * -
-     *
-     * `width`
+     * - `width`
      * number the width of the animation
      *
-     * -
-     *
-     * `height`
+     * - `height`
      * number the height of the animation
      *
-     * -
-     *
-     * `frame_start`
+     * - `frame_start`
      * number index to the first geometry of the animation. Indices are lua based and must be in the range of 1 .. in atlas.
      *
-     * -
-     *
-     * `frame_end`
+     * - `frame_end`
      * number index to the last geometry of the animation (non-inclusive). Indices are lua based and must be in the range of 1 .. in atlas.
      *
-     * -
-     *
-     * `playback`
+     * - `playback`
      * constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
      *
-     * -
-     *
-     * `fps`
+     * - `fps`
      * number optional fps of the animation, the default value is 30
      *
-     * -
-     *
-     * `flip_vertical`
+     * - `flip_vertical`
      * boolean optional flip the animation vertically, the default value is false
      *
-     * -
-     *
-     * `flip_horizontal`
+     * - `flip_horizontal`
      * boolean optional flip the animation horizontally, the default value is false
      *
-     * -
-     *
-     * `geometries`
+     * - `geometries`
      * table A list of the geometries that should map to the texture data. Supports the following fields:
      *
-     * -
-     *
-     * `id`
+     * - `id`
      * string The name of the geometry. Used when matching animations between multiple atlases
      *
-     * -
-     *
-     * `width`
+     * - `width`
      * number The width of the image the sprite geometry represents
      *
-     * -
-     *
-     * `height`
+     * - `height`
      * number The height of the image the sprite geometry represents
      *
-     * -
-     *
-     * `pivot_x`
+     * - `pivot_x`
      * number The pivot x value of the image in unit coords. (0,0) is upper left corner, (1,1) is bottom right. Default is 0.5.
      *
-     * -
-     *
-     * `pivot_y`
+     * - `pivot_y`
      * number The pivot y value of the image in unit coords. (0,0) is upper left corner, (1,1) is bottom right. Default is 0.5.
      *
-     * -
-     *
-     * `rotated`
+     * - `rotated`
      * boolean Whether the image is rotated 90 degrees counter-clockwise in the atlas. This affects UV coordinate generation for proper rendering. Default is false.
      *
-     * -
-     *
-     * `vertices`
+     * - `vertices`
      * table a list of the vertices in image space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
      *
-     * -
-     *
-     * `uvs`
+     * - `uvs`
      * table a list of the uv coordinates in image space of the geometry in the form of {u0, v0, u1, v1, ..., un, vn}.
      *
-     * -
-     *
-     * `indices`
+     * - `indices`
      * table a list of the indices of the geometry in the form {i0, i1, i2, ..., in}. Each tripe in the list represents a triangle.
      * @returns Returns the atlas resource path
      * @example
@@ -247,17 +209,14 @@ declare global {
      * @param path - The path to the resource.
      * @param table - A table containing info about how to create the buffer. Supported entries:
      *
-     * -
-     *
-     * `buffer`
+     * - `buffer`
      * buffer the buffer to bind to this resource
      *
-     * -
-     *
-     * `transfer_ownership`
+     * - `transfer_ownership`
      * boolean optional flag to determine whether or not the resource should take over ownership of the buffer object (default true)
      * @returns Returns the buffer resource path
      * @example
+     * Create a buffer object and bind it to a buffer resource
      * ```ts
      * // Create a buffer object and bind it to a buffer resource
      * export default defineScript({
@@ -293,7 +252,10 @@ declare global {
      *     go.set("/go#mesh", "vertices", my_buffer);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Create a buffer resource from existing resource
+     * ```ts
      * // Create a buffer resource from existing resource
      * export default defineScript({
      *   init() {
@@ -449,7 +411,9 @@ declare global {
      * if graphics.TEXTURE_TYPE_3D ~= nil then
      * -- Device and graphics adapter support 3D textures
      * end
+     * ```
      * @example
+     * How to create an 128x128 RGBA texture resource and assign it to a model
      * ```ts
      * // How to create an 128x128 RGBA texture resource and assign it to a model
      * export default defineScript({
@@ -464,7 +428,10 @@ declare global {
      *     go.set("#model", "texture0", my_texture_id);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to create an 128x128 floating point texture (RGBA32F) resource from a buffer object
+     * ```ts
      * // How to create an 128x128 floating point texture (RGBA32F) resource from a buffer object
      * export default defineScript({
      *   init() {
@@ -498,7 +465,10 @@ declare global {
      *     go.set("#model", "texture0", my_texture_id);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to create a 32x32x32 floating point 3D texture that can be used to generate volumetric data in a compute shader
+     * ```ts
      * // How to create a 32x32x32 floating point 3D texture that can be used to generate volumetric data in a compute shader
      * export default defineScript({
      *   init() {
@@ -515,7 +485,10 @@ declare global {
      *     msg.post("@render:", "add_textures", [t_volume]);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to create 512x512 texture array with 5 pages.
+     * ```ts
      * // How to create 512x512 texture array with 5 pages.
      * const new_tex = resource.create_texture("/runtime/example_array.texturec", {
      *   type: graphics.TEXTURE_TYPE_2D_ARRAY,
@@ -526,7 +499,7 @@ declare global {
      * });
      * ```
      */
-    function create_texture(path: string, table: { type?: number; width?: number; height?: number; depth?: number; format?: number; flags?: number; max_mipmaps?: number; compression_type?: number }, buffer?: Opaque<"buffer">): Hash;
+    function create_texture(path: string, table: { type?: number; width?: number; height?: number; depth?: number; format?: number; flags?: number; max_mipmaps?: number; compression_type?: number; page_count?: number }, buffer?: Opaque<"buffer">): Hash;
     /**
      * Creates a new texture resource that can be used in the same way as any texture created during build time.
      * The path used for creating the texture must be unique, trying to create a resource at a path that is already
@@ -639,14 +612,15 @@ declare global {
      * @param buffer - optional buffer of precreated pixel data
      * @param callback - callback function when texture is created (self, request_id, resource)
      * @example
+     * Create a texture resource asyncronously with a buffer and a callback
      * ```ts
      * // Create a texture resource asyncronously with a buffer and a callback
-     * function callback(self, request_id, resource) {
+     * function callback(self: unknown, request_id: unknown, texture_path: unknown) {
      *   // The resource has been updated with a new texture,
      *   // so we can update other systems with the new handle,
      *   // or update components to use the resource if we want
-     *   const tinfo = resource.get_texture_info(resource);
-     *   msg.post("@render:", "set_backing_texture", tinfo.handle);
+     *   const tinfo = resource.get_texture_info(texture_path as Hash);
+     *   msg.post("@render:", "set_backing_texture", { handle: tinfo.handle });
      * }
      *
      * export default defineScript({
@@ -680,7 +654,10 @@ declare global {
      *     go.set("#model", "texture0", tpath);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Create a texture resource asyncronously without a callback
+     * ```ts
      * // Create a texture resource asyncronously without a callback
      * export default defineScript({
      *   init() {
@@ -728,6 +705,7 @@ declare global {
      * @param path - optional resource path string to the resource
      * @returns a path hash to the binary version of the resource
      * @example
+     * Load a font and set it to a label:
      * ```ts
      * // Load a font and set it to a label:
      * go.property("my_font", resource.font("/font.font"));
@@ -737,7 +715,10 @@ declare global {
      *     go.set("#label", "font", self.my_font);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Load a font and set it to a gui:
+     * ```ts
      * // Load a font and set it to a gui:
      * go.property("my_font", resource.font("/font.font"));
      *
@@ -828,14 +809,12 @@ declare global {
      *
      * - `resource.BUFFER_TYPE_DEPTH`
      *
-     * -
-     * `resource.BUFFER_TYPE_STENCIL`
-     *
-     * -
+     * - `resource.BUFFER_TYPE_STENCIL`
      *
-     * `texture`
+     * - `texture`
      * hash The hashed path to the attachment texture resource. This field is only available if the render target passed in is a resource.
      * @example
+     * Get the metadata from a render target resource
      * ```ts
      * // Get the metadata from a render target resource
      * export default defineScript({
@@ -847,7 +826,10 @@ declare global {
      *     const info_attachment_1 = resource.get_texture_info(info.attachments[0]!.handle);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Get a texture attachment from a render target and set it on a model component
+     * ```ts
      * // Get a texture attachment from a render target and set it on a model component
      * export default defineScript({
      *   init() {
@@ -932,6 +914,7 @@ declare global {
      *
      * - `graphics.TEXTURE_TYPE_CUBE_MAP`
      * @example
+     * Create a new texture and get the metadata from it
      * ```ts
      * // Create a new texture and get the metadata from it
      * export default defineScript({
@@ -960,7 +943,10 @@ declare global {
      *     // }
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Get the meta data from an atlas resource
+     * ```ts
      * // Get the meta data from an atlas resource
      * export default defineScript({
      *   init() {
@@ -1004,6 +990,7 @@ declare global {
      * @param path - optional resource path string to the resource
      * @returns a path hash to the binary version of the resource
      * @example
+     * Load a material and set it to a sprite:
      * ```ts
      * // Load a material and set it to a sprite:
      * go.property("my_material", resource.material("/material.material"));
@@ -1013,7 +1000,10 @@ declare global {
      *     go.set("#sprite", "material", self.my_material);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Load a material resource and update a named material with the resource:
+     * ```ts
      * // Load a material resource and update a named material with the resource:
      * go.property("my_material", resource.material("/material.material"));
      *
@@ -1087,81 +1077,52 @@ declare global {
      * @param path - The path to the atlas resource
      * @param table - A table containing info about the atlas. Supported entries:
      *
-     * -
-     *
-     * `texture`
+     * - `texture`
      * string | hash the path to the texture resource, e.g "/main/my_texture.texturec"
      *
-     * -
-     *
-     * `animations`
+     * - `animations`
      * table a list of the animations in the atlas. Supports the following fields:
      *
-     * -
-     *
-     * `id`
+     * - `id`
      * string the id of the animation, used in e.g sprite.play_animation
      *
-     * -
-     *
-     * `width`
+     * - `width`
      * number the width of the animation
      *
-     * -
-     *
-     * `height`
+     * - `height`
      * number the height of the animation
      *
-     * -
-     *
-     * `frame_start`
+     * - `frame_start`
      * number index to the first geometry of the animation. Indices are lua based and must be in the range of 1 .. in atlas.
      *
-     * -
-     *
-     * `frame_end`
+     * - `frame_end`
      * number index to the last geometry of the animation (non-inclusive). Indices are lua based and must be in the range of 1 .. in atlas.
      *
-     * -
-     *
-     * `playback`
+     * - `playback`
      * constant optional playback mode of the animation, the default value is go.PLAYBACK_ONCE_FORWARD
      *
-     * -
-     *
-     * `fps`
+     * - `fps`
      * number optional fps of the animation, the default value is 30
      *
-     * -
-     *
-     * `flip_vertical`
+     * - `flip_vertical`
      * boolean optional flip the animation vertically, the default value is false
      *
-     * -
-     *
-     * `flip_horizontal`
+     * - `flip_horizontal`
      * boolean optional flip the animation horizontally, the default value is false
      *
-     * -
-     *
-     * `geometries`
+     * - `geometries`
      * table A list of the geometries that should map to the texture data. Supports the following fields:
      *
-     * -
-     *
-     * `vertices`
+     * - `vertices`
      * table a list of the vertices in texture space of the geometry in the form {px0, py0, px1, py1, ..., pxn, pyn}
      *
-     * -
-     *
-     * `uvs`
+     * - `uvs`
      * table a list of the uv coordinates in texture space of the geometry in the form of {u0, v0, u1, v1, ..., un, vn}
      *
-     * -
-     *
-     * `indices`
+     * - `indices`
      * table a list of the indices of the geometry in the form {i0, i1, i2, ..., in}. Each tripe in the list represents a triangle.
      * @example
+     * Add a new animation to an existing atlas
      * ```ts
      * // Add a new animation to an existing atlas
      * export default defineScript({
@@ -1180,7 +1141,10 @@ declare global {
      *     resource.set_atlas("/main/my_atlas.a.texturesetc", data);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Sets atlas data for a 256x256 texture with a single animation being rendered as a quad
+     * ```ts
      * // Sets atlas data for a 256x256 texture with a single animation being rendered as a quad
      * export default defineScript({
      *   init() {
@@ -1221,16 +1185,14 @@ declare global {
      * @param buffer - The resource buffer
      * @param table - A table containing info about how to set the buffer. Supported entries:
      *
-     * -
-     *
-     * `transfer_ownership`
+     * - `transfer_ownership`
      * boolean optional flag to determine whether or not the resource should take over ownership of the buffer object (default false)
      * @example
      * ```ts
      * // How to set the data from a buffer
-     * function fill_stream(stream, verts) {
+     * function fill_stream(stream: { [index: number]: number }, verts: number[]) {
      *   verts.forEach((value, key) => {
-     *     stream[key] = verts[key];
+     *     stream[key] = value;
      *   });
      * }
      *
@@ -1350,7 +1312,9 @@ declare global {
      * if graphics.TEXTURE_TYPE_3D ~= nil then
      * -- Device and graphics adapter support 3D textures
      * end
+     * ```
      * @example
+     * How to set all pixels of an atlas
      * ```ts
      * // How to set all pixels of an atlas
      * export default defineScript({
@@ -1374,7 +1338,10 @@ declare global {
      *     resource.set_texture(resource_path, args, self.buffer);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to update a specific region of an atlas by using the x,y values. Assumes the already set atlas is a 128x128 texture.
+     * ```ts
      * // How to update a specific region of an atlas by using the x,y values. Assumes the already set atlas is a 128x128 texture.
      * export default defineScript({
      *   init(self) {
@@ -1399,7 +1366,10 @@ declare global {
      *     resource.set_texture(resource_path, args, self.buffer);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Update a texture from a buffer resource
+     * ```ts
      * // Update a texture from a buffer resource
      * go.property("my_buffer", resource.buffer("/my_default_buffer.buffer"));
      *
@@ -1419,7 +1389,10 @@ declare global {
      *     resource.set_texture(resource_path, args, resource.get_buffer(self.my_buffer));
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Update an existing 3D texture from a lua buffer
+     * ```ts
      * // Update an existing 3D texture from a buffer
      * export default defineScript({
      *   init() {
@@ -1455,24 +1428,37 @@ declare global {
      *     resource.set_texture("/my_3d_texture.texturec", t_args, tbuffer);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * ```ts
      * // Update texture 2nd array page with loaded texture from png
-     * // new_tex is resource handle of texture which was created via resource.create_resource
      * const tex_path = "/bundle_resources/page_02.png";
      * const [data] = sys.load_resource(tex_path);
-     * const buf = image.load_buffer(data);
-     * resource.set_texture(
-     *   new_tex,
-     *   {
-     *     type: graphics.TEXTURE_TYPE_2D_ARRAY,
-     *     width: buf.width,
-     *     height: buf.height,
-     *     page: 1,
-     *     format: graphics.TEXTURE_FORMAT_RGB,
-     *   },
-     *   buf.buffer,
-     * );
-     * go.set("#mesh", "texture0", new_tex);
+     * if (data !== undefined) {
+     *   const buf = image.load_buffer(data);
+     *   if (buf !== undefined) {
+     *     // new_tex is the resource handle of a texture created via resource.create_texture
+     *     const new_tex = resource.create_texture("/my_array_texture.texturec", {
+     *       type: graphics.TEXTURE_TYPE_2D_ARRAY,
+     *       width: buf.width,
+     *       height: buf.height,
+     *       page_count: 2,
+     *       format: graphics.TEXTURE_FORMAT_RGB,
+     *     });
+     *     resource.set_texture(
+     *       new_tex,
+     *       {
+     *         type: graphics.TEXTURE_TYPE_2D_ARRAY,
+     *         width: buf.width,
+     *         height: buf.height,
+     *         page: 1,
+     *         format: graphics.TEXTURE_FORMAT_RGB,
+     *       },
+     *       buf.buffer,
+     *     );
+     *     go.set("#mesh", "texture0", new_tex);
+     *   }
+     * }
      * ```
      */
     function set_texture(path: Hash | string, table: { type?: number; width?: number; height?: number; format?: number; x?: number; y?: number; z?: number; page?: number; mipmap?: number; compression_type?: number }, buffer: Opaque<"buffer">): void;

package/generated/socket.d.ts

@@ -635,14 +635,17 @@ declare global {
      * @example
      * ```ts
      * // Perform operations on an open socket c:
-     * // 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());
-     * // ...
-     * try_(c.send("good bye\r\n"));
-     * c.close();
+     * const [c] = socket.connect("localhost", 80);
+     * if (c !== undefined) {
+     *   // 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());
+     *   // ...
+     *   try_(c.send("good bye\r\n"));
+     *   c.close();
+     * }
      * ```
      */
     function newtry(finalizer: () => void): (...args: unknown[]) => unknown;
@@ -694,6 +697,8 @@ declare global {
      * @param retN - argument N.
      * @example
      * ```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)(.?)");

package/generated/sound.d.ts

@@ -193,9 +193,10 @@ declare global {
      * sound.play("#sound", { delay: 1, gain: 0.9, pan: -1.0 });
      *
      * // Using the callback argument, you can chain several sounds together:
-     * function sound_done(self, message_id, message, sender) {
+     * function sound_done(self: unknown, message_id: unknown, message: unknown, sender: unknown) {
      *   // play 'boom' sound fx when the countdown has completed
-     *   if (message_id === hash("sound_done") && message.play_id === self.countdown_id) {
+     *   const { play_id } = message as { play_id: number };
+     *   if (message_id === hash("sound_done") && play_id === (self as { countdown_id: number }).countdown_id) {
      *     sound.play("#boom", undefined, sound_done);
      *   }
      * }