@defold-typescript/types 0.40.0 → 0.41.0

package/generated/versions/defold-1.13.0/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.13.0/go.d.ts

@@ -215,15 +215,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
@@ -285,7 +280,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
@@ -376,7 +371,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
@@ -765,7 +759,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
@@ -1068,7 +1062,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.
      *
@@ -1083,7 +1077,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 {
       /**
@@ -1103,9 +1097,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;
     }
   }
 }

package/generated/versions/defold-1.13.0/graphics.d.ts

@@ -92,6 +92,46 @@ declare global {
      * Context feature flag indicating support for vertical sync (vsync).
      */
     const CONTEXT_FEATURE_VSYNC: number & { readonly __brand: "graphics.CONTEXT_FEATURE_VSYNC" };
+    /**
+     * Vertex attribute coordinate space, for `material.set_vertex_attributes`.
+     */
+    const COORDINATE_SPACE_DEFAULT: number & { readonly __brand: "graphics.COORDINATE_SPACE_DEFAULT" };
+    /**
+     * Vertex attribute coordinate space, for `material.set_vertex_attributes`.
+     */
+    const COORDINATE_SPACE_LOCAL: number & { readonly __brand: "graphics.COORDINATE_SPACE_LOCAL" };
+    /**
+     * Vertex attribute coordinate space, for `material.set_vertex_attributes`.
+     */
+    const COORDINATE_SPACE_WORLD: number & { readonly __brand: "graphics.COORDINATE_SPACE_WORLD" };
+    /**
+     * Vertex attribute data type, for `material.set_vertex_attributes`.
+     */
+    const DATA_TYPE_BYTE: number & { readonly __brand: "graphics.DATA_TYPE_BYTE" };
+    /**
+     * Vertex attribute data type, for `material.set_vertex_attributes`.
+     */
+    const DATA_TYPE_FLOAT: number & { readonly __brand: "graphics.DATA_TYPE_FLOAT" };
+    /**
+     * Vertex attribute data type, for `material.set_vertex_attributes`.
+     */
+    const DATA_TYPE_INT: number & { readonly __brand: "graphics.DATA_TYPE_INT" };
+    /**
+     * Vertex attribute data type, for `material.set_vertex_attributes`.
+     */
+    const DATA_TYPE_SHORT: number & { readonly __brand: "graphics.DATA_TYPE_SHORT" };
+    /**
+     * Vertex attribute data type, for `material.set_vertex_attributes`.
+     */
+    const DATA_TYPE_UNSIGNED_BYTE: number & { readonly __brand: "graphics.DATA_TYPE_UNSIGNED_BYTE" };
+    /**
+     * Vertex attribute data type, for `material.set_vertex_attributes`.
+     */
+    const DATA_TYPE_UNSIGNED_INT: number & { readonly __brand: "graphics.DATA_TYPE_UNSIGNED_INT" };
+    /**
+     * Vertex attribute data type, for `material.set_vertex_attributes`.
+     */
+    const DATA_TYPE_UNSIGNED_SHORT: number & { readonly __brand: "graphics.DATA_TYPE_UNSIGNED_SHORT" };
     const FACE_TYPE_BACK: number & { readonly __brand: "graphics.FACE_TYPE_BACK" };
     const FACE_TYPE_FRONT: number & { readonly __brand: "graphics.FACE_TYPE_FRONT" };
     const FACE_TYPE_FRONT_AND_BACK: number & { readonly __brand: "graphics.FACE_TYPE_FRONT_AND_BACK" };
@@ -319,44 +359,40 @@ declare global {
      * optional context features supported by the backend.
      *
      * @returns table with the following fields:
-     * `family` string adapter family name (e.g. "opengl", "vulkan")
-     * `version_major` number adapter API major version (e.g. 1 for Vulkan 1.4)
-     * `version_minor` number adapter API minor version (e.g. 4 for Vulkan 1.4)
-     * `limits` table hardware/driver limits:
-     *
-     * ``max_texture_size_2d` [type:number] max 2D texture dimension in texels
-     * `max_texture_size_3d` [type:number] max 3D (volume) texture dimension in texels
-     * `max_texture_size_cube` [type:number] max cube map face dimension in texels
-     * `max_texture_array_layers` [type:number] max layers in an array texture
-     * `max_framebuffer_width` [type:number] max framebuffer width in pixels
-     * `max_framebuffer_height` [type:number] max framebuffer height in pixels
-     * `max_color_attachments` [type:number] max simultaneous color attachments
-     * `max_samplers_per_stage` [type:number] max texture samplers per shader stage
-     * `max_textures_per_stage` [type:number] max sampled textures per shader stage
-     * `max_vertex_attributes` [type:number] max vertex attributes
-     * `max_vertex_buffers` [type:number] max vertex buffer bindings
-     * `max_compute_workgroup_size_x` [type:number] max compute workgroup size (X)
-     * `max_compute_workgroup_size_y` [type:number] max compute workgroup size (Y)
-     * `max_compute_workgroup_size_z` [type:number] max compute workgroup size (Z)
-     * `max_compute_workgroup_invocations` [type:number] max invocations per compute workgroup
-     * `max_compute_shared_memory_size` [type:number] max shared memory per compute workgroup (bytes)
-     * `max_uniform_buffer_range` [type:number] max bindable uniform buffer range (bytes)
-     * `max_storage_buffer_range` [type:number] max bindable storage buffer range (bytes)
-     * `
-     *
-     * `extensions` table array of driver-reported extension name strings
-     * `features` table array of supported context feature ids:
      *
-     * ``graphics.CONTEXT_FEATURE_MULTI_TARGET_RENDERING` multi-target rendering
-     * `graphics.CONTEXT_FEATURE_TEXTURE_ARRAY` texture arrays
-     * `graphics.CONTEXT_FEATURE_COMPUTE_SHADER` compute shaders
-     * `graphics.CONTEXT_FEATURE_STORAGE_BUFFER` storage buffers
-     * `graphics.CONTEXT_FEATURE_VSYNC` vertical sync
-     * `graphics.CONTEXT_FEATURE_INSTANCING` hardware instancing
-     * `graphics.CONTEXT_FEATURE_3D_TEXTURES` 3D (volume) textures
-     * `graphics.CONTEXT_FEATURE_ASTC_ARRAY_TEXTURES` ASTC compressed 2D array textures
-     * `graphics.CONTEXT_FEATURE_BLEND_EQUATION_MIN_MAX` min/max blend equations
-     * `
+     * - `family` string adapter family name (e.g. "opengl", "vulkan")
+     * - `version_major` number adapter API major version (e.g. 1 for Vulkan 1.4)
+     * - `version_minor` number adapter API minor version (e.g. 4 for Vulkan 1.4)
+     * - `limits` table hardware/driver limits:
+     *   - `max_texture_size_2d` number max 2D texture dimension in texels
+     *   - `max_texture_size_3d` number max 3D (volume) texture dimension in texels
+     *   - `max_texture_size_cube` number max cube map face dimension in texels
+     *   - `max_texture_array_layers` number max layers in an array texture
+     *   - `max_framebuffer_width` number max framebuffer width in pixels
+     *   - `max_framebuffer_height` number max framebuffer height in pixels
+     *   - `max_color_attachments` number max simultaneous color attachments
+     *   - `max_samplers_per_stage` number max texture samplers per shader stage
+     *   - `max_textures_per_stage` number max sampled textures per shader stage
+     *   - `max_vertex_attributes` number max vertex attributes
+     *   - `max_vertex_buffers` number max vertex buffer bindings
+     *   - `max_compute_workgroup_size_x` number max compute workgroup size (X)
+     *   - `max_compute_workgroup_size_y` number max compute workgroup size (Y)
+     *   - `max_compute_workgroup_size_z` number max compute workgroup size (Z)
+     *   - `max_compute_workgroup_invocations` number max invocations per compute workgroup
+     *   - `max_compute_shared_memory_size` number max shared memory per compute workgroup (bytes)
+     *   - `max_uniform_buffer_range` number max bindable uniform buffer range (bytes)
+     *   - `max_storage_buffer_range` number max bindable storage buffer range (bytes)
+     * - `extensions` table array of driver-reported extension name strings
+     * - `features` table array of supported context feature ids:
+     *   - `graphics.CONTEXT_FEATURE_MULTI_TARGET_RENDERING` multi-target rendering
+     *   - `graphics.CONTEXT_FEATURE_TEXTURE_ARRAY` texture arrays
+     *   - `graphics.CONTEXT_FEATURE_COMPUTE_SHADER` compute shaders
+     *   - `graphics.CONTEXT_FEATURE_STORAGE_BUFFER` storage buffers
+     *   - `graphics.CONTEXT_FEATURE_VSYNC` vertical sync
+     *   - `graphics.CONTEXT_FEATURE_INSTANCING` hardware instancing
+     *   - `graphics.CONTEXT_FEATURE_3D_TEXTURES` 3D (volume) textures
+     *   - `graphics.CONTEXT_FEATURE_ASTC_ARRAY_TEXTURES` ASTC compressed 2D array textures
+     *   - `graphics.CONTEXT_FEATURE_BLEND_EQUATION_MIN_MAX` min/max blend equations
      */
     function get_adapter_info(): { family: string; version_major: number; version_minor: number; limits: { max_texture_size_2d: number; max_texture_size_3d: number; max_texture_size_cube: number; max_texture_array_layers: number; max_framebuffer_width: number; max_framebuffer_height: number; max_color_attachments: number; max_samplers_per_stage: number; max_textures_per_stage: number; max_vertex_attributes: number; max_vertex_buffers: number; max_compute_workgroup_size_x: number; max_compute_workgroup_size_y: number; max_compute_workgroup_size_z: number; max_compute_workgroup_invocations: number; max_compute_shared_memory_size: number; max_uniform_buffer_range: number; max_storage_buffer_range: number }; extensions: string[]; features: number[] };
     /**