@defold-typescript/types 0.39.0 → 0.41.0

package/generated/camera.d.ts

@@ -1,25 +1,22 @@
 /** @noSelfInFile */
-import type { Matrix4, Url, Vector3 } from "../src/core-types";
+import type { Hash, Matrix4, Url, Vector3 } from "../src/core-types";
 
 declare global {
   /**
    * Messages to control camera components and camera focus.
    */
   namespace camera {
+    type ORTHO_MODE = typeof camera.ORTHO_MODE_AUTO_COVER | typeof camera.ORTHO_MODE_AUTO_FIT | typeof camera.ORTHO_MODE_FIXED;
     /**
-     * Computes zoom so the original display area covers the entire window while preserving aspect ratio.
-     * Equivalent to using max(window_width/width, window_height/height).
-     * The result is multiplied by the user-controlled orthographic zoom.
+     * auto-cover orthographic zoom mode Computes zoom so the original display area covers the entire window while preserving aspect ratio. Equivalent to using max(window_width/width, window_height/height). The result is multiplied by the user-controlled orthographic zoom.
      */
     const ORTHO_MODE_AUTO_COVER: number & { readonly __brand: "camera.ORTHO_MODE_AUTO_COVER" };
     /**
-     * Computes zoom so the original display area (game.project width/height) fits inside the window
-     * while preserving aspect ratio. Equivalent to using min(window_width/width, window_height/height).
-     * The result is multiplied by the user-controlled orthographic zoom.
+     * auto-fit orthographic zoom mode Computes zoom so the original display area (game.project width/height) fits inside the window while preserving aspect ratio. Equivalent to using min(window_width/width, window_height/height). The result is multiplied by the user-controlled orthographic zoom.
      */
     const ORTHO_MODE_AUTO_FIT: number & { readonly __brand: "camera.ORTHO_MODE_AUTO_FIT" };
     /**
-     * Uses the manually set orthographic zoom value (camera.set_orthographic_zoom).
+     * fixed orthographic zoom mode Uses the manually set orthographic zoom value (camera.set_orthographic_zoom).
      */
     const ORTHO_MODE_FIXED: number & { readonly __brand: "camera.ORTHO_MODE_FIXED" };
     /**
@@ -30,7 +27,7 @@ declare global {
      * @param camera - camera id
      * @returns the effective aspect ratio.
      */
-    function get_aspect_ratio(camera?: Url | number): number;
+    function get_aspect_ratio(camera?: Url | number | string | Hash): number;
     /**
      * Returns whether auto aspect ratio is enabled. When enabled, the camera automatically
      * calculates aspect ratio from render target dimensions. When disabled, uses the
@@ -39,7 +36,7 @@ declare global {
      * @param camera - camera id
      * @returns true if auto aspect ratio is enabled
      */
-    function get_auto_aspect_ratio(camera?: Url | number): boolean;
+    function get_auto_aspect_ratio(camera?: Url | number | string | Hash): boolean;
     /**
      * This function returns a table with all the camera URLs that have been
      * registered in the render context.
@@ -62,28 +59,28 @@ declare global {
      * @param camera - camera id
      * @returns true if the camera is enabled
      */
-    function get_enabled(camera?: Url | number): boolean;
+    function get_enabled(camera?: Url | number | string | Hash): boolean;
     /**
      * get far z
      *
      * @param camera - camera id
      * @returns the far z.
      */
-    function get_far_z(camera?: Url | number): number;
+    function get_far_z(camera?: Url | number | string | Hash): number;
     /**
      * get field of view
      *
      * @param camera - camera id
      * @returns the field of view.
      */
-    function get_fov(camera?: Url | number): number;
+    function get_fov(camera?: Url | number | string | Hash): number;
     /**
      * get near z
      *
      * @param camera - camera id
      * @returns the near z.
      */
-    function get_near_z(camera?: Url | number): number;
+    function get_near_z(camera?: Url | number | string | Hash): number;
     /**
      * Gets the orthographic zoom calculated from the current window and project dimensions
      * in auto-fit and auto-cover modes. Returns 1.0 in fixed mode.
@@ -91,7 +88,7 @@ declare global {
      * @param camera - camera id
      * @returns the calculated orthographic auto zoom.
      */
-    function get_orthographic_auto_zoom(camera?: Url | number): number;
+    function get_orthographic_auto_zoom(camera?: Url | number | string | Hash): number;
     /**
      * get orthographic zoom mode
      *
@@ -99,7 +96,7 @@ declare global {
      * @returns one of camera.ORTHO_MODE_FIXED, camera.ORTHO_MODE_AUTO_FIT or
      * camera.ORTHO_MODE_AUTO_COVER
      */
-    function get_orthographic_mode(camera?: Url | number): number;
+    function get_orthographic_mode(camera?: Url | number | string | Hash): camera.ORTHO_MODE;
     /**
      * Gets the positive user-controlled orthographic zoom multiplier. In auto-fit and auto-cover
      * modes, this value is multiplied with camera.get_orthographic_auto_zoom(camera).
@@ -107,21 +104,21 @@ declare global {
      * @param camera - camera id
      * @returns the positive zoom multiplier when the camera uses orthographic projection.
      */
-    function get_orthographic_zoom(camera?: Url | number): number;
+    function get_orthographic_zoom(camera?: Url | number | string | Hash): number;
     /**
      * get projection matrix
      *
      * @param camera - camera id
      * @returns the projection matrix.
      */
-    function get_projection(camera?: Url | number): Matrix4;
+    function get_projection(camera?: Url | number | string | Hash): Matrix4;
     /**
      * get view matrix
      *
      * @param camera - camera id
      * @returns the view matrix.
      */
-    function get_view(camera?: Url | number): Matrix4;
+    function get_view(camera?: Url | number | string | Hash): Matrix4;
     /**
      * Converts a screen-space 2D point with view depth to a 3D world point.
      * z is the view depth in world units measured from the camera plane along the camera forward axis.
@@ -137,7 +134,7 @@ declare global {
      * export default defineScript({
      *   on_input(self, action_id, action) {
      *     if (action_id === hash("touch")) {
-     *       if (action.pressed) {
+     *       if (action.pressed && action.screen_x !== undefined && action.screen_y !== undefined) {
      *         const perspective_camera = msg.url("#perspective_camera");
      *         const random_z = math.random(
      *           camera.get_near_z(perspective_camera) + 0.01,
@@ -154,7 +151,7 @@ declare global {
      * });
      * ```
      */
-    function screen_to_world(pos: Vector3, camera?: Url | number): Vector3;
+    function screen_to_world(pos: Vector3, camera?: Url | number | string | Hash): Vector3;
     /**
      * Converts 2D screen coordinates (x,y) to the 3D world-space point on the camera's near plane for that pixel.
      * If a camera isn't specified, the last enabled camera is used.
@@ -169,7 +166,7 @@ declare global {
      * export default defineScript({
      *   on_input(self, action_id, action) {
      *     if (action_id === hash("touch")) {
-     *       if (action.pressed) {
+     *       if (action.pressed && action.screen_x !== undefined && action.screen_y !== undefined) {
      *         const world_position = camera.screen_xy_to_world(action.screen_x, action.screen_y);
      *         go.set_position(world_position, "/go1");
      *       }
@@ -178,7 +175,7 @@ declare global {
      * });
      * ```
      */
-    function screen_xy_to_world(x: number, y: number, camera?: Url | number): Vector3;
+    function screen_xy_to_world(x: number, y: number, camera?: Url | number | string | Hash): Vector3;
     /**
      * Sets the manual aspect ratio for the camera. This value is only used when
      * auto aspect ratio is disabled. To disable auto aspect ratio and use this
@@ -187,7 +184,7 @@ declare global {
      * @param camera - camera id
      * @param aspect_ratio - the manual aspect ratio value.
      */
-    function set_aspect_ratio(camera: Url | number | undefined, aspect_ratio: number): void;
+    function set_aspect_ratio(camera: Url | number | string | Hash | undefined, aspect_ratio: number): void;
     /**
      * Enables or disables automatic aspect ratio calculation. When enabled (true),
      * the camera automatically calculates aspect ratio from render target dimensions.
@@ -196,35 +193,35 @@ declare global {
      * @param camera - camera id
      * @param auto_aspect_ratio - true to enable auto aspect ratio
      */
-    function set_auto_aspect_ratio(camera: Url | number | undefined, auto_aspect_ratio: boolean): void;
+    function set_auto_aspect_ratio(camera: Url | number | string | Hash | undefined, auto_aspect_ratio: boolean): void;
     /**
      * set far z
      *
      * @param camera - camera id
      * @param far_z - the far z.
      */
-    function set_far_z(camera: Url | number | undefined, far_z: number): void;
+    function set_far_z(camera: Url | number | string | Hash | undefined, far_z: number): void;
     /**
      * set field of view
      *
      * @param camera - camera id
      * @param fov - the field of view.
      */
-    function set_fov(camera: Url | number | undefined, fov: number): void;
+    function set_fov(camera: Url | number | string | Hash | undefined, fov: number): void;
     /**
      * set near z
      *
      * @param camera - camera id
      * @param near_z - the near z.
      */
-    function set_near_z(camera: Url | number | undefined, near_z: number): void;
+    function set_near_z(camera: Url | number | string | Hash | undefined, near_z: number): void;
     /**
      * set orthographic zoom mode
      *
      * @param camera - camera id
      * @param mode - camera.ORTHO_MODE_FIXED, camera.ORTHO_MODE_AUTO_FIT or camera.ORTHO_MODE_AUTO_COVER
      */
-    function set_orthographic_mode(camera: Url | number | undefined, mode: number): void;
+    function set_orthographic_mode(camera: Url | number | string | Hash | undefined, mode: camera.ORTHO_MODE): void;
     /**
      * Sets the positive user-controlled orthographic zoom multiplier. In auto-fit and auto-cover
      * modes, this value is multiplied with camera.get_orthographic_auto_zoom(camera).
@@ -232,7 +229,7 @@ declare global {
      * @param camera - camera id
      * @param orthographic_zoom - the positive zoom multiplier when the camera uses orthographic projection.
      */
-    function set_orthographic_zoom(camera: Url | number | undefined, orthographic_zoom: number): void;
+    function set_orthographic_zoom(camera: Url | number | string | Hash | undefined, orthographic_zoom: number): void;
     /**
      * Converts a 3D world position to screen-space coordinates with view depth.
      * Returns a vector3 where x and y are in screen pixels and z is the view depth in world units
@@ -251,7 +248,7 @@ declare global {
      * const screen_pos = camera.world_to_screen(world_pos);
      * ```
      */
-    function world_to_screen(world_pos: Vector3, camera?: Url | number): Vector3;
+    function world_to_screen(world_pos: Vector3, camera?: Url | number | string | Hash): Vector3;
     interface properties {
       /**
        * The ratio between the frustum width and height. Used when calculating the
@@ -279,7 +276,7 @@ declare global {
        * in auto fit and auto cover modes. The value is 1.0 in fixed mode.
        * The type of the property is float.
        */
-      orthographic_auto_zoom: number;
+      readonly orthographic_auto_zoom: number;
       /**
        * Positive zoom multiplier when using an orthographic projection. In auto fit and auto cover
        * modes, this value is multiplied with the calculated orthographic_auto_zoom value.
@@ -290,12 +287,12 @@ declare global {
        * READ ONLY The calculated projection matrix of the camera.
        * The type of the property is matrix4.
        */
-      projection: Matrix4;
+      readonly projection: Matrix4;
       /**
        * READ ONLY The calculated view matrix of the camera.
        * The type of the property is matrix4.
        */
-      view: Matrix4;
+      readonly view: Matrix4;
     }
   }
 }

package/generated/collectionfactory.d.ts

@@ -8,16 +8,17 @@ declare global {
    */
   namespace collectionfactory {
     type Status = typeof collectionfactory.STATUS_UNLOADED | typeof collectionfactory.STATUS_LOADING | typeof collectionfactory.STATUS_LOADED;
+    type STATUS = typeof collectionfactory.STATUS_LOADED | typeof collectionfactory.STATUS_LOADING | typeof collectionfactory.STATUS_UNLOADED;
     /**
-     * loaded
+     * The collection factory resources are loaded.
      */
     const STATUS_LOADED: number & { readonly __brand: "collectionfactory.STATUS_LOADED" };
     /**
-     * loading
+     * The collection factory resources are loading.
      */
     const STATUS_LOADING: number & { readonly __brand: "collectionfactory.STATUS_LOADING" };
     /**
-     * unloaded
+     * The collection factory resources are unloaded.
      */
     const STATUS_UNLOADED: number & { readonly __brand: "collectionfactory.STATUS_UNLOADED" };
     /**
@@ -43,21 +44,20 @@ declare global {
      * @param scale - uniform scaling to apply to the newly spawned collection (must be greater than 0).
      * @returns a table mapping the id:s from the collection to the new instance id:s
      * @example
+     * How to spawn a collection of game objects:
      * ```ts
-     * // How to spawn a collection of game objects:
      * export default defineScript({
-     *   init(self) {
+     *   init() {
      *     // Spawn a small group of enemies.
      *     const pos = vmath.vector3(100, 12.5, 0);
      *     const rot = vmath.quat_rotation_z(Math.PI / 2);
      *     const scale = 0.5;
-     *     const props = {
-     *       [hash("/enemy_leader")]: { health: 1000.0 },
-     *       [hash("/enemy_1")]: { health: 200.0 },
-     *       [hash("/enemy_2")]: { health: 400.0, color: hash("green") },
-     *     };
+     *     const props = new LuaMap<Hash, Record<string, unknown>>();
+     *     props.set(hash("/enemy_leader"), { health: 1000.0 });
+     *     props.set(hash("/enemy_1"), { health: 200.0 });
+     *     props.set(hash("/enemy_2"), { health: 400.0, color: hash("green") });
      *
-     *     self.enemy_ids = collectionfactory.create("#enemyfactory", pos, rot, props, scale);
+     *     const enemy_ids = collectionfactory.create("#enemyfactory", pos, rot, props, scale);
      *     // enemy_ids now map to the spawned instance ids:
      *     //
      *     // pprint(self.enemy_ids)
@@ -70,32 +70,31 @@ declare global {
      *     // }
      *
      *     // Send "attack" message to the leader. First look up its instance id.
-     *     const leader_id = self.enemy_ids[hash("/enemy_leader")];
-     *     msg.post(leader_id, "attack");
+     *     const leader_id = enemy_ids.get(hash("/enemy_leader"));
+     *     if (leader_id !== undefined) {
+     *       msg.post(leader_id, "attack");
+     *     }
+     *     return { enemy_ids };
      *   },
      * });
-     *
-     * // How to delete a spawned collection:
+     * ```
+     * @example
+     * How to delete a spawned collection:
+     * ```ts
      * function delete_enemies(self: { enemy_ids: Hash[] }) {
      *   go.delete(self.enemy_ids);
      * }
      * ```
      */
-    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: Record<string | number, unknown>, scale?: number | Vector3): LuaMap<Hash, Hash>;
+    function create(url: string | Hash | Url, position?: Vector3, rotation?: Quaternion, properties?: LuaMap<Hash, Record<string | number, unknown>> | Record<string, Record<string | number, unknown>>, scale?: number | Vector3): LuaTable<Hash, Hash>;
     /**
      * This returns status of the collection factory.
      * Calling this function when the factory is not marked as dynamic loading always returns COMP_COLLECTION_FACTORY_STATUS_LOADED.
      *
      * @param url - the collection factory component to get status from
      * @returns status of the collection factory component
-     *
-     * - `collectionfactory.STATUS_UNLOADED`
-     *
-     * - `collectionfactory.STATUS_LOADING`
-     *
-     * - `collectionfactory.STATUS_LOADED`
      */
-    function get_status(url?: string | Hash | Url): collectionfactory.Status;
+    function get_status(url: string | Hash | Url): collectionfactory.STATUS;
     /**
      * Resources loaded are referenced by the collection factory component until the existing (parent) collection is destroyed or collectionfactory.unload is called.
      * Calling this function when the factory is not marked as dynamic loading does nothing.
@@ -104,7 +103,7 @@ declare global {
      * @param complete_function - function to call when resources are loaded.
      *
      * `self`
-     * object The current object.
+     * script_instance The current script instance.
      * `url`
      * url url of the collection factory component
      * `result`
@@ -115,7 +114,7 @@ declare global {
      * collectionfactory.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: Url, result: boolean) => void): void;
     /**
      * Changes the prototype for the collection factory.
      * Setting the prototype to "nil" will revert back to the original prototype.
@@ -130,7 +129,7 @@ declare global {
      * const ids = collectionfactory.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 collectionfactory.load. If reference is zero, the resource is destroyed.
      * Calling this function when the factory is not marked as dynamic loading does nothing.
@@ -142,7 +141,7 @@ declare global {
      * collectionfactory.unload("#factory");
      * ```
      */
-    function unload(url?: string | Hash | Url): void;
+    function unload(url: string | Hash | Url): void;
   }
 }
 

package/generated/collectionproxy.d.ts

@@ -8,15 +8,31 @@ declare global {
    */
   namespace collectionproxy {
     /**
-     * It's impossible to change the collection if the collection is already loaded.
+     * Data delivered to a collectionproxy.load callback. The available
+     * field depends on the callback message identifier.
+     */
+    interface load_data {
+      /**
+       * Loading progress from 0 to 1 for `proxy_loading`.
+       */
+      progress?: number;
+      /**
+       * Error code for `proxy_error`.
+       */
+      code?: number;
+    }
+    type TIME_STEP_MODE = 0 | 1;
+    type RESULT = typeof collectionproxy.RESULT_ALREADY_LOADED | typeof collectionproxy.RESULT_LOADING | typeof collectionproxy.RESULT_NOT_EXCLUDED;
+    /**
+     * The collection proxy is already loaded, so its collection cannot be changed.
      */
     const RESULT_ALREADY_LOADED: number & { readonly __brand: "collectionproxy.RESULT_ALREADY_LOADED" };
     /**
-     * It's impossible to change the collection while the collection proxy is loading.
+     * The collection proxy is loading, so its collection cannot be changed.
      */
     const RESULT_LOADING: number & { readonly __brand: "collectionproxy.RESULT_LOADING" };
     /**
-     * It's impossible to change the collection for a proxy that isn't excluded.
+     * The collection proxy is not excluded from the bundle; only excluded proxies can change collections.
      */
     const RESULT_NOT_EXCLUDED: number & { readonly __brand: "collectionproxy.RESULT_NOT_EXCLUDED" };
     /**
@@ -40,7 +56,7 @@ declare global {
      * }
      * ```
      */
-    function get_resources(collectionproxy: Url): Hash[];
+    function get_resources(collectionproxy: Url | string | Hash): string[];
     /**
      * Loads the collection referenced by a collection proxy. The proxy is also
      * initialized and the callback receives `proxy_loading`, `proxy_ready`, or
@@ -62,7 +78,7 @@ declare global {
      * });
      * ```
      */
-    function load(url: string | Hash | Url, options: Record<string | number, unknown> | undefined, callback: (self: unknown, message_id: unknown, message: unknown, sender: unknown) => void): void;
+    function load(url: string | Hash | Url, options: {} | undefined, callback: (self: unknown, message_id: Hash, message: Record<string | number, unknown>, sender: Url) => void): void;
     /**
      * The collection should be loaded by the collection proxy.
      * Setting the collection to "nil" will revert it back to the original collection.
@@ -86,7 +102,7 @@ declare global {
      * msg.post("/go#collectionproxy", "enable");
      * ```
      */
-    function set_collection(url?: string | Hash | Url, prototype?: string): LuaMultiReturn<[boolean, number]>;
+    function set_collection(url: string | Hash | Url, prototype: string | undefined): LuaMultiReturn<[boolean, collectionproxy.RESULT]>;
   }
 }