@defold-typescript/types 0.37.0 → 0.39.0

package/generated/gui.d.ts

@@ -6,6 +6,20 @@ declare global {
    * GUI API documentation
    */
   namespace gui {
+    type AdjustMode = typeof gui.ADJUST_FIT | typeof gui.ADJUST_ZOOM | typeof gui.ADJUST_STRETCH;
+    type BlendMode = typeof gui.BLEND_ALPHA | typeof gui.BLEND_ADD | typeof gui.BLEND_ADD_ALPHA | typeof gui.BLEND_MULT | typeof gui.BLEND_SCREEN;
+    type ClippingMode = typeof gui.CLIPPING_MODE_NONE | typeof gui.CLIPPING_MODE_STENCIL;
+    type Easing = typeof gui.EASING_INBACK | typeof gui.EASING_INBOUNCE | typeof gui.EASING_INCIRC | typeof gui.EASING_INCUBIC | typeof gui.EASING_INELASTIC | typeof gui.EASING_INEXPO | typeof gui.EASING_INOUTBACK | typeof gui.EASING_INOUTBOUNCE | typeof gui.EASING_INOUTCIRC | typeof gui.EASING_INOUTCUBIC | typeof gui.EASING_INOUTELASTIC | typeof gui.EASING_INOUTEXPO | typeof gui.EASING_INOUTQUAD | typeof gui.EASING_INOUTQUART | typeof gui.EASING_INOUTQUINT | typeof gui.EASING_INOUTSINE | typeof gui.EASING_INQUAD | typeof gui.EASING_INQUART | typeof gui.EASING_INQUINT | typeof gui.EASING_INSINE | typeof gui.EASING_LINEAR | typeof gui.EASING_OUTBACK | typeof gui.EASING_OUTBOUNCE | typeof gui.EASING_OUTCIRC | typeof gui.EASING_OUTCUBIC | typeof gui.EASING_OUTELASTIC | typeof gui.EASING_OUTEXPO | typeof gui.EASING_OUTINBACK | typeof gui.EASING_OUTINBOUNCE | typeof gui.EASING_OUTINCIRC | typeof gui.EASING_OUTINCUBIC | typeof gui.EASING_OUTINELASTIC | typeof gui.EASING_OUTINEXPO | typeof gui.EASING_OUTINQUAD | typeof gui.EASING_OUTINQUART | typeof gui.EASING_OUTINQUINT | typeof gui.EASING_OUTINSINE | typeof gui.EASING_OUTQUAD | typeof gui.EASING_OUTQUART | typeof gui.EASING_OUTQUINT | typeof gui.EASING_OUTSINE;
+    type KeyboardType = typeof gui.KEYBOARD_TYPE_DEFAULT | typeof gui.KEYBOARD_TYPE_EMAIL | typeof gui.KEYBOARD_TYPE_NUMBER_PAD | typeof gui.KEYBOARD_TYPE_PASSWORD;
+    type NodeType = typeof gui.TYPE_BOX | typeof gui.TYPE_TEXT | typeof gui.TYPE_PIE | typeof gui.TYPE_PARTICLEFX | typeof gui.TYPE_CUSTOM;
+    type PieBounds = typeof gui.PIEBOUNDS_RECTANGLE | typeof gui.PIEBOUNDS_ELLIPSE;
+    type Pivot = typeof gui.PIVOT_CENTER | typeof gui.PIVOT_N | typeof gui.PIVOT_NE | typeof gui.PIVOT_E | typeof gui.PIVOT_SE | typeof gui.PIVOT_S | typeof gui.PIVOT_SW | typeof gui.PIVOT_W | typeof gui.PIVOT_NW;
+    type Playback = typeof gui.PLAYBACK_ONCE_FORWARD | typeof gui.PLAYBACK_ONCE_BACKWARD | typeof gui.PLAYBACK_ONCE_PINGPONG | typeof gui.PLAYBACK_LOOP_FORWARD | typeof gui.PLAYBACK_LOOP_BACKWARD | typeof gui.PLAYBACK_LOOP_PINGPONG;
+    type Property = typeof gui.PROP_POSITION | typeof gui.PROP_ROTATION | typeof gui.PROP_EULER | typeof gui.PROP_SCALE | typeof gui.PROP_COLOR | typeof gui.PROP_OUTLINE | typeof gui.PROP_SHADOW | typeof gui.PROP_SIZE | typeof gui.PROP_FILL_ANGLE | typeof gui.PROP_INNER_RADIUS | typeof gui.PROP_LEADING | typeof gui.PROP_TRACKING | typeof gui.PROP_SLICE9;
+    type SafeAreaMode = typeof gui.SAFE_AREA_NONE | typeof gui.SAFE_AREA_LONG | typeof gui.SAFE_AREA_SHORT | typeof gui.SAFE_AREA_BOTH;
+    type SizeMode = typeof gui.SIZE_MODE_MANUAL | typeof gui.SIZE_MODE_AUTO;
+    type XAnchor = typeof gui.ANCHOR_NONE | typeof gui.ANCHOR_LEFT | typeof gui.ANCHOR_RIGHT;
+    type YAnchor = typeof gui.ANCHOR_NONE | typeof gui.ANCHOR_TOP | typeof gui.ANCHOR_BOTTOM;
     /**
      * Adjust mode is used when the screen resolution differs from the project settings.
      * The fit mode ensures that the entire node is visible in the adjusted gui scene.
@@ -522,19 +536,24 @@ declare global {
      *
      * - `gui.PLAYBACK_LOOP_PINGPONG`
      * @example
+     * How to start a simple color animation, where the node fades in to white during 0.5 seconds:
      * ```ts
      * // How to start a simple color animation, where the node fades in to white during 0.5 seconds:
+     * const node = gui.get_node("my_node");
      * gui.set_color(node, vmath.vector4(0, 0, 0, 0)); // node is fully transparent
      * gui.animate(node, gui.PROP_COLOR, vmath.vector4(1, 1, 1, 1), gui.EASING_INOUTQUAD, 0.5); // start animation
-     *
+     * ```
+     * @example
+     * How to start a sequenced animation where the node fades in to white during 0.5 seconds, stays visible for 2 seconds and then fades out:
+     * ```ts
      * // How to start a sequenced animation where the node fades in to white during 0.5
      * // seconds, stays visible for 2 seconds and then fades out:
-     * function on_animation_done(self, node) {
+     * function on_animation_done(self: unknown, node: unknown) {
      *   // fade out node, but wait 2 seconds before the animation starts
-     *   gui.animate(node, gui.PROP_COLOR, vmath.vector4(0, 0, 0, 0), gui.EASING_OUTQUAD, 0.5, 2.0);
+     *   gui.animate(node as Opaque<"node">, gui.PROP_COLOR, vmath.vector4(0, 0, 0, 0), gui.EASING_OUTQUAD, 0.5, 2.0);
      * }
      *
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init(self) {
      *     // fetch the node we want to animate
      *     const my_node = gui.get_node("my_node");
@@ -544,9 +563,12 @@ declare global {
      *     gui.animate(my_node, gui.PROP_COLOR, vmath.vector4(1, 1, 1, 1), gui.EASING_INOUTQUAD, 0.5, 0.0, on_animation_done);
      *   },
      * });
-     *
+     * ```
+     * @example
+     * How to animate a node's y position using a crazy custom easing curve:
+     * ```ts
      * // How to animate a node's y position using a crazy custom easing curve:
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init(self) {
      *     const values = [
      *       0, 0, 0, 0, 0, 0, 0, 0, 1, 1, 1, 1, 1, 1, 1, 1,
@@ -561,7 +583,7 @@ declare global {
      * });
      * ```
      */
-    function animate(node: Opaque<"node">, property: string | number & { readonly __brand: "gui.PROP_POSITION" } | number & { readonly __brand: "gui.PROP_ROTATION" } | number & { readonly __brand: "gui.PROP_EULER" } | number & { readonly __brand: "gui.PROP_SCALE" } | number & { readonly __brand: "gui.PROP_COLOR" } | number & { readonly __brand: "gui.PROP_OUTLINE" } | number & { readonly __brand: "gui.PROP_SHADOW" } | number & { readonly __brand: "gui.PROP_SIZE" } | number & { readonly __brand: "gui.PROP_FILL_ANGLE" } | number & { readonly __brand: "gui.PROP_INNER_RADIUS" } | number & { readonly __brand: "gui.PROP_LEADING" } | number & { readonly __brand: "gui.PROP_TRACKING" } | number & { readonly __brand: "gui.PROP_SLICE9" }, to: number | Vector3 | Vector4 | Quaternion, easing: number & { readonly __brand: "gui.EASING_INBACK" } | number & { readonly __brand: "gui.EASING_INBOUNCE" } | number & { readonly __brand: "gui.EASING_INCIRC" } | number & { readonly __brand: "gui.EASING_INCUBIC" } | number & { readonly __brand: "gui.EASING_INELASTIC" } | number & { readonly __brand: "gui.EASING_INEXPO" } | number & { readonly __brand: "gui.EASING_INOUTBACK" } | number & { readonly __brand: "gui.EASING_INOUTBOUNCE" } | number & { readonly __brand: "gui.EASING_INOUTCIRC" } | number & { readonly __brand: "gui.EASING_INOUTCUBIC" } | number & { readonly __brand: "gui.EASING_INOUTELASTIC" } | number & { readonly __brand: "gui.EASING_INOUTEXPO" } | number & { readonly __brand: "gui.EASING_INOUTQUAD" } | number & { readonly __brand: "gui.EASING_INOUTQUART" } | number & { readonly __brand: "gui.EASING_INOUTQUINT" } | number & { readonly __brand: "gui.EASING_INOUTSINE" } | number & { readonly __brand: "gui.EASING_INQUAD" } | number & { readonly __brand: "gui.EASING_INQUART" } | number & { readonly __brand: "gui.EASING_INQUINT" } | number & { readonly __brand: "gui.EASING_INSINE" } | number & { readonly __brand: "gui.EASING_LINEAR" } | number & { readonly __brand: "gui.EASING_OUTBACK" } | number & { readonly __brand: "gui.EASING_OUTBOUNCE" } | number & { readonly __brand: "gui.EASING_OUTCIRC" } | number & { readonly __brand: "gui.EASING_OUTCUBIC" } | number & { readonly __brand: "gui.EASING_OUTELASTIC" } | number & { readonly __brand: "gui.EASING_OUTEXPO" } | number & { readonly __brand: "gui.EASING_OUTINBACK" } | number & { readonly __brand: "gui.EASING_OUTINBOUNCE" } | number & { readonly __brand: "gui.EASING_OUTINCIRC" } | number & { readonly __brand: "gui.EASING_OUTINCUBIC" } | number & { readonly __brand: "gui.EASING_OUTINELASTIC" } | number & { readonly __brand: "gui.EASING_OUTINEXPO" } | number & { readonly __brand: "gui.EASING_OUTINQUAD" } | number & { readonly __brand: "gui.EASING_OUTINQUART" } | number & { readonly __brand: "gui.EASING_OUTINQUINT" } | number & { readonly __brand: "gui.EASING_OUTINSINE" } | number & { readonly __brand: "gui.EASING_OUTQUAD" } | number & { readonly __brand: "gui.EASING_OUTQUART" } | number & { readonly __brand: "gui.EASING_OUTQUINT" } | number & { readonly __brand: "gui.EASING_OUTSINE" } | Vector, duration: number, delay?: number, complete_function?: (self: unknown, node: unknown) => void, playback?: number & { readonly __brand: "gui.PLAYBACK_ONCE_FORWARD" } | number & { readonly __brand: "gui.PLAYBACK_ONCE_BACKWARD" } | number & { readonly __brand: "gui.PLAYBACK_ONCE_PINGPONG" } | number & { readonly __brand: "gui.PLAYBACK_LOOP_FORWARD" } | number & { readonly __brand: "gui.PLAYBACK_LOOP_BACKWARD" } | number & { readonly __brand: "gui.PLAYBACK_LOOP_PINGPONG" }): void;
+    function animate(node: Opaque<"node">, property: string | gui.Property, to: number | Vector3 | Vector4 | Quaternion, easing: gui.Easing | Vector, duration: number, delay?: number, complete_function?: (self: unknown, node: unknown) => void, playback?: gui.Playback): void;
     /**
      * If one or more animations of the specified node is currently running (started by `gui.animate`), they will immediately be canceled.
      *
@@ -614,7 +636,7 @@ declare global {
      * gui.cancel_animations(node);
      * ```
      */
-    function cancel_animations(node: Opaque<"node">, property?: string | number & { readonly __brand: "gui.PROP_POSITION" } | number & { readonly __brand: "gui.PROP_ROTATION" } | number & { readonly __brand: "gui.PROP_EULER" } | number & { readonly __brand: "gui.PROP_SCALE" } | number & { readonly __brand: "gui.PROP_COLOR" } | number & { readonly __brand: "gui.PROP_OUTLINE" } | number & { readonly __brand: "gui.PROP_SHADOW" } | number & { readonly __brand: "gui.PROP_SIZE" } | number & { readonly __brand: "gui.PROP_FILL_ANGLE" } | number & { readonly __brand: "gui.PROP_INNER_RADIUS" } | number & { readonly __brand: "gui.PROP_LEADING" } | number & { readonly __brand: "gui.PROP_TRACKING" } | number & { readonly __brand: "gui.PROP_SLICE9" }): void;
+    function cancel_animations(node: Opaque<"node">, property?: string | gui.Property): void;
     /**
      * Cancels any running flipbook animation on the specified node.
      *
@@ -664,7 +686,7 @@ declare global {
      * @param texture - texture id
      * @example
      * ```ts
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init(self) {
      *     // Create a texture.
      *     if (gui.new_texture("temp_tx", 10, 10, "rgb", "\0".repeat(10 * 10 * 3))) {
@@ -744,7 +766,7 @@ declare global {
      * const node_position = gui.get(node, "position");
      * ```
      */
-    function get(node: Opaque<"node">, property: string | Hash | number & { readonly __brand: "gui.PROP_POSITION" } | number & { readonly __brand: "gui.PROP_ROTATION" } | number & { readonly __brand: "gui.PROP_EULER" } | number & { readonly __brand: "gui.PROP_SCALE" } | number & { readonly __brand: "gui.PROP_COLOR" } | number & { readonly __brand: "gui.PROP_OUTLINE" } | number & { readonly __brand: "gui.PROP_SHADOW" } | number & { readonly __brand: "gui.PROP_SIZE" } | number & { readonly __brand: "gui.PROP_FILL_ANGLE" } | number & { readonly __brand: "gui.PROP_INNER_RADIUS" } | number & { readonly __brand: "gui.PROP_LEADING" } | number & { readonly __brand: "gui.PROP_TRACKING" } | number & { readonly __brand: "gui.PROP_SLICE9" }, options?: { index?: number }): unknown;
+    function get(node: Opaque<"node">, property: string | Hash | gui.Property, options?: { index?: number }): unknown;
     /**
      * Returns the adjust mode of a node.
      * The adjust mode defines how the node will adjust itself to screen
@@ -759,7 +781,7 @@ declare global {
      *
      * - `gui.ADJUST_STRETCH`
      */
-    function get_adjust_mode(node: Opaque<"node">): number & { readonly __brand: "gui.ADJUST_FIT" } | number & { readonly __brand: "gui.ADJUST_ZOOM" } | number & { readonly __brand: "gui.ADJUST_STRETCH" };
+    function get_adjust_mode(node: Opaque<"node">): gui.AdjustMode;
     /**
      * gets the node alpha
      *
@@ -784,7 +806,7 @@ declare global {
      *
      * - `gui.BLEND_SCREEN`
      */
-    function get_blend_mode(node: Opaque<"node">): number & { readonly __brand: "gui.BLEND_ALPHA" } | number & { readonly __brand: "gui.BLEND_ADD" } | number & { readonly __brand: "gui.BLEND_ADD_ALPHA" } | number & { readonly __brand: "gui.BLEND_MULT" } | number & { readonly __brand: "gui.BLEND_SCREEN" };
+    function get_blend_mode(node: Opaque<"node">): gui.BlendMode;
     /**
      * If node is set as an inverted clipping node, it will clip anything inside as opposed to outside.
      *
@@ -802,7 +824,7 @@ declare global {
      *
      * - `gui.CLIPPING_MODE_STENCIL`
      */
-    function get_clipping_mode(node: Opaque<"node">): number & { readonly __brand: "gui.CLIPPING_MODE_NONE" } | number & { readonly __brand: "gui.CLIPPING_MODE_STENCIL" };
+    function get_clipping_mode(node: Opaque<"node">): gui.ClippingMode;
     /**
      * If node is set as visible clipping node, it will be shown as well as clipping. Otherwise, it will only clip but not show visually.
      *
@@ -884,7 +906,7 @@ declare global {
      * @example
      * ```ts
      * // Get the text metrics for a text
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init(self) {
      *     const node = gui.get_node("name");
      *     const font_name = gui.get_font(node);
@@ -1028,7 +1050,7 @@ declare global {
      *
      * - `gui.PIEBOUNDS_ELLIPSE`
      */
-    function get_outer_bounds(node: Opaque<"node">): number & { readonly __brand: "gui.PIEBOUNDS_RECTANGLE" } | number & { readonly __brand: "gui.PIEBOUNDS_ELLIPSE" };
+    function get_outer_bounds(node: Opaque<"node">): gui.PieBounds;
     /**
      * Returns the outline color of the supplied node.
      * See gui.get_color for info how vectors encode color values.
@@ -1084,7 +1106,7 @@ declare global {
      *
      * - `gui.PIVOT_NW`
      */
-    function get_pivot(node: Opaque<"node">): number & { readonly __brand: "gui.PIVOT_CENTER" } | number & { readonly __brand: "gui.PIVOT_N" } | number & { readonly __brand: "gui.PIVOT_NE" } | number & { readonly __brand: "gui.PIVOT_E" } | number & { readonly __brand: "gui.PIVOT_SE" } | number & { readonly __brand: "gui.PIVOT_S" } | number & { readonly __brand: "gui.PIVOT_SW" } | number & { readonly __brand: "gui.PIVOT_W" } | number & { readonly __brand: "gui.PIVOT_NW" };
+    function get_pivot(node: Opaque<"node">): gui.Pivot;
     /**
      * Returns the position of the supplied node.
      *
@@ -1146,7 +1168,7 @@ declare global {
      *
      * - `gui.SIZE_MODE_AUTO`
      */
-    function get_size_mode(node: Opaque<"node">): number & { readonly __brand: "gui.SIZE_MODE_MANUAL" } | number & { readonly __brand: "gui.SIZE_MODE_AUTO" };
+    function get_size_mode(node: Opaque<"node">): gui.SizeMode;
     /**
      * Returns the slice9 configuration values for the node.
      *
@@ -1189,7 +1211,7 @@ declare global {
      *
      * @param node - node from which to get the type
      */
-    function get_type(node: Opaque<"node">): LuaMultiReturn<[number & { readonly __brand: "gui.TYPE_BOX" } | number & { readonly __brand: "gui.TYPE_TEXT" } | number & { readonly __brand: "gui.TYPE_PIE" } | number & { readonly __brand: "gui.TYPE_PARTICLEFX" } | number & { readonly __brand: "gui.TYPE_CUSTOM" }, number | undefined]>;
+    function get_type(node: Opaque<"node">): LuaMultiReturn<[gui.NodeType, number | undefined]>;
     /**
      * Returns `true` if a node is visible and `false` if it's not.
      * Invisible nodes are not rendered.
@@ -1216,7 +1238,7 @@ declare global {
      *
      * - `gui.ANCHOR_RIGHT`
      */
-    function get_xanchor(node: Opaque<"node">): number & { readonly __brand: "gui.ANCHOR_NONE" } | number & { readonly __brand: "gui.ANCHOR_LEFT" } | number & { readonly __brand: "gui.ANCHOR_RIGHT" };
+    function get_xanchor(node: Opaque<"node">): gui.XAnchor;
     /**
      * The y-anchor specifies how the node is moved when the game is run in a different resolution.
      *
@@ -1229,7 +1251,7 @@ declare global {
      *
      * - `gui.ANCHOR_BOTTOM`
      */
-    function get_yanchor(node: Opaque<"node">): number & { readonly __brand: "gui.ANCHOR_NONE" } | number & { readonly __brand: "gui.ANCHOR_TOP" } | number & { readonly __brand: "gui.ANCHOR_BOTTOM" };
+    function get_yanchor(node: Opaque<"node">): gui.YAnchor;
     /**
      * Hides the on-display touch keyboard on the device.
      */
@@ -1329,7 +1351,7 @@ declare global {
      * @example
      * ```ts
      * // How to create a texture and apply it to a new box node:
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init(self) {
      *     const w = 200;
      *     const h = 300;
@@ -1355,6 +1377,8 @@ declare global {
      * });
      *
      * // How to create a texture using .astc format
+     * const size = 4;
+     * const pos = vmath.vector3(200, 200, 0);
      * const path = "/assets/images/logo_4x4.astc";
      * const buffer = sys.load_resource(path);
      * const n = gui.new_box_node(pos, vmath.vector3(size, size, 0));
@@ -1505,7 +1529,7 @@ declare global {
      * @returns optional boolean to signal if the input should be consumed (not passed on to others) or not, default is false
      * @example
      * ```ts
-     * export default defineScript({
+     * export default defineGuiScript({
      *   on_input(self, action_id, action) {
      *     // check for input
      *     if (action_id === hash("my_action")) {
@@ -1582,11 +1606,11 @@ declare global {
      * @example
      * ```ts
      * // Set the texture of a node to a flipbook animation from an atlas:
-     * function anim_callback(self, node) {
+     * function anim_callback(self: unknown, node: unknown) {
      *   // Take action after animation has played.
      * }
      *
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init(self) {
      *     // Create a new node and set the texture to a flipbook animation
      *     const node = gui.get_node("button_node");
@@ -1630,13 +1654,13 @@ declare global {
      * // How to play a particle fx when a gui node is created.
      * // The callback receives the gui node, the hash of the id
      * // of the emitter, and the new state of the emitter as particlefx.EMITTER_STATE_.
-     * function emitter_state_change(self, node, emitter, state) {
+     * function emitter_state_change(self: unknown, node: unknown, emitter: unknown, state: unknown) {
      *   if (emitter === hash("exhaust") && state === particlefx.EMITTER_STATE_POSTSPAWN) {
      *     // exhaust is done spawning particles...
      *   }
      * }
      *
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init(self) {
      *     gui.play_particlefx(gui.get_node("particlefx"), emitter_state_change);
      *   },
@@ -1676,7 +1700,7 @@ declare global {
      * @example
      * ```ts
      * // Animate a node to the pressed pointer position:
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init() {
      *     msg.post(".", "acquire_input_focus");
      *     return { marker: gui.get_node("marker") };
@@ -1775,7 +1799,7 @@ declare global {
      * gui.set(node, "tint_array.x", 1, { index: 4 });
      *
      * // Set a named property
-     * export default defineScript({
+     * export default defineGuiScript({
      *   on_message(self, message_id, message) {
      *     if (message_id === hash("set_font")) {
      *       gui.set(msg.url(), "fonts", message.font, { key: "my_font_name" });
@@ -1789,6 +1813,7 @@ declare global {
      * });
      *
      * // Remove a named runtime texture resource mapping:
+     * const atlas_params = { texture: "/runtime.texturec", animations: [], geometries: [] };
      * const atlas_id = resource.create_atlas("/runtime.texturesetc", atlas_params);
      * gui.set(msg.url(), "textures", atlas_id, { key: "runtime_texture" });
      * gui.set_texture(gui.get_node("box"), "runtime_texture");
@@ -1798,7 +1823,7 @@ declare global {
      * resource.release(atlas_id);
      * ```
      */
-    function set(node: Opaque<"node"> | Url, property: string | Hash | number & { readonly __brand: "gui.PROP_POSITION" } | number & { readonly __brand: "gui.PROP_ROTATION" } | number & { readonly __brand: "gui.PROP_EULER" } | number & { readonly __brand: "gui.PROP_SCALE" } | number & { readonly __brand: "gui.PROP_COLOR" } | number & { readonly __brand: "gui.PROP_OUTLINE" } | number & { readonly __brand: "gui.PROP_SHADOW" } | number & { readonly __brand: "gui.PROP_SIZE" } | number & { readonly __brand: "gui.PROP_FILL_ANGLE" } | number & { readonly __brand: "gui.PROP_INNER_RADIUS" } | number & { readonly __brand: "gui.PROP_LEADING" } | number & { readonly __brand: "gui.PROP_TRACKING" } | number & { readonly __brand: "gui.PROP_SLICE9" }, value?: number | Vector4 | Vector3 | Quaternion, options?: { index?: number; key?: Hash }): void;
+    function set(node: Opaque<"node"> | Url, property: string | Hash | gui.Property, value?: number | Vector4 | Vector3 | Quaternion, options?: { index?: number; key?: Hash }): void;
     /**
      * Sets the adjust mode on a node.
      * The adjust mode defines how the node will adjust itself to screen
@@ -1813,7 +1838,7 @@ declare global {
      *
      * - `gui.ADJUST_STRETCH`
      */
-    function set_adjust_mode(node: Opaque<"node">, adjust_mode: number & { readonly __brand: "gui.ADJUST_FIT" } | number & { readonly __brand: "gui.ADJUST_ZOOM" } | number & { readonly __brand: "gui.ADJUST_STRETCH" }): void;
+    function set_adjust_mode(node: Opaque<"node">, adjust_mode: gui.AdjustMode): void;
     /**
      * sets the node alpha
      *
@@ -1838,7 +1863,7 @@ declare global {
      *
      * - `gui.BLEND_SCREEN`
      */
-    function set_blend_mode(node: Opaque<"node">, blend_mode: number & { readonly __brand: "gui.BLEND_ALPHA" } | number & { readonly __brand: "gui.BLEND_ADD" } | number & { readonly __brand: "gui.BLEND_ADD_ALPHA" } | number & { readonly __brand: "gui.BLEND_MULT" } | number & { readonly __brand: "gui.BLEND_SCREEN" }): void;
+    function set_blend_mode(node: Opaque<"node">, blend_mode: gui.BlendMode): void;
     /**
      * If node is set as an inverted clipping node, it will clip anything inside as opposed to outside.
      *
@@ -1856,7 +1881,7 @@ declare global {
      *
      * - `gui.CLIPPING_MODE_STENCIL`
      */
-    function set_clipping_mode(node: Opaque<"node">, clipping_mode: number & { readonly __brand: "gui.CLIPPING_MODE_NONE" } | number & { readonly __brand: "gui.CLIPPING_MODE_STENCIL" }): void;
+    function set_clipping_mode(node: Opaque<"node">, clipping_mode: gui.ClippingMode): void;
     /**
      * If node is set as an visible clipping node, it will be shown as well as clipping. Otherwise, it will only clip but not show visually.
      *
@@ -2024,7 +2049,7 @@ declare global {
      *
      * - `gui.PIEBOUNDS_ELLIPSE`
      */
-    function set_outer_bounds(node: Opaque<"node">, bounds_mode: number & { readonly __brand: "gui.PIEBOUNDS_RECTANGLE" } | number & { readonly __brand: "gui.PIEBOUNDS_ELLIPSE" }): void;
+    function set_outer_bounds(node: Opaque<"node">, bounds_mode: gui.PieBounds): void;
     /**
      * Sets the outline color of the supplied node.
      * See gui.set_color for info how vectors encode color values.
@@ -2079,7 +2104,7 @@ declare global {
      *
      * - `gui.PIVOT_NW`
      */
-    function set_pivot(node: Opaque<"node">, pivot: number & { readonly __brand: "gui.PIVOT_CENTER" } | number & { readonly __brand: "gui.PIVOT_N" } | number & { readonly __brand: "gui.PIVOT_NE" } | number & { readonly __brand: "gui.PIVOT_E" } | number & { readonly __brand: "gui.PIVOT_SE" } | number & { readonly __brand: "gui.PIVOT_S" } | number & { readonly __brand: "gui.PIVOT_SW" } | number & { readonly __brand: "gui.PIVOT_W" } | number & { readonly __brand: "gui.PIVOT_NW" }): void;
+    function set_pivot(node: Opaque<"node">, pivot: gui.Pivot): void;
     /**
      * Sets the position of the supplied node.
      *
@@ -2118,7 +2143,7 @@ declare global {
      *
      * - `gui.SAFE_AREA_BOTH`
      */
-    function set_safe_area_mode(mode: number & { readonly __brand: "gui.SAFE_AREA_NONE" } | number & { readonly __brand: "gui.SAFE_AREA_LONG" } | number & { readonly __brand: "gui.SAFE_AREA_SHORT" } | number & { readonly __brand: "gui.SAFE_AREA_BOTH" }): void;
+    function set_safe_area_mode(mode: gui.SafeAreaMode): void;
     /**
      * Sets the scaling of the supplied node.
      *
@@ -2164,7 +2189,7 @@ declare global {
      *
      * - `gui.SIZE_MODE_AUTO`
      */
-    function set_size_mode(node: Opaque<"node">, size_mode: number & { readonly __brand: "gui.SIZE_MODE_MANUAL" } | number & { readonly __brand: "gui.SIZE_MODE_AUTO" }): void;
+    function set_size_mode(node: Opaque<"node">, size_mode: gui.SizeMode): void;
     /**
      * Set the slice9 configuration values for the node.
      *
@@ -2229,7 +2254,7 @@ declare global {
      * @returns setting the data was successful
      * @example
      * ```ts
-     * export default defineScript({
+     * export default defineGuiScript({
      *   init(self) {
      *     const w = 200;
      *     const h = 300;
@@ -2284,7 +2309,7 @@ declare global {
      *
      * - `gui.ANCHOR_RIGHT`
      */
-    function set_xanchor(node: Opaque<"node">, anchor: number & { readonly __brand: "gui.ANCHOR_NONE" } | number & { readonly __brand: "gui.ANCHOR_LEFT" } | number & { readonly __brand: "gui.ANCHOR_RIGHT" }): void;
+    function set_xanchor(node: Opaque<"node">, anchor: gui.XAnchor): void;
     /**
      * The y-anchor specifies how the node is moved when the game is run in a different resolution.
      *
@@ -2297,7 +2322,7 @@ declare global {
      *
      * - `gui.ANCHOR_BOTTOM`
      */
-    function set_yanchor(node: Opaque<"node">, anchor: number & { readonly __brand: "gui.ANCHOR_NONE" } | number & { readonly __brand: "gui.ANCHOR_TOP" } | number & { readonly __brand: "gui.ANCHOR_BOTTOM" }): void;
+    function set_yanchor(node: Opaque<"node">, anchor: gui.YAnchor): void;
     /**
      * Shows the on-display touch keyboard.
      * The specified type of keyboard is displayed if it is available on
@@ -2315,7 +2340,7 @@ declare global {
      * - `gui.KEYBOARD_TYPE_PASSWORD`
      * @param autoclose - if the keyboard should automatically close when clicking outside
      */
-    function show_keyboard(type: number & { readonly __brand: "gui.KEYBOARD_TYPE_DEFAULT" } | number & { readonly __brand: "gui.KEYBOARD_TYPE_EMAIL" } | number & { readonly __brand: "gui.KEYBOARD_TYPE_NUMBER_PAD" } | number & { readonly __brand: "gui.KEYBOARD_TYPE_PASSWORD" }, autoclose: boolean): void;
+    function show_keyboard(type: gui.KeyboardType, autoclose: boolean): void;
     /**
      * Stops the particle fx for a gui node
      *

package/generated/html5.d.ts

@@ -34,7 +34,7 @@ declare global {
      * object The calling script
      * @example
      * ```ts
-     * function on_interaction(self) {
+     * function on_interaction(self: unknown) {
      *   print("on_interaction called");
      *   html5.set_interaction_listener(undefined);
      * }

package/generated/http.d.ts

@@ -53,6 +53,10 @@ declare global {
      * - boolean `report_progress`: when it is true, the amount of bytes sent and/or received for a request will be passed into the callback function
      * @example
      * ```ts
+     * function update_my_progress_bar(self: unknown, fraction: number) {
+     *   // draw the progress bar at the given fraction
+     * }
+     *
      * // Basic HTTP-GET request. The callback receives a table with the response
      * // in the fields status, the response (the data) and headers (a table).
      * export default defineScript({

package/generated/model.d.ts

@@ -83,6 +83,9 @@ 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) {
      *     if (model.get_mesh_enabled("#model", "Sword")) {
@@ -153,9 +156,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);
@@ -165,7 +171,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);
@@ -173,7 +178,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;
     /**
      * Resets a shader constant for a model component.
      * The constant must be defined in the material assigned to the model.

package/generated/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/physics.d.ts

@@ -200,6 +200,10 @@ 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) {
@@ -208,9 +212,10 @@ declare global {
      *
      *   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);
      *       }
@@ -248,6 +253,8 @@ declare global {
      *
      *   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);
      *   },
      *
@@ -287,8 +294,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);
@@ -314,7 +321,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 = {
@@ -328,7 +335,7 @@ declare global {
      *       //          id = hash: [/go2]
      *       //      }
      *       // }
-     *     } else if (event === hash("trigger_event")) {
+     *     } else if (event_type === hash("trigger_event")) {
      *       pprint(event);
      *       // {
      *       //  enter = true,
@@ -341,7 +348,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],
@@ -351,7 +358,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

package/generated/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
      */
@@ -113,6 +115,7 @@ declare global {
      * @param text - the string to send to the connected profiler
      * @example
      * ```ts
+     * const name = "my_event";
      * profiler.log_text(`Event: ${name}`);
      * ```
      */
@@ -135,6 +138,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();
@@ -173,7 +180,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
      *
@@ -188,7 +195,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