@defold-typescript/types 0.50.1 → 0.52.0

package/generated/image.d.ts

@@ -54,7 +54,7 @@ declare global {
       /**
        * Script buffer containing the decompressed image data.
        */
-      buffer: Opaque<"buffer">;
+      buffer: Opaque<"buffer"> & { length: LuaLengthMethod<number> };
     }
     /**
      * Image loading options
@@ -122,7 +122,7 @@ declare global {
      * }
      * ```
      */
-    function get_astc_header(buffer: string): image.astc_header | undefined;
+    function get_astc_header(buffer: string): image.astc_header;
     /**
      * Load image (PNG or JPEG) from buffer.
      *
@@ -141,7 +141,59 @@ declare global {
      * });
      * ```
      */
-    function load(buffer: string, options?: boolean | image.load_options): image.load_result | undefined;
+    function load(buffer: string): image.load_result | undefined;
+    /**
+     * Load image (PNG or JPEG) from buffer.
+     *
+     * @param buffer - image data buffer
+     * @param options - Optional loading parameters. A boolean is accepted for backwards compatibility and controls `premultiply_alpha`.
+     * @returns loaded image, or `nil` if loading fails
+     * @example
+     * ```ts
+     * // How to load an image from an URL and create a GUI texture from it:
+     * const imgurl = "http://www.site.com/image.png";
+     * http.request(imgurl, "GET", (self, id, response) => {
+     *   const img = response.response !== undefined ? image.load(response.response) : undefined;
+     *   if (img !== undefined) {
+     *     const tx = gui.new_texture("image_node", img.width, img.height, img.type, img.buffer);
+     *   }
+     * });
+     * ```
+     */
+    function load(buffer: string, options: boolean | image.load_options): image.load_result | undefined;
+    /**
+     * Load image (PNG or JPEG) from a string buffer.
+     *
+     * @param buffer - image data buffer
+     * @param options - Optional loading parameters. A boolean is accepted for backwards compatibility and controls `premultiply_alpha`.
+     * @returns loaded image, or `nil` if loading fails
+     * @example
+     * ```ts
+     * // Load an image from an URL as a buffer and create a texture resource from it:
+     * const imgurl = "http://www.site.com/image.png";
+     * http.request(imgurl, "GET", (self, id, response) => {
+     *   const img =
+     *     response.response !== undefined
+     *       ? image.load_buffer(response.response, { flip_vertically: true })
+     *       : undefined;
+     *   // the engine registers a texture format only when the driver supports it
+     *   const format = graphics.TEXTURE_FORMAT_RGBA;
+     *   if (img !== undefined && format !== undefined) {
+     *     const tparams = {
+     *       width: img.width,
+     *       height: img.height,
+     *       type: graphics.TEXTURE_TYPE_2D,
+     *       format,
+     *     };
+     *
+     *     const my_texture_id = resource.create_texture("/my_custom_texture.texturec", tparams, img.buffer);
+     *     // Apply the texture to a model
+     *     go.set("/go1#model", "texture0", my_texture_id);
+     *   }
+     * });
+     * ```
+     */
+    function load_buffer(buffer: string): image.load_buffer_result | undefined;
     /**
      * Load image (PNG or JPEG) from a string buffer.
      *
@@ -174,7 +226,7 @@ declare global {
      * });
      * ```
      */
-    function load_buffer(buffer: string, options?: boolean | image.load_options): image.load_buffer_result | undefined;
+    function load_buffer(buffer: string, options: boolean | image.load_options): image.load_buffer_result | undefined;
   }
 }
 

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

@@ -50,8 +50,11 @@ import "../../src/component-properties";
 import "../../src/custom-messages";
 import "../../src/engine-globals";
 import "../../src/go-overloads";
+import "../../src/gui-overloads";
+import "../../src/gui-texture-removal";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/physics-event-guard";
 import "../../src/scene-addresses";
 import "../../src/sys-overloads";
 import "../../src/vmath-overloads";

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

@@ -1,6 +1,6 @@
 /// <reference types="lua-types/5.1" />
 /// <reference types="lua-types/special/jit-only" />
-import "../b2d";
+import "../render-script-modules/b2d";
 import "../b2d_body";
 import "../b2d_chain";
 import "../b2d_fixture";
@@ -8,39 +8,39 @@ import "../b2d_joint";
 import "../b2d_shape";
 import "../b2d_world";
 import "../buffer";
-import "../bullet3d";
+import "../render-script-modules/bullet3d";
 import "../bullet3d_collision_object";
 import "../bullet3d_constraint";
 import "../bullet3d_rigid_body";
 import "../bullet3d_shape";
 import "../bullet3d_world";
 import "../camera";
-import "../collectionfactory";
-import "../collectionproxy";
+import "../render-script-modules/collectionfactory";
+import "../render-script-modules/collectionproxy";
 import "../compute";
 import "../crash";
-import "../factory";
+import "../render-script-modules/factory";
 import "../font";
-import "../go";
+import "../render-script-modules/go";
 import "../graphics";
 import "../html5";
 import "../http";
 import "../image";
 import "../json";
-import "../label";
+import "../render-script-modules/label";
 import "../liveupdate";
 import "../material";
-import "../model";
+import "../render-script-modules/model";
 import "../msg";
-import "../particlefx";
-import "../physics";
+import "../render-script-modules/particlefx";
+import "../render-script-modules/physics";
 import "../profiler";
-import "../resource";
+import "../render-script-modules/resource";
 import "../socket";
-import "../sound";
-import "../sprite";
+import "../render-script-modules/sound";
+import "../render-script-modules/sprite";
 import "../sys";
-import "../tilemap";
+import "../render-script-modules/tilemap";
 import "../timer";
 import "../types";
 import "../vmath";
@@ -49,9 +49,9 @@ import "../zlib";
 import "../../src/component-properties";
 import "../../src/custom-messages";
 import "../../src/engine-globals";
-import "../../src/go-overloads";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/physics-event-guard";
 import "../../src/render-overloads";
 import "../../src/scene-addresses";
 import "../../src/sys-overloads";

package/generated/kinds/script.d.ts

@@ -52,6 +52,7 @@ import "../../src/engine-globals";
 import "../../src/go-overloads";
 import "../../src/message-guard";
 import "../../src/msg-overloads";
+import "../../src/physics-event-guard";
 import "../../src/scene-addresses";
 import "../../src/sys-overloads";
 import "../../src/vmath-overloads";

package/generated/liveupdate.d.ts

@@ -6,7 +6,7 @@ declare global {
    * Functions and constants to access resources.
    */
   namespace liveupdate {
-    type LIVEUPDATE = typeof liveupdate.LIVEUPDATE_BUNDLED_RESOURCE_MISMATCH | typeof liveupdate.LIVEUPDATE_ENGINE_VERSION_MISMATCH | typeof liveupdate.LIVEUPDATE_FORMAT_ERROR | typeof liveupdate.LIVEUPDATE_INVAL | typeof liveupdate.LIVEUPDATE_INVALID_HEADER | typeof liveupdate.LIVEUPDATE_INVALID_RESOURCE | typeof liveupdate.LIVEUPDATE_IO_ERROR | typeof liveupdate.LIVEUPDATE_MEM_ERROR | typeof liveupdate.LIVEUPDATE_OK | typeof liveupdate.LIVEUPDATE_SCHEME_MISMATCH | typeof liveupdate.LIVEUPDATE_SIGNATURE_MISMATCH | typeof liveupdate.LIVEUPDATE_UNKNOWN | typeof liveupdate.LIVEUPDATE_VERSION_MISMATCH;
+    type LIVEUPDATE = typeof liveupdate.LIVEUPDATE_BUNDLED_RESOURCE_MISMATCH | typeof liveupdate.LIVEUPDATE_ENGINE_VERSION_MISMATCH | typeof liveupdate.LIVEUPDATE_FORMAT_ERROR | typeof liveupdate.LIVEUPDATE_INVAL | typeof liveupdate.LIVEUPDATE_INVALID_HEADER | typeof liveupdate.LIVEUPDATE_INVALID_RESOURCE | typeof liveupdate.LIVEUPDATE_IO_ERROR | typeof liveupdate.LIVEUPDATE_MEM_ERROR | typeof liveupdate.LIVEUPDATE_OK | typeof liveupdate.LIVEUPDATE_SCHEME_MISMATCH | typeof liveupdate.LIVEUPDATE_SIGNATURE_MISMATCH | typeof liveupdate.LIVEUPDATE_UNKNOWN | typeof liveupdate.LIVEUPDATE_VERSION_MISMATCH | typeof liveupdate.LIVEUPDATE_NOT_INITIALIZED;
     /**
      * Mismatch between between expected bundled resources and actual bundled resources. The manifest expects a resource to be in the bundle, but it was not found in the bundle. This is typically the case when a non-excluded resource was modified between publishing the bundle and publishing the manifest.
      */
@@ -39,6 +39,10 @@ declare global {
      * Memory wasn't allocated
      */
     const LIVEUPDATE_MEM_ERROR: number & { readonly __brand: "liveupdate.LIVEUPDATE_MEM_ERROR" };
+    /**
+     * Live update is not initialized. `liveupdate.add_mount` and `liveupdate.remove_mount` return it while live update is disabled.
+     */
+    const LIVEUPDATE_NOT_INITIALIZED: number & { readonly __brand: "liveupdate.LIVEUPDATE_NOT_INITIALIZED" };
     /**
      * Operation completed successfully.
      */

package/generated/material.d.ts

@@ -78,7 +78,7 @@ declare global {
       /**
        * Sampler texture type.
        */
-      type: graphics.TEXTURE_TYPE;
+      type: graphics.TEXTURE_TYPE | 6 | 7 | 8 | 9 | 10;
       /**
        * Horizontal wrap mode.
        */
@@ -348,7 +348,7 @@ declare global {
      * Returns a table of all the textures from the material.
      *
      * @param path - The path to the resource
-     * @returns material texture information
+     * @returns material texture information. Keyed by sampler slot from 1; a slot with no texture has no entry, so iterate with `for (const [slot, info] of textures)`.
      * @example
      * ```ts
      * // Get the textures from a material specified as a resource property
@@ -363,7 +363,7 @@ declare global {
      * });
      * ```
      */
-    function get_textures(path: Hash | string): material.texture_info[];
+    function get_textures(path: Hash | string): LuaMap<number, material.texture_info>;
     /**
      * Returns a table of all the vertex attributes in the material. This function will return all the vertex attributes
      * that are used in the vertex shader of the material.

package/generated/model.d.ts

@@ -164,10 +164,9 @@ declare global {
      * // How to play the "jump" animation followed by the "run" animation:
      * const url = msg.url("#model");
      *
-     * function anim_done(self: unknown, message_id: unknown, message: unknown, sender: unknown) {
+     * function anim_done(self: unknown, message_id: Hash, message: { animation_id: Hash }) {
      *   if (message_id === hash("model_animation_done")) {
-     *     const { animation_id } = message as { animation_id: Hash };
-     *     if (animation_id === hash("jump")) {
+     *     if (message.animation_id === hash("jump")) {
      *       // open animation done, chain with "run"
      *       const properties = { blend_duration: 0.2 };
      *       model.play_anim(url, "run", go.PLAYBACK_LOOP_FORWARD, properties, anim_done);
@@ -184,7 +183,7 @@ declare global {
      * });
      * ```
      */
-    function play_anim(url: string | Hash | Url, anim_id: string | Hash, playback: go.PLAYBACK, play_properties?: model.play_properties, complete_function?: (self: unknown, message_id: Hash, message: BuiltinMessages["model_animation_done"], sender: Url) => void): void;
+    function play_anim(url: string | Hash | Url, anim_id: string | Hash, playback: go.PLAYBACK, play_properties?: model.play_properties, complete_function?: (self: unknown, message_id: Hash, message: BuiltinMessages["model_animation_done"]) => void): void;
     /**
      * Resets a shader constant for a model component.
      * The constant must be defined in the material assigned to the model.
@@ -238,7 +237,7 @@ declare global {
       /**
        * The current animation set on the component. The type of the property is hash.
        */
-      animation: Hash;
+      readonly animation: Hash;
       /**
        * The normalized animation cursor. The type of the property is number.
        * Please note that model events may not fire as expected when the cursor is manipulated directly.

package/generated/particlefx.d.ts

@@ -128,7 +128,26 @@ declare global {
      * });
      * ```
      */
-    function stop(url: string | Hash | Url, options?: particlefx.stop_options): void;
+    function stop(url: string | Hash | Url): void;
+    /**
+     * Stops a particle FX component from playing.
+     * Stopping a particle FX does not remove already spawned particles.
+     * Which particle FX to stop is identified by the URL.
+     *
+     * @param url - the particle fx that should stop playing
+     * @param options - options used when stopping the particle fx
+     * @example
+     * ```ts
+     * // How to stop a particle fx when a game object is deleted and immediately also
+     * // clear any spawned particles:
+     * export default defineScript({
+     *   final(self) {
+     *     particlefx.stop("#particlefx", { clear: true });
+     *   },
+     * });
+     * ```
+     */
+    function stop(url: string | Hash | Url, options: particlefx.stop_options): void;
     interface properties {
       /**
        * The animation used during rendering by an emitter in a particle FX component.

package/generated/physics.d.ts

@@ -6,7 +6,7 @@ declare global {
    * Collision object physics API documentation
    */
   namespace physics {
-    type event = BuiltinMessages["contact_point_event"] | BuiltinMessages["collision_event"] | BuiltinMessages["trigger_event"] | BuiltinMessages["ray_cast_response"] | BuiltinMessages["ray_cast_missed"];
+    type event = BuiltinMessages["contact_point_event"] & { type: Hash<"contact_point_event"> } | BuiltinMessages["collision_event"] & { type: Hash<"collision_event"> } | BuiltinMessages["trigger_event"] & { type: Hash<"trigger_event"> } | BuiltinMessages["ray_cast_response"] & { type: Hash<"ray_cast_response"> } | BuiltinMessages["ray_cast_missed"] & { type: Hash<"ray_cast_missed"> };
     /**
      * The available fields depend on the joint type.
      */
@@ -366,7 +366,7 @@ declare global {
      * @returns It returns a list. If missed it returns `nil`. See ray_cast_response for details on the returned values.
      * @example
      * ```ts
-     * function handle_result(hit: { fraction: number; position: Vector3; normal: Vector3; id: Hash; group: Hash; request_id: number }) {
+     * function handle_result(hit: { fraction: number; position: Vector3; normal: Vector3; id: Hash; group: Hash }) {
      *   // act on the hit (see 'ray_cast_response')
      * }
      *
@@ -391,7 +391,7 @@ declare global {
      * });
      * ```
      */
-    function raycast(from: Vector3, to: Vector3, groups: Hash[], options?: physics.raycast_options): BuiltinMessages["ray_cast_response"][] | BuiltinMessages["ray_cast_response"] | undefined;
+    function raycast(from: Vector3, to: Vector3, groups: Hash[], options?: physics.raycast_options): Omit<BuiltinMessages["ray_cast_response"], "request_id">[] | Omit<BuiltinMessages["ray_cast_response"], "request_id"> | undefined;
     /**
      * Ray casts are used to test for intersections against collision objects in the physics world.
      * Collision objects of types kinematic, dynamic and static are tested against. Trigger objects
@@ -435,7 +435,51 @@ declare global {
      * });
      * ```
      */
-    function raycast_async(from: Vector3, to: Vector3, groups: Hash[], request_id?: number): void;
+    function raycast_async(from: Vector3, to: Vector3, groups: Hash[]): void;
+    /**
+     * Ray casts are used to test for intersections against collision objects in the physics world.
+     * Collision objects of types kinematic, dynamic and static are tested against. Trigger objects
+     * do not intersect with ray casts.
+     * 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
+     * @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 request_id - a number in range [0,255]. It will be sent back in the response for identification, 0 by default
+     * @example
+     * ```ts
+     * // How to perform a ray cast asynchronously:
+     * export default defineScript({
+     *   init() {
+     *     return { my_groups: [hash("my_group1"), hash("my_group2")] };
+     *   },
+     *
+     *   update(self, dt) {
+     *     // request ray cast
+     *     const my_start = go.get_world_position();
+     *     const my_end = vmath.vector3(my_start.x, my_start.y - 100, my_start.z);
+     *     physics.raycast_async(my_start, my_end, self.my_groups);
+     *   },
+     *
+     *   on_message(self, message_id, message, sender) {
+     *     // check for the response
+     *     if (message_id === hash("ray_cast_response")) {
+     *       // act on the hit
+     *     } else if (message_id === hash("ray_cast_missed")) {
+     *       // act on the miss
+     *     }
+     *   },
+     * });
+     * ```
+     */
+    function raycast_async(from: Vector3, to: Vector3, groups: Hash[], request_id: number): void;
     /**
      * Only one physics world event listener can be set at a time.
      *