@defold-typescript/types 0.40.0 → 0.42.0

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

@@ -336,55 +336,55 @@ declare global {
     /**
      * color property
      */
-    const PROP_COLOR: number & { readonly __brand: "gui.PROP_COLOR" };
+    const PROP_COLOR: string & { readonly __brand: "gui.PROP_COLOR" };
     /**
      * euler property
      */
-    const PROP_EULER: number & { readonly __brand: "gui.PROP_EULER" };
+    const PROP_EULER: string & { readonly __brand: "gui.PROP_EULER" };
     /**
      * fill_angle property
      */
-    const PROP_FILL_ANGLE: number & { readonly __brand: "gui.PROP_FILL_ANGLE" };
+    const PROP_FILL_ANGLE: string & { readonly __brand: "gui.PROP_FILL_ANGLE" };
     /**
      * inner_radius property
      */
-    const PROP_INNER_RADIUS: number & { readonly __brand: "gui.PROP_INNER_RADIUS" };
+    const PROP_INNER_RADIUS: string & { readonly __brand: "gui.PROP_INNER_RADIUS" };
     /**
      * leading property
      */
-    const PROP_LEADING: number & { readonly __brand: "gui.PROP_LEADING" };
+    const PROP_LEADING: string & { readonly __brand: "gui.PROP_LEADING" };
     /**
      * outline color property
      */
-    const PROP_OUTLINE: number & { readonly __brand: "gui.PROP_OUTLINE" };
+    const PROP_OUTLINE: string & { readonly __brand: "gui.PROP_OUTLINE" };
     /**
      * position property
      */
-    const PROP_POSITION: number & { readonly __brand: "gui.PROP_POSITION" };
+    const PROP_POSITION: string & { readonly __brand: "gui.PROP_POSITION" };
     /**
      * rotation property
      */
-    const PROP_ROTATION: number & { readonly __brand: "gui.PROP_ROTATION" };
+    const PROP_ROTATION: string & { readonly __brand: "gui.PROP_ROTATION" };
     /**
      * scale property
      */
-    const PROP_SCALE: number & { readonly __brand: "gui.PROP_SCALE" };
+    const PROP_SCALE: string & { readonly __brand: "gui.PROP_SCALE" };
     /**
      * shadow color property
      */
-    const PROP_SHADOW: number & { readonly __brand: "gui.PROP_SHADOW" };
+    const PROP_SHADOW: string & { readonly __brand: "gui.PROP_SHADOW" };
     /**
      * size property
      */
-    const PROP_SIZE: number & { readonly __brand: "gui.PROP_SIZE" };
+    const PROP_SIZE: string & { readonly __brand: "gui.PROP_SIZE" };
     /**
      * slice9 property
      */
-    const PROP_SLICE9: number & { readonly __brand: "gui.PROP_SLICE9" };
+    const PROP_SLICE9: string & { readonly __brand: "gui.PROP_SLICE9" };
     /**
      * tracking property
      */
-    const PROP_TRACKING: number & { readonly __brand: "gui.PROP_TRACKING" };
+    const PROP_TRACKING: string & { readonly __brand: "gui.PROP_TRACKING" };
     /**
      * The provided data is not in the expected format or is in some other way
      * incorrect, for instance the image data provided to gui.new_texture().
@@ -464,57 +464,33 @@ declare global {
      * @param property - property to animate
      *
      * - `"position"`
-     *
      * - `"rotation"`
-     *
      * - `"euler"`
-     *
      * - `"scale"`
-     *
      * - `"color"`
-     *
      * - `"outline"`
-     *
      * - `"shadow"`
-     *
      * - `"size"`
-     *
      * - `"fill_angle"` (pie)
-     *
      * - `"inner_radius"` (pie)
-     *
      * - `"leading"` (text)
-     *
      * - `"tracking"` (text)
-     *
      * - `"slice9"` (slice9)
      *
      * The following property constants are defined equaling the corresponding property string names.
      *
      * - `gui.PROP_POSITION`
-     *
      * - `gui.PROP_ROTATION`
-     *
      * - `gui.PROP_EULER`
-     *
      * - `gui.PROP_SCALE`
-     *
      * - `gui.PROP_COLOR`
-     *
      * - `gui.PROP_OUTLINE`
-     *
      * - `gui.PROP_SHADOW`
-     *
      * - `gui.PROP_SIZE`
-     *
      * - `gui.PROP_FILL_ANGLE`
-     *
      * - `gui.PROP_INNER_RADIUS`
-     *
      * - `gui.PROP_LEADING`
-     *
      * - `gui.PROP_TRACKING`
-     *
      * - `gui.PROP_SLICE9`
      * @param to - target property value
      * @param easing - easing to use during animation.
@@ -527,15 +503,10 @@ declare global {
      * @param playback - playback mode
      *
      * - `gui.PLAYBACK_ONCE_FORWARD`
-     *
      * - `gui.PLAYBACK_ONCE_BACKWARD`
-     *
      * - `gui.PLAYBACK_ONCE_PINGPONG`
-     *
      * - `gui.PLAYBACK_LOOP_FORWARD`
-     *
      * - `gui.PLAYBACK_LOOP_BACKWARD`
-     *
      * - `gui.PLAYBACK_LOOP_PINGPONG`
      * @example
      * How to start a simple color animation, where the node fades in to white during 0.5 seconds:
@@ -585,7 +556,7 @@ declare global {
      * });
      * ```
      */
-    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;
+    function animate(node: Opaque<"node">, property: string | gui.Property | Hash, 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.
      *
@@ -593,34 +564,22 @@ declare global {
      * @param property - optional property for which the animation should be canceled
      *
      * - `"position"`
-     *
      * - `"rotation"`
-     *
      * - `"euler"`
-     *
      * - `"scale"`
-     *
      * - `"color"`
-     *
      * - `"outline"`
-     *
      * - `"shadow"`
-     *
      * - `"size"`
-     *
      * - `"fill_angle"` (pie)
-     *
      * - `"inner_radius"` (pie)
-     *
      * - `"leading"` (text)
-     *
      * - `"tracking"` (text)
-     *
      * - `"slice9"` (slice9)
      * @example
+     * Start an animation of the position property of a node, then cancel parts of
+     * the animation:
      * ```ts
-     * // Start an animation of the position property of a node, then cancel parts of
-     * // the animation:
      * const node = gui.get_node("my_node");
      * // animate to new position
      * const pos = vmath.vector3(100, 100, 0);
@@ -628,8 +587,11 @@ declare global {
      * // ...
      * // cancel animation of the x component.
      * gui.cancel_animations(node, "position.x");
-     *
-     * // Cancels all property animations on a node in a single call:
+     * ```
+     * @example
+     * Cancels all property animations on a node in a single call:
+     * ```ts
+     * const node = gui.get_node("my_node");
      * // animate to new position and scale
      * 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);
@@ -638,7 +600,7 @@ declare global {
      * gui.cancel_animations(node);
      * ```
      */
-    function cancel_animations(node: Opaque<"node">, property?: string | gui.Property): void;
+    function cancel_animations(node: Opaque<"node">, property?: string | gui.Property | Hash): void;
     /**
      * Cancels any running flipbook animation on the specified node.
      *
@@ -732,29 +694,17 @@ declare global {
      * when operating in the gui namespace. Most notably, only these explicitly named properties are supported:
      *
      * - `"position"`
-     *
      * - `"rotation"`
-     *
      * - `"euler"`
-     *
      * - `"scale"`
-     *
      * - `"color"`
-     *
      * - `"outline"`
-     *
      * - `"shadow"`
-     *
      * - `"size"`
-     *
      * - `"fill_angle"` (pie)
-     *
      * - `"inner_radius"` (pie)
-     *
      * - `"leading"` (text)
-     *
      * - `"tracking"` (text)
-     *
      * - `"slice9"` (slice9)
      *
      * The value returned will either be a vmath.vector4 or a single number, i.e getting the "position"
@@ -764,7 +714,9 @@ 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 zero-based index into array property; the transpiler emits Defold's 1-based index
+     * - `index` number index into array property (1 based)
+     *
+     * **⚠️ `index` is 1-based; passed to Defold unchanged.**
      * @example
      * ```ts
      * // Get properties on existing nodes:
@@ -772,7 +724,7 @@ declare global {
      * const node_position = gui.get(node, "position");
      * ```
      */
-    function get(node: Opaque<"node">, property: string | Hash | gui.Property, options?: { index?: number }): unknown;
+    function get(node: Opaque<"node">, property: string | Hash | gui.Property, options?: { index?: number; key?: string | Hash; keys?: (Hash | string)[] }): unknown;
     /**
      * Returns the adjust mode of a node.
      * The adjust mode defines how the node will adjust itself to screen
@@ -782,9 +734,7 @@ declare global {
      * @returns the current adjust mode
      *
      * - `gui.ADJUST_FIT`
-     *
      * - `gui.ADJUST_ZOOM`
-     *
      * - `gui.ADJUST_STRETCH`
      */
     function get_adjust_mode(node: Opaque<"node">): gui.AdjustMode;
@@ -803,13 +753,9 @@ declare global {
      * @returns blend mode
      *
      * - `gui.BLEND_ALPHA`
-     *
      * - `gui.BLEND_ADD`
-     *
      * - `gui.BLEND_ADD_ALPHA`
-     *
      * - `gui.BLEND_MULT`
-     *
      * - `gui.BLEND_SCREEN`
      */
     function get_blend_mode(node: Opaque<"node">): gui.BlendMode;
@@ -827,7 +773,6 @@ declare global {
      * @returns clipping mode
      *
      * - `gui.CLIPPING_MODE_NONE`
-     *
      * - `gui.CLIPPING_MODE_STENCIL`
      */
     function get_clipping_mode(node: Opaque<"node">): gui.ClippingMode;
@@ -950,7 +895,7 @@ declare global {
      * Higher index means the node is drawn on top of lower indexed nodes.
      *
      * @param node - the node to retrieve the id from
-     * @returns the index of the node
+     * @returns the index of the node. **0️⃣ 0-based; passed to Defold unchanged.**
      * @example
      * ```ts
      * // Compare the index order of two sibling nodes:
@@ -1053,7 +998,6 @@ declare global {
      * @returns the outer bounds mode of the pie node:
      *
      * - `gui.PIEBOUNDS_RECTANGLE`
-     *
      * - `gui.PIEBOUNDS_ELLIPSE`
      */
     function get_outer_bounds(node: Opaque<"node">): gui.PieBounds;
@@ -1095,21 +1039,13 @@ declare global {
      * @returns pivot constant
      *
      * - `gui.PIVOT_CENTER`
-     *
      * - `gui.PIVOT_N`
-     *
      * - `gui.PIVOT_NE`
-     *
      * - `gui.PIVOT_E`
-     *
      * - `gui.PIVOT_SE`
-     *
      * - `gui.PIVOT_S`
-     *
      * - `gui.PIVOT_SW`
-     *
      * - `gui.PIVOT_W`
-     *
      * - `gui.PIVOT_NW`
      */
     function get_pivot(node: Opaque<"node">): gui.Pivot;
@@ -1171,7 +1107,6 @@ declare global {
      * @returns the current size mode
      *
      * - `gui.SIZE_MODE_MANUAL`
-     *
      * - `gui.SIZE_MODE_AUTO`
      */
     function get_size_mode(node: Opaque<"node">): gui.SizeMode;
@@ -1239,9 +1174,7 @@ declare global {
      * @returns anchor constant
      *
      * - `gui.ANCHOR_NONE`
-     *
      * - `gui.ANCHOR_LEFT`
-     *
      * - `gui.ANCHOR_RIGHT`
      */
     function get_xanchor(node: Opaque<"node">): gui.XAnchor;
@@ -1252,9 +1185,7 @@ declare global {
      * @returns anchor constant
      *
      * - `gui.ANCHOR_NONE`
-     *
      * - `gui.ANCHOR_TOP`
-     *
      * - `gui.ANCHOR_BOTTOM`
      */
     function get_yanchor(node: Opaque<"node">): gui.YAnchor;
@@ -1295,7 +1226,7 @@ declare global {
      * @param node - to move
      * @param reference - reference node above which the first node should be moved
      */
-    function move_above(node: Opaque<"node">, reference?: Opaque<"node">): void;
+    function move_above(node: Opaque<"node">, reference: Opaque<"node"> | undefined): void;
     /**
      * Alters the ordering of the two supplied nodes by moving the first node
      * below the second.
@@ -1304,7 +1235,7 @@ declare global {
      * @param node - to move
      * @param reference - reference node below which the first node should be moved
      */
-    function move_below(node: Opaque<"node">, reference?: Opaque<"node">): void;
+    function move_below(node: Opaque<"node">, reference: Opaque<"node"> | undefined): void;
     /**
      * Dynamically create a new box node.
      *
@@ -1346,17 +1277,14 @@ declare global {
      * @param type - texture type
      *
      * - `"rgb"` - RGB
-     *
      * - `"rgba"` - RGBA
-     *
      * - `"l"` - LUMINANCE
-     *
      * - `"astc"` - ASTC compressed format
      * @param buffer - texture data
      * @param flip - flip texture vertically
      * @example
+     * How to create a texture and apply it to a new box node:
      * ```ts
-     * // How to create a texture and apply it to a new box node:
      * export default defineGuiScript({
      *   init(self) {
      *     const w = 200;
@@ -1381,8 +1309,10 @@ declare global {
      *     }
      *   },
      * });
-     *
-     * // How to create a texture using .astc format
+     * ```
+     * @example
+     * How to create a texture using .astc format
+     * ```ts
      * const size = 4;
      * const pos = vmath.vector3(200, 200, 0);
      * const path = "/assets/images/logo_4x4.astc";
@@ -1396,7 +1326,7 @@ declare global {
      * }
      * ```
      */
-    function new_texture(texture_id: string | Hash, width: number, height: number, type: string | Opaque<"constant">, buffer: string, flip?: boolean): LuaMultiReturn<[boolean, number]>;
+    function new_texture(texture_id: string | Hash, width: number, height: number, type: string | Opaque<"constant">, buffer: string, flip?: boolean): LuaMultiReturn<[boolean, number | undefined]>;
     /**
      * This is a callback-function, which is called by the engine when user input is sent to the instance of the gui component.
      * It can be used to take action on the input, e.g. modify the gui according to the input.
@@ -1533,7 +1463,7 @@ declare global {
      *
      * @param self - reference to the script state to be used for storing data
      * @param action_id - id of the received input action, as mapped in the input_binding-file
-     * @param action - a table containing the input data, see above for a description
+     * @param action - a table containing the input data, see above for a description. **0️⃣ `gamepad` is 0-based; passed to Defold unchanged.**
      * @returns optional boolean to signal if the input should be consumed (not passed on to others) or not, default is false
      * @example
      * ```ts
@@ -1620,8 +1550,8 @@ declare global {
      * `playback_rate`
      * number The rate with which the animation will be played. Must be positive
      * @example
+     * Set the texture of a node to a flipbook animation from an atlas:
      * ```ts
-     * // Set the texture of a node to a flipbook animation from an atlas:
      * function anim_callback(self: unknown, node: unknown) {
      *   // Take action after animation has played.
      * }
@@ -1634,8 +1564,10 @@ declare global {
      *     gui.play_flipbook(node, "animated_button");
      *   },
      * });
-     *
-     * // Set the texture of a node to an image from an atlas:
+     * ```
+     * @example
+     * Set the texture of a node to an image from an atlas:
+     * ```ts
      * // Create a new node and set the texture to a "button.png" from atlas
      * const node = gui.get_node("button_node");
      * gui.set_texture(node, "gui_sprites");
@@ -1659,11 +1591,8 @@ declare global {
      * constant the new state of the emitter:
      *
      * - `particlefx.EMITTER_STATE_SLEEPING`
-     *
      * - `particlefx.EMITTER_STATE_PRESPAWN`
-     *
      * - `particlefx.EMITTER_STATE_SPAWNING`
-     *
      * - `particlefx.EMITTER_STATE_POSTSPAWN`
      * @example
      * ```ts
@@ -1713,7 +1642,7 @@ declare global {
      * @param screen_position - screen position
      * @returns local position
      */
-    function screen_to_local(node: Opaque<"node">, screen_position: Vector3): Vector3;
+    function screen_to_local(node: Opaque<"node">, screen_position: Vector3 | Vector4): Vector3;
     /**
      * Instead of using specific setteres such as gui.set_position or gui.set_scale,
      * you can use gui.set instead and supply the property as a string or a hash.
@@ -1721,29 +1650,17 @@ declare global {
      * when operating in the gui namespace. Most notably, only these named properties identifiers are supported:
      *
      * - `"position"`
-     *
      * - `"rotation"`
-     *
      * - `"euler"`
-     *
      * - `"scale"`
-     *
      * - `"color"`
-     *
      * - `"outline"`
-     *
      * - `"shadow"`
-     *
      * - `"size"`
-     *
      * - `"fill_angle"` (pie)
-     *
      * - `"inner_radius"` (pie)
-     *
      * - `"leading"` (text)
-     *
      * - `"tracking"` (text)
-     *
      * - `"slice9"` (slice9)
      *
      * The value to set must either be a vmath.vector4, vmath.vector3, vmath.quat or a single number and depends on the property name you want to set.
@@ -1761,16 +1678,21 @@ declare global {
      * @param property - the property to set
      * @param value - the property to set
      * @param options - optional options table (only applicable for material constants)
-     * - `index` number zero-based index into array property; the transpiler emits Defold's 1-based index
+     * - `index` number index into array property (1 based)
      * - `key` hash name of internal property
+     *
+     * **⚠️ `index` is 1-based; passed to Defold unchanged.**
      * @example
+     * Updates the position property on an existing node:
      * ```ts
-     * // Updates the position property on an existing node:
      * const node = gui.get_node("my_box_node");
      * 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:
+     * ```
+     * @example
+     * Updates the rotation property on an existing node:
+     * ```ts
+     * const node = gui.get_node("my_box_node");
      * gui.set(node, "rotation", vmath.quat_rotation_z(math.rad(45)));
      * // this is equivalent to:
      * gui.set(node, "euler.z", 45);
@@ -1778,23 +1700,28 @@ declare global {
      * gui.set(node, "euler", vmath.vector3(0, 0, 45));
      * // or using the set_rotation
      * gui.set_rotation(node, vmath.vector3(0, 0, 45));
-     *
-     * // Sets various material constants for a node:
+     * ```
+     * @example
+     * Sets various material constants for a node:
+     * ```ts
+     * const node = gui.get_node("my_box_node");
      * gui.set(node, "tint", vmath.vector4(1, 0, 0, 1));
      * // 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]; // TypeScript and the shader are both 0 based
-     * gui.set(node, "tint_array", vmath.vector4(1, 0, 0, 1), { index: 3 });
+     * // 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 });
      * // 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: 3 });
+     * gui.set(node, "light_matrix_array", vmath.matrix4(), { index: 4 });
      * // 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: 3 });
-     *
-     * // Set a named property
+     * gui.set(node, "tint_array.x", 1, { index: 4 });
+     * ```
+     * @example
+     * Set a named property
+     * ```ts
      * export default defineGuiScript({
      *   on_message(self, message_id, message) {
      *     if (message_id === hash("set_font") && types.is_hash(message.font)) {
@@ -1809,7 +1736,7 @@ declare global {
      * });
      * ```
      */
-    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;
+    function set(node: Opaque<"node"> | Url, property: string | Hash | gui.Property, value: number | Vector4 | Vector3 | Quaternion | Matrix4 | Hash, options?: { index?: number; key?: string | Hash; keys?: (Hash | string)[] }): void;
     /**
      * Sets the adjust mode on a node.
      * The adjust mode defines how the node will adjust itself to screen
@@ -1819,9 +1746,7 @@ declare global {
      * @param adjust_mode - adjust mode to set
      *
      * - `gui.ADJUST_FIT`
-     *
      * - `gui.ADJUST_ZOOM`
-     *
      * - `gui.ADJUST_STRETCH`
      */
     function set_adjust_mode(node: Opaque<"node">, adjust_mode: gui.AdjustMode): void;
@@ -1840,13 +1765,9 @@ declare global {
      * @param blend_mode - blend mode to set
      *
      * - `gui.BLEND_ALPHA`
-     *
      * - `gui.BLEND_ADD`
-     *
      * - `gui.BLEND_ADD_ALPHA`
-     *
      * - `gui.BLEND_MULT`
-     *
      * - `gui.BLEND_SCREEN`
      */
     function set_blend_mode(node: Opaque<"node">, blend_mode: gui.BlendMode): void;
@@ -1864,7 +1785,6 @@ declare global {
      * @param clipping_mode - clipping mode to set
      *
      * - `gui.CLIPPING_MODE_NONE`
-     *
      * - `gui.CLIPPING_MODE_STENCIL`
      */
     function set_clipping_mode(node: Opaque<"node">, clipping_mode: gui.ClippingMode): void;
@@ -2032,7 +1952,6 @@ declare global {
      * @param bounds_mode - the outer bounds mode of the pie node:
      *
      * - `gui.PIEBOUNDS_RECTANGLE`
-     *
      * - `gui.PIEBOUNDS_ELLIPSE`
      */
     function set_outer_bounds(node: Opaque<"node">, bounds_mode: gui.PieBounds): void;
@@ -2051,7 +1970,7 @@ declare global {
      * @param parent - parent node to set, pass `nil` to remove parent
      * @param keep_scene_transform - optional flag to make the scene position being perserved
      */
-    function set_parent(node: Opaque<"node">, parent?: Opaque<"node">, keep_scene_transform?: boolean): void;
+    function set_parent(node: Opaque<"node">, parent: Opaque<"node"> | undefined, keep_scene_transform?: boolean): void;
     /**
      * Set the paricle fx for a gui node
      *
@@ -2073,21 +1992,13 @@ declare global {
      * @param pivot - pivot constant
      *
      * - `gui.PIVOT_CENTER`
-     *
      * - `gui.PIVOT_N`
-     *
      * - `gui.PIVOT_NE`
-     *
      * - `gui.PIVOT_E`
-     *
      * - `gui.PIVOT_SE`
-     *
      * - `gui.PIVOT_S`
-     *
      * - `gui.PIVOT_SW`
-     *
      * - `gui.PIVOT_W`
-     *
      * - `gui.PIVOT_NW`
      */
     function set_pivot(node: Opaque<"node">, pivot: gui.Pivot): void;
@@ -2122,11 +2033,8 @@ declare global {
      * @param mode - safe area mode
      *
      * - `gui.SAFE_AREA_NONE`
-     *
      * - `gui.SAFE_AREA_LONG`
-     *
      * - `gui.SAFE_AREA_SHORT`
-     *
      * - `gui.SAFE_AREA_BOTH`
      */
     function set_safe_area_mode(mode: gui.SafeAreaMode): void;
@@ -2143,7 +2051,7 @@ declare global {
      * @param node - node to set the screen position to
      * @param screen_position - screen position
      */
-    function set_screen_position(node: Opaque<"node">, screen_position: Vector3): void;
+    function set_screen_position(node: Opaque<"node">, screen_position: Vector3 | Vector4): void;
     /**
      * Sets the shadow color of the supplied node.
      * See gui.set_color for info how vectors encode color values.
@@ -2172,7 +2080,6 @@ declare global {
      * @param size_mode - size mode to set
      *
      * - `gui.SIZE_MODE_MANUAL`
-     *
      * - `gui.SIZE_MODE_AUTO`
      */
     function set_size_mode(node: Opaque<"node">, size_mode: gui.SizeMode): void;
@@ -2201,20 +2108,25 @@ declare global {
      * @param node - node to set texture for
      * @param texture - texture id
      * @example
+     * To set a texture (or animation) from an atlas:
      * ```ts
-     * // To set a texture (or animation) from an atlas:
      * const node = gui.get_node("box_node");
      * gui.set_texture(node, "my_atlas");
      * gui.play_flipbook(node, "image");
-     *
-     * // Set a dynamically created texture to a node. Note that there is only
-     * // one texture image in this case so gui.set_texture() is sufficient.
+     * ```
+     * @example
+     * Set a dynamically created texture to a node. Note that there is only
+     * one texture image in this case so `gui.set_texture()` is
+     * sufficient.
+     * ```ts
      * const w = 200;
      * const h = 300;
      * // A nice orange. String with the RGB values.
      * const orange = String.fromCharCode(0xff, 0x80, 0x10);
      * // Create the texture. Repeat the color string for each pixel.
-     * if (gui.new_texture("orange_tx", w, h, "rgb", orange.repeat(w * h))) {
+     * const [ok] = gui.new_texture("orange_tx", w, h, "rgb", orange.repeat(w * h));
+     * if (ok) {
+     *   const node = gui.get_node("box_node");
      *   gui.set_texture(node, "orange_tx");
      * }
      * ```
@@ -2229,11 +2141,8 @@ declare global {
      * @param type - texture type
      *
      * - `"rgb"` - RGB
-     *
      * - `"rgba"` - RGBA
-     *
      * - `"l"` - LUMINANCE
-     *
      * - `"astc"` - ASTC compressed format
      * @param buffer - texture data
      * @param flip - flip texture vertically
@@ -2290,9 +2199,7 @@ declare global {
      * @param anchor - anchor constant
      *
      * - `gui.ANCHOR_NONE`
-     *
      * - `gui.ANCHOR_LEFT`
-     *
      * - `gui.ANCHOR_RIGHT`
      */
     function set_xanchor(node: Opaque<"node">, anchor: gui.XAnchor): void;
@@ -2303,9 +2210,7 @@ declare global {
      * @param anchor - anchor constant
      *
      * - `gui.ANCHOR_NONE`
-     *
      * - `gui.ANCHOR_TOP`
-     *
      * - `gui.ANCHOR_BOTTOM`
      */
     function set_yanchor(node: Opaque<"node">, anchor: gui.YAnchor): void;
@@ -2318,11 +2223,8 @@ declare global {
      * @param type - keyboard type
      *
      * - `gui.KEYBOARD_TYPE_DEFAULT`
-     *
      * - `gui.KEYBOARD_TYPE_EMAIL`
-     *
      * - `gui.KEYBOARD_TYPE_NUMBER_PAD`
-     *
      * - `gui.KEYBOARD_TYPE_PASSWORD`
      * @param autoclose - if the keyboard should automatically close when clicking outside
      */