@defold-typescript/types 0.44.1 → 0.45.0

package/generated/versions/defold-1.13.0/material.d.ts

@@ -108,7 +108,16 @@ declare global {
      * vmath.vector4 | vmath.matrix4 the value(s) of the constant. If the constant is an array, the value will be a table of vmath.vector4 or vmath.matrix4 if the type is `material.CONSTANT_TYPE_USER_MATRIX4`.
      * @example
      * ```ts
-     * const constants = material.get_constants(resource.material("/my_material.materialc"));
+     * // Get the shader constants from a material specified as a resource property
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material() },
+     *
+     *   init(self) {
+     *     const constants = material.get_constants(self.my_material);
+     *   },
+     * });
      * ```
      */
     function get_constants(path: Hash | string): { name: Hash; type: number; value: Vector4 | Matrix4 }[];
@@ -159,7 +168,16 @@ declare global {
      * number the max anisotropy of the texture sampler
      * @example
      * ```ts
-     * const samplers = material.get_samplers(resource.material("/my_material.materialc"));
+     * // Get the texture samplers from a material specified as a resource property
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material() },
+     *
+     *   init(self) {
+     *     const samplers = material.get_samplers(self.my_material);
+     *   },
+     * });
      * ```
      */
     function get_samplers(path: Hash | string): { name: Hash; u_wrap: number; v_wrap: number; min_filter: number; mag_filter: number; max_anisotropy: number }[];
@@ -201,7 +219,16 @@ declare global {
      * - `graphics.TEXTURE_USAGE_FLAG_COLOR`
      * @example
      * ```ts
-     * const textures = material.get_textures(resource.material("/my_material.materialc"));
+     * // Get the textures from a material specified as a resource property
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material() },
+     *
+     *   init(self) {
+     *     const textures = material.get_textures(self.my_material);
+     *   },
+     * });
      * ```
      */
     function get_textures(path: Hash | string): { path: Hash; handle: Hash; width: number; height: number; depth: number; mipmaps: number; type: number; flags: number }[];
@@ -252,7 +279,16 @@ declare global {
      * - `graphics.SEMANTIC_TYPE_TEXTURE_TRANSFORM_2D`
      * @example
      * ```ts
-     * const vertex_attributes = material.get_vertex_attributes(resource.material("/my_material.materialc"));
+     * // Get the vertex attributes from a material specified as a resource property
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material() },
+     *
+     *   init(self) {
+     *     const vertex_attributes = material.get_vertex_attributes(self.my_material);
+     *   },
+     * });
      * ```
      */
     function get_vertex_attributes(path: Hash | string): { name: Hash; value: Vector4 | Vector3 | Matrix4 | number | number[]; normalize: boolean; data_type: number; coordinate_space: number; semantic_type: number }[];
@@ -287,7 +323,27 @@ declare global {
      * vmath.vector4 | vmath.vector3 | vmath.matrix4 | number | table the value(s) of the constant. If the shader constant is an array, the amount of values to update depends on how many values that are passed in the 'value' field.
      * @example
      * ```ts
-     * material.set_constants(resource.material("/my_material.materialc"), { tint: { value: vmath.vector4(1, 0, 0, 1) } });
+     * // Set a shader constant in a material specified as a resource property
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material() },
+     *
+     *   init() {
+     *     return { my_view_proj: vmath.matrix4() };
+     *   },
+     *
+     *   update(self) {
+     *     // update the 'tint' constant
+     *     material.set_constants(self.my_material, {
+     *       tint: { value: vmath.vector4(1, 0, 0, 1) },
+     *     });
+     *     // change the type of the 'view_proj' constant to CONSTANT_TYPE_USER_MATRIX4 so the renderer can set our custom data
+     *     material.set_constants(self.my_material, {
+     *       view_proj: { value: self.my_view_proj, type: material.CONSTANT_TYPE_USER_MATRIX4 },
+     *     });
+     *   },
+     * });
      * ```
      */
     function set_constants(path: Hash | string, constants: Record<string, { type?: number; value?: Vector4 | Vector3 | Matrix4 | number | (Vector4 | Matrix4)[] }>): void;
@@ -336,7 +392,18 @@ declare global {
      * number the max anisotropy of the texture sampler
      * @example
      * ```ts
-     * material.set_samplers(resource.material("/my_material.materialc"), { texture_sampler: { u_wrap: graphics.TEXTURE_WRAP_REPEAT, v_wrap: graphics.TEXTURE_WRAP_MIRRORED_REPEAT } });
+     * // Configures a sampler in a material specified as a resource property
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material() },
+     *
+     *   init(self) {
+     *     material.set_samplers(self.my_material, {
+     *       texture_sampler: { u_wrap: graphics.TEXTURE_WRAP_REPEAT, v_wrap: graphics.TEXTURE_WRAP_MIRRORED_REPEAT },
+     *     });
+     *   },
+     * });
      * ```
      */
     function set_samplers(path: Hash | string, samplers: Record<string, { u_wrap?: number; v_wrap?: number; min_filter?: number; mag_filter?: number; max_anisotropy?: number }>): void;
@@ -347,7 +414,18 @@ declare global {
      * @param textures - A table keyed by sampler name with texture resources as values.
      * @example
      * ```ts
-     * material.set_textures(resource.material("/my_material.materialc"), { my_texture: resource.texture() });
+     * // Set a texture in a material from a resource
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registrations from this field, and only this field types them onto `self`.
+     *   properties: { my_material: resource.material(), my_texture: resource.texture() },
+     *
+     *   init(self) {
+     *     material.set_textures(self.my_material, {
+     *       my_texture: self.my_texture,
+     *     });
+     *   },
+     * });
      * ```
      */
     function set_textures(path: Hash | string, textures: LuaMap<string, Hash> | Record<string, Hash>): void;
@@ -396,7 +474,19 @@ declare global {
      * - `graphics.SEMANTIC_TYPE_TEXTURE_TRANSFORM_2D`
      * @example
      * ```ts
-     * material.set_vertex_attributes(resource.material("/my_material.materialc"), { tint_attribute: { value: vmath.vector4(1, 0, 0, 1), semantic_type: graphics.SEMANTIC_TYPE_COLOR } });
+     * // Configures a vertex attribute in a material specified as a resource property
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_material: resource.material() },
+     *
+     *   init(self) {
+     *     material.set_vertex_attributes(self.my_material, {
+     *       tint_attribute: { value: vmath.vector4(1, 0, 0, 1), semantic_type: graphics.SEMANTIC_TYPE_COLOR },
+     *       weights: { value: vmath.vector4(0, 1, 0, 0), semantic_type: graphics.SEMANTIC_TYPE_NONE },
+     *     });
+     *   },
+     * });
      * ```
      */
     function set_vertex_attributes(path: Hash | string, attributes: Record<string, { value?: Vector4 | Vector3 | Matrix4 | number | number[]; normalize?: boolean; data_type?: number; coordinate_space?: number; semantic_type?: number }>): void;

package/generated/versions/defold-1.13.0/model.d.ts

@@ -33,10 +33,14 @@ declare global {
      * @returns array of weight values, or empty table if the model has no morph targets
      * @example
      * ```ts
-     * const weights = model.get_blend_weights("#model");
-     * weights[1] = 0.75;
-     * weights[2] = 0.25;
-     * model.set_blend_weights("#model", weights);
+     * const w = model.get_blend_weights("#model");
+     * w.forEach((weight, i) => {
+     *   print(i + 1, weight);
+     * });
+     * // change the data in the table and then set the weights again
+     * w[0] = 0.75;
+     * w[1] = 0.25;
+     * model.set_blend_weights("#model", w);
      * ```
      */
     function get_blend_weights(url: string | Hash | Url): number[];
@@ -197,8 +201,10 @@ declare global {
      * @param weights - array of weight values (1-based indices). Omit or pass `nil` to clear the override and return morphs to animation only
      * @example
      * ```ts
+     * // set the weights for the first 4 morph targets
      * model.set_blend_weights("#model", [0, 1, 0.5, 0]);
-     * model.set_blend_weights("#model");
+     * // clear the override, animation will continue if the weights are driven by an animation
+     * model.set_blend_weights("#model"); // clear script override
      * ```
      */
     function set_blend_weights(url: string | Hash | Url, weights?: number[]): void;

package/generated/versions/defold-1.13.0/particlefx.d.ts

@@ -50,15 +50,13 @@ declare global {
      * // How to play a particle fx when a game object is created.
      * // The callback receives the hash of the path to the particlefx, the hash of the id
      * // of the emitter, and the new state of the emitter as particlefx.EMITTER_STATE_.
-     * function emitter_state_change(self: unknown, id: unknown, emitter: unknown, state: unknown) {
-     *   if (emitter === hash("exhaust") && state === particlefx.EMITTER_STATE_POSTSPAWN) {
-     *     // exhaust is done spawning particles...
-     *   }
-     * }
-     *
      * export default defineScript({
      *   init(self) {
-     *     particlefx.play("#particlefx", emitter_state_change);
+     *     particlefx.play("#particlefx", (self, id, emitter, state) => {
+     *       if (emitter === hash("exhaust") && state === particlefx.EMITTER_STATE_POSTSPAWN) {
+     *         // exhaust is done spawning particles...
+     *       }
+     *     });
      *   },
      * });
      * ```

package/generated/versions/defold-1.13.0/render.d.ts

@@ -70,11 +70,16 @@ declare global {
      * @example
      * Then use the constant buffer when drawing a predicate:
      * ```ts
-     * function draw_tinted(self: { my_pred: Opaque<"render_predicate"> }) {
-     *   const constants = render.constant_buffer();
-     *   constants.tint = vmath.vector4(1, 1, 1, 1);
-     *   render.draw(self.my_pred, { constants });
-     * }
+     * export default defineRenderScript({
+     *   init() {
+     *     return { my_pred: render.predicate([hash("my_tag")]) };
+     *   },
+     *
+     *   update(self, dt) {
+     *     const constants = render.constant_buffer();
+     *     render.draw(self.my_pred, { constants });
+     *   },
+     * });
      * ```
      * @example
      * The constant buffer also supports array values by specifying constants in a table:
@@ -449,13 +454,13 @@ declare global {
      * ```
      * @example
      * ```ts
-     * // Or enable a render target by resource id:
      * export default defineRenderScript({
      *   init() {
      *     return { my_pred: render.predicate([hash("my_tag")]) };
      *   },
      *
      *   update(self, dt) {
+     *     // enable render target by resource id
      *     render.set_render_target("my_rt_resource");
      *     render.draw(self.my_pred);
      *     render.set_render_target(render.RENDER_TARGET_DEFAULT);
@@ -469,7 +474,6 @@ declare global {
      * ```
      * @example
      * ```ts
-     * // Or bind a texture handle directly:
      * export default defineRenderScript({
      *   init() {
      *     return { my_texture_handle: resource.get_texture_info("/main/my_texture.texturec").handle };
@@ -512,15 +516,10 @@ declare global {
      * ```ts
      * export default defineRenderScript({
      *   init() {
-     *     // render target buffer parameters
      *     const color_params = {
      *       format: graphics.TEXTURE_FORMAT_RGBA,
      *       width: render.get_window_width(),
      *       height: render.get_window_height(),
-     *       min_filter: graphics.TEXTURE_FILTER_LINEAR,
-     *       mag_filter: graphics.TEXTURE_FILTER_LINEAR,
-     *       u_wrap: graphics.TEXTURE_WRAP_CLAMP_TO_EDGE,
-     *       v_wrap: graphics.TEXTURE_WRAP_CLAMP_TO_EDGE,
      *     };
      *     return {
      *       target_right: render.render_target("right", {
@@ -554,15 +553,10 @@ declare global {
      * ```ts
      * export default defineRenderScript({
      *   init() {
-     *     // render target buffer parameters
      *     const color_params = {
      *       format: graphics.TEXTURE_FORMAT_RGBA,
      *       width: render.get_window_width(),
      *       height: render.get_window_height(),
-     *       min_filter: graphics.TEXTURE_FILTER_LINEAR,
-     *       mag_filter: graphics.TEXTURE_FILTER_LINEAR,
-     *       u_wrap: graphics.TEXTURE_WRAP_CLAMP_TO_EDGE,
-     *       v_wrap: graphics.TEXTURE_WRAP_CLAMP_TO_EDGE,
      *     };
      *     return {
      *       target_right: render.render_target("right", {
@@ -1003,13 +997,13 @@ declare global {
      * ```
      * @example
      * ```ts
-     * // Or set the render target by a render target resource identifier:
      * export default defineRenderScript({
      *   init() {
      *     return { my_pred: render.predicate([hash("my_tag")]) };
      *   },
      *
      *   update(self, dt) {
+     *     // set render target by a render target resource identifier
      *     render.set_render_target("my_rt_resource");
      *
      *     // draw a predicate to the render target

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

@@ -605,22 +605,20 @@ declare global {
      * string The stack traceback.
      * @example
      * ```ts
-     * // Install error handler that just prints the errors
-     * function my_error_handler(source: unknown, message: unknown, traceback: unknown) {
-     *   print(source); //> lua
-     *   print(message); //> main/my.script:10: attempt to perform arithmetic on a string value
-     *   print(traceback); //> stack traceback:
-     *   //>         main/test.script:10: in function 'boom'
-     *   //>         main/test.script:15: in function <main/my.script:13>
-     * }
-     *
      * function boom() {
      *   return 10 + "string";
      * }
      *
      * export default defineScript({
      *   init() {
-     *     sys.set_error_handler(my_error_handler);
+     *     // Install error handler that just prints the errors
+     *     sys.set_error_handler((source, message, traceback) => {
+     *       print(source); //> lua
+     *       print(message); //> main/my.script:10: attempt to perform arithmetic on a string value
+     *       print(traceback); //> stack traceback:
+     *       //>         main/test.script:10: in function 'boom'
+     *       //>         main/test.script:15: in function <main/my.script:13>
+     *     });
      *     boom();
      *   },
      * });

package/generated/versions/defold-1.13.0/window.d.ts

@@ -127,23 +127,21 @@ declare global {
      * - number `height`: The height of a resize event. nil otherwise.
      * @example
      * ```ts
-     * function window_callback(self: unknown, event: unknown, data: Record<string | number, unknown>) {
-     *   if (event === window.WINDOW_EVENT_FOCUS_LOST) {
-     *     print("window.WINDOW_EVENT_FOCUS_LOST");
-     *   } else if (event === window.WINDOW_EVENT_FOCUS_GAINED) {
-     *     print("window.WINDOW_EVENT_FOCUS_GAINED");
-     *   } else if (event === window.WINDOW_EVENT_ICONFIED) {
-     *     print("window.WINDOW_EVENT_ICONFIED");
-     *   } else if (event === window.WINDOW_EVENT_DEICONIFIED) {
-     *     print("window.WINDOW_EVENT_DEICONIFIED");
-     *   } else if (event === window.WINDOW_EVENT_RESIZED) {
-     *     print("Window resized: ", data.width, data.height);
-     *   }
-     * }
-     *
      * export default defineScript({
      *   init() {
-     *     window.set_listener(window_callback);
+     *     window.set_listener((self, event, data) => {
+     *       if (event === window.WINDOW_EVENT_FOCUS_LOST) {
+     *         print("window.WINDOW_EVENT_FOCUS_LOST");
+     *       } else if (event === window.WINDOW_EVENT_FOCUS_GAINED) {
+     *         print("window.WINDOW_EVENT_FOCUS_GAINED");
+     *       } else if (event === window.WINDOW_EVENT_ICONFIED) {
+     *         print("window.WINDOW_EVENT_ICONFIED");
+     *       } else if (event === window.WINDOW_EVENT_DEICONIFIED) {
+     *         print("window.WINDOW_EVENT_DEICONIFIED");
+     *       } else if (event === window.WINDOW_EVENT_RESIZED) {
+     *         print("Window resized: ", data.width, data.height);
+     *       }
+     *     });
      *   },
      * });
      * ```

package/generated/versions/defold-1.13.1/b2d_fixture.d.ts

@@ -135,10 +135,32 @@ declare global {
      * ```ts
      * const body = b2d.get_body("#collisionobject");
      * if (body !== undefined) {
+     *   // Move a circle shape relative to the body origin.
      *   const circle = b2d.fixture.get_shape(body, 1);
      *   const radius = "radius" in circle ? circle.radius : undefined;
      *   b2d.fixture.set_shape(body, 1, { type: b2d.shape.SHAPE_TYPE_CIRCLE, radius: radius ?? 16, center: vmath.vector3(24, 0, 0) }, true);
-     *   b2d.fixture.set_shape(body, 2, { type: b2d.shape.SHAPE_TYPE_EDGE, v1: vmath.vector3(-32, 0, 0), v2: vmath.vector3(32, 0, 0) });
+     *
+     *   // Replace an edge shape's local endpoints.
+     *   b2d.fixture.set_shape(body, 2, {
+     *     type: b2d.shape.SHAPE_TYPE_EDGE,
+     *     v1: vmath.vector3(-32, 0, 0),
+     *     v2: vmath.vector3(32, 0, 0),
+     *   });
+     *
+     *   // Update a box shape using the polygon box convenience format.
+     *   // The existing polygon must already have four vertices.
+     *   b2d.fixture.set_shape(
+     *     body,
+     *     3,
+     *     {
+     *       type: b2d.shape.SHAPE_TYPE_BOX,
+     *       hx: 16,
+     *       hy: 8,
+     *       center: vmath.vector3(0, 20, 0),
+     *       angle: math.rad(30),
+     *     },
+     *     true,
+     *   );
      * }
      * ```
      */

package/generated/versions/defold-1.13.1/b2d_shape.d.ts

@@ -375,10 +375,31 @@ declare global {
      * ```ts
      * const body = b2d.get_body("#collisionobject");
      * if (body !== undefined) {
+     *   // Move a circle shape relative to the body origin.
      *   const circle = b2d.shape.get_shape(body, 1);
      *   const radius = "radius" in circle ? circle.radius : undefined;
      *   b2d.shape.set_shape(body, 1, { type: b2d.shape.SHAPE_TYPE_CIRCLE, radius: radius ?? 16, center: vmath.vector3(24, 0, 0) }, true);
-     *   b2d.shape.set_shape(body, 2, { type: b2d.shape.SHAPE_TYPE_SEGMENT, v1: vmath.vector3(-32, 0, 0), v2: vmath.vector3(32, 0, 0) });
+     *
+     *   // Replace a segment shape's local endpoints.
+     *   b2d.shape.set_shape(body, 2, {
+     *     type: b2d.shape.SHAPE_TYPE_SEGMENT,
+     *     v1: vmath.vector3(-32, 0, 0),
+     *     v2: vmath.vector3(32, 0, 0),
+     *   });
+     *
+     *   // Update a box shape using the polygon box convenience format.
+     *   b2d.shape.set_shape(
+     *     body,
+     *     3,
+     *     {
+     *       type: b2d.shape.SHAPE_TYPE_BOX,
+     *       hx: 16,
+     *       hy: 8,
+     *       center: vmath.vector3(0, 20, 0),
+     *       angle: math.rad(30),
+     *     },
+     *     true,
+     *   );
      * }
      * ```
      */

package/generated/versions/defold-1.13.1/compute.d.ts

@@ -167,7 +167,23 @@ declare global {
      * vmath.vector4 | vmath.vector3 | vmath.matrix4 | number | table the value(s) of the constant. If the shader constant is an array, the amount of values to update depends on how many values that are passed in the 'value' field.
      * @example
      * ```ts
-     * compute.set_constants("/my_compute.computec", { tint: { value: vmath.vector4(1, 0, 0, 1) } });
+     * // Set a shader constant in a compute program
+     * export default defineScript({
+     *   init() {
+     *     return { my_view_proj: vmath.matrix4() };
+     *   },
+     *
+     *   update(self) {
+     *     // update the 'tint' constant
+     *     compute.set_constants("/my_compute.computec", {
+     *       tint: { value: vmath.vector4(1, 0, 0, 1) },
+     *     });
+     *     // change the type of the 'view_proj' constant to CONSTANT_TYPE_USER_MATRIX4 so the renderer can set our custom data
+     *     compute.set_constants("/my_compute.computec", {
+     *       view_proj: { value: self.my_view_proj, type: material.CONSTANT_TYPE_USER_MATRIX4 },
+     *     });
+     *   },
+     * });
      * ```
      */
     function set_constants(path: Hash | string, constants: Record<string, { type?: number; value?: Vector4 | Vector3 | Matrix4 | number | (Vector4 | Matrix4)[] }>): void;
@@ -227,7 +243,18 @@ declare global {
      * @param textures - A table keyed by sampler name with texture resources as values.
      * @example
      * ```ts
-     * compute.set_textures("/my_compute.computec", { my_texture: resource.texture() });
+     * // Set a texture in a compute program from a resource
+     * export default defineScript({
+     *   // Never call `go.property` yourself: the transpiler emits the chunk-scope
+     *   // registration from this field, and only this field types the property onto `self`.
+     *   properties: { my_texture: resource.texture() },
+     *
+     *   init(self) {
+     *     compute.set_textures("/my_compute.computec", {
+     *       my_texture: self.my_texture,
+     *     });
+     *   },
+     * });
      * ```
      */
     function set_textures(path: Hash | string, textures: LuaMap<string, Hash> | Record<string, Hash>): void;

package/generated/versions/defold-1.13.1/go.d.ts

@@ -297,7 +297,7 @@ declare global {
      * // Delete the script's own game object.
      * go.delete();
      * // Delete a game object with the id "my_game_object".
-     * const id = go.get_id("my_game_object");
+     * const id = go.get_id("my_game_object"); // retrieve the id of the game object to be deleted
      * go.delete(id);
      * // Delete a list of game objects.
      * const ids = [hash("/my_object_1"), hash("/my_object_2"), hash("/my_object_3")];
@@ -309,7 +309,7 @@ declare global {
      * // Delete the script's own game object and its children.
      * go.delete(true);
      * // Delete a game object with the id "my_game_object" and its children.
-     * const id = go.get_id("my_game_object");
+     * const id = go.get_id("my_game_object"); // retrieve the id of the game object to be deleted
      * go.delete(id, true);
      * // Delete a list of game objects and their children.
      * const ids = [hash("/my_object_1"), hash("/my_object_2"), hash("/my_object_3")];

package/generated/versions/defold-1.13.1/gui.d.ts

@@ -1597,15 +1597,13 @@ declare global {
      * // How to play a particle fx when a gui node is created.
      * // The callback receives the gui node, the hash of the id
      * // of the emitter, and the new state of the emitter as particlefx.EMITTER_STATE_.
-     * function emitter_state_change(self: unknown, node: unknown, emitter: unknown, state: unknown) {
-     *   if (emitter === hash("exhaust") && state === particlefx.EMITTER_STATE_POSTSPAWN) {
-     *     // exhaust is done spawning particles...
-     *   }
-     * }
-     *
      * export default defineGuiScript({
      *   init(self) {
-     *     gui.play_particlefx(gui.get_node("particlefx"), emitter_state_change);
+     *     gui.play_particlefx(gui.get_node("particlefx"), (self, node, emitter, state) => {
+     *       if (emitter === hash("exhaust") && state === particlefx.EMITTER_STATE_POSTSPAWN) {
+     *         // exhaust is done spawning particles...
+     *       }
+     *     });
      *   },
      * });
      * ```