@defold-typescript/types 0.40.0 → 0.41.0

package/generated/model.d.ts

@@ -6,6 +6,36 @@ declare global {
    * Model API documentation
    */
   namespace model {
+    /**
+     * Axis-aligned bounding box
+     */
+    interface aabb {
+      /**
+       * minimum local-space bounds
+       */
+      min: Vector3;
+      /**
+       * maximum local-space bounds
+       */
+      max: Vector3;
+    }
+    /**
+     * Model animation playback properties
+     */
+    interface play_properties {
+      /**
+       * duration of a linear blend from the current animation
+       */
+      blend_duration?: number;
+      /**
+       * normalized initial animation cursor
+       */
+      offset?: number;
+      /**
+       * positive animation playback rate
+       */
+      playback_rate?: number;
+    }
     /**
      * Cancels all animation on a model component.
      *
@@ -14,17 +44,16 @@ declare global {
     function cancel(url: string | Hash | Url): void;
     /**
      * Get AABB of the whole model in local coordinate space.
-     * AABB information return as a table with `min` and `max` fields, where `min` and `max` has type `vmath.vector3`.
      *
      * @param url - the model
-     * @returns A table containing AABB of the model. If model has no meshes - return vmath.vector3(0,0,0) for min and max fields.
+     * @returns model bounds; an empty model returns zero vectors
      * @example
      * ```ts
      * model.get_aabb("#model"); // => { min = vmath.vector3(-2.5, -3.0, 0), max = vmath.vector3(1.5, 5.5, 0) }
      * model.get_aabb("#empty"); // => { min = vmath.vector3(0, 0, 0), max = vmath.vector3(0, 0, 0) }
      * ```
      */
-    function get_aabb(url: string | Hash | Url): { min: Vector3; max: Vector3 };
+    function get_aabb(url: string | Hash | Url): model.aabb;
     /**
      * Returns a table of numbers with one entry per morph target on the first mesh of the model that has morph targets.
      * Values reflect the rig state at call time (after animation, and any active script override from model.set_blend_weights).
@@ -65,16 +94,15 @@ declare global {
     function get_go(url: string | Hash | Url, bone_id: string | Hash): Hash;
     /**
      * Get AABB of all meshes.
-     * AABB information return as a table with `min` and `max` fields, where `min` and `max` has type `vmath.vector3`.
      *
      * @param url - the model
-     * @returns A table containing info about all AABB in the format
+     * @returns mesh bounds keyed by mesh identifier
      * @example
      * ```ts
      * model.get_mesh_aabb("#model"); // => { hash("Sword") = { min = vmath.vector3(-0.5, -0.5, 0), max = vmath.vector3(0.5, 0.5, 0) }, hash("Shield") = { min = vmath.vector3(-0.5, -0.5, -0.5), max = vmath.vector3(0.5, 0.5, 0.5) } }
      * ```
      */
-    function get_mesh_aabb(url: string | Hash | Url): LuaMap<Hash, { min: Vector3; max: Vector3 }>;
+    function get_mesh_aabb(url: string | Hash | Url): LuaTable<Hash, model.aabb>;
     /**
      * Get the enabled state of a mesh
      *
@@ -97,7 +125,7 @@ declare global {
      * });
      * ```
      */
-    function get_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash | Url): boolean;
+    function get_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash): boolean;
     /**
      * Plays an animation on a model component with specified playback
      * mode and parameters.
@@ -109,48 +137,21 @@ declare global {
      * 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`
-     * number The normalized initial value of the animation cursor when the animation starts playing.
-     * `playback_rate`
-     * number The rate with which the animation will be played. Must be positive.
+     * @param play_properties - optional playback properties
      * @param complete_function - function to call when the animation has completed.
      *
      * `self`
-     * object The current object.
+     * script_instance The current script instance.
      * `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.
-     *
+     * message.model.model_animation_done Information about the completion.
      * `sender`
      * url The invoker of the callback: the model component.
      * @example
@@ -179,7 +180,7 @@ declare global {
      * });
      * ```
      */
-    function play_anim(url: string | Hash | Url, anim_id: string | Hash, playback: go.Playback, play_properties?: { blend_duration?: number; offset?: number; playback_rate?: number }, complete_function?: (self: unknown, message_id: unknown, message: unknown, sender: unknown) => 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"], sender: Url) => void): void;
     /**
      * Resets a shader constant for a model component.
      * The constant must be defined in the material assigned to the model.
@@ -226,7 +227,7 @@ declare global {
      * });
      * ```
      */
-    function set_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash | Url, enabled: boolean): void;
+    function set_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash, enabled: boolean): void;
     interface properties {
       /**
        * The current animation set on the component. The type of the property is hash.

package/generated/particlefx.d.ts

@@ -1,5 +1,5 @@
 /** @noSelfInFile */
-import type { Hash, Url, Vector4 } from "../src/core-types";
+import type { Hash, Matrix4, Url, Vector4 } from "../src/core-types";
 
 declare global {
   /**
@@ -8,19 +8,29 @@ declare global {
    */
   namespace particlefx {
     /**
-     * The emitter is not spawning any particles, but has particles that are still alive.
+     * Options used when stopping particle effects.
+     */
+    interface stop_options {
+      /**
+       * Instantly clear spawned particles.
+       */
+      clear?: boolean;
+    }
+    type EMITTER_STATE = typeof particlefx.EMITTER_STATE_POSTSPAWN | typeof particlefx.EMITTER_STATE_PRESPAWN | typeof particlefx.EMITTER_STATE_SLEEPING | typeof particlefx.EMITTER_STATE_SPAWNING;
+    /**
+     * postspawn state The emitter is not spawning any particles, but has particles that are still alive.
      */
     const EMITTER_STATE_POSTSPAWN: number & { readonly __brand: "particlefx.EMITTER_STATE_POSTSPAWN" };
     /**
-     * The emitter will be in this state when it has been started but before spawning any particles. Normally the emitter is in this state for a short time, depending on if a start delay has been set for this emitter or not.
+     * prespawn state The emitter will be in this state when it has been started but before spawning any particles. Normally the emitter is in this state for a short time, depending on if a start delay has been set for this emitter or not.
      */
     const EMITTER_STATE_PRESPAWN: number & { readonly __brand: "particlefx.EMITTER_STATE_PRESPAWN" };
     /**
-     * The emitter does not have any living particles and will not spawn any particles in this state.
+     * sleeping state The emitter does not have any living particles and will not spawn any particles in this state.
      */
     const EMITTER_STATE_SLEEPING: number & { readonly __brand: "particlefx.EMITTER_STATE_SLEEPING" };
     /**
-     * The emitter is spawning particles.
+     * spawning state The emitter is spawning particles.
      */
     const EMITTER_STATE_SPAWNING: number & { readonly __brand: "particlefx.EMITTER_STATE_SPAWNING" };
     /**
@@ -31,23 +41,6 @@ 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`
-     * hash The id of the particle fx component
-     * `emitter`
-     * 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
      * // How to play a particle fx when a game object is created.
@@ -66,7 +59,7 @@ declare global {
      * });
      * ```
      */
-    function play(url: string | Hash | Url, emitter_state_function?: (self: unknown, id: unknown, emitter: unknown, state: unknown) => void): void;
+    function play(url: string | Hash | Url, emitter_state_function?: (self: unknown, id: Hash, emitter: Hash, state: particlefx.EMITTER_STATE) => void): void;
     /**
      * Resets a shader constant for a particle FX component emitter.
      * The constant must be defined in the material assigned to the emitter.
@@ -118,16 +111,14 @@ declare global {
      * });
      * ```
      */
-    function set_constant(url: string | Hash | Url, emitter: string | Hash, constant: string | Hash, value: Vector4): void;
+    function set_constant(url: string | Hash | Url, emitter: string | Hash, constant: string | Hash, value: Vector4 | Matrix4): 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 when stopping the particle fx. Supported options:
-     *
-     * - boolean `clear`: instantly clear spawned particles
+     * @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
@@ -139,7 +130,7 @@ declare global {
      * });
      * ```
      */
-    function stop(url: string | Hash | Url, options?: { clear?: boolean }): void;
+    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.