@defold-typescript/types 0.38.0 → 0.40.0

package/generated/versions/defold-1.12.4/index.d.ts

@@ -42,6 +42,7 @@ import "../../../src/message-guard";
 import "../../../src/window-event-guard";
 import "../../../src/scene-addresses";
 import "../../../src/go-overloads";
+import "../../../src/component-properties";
 import "../../../src/render-overloads";
 import "../../../src/vmath-overloads";
 

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

@@ -68,12 +68,16 @@ declare global {
      * @returns true if the mesh is visible, false otherwise
      * @example
      * ```ts
+     * // shared weapon data, e.g. required from your own module
+     * const game = { data: { weapons: { Sword: { damage: 10 } } } };
+     *
      * export default defineScript({
-     *   init(self) {
+     *   init() {
      *     if (model.get_mesh_enabled("#model", "Sword")) {
      *       // set properties specific for the sword
-     *       self.weapon_properties = game.data.weapons["Sword"];
+     *       return { weapon_properties: game.data.weapons["Sword"] };
      *     }
+     *     return { weapon_properties: undefined };
      *   },
      * });
      * ```
@@ -138,9 +142,12 @@ declare global {
      * ```ts
      * // The following examples assume that the model has id "model".
      * // How to play the "jump" animation followed by the "run" animation:
-     * function anim_done(self, message_id, message, sender) {
+     * const url = msg.url("#model");
+     *
+     * function anim_done(self: unknown, message_id: unknown, message: unknown, sender: unknown) {
      *   if (message_id === hash("model_animation_done")) {
-     *     if (message.animation_id === hash("jump")) {
+     *     const { animation_id } = message as { animation_id: Hash };
+     *     if (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);
@@ -150,7 +157,6 @@ declare global {
      *
      * export default defineScript({
      *   init(self) {
-     *     const url = msg.url("#model");
      *     const play_properties = { blend_duration: 0.1 };
      *     // first blend during 0.1 sec into the jump, then during 0.2 s into the run animation
      *     model.play_anim(url, "jump", go.PLAYBACK_ONCE_FORWARD, play_properties, anim_done);
@@ -158,7 +164,7 @@ declare global {
      * });
      * ```
      */
-    function play_anim(url: string | Hash | Url, anim_id: string | Hash, playback: number & { readonly __brand: "go.PLAYBACK_ONCE_FORWARD" } | number & { readonly __brand: "go.PLAYBACK_ONCE_BACKWARD" } | number & { readonly __brand: "go.PLAYBACK_ONCE_PINGPONG" } | number & { readonly __brand: "go.PLAYBACK_LOOP_FORWARD" } | number & { readonly __brand: "go.PLAYBACK_LOOP_BACKWARD" } | number & { readonly __brand: "go.PLAYBACK_LOOP_PINGPONG" }, 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?: { blend_duration?: number; offset?: number; playback_rate?: number }, complete_function?: (self: unknown, message_id: unknown, message: unknown, sender: unknown) => void): void;
     /**
      * Enable or disable visibility of a mesh
      *
@@ -197,7 +203,35 @@ declare global {
       /**
        * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
        */
-      textureN: Hash;
+      texture0: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture1: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture2: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture3: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture4: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture5: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture6: Hash;
+      /**
+       * The texture hash id of the model. Used for getting/setting model texture for unit 0-7
+       */
+      texture7: Hash;
     }
   }
 }

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

@@ -53,7 +53,7 @@ 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, id, 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...
      *   }

package/generated/versions/defold-1.12.4/physics.d.ts

@@ -72,7 +72,7 @@ declare global {
      *   init(self) {
      *     let gravity = physics.get_gravity();
      *     // Inverse gravity!
-     *     gravity = -gravity;
+     *     gravity = vmath.vector3(-gravity.x, -gravity.y, -gravity.z);
      *     physics.set_gravity(gravity);
      *   },
      * });
@@ -202,17 +202,22 @@ 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 }) {
+     *   // act on the hit (see 'ray_cast_response')
+     * }
+     *
      * // How to perform a ray cast synchronously:
      * export default defineScript({
-     *   init(self) {
-     *     self.groups = [hash("world"), hash("enemy")];
+     *   init() {
+     *     return { groups: [hash("world"), hash("enemy")] };
      *   },
      *
      *   update(self, dt) {
      *     // request ray cast
-     *     const result = physics.raycast(from, to, self.groups, { all: true });
-     *     if (result !== undefined) {
-     *       // act on the hit (see 'ray_cast_response')
+     *     const from = go.get_world_position();
+     *     const to = vmath.vector3(from.x, from.y - 100, from.z);
+     *     const results = physics.raycast(from, to, self.groups, { all: true });
+     *     if (results !== undefined) {
      *       for (const result of results) {
      *         handle_result(result);
      *       }
@@ -244,12 +249,14 @@ declare global {
      * ```ts
      * // How to perform a ray cast asynchronously:
      * export default defineScript({
-     *   init(self) {
-     *     self.my_groups = [hash("my_group1"), hash("my_group2")];
+     *   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);
      *   },
      *
@@ -289,8 +296,8 @@ declare global {
      * table The callback value data is a table that contains event-related data. See the documentation for details on the messages.
      * @example
      * ```ts
-     * function physics_world_listener(self, events) {
-     *   for (const event of events) {
+     * function physics_world_listener(self: unknown, events: unknown) {
+     *   for (const event of events as Record<string, unknown>[]) {
      *     const event_type = event["type"];
      *     if (event_type === hash("contact_point_event")) {
      *       pprint(event);
@@ -316,7 +323,7 @@ declare global {
      *       //    relative_velocity = vmath.vector3(0, 0, 0),
      *       //  },
      *       // }
-     *     } else if (event === hash("collision_event")) {
+     *     } else if (event_type === hash("collision_event")) {
      *       pprint(event);
      *       // {
      *       //  a = {
@@ -330,7 +337,7 @@ declare global {
      *       //          id = hash: [/go2]
      *       //      }
      *       // }
-     *     } else if (event === hash("trigger_event")) {
+     *     } else if (event_type === hash("trigger_event")) {
      *       pprint(event);
      *       // {
      *       //  enter = true,
@@ -343,7 +350,7 @@ declare global {
      *       //      id = hash: [/go1]
      *       //  }
      *       // },
-     *     } else if (event === hash("ray_cast_response")) {
+     *     } else if (event_type === hash("ray_cast_response")) {
      *       pprint(event);
      *       // {
      *       //  group = hash: [default],
@@ -353,7 +360,7 @@ declare global {
      *       //  normal = vmath.vector3(0, 1, 0),
      *       //  id = hash: [/go]
      *       // }
-     *     } else if (event === hash("ray_cast_missed")) {
+     *     } else if (event_type === hash("ray_cast_missed")) {
      *       pprint(event);
      *       // {
      *       //  request_id = 0
@@ -409,9 +416,10 @@ declare global {
      * @example
      * ```ts
      * export default defineScript({
-     *   init(self) {
-     *     self.fliph = true; // set on some condition
-     *     physics.set_hflip("#collisionobject", self.fliph);
+     *   init() {
+     *     const fliph = true; // set on some condition
+     *     physics.set_hflip("#collisionobject", fliph);
+     *     return { fliph };
      *   },
      * });
      * ```
@@ -483,9 +491,10 @@ declare global {
      * @example
      * ```ts
      * export default defineScript({
-     *   init(self) {
-     *     self.flipv = true; // set on some condition
-     *     physics.set_vflip("#collisionobject", self.flipv);
+     *   init() {
+     *     const flipv = true; // set on some condition
+     *     physics.set_vflip("#collisionobject", flipv);
+     *     return { flipv };
      *   },
      * });
      * ```

package/generated/versions/defold-1.12.4/profiler.d.ts

@@ -5,6 +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 ViewMode = typeof profiler.VIEW_MODE_FULL | typeof profiler.VIEW_MODE_MINIMIZED;
     /**
      * pause on current frame
      */
@@ -114,6 +116,7 @@ declare global {
      * @param text - the string to send to the connected profiler
      * @example
      * ```ts
+     * const name = "my_event";
      * profiler.log_text(`Event: ${name}`);
      * ```
      */
@@ -126,7 +129,7 @@ declare global {
      * ```ts
      * // Show the last recorded frame
      * const recorded_frame_count = profiler.recorded_frame_count();
-     * profiler.view_recorded_frame(recorded_frame_count);
+     * profiler.view_recorded_frame({ frame: recorded_frame_count });
      * ```
      */
     function recorded_frame_count(): number;
@@ -136,6 +139,10 @@ declare global {
      * @param name - The name of the scope
      * @example
      * ```ts
+     * function test_function() {
+     *   // the work being measured
+     * }
+     *
      * // Go back one frame
      * profiler.scope_begin("test_function");
      * test_function();
@@ -174,7 +181,7 @@ declare global {
      * }
      * ```
      */
-    function set_ui_mode(mode: number & { readonly __brand: "profiler.MODE_RUN" } | number & { readonly __brand: "profiler.MODE_PAUSE" } | number & { readonly __brand: "profiler.MODE_SHOW_PEAK_FRAME" } | number & { readonly __brand: "profiler.MODE_RECORD" }): void;
+    function set_ui_mode(mode: profiler.Mode): void;
     /**
      * Set the on-screen profile view mode - minimized or expanded
      *
@@ -189,7 +196,7 @@ declare global {
      * profiler.set_ui_view_mode(profiler.VIEW_MODE_MINIMIZED);
      * ```
      */
-    function set_ui_view_mode(mode: number & { readonly __brand: "profiler.VIEW_MODE_FULL" } | number & { readonly __brand: "profiler.VIEW_MODE_MINIMIZED" }): 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