@defold-typescript/types 0.37.0 → 0.39.0

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

@@ -8,6 +8,8 @@ declare global {
    * files.
    */
   namespace go {
+    export type Easing = typeof go.EASING_INBACK | typeof go.EASING_INBOUNCE | typeof go.EASING_INCIRC | typeof go.EASING_INCUBIC | typeof go.EASING_INELASTIC | typeof go.EASING_INEXPO | typeof go.EASING_INOUTBACK | typeof go.EASING_INOUTBOUNCE | typeof go.EASING_INOUTCIRC | typeof go.EASING_INOUTCUBIC | typeof go.EASING_INOUTELASTIC | typeof go.EASING_INOUTEXPO | typeof go.EASING_INOUTQUAD | typeof go.EASING_INOUTQUART | typeof go.EASING_INOUTQUINT | typeof go.EASING_INOUTSINE | typeof go.EASING_INQUAD | typeof go.EASING_INQUART | typeof go.EASING_INQUINT | typeof go.EASING_INSINE | typeof go.EASING_LINEAR | typeof go.EASING_OUTBACK | typeof go.EASING_OUTBOUNCE | typeof go.EASING_OUTCIRC | typeof go.EASING_OUTCUBIC | typeof go.EASING_OUTELASTIC | typeof go.EASING_OUTEXPO | typeof go.EASING_OUTINBACK | typeof go.EASING_OUTINBOUNCE | typeof go.EASING_OUTINCIRC | typeof go.EASING_OUTINCUBIC | typeof go.EASING_OUTINELASTIC | typeof go.EASING_OUTINEXPO | typeof go.EASING_OUTINQUAD | typeof go.EASING_OUTINQUART | typeof go.EASING_OUTINQUINT | typeof go.EASING_OUTINSINE | typeof go.EASING_OUTQUAD | typeof go.EASING_OUTQUART | typeof go.EASING_OUTQUINT | typeof go.EASING_OUTSINE;
+    export type Playback = typeof go.PLAYBACK_ONCE_FORWARD | typeof go.PLAYBACK_ONCE_BACKWARD | typeof go.PLAYBACK_ONCE_PINGPONG | typeof go.PLAYBACK_LOOP_FORWARD | typeof go.PLAYBACK_LOOP_BACKWARD | typeof go.PLAYBACK_LOOP_PINGPONG;
     /**
      * in-back
      */
@@ -243,14 +245,15 @@ declare global {
      *
      * hash The id of the animated property.
      * @example
+     * Animate the position of a game object to x = 10 during 1 second, then y = 20 during 1 second:
      * ```ts
-     * // Animate the position of a game object to x = 10 during 1 second, then
-     * // y = 20 during 1 second:
      * go.animate(go.get_id(), "position.x", go.PLAYBACK_ONCE_FORWARD, 10, go.EASING_LINEAR, 1, 0, () => {
      *   go.animate(go.get_id(), "position.y", go.PLAYBACK_ONCE_FORWARD, 20, go.EASING_LINEAR, 1);
      * });
-     *
-     * // Animate the y position of a game object using a crazy custom easing curve:
+     * ```
+     * @example
+     * Animate the y position of a game object using a crazy custom easing curve:
+     * ```ts
      * const values = [
      *   0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1,
      *   0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1,
@@ -261,7 +264,7 @@ declare global {
      * go.animate("go", "position.y", go.PLAYBACK_LOOP_PINGPONG, 100, vec, 2.0);
      * ```
      */
-    export function animate(url: SceneAddress | Hash | Url, property: 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" }, to: number | Vector3 | Vector4 | Quaternion, easing: Vector | number & { readonly __brand: "go.EASING_INBACK" } | number & { readonly __brand: "go.EASING_INBOUNCE" } | number & { readonly __brand: "go.EASING_INCIRC" } | number & { readonly __brand: "go.EASING_INCUBIC" } | number & { readonly __brand: "go.EASING_INELASTIC" } | number & { readonly __brand: "go.EASING_INEXPO" } | number & { readonly __brand: "go.EASING_INOUTBACK" } | number & { readonly __brand: "go.EASING_INOUTBOUNCE" } | number & { readonly __brand: "go.EASING_INOUTCIRC" } | number & { readonly __brand: "go.EASING_INOUTCUBIC" } | number & { readonly __brand: "go.EASING_INOUTELASTIC" } | number & { readonly __brand: "go.EASING_INOUTEXPO" } | number & { readonly __brand: "go.EASING_INOUTQUAD" } | number & { readonly __brand: "go.EASING_INOUTQUART" } | number & { readonly __brand: "go.EASING_INOUTQUINT" } | number & { readonly __brand: "go.EASING_INOUTSINE" } | number & { readonly __brand: "go.EASING_INQUAD" } | number & { readonly __brand: "go.EASING_INQUART" } | number & { readonly __brand: "go.EASING_INQUINT" } | number & { readonly __brand: "go.EASING_INSINE" } | number & { readonly __brand: "go.EASING_LINEAR" } | number & { readonly __brand: "go.EASING_OUTBACK" } | number & { readonly __brand: "go.EASING_OUTBOUNCE" } | number & { readonly __brand: "go.EASING_OUTCIRC" } | number & { readonly __brand: "go.EASING_OUTCUBIC" } | number & { readonly __brand: "go.EASING_OUTELASTIC" } | number & { readonly __brand: "go.EASING_OUTEXPO" } | number & { readonly __brand: "go.EASING_OUTINBACK" } | number & { readonly __brand: "go.EASING_OUTINBOUNCE" } | number & { readonly __brand: "go.EASING_OUTINCIRC" } | number & { readonly __brand: "go.EASING_OUTINCUBIC" } | number & { readonly __brand: "go.EASING_OUTINELASTIC" } | number & { readonly __brand: "go.EASING_OUTINEXPO" } | number & { readonly __brand: "go.EASING_OUTINQUAD" } | number & { readonly __brand: "go.EASING_OUTINQUART" } | number & { readonly __brand: "go.EASING_OUTINQUINT" } | number & { readonly __brand: "go.EASING_OUTINSINE" } | number & { readonly __brand: "go.EASING_OUTQUAD" } | number & { readonly __brand: "go.EASING_OUTQUART" } | number & { readonly __brand: "go.EASING_OUTQUINT" } | number & { readonly __brand: "go.EASING_OUTSINE" }, duration: number, delay?: number, complete_function?: (self: unknown, url: unknown, property: unknown) => void): void;
+    export function animate(url: SceneAddress | Hash | Url, property: string | Hash, playback: go.Playback, to: number | Vector3 | Vector4 | Quaternion, easing: Vector | go.Easing, duration: number, delay?: number, complete_function?: (self: unknown, url: unknown, property: unknown) => void): void;
     /**
      * By calling this function, all or specified stored property animations of the game object or component will be canceled.
      * See the properties guide for which properties can be animated and the animation guide for how to animate them.
@@ -269,14 +272,18 @@ declare global {
      * @param url - url of the game object or component
      * @param property - optional id of the property to cancel
      * @example
+     * Cancel the animation of the position of a game object:
      * ```ts
-     * // Cancel the animation of the position of a game object:
      * go.cancel_animations(go.get_id(), "position");
-     *
-     * // Cancel all property animations of the current game object:
+     * ```
+     * @example
+     * Cancel all property animations of the current game object:
+     * ```ts
      * go.cancel_animations(".");
-     *
-     * // Cancel all property animations of the sprite component of the current game object:
+     * ```
+     * @example
+     * Cancel all property animations of the sprite component of the current game object:
+     * ```ts
      * go.cancel_animations("#sprite");
      * ```
      */
@@ -292,8 +299,8 @@ declare global {
      * @param id - optional id or table of id's of the instance(s) to delete, the instance of the calling script is deleted by default
      * @param recursive - optional boolean, set to true to recursively delete child hiearchy in child to parent order
      * @example
+     * This example demonstrates how to delete game objects
      * ```ts
-     * // This example demonstrates how to delete game objects:
      * // Delete the script's own game object.
      * go.delete();
      * // Delete a game object with the id "my_game_object".
@@ -302,17 +309,18 @@ declare global {
      * // Delete a list of game objects.
      * const ids = [hash("/my_object_1"), hash("/my_object_2"), hash("/my_object_3")];
      * go.delete(ids);
-     *
-     * // This example demonstrates how to delete game objects and their children
-     * // (child-to-parent order):
+     * ```
+     * @example
+     * This example demonstrates how to delete a game objects and their children (child to parent order)
+     * ```ts
      * // Delete the script's own game object and its children.
      * go.delete(true);
      * // Delete a game object with the id "my_game_object" and its children.
-     * const id2 = go.get_id("my_game_object");
-     * go.delete(id2, true);
+     * const id = go.get_id("my_game_object");
+     * go.delete(id, true);
      * // Delete a list of game objects and their children.
-     * const ids2 = [hash("/my_object_1"), hash("/my_object_2"), hash("/my_object_3")];
-     * go.delete(ids2, true);
+     * const ids = [hash("/my_object_1"), hash("/my_object_2"), hash("/my_object_3")];
+     * go.delete(ids, true);
      * ```
      */
     function _delete(id?: SceneGameObjectAddress | Hash | Url | (SceneGameObjectAddress | Hash | Url)[], recursive?: boolean): void;
@@ -323,11 +331,13 @@ declare global {
      * @param url - url of the game object to check
      * @returns true if the game object exists
      * @example
+     * Check if game object "my_game_object" exists in the current collection
      * ```ts
-     * // Check if game object "my_game_object" exists in the current collection:
      * go.exists("/my_game_object");
-     *
-     * // Check if game object exists in another collection:
+     * ```
+     * @example
+     * Check if game object exists in another collection
+     * ```ts
      * go.exists("other_collection:/my_game_object");
      * ```
      */
@@ -390,12 +400,14 @@ declare global {
      * @param id - optional id of the game object instance to get parent for, defaults to the instance containing the calling script
      * @returns parent instance or `nil`
      * @example
+     * Get parent of the instance containing the calling script:
      * ```ts
-     * // Get parent of the instance containing the calling script:
      * const parent_id = go.get_parent();
-     *
-     * // Get parent of the instance with id "x":
-     * const parent_id2 = go.get_parent("x");
+     * ```
+     * @example
+     * Get parent of the instance with id "x":
+     * ```ts
+     * const parent_id = go.get_parent("x");
      * ```
      */
     export function get_parent(id?: SceneGameObjectAddress | Hash | Url): Hash | undefined;
@@ -405,11 +417,13 @@ declare global {
      * @param id - optional id of the game object instance to get the position for, by default the instance of the calling script
      * @returns instance position
      * @example
+     * Get the position of the game object instance the script is attached to:
      * ```ts
-     * // Get the position of the game object the script is attached to:
      * const p = go.get_position();
-     *
-     * // Get the position of another game object "my_gameobject":
+     * ```
+     * @example
+     * Get the position of another game object instance "my_gameobject":
+     * ```ts
      * const pos = go.get_position("my_gameobject");
      * ```
      */
@@ -420,12 +434,14 @@ declare global {
      * @param id - optional id of the game object instance to get the rotation for, by default the instance of the calling script
      * @returns instance rotation
      * @example
+     * Get the rotation of the game object instance the script is attached to:
      * ```ts
-     * // Get the rotation of the game object the script is attached to:
      * const r = go.get_rotation();
-     *
-     * // Get the rotation of another game object with id "x":
-     * const r2 = go.get_rotation("x");
+     * ```
+     * @example
+     * Get the rotation of another game object instance with id "x":
+     * ```ts
+     * const r = go.get_rotation("x");
      * ```
      */
     export function get_rotation(id?: SceneGameObjectAddress | Hash | Url): Quaternion;
@@ -435,12 +451,14 @@ declare global {
      * @param id - optional id of the game object instance to get the scale for, by default the instance of the calling script
      * @returns instance scale factor
      * @example
+     * Get the scale of the game object instance the script is attached to:
      * ```ts
-     * // Get the scale of the game object the script is attached to:
      * const s = go.get_scale();
-     *
-     * // Get the scale of another game object with id "x":
-     * const s2 = go.get_scale("x");
+     * ```
+     * @example
+     * Get the scale of another game object instance with id "x":
+     * ```ts
+     * const s = go.get_scale("x");
      * ```
      */
     export function get_scale(id?: SceneGameObjectAddress | Hash | Url): Vector3;
@@ -450,12 +468,14 @@ declare global {
      * @param id - optional id of the game object instance to get the uniform scale for, by default the instance of the calling script
      * @returns uniform instance scale factor
      * @example
+     * Get the scale of the game object instance the script is attached to:
      * ```ts
-     * // Get the uniform scale of the game object the script is attached to:
      * const s = go.get_scale_uniform();
-     *
-     * // Get the uniform scale of another game object with id "x":
-     * const s2 = go.get_scale_uniform("x");
+     * ```
+     * @example
+     * Get the uniform scale of another game object instance with id "x":
+     * ```ts
+     * const s = go.get_scale_uniform("x");
      * ```
      */
     export function get_scale_uniform(id?: SceneGameObjectAddress | Hash | Url): number;
@@ -467,12 +487,15 @@ declare global {
      * @param id - optional id of the game object instance to get the world position for, by default the instance of the calling script
      * @returns instance world position
      * @example
+     * Get the world position of the game object instance the script is attached to:
      * ```ts
-     * // Get the world position of the game object the script is attached to:
      * const p = go.get_world_position();
-     *
-     * // Reach a sibling game object by its id — relative addressing, no socket prefix:
-     * const p2 = go.get_world_position("x");
+     * ```
+     * @example
+     * Get the world position of another game object instance with id "x":
+     * ```ts
+     * // Relative addressing by id — no socket prefix:
+     * const p = go.get_world_position("x");
      * ```
      */
     export function get_world_position(id?: SceneGameObjectAddress | Hash | Url): Vector3;
@@ -484,12 +507,14 @@ declare global {
      * @param id - optional id of the game object instance to get the world rotation for, by default the instance of the calling script
      * @returns instance world rotation
      * @example
+     * Get the world rotation of the game object instance the script is attached to:
      * ```ts
-     * // Get the world rotation of the game object the script is attached to:
      * const r = go.get_world_rotation();
-     *
-     * // Get the world rotation of another game object with id "x":
-     * const r2 = go.get_world_rotation("x");
+     * ```
+     * @example
+     * Get the world rotation of another game object instance with id "x":
+     * ```ts
+     * const r = go.get_world_rotation("x");
      * ```
      */
     export function get_world_rotation(id?: SceneGameObjectAddress | Hash | Url): Quaternion;
@@ -503,12 +528,14 @@ declare global {
      * @param id - optional id of the game object instance to get the world scale for, by default the instance of the calling script
      * @returns instance world 3D scale factor
      * @example
+     * Get the world 3D scale of the game object instance the script is attached to:
      * ```ts
-     * // Get the world 3D scale of the game object the script is attached to:
      * const s = go.get_world_scale();
-     *
-     * // Get the world scale of another game object "x":
-     * const s2 = go.get_world_scale("x");
+     * ```
+     * @example
+     * Get the world scale of another game object instance "x":
+     * ```ts
+     * const s = go.get_world_scale("x");
      * ```
      */
     export function get_world_scale(id?: SceneGameObjectAddress | Hash | Url): Vector3;
@@ -520,12 +547,14 @@ declare global {
      * @param id - optional id of the game object instance to get the world scale for, by default the instance of the calling script
      * @returns instance world scale factor
      * @example
+     * Get the world scale of the game object instance the script is attached to:
      * ```ts
-     * // Get the world uniform scale of the game object the script is attached to:
      * const s = go.get_world_scale_uniform();
-     *
-     * // Get the world uniform scale of another game object with id "x":
-     * const s2 = go.get_world_scale_uniform("x");
+     * ```
+     * @example
+     * Get the world scale of another game object instance with id "x":
+     * ```ts
+     * const s = go.get_world_scale_uniform("x");
      * ```
      */
     export function get_world_scale_uniform(id?: SceneGameObjectAddress | Hash | Url): number;
@@ -536,12 +565,14 @@ declare global {
      * @param id - optional id of the game object instance to get the world transform for, by default the instance of the calling script
      * @returns instance world transform
      * @example
+     * Get the world transform of the game object instance the script is attached to:
      * ```ts
-     * // Get the world transform of the game object the script is attached to:
      * const m = go.get_world_transform();
-     *
-     * // Get the world transform of another game object with id "x":
-     * const m2 = go.get_world_transform("x");
+     * ```
+     * @example
+     * Get the world transform of another game object instance with id "x":
+     * ```ts
+     * const m = go.get_world_transform("x");
      * ```
      */
     export function get_world_transform(id?: SceneGameObjectAddress | Hash | Url): Matrix4;
@@ -754,6 +785,9 @@ declare global {
      * @param message - a table containing the message data
      * @param sender - address of the sender
      * @example
+     * This example demonstrates how a game object instance, called "a", can communicate with another instance, called "b". It
+     * is assumed that both script components of the instances has id "script".
+     * Script of instance "a":
      * ```ts
      * // This example demonstrates how a game object instance, called "a", can communicate with another instance, called "b". It
      * // is assumed that both script components of the instances has id "script".
@@ -765,7 +799,10 @@ declare global {
      *     msg.post("b#script", "my_data", { important_value: 1 });
      *   },
      * });
-     *
+     * ```
+     * @example
+     * Script of instance "b":
+     * ```ts
      * // b.script — Script of instance "b":
      * export default defineScript({
      *   init() {
@@ -843,14 +880,18 @@ declare global {
      * @param parent_id - optional id of the new parent game object, defaults to detaching game object from its parent
      * @param keep_world_transform - optional boolean, set to true to maintain the world transform when changing spaces. Defaults to false.
      * @example
+     * Attach myself to another instance "my_parent":
      * ```ts
-     * // Attach myself to another instance "my_parent":
      * go.set_parent(go.get_id(), go.get_id("my_parent"));
-     *
-     * // Attach an instance "my_instance" to another instance "my_parent":
+     * ```
+     * @example
+     * Attach an instance "my_instance" to another instance "my_parent":
+     * ```ts
      * go.set_parent(go.get_id("my_instance"), go.get_id("my_parent"));
-     *
-     * // Detach an instance "my_instance" from its parent (if any):
+     * ```
+     * @example
+     * Detach an instance "my_instance" from its parent (if any):
+     * ```ts
      * go.set_parent(go.get_id("my_instance"));
      * ```
      */
@@ -861,14 +902,19 @@ declare global {
      * @param position - position to set
      * @param id - optional id of the game object instance to set the position for, by default the instance of the calling script
      * @example
+     * Set the position of the game object instance the script is attached to:
      * ```ts
      * // `p` is the desired position (a Vector3).
      * const p = vmath.vector3();
-     *
-     * // Set the position of the game object the script is attached to:
      * go.set_position(p);
+     * ```
+     * @example
+     * Set the position of another game object instance with id "x":
+     * ```ts
+     * // `p` is the desired position (a Vector3).
+     * const p = vmath.vector3();
      *
-     * // Reach a sibling game object by its id — relative addressing, no socket prefix:
+     * // Relative addressing by id — no socket prefix:
      * go.set_position(p, "x");
      * ```
      */
@@ -879,14 +925,17 @@ declare global {
      * @param rotation - rotation to set
      * @param id - optional id of the game object instance to get the rotation for, by default the instance of the calling script
      * @example
+     * Set the rotation of the game object instance the script is attached to:
      * ```ts
      * // `r` is the desired rotation (a Quaternion).
      * const r = vmath.quat();
-     *
-     * // Set the rotation of the game object the script is attached to:
      * go.set_rotation(r);
-     *
-     * // Set the rotation of another game object with id "x":
+     * ```
+     * @example
+     * Set the rotation of another game object instance with id "x":
+     * ```ts
+     * // `r` is the desired rotation (a Quaternion).
+     * const r = vmath.quat();
      * go.set_rotation(r, "x");
      * ```
      */
@@ -898,14 +947,16 @@ declare global {
      * @param scale - vector or uniform scale factor, must be greater than 0
      * @param id - optional id of the game object instance to get the scale for, by default the instance of the calling script
      * @example
+     * Set the scale of the game object instance the script is attached to:
      * ```ts
-     * // Set the scale of the game object the script is attached to:
      * const s = vmath.vector3(2.0, 1.0, 1.0);
      * go.set_scale(s);
-     *
-     * // Set the scale of another game object with id "obj_id":
-     * const s2 = 1.2;
-     * go.set_scale(s2, "obj_id");
+     * ```
+     * @example
+     * Set the scale of another game object instance with id "obj_id":
+     * ```ts
+     * const s = 1.2;
+     * go.set_scale(s, "obj_id");
      * ```
      */
     export function set_scale(scale: number | Vector3, id?: SceneGameObjectAddress | Hash | Url): void;
@@ -916,14 +967,16 @@ declare global {
      * @param scale - vector or uniform scale factor, must be greater than 0
      * @param id - optional id of the game object instance to get the scale for, by default the instance of the calling script
      * @example
+     * Set the scale of the game object instance the script is attached to:
      * ```ts
-     * // Set the scale of the game object the script is attached to:
      * const s = vmath.vector3(2.0, 1.0, 5.0);
      * go.set_scale_xy(s); // z will not be set here, only x and y
-     *
-     * // Set the scale of another game object with id "obj_id":
-     * const s2 = 1.2;
-     * go.set_scale_xy(s2, "obj_id"); // z will not be set here, only x and y
+     * ```
+     * @example
+     * Set the scale of another game object instance with id "obj_id":
+     * ```ts
+     * const s = 1.2;
+     * go.set_scale_xy(s, "obj_id"); // z will not be set here, only x and y
      * ```
      */
     export function set_scale_xy(scale: number | Vector3, id?: SceneGameObjectAddress | Hash | Url): void;
@@ -961,11 +1014,13 @@ declare global {
      *
      * @param id - optional id of the game object instance to update
      * @example
+     * Update this game object's world transform:
      * ```ts
-     * // Update this game object's world transform:
      * go.update_world_transform();
-     *
-     * // Update another game object's world transform:
+     * ```
+     * @example
+     * Update another game object's world transform:
+     * ```ts
      * go.update_world_transform("/other");
      * ```
      */

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

@@ -4,6 +4,8 @@ declare global {
    * Graphics functions and constants.
    */
   namespace graphics {
+    type BufferType = typeof graphics.BUFFER_TYPE_COLOR0_BIT | typeof graphics.BUFFER_TYPE_COLOR1_BIT | typeof graphics.BUFFER_TYPE_COLOR2_BIT | typeof graphics.BUFFER_TYPE_COLOR3_BIT | typeof graphics.BUFFER_TYPE_DEPTH_BIT | typeof graphics.BUFFER_TYPE_STENCIL_BIT;
+    type State = typeof graphics.STATE_DEPTH_TEST | typeof graphics.STATE_STENCIL_TEST | typeof graphics.STATE_BLEND | typeof graphics.STATE_ALPHA_TEST | typeof graphics.STATE_CULL_FACE | typeof graphics.STATE_POLYGON_OFFSET_FILL;
     const BLEND_FACTOR_CONSTANT_ALPHA: number & { readonly __brand: "graphics.BLEND_FACTOR_CONSTANT_ALPHA" };
     const BLEND_FACTOR_CONSTANT_COLOR: number & { readonly __brand: "graphics.BLEND_FACTOR_CONSTANT_COLOR" };
     const BLEND_FACTOR_DST_ALPHA: number & { readonly __brand: "graphics.BLEND_FACTOR_DST_ALPHA" };