@defold-typescript/types 0.38.0 → 0.40.0

package/generated/gui.d.ts

@@ -1,11 +1,25 @@
 /** @noSelfInFile */
-import type { Hash, Opaque, Quaternion, Url, Vector, Vector3, Vector4 } from "../src/core-types";
+import type { Hash, Matrix4, Opaque, Quaternion, Url, Vector, Vector3, Vector4 } from "../src/core-types";
 
 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.
      *
@@ -600,21 +622,21 @@ declare global {
      * const node = gui.get_node("my_node");
      * // animate to new position
      * const pos = vmath.vector3(100, 100, 0);
-     * gui.animate(node, "position", pos, go.EASING_LINEAR, 2);
+     * gui.animate(node, "position", pos, gui.EASING_LINEAR, 2);
      * // ...
      * // cancel animation of the x component.
      * gui.cancel_animations(node, "position.x");
      *
      * // Cancels all property animations on a node in a single call:
      * // animate to new position and scale
-     * gui.animate(node, "position", vmath.vector3(100, 100, 0), go.EASING_LINEAR, 5);
-     * gui.animate(node, "scale", vmath.vector3(0.5), go.EASING_LINEAR, 5);
+     * gui.animate(node, "position", vmath.vector3(100, 100, 0), gui.EASING_LINEAR, 5);
+     * gui.animate(node, "scale", vmath.vector3(0.5), gui.EASING_LINEAR, 5);
      * // ...
      * // cancel positioning and scaling at once
      * 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))) {
@@ -689,6 +711,10 @@ declare global {
      * @example
      * ```ts
      * export default defineScript({
+     *   init() {
+     *     return { some_value: 0 };
+     *   },
+     *
      *   final(self) {
      *     // report finalization
      *     msg.post("my_friend_instance", "im_dead", { my_stats: self.some_value });
@@ -736,7 +762,7 @@ declare global {
      * @param node - node to get the property for
      * @param property - the property to retrieve
      * @param options - optional options table (only applicable for material constants)
-     * - `index` number index into array property (1 based)
+     * - `index` number zero-based index into array property; the transpiler emits Defold's 1-based index
      * @example
      * ```ts
      * // Get properties on existing nodes:
@@ -744,7 +770,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 +785,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 +810,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 +828,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 +910,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 +1054,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 +1110,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 +1172,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 +1215,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 +1242,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 +1255,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 +1355,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,13 +1381,17 @@ 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));
-     * // size is read from the .astc buffer
-     * // flip is not supported
-     * gui.new_texture(path, 0, 0, "astc", buffer, false);
-     * gui.set_texture(n, path);
+     * const [data] = sys.load_resource(path);
+     * if (data !== undefined) {
+     *   const n = gui.new_box_node(pos, vmath.vector3(size, size, 0));
+     *   // size is read from the .astc buffer
+     *   // flip is not supported
+     *   gui.new_texture(path, 0, 0, "astc", data, false);
+     *   gui.set_texture(n, path);
+     * }
      * ```
      */
     function new_texture(texture_id: string | Hash, width: number, height: number, type: string | Opaque<"constant">, buffer: string, flip?: boolean): LuaMultiReturn<[boolean, number]>;
@@ -1505,7 +1535,11 @@ 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({
+     *   init(): { my_value: number | undefined } {
+     *     return { my_value: undefined };
+     *   },
+     *
      *   on_input(self, action_id, action) {
      *     // check for input
      *     if (action_id === hash("my_action")) {
@@ -1539,6 +1573,10 @@ declare global {
      * @example
      * ```ts
      * export default defineGuiScript({
+     *   init() {
+     *     return { my_original_color: gui.get_color(gui.get_node("my_node")) };
+     *   },
+     *
      *   on_reload(self) {
      *     // restore some color (or similar)
      *     gui.set_color(gui.get_node("my_node"), self.my_original_color);
@@ -1582,11 +1620,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 +1668,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,14 +1714,19 @@ 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") };
      *   },
      *
      *   on_input(self, action_id, action) {
-     *     if (action_id === hash("touch") && action.pressed) {
+     *     if (
+     *       action_id === hash("touch") &&
+     *       action.pressed &&
+     *       action.screen_x !== undefined &&
+     *       action.screen_y !== undefined
+     *     ) {
      *       const screen_position = vmath.vector3(action.screen_x, action.screen_y, 0);
      *       const target_position = gui.screen_to_local(self.marker, screen_position);
      *       gui.animate(self.marker, gui.PROP_POSITION, target_position, gui.EASING_OUTQUAD, 0.2);
@@ -1741,13 +1784,13 @@ declare global {
      * @param property - the property to set
      * @param value - the property to set. `nil` is only supported for removing runtime texture mappings with `gui.set(msg.url(), "textures", nil, {key = ...})`.
      * @param options - optional options table (only applicable for material constants)
-     * - `index` number index into array property (1 based)
+     * - `index` number zero-based index into array property; the transpiler emits Defold's 1-based index
      * - `key` hash name of internal property
      * @example
      * ```ts
      * // Updates the position property on an existing node:
      * const node = gui.get_node("my_box_node");
-     * const node_position = gui.get(node, "position");
+     * const node_position = gui.get(node, "position") as Vector3;
      * gui.set(node, "position.x", node_position.x + 128);
      *
      * // Updates the rotation property on an existing node:
@@ -1764,23 +1807,23 @@ declare global {
      * // matrix4 is also supported
      * gui.set(node, "light_matrix", vmath.matrix4());
      * // update a constant in an array at position 4. the array is specified in the shader as:
-     * // uniform vec4 tint_array[4]; // lua is 1 based, shader is 0 based
-     * gui.set(node, "tint_array", vmath.vector4(1, 0, 0, 1), { index: 4 });
+     * // uniform vec4 tint_array[4]; // TypeScript and the shader are both 0 based
+     * gui.set(node, "tint_array", vmath.vector4(1, 0, 0, 1), { index: 3 });
      * // update a matrix constant in an array at position 4. the array is specified in the shader as:
      * // uniform mat4 light_matrix_array[4];
-     * gui.set(node, "light_matrix_array", vmath.matrix4(), { index: 4 });
+     * gui.set(node, "light_matrix_array", vmath.matrix4(), { index: 3 });
      * // update a sub-element in a constant
      * gui.set(node, "tint.x", 1);
      * // update a sub-element in an array constant at position 4
-     * gui.set(node, "tint_array.x", 1, { index: 4 });
+     * gui.set(node, "tint_array.x", 1, { index: 3 });
      *
      * // Set a named property
-     * export default defineScript({
+     * export default defineGuiScript({
      *   on_message(self, message_id, message) {
-     *     if (message_id === hash("set_font")) {
+     *     if (message_id === hash("set_font") && types.is_hash(message.font)) {
      *       gui.set(msg.url(), "fonts", message.font, { key: "my_font_name" });
      *       gui.set_font(gui.get_node("text"), "my_font_name");
-     *     } else if (message_id === hash("set_texture")) {
+     *     } else if (message_id === hash("set_texture") && types.is_hash(message.texture)) {
      *       gui.set(msg.url(), "textures", message.texture, { key: "my_texture" });
      *       gui.set_texture(gui.get_node("box"), "my_texture");
      *       gui.play_flipbook(gui.get_node("box"), "logo_256");
@@ -1789,6 +1832,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 +1842,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 | Matrix4 | Hash, options?: { index?: number; key?: string | Hash }): void;
     /**
      * Sets the adjust mode on a node.
      * The adjust mode defines how the node will adjust itself to screen
@@ -1813,7 +1857,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 +1882,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 +1900,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 +2068,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 +2123,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.
      *
@@ -2104,7 +2148,7 @@ declare global {
      * @param node - node to set the rotation for
      * @param rotation - new rotation
      */
-    function set_rotation(node: Opaque<"node">, rotation: Quaternion | Vector4): void;
+    function set_rotation(node: Opaque<"node">, rotation: Quaternion | Vector4 | Vector3): void;
     /**
      * Sets how the safe area is applied to this gui scene.
      *
@@ -2118,7 +2162,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 +2208,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 +2273,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 +2328,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 +2341,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 +2359,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
      *
@@ -2337,15 +2381,17 @@ declare global {
      * // in a counting fashion. It is assumed that the gui component receives messages
      * // from the game when a new score is to be shown.
      * export default defineGuiScript({
-     *   init(self) {
-     *     // fetch the score text node for later use (assumes it is called "score")
-     *     self.score_node = gui.get_node("score");
-     *     // keep track of the current score counted up so far
-     *     self.current_score = 0;
-     *     // keep track of the target score we should count up to
-     *     self.target_score = 0;
-     *     // how fast we will update the score, in score/second
-     *     self.score_update_speed = 1;
+     *   init() {
+     *     return {
+     *       // fetch the score text node for later use (assumes it is called "score")
+     *       score_node: gui.get_node("score"),
+     *       // keep track of the current score counted up so far
+     *       current_score: 0,
+     *       // keep track of the target score we should count up to
+     *       target_score: 0,
+     *       // how fast we will update the score, in score/second
+     *       score_update_speed: 1,
+     *     };
      *   },
      *
      *   update(self, dt) {
@@ -2364,7 +2410,7 @@ declare global {
      *
      *   on_message(self, message_id, message) {
      *     // check the message
-     *     if (message_id === hash("set_score")) {
+     *     if (message_id === hash("set_score") && typeof message.score === "number") {
      *       self.target_score = message.score;
      *     }
      *   },

package/generated/html5.d.ts

@@ -18,7 +18,9 @@ declare global {
      * const res = html5.run("10 + 20"); // returns the string "30"
      * print(res);
      * const res_num = tonumber(res); // convert to number
-     * print(res_num - 20); // prints 10
+     * if (res_num !== undefined) {
+     *   print(res_num - 20); // prints 10
+     * }
      * ```
      */
     function run(code: string): string;
@@ -34,7 +36,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

@@ -1,4 +1,6 @@
 /** @noSelfInFile */
+import type { Hash } from "../src/core-types";
+
 declare global {
   /**
    * Functions for performing HTTP and HTTPS requests.
@@ -53,6 +55,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({
@@ -61,7 +67,7 @@ declare global {
      *       "http://www.google.com",
      *       "GET",
      *       (self, _id, response) => {
-     *         if (response.bytes_total !== undefined) {
+     *         if (response.bytes_received !== undefined && response.bytes_total !== undefined) {
      *           update_my_progress_bar(self, response.bytes_received / response.bytes_total);
      *         } else {
      *           print(response.status);
@@ -77,7 +83,7 @@ declare global {
      * });
      * ```
      */
-    function request(url: string, method: string, callback: (self: unknown, id: unknown, response: unknown) => void, headers?: LuaMap<string, string>, post_data?: string, options?: { timeout?: number; path?: string; ignore_cache?: boolean; chunked_transfer?: boolean; report_progress?: boolean }): void;
+    function request(url: string, method: string, callback: (self: unknown, id: Hash, response: { status: number; response?: string; headers?: LuaMap<string, string>; path?: string; error?: string; bytes_received?: number; bytes_total?: number; range_start?: number; range_end?: number; document_size?: number }) => void, headers?: LuaMap<string, string> | Record<string, string>, post_data?: string, options?: { timeout?: number; path?: string; ignore_cache?: boolean; chunked_transfer?: boolean; report_progress?: boolean }): void;
   }
 }