@defold-typescript/types 0.51.0 → 0.53.0

package/generated/model.d.ts

@@ -9,7 +9,7 @@ declare global {
     /**
      * Axis-aligned bounding box
      */
-    interface aabb {
+    interface Aabb {
       /**
        * minimum local-space bounds
        */
@@ -22,7 +22,7 @@ declare global {
     /**
      * Model animation playback properties
      */
-    interface play_properties {
+    interface PlayProperties {
       /**
        * duration of a linear blend from the current animation
        */
@@ -53,7 +53,7 @@ declare global {
      * model.get_aabb("#empty"); // => { min = vmath.vector3(0, 0, 0), max = vmath.vector3(0, 0, 0) }
      * ```
      */
-    function get_aabb(url: string | Hash | Url): model.aabb;
+    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).
@@ -106,7 +106,7 @@ declare global {
      * 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): LuaTable<Hash, model.aabb>;
+    function get_mesh_aabb(url: string | Hash | Url): LuaTable<Hash, model.Aabb>;
     /**
      * Get the enabled state of a mesh
      *
@@ -183,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"]) => void): void;
+    function play_anim(url: string | Hash | Url, anim_id: string | Hash, playback: go.Playback, play_properties?: model.PlayProperties, 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.
@@ -233,7 +233,7 @@ declare global {
      * ```
      */
     function set_mesh_enabled(url: string | Hash | Url, mesh_id: string | Hash, enabled: boolean): void;
-    interface properties {
+    interface Properties {
       /**
        * The current animation set on the component. The type of the property is hash.
        */
@@ -248,37 +248,69 @@ declare global {
        */
       playback_rate: number;
       /**
-       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
        */
       texture0: Hash;
       /**
-       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
        */
       texture1: Hash;
       /**
-       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
        */
       texture2: Hash;
       /**
-       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
        */
       texture3: Hash;
       /**
-       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
        */
       texture4: Hash;
       /**
-       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
        */
       texture5: Hash;
       /**
-       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
        */
       texture6: Hash;
       /**
-       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
        */
       texture7: Hash;
+      /**
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
+       */
+      texture8: Hash;
+      /**
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
+       */
+      texture9: Hash;
+      /**
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
+       */
+      texture10: Hash;
+      /**
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
+       */
+      texture11: Hash;
+      /**
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
+       */
+      texture12: Hash;
+      /**
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
+       */
+      texture13: Hash;
+      /**
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
+       */
+      texture14: Hash;
+      /**
+       * The texture hash id of the model, read and written on the texture unit the key's number names (`texture3` is unit 3).
+       */
+      texture15: Hash;
     }
   }
 }

package/generated/particlefx.d.ts

@@ -10,13 +10,13 @@ declare global {
     /**
      * Options used when stopping particle effects.
      */
-    interface stop_options {
+    interface StopOptions {
       /**
        * 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;
+    type EmitterState = 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.
      */
@@ -57,7 +57,7 @@ declare global {
      * });
      * ```
      */
-    function play(url: string | Hash | Url, emitter_state_function?: (self: unknown, id: Hash, emitter: Hash, state: particlefx.EMITTER_STATE) => void): void;
+    function play(url: string | Hash | Url, emitter_state_function?: (self: unknown, id: Hash, emitter: Hash, state: particlefx.EmitterState) => void): void;
     /**
      * Resets a shader constant for a particle FX component emitter.
      * The constant must be defined in the material assigned to the emitter.
@@ -128,8 +128,27 @@ declare global {
      * });
      * ```
      */
-    function stop(url: string | Hash | Url, options?: particlefx.stop_options): void;
-    interface properties {
+    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.StopOptions): void;
+    interface Properties {
       /**
        * The animation used during rendering by an emitter in a particle FX component.
        * The property type is a hash and refers to a valid animation in an atlas or a tile source resource.

package/generated/physics.d.ts

@@ -6,11 +6,11 @@ declare global {
    * Collision object physics API documentation
    */
   namespace physics {
-    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"> };
+    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.
      */
-    interface joint_properties {
+    interface JointProperties {
       /**
        * whether the connected objects should collide
        */
@@ -79,7 +79,7 @@ declare global {
     /**
      * The available optional fields depend on the joint type.
      */
-    interface joint_properties_info {
+    interface JointPropertiesInfo {
       /**
        * whether the connected objects collide
        */
@@ -160,7 +160,7 @@ declare global {
     /**
      * Ray-cast options
      */
-    interface raycast_options {
+    interface RaycastOptions {
       /**
        * Return every hit instead of only the closest hit.
        */
@@ -169,11 +169,11 @@ declare global {
     /**
      * The available geometry fields depend on `type`.
      */
-    interface shape_data {
+    interface ShapeData {
       /**
        * shape type
        */
-      type: physics.SHAPE_TYPE;
+      type: physics.ShapeType;
       /**
        * sphere diameter or capsule pole diameter
        */
@@ -187,8 +187,8 @@ declare global {
        */
       height?: number;
     }
-    type JOINT_TYPE = typeof physics.JOINT_TYPE_FIXED | typeof physics.JOINT_TYPE_HINGE | typeof physics.JOINT_TYPE_SLIDER | typeof physics.JOINT_TYPE_SPRING | typeof physics.JOINT_TYPE_WELD | typeof physics.JOINT_TYPE_WHEEL;
-    type SHAPE_TYPE = typeof physics.SHAPE_TYPE_BOX | typeof physics.SHAPE_TYPE_CAPSULE | typeof physics.SHAPE_TYPE_HULL | typeof physics.SHAPE_TYPE_MESH | typeof physics.SHAPE_TYPE_SPHERE;
+    type JointType = typeof physics.JOINT_TYPE_FIXED | typeof physics.JOINT_TYPE_HINGE | typeof physics.JOINT_TYPE_SLIDER | typeof physics.JOINT_TYPE_SPRING | typeof physics.JOINT_TYPE_WELD | typeof physics.JOINT_TYPE_WHEEL;
+    type ShapeType = typeof physics.SHAPE_TYPE_BOX | typeof physics.SHAPE_TYPE_CAPSULE | typeof physics.SHAPE_TYPE_HULL | typeof physics.SHAPE_TYPE_MESH | typeof physics.SHAPE_TYPE_SPHERE;
     /**
      * Fixed joint; uses `max_length` from physics.joint_properties.
      */
@@ -245,7 +245,7 @@ declare global {
      * @param position_b - local position where to attach the joint on the second collision object
      * @param properties - optional joint-specific properties
      */
-    function create_joint(joint_type: physics.JOINT_TYPE, collisionobject_a: string | Hash | Url, joint_id: string | Hash, position_a: Vector3, collisionobject_b: string | Hash | Url, position_b: Vector3, properties?: physics.joint_properties): void;
+    function create_joint(joint_type: physics.JointType, collisionobject_a: string | Hash | Url, joint_id: string | Hash, position_a: Vector3, collisionobject_b: string | Hash | Url, position_b: Vector3, properties?: physics.JointProperties): void;
     /**
      * Destroy an already physics joint. The joint has to be created before a
      * destroy can be issued.
@@ -297,7 +297,7 @@ declare global {
      * @param joint_id - id of the joint
      * @returns joint properties
      */
-    function get_joint_properties(collisionobject: string | Hash | Url, joint_id: string | Hash): physics.joint_properties_info;
+    function get_joint_properties(collisionobject: string | Hash | Url, joint_id: string | Hash): physics.JointPropertiesInfo;
     /**
      * Get the reaction force for a joint. The joint has to be created before
      * the reaction force can be calculated.
@@ -350,7 +350,7 @@ declare global {
      * }
      * ```
      */
-    function get_shape(url: string | Hash | Url, shape: string | Hash): physics.shape_data;
+    function get_shape(url: string | Hash | Url, shape: string | Hash): physics.ShapeData;
     /**
      * 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
@@ -391,7 +391,7 @@ declare global {
      * });
      * ```
      */
-    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;
+    function raycast(from: Vector3, to: Vector3, groups: Hash[], options?: physics.RaycastOptions): 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.
      *
@@ -533,7 +577,7 @@ declare global {
      * });
      * ```
      */
-    function set_event_listener(callback?: (self: unknown, events: physics.event[]) => void): void;
+    function set_event_listener(callback?: (self: unknown, events: physics.Event[]) => void): void;
     /**
      * Set the gravity in runtime. The gravity change is not global, it will only affect
      * the collection that the function is called from.
@@ -593,7 +637,7 @@ declare global {
      * @param properties - joint specific properties table
      * Note: The `collide_connected` field cannot be updated/changed after a connection has been made.
      */
-    function set_joint_properties(collisionobject: string | Hash | Url, joint_id: string | Hash, properties: physics.joint_properties): void;
+    function set_joint_properties(collisionobject: string | Hash | Url, joint_id: string | Hash, properties: physics.JointProperties): void;
     /**
      * Sets or clears the masking of a group (maskbit) in a collision object.
      *
@@ -642,7 +686,7 @@ declare global {
      * }
      * ```
      */
-    function set_shape(url: string | Hash | Url, shape: string | Hash, table: physics.shape_data): void;
+    function set_shape(url: string | Hash | Url, shape: string | Hash, table: physics.ShapeData): void;
     /**
      * Flips the collision shapes vertically for a collision object
      *
@@ -694,7 +738,7 @@ declare global {
         /**
          * collision object information
          */
-        interface collision_info {
+        interface CollisionInfo {
           /**
            * object position in world space
            */
@@ -711,7 +755,7 @@ declare global {
         /**
          * contact-point object information
          */
-        interface contact_point_info {
+        interface ContactPointInfo {
           /**
            * contact point position in world space
            */
@@ -744,7 +788,7 @@ declare global {
         /**
          * trigger interaction object information
          */
-        interface trigger_info {
+        interface TriggerInfo {
           /**
            * object identifier
            */
@@ -756,7 +800,7 @@ declare global {
         }
       }
     }
-    interface properties {
+    interface Properties {
       /**
        * The angular damping value for the collision object. Setting this value alters the damping of
        * angular motion of the object (rotation). Valid values are between 0 (no damping) and 1 (full damping).

package/generated/profiler.d.ts

@@ -5,10 +5,8 @@ declare global {
    * More detailed [profiling](https://www.defold.com/manuals/profiling/) and [debugging](http://www.defold.com/manuals/debugging/) information available in the manuals.
    */
   namespace profiler {
-    type Mode = typeof profiler.MODE_RUN | typeof profiler.MODE_PAUSE | typeof profiler.MODE_SHOW_PEAK_FRAME | typeof profiler.MODE_RECORD;
+    type Mode = typeof profiler.MODE_PAUSE | typeof profiler.MODE_RECORD | typeof profiler.MODE_RUN | typeof profiler.MODE_SHOW_PEAK_FRAME;
     type ViewMode = typeof profiler.VIEW_MODE_FULL | typeof profiler.VIEW_MODE_MINIMIZED;
-    type MODE = typeof profiler.MODE_PAUSE | typeof profiler.MODE_RECORD | typeof profiler.MODE_RUN | typeof profiler.MODE_SHOW_PEAK_FRAME;
-    type VIEW_MODE = typeof profiler.VIEW_MODE_FULL | typeof profiler.VIEW_MODE_MINIMIZED;
     /**
      * pause on the currently displayed frame
      */
@@ -173,7 +171,7 @@ declare global {
      * }
      * ```
      */
-    function set_ui_mode(mode: profiler.MODE): void;
+    function set_ui_mode(mode: profiler.Mode): void;
     /**
      * Set the on-screen profile view mode - minimized or expanded
      *
@@ -184,7 +182,7 @@ declare global {
      * profiler.set_ui_view_mode(profiler.VIEW_MODE_MINIMIZED);
      * ```
      */
-    function set_ui_view_mode(mode: profiler.VIEW_MODE): void;
+    function set_ui_view_mode(mode: profiler.ViewMode): void;
     /**
      * Shows or hides the time the engine waits for vsync in the on-screen profiler
      * Each frame the engine waits for vsync and depending on your vsync settings and how much time