@defold-typescript/types 0.39.0 → 0.41.0

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

@@ -35,8 +35,8 @@ declare global {
      * @param scale - the scale of the new game object (must be greater than 0), the scale of the game object containing the factory is used by default, or if the value is `nil`
      * @returns the global id of the spawned game object
      * @example
+     * How to create a new game object:
      * ```ts
-     * // How to create a new game object:
      * export default defineScript({
      *   init(self) {
      *     // create a new game object and provide property values
@@ -45,16 +45,17 @@ declare global {
      *     msg.post(created, "hello");
      *   },
      * });
+     * ```
+     * @example
+     * And then let the new game object have a script attached:
+     * ```ts
+     * go.property("my_value", 0);
      *
-     * // And then let the new game object have a script attached, in its own file:
-     * //
-     * //   go.property("my_value", 0);
-     * //
-     * //   export default defineScript({
-     * //     init(self) {
-     * //       // do something with self.my_value which is now one
-     * //     },
-     * //   });
+     * export default defineScript({
+     *   init(self) {
+     *     // do something with self.my_value which is now one
+     *   },
+     * });
      * ```
      */
     function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: Record<string | number, unknown>, scale?: number | Vector3): Hash;
@@ -67,12 +68,10 @@ declare global {
      * @returns status of the factory component
      *
      * - `factory.STATUS_UNLOADED`
-     *
      * - `factory.STATUS_LOADING`
-     *
      * - `factory.STATUS_LOADED`
      */
-    function get_status(url?: string | Hash | Url): factory.Status;
+    function get_status(url: string | Hash | Url): factory.Status;
     /**
      * Resources are referenced by the factory component until the existing (parent) collection is destroyed or factory.unload is called.
      * Calling this function when the factory is not marked as dynamic loading does nothing.
@@ -92,7 +91,7 @@ declare global {
      * factory.load("#factory", (self, url, result) => {});
      * ```
      */
-    function load(url?: string | Hash | Url, complete_function?: (self: unknown, url: unknown, result: unknown) => void): void;
+    function load(url: string | Hash | Url, complete_function: (self: unknown, url: unknown, result: unknown) => void): void;
     /**
      * Changes the prototype for the factory.
      *
@@ -106,7 +105,7 @@ declare global {
      * const id = factory.create("#factory", go.get_world_position(), vmath.quat());
      * ```
      */
-    function set_prototype(url?: string | Hash | Url, prototype?: string): void;
+    function set_prototype(url: string | Hash | Url, prototype: string | undefined): void;
     /**
      * This decreases the reference count for each resource loaded with factory.load. If reference is zero, the resource is destroyed.
      * Calling this function when the factory is not marked as dynamic loading does nothing.
@@ -118,7 +117,7 @@ declare global {
      * factory.unload("#factory");
      * ```
      */
-    function unload(url?: string | Hash | Url): void;
+    function unload(url: string | Hash | Url): void;
   }
 }
 

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

@@ -217,15 +217,10 @@ declare global {
      * @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 to - target property value
      * @param easing - easing to use during animation. Either specify a constant, see the animation guide for a complete list, or a vmath.vector with a curve
@@ -287,7 +282,7 @@ declare global {
      * go.cancel_animations("#sprite");
      * ```
      */
-    export function cancel_animations(url: SceneAddress | Hash | Url, property?: string | Hash): void;
+    export function cancel_animations(url?: SceneAddress | Hash | Url, property?: string | Hash): void;
     /**
      * Delete one or more game objects identified by id. Deletion is asynchronous meaning that
      * the game object(s) are scheduled for deletion which will happen at the end of the current
@@ -323,7 +318,7 @@ declare global {
      * go.delete(ids, true);
      * ```
      */
-    function _delete(id?: SceneGameObjectAddress | Hash | Url | (SceneGameObjectAddress | Hash | Url)[], recursive?: boolean): void;
+    function _delete(id?: SceneGameObjectAddress | Hash | Url | (SceneGameObjectAddress | Hash | Url)[] | boolean, recursive?: boolean): void;
     /**
      * This function can check for game objects in any collection by specifying
      * the collection name in the URL.
@@ -351,6 +346,10 @@ declare global {
      * @example
      * ```ts
      * export default defineScript({
+     *   init() {
+     *     return { some_value: 0 };
+     *   },
+     *
      *   final(self) {
      *     // report finalization
      *     msg.post("my_friend_instance", "im_dead", { my_stats: self.some_value });
@@ -374,7 +373,6 @@ declare global {
      * of the absolute path to the instance.
      *
      * - If `path` is specified, it can either be absolute or relative to the instance of the calling script.
-     *
      * - If `path` is not specified, the id of the game object instance the script is attached to will be returned.
      *
      * @param path - path of the instance for which to return the id
@@ -736,7 +734,7 @@ declare global {
      *
      * @param self - reference to the script state to be used for storing data
      * @param action_id - id of the received input action, as mapped in the input_binding-file
-     * @param action - a table containing the input data, see above for a description
+     * @param action - a table containing the input data, see above for a description. **0️⃣ `gamepad` is 0-based; passed to Defold unchanged.**
      * @returns optional boolean to signal if the input should be consumed (not passed on to others) or not, default is false
      * @example
      * ```ts
@@ -766,7 +764,7 @@ declare global {
      *         self.velocity = vmath.vector3();
      *       } else {
      *         // update velocity
-     *         self.velocity = vmath.vector3(action.value * self.max_speed, 0, 0);
+     *         self.velocity = vmath.vector3((action.value ?? 0) * self.max_speed, 0, 0);
      *       }
      *     }
      *   },
@@ -808,12 +806,12 @@ declare global {
      *   init() {
      *     // store the url of instance "a" for later use, by specifying undefined as socket we
      *     // automatically use our own socket
-     *     return { a_url: msg.url(undefined, go.get_id("a"), "script") };
+     *     return { a_url: msg.url(undefined, go.get_id("a"), "script"), important_value: 0 };
      *   },
      *
      *   on_message(self, message_id, message, sender) {
      *     // check message and sender
-     *     if (message_id === hash("my_data") && sender === self.a_url) {
+     *     if (message_id === hash("my_data") && sender === self.a_url && typeof message.important_value === "number") {
      *       // use the data in some way
      *       self.important_value = message.important_value;
      *     }
@@ -855,7 +853,7 @@ declare global {
      *         self.velocity = vmath.vector3();
      *       } else {
      *         // update velocity
-     *         self.velocity = vmath.vector3(action.value * self.max_speed, 0, 0);
+     *         self.velocity = vmath.vector3((action.value ?? 0) * self.max_speed, 0, 0);
      *       }
      *     }
      *   },
@@ -1039,7 +1037,7 @@ declare global {
      * const new_position = go.world_to_local_position(test_pos, "/child");
      * ```
      */
-    export function world_to_local_position(position: Vector3, url: SceneGameObjectAddress | Hash | Url): Vector3;
+    export function world_to_local_position(position: Vector3, url?: SceneGameObjectAddress | Hash | Url): Vector3;
     /**
      * The function uses world transformation calculated at the end of previous frame.
      *
@@ -1054,7 +1052,7 @@ declare global {
      * const result_transform = go.world_to_local_transform(test_transform, "/child");
      * ```
      */
-    export function world_to_local_transform(transformation: Matrix4, url: SceneGameObjectAddress | Hash | Url): Matrix4;
+    export function world_to_local_transform(transformation: Matrix4, url?: SceneGameObjectAddress | Hash | Url): Matrix4;
     export { _delete as delete };
     export interface properties {
       /**
@@ -1074,9 +1072,9 @@ declare global {
        */
       rotation: Quaternion;
       /**
-       * The uniform scale of the game object. The type of the property is number.
+       * The scale of the game object. `go.get` returns a vector3; `go.set` and `go.animate` also take a number, which sets a uniform scale.
        */
-      scale: number;
+      scale: number | Vector3;
     }
   }
 }