Thilawyn/react-godot-renderer
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
a19746d3ab24015d6e7d9e0e9ab5c2736fabe83c
react-godot-renderer/packages/example/typings/godot4.gen.d.ts
Julien Valverdé e9a34a2152
Some checks failed
Lint / lint (push) Failing after 9s
Details
Setup Godot example project
2025-12-28 15:37:58 +01:00

9218 lines
552 KiB
TypeScript
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
// AUTO-GENERATED
declare module "godot" {
namespace GradientTexture2D {
enum Fill {
/** The colors are linearly interpolated in a straight line. */
FILL_LINEAR = 0,
/** The colors are linearly interpolated in a circular pattern. */
FILL_RADIAL = 1,
/** The colors are linearly interpolated in a square pattern. */
FILL_SQUARE = 2,
}
enum Repeat {
/** The gradient fill is restricted to the range defined by [member fill_from] to [member fill_to] offsets. */
REPEAT_NONE = 0,
/** The texture is filled starting from [member fill_from] to [member fill_to] offsets, repeating the same pattern in both directions. */
REPEAT = 1,
/** The texture is filled starting from [member fill_from] to [member fill_to] offsets, mirroring the pattern in both directions. */
REPEAT_MIRROR = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGradientTexture2D extends __NameMapTexture2D {
}
/** A 2D texture that creates a pattern with colors obtained from a [Gradient].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_gradienttexture2d.html
*/
class GradientTexture2D extends Texture2D {
constructor(identifier?: any)
/** The [Gradient] used to fill the texture. */
get gradient(): null | Gradient
set gradient(value: null | Gradient)
/** The number of horizontal color samples that will be obtained from the [Gradient], which also represents the texture's width. */
get width(): int64
set width(value: int64)
/** The number of vertical color samples that will be obtained from the [Gradient], which also represents the texture's height. */
get height(): int64
set height(value: int64)
/** If `true`, the generated texture will support high dynamic range ([constant Image.FORMAT_RGBAF] format). This allows for glow effects to work if [member Environment.glow_enabled] is `true`. If `false`, the generated texture will use low dynamic range; overbright colors will be clamped ([constant Image.FORMAT_RGBA8] format). */
get use_hdr(): boolean
set use_hdr(value: boolean)
/** The gradient's fill type. */
get fill(): int64
set fill(value: int64)
/** The initial offset used to fill the texture specified in UV coordinates. */
get fill_from(): Vector2
set fill_from(value: Vector2)
/** The final offset used to fill the texture specified in UV coordinates. */
get fill_to(): Vector2
set fill_to(value: Vector2)
/** The gradient's repeat type. */
get repeat(): int64
set repeat(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGradientTexture2D;
}
namespace GraphEdit {
enum PanningScheme {
/** [kbd]Mouse Wheel[/kbd] will zoom, [kbd]Ctrl + Mouse Wheel[/kbd] will move the view. */
SCROLL_ZOOMS = 0,
/** [kbd]Mouse Wheel[/kbd] will move the view, [kbd]Ctrl + Mouse Wheel[/kbd] will zoom. */
SCROLL_PANS = 1,
}
enum GridPattern {
/** Draw the grid using solid lines. */
GRID_PATTERN_LINES = 0,
/** Draw the grid using dots. */
GRID_PATTERN_DOTS = 1,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGraphEdit extends __NameMapControl {
}
/** An editor for graph-like structures, using [GraphNode]s.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_graphedit.html
*/
class GraphEdit<Map extends NodePathMap = any> extends Control<Map> {
constructor(identifier?: any)
/** Returns whether the [param mouse_position] is in the input hot zone.
* By default, a hot zone is a [Rect2] positioned such that its center is at [param in_node].[method GraphNode.get_input_port_position]([param in_port]) (For output's case, call [method GraphNode.get_output_port_position] instead). The hot zone's width is twice the Theme Property `port_grab_distance_horizontal`, and its height is twice the `port_grab_distance_vertical`.
* Below is a sample code to help get started:
*
*/
/* gdvirtual */ _is_in_input_hotzone(in_node: Object, in_port: int64, mouse_position: Vector2): boolean
/** Returns whether the [param mouse_position] is in the output hot zone. For more information on hot zones, see [method _is_in_input_hotzone].
* Below is a sample code to help get started:
*
*/
/* gdvirtual */ _is_in_output_hotzone(in_node: Object, in_port: int64, mouse_position: Vector2): boolean
/** Virtual method which can be overridden to customize how connections are drawn. */
/* gdvirtual */ _get_connection_line(from_position: Vector2, to_position: Vector2): PackedVector2Array
/** This virtual method can be used to insert additional error detection while the user is dragging a connection over a valid port.
* Return `true` if the connection is indeed valid or return `false` if the connection is impossible. If the connection is impossible, no snapping to the port and thus no connection request to that port will happen.
* In this example a connection to same node is suppressed:
*
*/
/* gdvirtual */ _is_node_hover_valid(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64): boolean
/** Create a connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode]. If the connection already exists, no connection is created.
* Connections with [param keep_alive] set to `false` may be deleted automatically if invalid during a redraw.
*/
connect_node(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64, keep_alive?: boolean /* = false */): Error
/** Returns `true` if the [param from_port] of the [param from_node] [GraphNode] is connected to the [param to_port] of the [param to_node] [GraphNode]. */
is_node_connected(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64): boolean
/** Removes the connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode]. If the connection does not exist, no connection is removed. */
disconnect_node(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64): void
/** Sets the coloration of the connection between [param from_node]'s [param from_port] and [param to_node]'s [param to_port] with the color provided in the [theme_item activity] theme property. The color is linearly interpolated between the connection color and the activity color using [param amount] as weight. */
set_connection_activity(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64, amount: float64): void
/** Returns the number of connections from [param from_port] of [param from_node]. */
get_connection_count(from_node: StringName, from_port: int64): int64
/** Returns the closest connection to the given point in screen space. If no connection is found within [param max_distance] pixels, an empty [Dictionary] is returned.
* A connection is represented as a [Dictionary] in the form of:
*
* For example, getting a connection at a given mouse position can be achieved like this:
*
*/
get_closest_connection_at_point(point: Vector2, max_distance?: float64 /* = 4 */): GDictionary
/** Returns an [Array] containing a list of all connections for [param node].
* A connection is represented as a [Dictionary] in the form of:
*
* **Example:** Get all connections on a specific port:
*
*/
get_connection_list_from_node(node: StringName): GArray<GDictionary>
/** Returns an [Array] containing the list of connections that intersect with the given [Rect2].
* A connection is represented as a [Dictionary] in the form of:
*
*/
get_connections_intersecting_with_rect(rect: Rect2): GArray<GDictionary>
/** Removes all connections between nodes. */
clear_connections(): void
/** Ends the creation of the current connection. In other words, if you are dragging a connection you can use this method to abort the process and remove the line that followed your cursor.
* This is best used together with [signal connection_drag_started] and [signal connection_drag_ended] to add custom behavior like node addition through shortcuts.
*
* **Note:** This method suppresses any other connection request signals apart from [signal connection_drag_ended].
*/
force_connection_drag_end(): void
/** Allows to disconnect nodes when dragging from the right port of the [GraphNode]'s slot if it has the specified type. See also [method remove_valid_right_disconnect_type]. */
add_valid_right_disconnect_type(type: int64): void
/** Disallows to disconnect nodes when dragging from the right port of the [GraphNode]'s slot if it has the specified type. Use this to disable disconnection previously allowed with [method add_valid_right_disconnect_type]. */
remove_valid_right_disconnect_type(type: int64): void
/** Allows to disconnect nodes when dragging from the left port of the [GraphNode]'s slot if it has the specified type. See also [method remove_valid_left_disconnect_type]. */
add_valid_left_disconnect_type(type: int64): void
/** Disallows to disconnect nodes when dragging from the left port of the [GraphNode]'s slot if it has the specified type. Use this to disable disconnection previously allowed with [method add_valid_left_disconnect_type]. */
remove_valid_left_disconnect_type(type: int64): void
/** Allows the connection between two different port types. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method.
* See also [method is_valid_connection_type] and [method remove_valid_connection_type].
*/
add_valid_connection_type(from_type: int64, to_type: int64): void
/** Disallows the connection between two different port types previously allowed by [method add_valid_connection_type]. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method.
* See also [method is_valid_connection_type].
*/
remove_valid_connection_type(from_type: int64, to_type: int64): void
/** Returns whether it's possible to make a connection between two different port types. The port type is defined individually for the left and the right port of each slot with the [method GraphNode.set_slot] method.
* See also [method add_valid_connection_type] and [method remove_valid_connection_type].
*/
is_valid_connection_type(from_type: int64, to_type: int64): boolean
/** Returns the points which would make up a connection between [param from_node] and [param to_node]. */
get_connection_line(from_node: Vector2, to_node: Vector2): PackedVector2Array
/** Attaches the [param element] [GraphElement] to the [param frame] [GraphFrame]. */
attach_graph_element_to_frame(element: StringName, frame: StringName): void
/** Detaches the [param element] [GraphElement] from the [GraphFrame] it is currently attached to. */
detach_graph_element_from_frame(element: StringName): void
/** Returns the [GraphFrame] that contains the [GraphElement] with the given name. */
get_element_frame(element: StringName): null | GraphFrame
/** Returns an array of node names that are attached to the [GraphFrame] with the given name. */
get_attached_nodes_of_frame(frame: StringName): GArray<StringName>
/** Gets the [HBoxContainer] that contains the zooming and grid snap controls in the top left of the graph. You can use this method to reposition the toolbar or to add your own custom controls to it.
* **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
*/
get_menu_hbox(): null | HBoxContainer
/** Rearranges selected nodes in a layout with minimum crossings between connections and uniform horizontal and vertical gap between nodes. */
arrange_nodes(): void
/** Sets the specified [param node] as the one selected. */
set_selected(node: Node): void
/** The scroll offset. */
get scroll_offset(): Vector2
set scroll_offset(value: Vector2)
/** If `true`, the grid is visible. */
get show_grid(): boolean
set show_grid(value: boolean)
/** The pattern used for drawing the grid. */
get grid_pattern(): int64
set grid_pattern(value: int64)
/** If `true`, enables snapping. */
get snapping_enabled(): boolean
set snapping_enabled(value: boolean)
/** The snapping distance in pixels, also determines the grid line distance. */
get snapping_distance(): int64
set snapping_distance(value: int64)
/** Defines the control scheme for panning with mouse wheel. */
get panning_scheme(): int64
set panning_scheme(value: int64)
/** If `true`, enables disconnection of existing connections in the GraphEdit by dragging the right end. */
get right_disconnects(): boolean
set right_disconnects(value: boolean)
/** [Dictionary] of human readable port type names. */
get type_names(): GDictionary<Record<int64, int64>>
set type_names(value: GDictionary<Record<int64, int64>>)
/** The curvature of the lines between the nodes. 0 results in straight lines. */
get connection_lines_curvature(): float64
set connection_lines_curvature(value: float64)
/** The thickness of the lines between the nodes. */
get connection_lines_thickness(): float64
set connection_lines_thickness(value: float64)
/** If `true`, the lines between nodes will use antialiasing. */
get connection_lines_antialiased(): boolean
set connection_lines_antialiased(value: boolean)
/** The connections between [GraphNode]s.
* A connection is represented as a [Dictionary] in the form of:
*
* Connections with `keep_alive` set to `false` may be deleted automatically if invalid during a redraw.
*/
get connections(): GArray<any /**/>
set connections(value: GArray<any /**/>)
/** The current zoom value. */
get zoom(): float64
set zoom(value: float64)
/** The lower zoom limit. */
get zoom_min(): float64
set zoom_min(value: float64)
/** The upper zoom limit. */
get zoom_max(): float64
set zoom_max(value: float64)
/** The step of each zoom level. */
get zoom_step(): float64
set zoom_step(value: float64)
/** If `true`, the minimap is visible. */
get minimap_enabled(): boolean
set minimap_enabled(value: boolean)
/** The size of the minimap rectangle. The map itself is based on the size of the grid area and is scaled to fit this rectangle. */
get minimap_size(): Vector2
set minimap_size(value: Vector2)
/** The opacity of the minimap rectangle. */
get minimap_opacity(): float64
set minimap_opacity(value: float64)
/** If `true`, the menu toolbar is visible. */
get show_menu(): boolean
set show_menu(value: boolean)
/** If `true`, the label with the current zoom level is visible. The zoom level is displayed in percents. */
get show_zoom_label(): boolean
set show_zoom_label(value: boolean)
/** If `true`, buttons that allow to change and reset the zoom level are visible. */
get show_zoom_buttons(): boolean
set show_zoom_buttons(value: boolean)
/** If `true`, buttons that allow to configure grid and snapping options are visible. */
get show_grid_buttons(): boolean
set show_grid_buttons(value: boolean)
/** If `true`, the button to toggle the minimap is visible. */
get show_minimap_button(): boolean
set show_minimap_button(value: boolean)
/** If `true`, the button to automatically arrange graph nodes is visible. */
get show_arrange_button(): boolean
set show_arrange_button(value: boolean)
/** Emitted to the GraphEdit when the connection between the [param from_port] of the [param from_node] [GraphNode] and the [param to_port] of the [param to_node] [GraphNode] is attempted to be created. */
readonly connection_request: Signal<(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64) => void>
/** Emitted to the GraphEdit when the connection between [param from_port] of [param from_node] [GraphNode] and [param to_port] of [param to_node] [GraphNode] is attempted to be removed. */
readonly disconnection_request: Signal<(from_node: StringName, from_port: int64, to_node: StringName, to_port: int64) => void>
/** Emitted when user drags a connection from an output port into the empty space of the graph. */
readonly connection_to_empty: Signal<(from_node: StringName, from_port: int64, release_position: Vector2) => void>
/** Emitted when user drags a connection from an input port into the empty space of the graph. */
readonly connection_from_empty: Signal<(to_node: StringName, to_port: int64, release_position: Vector2) => void>
/** Emitted at the beginning of a connection drag. */
readonly connection_drag_started: Signal<(from_node: StringName, from_port: int64, is_output: boolean) => void>
/** Emitted at the end of a connection drag. */
readonly connection_drag_ended: Signal<() => void>
/** Emitted when this [GraphEdit] captures a `ui_copy` action ([kbd]Ctrl + C[/kbd] by default). In general, this signal indicates that the selected [GraphElement]s should be copied. */
readonly copy_nodes_request: Signal<() => void>
/** Emitted when this [GraphEdit] captures a `ui_cut` action ([kbd]Ctrl + X[/kbd] by default). In general, this signal indicates that the selected [GraphElement]s should be cut. */
readonly cut_nodes_request: Signal<() => void>
/** Emitted when this [GraphEdit] captures a `ui_paste` action ([kbd]Ctrl + V[/kbd] by default). In general, this signal indicates that previously copied [GraphElement]s should be pasted. */
readonly paste_nodes_request: Signal<() => void>
/** Emitted when this [GraphEdit] captures a `ui_graph_duplicate` action ([kbd]Ctrl + D[/kbd] by default). In general, this signal indicates that the selected [GraphElement]s should be duplicated. */
readonly duplicate_nodes_request: Signal<() => void>
/** Emitted when this [GraphEdit] captures a `ui_graph_delete` action ([kbd]Delete[/kbd] by default).
* [param nodes] is an array of node names that should be removed. These usually include all selected nodes.
*/
readonly delete_nodes_request: Signal<(nodes: GArray<StringName>) => void>
/** Emitted when the given [GraphElement] node is selected. */
readonly node_selected: Signal<(node: Node) => void>
/** Emitted when the given [GraphElement] node is deselected. */
readonly node_deselected: Signal<(node: Node) => void>
/** Emitted when the [GraphFrame] [param frame] is resized to [param new_rect]. */
readonly frame_rect_changed: Signal<(frame: GraphFrame, new_rect: Rect2) => void>
/** Emitted when a popup is requested. Happens on right-clicking in the GraphEdit. [param at_position] is the position of the mouse pointer when the signal is sent. */
readonly popup_request: Signal<(at_position: Vector2) => void>
/** Emitted at the beginning of a [GraphElement]'s movement. */
readonly begin_node_move: Signal<() => void>
/** Emitted at the end of a [GraphElement]'s movement. */
readonly end_node_move: Signal<() => void>
/** Emitted when one or more [GraphElement]s are dropped onto the [GraphFrame] named [param frame], when they were not previously attached to any other one.
* [param elements] is an array of [GraphElement]s to be attached.
*/
readonly graph_elements_linked_to_frame_request: Signal<(elements: GArray, frame: StringName) => void>
/** Emitted when the scroll offset is changed by the user. It will not be emitted when changed in code. */
readonly scroll_offset_changed: Signal<(offset: Vector2) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGraphEdit;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGraphElement extends __NameMapContainer {
}
/** A container that represents a basic element that can be placed inside a [GraphEdit] control.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_graphelement.html
*/
class GraphElement<Map extends NodePathMap = any> extends Container<Map> {
constructor(identifier?: any)
/** The offset of the GraphElement, relative to the scroll offset of the [GraphEdit]. */
get position_offset(): Vector2
set position_offset(value: Vector2)
/** If `true`, the user can resize the GraphElement.
*
* **Note:** Dragging the handle will only emit the [signal resize_request] and [signal resize_end] signals, the GraphElement needs to be resized manually.
*/
get resizable(): boolean
set resizable(value: boolean)
/** If `true`, the user can drag the GraphElement. */
get draggable(): boolean
set draggable(value: boolean)
/** If `true`, the user can select the GraphElement. */
get selectable(): boolean
set selectable(value: boolean)
/** If `true`, the GraphElement is selected. */
get selected(): boolean
set selected(value: boolean)
/** Emitted when the GraphElement is selected. */
readonly node_selected: Signal<() => void>
/** Emitted when the GraphElement is deselected. */
readonly node_deselected: Signal<() => void>
/** Emitted when displaying the GraphElement over other ones is requested. Happens on focusing (clicking into) the GraphElement. */
readonly raise_request: Signal<() => void>
/** Emitted when removing the GraphElement is requested. */
readonly delete_request: Signal<() => void>
/** Emitted when resizing the GraphElement is requested. Happens on dragging the resizer handle (see [member resizable]). */
readonly resize_request: Signal<(new_size: Vector2) => void>
/** Emitted when releasing the mouse button after dragging the resizer handle (see [member resizable]). */
readonly resize_end: Signal<(new_size: Vector2) => void>
/** Emitted when the GraphElement is dragged. */
readonly dragged: Signal<(from: Vector2, to: Vector2) => void>
/** Emitted when the GraphElement is moved. */
readonly position_offset_changed: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGraphElement;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGraphFrame extends __NameMapGraphElement {
}
/** GraphFrame is a special [GraphElement] that can be used to organize other [GraphElement]s inside a [GraphEdit].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_graphframe.html
*/
class GraphFrame<Map extends NodePathMap = any> extends GraphElement<Map> {
constructor(identifier?: any)
/** Returns the [HBoxContainer] used for the title bar, only containing a [Label] for displaying the title by default.
* This can be used to add custom controls to the title bar such as option or close buttons.
*/
get_titlebar_hbox(): null | HBoxContainer
/** Title of the frame. */
get title(): string
set title(value: string)
/** If `true`, the frame's rect will be adjusted automatically to enclose all attached [GraphElement]s. */
get autoshrink_enabled(): boolean
set autoshrink_enabled(value: boolean)
/** The margin around the attached nodes that is used to calculate the size of the frame when [member autoshrink_enabled] is `true`. */
get autoshrink_margin(): int64
set autoshrink_margin(value: int64)
/** The margin inside the frame that can be used to drag the frame. */
get drag_margin(): int64
set drag_margin(value: int64)
/** If `true`, the tint color will be used to tint the frame. */
get tint_color_enabled(): boolean
set tint_color_enabled(value: boolean)
/** The color of the frame when [member tint_color_enabled] is `true`. */
get tint_color(): Color
set tint_color(value: Color)
/** Emitted when [member autoshrink_enabled] or [member autoshrink_margin] changes. */
readonly autoshrink_changed: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGraphFrame;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGraphNode extends __NameMapGraphElement {
}
/** A container with connection ports, representing a node in a [GraphEdit].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_graphnode.html
*/
class GraphNode<Map extends NodePathMap = any> extends GraphElement<Map> {
constructor(identifier?: any)
/* gdvirtual */ _draw_port(slot_index: int64, position: Vector2i, left: boolean, color: Color): void
/** Returns the [HBoxContainer] used for the title bar, only containing a [Label] for displaying the title by default. This can be used to add custom controls to the title bar such as option or close buttons. */
get_titlebar_hbox(): null | HBoxContainer
/** Sets properties of the slot with the given [param slot_index].
* If [param enable_left_port]/[param enable_right_port] is `true`, a port will appear and the slot will be able to be connected from this side.
* With [param type_left]/[param type_right] an arbitrary type can be assigned to each port. Two ports can be connected if they share the same type, or if the connection between their types is allowed in the parent [GraphEdit] (see [method GraphEdit.add_valid_connection_type]). Keep in mind that the [GraphEdit] has the final say in accepting the connection. Type compatibility simply allows the [signal GraphEdit.connection_request] signal to be emitted.
* Ports can be further customized using [param color_left]/[param color_right] and [param custom_icon_left]/[param custom_icon_right]. The color parameter adds a tint to the icon. The custom icon can be used to override the default port dot.
* Additionally, [param draw_stylebox] can be used to enable or disable drawing of the background stylebox for each slot. See [theme_item slot].
* Individual properties can also be set using one of the `set_slot_*` methods.
*
* **Note:** This method only sets properties of the slot. To create the slot itself, add a [Control]-derived child to the GraphNode.
*/
set_slot(slot_index: int64, enable_left_port: boolean, type_left: int64, color_left: Color, enable_right_port: boolean, type_right: int64, color_right: Color, custom_icon_left?: Texture2D /* = undefined */, custom_icon_right?: Texture2D /* = undefined */, draw_stylebox?: boolean /* = true */): void
/** Disables the slot with the given [param slot_index]. This will remove the corresponding input and output port from the GraphNode. */
clear_slot(slot_index: int64): void
/** Disables all slots of the GraphNode. This will remove all input/output ports from the GraphNode. */
clear_all_slots(): void
/** Returns `true` if left (input) side of the slot with the given [param slot_index] is enabled. */
is_slot_enabled_left(slot_index: int64): boolean
/** Toggles the left (input) side of the slot with the given [param slot_index]. If [param enable] is `true`, a port will appear on the left side and the slot will be able to be connected from this side. */
set_slot_enabled_left(slot_index: int64, enable: boolean): void
/** Sets the left (input) type of the slot with the given [param slot_index] to [param type]. If the value is negative, all connections will be disallowed to be created via user inputs. */
set_slot_type_left(slot_index: int64, type: int64): void
/** Returns the left (input) type of the slot with the given [param slot_index]. */
get_slot_type_left(slot_index: int64): int64
/** Sets the [Color] of the left (input) side of the slot with the given [param slot_index] to [param color]. */
set_slot_color_left(slot_index: int64, color: Color): void
/** Returns the left (input) [Color] of the slot with the given [param slot_index]. */
get_slot_color_left(slot_index: int64): Color
/** Sets the custom [Texture2D] of the left (input) side of the slot with the given [param slot_index] to [param custom_icon]. */
set_slot_custom_icon_left(slot_index: int64, custom_icon: Texture2D): void
/** Returns the left (input) custom [Texture2D] of the slot with the given [param slot_index]. */
get_slot_custom_icon_left(slot_index: int64): null | Texture2D
/** Returns `true` if right (output) side of the slot with the given [param slot_index] is enabled. */
is_slot_enabled_right(slot_index: int64): boolean
/** Toggles the right (output) side of the slot with the given [param slot_index]. If [param enable] is `true`, a port will appear on the right side and the slot will be able to be connected from this side. */
set_slot_enabled_right(slot_index: int64, enable: boolean): void
/** Sets the right (output) type of the slot with the given [param slot_index] to [param type]. If the value is negative, all connections will be disallowed to be created via user inputs. */
set_slot_type_right(slot_index: int64, type: int64): void
/** Returns the right (output) type of the slot with the given [param slot_index]. */
get_slot_type_right(slot_index: int64): int64
/** Sets the [Color] of the right (output) side of the slot with the given [param slot_index] to [param color]. */
set_slot_color_right(slot_index: int64, color: Color): void
/** Returns the right (output) [Color] of the slot with the given [param slot_index]. */
get_slot_color_right(slot_index: int64): Color
/** Sets the custom [Texture2D] of the right (output) side of the slot with the given [param slot_index] to [param custom_icon]. */
set_slot_custom_icon_right(slot_index: int64, custom_icon: Texture2D): void
/** Returns the right (output) custom [Texture2D] of the slot with the given [param slot_index]. */
get_slot_custom_icon_right(slot_index: int64): null | Texture2D
/** Returns `true` if the background [StyleBox] of the slot with the given [param slot_index] is drawn. */
is_slot_draw_stylebox(slot_index: int64): boolean
/** Toggles the background [StyleBox] of the slot with the given [param slot_index]. */
set_slot_draw_stylebox(slot_index: int64, enable: boolean): void
/** Returns the number of slots with an enabled input port. */
get_input_port_count(): int64
/** Returns the position of the input port with the given [param port_idx]. */
get_input_port_position(port_idx: int64): Vector2
/** Returns the type of the input port with the given [param port_idx]. */
get_input_port_type(port_idx: int64): int64
/** Returns the [Color] of the input port with the given [param port_idx]. */
get_input_port_color(port_idx: int64): Color
/** Returns the corresponding slot index of the input port with the given [param port_idx]. */
get_input_port_slot(port_idx: int64): int64
/** Returns the number of slots with an enabled output port. */
get_output_port_count(): int64
/** Returns the position of the output port with the given [param port_idx]. */
get_output_port_position(port_idx: int64): Vector2
/** Returns the type of the output port with the given [param port_idx]. */
get_output_port_type(port_idx: int64): int64
/** Returns the [Color] of the output port with the given [param port_idx]. */
get_output_port_color(port_idx: int64): Color
/** Returns the corresponding slot index of the output port with the given [param port_idx]. */
get_output_port_slot(port_idx: int64): int64
/** The text displayed in the GraphNode's title bar. */
get title(): string
set title(value: string)
/** If `true`, you can connect ports with different types, even if the connection was not explicitly allowed in the parent [GraphEdit]. */
get ignore_invalid_connection_type(): boolean
set ignore_invalid_connection_type(value: boolean)
/** Determines how connection slots can be focused.
* - If set to [constant Control.FOCUS_CLICK], connections can only be made with the mouse.
* - If set to [constant Control.FOCUS_ALL], slots can also be focused using the [member ProjectSettings.input/ui_up] and [member ProjectSettings.input/ui_down] and connected using [member ProjectSettings.input/ui_left] and [member ProjectSettings.input/ui_right] input actions.
* - If set to [constant Control.FOCUS_ACCESSIBILITY], slot input actions are only enabled when the screen reader is active.
*/
get slots_focus_mode(): int64
set slots_focus_mode(value: int64)
/** Emitted when any GraphNode's slot is updated. */
readonly slot_updated: Signal<(slot_index: int64) => void>
/** Emitted when any slot's size might have changed. */
readonly slot_sizes_changed: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGraphNode;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGridContainer extends __NameMapContainer {
}
/** A container that arranges its child controls in a grid layout.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_gridcontainer.html
*/
class GridContainer<Map extends NodePathMap = any> extends Container<Map> {
constructor(identifier?: any)
/** The number of columns in the [GridContainer]. If modified, [GridContainer] reorders its Control-derived children to accommodate the new layout. */
get columns(): int64
set columns(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGridContainer;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGridMap extends __NameMapNode3D {
}
/** Node for 3D tile-based maps.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_gridmap.html
*/
class GridMap<Map extends NodePathMap = any> extends Node3D<Map> {
/** Invalid cell item that can be used in [method set_cell_item] to clear cells (or represent an empty cell in [method get_cell_item]). */
static readonly INVALID_CELL_ITEM = -1
constructor(identifier?: any)
/** Based on [param value], enables or disables the specified layer in the [member collision_mask], given a [param layer_number] between 1 and 32. */
set_collision_mask_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member collision_mask] is enabled, given a [param layer_number] between 1 and 32. */
get_collision_mask_value(layer_number: int64): boolean
/** Based on [param value], enables or disables the specified layer in the [member collision_layer], given a [param layer_number] between 1 and 32. */
set_collision_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member collision_layer] is enabled, given a [param layer_number] between 1 and 32. */
get_collision_layer_value(layer_number: int64): boolean
/** Sets the [RID] of the navigation map this GridMap node should use for its cell baked navigation meshes. */
set_navigation_map(navigation_map: RID): void
/** Returns the [RID] of the navigation map this GridMap node uses for its cell baked navigation meshes.
* This function returns always the map set on the GridMap node and not the map on the NavigationServer. If the map is changed directly with the NavigationServer API the GridMap node will not be aware of the map change.
*/
get_navigation_map(): RID
/** Sets the mesh index for the cell referenced by its grid coordinates.
* A negative item index such as [constant INVALID_CELL_ITEM] will clear the cell.
* Optionally, the item's orientation can be passed. For valid orientation values, see [method get_orthogonal_index_from_basis].
*/
set_cell_item(position: Vector3i, item: int64, orientation?: int64 /* = 0 */): void
/** The [MeshLibrary] item index located at the given grid coordinates. If the cell is empty, [constant INVALID_CELL_ITEM] will be returned. */
get_cell_item(position: Vector3i): int64
/** The orientation of the cell at the given grid coordinates. `-1` is returned if the cell is empty. */
get_cell_item_orientation(position: Vector3i): int64
/** Returns the basis that gives the specified cell its orientation. */
get_cell_item_basis(position: Vector3i): Basis
/** Returns one of 24 possible rotations that lie along the vectors (x,y,z) with each component being either -1, 0, or 1. For further details, refer to the Godot source code. */
get_basis_with_orthogonal_index(index: int64): Basis
/** This function considers a discretization of rotations into 24 points on unit sphere, lying along the vectors (x,y,z) with each component being either -1, 0, or 1, and returns the index (in the range from 0 to 23) of the point best representing the orientation of the object. For further details, refer to the Godot source code. */
get_orthogonal_index_from_basis(basis: Basis): int64
/** Returns the map coordinates of the cell containing the given [param local_position]. If [param local_position] is in global coordinates, consider using [method Node3D.to_local] before passing it to this method. See also [method map_to_local]. */
local_to_map(local_position: Vector3): Vector3i
/** Returns the position of a grid cell in the GridMap's local coordinate space. To convert the returned value into global coordinates, use [method Node3D.to_global]. See also [method local_to_map]. */
map_to_local(map_position: Vector3i): Vector3
/** This method does nothing. */
resource_changed(resource: Resource): void
/** Clear all cells. */
clear(): void
/** Returns an array of [Vector3] with the non-empty cell coordinates in the grid map. */
get_used_cells(): GArray<Vector3i>
/** Returns an array of all cells with the given item index specified in [param item]. */
get_used_cells_by_item(item: int64): GArray<Vector3i>
/** Returns an array of [Transform3D] and [Mesh] references corresponding to the non-empty cells in the grid. The transforms are specified in local space. Even indices contain [Transform3D]s, while odd indices contain [Mesh]es related to the [Transform3D] in the index preceding it. */
get_meshes(): GArray
/** Returns an array of [ArrayMesh]es and [Transform3D] references of all bake meshes that exist within the current GridMap. Even indices contain [ArrayMesh]es, while odd indices contain [Transform3D]s that are always equal to [constant Transform3D.IDENTITY].
* This method relies on the output of [method make_baked_meshes], which will be called with `gen_lightmap_uv` set to `true` and `lightmap_uv_texel_size` set to `0.1` if it hasn't been called yet.
*/
get_bake_meshes(): GArray
/** Returns [RID] of a baked mesh with the given [param idx]. */
get_bake_mesh_instance(idx: int64): RID
/** Clears all baked meshes. See [method make_baked_meshes]. */
clear_baked_meshes(): void
/** Generates a baked mesh that represents all meshes in the assigned [MeshLibrary] for use with [LightmapGI]. If [param gen_lightmap_uv] is `true`, UV2 data will be generated for each mesh currently used in the [GridMap]. Otherwise, only meshes that already have UV2 data present will be able to use baked lightmaps. When generating UV2, [param lightmap_uv_texel_size] controls the texel density for lightmaps, with lower values resulting in more detailed lightmaps. [param lightmap_uv_texel_size] is ignored if [param gen_lightmap_uv] is `false`. See also [method get_bake_meshes], which relies on the output of this method.
*
* **Note:** Calling this method will not actually bake lightmaps, as lightmap baking is performed using the [LightmapGI] node.
*/
make_baked_meshes(gen_lightmap_uv?: boolean /* = false */, lightmap_uv_texel_size?: float64 /* = 0.1 */): void
/** The assigned [MeshLibrary]. */
get mesh_library(): null | MeshLibrary
set mesh_library(value: null | MeshLibrary)
/** Overrides the default friction and bounce physics properties for the whole [GridMap]. */
get physics_material(): null | PhysicsMaterial
set physics_material(value: null | PhysicsMaterial)
/** The dimensions of the grid's cells.
* This does not affect the size of the meshes. See [member cell_scale].
*/
get cell_size(): Vector3
set cell_size(value: Vector3)
/** The size of each octant measured in number of cells. This applies to all three axis. */
get cell_octant_size(): int64
set cell_octant_size(value: int64)
/** If `true`, grid items are centered on the X axis. */
get cell_center_x(): boolean
set cell_center_x(value: boolean)
/** If `true`, grid items are centered on the Y axis. */
get cell_center_y(): boolean
set cell_center_y(value: boolean)
/** If `true`, grid items are centered on the Z axis. */
get cell_center_z(): boolean
set cell_center_z(value: boolean)
/** The scale of the cell items.
* This does not affect the size of the grid cells themselves, only the items in them. This can be used to make cell items overlap their neighbors.
*/
get cell_scale(): float64
set cell_scale(value: float64)
/** The physics layers this GridMap is in.
* GridMaps act as static bodies, meaning they aren't affected by gravity or other forces. They only affect other physics bodies that collide with them.
*/
get collision_layer(): int64
set collision_layer(value: int64)
/** The physics layers this GridMap detects collisions in. See [url=https://docs.godotengine.org/en/4.5/tutorials/physics/physics_introduction.html#collision-layers-and-masks]Collision layers and masks[/url] in the documentation for more information. */
get collision_mask(): int64
set collision_mask(value: int64)
/** The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level. */
get collision_priority(): float64
set collision_priority(value: float64)
/** If `true`, this GridMap creates a navigation region for each cell that uses a [member mesh_library] item with a navigation mesh. The created navigation region will use the navigation layers bitmask assigned to the [MeshLibrary]'s item. */
get bake_navigation(): boolean
set bake_navigation(value: boolean)
/** Emitted when [member cell_size] changes. */
readonly cell_size_changed: Signal<(cell_size: Vector3) => void>
/** Emitted when the [MeshLibrary] of this GridMap changes. */
readonly changed: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGridMap;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGridMapEditorPlugin extends __NameMapEditorPlugin {
}
/** Editor for [GridMap] nodes.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_gridmapeditorplugin.html
*/
class GridMapEditorPlugin<Map extends NodePathMap = any> extends EditorPlugin<Map> {
constructor(identifier?: any)
/** Returns the [GridMap] node currently edited by the grid map editor. */
get_current_grid_map(): null | GridMap
/** Selects the cells inside the given bounds from [param begin] to [param end]. */
set_selection(begin: Vector3i, end: Vector3i): void
/** Deselects any currently selected cells. */
clear_selection(): void
/** Returns the cell coordinate bounds of the current selection. Use [method has_selection] to check if there is an active selection. */
get_selection(): AABB
/** Returns `true` if there are selected cells. */
has_selection(): boolean
/** Returns an array of [Vector3i]s with the selected cells' coordinates. */
get_selected_cells(): GArray
/** Selects the [MeshLibrary] item with the given index in the grid map editor's palette. If a negative index is given, no item will be selected. If a value greater than the last index is given, the last item will be selected.
*
* **Note:** The indices might not be in the same order as they appear in the editor's interface.
*/
set_selected_palette_item(item: int64): void
/** Returns the index of the selected [MeshLibrary] item in the grid map editor's palette or `-1` if no item is selected.
*
* **Note:** The indices might not be in the same order as they appear in the editor's interface.
*/
get_selected_palette_item(): int64
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGridMapEditorPlugin;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapGrooveJoint2D extends __NameMapJoint2D {
}
/** A physics joint that restricts the movement of two 2D physics bodies to a fixed axis.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_groovejoint2d.html
*/
class GrooveJoint2D<Map extends NodePathMap = any> extends Joint2D<Map> {
constructor(identifier?: any)
/** The groove's length. The groove is from the joint's origin towards [member length] along the joint's local Y axis. */
get length(): float64
set length(value: float64)
/** The body B's initial anchor position defined by the joint's origin and a local offset [member initial_offset] along the joint's Y axis (along the groove). */
get initial_offset(): float64
set initial_offset(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapGrooveJoint2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHBoxContainer extends __NameMapBoxContainer {
}
/** A container that arranges its child controls horizontally.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hboxcontainer.html
*/
class HBoxContainer<Map extends NodePathMap = any> extends BoxContainer<Map> {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHBoxContainer;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHFlowContainer extends __NameMapFlowContainer {
}
/** A container that arranges its child controls horizontally and wraps them around at the borders.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hflowcontainer.html
*/
class HFlowContainer<Map extends NodePathMap = any> extends FlowContainer<Map> {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHFlowContainer;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHMACContext extends __NameMapRefCounted {
}
/** Used to create an HMAC for a message using a key.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hmaccontext.html
*/
class HMACContext extends RefCounted {
constructor(identifier?: any)
/** Initializes the HMACContext. This method cannot be called again on the same HMACContext until [method finish] has been called. */
start(hash_type: HashingContext.HashType, key: PackedByteArray | byte[] | ArrayBuffer): Error
/** Updates the message to be HMACed. This can be called multiple times before [method finish] is called to append [param data] to the message, but cannot be called until [method start] has been called. */
update(data: PackedByteArray | byte[] | ArrayBuffer): Error
/** Returns the resulting HMAC. If the HMAC failed, an empty [PackedByteArray] is returned. */
finish(): PackedByteArray
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHMACContext;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHScrollBar extends __NameMapScrollBar {
}
/** A horizontal scrollbar that goes from left (min) to right (max).
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hscrollbar.html
*/
class HScrollBar<Map extends NodePathMap = any> extends ScrollBar<Map> {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHScrollBar;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHSeparator extends __NameMapSeparator {
}
/** A horizontal line used for separating other controls.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hseparator.html
*/
class HSeparator<Map extends NodePathMap = any> extends Separator<Map> {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHSeparator;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHSlider extends __NameMapSlider {
}
/** A horizontal slider that goes from left (min) to right (max).
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hslider.html
*/
class HSlider<Map extends NodePathMap = any> extends Slider<Map> {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHSlider;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHSplitContainer extends __NameMapSplitContainer {
}
/** A container that splits two child controls horizontally and provides a grabber for adjusting the split ratio.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hsplitcontainer.html
*/
class HSplitContainer<Map extends NodePathMap = any> extends SplitContainer<Map> {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHSplitContainer;
}
namespace HTTPClient {
enum Method {
/** HTTP GET method. The GET method requests a representation of the specified resource. Requests using GET should only retrieve data. */
METHOD_GET = 0,
/** HTTP HEAD method. The HEAD method asks for a response identical to that of a GET request, but without the response body. This is useful to request metadata like HTTP headers or to check if a resource exists. */
METHOD_HEAD = 1,
/** HTTP POST method. The POST method is used to submit an entity to the specified resource, often causing a change in state or side effects on the server. This is often used for forms and submitting data or uploading files. */
METHOD_POST = 2,
/** HTTP PUT method. The PUT method asks to replace all current representations of the target resource with the request payload. (You can think of POST as "create or update" and PUT as "update", although many services tend to not make a clear distinction or change their meaning). */
METHOD_PUT = 3,
/** HTTP DELETE method. The DELETE method requests to delete the specified resource. */
METHOD_DELETE = 4,
/** HTTP OPTIONS method. The OPTIONS method asks for a description of the communication options for the target resource. Rarely used. */
METHOD_OPTIONS = 5,
/** HTTP TRACE method. The TRACE method performs a message loop-back test along the path to the target resource. Returns the entire HTTP request received in the response body. Rarely used. */
METHOD_TRACE = 6,
/** HTTP CONNECT method. The CONNECT method establishes a tunnel to the server identified by the target resource. Rarely used. */
METHOD_CONNECT = 7,
/** HTTP PATCH method. The PATCH method is used to apply partial modifications to a resource. */
METHOD_PATCH = 8,
/** Represents the size of the [enum Method] enum. */
METHOD_MAX = 9,
}
enum Status {
/** Status: Disconnected from the server. */
STATUS_DISCONNECTED = 0,
/** Status: Currently resolving the hostname for the given URL into an IP. */
STATUS_RESOLVING = 1,
/** Status: DNS failure: Can't resolve the hostname for the given URL. */
STATUS_CANT_RESOLVE = 2,
/** Status: Currently connecting to server. */
STATUS_CONNECTING = 3,
/** Status: Can't connect to the server. */
STATUS_CANT_CONNECT = 4,
/** Status: Connection established. */
STATUS_CONNECTED = 5,
/** Status: Currently sending request. */
STATUS_REQUESTING = 6,
/** Status: HTTP body received. */
STATUS_BODY = 7,
/** Status: Error in HTTP connection. */
STATUS_CONNECTION_ERROR = 8,
/** Status: Error in TLS handshake. */
STATUS_TLS_HANDSHAKE_ERROR = 9,
}
enum ResponseCode {
/** HTTP status code `100 Continue`. Interim response that indicates everything so far is OK and that the client should continue with the request (or ignore this status if already finished). */
RESPONSE_CONTINUE = 100,
/** HTTP status code `101 Switching Protocol`. Sent in response to an `Upgrade` request header by the client. Indicates the protocol the server is switching to. */
RESPONSE_SWITCHING_PROTOCOLS = 101,
/** HTTP status code `102 Processing` (WebDAV). Indicates that the server has received and is processing the request, but no response is available yet. */
RESPONSE_PROCESSING = 102,
/** HTTP status code `200 OK`. The request has succeeded. Default response for successful requests. Meaning varies depending on the request:
* - [constant METHOD_GET]: The resource has been fetched and is transmitted in the message body.
* - [constant METHOD_HEAD]: The entity headers are in the message body.
* - [constant METHOD_POST]: The resource describing the result of the action is transmitted in the message body.
* - [constant METHOD_TRACE]: The message body contains the request message as received by the server.
*/
RESPONSE_OK = 200,
/** HTTP status code `201 Created`. The request has succeeded and a new resource has been created as a result of it. This is typically the response sent after a PUT request. */
RESPONSE_CREATED = 201,
/** HTTP status code `202 Accepted`. The request has been received but not yet acted upon. It is non-committal, meaning that there is no way in HTTP to later send an asynchronous response indicating the outcome of processing the request. It is intended for cases where another process or server handles the request, or for batch processing. */
RESPONSE_ACCEPTED = 202,
/** HTTP status code `203 Non-Authoritative Information`. This response code means returned meta-information set is not exact set as available from the origin server, but collected from a local or a third party copy. Except this condition, 200 OK response should be preferred instead of this response. */
RESPONSE_NON_AUTHORITATIVE_INFORMATION = 203,
/** HTTP status code `204 No Content`. There is no content to send for this request, but the headers may be useful. The user-agent may update its cached headers for this resource with the new ones. */
RESPONSE_NO_CONTENT = 204,
/** HTTP status code `205 Reset Content`. The server has fulfilled the request and desires that the client resets the "document view" that caused the request to be sent to its original state as received from the origin server. */
RESPONSE_RESET_CONTENT = 205,
/** HTTP status code `206 Partial Content`. This response code is used because of a range header sent by the client to separate download into multiple streams. */
RESPONSE_PARTIAL_CONTENT = 206,
/** HTTP status code `207 Multi-Status` (WebDAV). A Multi-Status response conveys information about multiple resources in situations where multiple status codes might be appropriate. */
RESPONSE_MULTI_STATUS = 207,
/** HTTP status code `208 Already Reported` (WebDAV). Used inside a DAV: propstat response element to avoid enumerating the internal members of multiple bindings to the same collection repeatedly. */
RESPONSE_ALREADY_REPORTED = 208,
/** HTTP status code `226 IM Used` (WebDAV). The server has fulfilled a GET request for the resource, and the response is a representation of the result of one or more instance-manipulations applied to the current instance. */
RESPONSE_IM_USED = 226,
/** HTTP status code `300 Multiple Choice`. The request has more than one possible responses and there is no standardized way to choose one of the responses. User-agent or user should choose one of them. */
RESPONSE_MULTIPLE_CHOICES = 300,
/** HTTP status code `301 Moved Permanently`. Redirection. This response code means the URI of requested resource has been changed. The new URI is usually included in the response. */
RESPONSE_MOVED_PERMANENTLY = 301,
/** HTTP status code `302 Found`. Temporary redirection. This response code means the URI of requested resource has been changed temporarily. New changes in the URI might be made in the future. Therefore, this same URI should be used by the client in future requests. */
RESPONSE_FOUND = 302,
/** HTTP status code `303 See Other`. The server is redirecting the user agent to a different resource, as indicated by a URI in the Location header field, which is intended to provide an indirect response to the original request. */
RESPONSE_SEE_OTHER = 303,
/** HTTP status code `304 Not Modified`. A conditional GET or HEAD request has been received and would have resulted in a 200 OK response if it were not for the fact that the condition evaluated to `false`. */
RESPONSE_NOT_MODIFIED = 304,
/** HTTP status code `305 Use Proxy`. */
RESPONSE_USE_PROXY = 305,
/** HTTP status code `306 Switch Proxy`. */
RESPONSE_SWITCH_PROXY = 306,
/** HTTP status code `307 Temporary Redirect`. The target resource resides temporarily under a different URI and the user agent MUST NOT change the request method if it performs an automatic redirection to that URI. */
RESPONSE_TEMPORARY_REDIRECT = 307,
/** HTTP status code `308 Permanent Redirect`. The target resource has been assigned a new permanent URI and any future references to this resource ought to use one of the enclosed URIs. */
RESPONSE_PERMANENT_REDIRECT = 308,
/** HTTP status code `400 Bad Request`. The request was invalid. The server cannot or will not process the request due to something that is perceived to be a client error (e.g., malformed request syntax, invalid request message framing, invalid request contents, or deceptive request routing). */
RESPONSE_BAD_REQUEST = 400,
/** HTTP status code `401 Unauthorized`. Credentials required. The request has not been applied because it lacks valid authentication credentials for the target resource. */
RESPONSE_UNAUTHORIZED = 401,
/** HTTP status code `402 Payment Required`. This response code is reserved for future use. Initial aim for creating this code was using it for digital payment systems, however this is not currently used. */
RESPONSE_PAYMENT_REQUIRED = 402,
/** HTTP status code `403 Forbidden`. The client does not have access rights to the content, i.e. they are unauthorized, so server is rejecting to give proper response. Unlike `401`, the client's identity is known to the server. */
RESPONSE_FORBIDDEN = 403,
/** HTTP status code `404 Not Found`. The server can not find requested resource. Either the URL is not recognized or the endpoint is valid but the resource itself does not exist. May also be sent instead of 403 to hide existence of a resource if the client is not authorized. */
RESPONSE_NOT_FOUND = 404,
/** HTTP status code `405 Method Not Allowed`. The request's HTTP method is known by the server but has been disabled and cannot be used. For example, an API may forbid DELETE-ing a resource. The two mandatory methods, GET and HEAD, must never be disabled and should not return this error code. */
RESPONSE_METHOD_NOT_ALLOWED = 405,
/** HTTP status code `406 Not Acceptable`. The target resource does not have a current representation that would be acceptable to the user agent, according to the proactive negotiation header fields received in the request. Used when negotiation content. */
RESPONSE_NOT_ACCEPTABLE = 406,
/** HTTP status code `407 Proxy Authentication Required`. Similar to 401 Unauthorized, but it indicates that the client needs to authenticate itself in order to use a proxy. */
RESPONSE_PROXY_AUTHENTICATION_REQUIRED = 407,
/** HTTP status code `408 Request Timeout`. The server did not receive a complete request message within the time that it was prepared to wait. */
RESPONSE_REQUEST_TIMEOUT = 408,
/** HTTP status code `409 Conflict`. The request could not be completed due to a conflict with the current state of the target resource. This code is used in situations where the user might be able to resolve the conflict and resubmit the request. */
RESPONSE_CONFLICT = 409,
/** HTTP status code `410 Gone`. The target resource is no longer available at the origin server and this condition is likely permanent. */
RESPONSE_GONE = 410,
/** HTTP status code `411 Length Required`. The server refuses to accept the request without a defined Content-Length header. */
RESPONSE_LENGTH_REQUIRED = 411,
/** HTTP status code `412 Precondition Failed`. One or more conditions given in the request header fields evaluated to `false` when tested on the server. */
RESPONSE_PRECONDITION_FAILED = 412,
/** HTTP status code `413 Entity Too Large`. The server is refusing to process a request because the request payload is larger than the server is willing or able to process. */
RESPONSE_REQUEST_ENTITY_TOO_LARGE = 413,
/** HTTP status code `414 Request-URI Too Long`. The server is refusing to service the request because the request-target is longer than the server is willing to interpret. */
RESPONSE_REQUEST_URI_TOO_LONG = 414,
/** HTTP status code `415 Unsupported Media Type`. The origin server is refusing to service the request because the payload is in a format not supported by this method on the target resource. */
RESPONSE_UNSUPPORTED_MEDIA_TYPE = 415,
/** HTTP status code `416 Requested Range Not Satisfiable`. None of the ranges in the request's Range header field overlap the current extent of the selected resource or the set of ranges requested has been rejected due to invalid ranges or an excessive request of small or overlapping ranges. */
RESPONSE_REQUESTED_RANGE_NOT_SATISFIABLE = 416,
/** HTTP status code `417 Expectation Failed`. The expectation given in the request's Expect header field could not be met by at least one of the inbound servers. */
RESPONSE_EXPECTATION_FAILED = 417,
/** HTTP status code `418 I'm A Teapot`. Any attempt to brew coffee with a teapot should result in the error code "418 I'm a teapot". The resulting entity body MAY be short and stout. */
RESPONSE_IM_A_TEAPOT = 418,
/** HTTP status code `421 Misdirected Request`. The request was directed at a server that is not able to produce a response. This can be sent by a server that is not configured to produce responses for the combination of scheme and authority that are included in the request URI. */
RESPONSE_MISDIRECTED_REQUEST = 421,
/** HTTP status code `422 Unprocessable Entity` (WebDAV). The server understands the content type of the request entity (hence a 415 Unsupported Media Type status code is inappropriate), and the syntax of the request entity is correct (thus a 400 Bad Request status code is inappropriate) but was unable to process the contained instructions. */
RESPONSE_UNPROCESSABLE_ENTITY = 422,
/** HTTP status code `423 Locked` (WebDAV). The source or destination resource of a method is locked. */
RESPONSE_LOCKED = 423,
/** HTTP status code `424 Failed Dependency` (WebDAV). The method could not be performed on the resource because the requested action depended on another action and that action failed. */
RESPONSE_FAILED_DEPENDENCY = 424,
/** HTTP status code `426 Upgrade Required`. The server refuses to perform the request using the current protocol but might be willing to do so after the client upgrades to a different protocol. */
RESPONSE_UPGRADE_REQUIRED = 426,
/** HTTP status code `428 Precondition Required`. The origin server requires the request to be conditional. */
RESPONSE_PRECONDITION_REQUIRED = 428,
/** HTTP status code `429 Too Many Requests`. The user has sent too many requests in a given amount of time (see "rate limiting"). Back off and increase time between requests or try again later. */
RESPONSE_TOO_MANY_REQUESTS = 429,
/** HTTP status code `431 Request Header Fields Too Large`. The server is unwilling to process the request because its header fields are too large. The request MAY be resubmitted after reducing the size of the request header fields. */
RESPONSE_REQUEST_HEADER_FIELDS_TOO_LARGE = 431,
/** HTTP status code `451 Response Unavailable For Legal Reasons`. The server is denying access to the resource as a consequence of a legal demand. */
RESPONSE_UNAVAILABLE_FOR_LEGAL_REASONS = 451,
/** HTTP status code `500 Internal Server Error`. The server encountered an unexpected condition that prevented it from fulfilling the request. */
RESPONSE_INTERNAL_SERVER_ERROR = 500,
/** HTTP status code `501 Not Implemented`. The server does not support the functionality required to fulfill the request. */
RESPONSE_NOT_IMPLEMENTED = 501,
/** HTTP status code `502 Bad Gateway`. The server, while acting as a gateway or proxy, received an invalid response from an inbound server it accessed while attempting to fulfill the request. Usually returned by load balancers or proxies. */
RESPONSE_BAD_GATEWAY = 502,
/** HTTP status code `503 Service Unavailable`. The server is currently unable to handle the request due to a temporary overload or scheduled maintenance, which will likely be alleviated after some delay. Try again later. */
RESPONSE_SERVICE_UNAVAILABLE = 503,
/** HTTP status code `504 Gateway Timeout`. The server, while acting as a gateway or proxy, did not receive a timely response from an upstream server it needed to access in order to complete the request. Usually returned by load balancers or proxies. */
RESPONSE_GATEWAY_TIMEOUT = 504,
/** HTTP status code `505 HTTP Version Not Supported`. The server does not support, or refuses to support, the major version of HTTP that was used in the request message. */
RESPONSE_HTTP_VERSION_NOT_SUPPORTED = 505,
/** HTTP status code `506 Variant Also Negotiates`. The server has an internal configuration error: the chosen variant resource is configured to engage in transparent content negotiation itself, and is therefore not a proper end point in the negotiation process. */
RESPONSE_VARIANT_ALSO_NEGOTIATES = 506,
/** HTTP status code `507 Insufficient Storage`. The method could not be performed on the resource because the server is unable to store the representation needed to successfully complete the request. */
RESPONSE_INSUFFICIENT_STORAGE = 507,
/** HTTP status code `508 Loop Detected`. The server terminated an operation because it encountered an infinite loop while processing a request with "Depth: infinity". This status indicates that the entire operation failed. */
RESPONSE_LOOP_DETECTED = 508,
/** HTTP status code `510 Not Extended`. The policy for accessing the resource has not been met in the request. The server should send back all the information necessary for the client to issue an extended request. */
RESPONSE_NOT_EXTENDED = 510,
/** HTTP status code `511 Network Authentication Required`. The client needs to authenticate to gain network access. */
RESPONSE_NETWORK_AUTH_REQUIRED = 511,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHTTPClient extends __NameMapRefCounted {
}
/** Low-level hyper-text transfer protocol client.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_httpclient.html
*/
class HTTPClient extends RefCounted {
constructor(identifier?: any)
/** Connects to a host. This needs to be done before any requests are sent.
* If no [param port] is specified (or `-1` is used), it is automatically set to 80 for HTTP and 443 for HTTPS. You can pass the optional [param tls_options] parameter to customize the trusted certification authorities, or the common name verification when using HTTPS. See [method TLSOptions.client] and [method TLSOptions.client_unsafe].
*/
connect_to_host(host: string, port?: int64 /* = -1 */, tls_options?: TLSOptions /* = undefined */): Error
/** Sends a raw HTTP request to the connected host with the given [param method].
* The URL parameter is usually just the part after the host, so for `https://example.com/index.php`, it is `/index.php`. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, `*` is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component (`host:port`).
* [param headers] are HTTP request headers.
* Sends the body data raw, as a byte array and does not encode it in any way.
*/
request_raw(method: HTTPClient.Method, url: string, headers: PackedStringArray | string[], body: PackedByteArray | byte[] | ArrayBuffer): Error
/** Sends an HTTP request to the connected host with the given [param method].
* The URL parameter is usually just the part after the host, so for `https://example.com/index.php`, it is `/index.php`. When sending requests to an HTTP proxy server, it should be an absolute URL. For [constant HTTPClient.METHOD_OPTIONS] requests, `*` is also allowed. For [constant HTTPClient.METHOD_CONNECT] requests, it should be the authority component (`host:port`).
* [param headers] are HTTP request headers.
* To create a POST request with query strings to push to the server, do:
*
*
* **Note:** The [param body] parameter is ignored if [param method] is [constant HTTPClient.METHOD_GET]. This is because GET methods can't contain request data. As a workaround, you can pass request data as a query string in the URL. See [method String.uri_encode] for an example.
*/
request(method: HTTPClient.Method, url: string, headers: PackedStringArray | string[], body?: string /* = '' */): Error
/** Closes the current connection, allowing reuse of this [HTTPClient]. */
close(): void
/** If `true`, this [HTTPClient] has a response available. */
has_response(): boolean
/** If `true`, this [HTTPClient] has a response that is chunked. */
is_response_chunked(): boolean
/** Returns the response's HTTP status code. */
get_response_code(): int64
/** Returns the response headers. */
get_response_headers(): PackedStringArray
/** Returns all response headers as a [Dictionary]. Each entry is composed by the header name, and a [String] containing the values separated by `"; "`. The casing is kept the same as the headers were received.
*
*/
get_response_headers_as_dictionary(): GDictionary
/** Returns the response's body length.
*
* **Note:** Some Web servers may not send a body length. In this case, the value returned will be `-1`. If using chunked transfer encoding, the body length will also be `-1`.
*
* **Note:** This function always returns `-1` on the Web platform due to browsers limitations.
*/
get_response_body_length(): int64
/** Reads one chunk from the response. */
read_response_body_chunk(): PackedByteArray
/** Returns a [enum Status] constant. Need to call [method poll] in order to get status updates. */
get_status(): HTTPClient.Status
/** This needs to be called in order to have any request processed. Check results with [method get_status]. */
poll(): Error
/** Sets the proxy server for HTTP requests.
* The proxy server is unset if [param host] is empty or [param port] is -1.
*/
set_http_proxy(host: string, port: int64): void
/** Sets the proxy server for HTTPS requests.
* The proxy server is unset if [param host] is empty or [param port] is -1.
*/
set_https_proxy(host: string, port: int64): void
/** Generates a GET/POST application/x-www-form-urlencoded style query string from a provided dictionary, e.g.:
*
* Furthermore, if a key has a `null` value, only the key itself is added, without equal sign and value. If the value is an array, for each value in it a pair with the same key is added.
*
*/
query_string_from_dict(fields: GDictionary): string
/** If `true`, execution will block until all data is read from the response. */
get blocking_mode_enabled(): boolean
set blocking_mode_enabled(value: boolean)
/** The connection to use for this client. */
get connection(): null | StreamPeer
set connection(value: null | StreamPeer)
/** The size of the buffer used and maximum bytes to read per iteration. See [method read_response_body_chunk]. */
get read_chunk_size(): int64
set read_chunk_size(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHTTPClient;
}
namespace HTTPRequest {
enum Result {
/** Request successful. */
RESULT_SUCCESS = 0,
/** Request failed due to a mismatch between the expected and actual chunked body size during transfer. Possible causes include network errors, server misconfiguration, or issues with chunked encoding. */
RESULT_CHUNKED_BODY_SIZE_MISMATCH = 1,
/** Request failed while connecting. */
RESULT_CANT_CONNECT = 2,
/** Request failed while resolving. */
RESULT_CANT_RESOLVE = 3,
/** Request failed due to connection (read/write) error. */
RESULT_CONNECTION_ERROR = 4,
/** Request failed on TLS handshake. */
RESULT_TLS_HANDSHAKE_ERROR = 5,
/** Request does not have a response (yet). */
RESULT_NO_RESPONSE = 6,
/** Request exceeded its maximum size limit, see [member body_size_limit]. */
RESULT_BODY_SIZE_LIMIT_EXCEEDED = 7,
/** Request failed due to an error while decompressing the response body. Possible causes include unsupported or incorrect compression format, corrupted data, or incomplete transfer. */
RESULT_BODY_DECOMPRESS_FAILED = 8,
/** Request failed (currently unused). */
RESULT_REQUEST_FAILED = 9,
/** HTTPRequest couldn't open the download file. */
RESULT_DOWNLOAD_FILE_CANT_OPEN = 10,
/** HTTPRequest couldn't write to the download file. */
RESULT_DOWNLOAD_FILE_WRITE_ERROR = 11,
/** Request reached its maximum redirect limit, see [member max_redirects]. */
RESULT_REDIRECT_LIMIT_REACHED = 12,
/** Request failed due to a timeout. If you expect requests to take a long time, try increasing the value of [member timeout] or setting it to `0.0` to remove the timeout completely. */
RESULT_TIMEOUT = 13,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHTTPRequest extends __NameMapNode {
}
/** A node with the ability to send HTTP(S) requests.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_httprequest.html
*/
class HTTPRequest<Map extends NodePathMap = any> extends Node<Map> {
constructor(identifier?: any)
/** Creates request on the underlying [HTTPClient]. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request].
* Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host.
*
* **Note:** When [param method] is [constant HTTPClient.METHOD_GET], the payload sent via [param request_data] might be ignored by the server or even cause the server to reject the request (check [url=https://datatracker.ietf.org/doc/html/rfc7231#section-4.3.1]RFC 7231 section 4.3.1[/url] for more details). As a workaround, you can send data as a query string in the URL (see [method String.uri_encode] for an example).
*
* **Note:** It's recommended to use transport encryption (TLS) and to avoid sending sensitive information (such as login credentials) in HTTP GET URL parameters. Consider using HTTP POST requests or HTTP headers for such information instead.
*/
request(url: string, custom_headers?: PackedStringArray | string[] /* = [] */, method?: HTTPClient.Method /* = 0 */, request_data?: string /* = '' */): Error
/** Creates request on the underlying [HTTPClient] using a raw array of bytes for the request body. If there is no configuration errors, it tries to connect using [method HTTPClient.connect_to_host] and passes parameters onto [method HTTPClient.request].
* Returns [constant OK] if request is successfully created. (Does not imply that the server has responded), [constant ERR_UNCONFIGURED] if not in the tree, [constant ERR_BUSY] if still processing previous request, [constant ERR_INVALID_PARAMETER] if given string is not a valid URL format, or [constant ERR_CANT_CONNECT] if not using thread and the [HTTPClient] cannot connect to host.
*/
request_raw(url: string, custom_headers?: PackedStringArray | string[] /* = [] */, method?: HTTPClient.Method /* = 0 */, request_data_raw?: PackedByteArray | byte[] | ArrayBuffer /* = [] */): Error
/** Cancels the current request. */
cancel_request(): void
/** Sets the [TLSOptions] to be used when connecting to an HTTPS server. See [method TLSOptions.client]. */
set_tls_options(client_options: TLSOptions): void
/** Returns the current status of the underlying [HTTPClient]. */
get_http_client_status(): HTTPClient.Status
/** Returns the number of bytes this HTTPRequest downloaded. */
get_downloaded_bytes(): int64
/** Returns the response body length.
*
* **Note:** Some Web servers may not send a body length. In this case, the value returned will be `-1`. If using chunked transfer encoding, the body length will also be `-1`.
*/
get_body_size(): int64
/** Sets the proxy server for HTTP requests.
* The proxy server is unset if [param host] is empty or [param port] is -1.
*/
set_http_proxy(host: string, port: int64): void
/** Sets the proxy server for HTTPS requests.
* The proxy server is unset if [param host] is empty or [param port] is -1.
*/
set_https_proxy(host: string, port: int64): void
/** The file to download into. Will output any received file into it. */
get download_file(): string
set download_file(value: string)
/** The size of the buffer used and maximum bytes to read per iteration. See [member HTTPClient.read_chunk_size].
* Set this to a lower value (e.g. 4096 for 4 KiB) when downloading small files to decrease memory usage at the cost of download speeds.
*/
get download_chunk_size(): int64
set download_chunk_size(value: int64)
/** If `true`, multithreading is used to improve performance. */
get use_threads(): boolean
set use_threads(value: boolean)
/** If `true`, this header will be added to each request: `Accept-Encoding: gzip, deflate` telling servers that it's okay to compress response bodies.
* Any Response body declaring a `Content-Encoding` of either `gzip` or `deflate` will then be automatically decompressed, and the uncompressed bytes will be delivered via [signal request_completed].
* If the user has specified their own `Accept-Encoding` header, then no header will be added regardless of [member accept_gzip].
* If `false` no header will be added, and no decompression will be performed on response bodies. The raw bytes of the response body will be returned via [signal request_completed].
*/
get accept_gzip(): boolean
set accept_gzip(value: boolean)
/** Maximum allowed size for response bodies. If the response body is compressed, this will be used as the maximum allowed size for the decompressed body. */
get body_size_limit(): int64
set body_size_limit(value: int64)
/** Maximum number of allowed redirects. */
get max_redirects(): int64
set max_redirects(value: int64)
/** The duration to wait in seconds before a request times out. If [member timeout] is set to `0.0` then the request will never time out. For simple requests, such as communication with a REST API, it is recommended that [member timeout] is set to a value suitable for the server response time (e.g. between `1.0` and `10.0`). This will help prevent unwanted timeouts caused by variation in server response times while still allowing the application to detect when a request has timed out. For larger requests such as file downloads it is suggested the [member timeout] be set to `0.0`, disabling the timeout functionality. This will help to prevent large transfers from failing due to exceeding the timeout value. */
get timeout(): float64
set timeout(value: float64)
/** Emitted when a request is completed. */
readonly request_completed: Signal<(result: int64, response_code: int64, headers: PackedStringArray, body: PackedByteArray) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHTTPRequest;
}
namespace HashingContext {
enum HashType {
/** Hashing algorithm: MD5. */
HASH_MD5 = 0,
/** Hashing algorithm: SHA-1. */
HASH_SHA1 = 1,
/** Hashing algorithm: SHA-256. */
HASH_SHA256 = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHashingContext extends __NameMapRefCounted {
}
/** Provides functionality for computing cryptographic hashes chunk by chunk.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hashingcontext.html
*/
class HashingContext extends RefCounted {
constructor(identifier?: any)
/** Starts a new hash computation of the given [param type] (e.g. [constant HASH_SHA256] to start computation of an SHA-256). */
start(type: HashingContext.HashType): Error
/** Updates the computation with the given [param chunk] of data. */
update(chunk: PackedByteArray | byte[] | ArrayBuffer): Error
/** Closes the current context, and return the computed hash. */
finish(): PackedByteArray
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHashingContext;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHeightMapShape3D extends __NameMapShape3D {
}
/** A 3D height map shape used for physics collision.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_heightmapshape3d.html
*/
class HeightMapShape3D extends Shape3D {
constructor(identifier?: any)
/** Returns the smallest height value found in [member map_data]. Recalculates only when [member map_data] changes. */
get_min_height(): float64
/** Returns the largest height value found in [member map_data]. Recalculates only when [member map_data] changes. */
get_max_height(): float64
/** Updates [member map_data] with data read from an [Image] reference. Automatically resizes heightmap [member map_width] and [member map_depth] to fit the full image width and height.
* The image needs to be in either [constant Image.FORMAT_RF] (32 bit), [constant Image.FORMAT_RH] (16 bit), or [constant Image.FORMAT_R8] (8 bit).
* Each image pixel is read in as a float on the range from `0.0` (black pixel) to `1.0` (white pixel). This range value gets remapped to [param height_min] and [param height_max] to form the final height value.
*
* **Note:** Using a heightmap with 16-bit or 32-bit data, stored in EXR or HDR format is recommended. Using 8-bit height data, or a format like PNG that Godot imports as 8-bit, will result in a terraced terrain.
*/
update_map_data_from_image(image: Image, height_min: float64, height_max: float64): void
/** Number of vertices in the width of the height map. Changing this will resize the [member map_data]. */
get map_width(): int64
set map_width(value: int64)
/** Number of vertices in the depth of the height map. Changing this will resize the [member map_data]. */
get map_depth(): int64
set map_depth(value: int64)
/** Height map data. The array's size must be equal to [member map_width] multiplied by [member map_depth]. */
get map_data(): PackedFloat32Array
set map_data(value: PackedFloat32Array | float32[])
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHeightMapShape3D;
}
namespace HingeJoint3D {
enum Param {
/** The speed with which the two bodies get pulled together when they move in different directions. */
PARAM_BIAS = 0,
/** The maximum rotation. Only active if [member angular_limit/enable] is `true`. */
PARAM_LIMIT_UPPER = 1,
/** The minimum rotation. Only active if [member angular_limit/enable] is `true`. */
PARAM_LIMIT_LOWER = 2,
/** The speed with which the rotation across the axis perpendicular to the hinge gets corrected. */
PARAM_LIMIT_BIAS = 3,
PARAM_LIMIT_SOFTNESS = 4,
/** The lower this value, the more the rotation gets slowed down. */
PARAM_LIMIT_RELAXATION = 5,
/** Target speed for the motor. */
PARAM_MOTOR_TARGET_VELOCITY = 6,
/** Maximum acceleration for the motor. */
PARAM_MOTOR_MAX_IMPULSE = 7,
/** Represents the size of the [enum Param] enum. */
PARAM_MAX = 8,
}
enum Flag {
/** If `true`, the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. */
FLAG_USE_LIMIT = 0,
/** When activated, a motor turns the hinge. */
FLAG_ENABLE_MOTOR = 1,
/** Represents the size of the [enum Flag] enum. */
FLAG_MAX = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapHingeJoint3D extends __NameMapJoint3D {
}
/** A physics joint that restricts the rotation of a 3D physics body around an axis relative to another physics body.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_hingejoint3d.html
*/
class HingeJoint3D<Map extends NodePathMap = any> extends Joint3D<Map> {
constructor(identifier?: any)
/** Sets the value of the specified parameter. */
set_param(param: HingeJoint3D.Param, value: float64): void
/** Returns the value of the specified parameter. */
get_param(param: HingeJoint3D.Param): float64
/** If `true`, enables the specified flag. */
set_flag(flag: HingeJoint3D.Flag, enabled: boolean): void
/** Returns the value of the specified flag. */
get_flag(flag: HingeJoint3D.Flag): boolean
/** The speed with which the two bodies get pulled together when they move in different directions. */
get "params/bias"(): float64
set "params/bias"(value: float64)
/** If `true`, the hinges maximum and minimum rotation, defined by [member angular_limit/lower] and [member angular_limit/upper] has effects. */
get "angular_limit/enable"(): boolean
set "angular_limit/enable"(value: boolean)
/** The maximum rotation. Only active if [member angular_limit/enable] is `true`. */
get "angular_limit/upper"(): float64
set "angular_limit/upper"(value: float64)
/** The minimum rotation. Only active if [member angular_limit/enable] is `true`. */
get "angular_limit/lower"(): float64
set "angular_limit/lower"(value: float64)
/** The speed with which the rotation across the axis perpendicular to the hinge gets corrected. */
get "angular_limit/bias"(): float64
set "angular_limit/bias"(value: float64)
get "angular_limit/softness"(): float64
set "angular_limit/softness"(value: float64)
/** The lower this value, the more the rotation gets slowed down. */
get "angular_limit/relaxation"(): float64
set "angular_limit/relaxation"(value: float64)
/** When activated, a motor turns the hinge. */
get "motor/enable"(): boolean
set "motor/enable"(value: boolean)
/** Target speed for the motor. */
get "motor/target_velocity"(): float64
set "motor/target_velocity"(value: float64)
/** Maximum acceleration for the motor. */
get "motor/max_impulse"(): float64
set "motor/max_impulse"(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapHingeJoint3D;
}
namespace Image {
enum Format {
/** Texture format with a single 8-bit depth representing luminance. */
FORMAT_L8 = 0,
/** OpenGL texture format with two values, luminance and alpha each stored with 8 bits. */
FORMAT_LA8 = 1,
/** OpenGL texture format `RED` with a single component and a bitdepth of 8. */
FORMAT_R8 = 2,
/** OpenGL texture format `RG` with two components and a bitdepth of 8 for each. */
FORMAT_RG8 = 3,
/** OpenGL texture format `RGB` with three components, each with a bitdepth of 8.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_RGB8 = 4,
/** OpenGL texture format `RGBA` with four components, each with a bitdepth of 8.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_RGBA8 = 5,
/** OpenGL texture format `RGBA` with four components, each with a bitdepth of 4. */
FORMAT_RGBA4444 = 6,
/** OpenGL texture format `RGB` with three components. Red and blue have a bitdepth of 5, and green has a bitdepth of 6. */
FORMAT_RGB565 = 7,
/** OpenGL texture format `GL_R32F` where there's one component, a 32-bit floating-point value. */
FORMAT_RF = 8,
/** OpenGL texture format `GL_RG32F` where there are two components, each a 32-bit floating-point values. */
FORMAT_RGF = 9,
/** OpenGL texture format `GL_RGB32F` where there are three components, each a 32-bit floating-point values. */
FORMAT_RGBF = 10,
/** OpenGL texture format `GL_RGBA32F` where there are four components, each a 32-bit floating-point values. */
FORMAT_RGBAF = 11,
/** OpenGL texture format `GL_R16F` where there's one component, a 16-bit "half-precision" floating-point value. */
FORMAT_RH = 12,
/** OpenGL texture format `GL_RG16F` where there are two components, each a 16-bit "half-precision" floating-point value. */
FORMAT_RGH = 13,
/** OpenGL texture format `GL_RGB16F` where there are three components, each a 16-bit "half-precision" floating-point value. */
FORMAT_RGBH = 14,
/** OpenGL texture format `GL_RGBA16F` where there are four components, each a 16-bit "half-precision" floating-point value. */
FORMAT_RGBAH = 15,
/** A special OpenGL texture format where the three color components have 9 bits of precision and all three share a single 5-bit exponent. */
FORMAT_RGBE9995 = 16,
/** The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format that uses Block Compression 1, and is the smallest variation of S3TC, only providing 1 bit of alpha and color data being premultiplied with alpha.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_DXT1 = 17,
/** The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format that uses Block Compression 2, and color data is interpreted as not having been premultiplied by alpha. Well suited for images with sharp alpha transitions between translucent and opaque areas.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_DXT3 = 18,
/** The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format also known as Block Compression 3 or BC3 that contains 64 bits of alpha channel data followed by 64 bits of DXT1-encoded color data. Color data is not premultiplied by alpha, same as DXT3. DXT5 generally produces superior results for transparent gradients compared to DXT3.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_DXT5 = 19,
/** Texture format that uses [url=https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression]Red Green Texture Compression[/url], normalizing the red channel data using the same compression algorithm that DXT5 uses for the alpha channel. */
FORMAT_RGTC_R = 20,
/** Texture format that uses [url=https://www.khronos.org/opengl/wiki/Red_Green_Texture_Compression]Red Green Texture Compression[/url], normalizing the red and green channel data using the same compression algorithm that DXT5 uses for the alpha channel. */
FORMAT_RGTC_RG = 21,
/** Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with unsigned normalized RGBA components.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_BPTC_RGBA = 22,
/** Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with signed floating-point RGB components. */
FORMAT_BPTC_RGBF = 23,
/** Texture format that uses [url=https://www.khronos.org/opengl/wiki/BPTC_Texture_Compression]BPTC[/url] compression with unsigned floating-point RGB components. */
FORMAT_BPTC_RGBFU = 24,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC1]Ericsson Texture Compression format 1[/url], also referred to as "ETC1", and is part of the OpenGL ES graphics standard. This format cannot store an alpha channel. */
FORMAT_ETC = 25,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`R11_EAC` variant), which provides one channel of unsigned data. */
FORMAT_ETC2_R11 = 26,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`SIGNED_R11_EAC` variant), which provides one channel of signed data. */
FORMAT_ETC2_R11S = 27,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RG11_EAC` variant), which provides two channels of unsigned data. */
FORMAT_ETC2_RG11 = 28,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`SIGNED_RG11_EAC` variant), which provides two channels of signed data. */
FORMAT_ETC2_RG11S = 29,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RGB8` variant), which is a follow-up of ETC1 and compresses RGB888 data.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_ETC2_RGB8 = 30,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RGBA8`variant), which compresses RGBA8888 data with full alpha support.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_ETC2_RGBA8 = 31,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RGB8_PUNCHTHROUGH_ALPHA1` variant), which compresses RGBA data to make alpha either fully transparent or fully opaque.
*
* **Note:** When creating an [ImageTexture], an sRGB to linear color space conversion is performed.
*/
FORMAT_ETC2_RGB8A1 = 32,
/** [url=https://en.wikipedia.org/wiki/Ericsson_Texture_Compression#ETC2_and_EAC]Ericsson Texture Compression format 2[/url] (`RGBA8` variant), which compresses RA data and interprets it as two channels (red and green). See also [constant FORMAT_ETC2_RGBA8]. */
FORMAT_ETC2_RA_AS_RG = 33,
/** The [url=https://en.wikipedia.org/wiki/S3_Texture_Compression]S3TC[/url] texture format also known as Block Compression 3 or BC3, which compresses RA data and interprets it as two channels (red and green). See also [constant FORMAT_DXT5]. */
FORMAT_DXT5_RA_AS_RG = 34,
/** [url=https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression]Adaptive Scalable Texture Compression[/url]. This implements the 4×4 (high quality) mode. */
FORMAT_ASTC_4x4 = 35,
/** Same format as [constant FORMAT_ASTC_4x4], but with the hint to let the GPU know it is used for HDR. */
FORMAT_ASTC_4x4_HDR = 36,
/** [url=https://en.wikipedia.org/wiki/Adaptive_scalable_texture_compression]Adaptive Scalable Texture Compression[/url]. This implements the 8×8 (low quality) mode. */
FORMAT_ASTC_8x8 = 37,
/** Same format as [constant FORMAT_ASTC_8x8], but with the hint to let the GPU know it is used for HDR. */
FORMAT_ASTC_8x8_HDR = 38,
/** Represents the size of the [enum Format] enum. */
FORMAT_MAX = 39,
}
enum Interpolation {
/** Performs nearest-neighbor interpolation. If the image is resized, it will be pixelated. */
INTERPOLATE_NEAREST = 0,
/** Performs bilinear interpolation. If the image is resized, it will be blurry. This mode is faster than [constant INTERPOLATE_CUBIC], but it results in lower quality. */
INTERPOLATE_BILINEAR = 1,
/** Performs cubic interpolation. If the image is resized, it will be blurry. This mode often gives better results compared to [constant INTERPOLATE_BILINEAR], at the cost of being slower. */
INTERPOLATE_CUBIC = 2,
/** Performs bilinear separately on the two most-suited mipmap levels, then linearly interpolates between them.
* It's slower than [constant INTERPOLATE_BILINEAR], but produces higher-quality results with far fewer aliasing artifacts.
* If the image does not have mipmaps, they will be generated and used internally, but no mipmaps will be generated on the resulting image.
*
* **Note:** If you intend to scale multiple copies of the original image, it's better to call [method generate_mipmaps]] on it in advance, to avoid wasting processing power in generating them again and again.
* On the other hand, if the image already has mipmaps, they will be used, and a new set will be generated for the resulting image.
*/
INTERPOLATE_TRILINEAR = 3,
/** Performs Lanczos interpolation. This is the slowest image resizing mode, but it typically gives the best results, especially when downscaling images. */
INTERPOLATE_LANCZOS = 4,
}
enum AlphaMode {
/** Image does not have alpha. */
ALPHA_NONE = 0,
/** Image stores alpha in a single bit. */
ALPHA_BIT = 1,
/** Image uses alpha. */
ALPHA_BLEND = 2,
}
enum CompressMode {
/** Use S3TC compression. */
COMPRESS_S3TC = 0,
/** Use ETC compression. */
COMPRESS_ETC = 1,
/** Use ETC2 compression. */
COMPRESS_ETC2 = 2,
/** Use BPTC compression. */
COMPRESS_BPTC = 3,
/** Use ASTC compression. */
COMPRESS_ASTC = 4,
/** Represents the size of the [enum CompressMode] enum. */
COMPRESS_MAX = 5,
}
enum UsedChannels {
/** The image only uses one channel for luminance (grayscale). */
USED_CHANNELS_L = 0,
/** The image uses two channels for luminance and alpha, respectively. */
USED_CHANNELS_LA = 1,
/** The image only uses the red channel. */
USED_CHANNELS_R = 2,
/** The image uses two channels for red and green. */
USED_CHANNELS_RG = 3,
/** The image uses three channels for red, green, and blue. */
USED_CHANNELS_RGB = 4,
/** The image uses four channels for red, green, blue, and alpha. */
USED_CHANNELS_RGBA = 5,
}
enum CompressSource {
/** Source texture (before compression) is a regular texture. Default for all textures. */
COMPRESS_SOURCE_GENERIC = 0,
/** Source texture (before compression) is in sRGB space. */
COMPRESS_SOURCE_SRGB = 1,
/** Source texture (before compression) is a normal texture (e.g. it can be compressed into two channels). */
COMPRESS_SOURCE_NORMAL = 2,
}
enum ASTCFormat {
/** Hint to indicate that the high quality 4×4 ASTC compression format should be used. */
ASTC_FORMAT_4x4 = 0,
/** Hint to indicate that the low quality 8×8 ASTC compression format should be used. */
ASTC_FORMAT_8x8 = 1,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImage extends __NameMapResource {
}
/** Image datatype.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_image.html
*/
class Image extends Resource {
/** The maximal width allowed for [Image] resources. */
static readonly MAX_WIDTH = 16777216
/** The maximal height allowed for [Image] resources. */
static readonly MAX_HEIGHT = 16777216
constructor(identifier?: any)
/** Returns the image's width. */
get_width(): int64
/** Returns the image's height. */
get_height(): int64
/** Returns the image's size (width and height). */
get_size(): Vector2i
/** Returns `true` if the image has generated mipmaps. */
has_mipmaps(): boolean
/** Returns this image's format. */
get_format(): Image.Format
/** Returns a copy of the image's raw data. */
get_data(): PackedByteArray
/** Returns size (in bytes) of the image's raw data. */
get_data_size(): int64
/** Converts this image's format to the given [param format]. */
convert(format: Image.Format): void
/** Returns the number of mipmap levels or 0 if the image has no mipmaps. The largest main level image is not counted as a mipmap level by this method, so if you want to include it you can add 1 to this count. */
get_mipmap_count(): int64
/** Returns the offset where the image's mipmap with index [param mipmap] is stored in the [member data] dictionary. */
get_mipmap_offset(mipmap: int64): int64
/** Resizes the image to the nearest power of 2 for the width and height. If [param square] is `true`, sets width and height to be the same. New pixels are calculated using the [param interpolation] mode defined via [enum Interpolation] constants. */
resize_to_po2(square?: boolean /* = false */, interpolation?: Image.Interpolation /* = 1 */): void
/** Resizes the image to the given [param width] and [param height]. New pixels are calculated using the [param interpolation] mode defined via [enum Interpolation] constants. */
resize(width: int64, height: int64, interpolation?: Image.Interpolation /* = 1 */): void
/** Shrinks the image by a factor of 2 on each axis (this divides the pixel count by 4). */
shrink_x2(): void
/** Crops the image to the given [param width] and [param height]. If the specified size is larger than the current size, the extra area is filled with black pixels. */
crop(width: int64, height: int64): void
/** Flips the image horizontally. */
flip_x(): void
/** Flips the image vertically. */
flip_y(): void
/** Generates mipmaps for the image. Mipmaps are precalculated lower-resolution copies of the image that are automatically used if the image needs to be scaled down when rendered. They help improve image quality and performance when rendering. This method returns an error if the image is compressed, in a custom format, or if the image's width/height is `0`. Enabling [param renormalize] when generating mipmaps for normal map textures will make sure all resulting vector values are normalized.
* It is possible to check if the image has mipmaps by calling [method has_mipmaps] or [method get_mipmap_count]. Calling [method generate_mipmaps] on an image that already has mipmaps will replace existing mipmaps in the image.
*/
generate_mipmaps(renormalize?: boolean /* = false */): Error
/** Removes the image's mipmaps. */
clear_mipmaps(): void
/** Creates an empty image of the given size and format. If [param use_mipmaps] is `true`, generates mipmaps for this image. See the [method generate_mipmaps]. */
static create(width: int64, height: int64, use_mipmaps: boolean, format: Image.Format): Image
/** Creates an empty image of the given size and format. If [param use_mipmaps] is `true`, generates mipmaps for this image. See the [method generate_mipmaps]. */
static create_empty(width: int64, height: int64, use_mipmaps: boolean, format: Image.Format): Image
/** Creates a new image of the given size and format. Fills the image with the given raw data. If [param use_mipmaps] is `true`, loads the mipmaps for this image from [param data]. See [method generate_mipmaps]. */
static create_from_data(width: int64, height: int64, use_mipmaps: boolean, format: Image.Format, data: PackedByteArray | byte[] | ArrayBuffer): Image
/** Overwrites data of an existing [Image]. Non-static equivalent of [method create_from_data]. */
set_data(width: int64, height: int64, use_mipmaps: boolean, format: Image.Format, data: PackedByteArray | byte[] | ArrayBuffer): void
/** Returns `true` if the image has no data. */
is_empty(): boolean
/** Loads an image from file [param path]. See [url=https://docs.godotengine.org/en/4.5/tutorials/assets_pipeline/importing_images.html#supported-image-formats]Supported image formats[/url] for a list of supported image formats and limitations.
* **Warning:** This method should only be used in the editor or in cases when you need to load external images at run-time, such as images located at the `user://` directory, and may not work in exported projects.
* See also [ImageTexture] description for usage examples.
*/
load(path: string): Error
/** Creates a new [Image] and loads data from the specified file. */
static load_from_file(path: string): null | Image
/** Saves the image as a PNG file to the file at [param path]. */
save_png(path: string): Error
/** Saves the image as a PNG file to a byte array. */
save_png_to_buffer(): PackedByteArray
/** Saves the image as a JPEG file to [param path] with the specified [param quality] between `0.01` and `1.0` (inclusive). Higher [param quality] values result in better-looking output at the cost of larger file sizes. Recommended [param quality] values are between `0.75` and `0.90`. Even at quality `1.00`, JPEG compression remains lossy.
*
* **Note:** JPEG does not save an alpha channel. If the [Image] contains an alpha channel, the image will still be saved, but the resulting JPEG file won't contain the alpha channel.
*/
save_jpg(path: string, quality?: float64 /* = 0.75 */): Error
/** Saves the image as a JPEG file to a byte array with the specified [param quality] between `0.01` and `1.0` (inclusive). Higher [param quality] values result in better-looking output at the cost of larger byte array sizes (and therefore memory usage). Recommended [param quality] values are between `0.75` and `0.90`. Even at quality `1.00`, JPEG compression remains lossy.
*
* **Note:** JPEG does not save an alpha channel. If the [Image] contains an alpha channel, the image will still be saved, but the resulting byte array won't contain the alpha channel.
*/
save_jpg_to_buffer(quality?: float64 /* = 0.75 */): PackedByteArray
/** Saves the image as an EXR file to [param path]. If [param grayscale] is `true` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the TinyEXR module.
*
* **Note:** The TinyEXR module is disabled in non-editor builds, which means [method save_exr] will return [constant ERR_UNAVAILABLE] when it is called from an exported project.
*/
save_exr(path: string, grayscale?: boolean /* = false */): Error
/** Saves the image as an EXR file to a byte array. If [param grayscale] is `true` and the image has only one channel, it will be saved explicitly as monochrome rather than one red channel. This function will return an empty byte array if Godot was compiled without the TinyEXR module.
*
* **Note:** The TinyEXR module is disabled in non-editor builds, which means [method save_exr_to_buffer] will return an empty byte array when it is called from an exported project.
*/
save_exr_to_buffer(grayscale?: boolean /* = false */): PackedByteArray
/** Saves the image as a DDS (DirectDraw Surface) file to [param path]. DDS is a container format that can store textures in various compression formats, such as DXT1, DXT5, or BC7. This function will return [constant ERR_UNAVAILABLE] if Godot was compiled without the DDS module.
*
* **Note:** The DDS module may be disabled in certain builds, which means [method save_dds] will return [constant ERR_UNAVAILABLE] when it is called from an exported project.
*/
save_dds(path: string): Error
/** Saves the image as a DDS (DirectDraw Surface) file to a byte array. DDS is a container format that can store textures in various compression formats, such as DXT1, DXT5, or BC7. This function will return an empty byte array if Godot was compiled without the DDS module.
*
* **Note:** The DDS module may be disabled in certain builds, which means [method save_dds_to_buffer] will return an empty byte array when it is called from an exported project.
*/
save_dds_to_buffer(): PackedByteArray
/** Saves the image as a WebP (Web Picture) file to the file at [param path]. By default it will save lossless. If [param lossy] is `true`, the image will be saved lossy, using the [param quality] setting between `0.0` and `1.0` (inclusive). Lossless WebP offers more efficient compression than PNG.
*
* **Note:** The WebP format is limited to a size of 16383×16383 pixels, while PNG can save larger images.
*/
save_webp(path: string, lossy?: boolean /* = false */, quality?: float64 /* = 0.75 */): Error
/** Saves the image as a WebP (Web Picture) file to a byte array. By default it will save lossless. If [param lossy] is `true`, the image will be saved lossy, using the [param quality] setting between `0.0` and `1.0` (inclusive). Lossless WebP offers more efficient compression than PNG.
*
* **Note:** The WebP format is limited to a size of 16383×16383 pixels, while PNG can save larger images.
*/
save_webp_to_buffer(lossy?: boolean /* = false */, quality?: float64 /* = 0.75 */): PackedByteArray
/** Returns [constant ALPHA_BLEND] if the image has data for alpha values. Returns [constant ALPHA_BIT] if all the alpha values are stored in a single bit. Returns [constant ALPHA_NONE] if no data for alpha values is found. */
detect_alpha(): Image.AlphaMode
/** Returns `true` if all the image's pixels have an alpha value of 0. Returns `false` if any pixel has an alpha value higher than 0. */
is_invisible(): boolean
/** Returns the color channels used by this image. If the image is compressed, the original [param source] must be specified. */
detect_used_channels(source?: Image.CompressSource /* = 0 */): Image.UsedChannels
/** Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available.
* The [param source] parameter helps to pick the best compression method for DXT and ETC2 formats. It is ignored for ASTC compression.
* For ASTC compression, the [param astc_format] parameter must be supplied.
*/
compress(mode: Image.CompressMode, source?: Image.CompressSource /* = 0 */, astc_format?: Image.ASTCFormat /* = 0 */): Error
/** Compresses the image to use less memory. Can not directly access pixel data while the image is compressed. Returns error if the chosen compression mode is not available.
* This is an alternative to [method compress] that lets the user supply the channels used in order for the compressor to pick the best DXT and ETC2 formats. For other formats (non DXT or ETC2), this argument is ignored.
* For ASTC compression, the [param astc_format] parameter must be supplied.
*/
compress_from_channels(mode: Image.CompressMode, channels: Image.UsedChannels, astc_format?: Image.ASTCFormat /* = 0 */): Error
/** Decompresses the image if it is VRAM compressed in a supported format. Returns [constant OK] if the format is supported, otherwise [constant ERR_UNAVAILABLE].
*
* **Note:** The following formats can be decompressed: DXT, RGTC, BPTC. The formats ETC1 and ETC2 are not supported.
*/
decompress(): Error
/** Returns `true` if the image is compressed. */
is_compressed(): boolean
/** Rotates the image in the specified [param direction] by `90` degrees. The width and height of the image must be greater than `1`. If the width and height are not equal, the image will be resized. */
rotate_90(direction: ClockDirection): void
/** Rotates the image by `180` degrees. The width and height of the image must be greater than `1`. */
rotate_180(): void
/** Blends low-alpha pixels with nearby pixels. */
fix_alpha_edges(): void
/** Multiplies color values with alpha values. Resulting color values for a pixel are `(color * alpha)/256`. See also [member CanvasItemMaterial.blend_mode]. */
premultiply_alpha(): void
/** Converts the raw data from the sRGB colorspace to a linear scale. Only works on images with [constant FORMAT_RGB8] or [constant FORMAT_RGBA8] formats. */
srgb_to_linear(): void
/** Converts the entire image from the linear colorspace to the sRGB colorspace. Only works on images with [constant FORMAT_RGB8] or [constant FORMAT_RGBA8] formats. */
linear_to_srgb(): void
/** Converts the image's data to represent coordinates on a 3D plane. This is used when the image represents a normal map. A normal map can add lots of detail to a 3D surface without increasing the polygon count. */
normal_map_to_xy(): void
/** Converts a standard RGBE (Red Green Blue Exponent) image to an sRGB image. */
rgbe_to_srgb(): null | Image
/** Converts a bump map to a normal map. A bump map provides a height offset per-pixel, while a normal map provides a normal direction per pixel. */
bump_map_to_normal_map(bump_scale?: float64 /* = 1 */): void
/** Compute image metrics on the current image and the compared image.
* The dictionary contains `max`, `mean`, `mean_squared`, `root_mean_squared` and `peak_snr`.
*/
compute_image_metrics(compared_image: Image, use_luma: boolean): GDictionary
/** Copies [param src_rect] from [param src] image to this image at coordinates [param dst], clipped accordingly to both image bounds. This image and [param src] image **must** have the same format. [param src_rect] with non-positive size is treated as empty.
*
* **Note:** The alpha channel data in [param src] will overwrite the corresponding data in this image at the target position. To blend alpha channels, use [method blend_rect] instead.
*/
blit_rect(src: Image, src_rect: Rect2i, dst: Vector2i): void
/** Blits [param src_rect] area from [param src] image to this image at the coordinates given by [param dst], clipped accordingly to both image bounds. [param src] pixel is copied onto [param dst] if the corresponding [param mask] pixel's alpha value is not 0. This image and [param src] image **must** have the same format. [param src] image and [param mask] image **must** have the same size (width and height) but they can have different formats. [param src_rect] with non-positive size is treated as empty. */
blit_rect_mask(src: Image, mask: Image, src_rect: Rect2i, dst: Vector2i): void
/** Alpha-blends [param src_rect] from [param src] image to this image at coordinates [param dst], clipped accordingly to both image bounds. This image and [param src] image **must** have the same format. [param src_rect] with non-positive size is treated as empty. */
blend_rect(src: Image, src_rect: Rect2i, dst: Vector2i): void
/** Alpha-blends [param src_rect] from [param src] image to this image using [param mask] image at coordinates [param dst], clipped accordingly to both image bounds. Alpha channels are required for both [param src] and [param mask]. [param dst] pixels and [param src] pixels will blend if the corresponding mask pixel's alpha value is not 0. This image and [param src] image **must** have the same format. [param src] image and [param mask] image **must** have the same size (width and height) but they can have different formats. [param src_rect] with non-positive size is treated as empty. */
blend_rect_mask(src: Image, mask: Image, src_rect: Rect2i, dst: Vector2i): void
/** Fills the image with [param color]. */
fill(color: Color): void
/** Fills [param rect] with [param color]. */
fill_rect(rect: Rect2i, color: Color): void
/** Returns a [Rect2i] enclosing the visible portion of the image, considering each pixel with a non-zero alpha channel as visible. */
get_used_rect(): Rect2i
/** Returns a new [Image] that is a copy of this [Image]'s area specified with [param region]. */
get_region(region: Rect2i): null | Image
/** Copies [param src] image to this image. */
copy_from(src: Image): void
/** Returns the color of the pixel at [param point].
* This is the same as [method get_pixel], but with a [Vector2i] argument instead of two integer arguments.
*/
get_pixelv(point: Vector2i): Color
/** Returns the color of the pixel at `(x, y)`.
* This is the same as [method get_pixelv], but with two integer arguments instead of a [Vector2i] argument.
*/
get_pixel(x: int64, y: int64): Color
/** Sets the [Color] of the pixel at [param point] to [param color].
*
* This is the same as [method set_pixel], but with a [Vector2i] argument instead of two integer arguments.
*/
set_pixelv(point: Vector2i, color: Color): void
/** Sets the [Color] of the pixel at `(x, y)` to [param color].
*
* This is the same as [method set_pixelv], but with a two integer arguments instead of a [Vector2i] argument.
*/
set_pixel(x: int64, y: int64, color: Color): void
/** Adjusts this image's [param brightness], [param contrast], and [param saturation] by the given values. Does not work if the image is compressed (see [method is_compressed]). */
adjust_bcs(brightness: float64, contrast: float64, saturation: float64): void
/** Loads an image from the binary contents of a PNG file. */
load_png_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): Error
/** Loads an image from the binary contents of a JPEG file. */
load_jpg_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): Error
/** Loads an image from the binary contents of a WebP file. */
load_webp_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): Error
/** Loads an image from the binary contents of a TGA file.
*
* **Note:** This method is only available in engine builds with the TGA module enabled. By default, the TGA module is enabled, but it can be disabled at build-time using the `module_tga_enabled=no` SCons option.
*/
load_tga_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): Error
/** Loads an image from the binary contents of a BMP file.
*
* **Note:** Godot's BMP module doesn't support 16-bit per pixel images. Only 1-bit, 4-bit, 8-bit, 24-bit, and 32-bit per pixel images are supported.
*
* **Note:** This method is only available in engine builds with the BMP module enabled. By default, the BMP module is enabled, but it can be disabled at build-time using the `module_bmp_enabled=no` SCons option.
*/
load_bmp_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): Error
/** Loads an image from the binary contents of a [url=https://github.com/KhronosGroup/KTX-Software]KTX[/url] file. Unlike most image formats, KTX can store VRAM-compressed data and embed mipmaps.
*
* **Note:** Godot's libktx implementation only supports 2D images. Cubemaps, texture arrays, and de-padding are not supported.
*
* **Note:** This method is only available in engine builds with the KTX module enabled. By default, the KTX module is enabled, but it can be disabled at build-time using the `module_ktx_enabled=no` SCons option.
*/
load_ktx_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): Error
/** Loads an image from the binary contents of a DDS file.
*
* **Note:** This method is only available in engine builds with the DDS module enabled. By default, the DDS module is enabled, but it can be disabled at build-time using the `module_dds_enabled=no` SCons option.
*/
load_dds_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer): Error
/** Loads an image from the UTF-8 binary contents of an **uncompressed** SVG file (**.svg**).
*
* **Note:** Beware when using compressed SVG files (like **.svgz**), they need to be `decompressed` before loading.
*
* **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the `module_svg_enabled=no` SCons option.
*/
load_svg_from_buffer(buffer: PackedByteArray | byte[] | ArrayBuffer, scale?: float64 /* = 1 */): Error
/** Loads an image from the string contents of an SVG file (**.svg**).
*
* **Note:** This method is only available in engine builds with the SVG module enabled. By default, the SVG module is enabled, but it can be disabled at build-time using the `module_svg_enabled=no` SCons option.
*/
load_svg_from_string(svg_str: string, scale?: float64 /* = 1 */): Error
/** Holds all the image's color data in a given format. See [enum Format] constants. */
get data(): GDictionary
set data(value: GDictionary)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImage;
}
namespace ImageFormatLoader {
enum LoaderFlags {
FLAG_NONE = 0,
FLAG_FORCE_LINEAR = 1,
FLAG_CONVERT_COLORS = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImageFormatLoader extends __NameMapRefCounted {
}
/** Base class to add support for specific image formats.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_imageformatloader.html
*/
class ImageFormatLoader extends RefCounted {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImageFormatLoader;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImageFormatLoaderExtension extends __NameMapImageFormatLoader {
}
/** Base class for creating [ImageFormatLoader] extensions (adding support for extra image formats).
*
* @link https://docs.godotengine.org/en/4.5/classes/class_imageformatloaderextension.html
*/
class ImageFormatLoaderExtension extends ImageFormatLoader {
constructor(identifier?: any)
/** Returns the list of file extensions for this image format. Files with the given extensions will be treated as image file and loaded using this class. */
/* gdvirtual */ _get_recognized_extensions(): PackedStringArray
/** Loads the content of [param fileaccess] into the provided [param image]. */
/* gdvirtual */ _load_image(image: Image, fileaccess: FileAccess, flags: ImageFormatLoader.LoaderFlags, scale: float64): Error
/** Add this format loader to the engine, allowing it to recognize the file extensions returned by [method _get_recognized_extensions]. */
add_format_loader(): void
/** Remove this format loader from the engine. */
remove_format_loader(): void
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImageFormatLoaderExtension;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImageTexture extends __NameMapTexture2D {
}
/** A [Texture2D] based on an [Image].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_imagetexture.html
*/
class ImageTexture extends Texture2D {
constructor(identifier?: any)
/** Creates a new [ImageTexture] and initializes it by allocating and setting the data from an [Image]. */
static create_from_image(image: Image): ImageTexture
/** Returns the format of the texture. */
get_format(): Image.Format
/** Replaces the texture's data with a new [Image]. This will re-allocate new memory for the texture.
* If you want to update the image, but don't need to change its parameters (format, size), use [method update] instead for better performance.
*/
set_image(image: Image): void
/** Replaces the texture's data with a new [Image].
*
* **Note:** The texture has to be created using [method create_from_image] or initialized first with the [method set_image] method before it can be updated. The new image dimensions, format, and mipmaps configuration should match the existing texture's image configuration.
* Use this method over [method set_image] if you need to update the texture frequently, which is faster than allocating additional memory for a new texture each time.
*/
update(image: Image): void
/** Resizes the texture to the specified dimensions. */
set_size_override(size: Vector2i): void
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImageTexture;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImageTexture3D extends __NameMapTexture3D {
}
/** Texture with 3 dimensions.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_imagetexture3d.html
*/
class ImageTexture3D extends Texture3D {
constructor(identifier?: any)
/** Creates the [ImageTexture3D] with specified [param format], [param width], [param height], and [param depth]. If [param use_mipmaps] is `true`, generates mipmaps for the [ImageTexture3D]. */
create(format: Image.Format, width: int64, height: int64, depth: int64, use_mipmaps: boolean, data: GArray<Image>): Error
/** Replaces the texture's existing data with the layers specified in [param data]. The size of [param data] must match the parameters that were used for [method create]. In other words, the texture cannot be resized or have its format changed by calling [method update]. */
update(data: GArray<Image>): void
get _images(): GArray<Image>
set _images(value: GArray<Image>)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImageTexture3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImageTextureLayered extends __NameMapTextureLayered {
}
/** Base class for texture types which contain the data of multiple [ImageTexture]s. Each image is of the same size and format.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_imagetexturelayered.html
*/
class ImageTextureLayered extends TextureLayered {
constructor(identifier?: any)
/** Creates an [ImageTextureLayered] from an array of [Image]s. See [method Image.create] for the expected data format. The first image decides the width, height, image format and mipmapping setting. The other images *must* have the same width, height, image format and mipmapping setting.
* Each [Image] represents one `layer`.
*
*/
create_from_images(images: GArray<Image>): Error
/** Replaces the existing [Image] data at the given [param layer] with this new image.
* The given [Image] must have the same width, height, image format, and mipmapping flag as the rest of the referenced images.
* If the image format is unsupported, it will be decompressed and converted to a similar and supported [enum Image.Format].
* The update is immediate: it's synchronized with drawing.
*/
update_layer(image: Image, layer: int64): void
get _images(): GArray<Image>
set _images(value: GArray<Image>)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImageTextureLayered;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImmediateMesh extends __NameMapMesh {
}
/** Mesh optimized for creating geometry manually.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_immediatemesh.html
*/
class ImmediateMesh extends Mesh {
constructor(identifier?: any)
/** Begin a new surface. */
surface_begin(primitive: Mesh.PrimitiveType, material?: Material /* = undefined */): void
/** Set the color attribute that will be pushed with the next vertex. */
surface_set_color(color: Color): void
/** Set the normal attribute that will be pushed with the next vertex. */
surface_set_normal(normal: Vector3): void
/** Set the tangent attribute that will be pushed with the next vertex. */
surface_set_tangent(tangent: Plane): void
/** Set the UV attribute that will be pushed with the next vertex. */
surface_set_uv(uv: Vector2): void
/** Set the UV2 attribute that will be pushed with the next vertex. */
surface_set_uv2(uv2: Vector2): void
/** Add a 3D vertex using the current attributes previously set. */
surface_add_vertex(vertex: Vector3): void
/** Add a 2D vertex using the current attributes previously set. */
surface_add_vertex_2d(vertex: Vector2): void
/** End and commit current surface. Note that surface being created will not be visible until this function is called. */
surface_end(): void
/** Clear all surfaces. */
clear_surfaces(): void
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImmediateMesh;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImporterMesh extends __NameMapResource {
}
/** A [Resource] that contains vertex array-based geometry during the import process.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_importermesh.html
*/
class ImporterMesh extends Resource {
constructor(identifier?: any)
/** Adds name for a blend shape that will be added with [method add_surface]. Must be called before surface is added. */
add_blend_shape(name: string): void
/** Returns the number of blend shapes that the mesh holds. */
get_blend_shape_count(): int64
/** Returns the name of the blend shape at this index. */
get_blend_shape_name(blend_shape_idx: int64): string
/** Sets the blend shape mode. */
set_blend_shape_mode(mode: Mesh.BlendShapeMode): void
/** Returns the blend shape mode for this Mesh. */
get_blend_shape_mode(): Mesh.BlendShapeMode
/** Creates a new surface. [method Mesh.get_surface_count] will become the `surf_idx` for this new surface.
* Surfaces are created to be rendered using a [param primitive], which may be any of the values defined in [enum Mesh.PrimitiveType].
* The [param arrays] argument is an array of arrays. Each of the [constant Mesh.ARRAY_MAX] elements contains an array with some of the mesh data for this surface as described by the corresponding member of [enum Mesh.ArrayType] or `null` if it is not used by the surface. For example, `arrays[0]` is the array of vertices. That first vertex sub-array is always required; the others are optional. Adding an index array puts this surface into "index mode" where the vertex and other arrays become the sources of data and the index array defines the vertex order. All sub-arrays must have the same length as the vertex array (or be an exact multiple of the vertex array's length, when multiple elements of a sub-array correspond to a single vertex) or be empty, except for [constant Mesh.ARRAY_INDEX] if it is used.
* The [param blend_shapes] argument is an array of vertex data for each blend shape. Each element is an array of the same structure as [param arrays], but [constant Mesh.ARRAY_VERTEX], [constant Mesh.ARRAY_NORMAL], and [constant Mesh.ARRAY_TANGENT] are set if and only if they are set in [param arrays] and all other entries are `null`.
* The [param lods] argument is a dictionary with [float] keys and [PackedInt32Array] values. Each entry in the dictionary represents an LOD level of the surface, where the value is the [constant Mesh.ARRAY_INDEX] array to use for the LOD level and the key is roughly proportional to the distance at which the LOD stats being used. I.e., increasing the key of an LOD also increases the distance that the objects has to be from the camera before the LOD is used.
* The [param flags] argument is the bitwise OR of, as required: One value of [enum Mesh.ArrayCustomFormat] left shifted by `ARRAY_FORMAT_CUSTOMn_SHIFT` for each custom channel in use, [constant Mesh.ARRAY_FLAG_USE_DYNAMIC_UPDATE], [constant Mesh.ARRAY_FLAG_USE_8_BONE_WEIGHTS], or [constant Mesh.ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY].
*
* **Note:** When using indices, it is recommended to only use points, lines, or triangles.
*/
add_surface(primitive: Mesh.PrimitiveType, arrays: GArray, blend_shapes?: GArray<GArray> /* = [] */, lods?: GDictionary /* = new GDictionary() */, material?: Material /* = undefined */, name?: string /* = '' */, flags?: int64 /* = 0 */): void
/** Returns the number of surfaces that the mesh holds. */
get_surface_count(): int64
/** Returns the primitive type of the requested surface (see [method add_surface]). */
get_surface_primitive_type(surface_idx: int64): Mesh.PrimitiveType
/** Gets the name assigned to this surface. */
get_surface_name(surface_idx: int64): string
/** Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface. See [method add_surface]. */
get_surface_arrays(surface_idx: int64): GArray
/** Returns a single set of blend shape arrays for the requested blend shape index for a surface. */
get_surface_blend_shape_arrays(surface_idx: int64, blend_shape_idx: int64): GArray
/** Returns the number of lods that the mesh holds on a given surface. */
get_surface_lod_count(surface_idx: int64): int64
/** Returns the screen ratio which activates a lod for a surface. */
get_surface_lod_size(surface_idx: int64, lod_idx: int64): float64
/** Returns the index buffer of a lod for a surface. */
get_surface_lod_indices(surface_idx: int64, lod_idx: int64): PackedInt32Array
/** Returns a [Material] in a given surface. Surface is rendered using this material. */
get_surface_material(surface_idx: int64): null | Material
/** Returns the format of the surface that the mesh holds. */
get_surface_format(surface_idx: int64): int64
/** Sets a name for a given surface. */
set_surface_name(surface_idx: int64, name: string): void
/** Sets a [Material] for a given surface. Surface will be rendered using this material. */
set_surface_material(surface_idx: int64, material: Material): void
/** Generates all lods for this ImporterMesh.
* [param normal_merge_angle] is in degrees and used in the same way as the importer settings in `lods`.
* [param normal_split_angle] is not used and only remains for compatibility with older versions of the API.
* The number of generated lods can be accessed using [method get_surface_lod_count], and each LOD is available in [method get_surface_lod_size] and [method get_surface_lod_indices].
* [param bone_transform_array] is an [Array] which can be either empty or contain [Transform3D]s which, for each of the mesh's bone IDs, will apply mesh skinning when generating the LOD mesh variations. This is usually used to account for discrepancies in scale between the mesh itself and its skinning data.
*/
generate_lods(normal_merge_angle: float64, normal_split_angle: float64, bone_transform_array: GArray): void
/** Returns the mesh data represented by this [ImporterMesh] as a usable [ArrayMesh].
* This method caches the returned mesh, and subsequent calls will return the cached data until [method clear] is called.
* If not yet cached and [param base_mesh] is provided, [param base_mesh] will be used and mutated.
*/
get_mesh(base_mesh?: ArrayMesh /* = undefined */): null | ArrayMesh
/** Removes all surfaces and blend shapes from this [ImporterMesh]. */
clear(): void
/** Sets the size hint of this mesh for lightmap-unwrapping in UV-space. */
set_lightmap_size_hint(size: Vector2i): void
/** Returns the size hint of this mesh for lightmap-unwrapping in UV-space. */
get_lightmap_size_hint(): Vector2i
get _data(): GDictionary
set _data(value: GDictionary)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImporterMesh;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapImporterMeshInstance3D extends __NameMapNode3D {
}
/** @link https://docs.godotengine.org/en/4.5/classes/class_importermeshinstance3d.html */
class ImporterMeshInstance3D<Map extends NodePathMap = any> extends Node3D<Map> {
constructor(identifier?: any)
get mesh(): null | ImporterMesh
set mesh(value: null | ImporterMesh)
get skin(): null | Skin
set skin(value: null | Skin)
get skeleton_path(): NodePath
set skeleton_path(value: NodePath | string)
get layer_mask(): int64
set layer_mask(value: int64)
get cast_shadow(): int64
set cast_shadow(value: int64)
get visibility_range_begin(): float64
set visibility_range_begin(value: float64)
get visibility_range_begin_margin(): float64
set visibility_range_begin_margin(value: float64)
get visibility_range_end(): float64
set visibility_range_end(value: float64)
get visibility_range_end_margin(): float64
set visibility_range_end_margin(value: float64)
get visibility_range_fade_mode(): int64
set visibility_range_fade_mode(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapImporterMeshInstance3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEvent extends __NameMapResource {
}
/** Abstract base class for input events.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputevent.html
*/
class InputEvent extends Resource {
/** Device ID used for emulated mouse input from a touchscreen, or for emulated touch input from a mouse. This can be used to distinguish emulated mouse input from physical mouse input, or emulated touch input from physical touch input. */
static readonly DEVICE_ID_EMULATION = -1
constructor(identifier?: any)
/** Returns `true` if this input event matches a pre-defined action of any type.
* If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
*/
is_action(action: InputActionName, exact_match?: boolean /* = false */): boolean
/** Returns `true` if the given action matches this event and is being pressed (and is not an echo event for [InputEventKey] events, unless [param allow_echo] is `true`). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
* If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
*
* **Note:** Due to keyboard ghosting, [method is_action_pressed] may return `false` even if one of the action's keys is pressed. See [url=https://docs.godotengine.org/en/4.5/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
*/
is_action_pressed(action: InputActionName, allow_echo?: boolean /* = false */, exact_match?: boolean /* = false */): boolean
/** Returns `true` if the given action matches this event and is released (i.e. not pressed). Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
* If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
*/
is_action_released(action: InputActionName, exact_match?: boolean /* = false */): boolean
/** Returns a value between 0.0 and 1.0 depending on the given actions' state. Useful for getting the value of events of type [InputEventJoypadMotion].
* If [param exact_match] is `false`, it ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
*/
get_action_strength(action: InputActionName, exact_match?: boolean /* = false */): float64
/** Returns `true` if this input event has been canceled. */
is_canceled(): boolean
/** Returns `true` if this input event is pressed. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag].
*
* **Note:** Due to keyboard ghosting, [method is_pressed] may return `false` even if one of the action's keys is pressed. See [url=https://docs.godotengine.org/en/4.5/tutorials/inputs/input_examples.html#keyboard-events]Input examples[/url] in the documentation for more information.
*/
is_pressed(): boolean
/** Returns `true` if this input event is released. Not relevant for events of type [InputEventMouseMotion] or [InputEventScreenDrag]. */
is_released(): boolean
/** Returns `true` if this input event is an echo event (only for events of type [InputEventKey]). An echo event is a repeated key event sent when the user is holding down the key. Any other event type returns `false`.
*
* **Note:** The rate at which echo events are sent is typically around 20 events per second (after holding down the key for roughly half a second). However, the key repeat delay/speed can be changed by the user or disabled entirely in the operating system settings. To ensure your project works correctly on all configurations, do not assume the user has a specific key repeat configuration in your project's behavior.
*/
is_echo(): boolean
/** Returns a [String] representation of the event. */
as_text(): string
/** Returns `true` if the specified [param event] matches this event. Only valid for action events, which include key ([InputEventKey]), button ([InputEventMouseButton] or [InputEventJoypadButton]), axis [InputEventJoypadMotion], and action ([InputEventAction]) events.
* If [param exact_match] is `false`, the check ignores additional input modifiers for [InputEventKey] and [InputEventMouseButton] events, and the direction for [InputEventJoypadMotion] events.
*
* **Note:** This method only considers the event configuration (such as the keyboard key or the joypad axis), not state information like [method is_pressed], [method is_released], [method is_echo], or [method is_canceled].
*/
is_match(event: InputEvent, exact_match?: boolean /* = true */): boolean
/** Returns `true` if this input event's type is one that can be assigned to an input action: [InputEventKey], [InputEventMouseButton], [InputEventJoypadButton], [InputEventJoypadMotion], [InputEventAction]. Returns `false` for all other input event types. */
is_action_type(): boolean
/** Returns `true` if the given input event and this input event can be added together (only for events of type [InputEventMouseMotion]).
* The given input event's position, global position and speed will be copied. The resulting `relative` is a sum of both events. Both events' modifiers have to be identical.
*/
accumulate(with_event: InputEvent): boolean
/** Returns a copy of the given input event which has been offset by [param local_ofs] and transformed by [param xform]. Relevant for events of type [InputEventMouseButton], [InputEventMouseMotion], [InputEventScreenTouch], [InputEventScreenDrag], [InputEventMagnifyGesture] and [InputEventPanGesture]. */
xformed_by(xform: Transform2D, local_ofs?: Vector2 /* = Vector2.ZERO */): null | InputEvent
/** The event's device ID.
*
* **Note:** [member device] can be negative for special use cases that don't refer to devices physically present on the system. See [constant DEVICE_ID_EMULATION].
*/
get device(): int64
set device(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEvent;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventAction extends __NameMapInputEvent {
}
/** An input event type for actions.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventaction.html
*/
class InputEventAction extends InputEvent {
constructor(identifier?: any)
/** The action's name. This is usually the name of an existing action in the [InputMap] which you want this custom event to match. */
get action(): StringName
set action(value: StringName)
/** If `true`, the action's state is pressed. If `false`, the action's state is released. */
get pressed(): boolean
set pressed(value: boolean)
/** The action's strength between 0 and 1. This value is considered as equal to 0 if pressed is `false`. The event strength allows faking analog joypad motion events, by specifying how strongly the joypad axis is bent or pressed. */
get strength(): float64
set strength(value: float64)
/** The real event index in action this event corresponds to (from events defined for this action in the [InputMap]). If `-1`, a unique ID will be used and actions pressed with this ID will need to be released with another [InputEventAction]. */
get event_index(): int64
set event_index(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventAction;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventFromWindow extends __NameMapInputEvent {
}
/** Abstract base class for [Viewport]-based input events.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventfromwindow.html
*/
class InputEventFromWindow extends InputEvent {
constructor(identifier?: any)
/** The ID of a [Window] that received this event. */
get window_id(): int64
set window_id(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventFromWindow;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventGesture extends __NameMapInputEventWithModifiers {
}
/** Abstract base class for touch gestures.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventgesture.html
*/
class InputEventGesture extends InputEventWithModifiers {
constructor(identifier?: any)
/** The local gesture position relative to the [Viewport]. If used in [method Control._gui_input], the position is relative to the current [Control] that received this gesture. */
get position(): Vector2
set position(value: Vector2)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventGesture;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventJoypadButton extends __NameMapInputEvent {
}
/** Represents a gamepad button being pressed or released.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventjoypadbutton.html
*/
class InputEventJoypadButton extends InputEvent {
constructor(identifier?: any)
/** Button identifier. One of the [enum JoyButton] button constants. */
get button_index(): int64
set button_index(value: int64)
get pressure(): float64
set pressure(value: float64)
/** If `true`, the button's state is pressed. If `false`, the button's state is released. */
get pressed(): boolean
set pressed(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventJoypadButton;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventJoypadMotion extends __NameMapInputEvent {
}
/** Represents axis motions (such as joystick or analog triggers) from a gamepad.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventjoypadmotion.html
*/
class InputEventJoypadMotion extends InputEvent {
constructor(identifier?: any)
/** Axis identifier. */
get axis(): int64
set axis(value: int64)
/** Current position of the joystick on the given axis. The value ranges from `-1.0` to `1.0`. A value of `0` means the axis is in its resting position. */
get axis_value(): float64
set axis_value(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventJoypadMotion;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventKey extends __NameMapInputEventWithModifiers {
}
/** Represents a key on a keyboard being pressed or released.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventkey.html
*/
class InputEventKey extends InputEventWithModifiers {
constructor(identifier?: any)
/** Returns the Latin keycode combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers].
* To get a human-readable representation of the [InputEventKey] with modifiers, use `OS.get_keycode_string(event.get_keycode_with_modifiers())` where `event` is the [InputEventKey].
*/
get_keycode_with_modifiers(): Key
/** Returns the physical keycode combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers].
* To get a human-readable representation of the [InputEventKey] with modifiers, use `OS.get_keycode_string(event.get_physical_keycode_with_modifiers())` where `event` is the [InputEventKey].
*/
get_physical_keycode_with_modifiers(): Key
/** Returns the localized key label combined with modifier keys such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. See also [InputEventWithModifiers].
* To get a human-readable representation of the [InputEventKey] with modifiers, use `OS.get_keycode_string(event.get_key_label_with_modifiers())` where `event` is the [InputEventKey].
*/
get_key_label_with_modifiers(): Key
/** Returns a [String] representation of the event's [member keycode] and modifiers. */
as_text_keycode(): string
/** Returns a [String] representation of the event's [member physical_keycode] and modifiers. */
as_text_physical_keycode(): string
/** Returns a [String] representation of the event's [member key_label] and modifiers. */
as_text_key_label(): string
/** Returns a [String] representation of the event's [member location]. This will be a blank string if the event is not specific to a location. */
as_text_location(): string
/** If `true`, the key's state is pressed. If `false`, the key's state is released. */
get pressed(): boolean
set pressed(value: boolean)
/** Latin label printed on the key in the current keyboard layout, which corresponds to one of the [enum Key] constants.
* To get a human-readable representation of the [InputEventKey], use `OS.get_keycode_string(event.keycode)` where `event` is the [InputEventKey].
* [codeblock lang=text]
* +-----+ +-----+
* | Q | | Q | - "Q" - keycode
* | Й | | ض | - "Й" and "ض" - key_label
* +-----+ +-----+
* [/codeblock]
*/
get keycode(): int64
set keycode(value: int64)
/** Represents the physical location of a key on the 101/102-key US QWERTY keyboard, which corresponds to one of the [enum Key] constants.
* To get a human-readable representation of the [InputEventKey], use [method OS.get_keycode_string] in combination with [method DisplayServer.keyboard_get_keycode_from_physical]:
*
*/
get physical_keycode(): int64
set physical_keycode(value: int64)
/** Represents the localized label printed on the key in the current keyboard layout, which corresponds to one of the [enum Key] constants or any valid Unicode character.
* For keyboard layouts with a single label on the key, it is equivalent to [member keycode].
* To get a human-readable representation of the [InputEventKey], use `OS.get_keycode_string(event.key_label)` where `event` is the [InputEventKey].
* [codeblock lang=text]
* +-----+ +-----+
* | Q | | Q | - "Q" - keycode
* | Й | | ض | - "Й" and "ض" - key_label
* +-----+ +-----+
* [/codeblock]
*/
get key_label(): int64
set key_label(value: int64)
/** The key Unicode character code (when relevant), shifted by modifier keys. Unicode character codes for composite characters and complex scripts may not be available unless IME input mode is active. See [method Window.set_ime_active] for more information. */
get unicode(): int64
set unicode(value: int64)
/** Represents the location of a key which has both left and right versions, such as [kbd]Shift[/kbd] or [kbd]Alt[/kbd]. */
get location(): int64
set location(value: int64)
/** If `true`, the key was already pressed before this event. An echo event is a repeated key event sent when the user is holding down the key.
*
* **Note:** The rate at which echo events are sent is typically around 20 events per second (after holding down the key for roughly half a second). However, the key repeat delay/speed can be changed by the user or disabled entirely in the operating system settings. To ensure your project works correctly on all configurations, do not assume the user has a specific key repeat configuration in your project's behavior.
*/
get echo(): boolean
set echo(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventKey;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventMIDI extends __NameMapInputEvent {
}
/** Represents a MIDI message from a MIDI device, such as a musical keyboard.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventmidi.html
*/
class InputEventMIDI extends InputEvent {
constructor(identifier?: any)
/** The MIDI channel of this message, ranging from `0` to `15`. MIDI channel `9` is reserved for percussion instruments. */
get channel(): int64
set channel(value: int64)
/** Represents the type of MIDI message (see the [enum MIDIMessage] enum).
* For more information, see the [url=https://www.midi.org/specifications-old/item/table-2-expanded-messages-list-status-bytes]MIDI message status byte list chart[/url].
*/
get message(): int64
set message(value: int64)
/** The pitch index number of this MIDI message. This value ranges from `0` to `127`.
* On a piano, the **middle C** is `60`, followed by a **C-sharp** (`61`), then a **D** (`62`), and so on. Each octave is split in offsets of 12. See the "MIDI note number" column of the [url=https://en.wikipedia.org/wiki/Piano_key_frequencies]piano key frequency chart[/url] a full list.
*/
get pitch(): int64
set pitch(value: int64)
/** The velocity of the MIDI message. This value ranges from `0` to `127`. For a musical keyboard, this corresponds to how quickly the key was pressed, and is rarely above `110` in practice.
*
* **Note:** Some MIDI devices may send a [constant MIDI_MESSAGE_NOTE_ON] message with `0` velocity and expect it to be treated the same as a [constant MIDI_MESSAGE_NOTE_OFF] message. If necessary, this can be handled with a few lines of code:
*
*/
get velocity(): int64
set velocity(value: int64)
/** The instrument (also called *program* or *preset* ) used on this MIDI message. This value ranges from `0` to `127`.
* To see what each value means, refer to the [url=https://en.wikipedia.org/wiki/General_MIDI#Program_change_events]General MIDI's instrument list[/url]. Keep in mind that the list is off by 1 because it does not begin from 0. A value of `0` corresponds to the acoustic grand piano.
*/
get instrument(): int64
set instrument(value: int64)
/** The strength of the key being pressed. This value ranges from `0` to `127`.
*
* **Note:** For many devices, this value is always `0`. Other devices such as musical keyboards may simulate pressure by changing the [member velocity], instead.
*/
get pressure(): int64
set pressure(value: int64)
/** The unique number of the controller, if [member message] is [constant MIDI_MESSAGE_CONTROL_CHANGE], otherwise this is `0`. This value can be used to identify sliders for volume, balance, and panning, as well as switches and pedals on the MIDI device. See the [url=https://en.wikipedia.org/wiki/General_MIDI#Controller_events]General MIDI specification[/url] for a small list. */
get controller_number(): int64
set controller_number(value: int64)
/** The value applied to the controller. If [member message] is [constant MIDI_MESSAGE_CONTROL_CHANGE], this value ranges from `0` to `127`, otherwise it is `0`. See also [member controller_value]. */
get controller_value(): int64
set controller_value(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventMIDI;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventMagnifyGesture extends __NameMapInputEventGesture {
}
/** Represents a magnifying touch gesture.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventmagnifygesture.html
*/
class InputEventMagnifyGesture extends InputEventGesture {
constructor(identifier?: any)
/** The amount (or delta) of the event. This value is closer to `1.0` the slower the gesture is performed. */
get factor(): float64
set factor(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventMagnifyGesture;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventMouse extends __NameMapInputEventWithModifiers {
}
/** Base input event type for mouse events.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventmouse.html
*/
class InputEventMouse extends InputEventWithModifiers {
constructor(identifier?: any)
/** The mouse button mask identifier, one of or a bitwise combination of the [enum MouseButton] button masks. */
get button_mask(): int64
set button_mask(value: int64)
/** When received in [method Node._input] or [method Node._unhandled_input], returns the mouse's position in the [Viewport] this [Node] is in using the coordinate system of this [Viewport].
* When received in [method Control._gui_input], returns the mouse's position in the [Control] using the local coordinate system of the [Control].
*/
get position(): Vector2
set position(value: Vector2)
/** When received in [method Node._input] or [method Node._unhandled_input], returns the mouse's position in the root [Viewport] using the coordinate system of the root [Viewport].
* When received in [method Control._gui_input], returns the mouse's position in the [CanvasLayer] that the [Control] is in using the coordinate system of the [CanvasLayer].
*/
get global_position(): Vector2
set global_position(value: Vector2)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventMouse;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventMouseButton extends __NameMapInputEventMouse {
}
/** Represents a mouse button being pressed or released.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventmousebutton.html
*/
class InputEventMouseButton extends InputEventMouse {
constructor(identifier?: any)
/** The amount (or delta) of the event. When used for high-precision scroll events, this indicates the scroll amount (vertical or horizontal). This is only supported on some platforms; the reported sensitivity varies depending on the platform. May be `0` if not supported. */
get factor(): float64
set factor(value: float64)
/** The mouse button identifier, one of the [enum MouseButton] button or button wheel constants. */
get button_index(): int64
set button_index(value: int64)
/** If `true`, the mouse button event has been canceled. */
get canceled(): boolean
set canceled(value: boolean)
/** If `true`, the mouse button's state is pressed. If `false`, the mouse button's state is released. */
get pressed(): boolean
set pressed(value: boolean)
/** If `true`, the mouse button's state is a double-click. */
get double_click(): boolean
set double_click(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventMouseButton;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventMouseMotion extends __NameMapInputEventMouse {
}
/** Represents a mouse or a pen movement.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventmousemotion.html
*/
class InputEventMouseMotion extends InputEventMouse {
constructor(identifier?: any)
/** Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from `-1.0` to `1.0` for both axes. */
get tilt(): Vector2
set tilt(value: Vector2)
/** Represents the pressure the user puts on the pen. Ranges from `0.0` to `1.0`. */
get pressure(): float64
set pressure(value: float64)
/** Returns `true` when using the eraser end of a stylus pen.
*
* **Note:** This property is implemented on Linux, macOS and Windows.
*/
get pen_inverted(): boolean
set pen_inverted(value: boolean)
/** The mouse position relative to the previous position (position at the last frame).
*
* **Note:** Since [InputEventMouseMotion] may only be emitted when the mouse moves, it is not possible to reliably detect when the mouse has stopped moving by checking this property. A separate, short timer may be necessary.
*
* **Note:** [member relative] is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means mouse sensitivity will appear different depending on resolution when using [member relative] in a script that handles mouse aiming with the [constant Input.MOUSE_MODE_CAPTURED] mouse mode. To avoid this, use [member screen_relative] instead.
*/
get relative(): Vector2
set relative(value: Vector2)
/** The unscaled mouse position relative to the previous position in the coordinate system of the screen (position at the last frame).
*
* **Note:** Since [InputEventMouseMotion] may only be emitted when the mouse moves, it is not possible to reliably detect when the mouse has stopped moving by checking this property. A separate, short timer may be necessary.
*
* **Note:** This coordinate is *not* scaled according to the content scale factor or calls to [method InputEvent.xformed_by]. This should be preferred over [member relative] for mouse aiming when using the [constant Input.MOUSE_MODE_CAPTURED] mouse mode, regardless of the project's stretch mode.
*/
get screen_relative(): Vector2
set screen_relative(value: Vector2)
/** The mouse velocity in pixels per second.
*
* **Note:** [member velocity] is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. That means mouse sensitivity may appear different depending on resolution.
*
* **Note:** Use [member screen_relative] for mouse aiming using the [constant Input.MOUSE_MODE_CAPTURED] mouse mode.
*/
get velocity(): Vector2
set velocity(value: Vector2)
/** The unscaled mouse velocity in pixels per second in screen coordinates. This velocity is *not* scaled according to the content scale factor or calls to [method InputEvent.xformed_by].
*
* **Note:** Use [member screen_relative] for mouse aiming using the [constant Input.MOUSE_MODE_CAPTURED] mouse mode.
*/
get screen_velocity(): Vector2
set screen_velocity(value: Vector2)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventMouseMotion;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventPanGesture extends __NameMapInputEventGesture {
}
/** Represents a panning touch gesture.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventpangesture.html
*/
class InputEventPanGesture extends InputEventGesture {
constructor(identifier?: any)
/** Panning amount since last pan event. */
get delta(): Vector2
set delta(value: Vector2)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventPanGesture;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventScreenDrag extends __NameMapInputEventFromWindow {
}
/** Represents a screen drag event.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventscreendrag.html
*/
class InputEventScreenDrag extends InputEventFromWindow {
constructor(identifier?: any)
/** The drag event index in the case of a multi-drag event. */
get index(): int64
set index(value: int64)
/** Represents the angles of tilt of the pen. Positive X-coordinate value indicates a tilt to the right. Positive Y-coordinate value indicates a tilt toward the user. Ranges from `-1.0` to `1.0` for both axes. */
get tilt(): Vector2
set tilt(value: Vector2)
/** Represents the pressure the user puts on the pen. Ranges from `0.0` to `1.0`. */
get pressure(): float64
set pressure(value: float64)
/** Returns `true` when using the eraser end of a stylus pen. */
get pen_inverted(): boolean
set pen_inverted(value: boolean)
/** The drag position in the viewport the node is in, using the coordinate system of this viewport. */
get position(): Vector2
set position(value: Vector2)
/** The drag position relative to the previous position (position at the last frame).
*
* **Note:** [member relative] is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means touch sensitivity will appear different depending on resolution when using [member relative] in a script that handles touch aiming. To avoid this, use [member screen_relative] instead.
*/
get relative(): Vector2
set relative(value: Vector2)
/** The unscaled drag position relative to the previous position in screen coordinates (position at the last frame). This position is *not* scaled according to the content scale factor or calls to [method InputEvent.xformed_by]. This should be preferred over [member relative] for touch aiming regardless of the project's stretch mode. */
get screen_relative(): Vector2
set screen_relative(value: Vector2)
/** The drag velocity.
*
* **Note:** [member velocity] is automatically scaled according to the content scale factor, which is defined by the project's stretch mode settings. This means touch sensitivity will appear different depending on resolution when using [member velocity] in a script that handles touch aiming. To avoid this, use [member screen_velocity] instead.
*/
get velocity(): Vector2
set velocity(value: Vector2)
/** The unscaled drag velocity in pixels per second in screen coordinates. This velocity is *not* scaled according to the content scale factor or calls to [method InputEvent.xformed_by]. This should be preferred over [member velocity] for touch aiming regardless of the project's stretch mode. */
get screen_velocity(): Vector2
set screen_velocity(value: Vector2)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventScreenDrag;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventScreenTouch extends __NameMapInputEventFromWindow {
}
/** Represents a screen touch event.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventscreentouch.html
*/
class InputEventScreenTouch extends InputEventFromWindow {
constructor(identifier?: any)
/** The touch index in the case of a multi-touch event. One index = one finger. */
get index(): int64
set index(value: int64)
/** The touch position in the viewport the node is in, using the coordinate system of this viewport. */
get position(): Vector2
set position(value: Vector2)
/** If `true`, the touch event has been canceled. */
get canceled(): boolean
set canceled(value: boolean)
/** If `true`, the touch's state is pressed. If `false`, the touch's state is released. */
get pressed(): boolean
set pressed(value: boolean)
/** If `true`, the touch's state is a double tap. */
get double_tap(): boolean
set double_tap(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventScreenTouch;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventShortcut extends __NameMapInputEvent {
}
/** Represents a triggered keyboard [Shortcut].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventshortcut.html
*/
class InputEventShortcut extends InputEvent {
constructor(identifier?: any)
/** The [Shortcut] represented by this event. Its [method Shortcut.matches_event] method will always return `true` for this event. */
get shortcut(): null | Shortcut
set shortcut(value: null | Shortcut)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventShortcut;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInputEventWithModifiers extends __NameMapInputEventFromWindow {
}
/** Abstract base class for input events affected by modifier keys like [kbd]Shift[/kbd] and [kbd]Alt[/kbd].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_inputeventwithmodifiers.html
*/
class InputEventWithModifiers extends InputEventFromWindow {
constructor(identifier?: any)
/** On macOS, returns `true` if [kbd]Meta[/kbd] ([kbd]Cmd[/kbd]) is pressed.
* On other platforms, returns `true` if [kbd]Ctrl[/kbd] is pressed.
*/
is_command_or_control_pressed(): boolean
/** Returns the keycode combination of modifier keys. */
get_modifiers_mask(): KeyModifierMask
/** Automatically use [kbd]Meta[/kbd] ([kbd]Cmd[/kbd]) on macOS and [kbd]Ctrl[/kbd] on other platforms. If `true`, [member ctrl_pressed] and [member meta_pressed] cannot be set. */
get command_or_control_autoremap(): boolean
set command_or_control_autoremap(value: boolean)
/** State of the [kbd]Alt[/kbd] modifier. */
get alt_pressed(): boolean
set alt_pressed(value: boolean)
/** State of the [kbd]Shift[/kbd] modifier. */
get shift_pressed(): boolean
set shift_pressed(value: boolean)
/** State of the [kbd]Ctrl[/kbd] modifier. */
get ctrl_pressed(): boolean
set ctrl_pressed(value: boolean)
/** State of the [kbd]Meta[/kbd] modifier. On Windows and Linux, this represents the Windows key (sometimes called "meta" or "super" on Linux). On macOS, this represents the Command key. */
get meta_pressed(): boolean
set meta_pressed(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInputEventWithModifiers;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapInstancePlaceholder extends __NameMapNode {
}
/** Placeholder for the root [Node] of a [PackedScene].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_instanceplaceholder.html
*/
class InstancePlaceholder<Map extends NodePathMap = any> extends Node<Map> {
constructor(identifier?: any)
/** Returns the list of properties that will be applied to the node when [method create_instance] is called.
* If [param with_order] is `true`, a key named `.order` (note the leading period) is added to the dictionary. This `.order` key is an [Array] of [String] property names specifying the order in which properties will be applied (with index 0 being the first).
*/
get_stored_values(with_order?: boolean /* = false */): GDictionary
/** Call this method to actually load in the node. The created node will be placed as a sibling *above* the [InstancePlaceholder] in the scene tree. The [Node]'s reference is also returned for convenience.
*
* **Note:** [method create_instance] is not thread-safe. Use [method Object.call_deferred] if calling from a thread.
*/
create_instance(replace?: boolean /* = false */, custom_scene?: PackedScene /* = undefined */): Node
/** Gets the path to the [PackedScene] resource file that is loaded by default when calling [method create_instance]. Not thread-safe. Use [method Object.call_deferred] if calling from a thread. */
get_instance_path(): string
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapInstancePlaceholder;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapIntervalTweener extends __NameMapTweener {
}
/** Creates an idle interval in a [Tween] animation.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_intervaltweener.html
*/
class IntervalTweener extends Tweener {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapIntervalTweener;
}
namespace ItemList {
enum IconMode {
/** Icon is drawn above the text. */
ICON_MODE_TOP = 0,
/** Icon is drawn to the left of the text. */
ICON_MODE_LEFT = 1,
}
enum SelectMode {
/** Only allow selecting a single item. */
SELECT_SINGLE = 0,
/** Allows selecting multiple items by holding [kbd]Ctrl[/kbd] or [kbd]Shift[/kbd]. */
SELECT_MULTI = 1,
/** Allows selecting multiple items by toggling them on and off. */
SELECT_TOGGLE = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapItemList extends __NameMapControl {
}
/** A vertical list of selectable items with one or multiple columns.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_itemlist.html
*/
class ItemList<Map extends NodePathMap = any> extends Control<Map> {
constructor(identifier?: any)
/** Adds an item to the item list with specified text. Returns the index of an added item.
* Specify an [param icon], or use `null` as the [param icon] for a list item with no icon.
* If [param selectable] is `true`, the list item will be selectable.
*/
add_item(text: string, icon?: Texture2D /* = undefined */, selectable?: boolean /* = true */): int64
/** Adds an item to the item list with no text, only an icon. Returns the index of an added item. */
add_icon_item(icon: Texture2D, selectable?: boolean /* = true */): int64
/** Sets text of the item associated with the specified index. */
set_item_text(idx: int64, text: string): void
/** Returns the text associated with the specified index. */
get_item_text(idx: int64): string
/** Sets (or replaces) the icon's [Texture2D] associated with the specified index. */
set_item_icon(idx: int64, icon: Texture2D): void
/** Returns the icon associated with the specified index. */
get_item_icon(idx: int64): null | Texture2D
/** Sets item's text base writing direction. */
set_item_text_direction(idx: int64, direction: Control.TextDirection): void
/** Returns item's text base writing direction. */
get_item_text_direction(idx: int64): Control.TextDirection
/** Sets language code of item's text used for line-breaking and text shaping algorithms, if left empty current locale is used instead. */
set_item_language(idx: int64, language: string): void
/** Returns item's text language code. */
get_item_language(idx: int64): string
/** Sets the auto translate mode of the item associated with the specified index.
* Items use [constant Node.AUTO_TRANSLATE_MODE_INHERIT] by default, which uses the same auto translate mode as the [ItemList] itself.
*/
set_item_auto_translate_mode(idx: int64, mode: Node.AutoTranslateMode): void
/** Returns item's auto translate mode. */
get_item_auto_translate_mode(idx: int64): Node.AutoTranslateMode
/** Sets whether the item icon will be drawn transposed. */
set_item_icon_transposed(idx: int64, transposed: boolean): void
/** Returns `true` if the item icon will be drawn transposed, i.e. the X and Y axes are swapped. */
is_item_icon_transposed(idx: int64): boolean
/** Sets the region of item's icon used. The whole icon will be used if the region has no area. */
set_item_icon_region(idx: int64, rect: Rect2): void
/** Returns the region of item's icon used. The whole icon will be used if the region has no area. */
get_item_icon_region(idx: int64): Rect2
/** Sets a modulating [Color] of the item associated with the specified index. */
set_item_icon_modulate(idx: int64, modulate: Color): void
/** Returns a [Color] modulating item's icon at the specified index. */
get_item_icon_modulate(idx: int64): Color
/** Allows or disallows selection of the item associated with the specified index. */
set_item_selectable(idx: int64, selectable: boolean): void
/** Returns `true` if the item at the specified index is selectable. */
is_item_selectable(idx: int64): boolean
/** Disables (or enables) the item at the specified index.
* Disabled items cannot be selected and do not trigger activation signals (when double-clicking or pressing [kbd]Enter[/kbd]).
*/
set_item_disabled(idx: int64, disabled: boolean): void
/** Returns `true` if the item at the specified index is disabled. */
is_item_disabled(idx: int64): boolean
/** Sets a value (of any type) to be stored with the item associated with the specified index. */
set_item_metadata(idx: int64, metadata: any): void
/** Returns the metadata value of the specified index. */
get_item_metadata(idx: int64): any
/** Sets the background color of the item specified by [param idx] index to the specified [Color]. */
set_item_custom_bg_color(idx: int64, custom_bg_color: Color): void
/** Returns the custom background color of the item specified by [param idx] index. */
get_item_custom_bg_color(idx: int64): Color
/** Sets the foreground color of the item specified by [param idx] index to the specified [Color]. */
set_item_custom_fg_color(idx: int64, custom_fg_color: Color): void
/** Returns the custom foreground color of the item specified by [param idx] index. */
get_item_custom_fg_color(idx: int64): Color
/** Returns the position and size of the item with the specified index, in the coordinate system of the [ItemList] node. If [param expand] is `true` the last column expands to fill the rest of the row.
*
* **Note:** The returned value is unreliable if called right after modifying the [ItemList], before it redraws in the next frame.
*/
get_item_rect(idx: int64, expand?: boolean /* = true */): Rect2
/** Sets whether the tooltip hint is enabled for specified item index. */
set_item_tooltip_enabled(idx: int64, enable: boolean): void
/** Returns `true` if the tooltip is enabled for specified item index. */
is_item_tooltip_enabled(idx: int64): boolean
/** Sets the tooltip hint for the item associated with the specified index. */
set_item_tooltip(idx: int64, tooltip: string): void
/** Returns the tooltip hint associated with the specified index. */
get_item_tooltip(idx: int64): string
/** Select the item at the specified index.
*
* **Note:** This method does not trigger the item selection signal.
*/
select(idx: int64, single?: boolean /* = true */): void
/** Ensures the item associated with the specified index is not selected. */
deselect(idx: int64): void
/** Ensures there are no items selected. */
deselect_all(): void
/** Returns `true` if the item at the specified index is currently selected. */
is_selected(idx: int64): boolean
/** Returns an array with the indexes of the selected items. */
get_selected_items(): PackedInt32Array
/** Moves item from index [param from_idx] to [param to_idx]. */
move_item(from_idx: int64, to_idx: int64): void
/** Removes the item specified by [param idx] index from the list. */
remove_item(idx: int64): void
/** Removes all items from the list. */
clear(): void
/** Sorts items in the list by their text. */
sort_items_by_text(): void
/** Returns `true` if one or more items are selected. */
is_anything_selected(): boolean
/** Returns the item index at the given [param position].
* When there is no item at that point, -1 will be returned if [param exact] is `true`, and the closest item index will be returned otherwise.
*
* **Note:** The returned value is unreliable if called right after modifying the [ItemList], before it redraws in the next frame.
*/
get_item_at_position(position: Vector2, exact?: boolean /* = false */): int64
/** Ensure current selection is visible, adjusting the scroll position as necessary. */
ensure_current_is_visible(): void
/** Returns the vertical scrollbar.
* **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
*/
get_v_scroll_bar(): null | VScrollBar
/** Returns the horizontal scrollbar.
* **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member CanvasItem.visible] property.
*/
get_h_scroll_bar(): null | HScrollBar
/** Forces an update to the list size based on its items. This happens automatically whenever size of the items, or other relevant settings like [member auto_height], change. The method can be used to trigger the update ahead of next drawing pass. */
force_update_list_size(): void
/** Allows single or multiple item selection. See the [enum SelectMode] constants. */
get select_mode(): int64
set select_mode(value: int64)
/** If `true`, the currently selected item can be selected again. */
get allow_reselect(): boolean
set allow_reselect(value: boolean)
/** If `true`, right mouse button click can select items. */
get allow_rmb_select(): boolean
set allow_rmb_select(value: boolean)
/** If `true`, allows navigating the [ItemList] with letter keys through incremental search. */
get allow_search(): boolean
set allow_search(value: boolean)
/** Maximum lines of text allowed in each item. Space will be reserved even when there is not enough lines of text to display.
*
* **Note:** This property takes effect only when [member icon_mode] is [constant ICON_MODE_TOP]. To make the text wrap, [member fixed_column_width] should be greater than zero.
*/
get max_text_lines(): int64
set max_text_lines(value: int64)
/** If `true`, the control will automatically resize the width to fit its content. */
get auto_width(): boolean
set auto_width(value: boolean)
/** If `true`, the control will automatically resize the height to fit its content. */
get auto_height(): boolean
set auto_height(value: boolean)
/** The clipping behavior when the text exceeds an item's bounding rectangle. */
get text_overrun_behavior(): int64
set text_overrun_behavior(value: int64)
/** If `true`, the control will automatically move items into a new row to fit its content. See also [HFlowContainer] for this behavior.
* If `false`, the control will add a horizontal scrollbar to make all items visible.
*/
get wraparound_items(): boolean
set wraparound_items(value: boolean)
/** The number of items currently in the list. */
get item_count(): int64
set item_count(value: int64)
/** Maximum columns the list will have.
* If greater than zero, the content will be split among the specified columns.
* A value of zero means unlimited columns, i.e. all items will be put in the same row.
*/
get max_columns(): int64
set max_columns(value: int64)
/** Whether all columns will have the same width.
* If `true`, the width is equal to the largest column width of all columns.
*/
get same_column_width(): boolean
set same_column_width(value: boolean)
/** The width all columns will be adjusted to.
* A value of zero disables the adjustment, each item will have a width equal to the width of its content and the columns will have an uneven width.
*/
get fixed_column_width(): int64
set fixed_column_width(value: int64)
/** The icon position, whether above or to the left of the text. See the [enum IconMode] constants. */
get icon_mode(): int64
set icon_mode(value: int64)
/** The scale of icon applied after [member fixed_icon_size] and transposing takes effect. */
get icon_scale(): float64
set icon_scale(value: float64)
/** The size all icons will be adjusted to.
* If either X or Y component is not greater than zero, icon size won't be affected.
*/
get fixed_icon_size(): Vector2i
set fixed_icon_size(value: Vector2i)
/** Emitted when specified item has been selected. Only applicable in single selection mode.
* [member allow_reselect] must be enabled to reselect an item.
*/
readonly item_selected: Signal<(index: int64) => void>
/** Emitted when any mouse click is issued within the rect of the list but on empty space.
* [param at_position] is the click position in this control's local coordinate system.
*/
readonly empty_clicked: Signal<(at_position: Vector2, mouse_button_index: int64) => void>
/** Emitted when specified list item has been clicked with any mouse button.
* [param at_position] is the click position in this control's local coordinate system.
*/
readonly item_clicked: Signal<(index: int64, at_position: Vector2, mouse_button_index: int64) => void>
/** Emitted when a multiple selection is altered on a list allowing multiple selection. */
readonly multi_selected: Signal<(index: int64, selected: boolean) => void>
/** Emitted when specified list item is activated via double-clicking or by pressing [kbd]Enter[/kbd]. */
readonly item_activated: Signal<(index: int64) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapItemList;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapJNISingleton extends __NameMapObject {
}
/** Singleton that connects the engine with Android plugins to interface with native Android code.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_jnisingleton.html
*/
class JNISingleton extends Object {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapJNISingleton;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapJSON extends __NameMapResource {
}
/** Helper class for creating and parsing JSON data.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_json.html
*/
class JSON extends Resource {
constructor(identifier?: any)
/** Converts a [Variant] var to JSON text and returns the result. Useful for serializing data to store or send over the network.
*
* **Note:** The JSON specification does not define integer or float types, but only a *number* type. Therefore, converting a Variant to JSON text will convert all numerical values to [float] types.
*
* **Note:** If [param full_precision] is `true`, when stringifying floats, the unreliable digits are stringified in addition to the reliable digits to guarantee exact decoding.
* The [param indent] parameter controls if and how something is indented; its contents will be used where there should be an indent in the output. Even spaces like `" "` will work. `\t` and `\n` can also be used for a tab indent, or to make a newline for each indent respectively.
* **Example output:**
*
*/
static stringify(data: any, indent?: string /* = '' */, sort_keys?: boolean /* = true */, full_precision?: boolean /* = false */): string
/** Attempts to parse the [param json_string] provided and returns the parsed data. Returns `null` if parse failed. */
static parse_string(json_string: string): any
/** Attempts to parse the [param json_text] provided.
* Returns an [enum Error]. If the parse was successful, it returns [constant OK] and the result can be retrieved using [member data]. If unsuccessful, use [method get_error_line] and [method get_error_message] to identify the source of the failure.
* Non-static variant of [method parse_string], if you want custom error handling.
* The optional [param keep_text] argument instructs the parser to keep a copy of the original text. This text can be obtained later by using the [method get_parsed_text] function and is used when saving the resource (instead of generating new text from [member data]).
*/
parse(json_text: string, keep_text?: boolean /* = false */): Error
/** Return the text parsed by [method parse] (requires passing `keep_text` to [method parse]). */
get_parsed_text(): string
/** Returns `0` if the last call to [method parse] was successful, or the line number where the parse failed. */
get_error_line(): int64
/** Returns an empty string if the last call to [method parse] was successful, or the error message if it failed. */
get_error_message(): string
/** Converts a native engine type to a JSON-compliant value.
* By default, objects are ignored for security reasons, unless [param full_objects] is `true`.
* You can convert a native value to a JSON string like this:
*
*/
static from_native(variant: any, full_objects?: boolean /* = false */): any
/** Converts a JSON-compliant value that was created with [method from_native] back to native engine types.
* By default, objects are ignored for security reasons, unless [param allow_objects] is `true`.
* You can convert a JSON string back to a native value like this:
*
*/
static to_native(json: any, allow_objects?: boolean /* = false */): any
/** Contains the parsed JSON data in [Variant] form. */
get data(): any
set data(value: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapJSON;
}
namespace JSONRPC {
enum ErrorCode {
/** The request could not be parsed as it was not valid by JSON standard ([method JSON.parse] failed). */
PARSE_ERROR = -32700,
/** A method call was requested but the request's format is not valid. */
INVALID_REQUEST = -32600,
/** A method call was requested but no function of that name existed in the JSONRPC subclass. */
METHOD_NOT_FOUND = -32601,
/** A method call was requested but the given method parameters are not valid. Not used by the built-in JSONRPC. */
INVALID_PARAMS = -32602,
/** An internal error occurred while processing the request. Not used by the built-in JSONRPC. */
INTERNAL_ERROR = -32603,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapJSONRPC extends __NameMapObject {
}
/** A helper to handle dictionaries which look like JSONRPC documents.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_jsonrpc.html
*/
class JSONRPC extends Object {
constructor(identifier?: any)
/** Registers a callback for the given method name.
* - [param name] The name that clients can use to access the callback.
* - [param callback] The callback which will handle the specific method.
*/
set_method(name: string, callback: Callable): void
/** Given a Dictionary which takes the form of a JSON-RPC request: unpack the request and run it. Methods are resolved by looking at the field called "method" and looking for an equivalently named function in the JSONRPC object. If one is found that method is called.
* To add new supported methods extend the JSONRPC class and call [method process_action] on your subclass.
* [param action]: The action to be run, as a Dictionary in the form of a JSON-RPC request or notification.
*/
process_action(action: any, recurse?: boolean /* = false */): any
process_string(action: string): string
/** Returns a dictionary in the form of a JSON-RPC request. Requests are sent to a server with the expectation of a response. The ID field is used for the server to specify which exact request it is responding to.
* - [param method]: Name of the method being called.
* - [param params]: An array or dictionary of parameters being passed to the method.
* - [param id]: Uniquely identifies this request. The server is expected to send a response with the same ID.
*/
make_request(method: string, params: any, id: any): GDictionary
/** When a server has received and processed a request, it is expected to send a response. If you did not want a response then you need to have sent a Notification instead.
* - [param result]: The return value of the function which was called.
* - [param id]: The ID of the request this response is targeted to.
*/
make_response(result: any, id: any): GDictionary
/** Returns a dictionary in the form of a JSON-RPC notification. Notifications are one-shot messages which do not expect a response.
* - [param method]: Name of the method being called.
* - [param params]: An array or dictionary of parameters being passed to the method.
*/
make_notification(method: string, params: any): GDictionary
/** Creates a response which indicates a previous reply has failed in some way.
* - [param code]: The error code corresponding to what kind of error this is. See the [enum ErrorCode] constants.
* - [param message]: A custom message about this error.
* - [param id]: The request this error is a response to.
*/
make_response_error(code: int64, message: string, id?: any /* = <any> {} */): GDictionary
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapJSONRPC;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapJavaClass extends __NameMapRefCounted {
}
/** Represents a class from the Java Native Interface.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_javaclass.html
*/
class JavaClass extends RefCounted {
constructor(identifier?: any)
/** Returns the Java class name. */
get_java_class_name(): string
/** Returns the object's Java methods and their signatures as an [Array] of dictionaries, in the same format as [method Object.get_method_list]. */
get_java_method_list(): GArray<GDictionary>
/** Returns a [JavaClass] representing the Java parent class of this class. */
get_java_parent_class(): null | JavaClass
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapJavaClass;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapJavaObject extends __NameMapRefCounted {
}
/** Represents an object from the Java Native Interface.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_javaobject.html
*/
class JavaObject extends RefCounted {
constructor(identifier?: any)
/** Returns the [JavaClass] that this object is an instance of. */
get_java_class(): null | JavaClass
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapJavaObject;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapJavaScriptObject extends __NameMapRefCounted {
}
/** A wrapper class for web native JavaScript objects.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_javascriptobject.html
*/
class JavaScriptObject extends RefCounted {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapJavaScriptObject;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapJoint2D extends __NameMapNode2D {
}
/** Abstract base class for all 2D physics joints.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_joint2d.html
*/
class Joint2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** Returns the joint's internal [RID] from the [PhysicsServer2D]. */
get_rid(): RID
/** Path to the first body (A) attached to the joint. The node must inherit [PhysicsBody2D]. */
get node_a(): NodePath
set node_a(value: NodePath | string)
/** Path to the second body (B) attached to the joint. The node must inherit [PhysicsBody2D]. */
get node_b(): NodePath
set node_b(value: NodePath | string)
/** When [member node_a] and [member node_b] move in different directions the [member bias] controls how fast the joint pulls them back to their original position. The lower the [member bias] the more the two bodies can pull on the joint.
* When set to `0`, the default value from [member ProjectSettings.physics/2d/solver/default_constraint_bias] is used.
*/
get bias(): float64
set bias(value: float64)
/** If `true`, the two bodies bound together do not collide with each other. */
get disable_collision(): boolean
set disable_collision(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapJoint2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapJoint3D extends __NameMapNode3D {
}
/** Abstract base class for all 3D physics joints.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_joint3d.html
*/
class Joint3D<Map extends NodePathMap = any> extends Node3D<Map> {
constructor(identifier?: any)
/** Returns the joint's internal [RID] from the [PhysicsServer3D]. */
get_rid(): RID
/** Path to the first node (A) attached to the joint. The node must inherit [PhysicsBody3D].
* If left empty and [member node_b] is set, the body is attached to a fixed [StaticBody3D] without collision shapes.
*/
get node_a(): NodePath
set node_a(value: NodePath | string)
/** Path to the second node (B) attached to the joint. The node must inherit [PhysicsBody3D].
* If left empty and [member node_a] is set, the body is attached to a fixed [StaticBody3D] without collision shapes.
*/
get node_b(): NodePath
set node_b(value: NodePath | string)
/** The priority used to define which solver is executed first for multiple joints. The lower the value, the higher the priority. */
get solver_priority(): int64
set solver_priority(value: int64)
/** If `true`, the two bodies bound together do not collide with each other. */
get exclude_nodes_from_collision(): boolean
set exclude_nodes_from_collision(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapJoint3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapKinematicCollision2D extends __NameMapRefCounted {
}
/** Holds collision data from the movement of a [PhysicsBody2D].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_kinematiccollision2d.html
*/
class KinematicCollision2D extends RefCounted {
constructor(identifier?: any)
/** Returns the point of collision in global coordinates. */
get_position(): Vector2
/** Returns the colliding body's shape's normal at the point of collision. */
get_normal(): Vector2
/** Returns the moving object's travel before collision. */
get_travel(): Vector2
/** Returns the moving object's remaining movement vector. */
get_remainder(): Vector2
/** Returns the collision angle according to [param up_direction], which is [constant Vector2.UP] by default. This value is always positive. */
get_angle(up_direction?: Vector2 /* = new Vector2(0, -1) */): float64
/** Returns the colliding body's length of overlap along the collision normal. */
get_depth(): float64
/** Returns the moving object's colliding shape. */
get_local_shape(): null | Object
/** Returns the colliding body's attached [Object]. */
get_collider(): null | Object
/** Returns the unique instance ID of the colliding body's attached [Object]. See [method Object.get_instance_id]. */
get_collider_id(): int64
/** Returns the colliding body's [RID] used by the [PhysicsServer2D]. */
get_collider_rid(): RID
/** Returns the colliding body's shape. */
get_collider_shape(): null | Object
/** Returns the colliding body's shape index. See [CollisionObject2D]. */
get_collider_shape_index(): int64
/** Returns the colliding body's velocity. */
get_collider_velocity(): Vector2
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapKinematicCollision2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapKinematicCollision3D extends __NameMapRefCounted {
}
/** Holds collision data from the movement of a [PhysicsBody3D].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_kinematiccollision3d.html
*/
class KinematicCollision3D extends RefCounted {
constructor(identifier?: any)
/** Returns the moving object's travel before collision. */
get_travel(): Vector3
/** Returns the moving object's remaining movement vector. */
get_remainder(): Vector3
/** Returns the colliding body's length of overlap along the collision normal. */
get_depth(): float64
/** Returns the number of detected collisions. */
get_collision_count(): int64
/** Returns the point of collision in global coordinates given a collision index (the deepest collision by default). */
get_position(collision_index?: int64 /* = 0 */): Vector3
/** Returns the colliding body's shape's normal at the point of collision given a collision index (the deepest collision by default). */
get_normal(collision_index?: int64 /* = 0 */): Vector3
/** Returns the collision angle according to [param up_direction], which is [constant Vector3.UP] by default. This value is always positive. */
get_angle(collision_index?: int64 /* = 0 */, up_direction?: Vector3 /* = Vector3.ZERO */): float64
/** Returns the moving object's colliding shape given a collision index (the deepest collision by default). */
get_local_shape(collision_index?: int64 /* = 0 */): null | Object
/** Returns the colliding body's attached [Object] given a collision index (the deepest collision by default). */
get_collider(collision_index?: int64 /* = 0 */): null | Object
/** Returns the unique instance ID of the colliding body's attached [Object] given a collision index (the deepest collision by default). See [method Object.get_instance_id]. */
get_collider_id(collision_index?: int64 /* = 0 */): int64
/** Returns the colliding body's [RID] used by the [PhysicsServer3D] given a collision index (the deepest collision by default). */
get_collider_rid(collision_index?: int64 /* = 0 */): RID
/** Returns the colliding body's shape given a collision index (the deepest collision by default). */
get_collider_shape(collision_index?: int64 /* = 0 */): null | Object
/** Returns the colliding body's shape index given a collision index (the deepest collision by default). See [CollisionObject3D]. */
get_collider_shape_index(collision_index?: int64 /* = 0 */): int64
/** Returns the colliding body's velocity given a collision index (the deepest collision by default). */
get_collider_velocity(collision_index?: int64 /* = 0 */): Vector3
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapKinematicCollision3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLabel extends __NameMapControl {
}
/** A control for displaying plain text.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_label.html
*/
class Label<Map extends NodePathMap = any> extends Control<Map> {
constructor(identifier?: any)
/** Returns the height of the line [param line].
* If [param line] is set to `-1`, returns the biggest line height.
* If there are no lines, returns font size in pixels.
*/
get_line_height(line?: int64 /* = -1 */): int64
/** Returns the number of lines of text the Label has. */
get_line_count(): int64
/** Returns the number of lines shown. Useful if the [Label]'s height cannot currently display all lines. */
get_visible_line_count(): int64
/** Returns the total number of printable characters in the text (excluding spaces and newlines). */
get_total_character_count(): int64
/** Returns the bounding rectangle of the character at position [param pos] in the label's local coordinate system. If the character is a non-visual character or [param pos] is outside the valid range, an empty [Rect2] is returned. If the character is a part of a composite grapheme, the bounding rectangle of the whole grapheme is returned. */
get_character_bounds(pos: int64): Rect2
/** The text to display on screen. */
get text(): string
set text(value: string)
/** A [LabelSettings] resource that can be shared between multiple [Label] nodes. Takes priority over theme properties. */
get label_settings(): null | LabelSettings
set label_settings(value: null | LabelSettings)
/** Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify). */
get horizontal_alignment(): int64
set horizontal_alignment(value: int64)
/** Controls the text's vertical alignment. Supports top, center, bottom, and fill. */
get vertical_alignment(): int64
set vertical_alignment(value: int64)
/** If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. */
get autowrap_mode(): int64
set autowrap_mode(value: int64)
/** Autowrap space trimming flags. See [constant TextServer.BREAK_TRIM_START_EDGE_SPACES] and [constant TextServer.BREAK_TRIM_END_EDGE_SPACES] for more info. */
get autowrap_trim_flags(): int64
set autowrap_trim_flags(value: int64)
/** Line fill alignment rules. */
get justification_flags(): int64
set justification_flags(value: int64)
/** String used as a paragraph separator. Each paragraph is processed independently, in its own BiDi context. */
get paragraph_separator(): string
set paragraph_separator(value: string)
/** If `true`, the Label only shows the text that fits inside its bounding rectangle and will clip text horizontally. */
get clip_text(): boolean
set clip_text(value: boolean)
/** The clipping behavior when the text exceeds the node's bounding rectangle. */
get text_overrun_behavior(): int64
set text_overrun_behavior(value: int64)
/** Ellipsis character used for text clipping. */
get ellipsis_char(): string
set ellipsis_char(value: string)
/** If `true`, all the text displays as UPPERCASE. */
get uppercase(): boolean
set uppercase(value: boolean)
/** Aligns text to the given tab-stops. */
get tab_stops(): PackedFloat32Array
set tab_stops(value: PackedFloat32Array | float32[])
/** The number of the lines ignored and not displayed from the start of the [member text] value. */
get lines_skipped(): int64
set lines_skipped(value: int64)
/** Limits the lines of text the node shows on screen. */
get max_lines_visible(): int64
set max_lines_visible(value: int64)
/** The number of characters to display. If set to `-1`, all characters are displayed. This can be useful when animating the text appearing in a dialog box.
*
* **Note:** Setting this property updates [member visible_ratio] accordingly.
*
* **Note:** Characters are counted as Unicode codepoints. A single visible grapheme may contain multiple codepoints (e.g. certain emoji use three codepoints). A single codepoint may contain two UTF-16 characters, which are used in C# strings.
*/
get visible_characters(): int64
set visible_characters(value: int64)
/** The clipping behavior when [member visible_characters] or [member visible_ratio] is set. */
get visible_characters_behavior(): int64
set visible_characters_behavior(value: int64)
/** The fraction of characters to display, relative to the total number of characters (see [method get_total_character_count]). If set to `1.0`, all characters are displayed. If set to `0.5`, only half of the characters will be displayed. This can be useful when animating the text appearing in a dialog box.
*
* **Note:** Setting this property updates [member visible_characters] accordingly.
*/
get visible_ratio(): float64
set visible_ratio(value: float64)
/** Base text writing direction. */
get text_direction(): int64
set text_direction(value: int64)
/** Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. */
get language(): string
set language(value: string)
/** Set BiDi algorithm override for the structured text. */
get structured_text_bidi_override(): int64
set structured_text_bidi_override(value: int64)
/** Set additional options for BiDi override. */
get structured_text_bidi_override_options(): GArray
set structured_text_bidi_override_options(value: GArray)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLabel;
}
namespace Label3D {
enum DrawFlags {
/** If set, lights in the environment affect the label. */
FLAG_SHADED = 0,
/** If set, text can be seen from the back as well. If not, the text is invisible when looking at it from behind. */
FLAG_DOUBLE_SIDED = 1,
/** Disables the depth test, so this object is drawn on top of all others. However, objects drawn after it in the draw order may cover it. */
FLAG_DISABLE_DEPTH_TEST = 2,
/** Label is scaled by depth so that it always appears the same size on screen. */
FLAG_FIXED_SIZE = 3,
/** Represents the size of the [enum DrawFlags] enum. */
FLAG_MAX = 4,
}
enum AlphaCutMode {
/** This mode performs standard alpha blending. It can display translucent areas, but transparency sorting issues may be visible when multiple transparent materials are overlapping. [member GeometryInstance3D.cast_shadow] has no effect when this transparency mode is used; the [Label3D] will never cast shadows. */
ALPHA_CUT_DISABLED = 0,
/** This mode only allows fully transparent or fully opaque pixels. Harsh edges will be visible unless some form of screen-space antialiasing is enabled (see [member ProjectSettings.rendering/anti_aliasing/quality/screen_space_aa]). This mode is also known as *alpha testing* or *1-bit transparency* .
*
* **Note:** This mode might have issues with anti-aliased fonts and outlines, try adjusting [member alpha_scissor_threshold] or using MSDF font.
*
* **Note:** When using text with overlapping glyphs (e.g., cursive scripts), this mode might have transparency sorting issues between the main text and the outline.
*/
ALPHA_CUT_DISCARD = 1,
/** This mode draws fully opaque pixels in the depth prepass. This is slower than [constant ALPHA_CUT_DISABLED] or [constant ALPHA_CUT_DISCARD], but it allows displaying translucent areas and smooth edges while using proper sorting.
*
* **Note:** When using text with overlapping glyphs (e.g., cursive scripts), this mode might have transparency sorting issues between the main text and the outline.
*/
ALPHA_CUT_OPAQUE_PREPASS = 2,
/** This mode draws cuts off all values below a spatially-deterministic threshold, the rest will remain opaque. */
ALPHA_CUT_HASH = 3,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLabel3D extends __NameMapGeometryInstance3D {
}
/** A node for displaying plain text in 3D space.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_label3d.html
*/
class Label3D<Map extends NodePathMap = any> extends GeometryInstance3D<Map> {
constructor(identifier?: any)
/** If `true`, the specified [param flag] will be enabled. */
set_draw_flag(flag: Label3D.DrawFlags, enabled: boolean): void
/** Returns the value of the specified flag. */
get_draw_flag(flag: Label3D.DrawFlags): boolean
/** Returns a [TriangleMesh] with the label's vertices following its current configuration (such as its [member pixel_size]). */
generate_triangle_mesh(): null | TriangleMesh
/** The size of one pixel's width on the label to scale it in 3D. To make the font look more detailed when up close, increase [member font_size] while decreasing [member pixel_size] at the same time. */
get pixel_size(): float64
set pixel_size(value: float64)
/** The text drawing offset (in pixels). */
get offset(): Vector2
set offset(value: Vector2)
/** The billboard mode to use for the label. */
get billboard(): int64
set billboard(value: int64)
/** If `true`, the [Light3D] in the [Environment] has effects on the label. */
get shaded(): boolean
set shaded(value: boolean)
/** If `true`, text can be seen from the back as well, if `false`, it is invisible when looking at it from behind. */
get double_sided(): boolean
set double_sided(value: boolean)
/** If `true`, depth testing is disabled and the object will be drawn in render order. */
get no_depth_test(): boolean
set no_depth_test(value: boolean)
/** If `true`, the label is rendered at the same size regardless of distance. The label's size on screen is the same as if the camera was `1.0` units away from the label's origin, regardless of the actual distance from the camera. The [Camera3D]'s field of view (or [member Camera3D.size] when in orthogonal/frustum mode) still affects the size the label is drawn at. */
get fixed_size(): boolean
set fixed_size(value: boolean)
/** The alpha cutting mode to use for the sprite. */
get alpha_cut(): int64
set alpha_cut(value: int64)
/** Threshold at which the alpha scissor will discard values. */
get alpha_scissor_threshold(): float64
set alpha_scissor_threshold(value: float64)
/** The hashing scale for Alpha Hash. Recommended values between `0` and `2`. */
get alpha_hash_scale(): float64
set alpha_hash_scale(value: float64)
/** The type of alpha antialiasing to apply. */
get alpha_antialiasing_mode(): int64
set alpha_antialiasing_mode(value: int64)
/** Threshold at which antialiasing will be applied on the alpha channel. */
get alpha_antialiasing_edge(): float64
set alpha_antialiasing_edge(value: float64)
/** Filter flags for the texture. */
get texture_filter(): int64
set texture_filter(value: int64)
/** Sets the render priority for the text. Higher priority objects will be sorted in front of lower priority objects.
*
* **Note:** This only applies if [member alpha_cut] is set to [constant ALPHA_CUT_DISABLED] (default value).
*
* **Note:** This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
*/
get render_priority(): int64
set render_priority(value: int64)
/** Sets the render priority for the text outline. Higher priority objects will be sorted in front of lower priority objects.
*
* **Note:** This only applies if [member alpha_cut] is set to [constant ALPHA_CUT_DISABLED] (default value).
*
* **Note:** This only applies to sorting of transparent objects. This will not impact how transparent objects are sorted relative to opaque objects. This is because opaque objects are not sorted, while transparent objects are sorted from back to front (subject to priority).
*/
get outline_render_priority(): int64
set outline_render_priority(value: int64)
/** Text [Color] of the [Label3D]. */
get modulate(): Color
set modulate(value: Color)
/** The tint of text outline. */
get outline_modulate(): Color
set outline_modulate(value: Color)
/** The text to display on screen. */
get text(): string
set text(value: string)
/** Font configuration used to display text. */
get font(): null | Font
set font(value: null | Font)
/** Font size of the [Label3D]'s text. To make the font look more detailed when up close, increase [member font_size] while decreasing [member pixel_size] at the same time.
* Higher font sizes require more time to render new characters, which can cause stuttering during gameplay.
*/
get font_size(): int64
set font_size(value: int64)
/** Text outline size. */
get outline_size(): int64
set outline_size(value: int64)
/** Controls the text's horizontal alignment. Supports left, center, right, and fill (also known as justify). */
get horizontal_alignment(): int64
set horizontal_alignment(value: int64)
/** Controls the text's vertical alignment. Supports top, center, and bottom. */
get vertical_alignment(): int64
set vertical_alignment(value: int64)
/** If `true`, all the text displays as UPPERCASE. */
get uppercase(): boolean
set uppercase(value: boolean)
/** Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative. */
get line_spacing(): float64
set line_spacing(value: float64)
/** If set to something other than [constant TextServer.AUTOWRAP_OFF], the text gets wrapped inside the node's bounding rectangle. If you resize the node, it will change its height automatically to show all the text. */
get autowrap_mode(): int64
set autowrap_mode(value: int64)
/** Autowrap space trimming flags. See [constant TextServer.BREAK_TRIM_START_EDGE_SPACES] and [constant TextServer.BREAK_TRIM_END_EDGE_SPACES] for more info. */
get autowrap_trim_flags(): int64
set autowrap_trim_flags(value: int64)
/** Line fill alignment rules. */
get justification_flags(): int64
set justification_flags(value: int64)
/** Text width (in pixels), used for autowrap and fill alignment. */
get width(): float64
set width(value: float64)
/** Base text writing direction. */
get text_direction(): int64
set text_direction(value: int64)
/** Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. */
get language(): string
set language(value: string)
/** Set BiDi algorithm override for the structured text. */
get structured_text_bidi_override(): int64
set structured_text_bidi_override(value: int64)
/** Set additional options for BiDi override. */
get structured_text_bidi_override_options(): GArray
set structured_text_bidi_override_options(value: GArray)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLabel3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLabelSettings extends __NameMapResource {
}
/** Provides common settings to customize the text in a [Label].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_labelsettings.html
*/
class LabelSettings extends Resource {
constructor(identifier?: any)
/** Adds a new stacked outline to the label at the given [param index]. If [param index] is `-1`, the new stacked outline will be added at the end of the list. */
add_stacked_outline(index?: int64 /* = -1 */): void
/** Moves the stacked outline at index [param from_index] to the given position [param to_position] in the array. */
move_stacked_outline(from_index: int64, to_position: int64): void
/** Removes the stacked outline at index [param index]. */
remove_stacked_outline(index: int64): void
/** Sets the size of the stacked outline identified by the given [param index] to [param size]. */
set_stacked_outline_size(index: int64, size: int64): void
/** Returns the size of the stacked outline at [param index]. */
get_stacked_outline_size(index: int64): int64
/** Sets the color of the stacked outline identified by the given [param index] to [param color]. */
set_stacked_outline_color(index: int64, color: Color): void
/** Returns the color of the stacked outline at [param index]. */
get_stacked_outline_color(index: int64): Color
/** Adds a new stacked shadow to the label at the given [param index]. If [param index] is `-1`, the new stacked shadow will be added at the end of the list. */
add_stacked_shadow(index?: int64 /* = -1 */): void
/** Moves the stacked shadow at index [param from_index] to the given position [param to_position] in the array. */
move_stacked_shadow(from_index: int64, to_position: int64): void
/** Removes the stacked shadow at index [param index]. */
remove_stacked_shadow(index: int64): void
/** Sets the offset of the stacked shadow identified by the given [param index] to [param offset]. */
set_stacked_shadow_offset(index: int64, offset: Vector2): void
/** Returns the offset of the stacked shadow at [param index]. */
get_stacked_shadow_offset(index: int64): Vector2
/** Sets the color of the stacked shadow identified by the given [param index] to [param color]. */
set_stacked_shadow_color(index: int64, color: Color): void
/** Returns the color of the stacked shadow at [param index]. */
get_stacked_shadow_color(index: int64): Color
/** Sets the outline size of the stacked shadow identified by the given [param index] to [param size]. */
set_stacked_shadow_outline_size(index: int64, size: int64): void
/** Returns the outline size of the stacked shadow at [param index]. */
get_stacked_shadow_outline_size(index: int64): int64
/** Additional vertical spacing between lines (in pixels), spacing is added to line descent. This value can be negative. */
get line_spacing(): float64
set line_spacing(value: float64)
/** Vertical space between paragraphs. Added on top of [member line_spacing]. */
get paragraph_spacing(): float64
set paragraph_spacing(value: float64)
/** [Font] used for the text. */
get font(): null | Font
set font(value: null | Font)
/** Size of the text. */
get font_size(): int64
set font_size(value: int64)
/** Color of the text. */
get font_color(): Color
set font_color(value: Color)
/** Text outline size. */
get outline_size(): int64
set outline_size(value: int64)
/** The color of the outline. */
get outline_color(): Color
set outline_color(value: Color)
/** Size of the shadow effect. */
get shadow_size(): int64
set shadow_size(value: int64)
/** Color of the shadow effect. If alpha is `0`, no shadow will be drawn. */
get shadow_color(): Color
set shadow_color(value: Color)
/** Offset of the shadow effect, in pixels. */
get shadow_offset(): Vector2
set shadow_offset(value: Vector2)
/** The number of stacked outlines. */
get stacked_outline_count(): int64
set stacked_outline_count(value: int64)
/** The number of stacked shadows. */
get stacked_shadow_count(): int64
set stacked_shadow_count(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLabelSettings;
}
namespace Light2D {
enum ShadowFilter {
/** No filter applies to the shadow map. This provides hard shadow edges and is the fastest to render. See [member shadow_filter]. */
SHADOW_FILTER_NONE = 0,
/** Percentage closer filtering (5 samples) applies to the shadow map. This is slower compared to hard shadow rendering. See [member shadow_filter]. */
SHADOW_FILTER_PCF5 = 1,
/** Percentage closer filtering (13 samples) applies to the shadow map. This is the slowest shadow filtering mode, and should be used sparingly. See [member shadow_filter]. */
SHADOW_FILTER_PCF13 = 2,
}
enum BlendMode {
/** Adds the value of pixels corresponding to the Light2D to the values of pixels under it. This is the common behavior of a light. */
BLEND_MODE_ADD = 0,
/** Subtracts the value of pixels corresponding to the Light2D to the values of pixels under it, resulting in inversed light effect. */
BLEND_MODE_SUB = 1,
/** Mix the value of pixels corresponding to the Light2D to the values of pixels under it by linear interpolation. */
BLEND_MODE_MIX = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLight2D extends __NameMapNode2D {
}
/** Casts light in a 2D environment.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_light2d.html
*/
class Light2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** Sets the light's height, which is used in 2D normal mapping. See [member PointLight2D.height] and [member DirectionalLight2D.height]. */
set_height(height: float64): void
/** Returns the light's height, which is used in 2D normal mapping. See [member PointLight2D.height] and [member DirectionalLight2D.height]. */
get_height(): float64
/** If `true`, Light2D will emit light. */
get enabled(): boolean
set enabled(value: boolean)
/** If `true`, Light2D will only appear when editing the scene. */
get editor_only(): boolean
set editor_only(value: boolean)
/** The Light2D's [Color]. */
get color(): Color
set color(value: Color)
/** The Light2D's energy value. The larger the value, the stronger the light. */
get energy(): float64
set energy(value: float64)
/** The Light2D's blend mode. */
get blend_mode(): int64
set blend_mode(value: int64)
/** Minimum `z` value of objects that are affected by the Light2D. */
get range_z_min(): int64
set range_z_min(value: int64)
/** Maximum `z` value of objects that are affected by the Light2D. */
get range_z_max(): int64
set range_z_max(value: int64)
/** Minimum layer value of objects that are affected by the Light2D. */
get range_layer_min(): int64
set range_layer_min(value: int64)
/** Maximum layer value of objects that are affected by the Light2D. */
get range_layer_max(): int64
set range_layer_max(value: int64)
/** The layer mask. Only objects with a matching [member CanvasItem.light_mask] will be affected by the Light2D. See also [member shadow_item_cull_mask], which affects which objects can cast shadows.
*
* **Note:** [member range_item_cull_mask] is ignored by [DirectionalLight2D], which will always light a 2D node regardless of the 2D node's [member CanvasItem.light_mask].
*/
get range_item_cull_mask(): int64
set range_item_cull_mask(value: int64)
/** If `true`, the Light2D will cast shadows. */
get shadow_enabled(): boolean
set shadow_enabled(value: boolean)
/** [Color] of shadows cast by the Light2D. */
get shadow_color(): Color
set shadow_color(value: Color)
/** Shadow filter type. */
get shadow_filter(): int64
set shadow_filter(value: int64)
/** Smoothing value for shadows. Higher values will result in softer shadows, at the cost of visible streaks that can appear in shadow rendering. [member shadow_filter_smooth] only has an effect if [member shadow_filter] is [constant SHADOW_FILTER_PCF5] or [constant SHADOW_FILTER_PCF13]. */
get shadow_filter_smooth(): float64
set shadow_filter_smooth(value: float64)
/** The shadow mask. Used with [LightOccluder2D] to cast shadows. Only occluders with a matching [member CanvasItem.light_mask] will cast shadows. See also [member range_item_cull_mask], which affects which objects can *receive* the light. */
get shadow_item_cull_mask(): int64
set shadow_item_cull_mask(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLight2D;
}
namespace Light3D {
enum Param {
/** Constant for accessing [member light_energy]. */
PARAM_ENERGY = 0,
/** Constant for accessing [member light_indirect_energy]. */
PARAM_INDIRECT_ENERGY = 1,
/** Constant for accessing [member light_volumetric_fog_energy]. */
PARAM_VOLUMETRIC_FOG_ENERGY = 2,
/** Constant for accessing [member light_specular]. */
PARAM_SPECULAR = 3,
/** Constant for accessing [member OmniLight3D.omni_range] or [member SpotLight3D.spot_range]. */
PARAM_RANGE = 4,
/** Constant for accessing [member light_size]. */
PARAM_SIZE = 5,
/** Constant for accessing [member OmniLight3D.omni_attenuation] or [member SpotLight3D.spot_attenuation]. */
PARAM_ATTENUATION = 6,
/** Constant for accessing [member SpotLight3D.spot_angle]. */
PARAM_SPOT_ANGLE = 7,
/** Constant for accessing [member SpotLight3D.spot_angle_attenuation]. */
PARAM_SPOT_ATTENUATION = 8,
/** Constant for accessing [member DirectionalLight3D.directional_shadow_max_distance]. */
PARAM_SHADOW_MAX_DISTANCE = 9,
/** Constant for accessing [member DirectionalLight3D.directional_shadow_split_1]. */
PARAM_SHADOW_SPLIT_1_OFFSET = 10,
/** Constant for accessing [member DirectionalLight3D.directional_shadow_split_2]. */
PARAM_SHADOW_SPLIT_2_OFFSET = 11,
/** Constant for accessing [member DirectionalLight3D.directional_shadow_split_3]. */
PARAM_SHADOW_SPLIT_3_OFFSET = 12,
/** Constant for accessing [member DirectionalLight3D.directional_shadow_fade_start]. */
PARAM_SHADOW_FADE_START = 13,
/** Constant for accessing [member shadow_normal_bias]. */
PARAM_SHADOW_NORMAL_BIAS = 14,
/** Constant for accessing [member shadow_bias]. */
PARAM_SHADOW_BIAS = 15,
/** Constant for accessing [member DirectionalLight3D.directional_shadow_pancake_size]. */
PARAM_SHADOW_PANCAKE_SIZE = 16,
/** Constant for accessing [member shadow_opacity]. */
PARAM_SHADOW_OPACITY = 17,
/** Constant for accessing [member shadow_blur]. */
PARAM_SHADOW_BLUR = 18,
/** Constant for accessing [member shadow_transmittance_bias]. */
PARAM_TRANSMITTANCE_BIAS = 19,
/** Constant for accessing [member light_intensity_lumens] and [member light_intensity_lux]. Only used when [member ProjectSettings.rendering/lights_and_shadows/use_physical_light_units] is `true`. */
PARAM_INTENSITY = 20,
/** Represents the size of the [enum Param] enum. */
PARAM_MAX = 21,
}
enum BakeMode {
/** Light is ignored when baking. This is the fastest mode, but the light will not be taken into account when baking global illumination. This mode should generally be used for dynamic lights that change quickly, as the effect of global illumination is less noticeable on those lights.
*
* **Note:** Hiding a light does *not* affect baking [LightmapGI]. Hiding a light will still affect baking [VoxelGI] and SDFGI (see [member Environment.sdfgi_enabled]).
*/
BAKE_DISABLED = 0,
/** Light is taken into account in static baking ([VoxelGI], [LightmapGI], SDFGI ([member Environment.sdfgi_enabled])). The light can be moved around or modified, but its global illumination will not update in real-time. This is suitable for subtle changes (such as flickering torches), but generally not large changes such as toggling a light on and off.
*
* **Note:** The light is not baked in [LightmapGI] if [member editor_only] is `true`.
*/
BAKE_STATIC = 1,
/** Light is taken into account in dynamic baking ([VoxelGI] and SDFGI ([member Environment.sdfgi_enabled]) only). The light can be moved around or modified with global illumination updating in real-time. The light's global illumination appearance will be slightly different compared to [constant BAKE_STATIC]. This has a greater performance cost compared to [constant BAKE_STATIC]. When using SDFGI, the update speed of dynamic lights is affected by [member ProjectSettings.rendering/global_illumination/sdfgi/frames_to_update_lights]. */
BAKE_DYNAMIC = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLight3D extends __NameMapVisualInstance3D {
}
/** Provides a base class for different kinds of light nodes.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_light3d.html
*/
class Light3D<Map extends NodePathMap = any> extends VisualInstance3D<Map> {
constructor(identifier?: any)
/** Sets the value of the specified [enum Light3D.Param] parameter. */
set_param(param: Light3D.Param, value: float64): void
/** Returns the value of the specified [enum Light3D.Param] parameter. */
get_param(param: Light3D.Param): float64
/** Returns the [Color] of an idealized blackbody at the given [member light_temperature]. This value is calculated internally based on the [member light_temperature]. This [Color] is multiplied by [member light_color] before being sent to the [RenderingServer]. */
get_correlated_color(): Color
/** Used by positional lights ([OmniLight3D] and [SpotLight3D]) when [member ProjectSettings.rendering/lights_and_shadows/use_physical_light_units] is `true`. Sets the intensity of the light source measured in Lumens. Lumens are a measure of luminous flux, which is the total amount of visible light emitted by a light source per unit of time.
* For [SpotLight3D]s, we assume that the area outside the visible cone is surrounded by a perfect light absorbing material. Accordingly, the apparent brightness of the cone area does not change as the cone increases and decreases in size.
* A typical household lightbulb can range from around 600 lumens to 1,200 lumens, a candle is about 13 lumens, while a streetlight can be approximately 60,000 lumens.
*/
get light_intensity_lumens(): float64
set light_intensity_lumens(value: float64)
/** Used by [DirectionalLight3D]s when [member ProjectSettings.rendering/lights_and_shadows/use_physical_light_units] is `true`. Sets the intensity of the light source measured in Lux. Lux is a measure of luminous flux per unit area, it is equal to one lumen per square meter. Lux is the measure of how much light hits a surface at a given time.
* On a clear sunny day a surface in direct sunlight may be approximately 100,000 lux, a typical room in a home may be approximately 50 lux, while the moonlit ground may be approximately 0.1 lux.
*/
get light_intensity_lux(): float64
set light_intensity_lux(value: float64)
/** Sets the color temperature of the light source, measured in Kelvin. This is used to calculate a correlated color temperature which tints the [member light_color].
* The sun on a cloudy day is approximately 6500 Kelvin, on a clear day it is between 5500 to 6000 Kelvin, and on a clear day at sunrise or sunset it ranges to around 1850 Kelvin.
*/
get light_temperature(): float64
set light_temperature(value: float64)
/** The light's color in the nonlinear sRGB color space. An *overbright* color can be used to achieve a result equivalent to increasing the light's [member light_energy]. */
get light_color(): Color
set light_color(value: Color)
/** The light's strength multiplier (this is not a physical unit). For [OmniLight3D] and [SpotLight3D], changing this value will only change the light color's intensity, not the light's radius. */
get light_energy(): float64
set light_energy(value: float64)
/** Secondary multiplier used with indirect light (light bounces). Used with [VoxelGI] and SDFGI (see [member Environment.sdfgi_enabled]).
*
* **Note:** This property is ignored if [member light_energy] is equal to `0.0`, as the light won't be present at all in the GI shader.
*/
get light_indirect_energy(): float64
set light_indirect_energy(value: float64)
/** Secondary multiplier multiplied with [member light_energy] then used with the [Environment]'s volumetric fog (if enabled). If set to `0.0`, computing volumetric fog will be skipped for this light, which can improve performance for large amounts of lights when volumetric fog is enabled.
*
* **Note:** To prevent short-lived dynamic light effects from poorly interacting with volumetric fog, lights used in those effects should have [member light_volumetric_fog_energy] set to `0.0` unless [member Environment.volumetric_fog_temporal_reprojection_enabled] is disabled (or unless the reprojection amount is significantly lowered).
*/
get light_volumetric_fog_energy(): float64
set light_volumetric_fog_energy(value: float64)
/** [Texture2D] projected by light. [member shadow_enabled] must be on for the projector to work. Light projectors make the light appear as if it is shining through a colored but transparent object, almost like light shining through stained-glass.
*
* **Note:** Unlike [BaseMaterial3D] whose filter mode can be adjusted on a per-material basis, the filter mode for light projector textures is set globally with [member ProjectSettings.rendering/textures/light_projectors/filter].
*
* **Note:** Light projector textures are only supported in the Forward+ and Mobile rendering methods, not Compatibility.
*/
get light_projector(): null | Texture2D | any /*-AnimatedTexture*/ | any /*-AtlasTexture*/ | any /*-CameraTexture*/ | any /*-CanvasTexture*/ | any /*-MeshTexture*/ | any /*-Texture2DRD*/ | any /*-ViewportTexture*/
set light_projector(value: null | Texture2D | any /*-AnimatedTexture*/ | any /*-AtlasTexture*/ | any /*-CameraTexture*/ | any /*-CanvasTexture*/ | any /*-MeshTexture*/ | any /*-Texture2DRD*/ | any /*-ViewportTexture*/)
/** The size of the light in Godot units. Only available for [OmniLight3D]s and [SpotLight3D]s. Increasing this value will make the light fade out slower and shadows appear blurrier (also called percentage-closer soft shadows, or PCSS). This can be used to simulate area lights to an extent. Increasing this value above `0.0` for lights with shadows enabled will have a noticeable performance cost due to PCSS.
*
* **Note:** [member light_size] is not affected by [member Node3D.scale] (the light's scale or its parent's scale).
*
* **Note:** PCSS for positional lights is only supported in the Forward+ and Mobile rendering methods, not Compatibility.
*/
get light_size(): float64
set light_size(value: float64)
/** The light's angular size in degrees. Increasing this will make shadows softer at greater distances (also called percentage-closer soft shadows, or PCSS). Only available for [DirectionalLight3D]s. For reference, the Sun from the Earth is approximately `0.5`. Increasing this value above `0.0` for lights with shadows enabled will have a noticeable performance cost due to PCSS.
*
* **Note:** [member light_angular_distance] is not affected by [member Node3D.scale] (the light's scale or its parent's scale).
*
* **Note:** PCSS for directional lights is only supported in the Forward+ rendering method, not Mobile or Compatibility.
*/
get light_angular_distance(): float64
set light_angular_distance(value: float64)
/** If `true`, the light's effect is reversed, darkening areas and casting bright shadows. */
get light_negative(): boolean
set light_negative(value: boolean)
/** The intensity of the specular blob in objects affected by the light. At `0`, the light becomes a pure diffuse light. When not baking emission, this can be used to avoid unrealistic reflections when placing lights above an emissive surface. */
get light_specular(): float64
set light_specular(value: float64)
/** The light's bake mode. This will affect the global illumination techniques that have an effect on the light's rendering.
*
* **Note:** Meshes' global illumination mode will also affect the global illumination rendering. See [member GeometryInstance3D.gi_mode].
*/
get light_bake_mode(): int64
set light_bake_mode(value: int64)
/** The light will affect objects in the selected layers.
*
* **Note:** The light cull mask is ignored by [VoxelGI], SDFGI, [LightmapGI], and volumetric fog. These will always render lights in a way that ignores the cull mask. See also [member VisualInstance3D.layers].
*/
get light_cull_mask(): int64
set light_cull_mask(value: int64)
/** If `true`, the light will cast real-time shadows. This has a significant performance cost. Only enable shadow rendering when it makes a noticeable difference in the scene's appearance, and consider using [member distance_fade_enabled] to hide the light when far away from the [Camera3D]. */
get shadow_enabled(): boolean
set shadow_enabled(value: boolean)
/** Used to adjust shadow appearance. Too small a value results in self-shadowing ("shadow acne"), while too large a value causes shadows to separate from casters ("peter-panning"). Adjust as needed. */
get shadow_bias(): float64
set shadow_bias(value: float64)
/** Offsets the lookup into the shadow map by the object's normal. This can be used to reduce self-shadowing artifacts without using [member shadow_bias]. In practice, this value should be tweaked along with [member shadow_bias] to reduce artifacts as much as possible. */
get shadow_normal_bias(): float64
set shadow_normal_bias(value: float64)
/** If `true`, reverses the backface culling of the mesh. This can be useful when you have a flat mesh that has a light behind it. If you need to cast a shadow on both sides of the mesh, set the mesh to use double-sided shadows with [constant GeometryInstance3D.SHADOW_CASTING_SETTING_DOUBLE_SIDED]. */
get shadow_reverse_cull_face(): boolean
set shadow_reverse_cull_face(value: boolean)
get shadow_transmittance_bias(): float64
set shadow_transmittance_bias(value: float64)
/** The opacity to use when rendering the light's shadow map. Values lower than `1.0` make the light appear through shadows. This can be used to fake global illumination at a low performance cost. */
get shadow_opacity(): float64
set shadow_opacity(value: float64)
/** Blurs the edges of the shadow. Can be used to hide pixel artifacts in low-resolution shadow maps. A high value can impact performance, make shadows appear grainy and can cause other unwanted artifacts. Try to keep as near default as possible. */
get shadow_blur(): float64
set shadow_blur(value: float64)
/** The light will only cast shadows using objects in the selected layers. */
get shadow_caster_mask(): int64
set shadow_caster_mask(value: int64)
/** If `true`, the light will smoothly fade away when far from the active [Camera3D] starting at [member distance_fade_begin]. This acts as a form of level of detail (LOD). The light will fade out over [member distance_fade_begin] + [member distance_fade_length], after which it will be culled and not sent to the shader at all. Use this to reduce the number of active lights in a scene and thus improve performance.
*
* **Note:** Only effective for [OmniLight3D] and [SpotLight3D].
*/
get distance_fade_enabled(): boolean
set distance_fade_enabled(value: boolean)
/** The distance from the camera at which the light begins to fade away (in 3D units).
*
* **Note:** Only effective for [OmniLight3D] and [SpotLight3D].
*/
get distance_fade_begin(): float64
set distance_fade_begin(value: float64)
/** The distance from the camera at which the light's shadow cuts off (in 3D units). Set this to a value lower than [member distance_fade_begin] + [member distance_fade_length] to further improve performance, as shadow rendering is often more expensive than light rendering itself.
*
* **Note:** Only effective for [OmniLight3D] and [SpotLight3D], and only when [member shadow_enabled] is `true`.
*/
get distance_fade_shadow(): float64
set distance_fade_shadow(value: float64)
/** Distance over which the light and its shadow fades. The light's energy and shadow's opacity is progressively reduced over this distance and is completely invisible at the end.
*
* **Note:** Only effective for [OmniLight3D] and [SpotLight3D].
*/
get distance_fade_length(): float64
set distance_fade_length(value: float64)
/** If `true`, the light only appears in the editor and will not be visible at runtime. If `true`, the light will never be baked in [LightmapGI] regardless of its [member light_bake_mode]. */
get editor_only(): boolean
set editor_only(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLight3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLightOccluder2D extends __NameMapNode2D {
}
/** Occludes light cast by a Light2D, casting shadows.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_lightoccluder2d.html
*/
class LightOccluder2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** The [OccluderPolygon2D] used to compute the shadow. */
get occluder(): null | OccluderPolygon2D
set occluder(value: null | OccluderPolygon2D)
/** If enabled, the occluder will be part of a real-time generated signed distance field that can be used in custom shaders. */
get sdf_collision(): boolean
set sdf_collision(value: boolean)
/** The LightOccluder2D's occluder light mask. The LightOccluder2D will cast shadows only from Light2D(s) that have the same light mask(s). */
get occluder_light_mask(): int64
set occluder_light_mask(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLightOccluder2D;
}
namespace LightmapGI {
enum BakeQuality {
/** Low bake quality (fastest bake times). The quality of this preset can be adjusted by changing [member ProjectSettings.rendering/lightmapping/bake_quality/low_quality_ray_count] and [member ProjectSettings.rendering/lightmapping/bake_quality/low_quality_probe_ray_count]. */
BAKE_QUALITY_LOW = 0,
/** Medium bake quality (fast bake times). The quality of this preset can be adjusted by changing [member ProjectSettings.rendering/lightmapping/bake_quality/medium_quality_ray_count] and [member ProjectSettings.rendering/lightmapping/bake_quality/medium_quality_probe_ray_count]. */
BAKE_QUALITY_MEDIUM = 1,
/** High bake quality (slow bake times). The quality of this preset can be adjusted by changing [member ProjectSettings.rendering/lightmapping/bake_quality/high_quality_ray_count] and [member ProjectSettings.rendering/lightmapping/bake_quality/high_quality_probe_ray_count]. */
BAKE_QUALITY_HIGH = 2,
/** Highest bake quality (slowest bake times). The quality of this preset can be adjusted by changing [member ProjectSettings.rendering/lightmapping/bake_quality/ultra_quality_ray_count] and [member ProjectSettings.rendering/lightmapping/bake_quality/ultra_quality_probe_ray_count]. */
BAKE_QUALITY_ULTRA = 3,
}
enum GenerateProbes {
/** Don't generate lightmap probes for lighting dynamic objects. */
GENERATE_PROBES_DISABLED = 0,
/** Lowest level of subdivision (fastest bake times, smallest file sizes). */
GENERATE_PROBES_SUBDIV_4 = 1,
/** Low level of subdivision (fast bake times, small file sizes). */
GENERATE_PROBES_SUBDIV_8 = 2,
/** High level of subdivision (slow bake times, large file sizes). */
GENERATE_PROBES_SUBDIV_16 = 3,
/** Highest level of subdivision (slowest bake times, largest file sizes). */
GENERATE_PROBES_SUBDIV_32 = 4,
}
enum BakeError {
/** Lightmap baking was successful. */
BAKE_ERROR_OK = 0,
/** Lightmap baking failed because the root node for the edited scene could not be accessed. */
BAKE_ERROR_NO_SCENE_ROOT = 1,
/** Lightmap baking failed as the lightmap data resource is embedded in a foreign resource. */
BAKE_ERROR_FOREIGN_DATA = 2,
/** Lightmap baking failed as there is no lightmapper available in this Godot build. */
BAKE_ERROR_NO_LIGHTMAPPER = 3,
/** Lightmap baking failed as the [LightmapGIData] save path isn't configured in the resource. */
BAKE_ERROR_NO_SAVE_PATH = 4,
/** Lightmap baking failed as there are no meshes whose [member GeometryInstance3D.gi_mode] is [constant GeometryInstance3D.GI_MODE_STATIC] and with valid UV2 mapping in the current scene. You may need to select 3D scenes in the Import dock and change their global illumination mode accordingly. */
BAKE_ERROR_NO_MESHES = 5,
/** Lightmap baking failed as the lightmapper failed to analyze some of the meshes marked as static for baking. */
BAKE_ERROR_MESHES_INVALID = 6,
/** Lightmap baking failed as the resulting image couldn't be saved or imported by Godot after it was saved. */
BAKE_ERROR_CANT_CREATE_IMAGE = 7,
/** The user aborted the lightmap baking operation (typically by clicking the **Cancel** button in the progress dialog). */
BAKE_ERROR_USER_ABORTED = 8,
/** Lightmap baking failed as the maximum texture size is too small to fit some of the meshes marked for baking. */
BAKE_ERROR_TEXTURE_SIZE_TOO_SMALL = 9,
/** Lightmap baking failed as the lightmap is too small. */
BAKE_ERROR_LIGHTMAP_TOO_SMALL = 10,
/** Lightmap baking failed as the lightmap was unable to fit into an atlas. */
BAKE_ERROR_ATLAS_TOO_SMALL = 11,
}
enum EnvironmentMode {
/** Ignore environment lighting when baking lightmaps. */
ENVIRONMENT_MODE_DISABLED = 0,
/** Use the scene's environment lighting when baking lightmaps.
*
* **Note:** If baking lightmaps in a scene with no [WorldEnvironment] node, this will act like [constant ENVIRONMENT_MODE_DISABLED]. The editor's preview sky and sun is *not* taken into account by [LightmapGI] when baking lightmaps.
*/
ENVIRONMENT_MODE_SCENE = 1,
/** Use [member environment_custom_sky] as a source of environment lighting when baking lightmaps. */
ENVIRONMENT_MODE_CUSTOM_SKY = 2,
/** Use [member environment_custom_color] multiplied by [member environment_custom_energy] as a constant source of environment lighting when baking lightmaps. */
ENVIRONMENT_MODE_CUSTOM_COLOR = 3,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLightmapGI extends __NameMapVisualInstance3D {
}
/** Computes and stores baked lightmaps for fast global illumination.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_lightmapgi.html
*/
class LightmapGI<Map extends NodePathMap = any> extends VisualInstance3D<Map> {
constructor(identifier?: any)
/** The quality preset to use when baking lightmaps. This affects bake times, but output file sizes remain mostly identical across quality levels.
* To further speed up bake times, decrease [member bounces], disable [member use_denoiser] and/or decrease [member texel_scale].
* To further increase quality, enable [member supersampling] and/or increase [member texel_scale].
*/
get quality(): int64
set quality(value: int64)
/** If `true`, lightmaps are baked with the texel scale multiplied with [member supersampling_factor] and downsampled before saving the lightmap (so the effective texel density is identical to having supersampling disabled).
* Supersampling provides increased lightmap quality with less noise, smoother shadows and better shadowing of small-scale features in objects. However, it may result in significantly increased bake times and memory usage while baking lightmaps. Padding is automatically adjusted to avoid increasing light leaking.
*/
get supersampling(): boolean
set supersampling(value: boolean)
/** The factor by which the texel density is multiplied for supersampling. For best results, use an integer value. While fractional values are allowed, they can result in increased light leaking and a blurry lightmap.
* Higher values may result in better quality, but also increase bake times and memory usage while baking.
* See [member supersampling] for more information.
*/
get supersampling_factor(): float64
set supersampling_factor(value: float64)
/** Number of light bounces that are taken into account during baking. Higher values result in brighter, more realistic lighting, at the cost of longer bake times. If set to `0`, only environment lighting, direct light and emissive lighting is baked. */
get bounces(): int64
set bounces(value: int64)
/** The energy multiplier for each bounce. Higher values will make indirect lighting brighter. A value of `1.0` represents physically accurate behavior, but higher values can be used to make indirect lighting propagate more visibly when using a low number of bounces. This can be used to speed up bake times by lowering the number of [member bounces] then increasing [member bounce_indirect_energy].
*
* **Note:** [member bounce_indirect_energy] only has an effect if [member bounces] is set to a value greater than or equal to `1`.
*/
get bounce_indirect_energy(): float64
set bounce_indirect_energy(value: float64)
/** If `true`, bakes lightmaps to contain directional information as spherical harmonics. This results in more realistic lighting appearance, especially with normal mapped materials and for lights that have their direct light baked ([member Light3D.light_bake_mode] set to [constant Light3D.BAKE_STATIC] and with [member Light3D.editor_only] set to `false`). The directional information is also used to provide rough reflections for static and dynamic objects. This has a small run-time performance cost as the shader has to perform more work to interpret the direction information from the lightmap. Directional lightmaps also take longer to bake and result in larger file sizes.
*
* **Note:** The property's name has no relationship with [DirectionalLight3D]. [member directional] works with all light types.
*/
get directional(): boolean
set directional(value: boolean)
/** The shadowmasking policy to use for directional shadows on static objects that are baked with this [LightmapGI] instance.
* Shadowmasking allows [DirectionalLight3D] nodes to cast shadows even outside the range defined by their [member DirectionalLight3D.directional_shadow_max_distance] property. This is done by baking a texture that contains a shadowmap for the directional light, then using this texture according to the current shadowmask mode.
*
* **Note:** The shadowmask texture is only created if [member shadowmask_mode] is not [constant LightmapGIData.SHADOWMASK_MODE_NONE]. To see a difference, you need to bake lightmaps again after switching from [constant LightmapGIData.SHADOWMASK_MODE_NONE] to any other mode.
*/
get shadowmask_mode(): int64
set shadowmask_mode(value: int64)
/** If `true`, a texture with the lighting information will be generated to speed up the generation of indirect lighting at the cost of some accuracy. The geometry might exhibit extra light leak artifacts when using low resolution lightmaps or UVs that stretch the lightmap significantly across surfaces. Leave [member use_texture_for_bounces] at its default value of `true` if unsure.
*
* **Note:** [member use_texture_for_bounces] only has an effect if [member bounces] is set to a value greater than or equal to `1`.
*/
get use_texture_for_bounces(): boolean
set use_texture_for_bounces(value: boolean)
/** If `true`, ignore environment lighting when baking lightmaps. */
get interior(): boolean
set interior(value: boolean)
/** If `true`, uses a GPU-based denoising algorithm on the generated lightmap. This eliminates most noise within the generated lightmap at the cost of longer bake times. File sizes are generally not impacted significantly by the use of a denoiser, although lossless compression may do a better job at compressing a denoised image. */
get use_denoiser(): boolean
set use_denoiser(value: boolean)
/** The strength of denoising step applied to the generated lightmaps. Only effective if [member use_denoiser] is `true` and [member ProjectSettings.rendering/lightmapping/denoising/denoiser] is set to JNLM. */
get denoiser_strength(): float64
set denoiser_strength(value: float64)
/** The distance in pixels from which the denoiser samples. Lower values preserve more details, but may give blotchy results if the lightmap quality is not high enough. Only effective if [member use_denoiser] is `true` and [member ProjectSettings.rendering/lightmapping/denoising/denoiser] is set to JNLM. */
get denoiser_range(): int64
set denoiser_range(value: int64)
/** The bias to use when computing shadows. Increasing [member bias] can fix shadow acne on the resulting baked lightmap, but can introduce peter-panning (shadows not connecting to their casters). Real-time [Light3D] shadows are not affected by this [member bias] property. */
get bias(): float64
set bias(value: float64)
/** Scales the lightmap texel density of all meshes for the current bake. This is a multiplier that builds upon the existing lightmap texel size defined in each imported 3D scene, along with the per-mesh density multiplier (which is designed to be used when the same mesh is used at different scales). Lower values will result in faster bake times.
* For example, doubling [member texel_scale] doubles the lightmap texture resolution for all objects *on each axis* , so it will *quadruple* the texel count.
*/
get texel_scale(): float64
set texel_scale(value: float64)
/** The maximum texture size for the generated texture atlas. Higher values will result in fewer slices being generated, but may not work on all hardware as a result of hardware limitations on texture sizes. Leave [member max_texture_size] at its default value of `16384` if unsure. */
get max_texture_size(): int64
set max_texture_size(value: int64)
/** The environment mode to use when baking lightmaps. */
get environment_mode(): int64
set environment_mode(value: int64)
/** The sky to use as a source of environment lighting. Only effective if [member environment_mode] is [constant ENVIRONMENT_MODE_CUSTOM_SKY]. */
get environment_custom_sky(): null | Sky
set environment_custom_sky(value: null | Sky)
/** The color to use for environment lighting. Only effective if [member environment_mode] is [constant ENVIRONMENT_MODE_CUSTOM_COLOR]. */
get environment_custom_color(): Color
set environment_custom_color(value: Color)
/** The color multiplier to use for environment lighting. Only effective if [member environment_mode] is [constant ENVIRONMENT_MODE_CUSTOM_COLOR]. */
get environment_custom_energy(): float64
set environment_custom_energy(value: float64)
/** The [CameraAttributes] resource that specifies exposure levels to bake at. Auto-exposure and non exposure properties will be ignored. Exposure settings should be used to reduce the dynamic range present when baking. If exposure is too high, the [LightmapGI] will have banding artifacts or may have over-exposure artifacts. */
get camera_attributes(): null | CameraAttributesPractical | CameraAttributesPhysical
set camera_attributes(value: null | CameraAttributesPractical | CameraAttributesPhysical)
/** The level of subdivision to use when automatically generating [LightmapProbe]s for dynamic object lighting. Higher values result in more accurate indirect lighting on dynamic objects, at the cost of longer bake times and larger file sizes.
*
* **Note:** Automatically generated [LightmapProbe]s are not visible as nodes in the Scene tree dock, and cannot be modified this way after they are generated.
*
* **Note:** Regardless of [member generate_probes_subdiv], direct lighting on dynamic objects is always applied using [Light3D] nodes in real-time.
*/
get generate_probes_subdiv(): int64
set generate_probes_subdiv(value: int64)
/** The [LightmapGIData] associated to this [LightmapGI] node. This resource is automatically created after baking, and is not meant to be created manually. */
get light_data(): null | LightmapGIData
set light_data(value: null | LightmapGIData)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLightmapGI;
}
namespace LightmapGIData {
enum ShadowmaskMode {
/** Shadowmasking is disabled. No shadowmask texture will be created when baking lightmaps. Existing shadowmask textures will be removed during baking. */
SHADOWMASK_MODE_NONE = 0,
/** Shadowmasking is enabled. Directional shadows that are outside the [member DirectionalLight3D.directional_shadow_max_distance] will be rendered using the shadowmask texture. Shadows that are inside the range will be rendered using real-time shadows exclusively. This mode allows for more precise real-time shadows up close, without the potential "smearing" effect that can occur when using lightmaps with a high texel size. The downside is that when the camera moves fast, the transition between the real-time light and shadowmask can be obvious. Also, objects that only have shadows baked in the shadowmask (and no real-time shadows) won't display any shadows up close. */
SHADOWMASK_MODE_REPLACE = 1,
/** Shadowmasking is enabled. Directional shadows will be rendered with real-time shadows overlaid on top of the shadowmask texture. This mode makes for smoother shadow transitions when the camera moves fast, at the cost of a potential smearing effect for directional shadows that are up close (due to the real-time shadow being mixed with a low-resolution shadowmask). Objects that only have shadows baked in the shadowmask (and no real-time shadows) will keep their shadows up close. */
SHADOWMASK_MODE_OVERLAY = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLightmapGIData extends __NameMapResource {
}
/** Contains baked lightmap and dynamic object probe data for [LightmapGI].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_lightmapgidata.html
*/
class LightmapGIData extends Resource {
constructor(identifier?: any)
/** Adds an object that is considered baked within this [LightmapGIData]. */
add_user(path: NodePath | string, uv_scale: Rect2, slice_index: int64, sub_instance: int64): void
/** Returns the number of objects that are considered baked within this [LightmapGIData]. */
get_user_count(): int64
/** Returns the [NodePath] of the baked object at index [param user_idx]. */
get_user_path(user_idx: int64): NodePath
/** Clear all objects that are considered baked within this [LightmapGIData]. */
clear_users(): void
/** The lightmap atlas textures generated by the lightmapper. */
get lightmap_textures(): GArray<TextureLayered>
set lightmap_textures(value: GArray<TextureLayered>)
/** The shadowmask atlas textures generated by the lightmapper. */
get shadowmask_textures(): GArray<TextureLayered>
set shadowmask_textures(value: GArray<TextureLayered>)
get uses_spherical_harmonics(): boolean
set uses_spherical_harmonics(value: boolean)
get user_data(): GArray
set user_data(value: GArray)
get probe_data(): GDictionary
set probe_data(value: GDictionary)
get _uses_packed_directional(): boolean
set _uses_packed_directional(value: boolean)
/** The lightmap atlas texture generated by the lightmapper. */
get light_texture(): null | TextureLayered
set light_texture(value: null | TextureLayered)
get light_textures(): GArray
set light_textures(value: GArray)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLightmapGIData;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLightmapProbe extends __NameMapNode3D {
}
/** Represents a single manually placed probe for dynamic object lighting with [LightmapGI].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_lightmapprobe.html
*/
class LightmapProbe<Map extends NodePathMap = any> extends Node3D<Map> {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLightmapProbe;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLightmapper extends __NameMapRefCounted {
}
/** Abstract class extended by lightmappers, for use in [LightmapGI].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_lightmapper.html
*/
class Lightmapper extends RefCounted {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLightmapper;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLightmapperRD extends __NameMapLightmapper {
}
/** The built-in GPU-based lightmapper for use with [LightmapGI].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_lightmapperrd.html
*/
class LightmapperRD extends Lightmapper {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLightmapperRD;
}
namespace Line2D {
enum LineJointMode {
/** Makes the polyline's joints pointy, connecting the sides of the two segments by extending them until they intersect. If the rotation of a joint is too big (based on [member sharp_limit]), the joint falls back to [constant LINE_JOINT_BEVEL] to prevent very long miters. */
LINE_JOINT_SHARP = 0,
/** Makes the polyline's joints bevelled/chamfered, connecting the sides of the two segments with a simple line. */
LINE_JOINT_BEVEL = 1,
/** Makes the polyline's joints rounded, connecting the sides of the two segments with an arc. The detail of this arc depends on [member round_precision]. */
LINE_JOINT_ROUND = 2,
}
enum LineCapMode {
/** Draws no line cap. */
LINE_CAP_NONE = 0,
/** Draws the line cap as a box, slightly extending the first/last segment. */
LINE_CAP_BOX = 1,
/** Draws the line cap as a semicircle attached to the first/last segment. */
LINE_CAP_ROUND = 2,
}
enum LineTextureMode {
/** Takes the left pixels of the texture and renders them over the whole polyline. */
LINE_TEXTURE_NONE = 0,
/** Tiles the texture over the polyline. [member CanvasItem.texture_repeat] of the [Line2D] node must be [constant CanvasItem.TEXTURE_REPEAT_ENABLED] or [constant CanvasItem.TEXTURE_REPEAT_MIRROR] for it to work properly. */
LINE_TEXTURE_TILE = 1,
/** Stretches the texture across the polyline. [member CanvasItem.texture_repeat] of the [Line2D] node must be [constant CanvasItem.TEXTURE_REPEAT_DISABLED] for best results. */
LINE_TEXTURE_STRETCH = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLine2D extends __NameMapNode2D {
}
/** A 2D polyline that can optionally be textured.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_line2d.html
*/
class Line2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** Overwrites the position of the point at the given [param index] with the supplied [param position]. */
set_point_position(index: int64, position: Vector2): void
/** Returns the position of the point at index [param index]. */
get_point_position(index: int64): Vector2
/** Returns the number of points in the polyline. */
get_point_count(): int64
/** Adds a point with the specified [param position] relative to the polyline's own position. If no [param index] is provided, the new point will be added to the end of the points array.
* If [param index] is given, the new point is inserted before the existing point identified by index [param index]. The indices of the points after the new point get increased by 1. The provided [param index] must not exceed the number of existing points in the polyline. See [method get_point_count].
*/
add_point(position: Vector2, index?: int64 /* = -1 */): void
/** Removes the point at index [param index] from the polyline. */
remove_point(index: int64): void
/** Removes all points from the polyline, making it empty. */
clear_points(): void
/** The points of the polyline, interpreted in local 2D coordinates. Segments are drawn between the adjacent points in this array. */
get points(): PackedVector2Array
set points(value: PackedVector2Array | Vector2[])
/** If `true` and the polyline has more than 2 points, the last point and the first one will be connected by a segment.
*
* **Note:** The shape of the closing segment is not guaranteed to be seamless if a [member width_curve] is provided.
*
* **Note:** The joint between the closing segment and the first segment is drawn first and it samples the [member gradient] and the [member width_curve] at the beginning. This is an implementation detail that might change in a future version.
*/
get closed(): boolean
set closed(value: boolean)
/** The polyline's width. */
get width(): float64
set width(value: float64)
/** The polyline's width curve. The width of the polyline over its length will be equivalent to the value of the width curve over its domain. The width curve should be a unit [Curve]. */
get width_curve(): null | Curve
set width_curve(value: null | Curve)
/** The color of the polyline. Will not be used if a gradient is set. */
get default_color(): Color
set default_color(value: Color)
/** The gradient is drawn through the whole line from start to finish. The [member default_color] will not be used if this property is set. */
get gradient(): null | Gradient
set gradient(value: null | Gradient)
/** The texture used for the polyline. Uses [member texture_mode] for drawing style. */
get texture(): null | Texture2D
set texture(value: null | Texture2D)
/** The style to render the [member texture] of the polyline. */
get texture_mode(): int64
set texture_mode(value: int64)
/** The style of the connections between segments of the polyline. */
get joint_mode(): int64
set joint_mode(value: int64)
/** The style of the beginning of the polyline, if [member closed] is `false`. */
get begin_cap_mode(): int64
set begin_cap_mode(value: int64)
/** The style of the end of the polyline, if [member closed] is `false`. */
get end_cap_mode(): int64
set end_cap_mode(value: int64)
/** Determines the miter limit of the polyline. Normally, when [member joint_mode] is set to [constant LINE_JOINT_SHARP], sharp angles fall back to using the logic of [constant LINE_JOINT_BEVEL] joints to prevent very long miters. Higher values of this property mean that the fallback to a bevel joint will happen at sharper angles. */
get sharp_limit(): float64
set sharp_limit(value: float64)
/** The smoothness used for rounded joints and caps. Higher values result in smoother corners, but are more demanding to render and update. */
get round_precision(): int64
set round_precision(value: int64)
/** If `true`, the polyline's border will be anti-aliased.
*
* **Note:** [Line2D] is not accelerated by batching when being anti-aliased.
*/
get antialiased(): boolean
set antialiased(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLine2D;
}
namespace LineEdit {
enum MenuItems {
/** Cuts (copies and clears) the selected text. */
MENU_CUT = 0,
/** Copies the selected text. */
MENU_COPY = 1,
/** Pastes the clipboard text over the selected text (or at the caret's position).
* Non-printable escape characters are automatically stripped from the OS clipboard via [method String.strip_escapes].
*/
MENU_PASTE = 2,
/** Erases the whole [LineEdit] text. */
MENU_CLEAR = 3,
/** Selects the whole [LineEdit] text. */
MENU_SELECT_ALL = 4,
/** Undoes the previous action. */
MENU_UNDO = 5,
/** Reverse the last undo action. */
MENU_REDO = 6,
/** ID of "Text Writing Direction" submenu. */
MENU_SUBMENU_TEXT_DIR = 7,
/** Sets text direction to inherited. */
MENU_DIR_INHERITED = 8,
/** Sets text direction to automatic. */
MENU_DIR_AUTO = 9,
/** Sets text direction to left-to-right. */
MENU_DIR_LTR = 10,
/** Sets text direction to right-to-left. */
MENU_DIR_RTL = 11,
/** Toggles control character display. */
MENU_DISPLAY_UCC = 12,
/** ID of "Insert Control Character" submenu. */
MENU_SUBMENU_INSERT_UCC = 13,
/** Inserts left-to-right mark (LRM) character. */
MENU_INSERT_LRM = 14,
/** Inserts right-to-left mark (RLM) character. */
MENU_INSERT_RLM = 15,
/** Inserts start of left-to-right embedding (LRE) character. */
MENU_INSERT_LRE = 16,
/** Inserts start of right-to-left embedding (RLE) character. */
MENU_INSERT_RLE = 17,
/** Inserts start of left-to-right override (LRO) character. */
MENU_INSERT_LRO = 18,
/** Inserts start of right-to-left override (RLO) character. */
MENU_INSERT_RLO = 19,
/** Inserts pop direction formatting (PDF) character. */
MENU_INSERT_PDF = 20,
/** Inserts Arabic letter mark (ALM) character. */
MENU_INSERT_ALM = 21,
/** Inserts left-to-right isolate (LRI) character. */
MENU_INSERT_LRI = 22,
/** Inserts right-to-left isolate (RLI) character. */
MENU_INSERT_RLI = 23,
/** Inserts first strong isolate (FSI) character. */
MENU_INSERT_FSI = 24,
/** Inserts pop direction isolate (PDI) character. */
MENU_INSERT_PDI = 25,
/** Inserts zero width joiner (ZWJ) character. */
MENU_INSERT_ZWJ = 26,
/** Inserts zero width non-joiner (ZWNJ) character. */
MENU_INSERT_ZWNJ = 27,
/** Inserts word joiner (WJ) character. */
MENU_INSERT_WJ = 28,
/** Inserts soft hyphen (SHY) character. */
MENU_INSERT_SHY = 29,
/** Opens system emoji and symbol picker. */
MENU_EMOJI_AND_SYMBOL = 30,
/** Represents the size of the [enum MenuItems] enum. */
MENU_MAX = 31,
}
enum VirtualKeyboardType {
/** Default text virtual keyboard. */
KEYBOARD_TYPE_DEFAULT = 0,
/** Multiline virtual keyboard. */
KEYBOARD_TYPE_MULTILINE = 1,
/** Virtual number keypad, useful for PIN entry. */
KEYBOARD_TYPE_NUMBER = 2,
/** Virtual number keypad, useful for entering fractional numbers. */
KEYBOARD_TYPE_NUMBER_DECIMAL = 3,
/** Virtual phone number keypad. */
KEYBOARD_TYPE_PHONE = 4,
/** Virtual keyboard with additional keys to assist with typing email addresses. */
KEYBOARD_TYPE_EMAIL_ADDRESS = 5,
/** Virtual keyboard for entering a password. On most platforms, this should disable autocomplete and autocapitalization.
*
* **Note:** This is not supported on Web. Instead, this behaves identically to [constant KEYBOARD_TYPE_DEFAULT].
*/
KEYBOARD_TYPE_PASSWORD = 6,
/** Virtual keyboard with additional keys to assist with typing URLs. */
KEYBOARD_TYPE_URL = 7,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLineEdit extends __NameMapControl {
}
/** An input field for single-line text.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_lineedit.html
*/
class LineEdit<Map extends NodePathMap = any> extends Control<Map> {
constructor(identifier?: any)
/** Returns `true` if the user has text in the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME). */
has_ime_text(): boolean
/** Closes the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME) if it is open. Any text in the IME will be lost. */
cancel_ime(): void
/** Applies text from the [url=https://en.wikipedia.org/wiki/Input_method]Input Method Editor[/url] (IME) and closes the IME if it is open. */
apply_ime(): void
/** Allows entering edit mode whether the [LineEdit] is focused or not.
* See also [member keep_editing_on_text_submit].
*/
edit(): void
/** Allows exiting edit mode while preserving focus. */
unedit(): void
/** Returns whether the [LineEdit] is being edited. */
is_editing(): boolean
/** Erases the [LineEdit]'s [member text]. */
clear(): void
/** Selects characters inside [LineEdit] between [param from] and [param to]. By default, [param from] is at the beginning and [param to] at the end.
*
*/
select(from?: int64 /* = 0 */, to?: int64 /* = -1 */): void
/** Selects the whole [String]. */
select_all(): void
/** Clears the current selection. */
deselect(): void
/** Returns `true` if an "undo" action is available. */
has_undo(): boolean
/** Returns `true` if a "redo" action is available. */
has_redo(): boolean
/** Returns `true` if the user has selected text. */
has_selection(): boolean
/** Returns the text inside the selection. */
get_selected_text(): string
/** Returns the selection begin column. */
get_selection_from_column(): int64
/** Returns the selection end column. */
get_selection_to_column(): int64
/** Returns the correct column at the end of a composite character like ❤️‍🩹 (mending heart; Unicode: `U+2764 U+FE0F U+200D U+1FA79`) which is comprised of more than one Unicode code point, if the caret is at the start of the composite character. Also returns the correct column with the caret at mid grapheme and for non-composite characters.
*
* **Note:** To check at caret location use `get_next_composite_character_column(get_caret_column())`
*/
get_next_composite_character_column(column: int64): int64
/** Returns the correct column at the start of a composite character like ❤️‍🩹 (mending heart; Unicode: `U+2764 U+FE0F U+200D U+1FA79`) which is comprised of more than one Unicode code point, if the caret is at the end of the composite character. Also returns the correct column with the caret at mid grapheme and for non-composite characters.
*
* **Note:** To check at caret location use `get_previous_composite_character_column(get_caret_column())`
*/
get_previous_composite_character_column(column: int64): int64
/** Returns the scroll offset due to [member caret_column], as a number of characters. */
get_scroll_offset(): float64
/** Inserts [param text] at the caret. If the resulting value is longer than [member max_length], nothing happens. */
insert_text_at_caret(text: string): void
/** Deletes one character at the caret's current position (equivalent to pressing [kbd]Delete[/kbd]). */
delete_char_at_caret(): void
/** Deletes a section of the [member text] going from position [param from_column] to [param to_column]. Both parameters should be within the text's length. */
delete_text(from_column: int64, to_column: int64): void
/** Executes a given action as defined in the [enum MenuItems] enum. */
menu_option(option: int64): void
/** Returns the [PopupMenu] of this [LineEdit]. By default, this menu is displayed when right-clicking on the [LineEdit].
* You can add custom menu items or remove standard ones. Make sure your IDs don't conflict with the standard ones (see [enum MenuItems]). For example:
*
* **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property.
*/
get_menu(): null | PopupMenu
/** Returns whether the menu is visible. Use this instead of `get_menu().visible` to improve performance (so the creation of the menu is avoided). */
is_menu_visible(): boolean
/** String value of the [LineEdit].
*
* **Note:** Changing text using this property won't emit the [signal text_changed] signal.
*/
get text(): string
set text(value: string)
/** Text shown when the [LineEdit] is empty. It is **not** the [LineEdit]'s default value (see [member text]). */
get placeholder_text(): string
set placeholder_text(value: string)
/** Text alignment as defined in the [enum HorizontalAlignment] enum. */
get alignment(): int64
set alignment(value: int64)
/** Maximum number of characters that can be entered inside the [LineEdit]. If `0`, there is no limit.
* When a limit is defined, characters that would exceed [member max_length] are truncated. This happens both for existing [member text] contents when setting the max length, or for new text inserted in the [LineEdit], including pasting.
* If any input text is truncated, the [signal text_change_rejected] signal is emitted with the truncated substring as a parameter:
*
*/
get max_length(): int64
set max_length(value: int64)
/** If `false`, existing text cannot be modified and new text cannot be added. */
get editable(): boolean
set editable(value: boolean)
/** If `true`, the [LineEdit] will not exit edit mode when text is submitted by pressing `ui_text_submit` action (by default: [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]). */
get keep_editing_on_text_submit(): boolean
set keep_editing_on_text_submit(value: boolean)
/** If `true`, the [LineEdit] width will increase to stay longer than the [member text]. It will **not** compress if the [member text] is shortened. */
get expand_to_text_length(): boolean
set expand_to_text_length(value: boolean)
/** If `true`, the context menu will appear when right-clicked. */
get context_menu_enabled(): boolean
set context_menu_enabled(value: boolean)
/** If `true`, "Emoji and Symbols" menu is enabled. */
get emoji_menu_enabled(): boolean
set emoji_menu_enabled(value: boolean)
/** If `true` and [member caret_mid_grapheme] is `false`, backspace deletes an entire composite character such as ❤️‍🩹, instead of deleting part of the composite character. */
get backspace_deletes_composite_character_enabled(): boolean
set backspace_deletes_composite_character_enabled(value: boolean)
/** If `true`, the native virtual keyboard is enabled on platforms that support it. */
get virtual_keyboard_enabled(): boolean
set virtual_keyboard_enabled(value: boolean)
/** If `true`, the native virtual keyboard is shown on focus events on platforms that support it. */
get virtual_keyboard_show_on_focus(): boolean
set virtual_keyboard_show_on_focus(value: boolean)
/** Specifies the type of virtual keyboard to show. */
get virtual_keyboard_type(): int64
set virtual_keyboard_type(value: int64)
/** If `true`, the [LineEdit] will show a clear button if [member text] is not empty, which can be used to clear the text quickly. */
get clear_button_enabled(): boolean
set clear_button_enabled(value: boolean)
/** If `true`, shortcut keys for context menu items are enabled, even if the context menu is disabled. */
get shortcut_keys_enabled(): boolean
set shortcut_keys_enabled(value: boolean)
/** If `false`, using middle mouse button to paste clipboard will be disabled.
*
* **Note:** This method is only implemented on Linux.
*/
get middle_mouse_paste_enabled(): boolean
set middle_mouse_paste_enabled(value: boolean)
/** If `false`, it's impossible to select the text using mouse nor keyboard. */
get selecting_enabled(): boolean
set selecting_enabled(value: boolean)
/** If `true`, the selected text will be deselected when focus is lost. */
get deselect_on_focus_loss_enabled(): boolean
set deselect_on_focus_loss_enabled(value: boolean)
/** If `true`, allow drag and drop of selected text. */
get drag_and_drop_selection_enabled(): boolean
set drag_and_drop_selection_enabled(value: boolean)
/** Sets the icon that will appear in the right end of the [LineEdit] if there's no [member text], or always, if [member clear_button_enabled] is set to `false`. */
get right_icon(): null | Texture2D
set right_icon(value: null | Texture2D)
/** If `true`, the [LineEdit] doesn't display decoration. */
get flat(): boolean
set flat(value: boolean)
/** If `true`, control characters are displayed. */
get draw_control_chars(): boolean
set draw_control_chars(value: boolean)
/** If `true`, the [LineEdit] will select the whole text when it gains focus. */
get select_all_on_focus(): boolean
set select_all_on_focus(value: boolean)
/** If `true`, makes the caret blink. */
get caret_blink(): boolean
set caret_blink(value: boolean)
/** The interval at which the caret blinks (in seconds). */
get caret_blink_interval(): float64
set caret_blink_interval(value: float64)
/** The caret's column position inside the [LineEdit]. When set, the text may scroll to accommodate it. */
get caret_column(): int64
set caret_column(value: int64)
/** If `true`, the [LineEdit] will always show the caret, even if not editing or focus is lost. */
get caret_force_displayed(): boolean
set caret_force_displayed(value: boolean)
/** Allow moving caret, selecting and removing the individual composite character components.
*
* **Note:** [kbd]Backspace[/kbd] is always removing individual composite character components.
*/
get caret_mid_grapheme(): boolean
set caret_mid_grapheme(value: boolean)
/** If `true`, every character is replaced with the secret character (see [member secret_character]). */
get secret(): boolean
set secret(value: boolean)
/** The character to use to mask secret input. Only a single character can be used as the secret character. If it is longer than one character, only the first one will be used. If it is empty, a space will be used instead. */
get secret_character(): string
set secret_character(value: string)
/** Base text writing direction. */
get text_direction(): int64
set text_direction(value: int64)
/** Language code used for line-breaking and text shaping algorithms. If left empty, current locale is used instead. */
get language(): string
set language(value: string)
/** Set BiDi algorithm override for the structured text. */
get structured_text_bidi_override(): int64
set structured_text_bidi_override(value: int64)
/** Set additional options for BiDi override. */
get structured_text_bidi_override_options(): GArray
set structured_text_bidi_override_options(value: GArray)
/** Emitted when the text changes. */
readonly text_changed: Signal<(new_text: string) => void>
/** Emitted when appending text that overflows the [member max_length]. The appended text is truncated to fit [member max_length], and the part that couldn't fit is passed as the [param rejected_substring] argument. */
readonly text_change_rejected: Signal<(rejected_substring: string) => void>
/** Emitted when the user presses the `ui_text_submit` action (by default: [kbd]Enter[/kbd] or [kbd]Kp Enter[/kbd]) while the [LineEdit] has focus. */
readonly text_submitted: Signal<(new_text: string) => void>
/** Emitted when the [LineEdit] switches in or out of edit mode. */
readonly editing_toggled: Signal<(toggled_on: boolean) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLineEdit;
}
namespace LinkButton {
enum UnderlineMode {
/** The LinkButton will always show an underline at the bottom of its text. */
UNDERLINE_MODE_ALWAYS = 0,
/** The LinkButton will show an underline at the bottom of its text when the mouse cursor is over it. */
UNDERLINE_MODE_ON_HOVER = 1,
/** The LinkButton will never show an underline at the bottom of its text. */
UNDERLINE_MODE_NEVER = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLinkButton extends __NameMapBaseButton {
}
/** A button that represents a link.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_linkbutton.html
*/
class LinkButton<Map extends NodePathMap = any> extends BaseButton<Map> {
constructor(identifier?: any)
/** The button's text that will be displayed inside the button's area. */
get text(): string
set text(value: string)
/** The underline mode to use for the text. */
get underline(): int64
set underline(value: int64)
/** The [url=https://en.wikipedia.org/wiki/Uniform_Resource_Identifier]URI[/url] for this [LinkButton]. If set to a valid URI, pressing the button opens the URI using the operating system's default program for the protocol (via [method OS.shell_open]). HTTP and HTTPS URLs open the default web browser.
*
*/
get uri(): string
set uri(value: string)
/** Base text writing direction. */
get text_direction(): int64
set text_direction(value: int64)
/** Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. */
get language(): string
set language(value: string)
/** Set BiDi algorithm override for the structured text. */
get structured_text_bidi_override(): int64
set structured_text_bidi_override(value: int64)
/** Set additional options for BiDi override. */
get structured_text_bidi_override_options(): GArray
set structured_text_bidi_override_options(value: GArray)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLinkButton;
}
namespace Logger {
enum ErrorType {
/** The message received is an error. */
ERROR_TYPE_ERROR = 0,
/** The message received is a warning. */
ERROR_TYPE_WARNING = 1,
/** The message received is a script error. */
ERROR_TYPE_SCRIPT = 2,
/** The message received is a shader error. */
ERROR_TYPE_SHADER = 3,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLogger extends __NameMapRefCounted {
}
/** Custom logger to receive messages from the internal error/warning stream.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_logger.html
*/
class Logger extends RefCounted {
constructor(identifier?: any)
/** Called when an error is logged. The error provides the [param function], [param file], and [param line] that it originated from, as well as either the [param code] that generated the error or a [param rationale].
* The type of error provided by [param error_type] is described in the [enum ErrorType] enumeration.
* Additionally, [param script_backtraces] provides backtraces for each of the script languages. These will only contain stack frames in editor builds and debug builds by default. To enable them for release builds as well, you need to enable [member ProjectSettings.debug/settings/gdscript/always_track_call_stacks].
* **Warning:** This function may be called from multiple different threads, so you may need to do your own locking.
*
* **Note:** [param script_backtraces] will not contain any captured variables, due to its prohibitively high cost. To get those you will need to capture the backtraces yourself, from within the [Logger] virtual methods, using [method Engine.capture_script_backtraces].
*/
/* gdvirtual */ _log_error(function_: string, file: string, line: int64, code: string, rationale: string, editor_notify: boolean, error_type: int64, script_backtraces: GArray<ScriptBacktrace>): void
/** Called when a message is logged. If [param error] is `true`, then this message was meant to be sent to `stderr`.
* **Warning:** This function may be called from multiple different threads, so you may need to do your own locking.
*/
/* gdvirtual */ _log_message(message: string, error: boolean): void
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLogger;
}
namespace LookAtModifier3D {
enum OriginFrom {
/** The bone rest position of the bone specified in [member bone] is used as origin. */
ORIGIN_FROM_SELF = 0,
/** The bone global pose position of the bone specified in [member origin_bone] is used as origin.
*
* **Note:** It is recommended that you select only the parent bone unless you are familiar with the bone processing process. The specified bone pose at the time the [LookAtModifier3D] is processed is used as a reference. In other words, if you specify a child bone and the [LookAtModifier3D] causes the child bone to move, the rendered result and direction will not match.
*/
ORIGIN_FROM_SPECIFIC_BONE = 1,
/** The global position of the [Node3D] specified in [member origin_external_node] is used as origin.
*
* **Note:** Same as [constant ORIGIN_FROM_SPECIFIC_BONE], when specifying a [BoneAttachment3D] with a child bone assigned, the rendered result and direction will not match.
*/
ORIGIN_FROM_EXTERNAL_NODE = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapLookAtModifier3D extends __NameMapSkeletonModifier3D {
}
/** The [LookAtModifier3D] rotates a bone to look at a target.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_lookatmodifier3d.html
*/
class LookAtModifier3D<Map extends NodePathMap = any> extends SkeletonModifier3D<Map> {
constructor(identifier?: any)
/** Returns the remaining seconds of the time-based interpolation. */
get_interpolation_remaining(): float64
/** Returns `true` if time-based interpolation is running. If `true`, it is equivalent to [method get_interpolation_remaining] returning `0.0`.
* This is useful to determine whether a [LookAtModifier3D] can be removed safely.
*/
is_interpolating(): boolean
/** Returns whether the target is within the angle limitations. It is useful for unsetting the [member target_node] when the target is outside of the angle limitations.
*
* **Note:** The value is updated after [method SkeletonModifier3D._process_modification]. To retrieve this value correctly, we recommend using the signal [signal SkeletonModifier3D.modification_processed].
*/
is_target_within_limitation(): boolean
/** The [NodePath] to the node that is the target for the look at modification. This node is what the modification will rotate the bone to. */
get target_node(): NodePath
set target_node(value: NodePath | string)
/** The bone name of the [Skeleton3D] that the modification will operate on. */
get bone_name(): string
set bone_name(value: string)
/** Index of the [member bone_name] in the parent [Skeleton3D]. */
get bone(): int64
set bone(value: int64)
/** The forward axis of the bone. This [SkeletonModifier3D] modifies the bone so that this axis points toward the [member target_node]. */
get forward_axis(): int64
set forward_axis(value: int64)
/** The axis of the first rotation. This [SkeletonModifier3D] works by compositing the rotation by Euler angles to prevent to rotate the [member forward_axis]. */
get primary_rotation_axis(): int64
set primary_rotation_axis(value: int64)
/** If `true`, provides rotation by two axes. */
get use_secondary_rotation(): boolean
set use_secondary_rotation(value: boolean)
/** This value determines from what origin is retrieved for use in the calculation of the forward vector. */
get origin_from(): int64
set origin_from(value: int64)
/** If [member origin_from] is [constant ORIGIN_FROM_SPECIFIC_BONE], the bone global pose position specified for this is used as origin. */
get origin_bone_name(): string
set origin_bone_name(value: string)
/** Index of the [member origin_bone_name] in the parent [Skeleton3D]. */
get origin_bone(): int64
set origin_bone(value: int64)
/** If [member origin_from] is [constant ORIGIN_FROM_EXTERNAL_NODE], the global position of the [Node3D] specified for this is used as origin. */
get origin_external_node(): NodePath
set origin_external_node(value: NodePath | string)
/** The offset of the bone pose origin. Matching the origins by offset is useful for cases where multiple bones must always face the same direction, such as the eyes.
*
* **Note:** This value indicates the local position of the object set in [member origin_from].
*/
get origin_offset(): Vector3
set origin_offset(value: Vector3)
/** If the target passes through too close to the origin than this value, time-based interpolation is used even if the target is within the angular limitations, to prevent the angular velocity from becoming too high. */
get origin_safe_margin(): float64
set origin_safe_margin(value: float64)
/** The duration of the time-based interpolation. Interpolation is triggered at the following cases:
* - When the target node is changed
* - When an axis is flipped due to angle limitation
*
* **Note:** The flipping occurs when the target is outside the angle limitation and the internally computed secondary rotation axis of the forward vector is flipped. Visually, it occurs when the target is outside the angle limitation and crosses the plane of the [member forward_axis] and [member primary_rotation_axis].
*/
get duration(): float64
set duration(value: float64)
/** The transition type of the time-based interpolation. See also [enum Tween.TransitionType]. */
get transition_type(): int64
set transition_type(value: int64)
/** The ease type of the time-based interpolation. See also [enum Tween.EaseType]. */
get ease_type(): int64
set ease_type(value: int64)
/** If `true`, limits the amount of rotation. For example, this helps to prevent a character's neck from rotating 360 degrees.
*
* **Note:** As with [AnimationTree] blending, interpolation is provided that favors [method Skeleton3D.get_bone_rest]. This means that interpolation does not select the shortest path in some cases.
*
* **Note:** Some values for [member transition_type] (such as [constant Tween.TRANS_BACK], [constant Tween.TRANS_ELASTIC], and [constant Tween.TRANS_SPRING]) may exceed the limitations. If interpolation occurs while overshooting the limitations, the result might not respect the bone rest.
*/
get use_angle_limitation(): boolean
set use_angle_limitation(value: boolean)
/** If `true`, the limitations are spread from the bone symmetrically.
* If `false`, the limitation can be specified separately for each side of the bone rest.
*/
get symmetry_limitation(): boolean
set symmetry_limitation(value: boolean)
/** The limit angle of the primary rotation when [member symmetry_limitation] is `true`. */
get primary_limit_angle(): float64
set primary_limit_angle(value: float64)
/** The threshold to start damping for [member primary_limit_angle]. It provides non-linear (b-spline) interpolation, let it feel more resistance the more it rotate to the edge limit. This is useful for simulating the limits of human motion.
* If `1.0`, no damping is performed. If `0.0`, damping is always performed.
*/
get primary_damp_threshold(): float64
set primary_damp_threshold(value: float64)
/** The limit angle of positive side of the primary rotation when [member symmetry_limitation] is `false`. */
get primary_positive_limit_angle(): float64
set primary_positive_limit_angle(value: float64)
/** The threshold to start damping for [member primary_positive_limit_angle]. */
get primary_positive_damp_threshold(): float64
set primary_positive_damp_threshold(value: float64)
/** The limit angle of negative side of the primary rotation when [member symmetry_limitation] is `false`. */
get primary_negative_limit_angle(): float64
set primary_negative_limit_angle(value: float64)
/** The threshold to start damping for [member primary_negative_limit_angle]. */
get primary_negative_damp_threshold(): float64
set primary_negative_damp_threshold(value: float64)
/** The limit angle of the secondary rotation when [member symmetry_limitation] is `true`. */
get secondary_limit_angle(): float64
set secondary_limit_angle(value: float64)
/** The threshold to start damping for [member secondary_limit_angle]. */
get secondary_damp_threshold(): float64
set secondary_damp_threshold(value: float64)
/** The limit angle of positive side of the secondary rotation when [member symmetry_limitation] is `false`. */
get secondary_positive_limit_angle(): float64
set secondary_positive_limit_angle(value: float64)
/** The threshold to start damping for [member secondary_positive_limit_angle]. */
get secondary_positive_damp_threshold(): float64
set secondary_positive_damp_threshold(value: float64)
/** The limit angle of negative side of the secondary rotation when [member symmetry_limitation] is `false`. */
get secondary_negative_limit_angle(): float64
set secondary_negative_limit_angle(value: float64)
/** The threshold to start damping for [member secondary_negative_limit_angle]. */
get secondary_negative_damp_threshold(): float64
set secondary_negative_damp_threshold(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapLookAtModifier3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMainLoop extends __NameMapObject {
}
/** Abstract base class for the game's main loop.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_mainloop.html
*/
class MainLoop extends Object {
/** Notification received from the OS when the application is exceeding its allocated memory.
* Specific to the iOS platform.
*/
static readonly NOTIFICATION_OS_MEMORY_WARNING = 2009
/** Notification received when translations may have changed. Can be triggered by the user changing the locale. Can be used to respond to language changes, for example to change the UI strings on the fly. Useful when working with the built-in translation support, like [method Object.tr]. */
static readonly NOTIFICATION_TRANSLATION_CHANGED = 2010
/** Notification received from the OS when a request for "About" information is sent.
* Specific to the macOS platform.
*/
static readonly NOTIFICATION_WM_ABOUT = 2011
/** Notification received from Godot's crash handler when the engine is about to crash.
* Implemented on desktop platforms if the crash handler is enabled.
*/
static readonly NOTIFICATION_CRASH = 2012
/** Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string).
* Specific to the macOS platform.
*/
static readonly NOTIFICATION_OS_IME_UPDATE = 2013
/** Notification received from the OS when the application is resumed.
* Specific to the Android and iOS platforms.
*/
static readonly NOTIFICATION_APPLICATION_RESUMED = 2014
/** Notification received from the OS when the application is paused.
* Specific to the Android and iOS platforms.
*
* **Note:** On iOS, you only have approximately 5 seconds to finish a task started by this signal. If you go over this allotment, iOS will kill the app instead of pausing it.
*/
static readonly NOTIFICATION_APPLICATION_PAUSED = 2015
/** Notification received from the OS when the application is focused, i.e. when changing the focus from the OS desktop or a thirdparty application to any open window of the Godot instance.
* Implemented on desktop and mobile platforms.
*/
static readonly NOTIFICATION_APPLICATION_FOCUS_IN = 2016
/** Notification received from the OS when the application is defocused, i.e. when changing the focus from any open window of the Godot instance to the OS desktop or a thirdparty application.
* Implemented on desktop and mobile platforms.
*/
static readonly NOTIFICATION_APPLICATION_FOCUS_OUT = 2017
/** Notification received when text server is changed. */
static readonly NOTIFICATION_TEXT_SERVER_CHANGED = 2018
constructor(identifier?: any)
/** Called once during initialization. */
/* gdvirtual */ _initialize(): void
/** Called each physics tick. [param delta] is the logical time between physics ticks in seconds and is equal to [member Engine.time_scale] / [member Engine.physics_ticks_per_second]. Equivalent to [method Node._physics_process].
* If implemented, the method must return a boolean value. `true` ends the main loop, while `false` lets it proceed to the next step.
*
* **Note:** [method _physics_process] may be called up to [member Engine.max_physics_steps_per_frame] times per (idle) frame. This step limit may be reached when the engine is suffering performance issues.
*
* **Note:** Accumulated [param delta] may diverge from real world seconds.
*/
/* gdvirtual */ _physics_process(delta: float64): boolean
/** Called on each idle frame, prior to rendering, and after physics ticks have been processed. [param delta] is the time between frames in seconds. Equivalent to [method Node._process].
* If implemented, the method must return a boolean value. `true` ends the main loop, while `false` lets it proceed to the next frame.
*
* **Note:** When the engine is struggling and the frame rate is lowered, [param delta] will increase. When [param delta] is increased, it's capped at a maximum of [member Engine.time_scale] * [member Engine.max_physics_steps_per_frame] / [member Engine.physics_ticks_per_second]. As a result, accumulated [param delta] may not represent real world time.
*
* **Note:** When `--fixed-fps` is enabled or the engine is running in Movie Maker mode (see [MovieWriter]), process [param delta] will always be the same for every frame, regardless of how much time the frame took to render.
*
* **Note:** Frame delta may be post-processed by [member OS.delta_smoothing] if this is enabled for the project.
*/
/* gdvirtual */ _process(delta: float64): boolean
/** Called before the program exits. */
/* gdvirtual */ _finalize(): void
/** Emitted when a user responds to a permission request. */
readonly on_request_permissions_result: Signal<(permission: string, granted: boolean) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMainLoop;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMarginContainer extends __NameMapContainer {
}
/** A container that keeps a margin around its child controls.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_margincontainer.html
*/
class MarginContainer<Map extends NodePathMap = any> extends Container<Map> {
constructor(identifier?: any)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMarginContainer;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMarker2D extends __NameMapNode2D {
}
/** Generic 2D position hint for editing.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_marker2d.html
*/
class Marker2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** Size of the gizmo cross that appears in the editor. */
get gizmo_extents(): float64
set gizmo_extents(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMarker2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMarker3D extends __NameMapNode3D {
}
/** Generic 3D position hint for editing.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_marker3d.html
*/
class Marker3D<Map extends NodePathMap = any> extends Node3D<Map> {
constructor(identifier?: any)
/** Size of the gizmo cross that appears in the editor. */
get gizmo_extents(): float64
set gizmo_extents(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMarker3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMaterial extends __NameMapResource {
}
/** Virtual base class for applying visual properties to an object, such as color and roughness.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_material.html
*/
class Material extends Resource {
/** Maximum value for the [member render_priority] parameter. */
static readonly RENDER_PRIORITY_MAX = 127
/** Minimum value for the [member render_priority] parameter. */
static readonly RENDER_PRIORITY_MIN = -128
constructor(identifier?: any)
/** Only exposed for the purpose of overriding. You cannot call this function directly. Used internally by various editor tools. Used to access the RID of the [Material]'s [Shader]. */
/* gdvirtual */ _get_shader_rid(): RID
/** Only exposed for the purpose of overriding. You cannot call this function directly. Used internally by various editor tools. */
/* gdvirtual */ _get_shader_mode(): Shader.Mode
/** Only exposed for the purpose of overriding. You cannot call this function directly. Used internally to determine if [member next_pass] should be shown in the editor or not. */
/* gdvirtual */ _can_do_next_pass(): boolean
/** Only exposed for the purpose of overriding. You cannot call this function directly. Used internally to determine if [member render_priority] should be shown in the editor or not. */
/* gdvirtual */ _can_use_render_priority(): boolean
/** Only available when running in the editor. Opens a popup that visualizes the generated shader code, including all variants and internal shader code. See also [method Shader.inspect_native_shader_code]. */
inspect_native_shader_code(): void
/** Creates a placeholder version of this resource ([PlaceholderMaterial]). */
create_placeholder(): Resource
/** Sets the render priority for objects in 3D scenes. Higher priority objects will be sorted in front of lower priority objects. In other words, all objects with [member render_priority] `1` will render on top of all objects with [member render_priority] `0`.
*
* **Note:** This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial".
*
* **Note:** This will not impact how transparent objects are sorted relative to opaque objects or how dynamic meshes will be sorted relative to other opaque meshes. This is because all transparent objects are drawn after all opaque objects and all dynamic opaque meshes are drawn before other opaque meshes.
*/
get render_priority(): int64
set render_priority(value: int64)
/** Sets the [Material] to be used for the next pass. This renders the object again using a different material.
*
* **Note:** [member next_pass] materials are not necessarily drawn immediately after the source [Material]. Draw order is determined by material properties, [member render_priority], and distance to camera.
*
* **Note:** This only applies to [StandardMaterial3D]s and [ShaderMaterial]s with type "Spatial".
*/
get next_pass(): null | Material
set next_pass(value: null | Material)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMaterial;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMenuBar extends __NameMapControl {
}
/** A horizontal menu bar that creates a menu for each [PopupMenu] child.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_menubar.html
*/
class MenuBar<Map extends NodePathMap = any> extends Control<Map> {
constructor(identifier?: any)
/** If `true`, shortcuts are disabled and cannot be used to trigger the button. */
set_disable_shortcuts(disabled: boolean): void
/** Returns `true`, if system global menu is supported and used by this [MenuBar]. */
is_native_menu(): boolean
/** Returns number of menu items. */
get_menu_count(): int64
/** Sets menu item title. */
set_menu_title(menu: int64, title: string): void
/** Returns menu item title. */
get_menu_title(menu: int64): string
/** Sets menu item tooltip. */
set_menu_tooltip(menu: int64, tooltip: string): void
/** Returns menu item tooltip. */
get_menu_tooltip(menu: int64): string
/** If `true`, menu item is disabled. */
set_menu_disabled(menu: int64, disabled: boolean): void
/** Returns `true`, if menu item is disabled. */
is_menu_disabled(menu: int64): boolean
/** If `true`, menu item is hidden. */
set_menu_hidden(menu: int64, hidden: boolean): void
/** Returns `true`, if menu item is hidden. */
is_menu_hidden(menu: int64): boolean
/** Returns [PopupMenu] associated with menu item. */
get_menu_popup(menu: int64): null | PopupMenu
/** Flat [MenuBar] don't display item decoration. */
get flat(): boolean
set flat(value: boolean)
/** Position order in the global menu to insert [MenuBar] items at. All menu items in the [MenuBar] are always inserted as a continuous range. Menus with lower [member start_index] are inserted first. Menus with [member start_index] equal to `-1` are inserted last. */
get start_index(): int64
set start_index(value: int64)
/** If `true`, when the cursor hovers above menu item, it will close the current [PopupMenu] and open the other one. */
get switch_on_hover(): boolean
set switch_on_hover(value: boolean)
/** If `true`, [MenuBar] will use system global menu when supported.
*
* **Note:** If `true` and global menu is supported, this node is not displayed, has zero size, and all its child nodes except [PopupMenu]s are inaccessible.
*
* **Note:** This property overrides the value of the [member PopupMenu.prefer_native_menu] property of the child nodes.
*/
get prefer_global_menu(): boolean
set prefer_global_menu(value: boolean)
/** Base text writing direction. */
get text_direction(): int64
set text_direction(value: int64)
/** Language code used for line-breaking and text shaping algorithms, if left empty current locale is used instead. */
get language(): string
set language(value: string)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMenuBar;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMenuButton extends __NameMapButton {
}
/** A button that brings up a [PopupMenu] when clicked.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_menubutton.html
*/
class MenuButton<Map extends NodePathMap = any> extends Button<Map> {
constructor(identifier?: any)
/** Returns the [PopupMenu] contained in this button.
* **Warning:** This is a required internal node, removing and freeing it may cause a crash. If you wish to hide it or any of its children, use their [member Window.visible] property.
*/
get_popup(): null | PopupMenu
/** Adjusts popup position and sizing for the [MenuButton], then shows the [PopupMenu]. Prefer this over using `get_popup().popup()`. */
show_popup(): void
/** If `true`, shortcuts are disabled and cannot be used to trigger the button. */
set_disable_shortcuts(disabled: boolean): void
/** If `true`, when the cursor hovers above another [MenuButton] within the same parent which also has [member switch_on_hover] enabled, it will close the current [MenuButton] and open the other one. */
get switch_on_hover(): boolean
set switch_on_hover(value: boolean)
/** The number of items currently in the list. */
get item_count(): int64
set item_count(value: int64)
/** Emitted when the [PopupMenu] of this MenuButton is about to show. */
readonly about_to_popup: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMenuButton;
}
namespace Mesh {
enum PrimitiveType {
/** Render array as points (one vertex equals one point). */
PRIMITIVE_POINTS = 0,
/** Render array as lines (every two vertices a line is created). */
PRIMITIVE_LINES = 1,
/** Render array as line strip. */
PRIMITIVE_LINE_STRIP = 2,
/** Render array as triangles (every three vertices a triangle is created). */
PRIMITIVE_TRIANGLES = 3,
/** Render array as triangle strips. */
PRIMITIVE_TRIANGLE_STRIP = 4,
}
enum ArrayType {
/** [PackedVector3Array], [PackedVector2Array], or [Array] of vertex positions. */
ARRAY_VERTEX = 0,
/** [PackedVector3Array] of vertex normals.
*
* **Note:** The array has to consist of normal vectors, otherwise they will be normalized by the engine, potentially causing visual discrepancies.
*/
ARRAY_NORMAL = 1,
/** [PackedFloat32Array] of vertex tangents. Each element in groups of 4 floats, first 3 floats determine the tangent, and the last the binormal direction as -1 or 1. */
ARRAY_TANGENT = 2,
/** [PackedColorArray] of vertex colors. */
ARRAY_COLOR = 3,
/** [PackedVector2Array] for UV coordinates. */
ARRAY_TEX_UV = 4,
/** [PackedVector2Array] for second UV coordinates. */
ARRAY_TEX_UV2 = 5,
/** Contains custom color channel 0. [PackedByteArray] if `(format >> Mesh.ARRAY_FORMAT_CUSTOM0_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK` is [constant ARRAY_CUSTOM_RGBA8_UNORM], [constant ARRAY_CUSTOM_RGBA8_SNORM], [constant ARRAY_CUSTOM_RG_HALF], or [constant ARRAY_CUSTOM_RGBA_HALF]. [PackedFloat32Array] otherwise. */
ARRAY_CUSTOM0 = 6,
/** Contains custom color channel 1. [PackedByteArray] if `(format >> Mesh.ARRAY_FORMAT_CUSTOM1_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK` is [constant ARRAY_CUSTOM_RGBA8_UNORM], [constant ARRAY_CUSTOM_RGBA8_SNORM], [constant ARRAY_CUSTOM_RG_HALF], or [constant ARRAY_CUSTOM_RGBA_HALF]. [PackedFloat32Array] otherwise. */
ARRAY_CUSTOM1 = 7,
/** Contains custom color channel 2. [PackedByteArray] if `(format >> Mesh.ARRAY_FORMAT_CUSTOM2_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK` is [constant ARRAY_CUSTOM_RGBA8_UNORM], [constant ARRAY_CUSTOM_RGBA8_SNORM], [constant ARRAY_CUSTOM_RG_HALF], or [constant ARRAY_CUSTOM_RGBA_HALF]. [PackedFloat32Array] otherwise. */
ARRAY_CUSTOM2 = 8,
/** Contains custom color channel 3. [PackedByteArray] if `(format >> Mesh.ARRAY_FORMAT_CUSTOM3_SHIFT) & Mesh.ARRAY_FORMAT_CUSTOM_MASK` is [constant ARRAY_CUSTOM_RGBA8_UNORM], [constant ARRAY_CUSTOM_RGBA8_SNORM], [constant ARRAY_CUSTOM_RG_HALF], or [constant ARRAY_CUSTOM_RGBA_HALF]. [PackedFloat32Array] otherwise. */
ARRAY_CUSTOM3 = 9,
/** [PackedFloat32Array] or [PackedInt32Array] of bone indices. Contains either 4 or 8 numbers per vertex depending on the presence of the [constant ARRAY_FLAG_USE_8_BONE_WEIGHTS] flag. */
ARRAY_BONES = 10,
/** [PackedFloat32Array] or [PackedFloat64Array] of bone weights in the range `0.0` to `1.0` (inclusive). Contains either 4 or 8 numbers per vertex depending on the presence of the [constant ARRAY_FLAG_USE_8_BONE_WEIGHTS] flag. */
ARRAY_WEIGHTS = 11,
/** [PackedInt32Array] of integers used as indices referencing vertices, colors, normals, tangents, and textures. All of those arrays must have the same number of elements as the vertex array. No index can be beyond the vertex array size. When this index array is present, it puts the function into "index mode," where the index selects the *i* 'th vertex, normal, tangent, color, UV, etc. This means if you want to have different normals or colors along an edge, you have to duplicate the vertices.
* For triangles, the index array is interpreted as triples, referring to the vertices of each triangle. For lines, the index array is in pairs indicating the start and end of each line.
*/
ARRAY_INDEX = 12,
/** Represents the size of the [enum ArrayType] enum. */
ARRAY_MAX = 13,
}
enum ArrayCustomFormat {
/** Indicates this custom channel contains unsigned normalized byte colors from 0 to 1, encoded as [PackedByteArray]. */
ARRAY_CUSTOM_RGBA8_UNORM = 0,
/** Indicates this custom channel contains signed normalized byte colors from -1 to 1, encoded as [PackedByteArray]. */
ARRAY_CUSTOM_RGBA8_SNORM = 1,
/** Indicates this custom channel contains half precision float colors, encoded as [PackedByteArray]. Only red and green channels are used. */
ARRAY_CUSTOM_RG_HALF = 2,
/** Indicates this custom channel contains half precision float colors, encoded as [PackedByteArray]. */
ARRAY_CUSTOM_RGBA_HALF = 3,
/** Indicates this custom channel contains full float colors, in a [PackedFloat32Array]. Only the red channel is used. */
ARRAY_CUSTOM_R_FLOAT = 4,
/** Indicates this custom channel contains full float colors, in a [PackedFloat32Array]. Only red and green channels are used. */
ARRAY_CUSTOM_RG_FLOAT = 5,
/** Indicates this custom channel contains full float colors, in a [PackedFloat32Array]. Only red, green and blue channels are used. */
ARRAY_CUSTOM_RGB_FLOAT = 6,
/** Indicates this custom channel contains full float colors, in a [PackedFloat32Array]. */
ARRAY_CUSTOM_RGBA_FLOAT = 7,
/** Represents the size of the [enum ArrayCustomFormat] enum. */
ARRAY_CUSTOM_MAX = 8,
}
enum ArrayFormat {
/** Mesh array contains vertices. All meshes require a vertex array so this should always be present. */
ARRAY_FORMAT_VERTEX = 1,
/** Mesh array contains normals. */
ARRAY_FORMAT_NORMAL = 2,
/** Mesh array contains tangents. */
ARRAY_FORMAT_TANGENT = 4,
/** Mesh array contains colors. */
ARRAY_FORMAT_COLOR = 8,
/** Mesh array contains UVs. */
ARRAY_FORMAT_TEX_UV = 16,
/** Mesh array contains second UV. */
ARRAY_FORMAT_TEX_UV2 = 32,
/** Mesh array contains custom channel index 0. */
ARRAY_FORMAT_CUSTOM0 = 64,
/** Mesh array contains custom channel index 1. */
ARRAY_FORMAT_CUSTOM1 = 128,
/** Mesh array contains custom channel index 2. */
ARRAY_FORMAT_CUSTOM2 = 256,
/** Mesh array contains custom channel index 3. */
ARRAY_FORMAT_CUSTOM3 = 512,
/** Mesh array contains bones. */
ARRAY_FORMAT_BONES = 1024,
/** Mesh array contains bone weights. */
ARRAY_FORMAT_WEIGHTS = 2048,
/** Mesh array uses indices. */
ARRAY_FORMAT_INDEX = 4096,
/** Mask of mesh channels permitted in blend shapes. */
ARRAY_FORMAT_BLEND_SHAPE_MASK = 7,
/** Shift of first custom channel. */
ARRAY_FORMAT_CUSTOM_BASE = 13,
/** Number of format bits per custom channel. See [enum ArrayCustomFormat]. */
ARRAY_FORMAT_CUSTOM_BITS = 3,
/** Amount to shift [enum ArrayCustomFormat] for custom channel index 0. */
ARRAY_FORMAT_CUSTOM0_SHIFT = 13,
/** Amount to shift [enum ArrayCustomFormat] for custom channel index 1. */
ARRAY_FORMAT_CUSTOM1_SHIFT = 16,
/** Amount to shift [enum ArrayCustomFormat] for custom channel index 2. */
ARRAY_FORMAT_CUSTOM2_SHIFT = 19,
/** Amount to shift [enum ArrayCustomFormat] for custom channel index 3. */
ARRAY_FORMAT_CUSTOM3_SHIFT = 22,
/** Mask of custom format bits per custom channel. Must be shifted by one of the SHIFT constants. See [enum ArrayCustomFormat]. */
ARRAY_FORMAT_CUSTOM_MASK = 7,
/** Shift of first compress flag. Compress flags should be passed to [method ArrayMesh.add_surface_from_arrays] and [method SurfaceTool.commit]. */
ARRAY_COMPRESS_FLAGS_BASE = 25,
/** Flag used to mark that the array contains 2D vertices. */
ARRAY_FLAG_USE_2D_VERTICES = 33554432,
/** Flag used to mark that the mesh data will use `GL_DYNAMIC_DRAW` on GLES. Unused on Vulkan. */
ARRAY_FLAG_USE_DYNAMIC_UPDATE = 67108864,
/** Flag used to mark that the mesh contains up to 8 bone influences per vertex. This flag indicates that [constant ARRAY_BONES] and [constant ARRAY_WEIGHTS] elements will have double length. */
ARRAY_FLAG_USE_8_BONE_WEIGHTS = 134217728,
/** Flag used to mark that the mesh intentionally contains no vertex array. */
ARRAY_FLAG_USES_EMPTY_VERTEX_ARRAY = 268435456,
/** Flag used to mark that a mesh is using compressed attributes (vertices, normals, tangents, UVs). When this form of compression is enabled, vertex positions will be packed into an RGBA16UNORM attribute and scaled in the vertex shader. The normal and tangent will be packed into an RG16UNORM representing an axis, and a 16-bit float stored in the A-channel of the vertex. UVs will use 16-bit normalized floats instead of full 32-bit signed floats. When using this compression mode you must use either vertices, normals, and tangents or only vertices. You cannot use normals without tangents. Importers will automatically enable this compression if they can. */
ARRAY_FLAG_COMPRESS_ATTRIBUTES = 536870912,
}
enum BlendShapeMode {
/** Blend shapes are normalized. */
BLEND_SHAPE_MODE_NORMALIZED = 0,
/** Blend shapes are relative to base weight. */
BLEND_SHAPE_MODE_RELATIVE = 1,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMesh extends __NameMapResource {
}
/** A [Resource] that contains vertex array-based geometry.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_mesh.html
*/
class Mesh extends Resource {
constructor(identifier?: any)
/** Virtual method to override the surface count for a custom class extending [Mesh]. */
/* gdvirtual */ _get_surface_count(): int64
/** Virtual method to override the surface array length for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_get_array_len(index: int64): int64
/** Virtual method to override the surface array index length for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_get_array_index_len(index: int64): int64
/** Virtual method to override the surface arrays for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_get_arrays(index: int64): GArray
/** Virtual method to override the blend shape arrays for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_get_blend_shape_arrays(index: int64): GArray<GArray>
/** Virtual method to override the surface LODs for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_get_lods(index: int64): GDictionary
/** Virtual method to override the surface format for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_get_format(index: int64): int64
/** Virtual method to override the surface primitive type for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_get_primitive_type(index: int64): int64
/** Virtual method to override the setting of a [param material] at the given [param index] for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_set_material(index: int64, material: Material): void
/** Virtual method to override the surface material for a custom class extending [Mesh]. */
/* gdvirtual */ _surface_get_material(index: int64): null | Material
/** Virtual method to override the number of blend shapes for a custom class extending [Mesh]. */
/* gdvirtual */ _get_blend_shape_count(): int64
/** Virtual method to override the retrieval of blend shape names for a custom class extending [Mesh]. */
/* gdvirtual */ _get_blend_shape_name(index: int64): StringName
/** Virtual method to override the names of blend shapes for a custom class extending [Mesh]. */
/* gdvirtual */ _set_blend_shape_name(index: int64, name: StringName): void
/** Virtual method to override the [AABB] for a custom class extending [Mesh]. */
/* gdvirtual */ _get_aabb(): AABB
/** Returns the smallest [AABB] enclosing this mesh in local space. Not affected by `custom_aabb`.
*
* **Note:** This is only implemented for [ArrayMesh] and [PrimitiveMesh].
*/
get_aabb(): AABB
/** Returns all the vertices that make up the faces of the mesh. Each three vertices represent one triangle. */
get_faces(): PackedVector3Array
/** Returns the number of surfaces that the [Mesh] holds. This is equivalent to [method MeshInstance3D.get_surface_override_material_count]. */
get_surface_count(): int64
/** Returns the arrays for the vertices, normals, UVs, etc. that make up the requested surface (see [method ArrayMesh.add_surface_from_arrays]). */
surface_get_arrays(surf_idx: int64): GArray
/** Returns the blend shape arrays for the requested surface. */
surface_get_blend_shape_arrays(surf_idx: int64): GArray<GArray>
/** Sets a [Material] for a given surface. Surface will be rendered using this material.
*
* **Note:** This assigns the material within the [Mesh] resource, not the [Material] associated to the [MeshInstance3D]'s Surface Material Override properties. To set the [Material] associated to the [MeshInstance3D]'s Surface Material Override properties, use [method MeshInstance3D.set_surface_override_material] instead.
*/
surface_set_material(surf_idx: int64, material: Material): void
/** Returns a [Material] in a given surface. Surface is rendered using this material.
*
* **Note:** This returns the material within the [Mesh] resource, not the [Material] associated to the [MeshInstance3D]'s Surface Material Override properties. To get the [Material] associated to the [MeshInstance3D]'s Surface Material Override properties, use [method MeshInstance3D.get_surface_override_material] instead.
*/
surface_get_material(surf_idx: int64): null | Material
/** Creates a placeholder version of this resource ([PlaceholderMesh]). */
create_placeholder(): Resource
/** Calculate a [ConcavePolygonShape3D] from the mesh. */
create_trimesh_shape(): ConcavePolygonShape3D
/** Calculate a [ConvexPolygonShape3D] from the mesh.
* If [param clean] is `true` (default), duplicate and interior vertices are removed automatically. You can set it to `false` to make the process faster if not needed.
* If [param simplify] is `true`, the geometry can be further simplified to reduce the number of vertices. Disabled by default.
*/
create_convex_shape(clean?: boolean /* = true */, simplify?: boolean /* = false */): ConvexPolygonShape3D
/** Calculate an outline mesh at a defined offset (margin) from the original mesh.
*
* **Note:** This method typically returns the vertices in reverse order (e.g. clockwise to counterclockwise).
*/
create_outline(margin: float64): Mesh
/** Generate a [TriangleMesh] from the mesh. Considers only surfaces using one of these primitive types: [constant PRIMITIVE_TRIANGLES], [constant PRIMITIVE_TRIANGLE_STRIP]. */
generate_triangle_mesh(): null | TriangleMesh
/** Sets a hint to be used for lightmap resolution. */
get lightmap_size_hint(): Vector2i
set lightmap_size_hint(value: Vector2i)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMesh;
}
namespace MeshConvexDecompositionSettings {
enum Mode {
/** Constant for voxel-based approximate convex decomposition. */
CONVEX_DECOMPOSITION_MODE_VOXEL = 0,
/** Constant for tetrahedron-based approximate convex decomposition. */
CONVEX_DECOMPOSITION_MODE_TETRAHEDRON = 1,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMeshConvexDecompositionSettings extends __NameMapRefCounted {
}
/** Parameters to be used with a [Mesh] convex decomposition operation.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_meshconvexdecompositionsettings.html
*/
class MeshConvexDecompositionSettings extends RefCounted {
constructor(identifier?: any)
/** Maximum concavity. Ranges from `0.0` to `1.0`. */
get max_concavity(): float64
set max_concavity(value: float64)
/** Controls the bias toward clipping along symmetry planes. Ranges from `0.0` to `1.0`. */
get symmetry_planes_clipping_bias(): float64
set symmetry_planes_clipping_bias(value: float64)
/** Controls the bias toward clipping along revolution axes. Ranges from `0.0` to `1.0`. */
get revolution_axes_clipping_bias(): float64
set revolution_axes_clipping_bias(value: float64)
/** Controls the adaptive sampling of the generated convex-hulls. Ranges from `0.0` to `0.01`. */
get min_volume_per_convex_hull(): float64
set min_volume_per_convex_hull(value: float64)
/** Maximum number of voxels generated during the voxelization stage. */
get resolution(): int64
set resolution(value: int64)
/** Controls the maximum number of triangles per convex-hull. Ranges from `4` to `1024`. */
get max_num_vertices_per_convex_hull(): int64
set max_num_vertices_per_convex_hull(value: int64)
/** Controls the granularity of the search for the "best" clipping plane. Ranges from `1` to `16`. */
get plane_downsampling(): int64
set plane_downsampling(value: int64)
/** Controls the precision of the convex-hull generation process during the clipping plane selection stage. Ranges from `1` to `16`. */
get convex_hull_downsampling(): int64
set convex_hull_downsampling(value: int64)
/** If `true`, normalizes the mesh before applying the convex decomposition. */
get normalize_mesh(): boolean
set normalize_mesh(value: boolean)
/** Mode for the approximate convex decomposition. */
get mode(): int64
set mode(value: int64)
/** If `true`, uses approximation for computing convex hulls. */
get convex_hull_approximation(): boolean
set convex_hull_approximation(value: boolean)
/** The maximum number of convex hulls to produce from the merge operation. */
get max_convex_hulls(): int64
set max_convex_hulls(value: int64)
/** If `true`, projects output convex hull vertices onto the original source mesh to increase floating-point accuracy of the results. */
get project_hull_vertices(): boolean
set project_hull_vertices(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMeshConvexDecompositionSettings;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMeshDataTool extends __NameMapRefCounted {
}
/** Helper tool to access and edit [Mesh] data.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_meshdatatool.html
*/
class MeshDataTool extends RefCounted {
constructor(identifier?: any)
/** Clears all data currently in MeshDataTool. */
clear(): void
/** Uses specified surface of given [Mesh] to populate data for MeshDataTool.
* Requires [Mesh] with primitive type [constant Mesh.PRIMITIVE_TRIANGLES].
*/
create_from_surface(mesh: ArrayMesh, surface: int64): Error
/** Adds a new surface to specified [Mesh] with edited data. */
commit_to_surface(mesh: ArrayMesh, compression_flags?: int64 /* = 0 */): Error
/** Returns the [Mesh]'s format as a combination of the [enum Mesh.ArrayFormat] flags. For example, a mesh containing both vertices and normals would return a format of `3` because [constant Mesh.ARRAY_FORMAT_VERTEX] is `1` and [constant Mesh.ARRAY_FORMAT_NORMAL] is `2`. */
get_format(): int64
/** Returns the total number of vertices in [Mesh]. */
get_vertex_count(): int64
/** Returns the number of edges in this [Mesh]. */
get_edge_count(): int64
/** Returns the number of faces in this [Mesh]. */
get_face_count(): int64
/** Sets the position of the given vertex. */
set_vertex(idx: int64, vertex: Vector3): void
/** Returns the position of the given vertex. */
get_vertex(idx: int64): Vector3
/** Sets the normal of the given vertex. */
set_vertex_normal(idx: int64, normal: Vector3): void
/** Returns the normal of the given vertex. */
get_vertex_normal(idx: int64): Vector3
/** Sets the tangent of the given vertex. */
set_vertex_tangent(idx: int64, tangent: Plane): void
/** Returns the tangent of the given vertex. */
get_vertex_tangent(idx: int64): Plane
/** Sets the UV of the given vertex. */
set_vertex_uv(idx: int64, uv: Vector2): void
/** Returns the UV of the given vertex. */
get_vertex_uv(idx: int64): Vector2
/** Sets the UV2 of the given vertex. */
set_vertex_uv2(idx: int64, uv2: Vector2): void
/** Returns the UV2 of the given vertex. */
get_vertex_uv2(idx: int64): Vector2
/** Sets the color of the given vertex. */
set_vertex_color(idx: int64, color: Color): void
/** Returns the color of the given vertex. */
get_vertex_color(idx: int64): Color
/** Sets the bones of the given vertex. */
set_vertex_bones(idx: int64, bones: PackedInt32Array | int32[]): void
/** Returns the bones of the given vertex. */
get_vertex_bones(idx: int64): PackedInt32Array
/** Sets the bone weights of the given vertex. */
set_vertex_weights(idx: int64, weights: PackedFloat32Array | float32[]): void
/** Returns bone weights of the given vertex. */
get_vertex_weights(idx: int64): PackedFloat32Array
/** Sets the metadata associated with the given vertex. */
set_vertex_meta(idx: int64, meta: any): void
/** Returns the metadata associated with the given vertex. */
get_vertex_meta(idx: int64): any
/** Returns an array of edges that share the given vertex. */
get_vertex_edges(idx: int64): PackedInt32Array
/** Returns an array of faces that share the given vertex. */
get_vertex_faces(idx: int64): PackedInt32Array
/** Returns the index of the specified [param vertex] connected to the edge at index [param idx].
* [param vertex] can only be `0` or `1`, as edges are composed of two vertices.
*/
get_edge_vertex(idx: int64, vertex: int64): int64
/** Returns array of faces that touch given edge. */
get_edge_faces(idx: int64): PackedInt32Array
/** Sets the metadata of the given edge. */
set_edge_meta(idx: int64, meta: any): void
/** Returns meta information assigned to given edge. */
get_edge_meta(idx: int64): any
/** Returns the specified vertex index of the given face.
* [param vertex] must be either `0`, `1`, or `2` because faces contain three vertices.
*
*/
get_face_vertex(idx: int64, vertex: int64): int64
/** Returns the edge associated with the face at index [param idx].
* [param edge] argument must be either `0`, `1`, or `2` because a face only has three edges.
*/
get_face_edge(idx: int64, edge: int64): int64
/** Sets the metadata of the given face. */
set_face_meta(idx: int64, meta: any): void
/** Returns the metadata associated with the given face. */
get_face_meta(idx: int64): any
/** Calculates and returns the face normal of the given face. */
get_face_normal(idx: int64): Vector3
/** Sets the material to be used by newly-constructed [Mesh]. */
set_material(material: Material): void
/** Returns the material assigned to the [Mesh]. */
get_material(): null | Material
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMeshDataTool;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMeshInstance2D extends __NameMapNode2D {
}
/** Node used for displaying a [Mesh] in 2D.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_meshinstance2d.html
*/
class MeshInstance2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** The [Mesh] that will be drawn by the [MeshInstance2D]. */
get mesh(): null | Mesh
set mesh(value: null | Mesh)
/** The [Texture2D] that will be used if using the default [CanvasItemMaterial]. Can be accessed as `TEXTURE` in CanvasItem shader. */
get texture(): null | Texture2D
set texture(value: null | Texture2D)
/** Emitted when the [member texture] is changed. */
readonly texture_changed: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMeshInstance2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMeshInstance3D extends __NameMapGeometryInstance3D {
}
/** Node that instances meshes into a scenario.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_meshinstance3d.html
*/
class MeshInstance3D<Map extends NodePathMap = any> extends GeometryInstance3D<Map> {
constructor(identifier?: any)
/** Returns the internal [SkinReference] containing the skeleton's [RID] attached to this RID. See also [method Resource.get_rid], [method SkinReference.get_skeleton], and [method RenderingServer.instance_attach_skeleton]. */
get_skin_reference(): null | SkinReference
/** Returns the number of surface override materials. This is equivalent to [method Mesh.get_surface_count]. See also [method get_surface_override_material]. */
get_surface_override_material_count(): int64
/** Sets the override [param material] for the specified [param surface] of the [Mesh] resource. This material is associated with this [MeshInstance3D] rather than with [member mesh].
*
* **Note:** This assigns the [Material] associated to the [MeshInstance3D]'s Surface Material Override properties, not the material within the [Mesh] resource. To set the material within the [Mesh] resource, use [method Mesh.surface_set_material] instead.
*/
set_surface_override_material(surface: int64, material: Material): void
/** Returns the override [Material] for the specified [param surface] of the [Mesh] resource. See also [method get_surface_override_material_count].
*
* **Note:** This returns the [Material] associated to the [MeshInstance3D]'s Surface Material Override properties, not the material within the [Mesh] resource. To get the material within the [Mesh] resource, use [method Mesh.surface_get_material] instead.
*/
get_surface_override_material(surface: int64): null | Material
/** Returns the [Material] that will be used by the [Mesh] when drawing. This can return the [member GeometryInstance3D.material_override], the surface override [Material] defined in this [MeshInstance3D], or the surface [Material] defined in the [member mesh]. For example, if [member GeometryInstance3D.material_override] is used, all surfaces will return the override material.
* Returns `null` if no material is active, including when [member mesh] is `null`.
*/
get_active_material(surface: int64): null | Material
/** This helper creates a [StaticBody3D] child node with a [ConcavePolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing. */
create_trimesh_collision(): void
/** This helper creates a [StaticBody3D] child node with a [ConvexPolygonShape3D] collision shape calculated from the mesh geometry. It's mainly used for testing.
* If [param clean] is `true` (default), duplicate and interior vertices are removed automatically. You can set it to `false` to make the process faster if not needed.
* If [param simplify] is `true`, the geometry can be further simplified to reduce the number of vertices. Disabled by default.
*/
create_convex_collision(clean?: boolean /* = true */, simplify?: boolean /* = false */): void
/** This helper creates a [StaticBody3D] child node with multiple [ConvexPolygonShape3D] collision shapes calculated from the mesh geometry via convex decomposition. The convex decomposition operation can be controlled with parameters from the optional [param settings]. */
create_multiple_convex_collisions(settings?: MeshConvexDecompositionSettings /* = undefined */): void
/** Returns the number of blend shapes available. Produces an error if [member mesh] is `null`. */
get_blend_shape_count(): int64
/** Returns the index of the blend shape with the given [param name]. Returns `-1` if no blend shape with this name exists, including when [member mesh] is `null`. */
find_blend_shape_by_name(name: StringName): int64
/** Returns the value of the blend shape at the given [param blend_shape_idx]. Returns `0.0` and produces an error if [member mesh] is `null` or doesn't have a blend shape at that index. */
get_blend_shape_value(blend_shape_idx: int64): float64
/** Sets the value of the blend shape at [param blend_shape_idx] to [param value]. Produces an error if [member mesh] is `null` or doesn't have a blend shape at that index. */
set_blend_shape_value(blend_shape_idx: int64, value: float64): void
/** This helper creates a [MeshInstance3D] child node with gizmos at every vertex calculated from the mesh geometry. It's mainly used for testing. */
create_debug_tangents(): void
/** Takes a snapshot from the current [ArrayMesh] with all blend shapes applied according to their current weights and bakes it to the provided [param existing] mesh. If no [param existing] mesh is provided a new [ArrayMesh] is created, baked and returned. Mesh surface materials are not copied.
* **Performance:** [Mesh] data needs to be received from the GPU, stalling the [RenderingServer] in the process.
*/
bake_mesh_from_current_blend_shape_mix(existing?: ArrayMesh /* = undefined */): null | ArrayMesh
/** Takes a snapshot of the current animated skeleton pose of the skinned mesh and bakes it to the provided [param existing] mesh. If no [param existing] mesh is provided a new [ArrayMesh] is created, baked, and returned. Requires a skeleton with a registered skin to work. Blendshapes are ignored. Mesh surface materials are not copied.
* **Performance:** [Mesh] data needs to be retrieved from the GPU, stalling the [RenderingServer] in the process.
*/
bake_mesh_from_current_skeleton_pose(existing?: ArrayMesh /* = undefined */): null | ArrayMesh
/** The [Mesh] resource for the instance. */
get mesh(): null | Mesh
set mesh(value: null | Mesh)
/** The [Skin] to be used by this instance. */
get skin(): null | Skin
set skin(value: null | Skin)
/** [NodePath] to the [Skeleton3D] associated with the instance. */
get skeleton(): NodePath
set skeleton(value: NodePath | string)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMeshInstance3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMeshLibrary extends __NameMapResource {
}
/** Library of meshes.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_meshlibrary.html
*/
class MeshLibrary extends Resource {
constructor(identifier?: any)
/** Creates a new item in the library with the given ID.
* You can get an unused ID from [method get_last_unused_item_id].
*/
create_item(id: int64): void
/** Sets the item's name.
* This name is shown in the editor. It can also be used to look up the item later using [method find_item_by_name].
*/
set_item_name(id: int64, name: string): void
/** Sets the item's mesh. */
set_item_mesh(id: int64, mesh: Mesh): void
/** Sets the transform to apply to the item's mesh. */
set_item_mesh_transform(id: int64, mesh_transform: Transform3D): void
/** Sets the item's shadow casting mode to [param shadow_casting_setting]. */
set_item_mesh_cast_shadow(id: int64, shadow_casting_setting: RenderingServer.ShadowCastingSetting): void
/** Sets the item's navigation mesh. */
set_item_navigation_mesh(id: int64, navigation_mesh: NavigationMesh): void
/** Sets the transform to apply to the item's navigation mesh. */
set_item_navigation_mesh_transform(id: int64, navigation_mesh: Transform3D): void
/** Sets the item's navigation layers bitmask. */
set_item_navigation_layers(id: int64, navigation_layers: int64): void
/** Sets an item's collision shapes.
* The array should consist of [Shape3D] objects, each followed by a [Transform3D] that will be applied to it. For shapes that should not have a transform, use [constant Transform3D.IDENTITY].
*/
set_item_shapes(id: int64, shapes: GArray): void
/** Sets a texture to use as the item's preview icon in the editor. */
set_item_preview(id: int64, texture: Texture2D): void
/** Returns the item's name. */
get_item_name(id: int64): string
/** Returns the item's mesh. */
get_item_mesh(id: int64): null | Mesh
/** Returns the transform applied to the item's mesh. */
get_item_mesh_transform(id: int64): Transform3D
/** Returns the item's shadow casting mode. */
get_item_mesh_cast_shadow(id: int64): RenderingServer.ShadowCastingSetting
/** Returns the item's navigation mesh. */
get_item_navigation_mesh(id: int64): null | NavigationMesh
/** Returns the transform applied to the item's navigation mesh. */
get_item_navigation_mesh_transform(id: int64): Transform3D
/** Returns the item's navigation layers bitmask. */
get_item_navigation_layers(id: int64): int64
/** Returns an item's collision shapes.
* The array consists of each [Shape3D] followed by its [Transform3D].
*/
get_item_shapes(id: int64): GArray
/** When running in the editor, returns a generated item preview (a 3D rendering in isometric perspective). When used in a running project, returns the manually-defined item preview which can be set using [method set_item_preview]. Returns an empty [Texture2D] if no preview was manually set in a running project. */
get_item_preview(id: int64): null | Texture2D
/** Removes the item. */
remove_item(id: int64): void
/** Returns the first item with the given name, or `-1` if no item is found. */
find_item_by_name(name: string): int64
/** Clears the library. */
clear(): void
/** Returns the list of item IDs in use. */
get_item_list(): PackedInt32Array
/** Gets an unused ID for a new item. */
get_last_unused_item_id(): int64
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMeshLibrary;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMeshTexture extends __NameMapTexture2D {
}
/** Simple texture that uses a mesh to draw itself.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_meshtexture.html
*/
class MeshTexture extends Texture2D {
constructor(identifier?: any)
/** Sets the mesh used to draw. It must be a mesh using 2D vertices. */
get mesh(): null | Mesh
set mesh(value: null | Mesh)
/** Sets the base texture that the Mesh will use to draw. */
get base_texture(): null | Texture2D
set base_texture(value: null | Texture2D)
/** Sets the size of the image, needed for reference. */
get image_size(): Vector2
set image_size(value: Vector2)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMeshTexture;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMethodTweener extends __NameMapTweener {
}
/** Interpolates an abstract value and supplies it to a method called over time.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_methodtweener.html
*/
class MethodTweener extends Tweener {
constructor(identifier?: any)
/** Sets the time in seconds after which the [MethodTweener] will start interpolating. By default there's no delay. */
set_delay(delay: float64): null | MethodTweener
/** Sets the type of used transition from [enum Tween.TransitionType]. If not set, the default transition is used from the [Tween] that contains this Tweener. */
set_trans(trans: Tween.TransitionType): null | MethodTweener
/** Sets the type of used easing from [enum Tween.EaseType]. If not set, the default easing is used from the [Tween] that contains this Tweener. */
set_ease(ease: Tween.EaseType): null | MethodTweener
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMethodTweener;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMissingNode extends __NameMapNode {
}
/** An internal editor class intended for keeping the data of unrecognized nodes.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_missingnode.html
*/
class MissingNode<Map extends NodePathMap = any> extends Node<Map> {
constructor(identifier?: any)
/** The name of the class this node was supposed to be (see [method Object.get_class]). */
get original_class(): string
set original_class(value: string)
/** Returns the path of the scene this node was instance of originally. */
get original_scene(): string
set original_scene(value: string)
/** If `true`, allows new properties to be set along with existing ones. If `false`, only existing properties' values can be set, and new properties cannot be added. */
get recording_properties(): boolean
set recording_properties(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMissingNode;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMissingResource extends __NameMapResource {
}
/** An internal editor class intended for keeping the data of unrecognized resources.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_missingresource.html
*/
class MissingResource extends Resource {
constructor(identifier?: any)
/** The name of the class this resource was supposed to be (see [method Object.get_class]). */
get original_class(): string
set original_class(value: string)
/** If set to `true`, allows new properties to be added on top of the existing ones with [method Object.set]. */
get recording_properties(): boolean
set recording_properties(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMissingResource;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMobileVRInterface extends __NameMapXRInterface {
}
/** Generic mobile VR implementation.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_mobilevrinterface.html
*/
class MobileVRInterface extends XRInterface {
constructor(identifier?: any)
/** The height at which the camera is placed in relation to the ground (i.e. [XROrigin3D] node). */
get eye_height(): float64
set eye_height(value: float64)
/** The interocular distance, also known as the interpupillary distance. The distance between the pupils of the left and right eye. */
get iod(): float64
set iod(value: float64)
/** The width of the display in centimeters. */
get display_width(): float64
set display_width(value: float64)
/** The distance between the display and the lenses inside of the device in centimeters. */
get display_to_lens(): float64
set display_to_lens(value: float64)
/** Set the offset rect relative to the area being rendered. A length of 1 represents the whole rendering area on that axis. */
get offset_rect(): Rect2
set offset_rect(value: Rect2)
/** The oversample setting. Because of the lens distortion we have to render our buffers at a higher resolution then the screen can natively handle. A value between 1.5 and 2.0 often provides good results but at the cost of performance. */
get oversample(): float64
set oversample(value: float64)
/** The k1 lens factor is one of the two constants that define the strength of the lens used and directly influences the lens distortion effect. */
get k1(): float64
set k1(value: float64)
/** The k2 lens factor, see k1. */
get k2(): float64
set k2(value: float64)
/** The minimum radius around the focal point where full quality is guaranteed if VRS is used as a percentage of screen size.
*
* **Note:** Mobile and Forward+ renderers only. Requires [member Viewport.vrs_mode] to be set to [constant Viewport.VRS_XR].
*/
get vrs_min_radius(): float64
set vrs_min_radius(value: float64)
/** The strength used to calculate the VRS density map. The greater this value, the more noticeable VRS is. This improves performance at the cost of quality.
*
* **Note:** Mobile and Forward+ renderers only. Requires [member Viewport.vrs_mode] to be set to [constant Viewport.VRS_XR].
*/
get vrs_strength(): float64
set vrs_strength(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMobileVRInterface;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapModifierBoneTarget3D extends __NameMapSkeletonModifier3D {
}
/** А node that dynamically copies the 3D transform of a bone in its parent [Skeleton3D].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_modifierbonetarget3d.html
*/
class ModifierBoneTarget3D<Map extends NodePathMap = any> extends SkeletonModifier3D<Map> {
constructor(identifier?: any)
/** The name of the attached bone. */
get bone_name(): string
set bone_name(value: string)
/** The index of the attached bone. */
get bone(): int64
set bone(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapModifierBoneTarget3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMovieWriter extends __NameMapObject {
}
/** Abstract class for non-real-time video recording encoders.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_moviewriter.html
*/
class MovieWriter extends Object {
constructor(identifier?: any)
/** Called when the audio sample rate used for recording the audio is requested by the engine. The value returned must be specified in Hz. Defaults to 48000 Hz if [method _get_audio_mix_rate] is not overridden. */
/* gdvirtual */ _get_audio_mix_rate(): int64
/** Called when the audio speaker mode used for recording the audio is requested by the engine. This can affect the number of output channels in the resulting audio file/stream. Defaults to [constant AudioServer.SPEAKER_MODE_STEREO] if [method _get_audio_speaker_mode] is not overridden. */
/* gdvirtual */ _get_audio_speaker_mode(): AudioServer.SpeakerMode
/** Called when the engine determines whether this [MovieWriter] is able to handle the file at [param path]. Must return `true` if this [MovieWriter] is able to handle the given file path, `false` otherwise. Typically, [method _handles_file] is overridden as follows to allow the user to record a file at any path with a given file extension:
*
*/
/* gdvirtual */ _handles_file(path: string): boolean
/** Called once before the engine starts writing video and audio data. [param movie_size] is the width and height of the video to save. [param fps] is the number of frames per second specified in the project settings or using the `--fixed-fps <fps>` [url=https://docs.godotengine.org/en/4.5/tutorials/editor/command_line_tutorial.html]command line argument[/url]. */
/* gdvirtual */ _write_begin(movie_size: Vector2i, fps: int64, base_path: string): Error
/** Called at the end of every rendered frame. The [param frame_image] and [param audio_frame_block] function arguments should be written to. */
/* gdvirtual */ _write_frame(frame_image: Image, audio_frame_block: int64): Error
/** Called when the engine finishes writing. This occurs when the engine quits by pressing the window manager's close button, or when [method SceneTree.quit] is called.
*
* **Note:** Pressing [kbd]Ctrl + C[/kbd] on the terminal running the editor/project does *not* result in [method _write_end] being called.
*/
/* gdvirtual */ _write_end(): void
/** Adds a writer to be usable by the engine. The supported file extensions can be set by overriding [method _handles_file].
*
* **Note:** [method add_writer] must be called early enough in the engine initialization to work, as movie writing is designed to start at the same time as the rest of the engine.
*/
static add_writer(writer: MovieWriter): void
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMovieWriter;
}
namespace MultiMesh {
enum TransformFormat {
/** Use this when using 2D transforms. */
TRANSFORM_2D = 0,
/** Use this when using 3D transforms. */
TRANSFORM_3D = 1,
}
enum PhysicsInterpolationQuality {
/** Always interpolate using Basis lerping, which can produce warping artifacts in some situations. */
INTERP_QUALITY_FAST = 0,
/** Attempt to interpolate using Basis slerping (spherical linear interpolation) where possible, otherwise fall back to lerping. */
INTERP_QUALITY_HIGH = 1,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiMesh extends __NameMapResource {
}
/** Provides high-performance drawing of a mesh multiple times using GPU instancing.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multimesh.html
*/
class MultiMesh extends Resource {
constructor(identifier?: any)
/** Sets the [Transform3D] for a specific instance. */
set_instance_transform(instance: int64, transform: Transform3D): void
/** Sets the [Transform2D] for a specific instance. */
set_instance_transform_2d(instance: int64, transform: Transform2D): void
/** Returns the [Transform3D] of a specific instance. */
get_instance_transform(instance: int64): Transform3D
/** Returns the [Transform2D] of a specific instance. */
get_instance_transform_2d(instance: int64): Transform2D
/** Sets the color of a specific instance by *multiplying* the mesh's existing vertex colors. This allows for different color tinting per instance.
*
* **Note:** Each component is stored in 32 bits in the Forward+ and Mobile rendering methods, but is packed into 16 bits in the Compatibility rendering method.
* For the color to take effect, ensure that [member use_colors] is `true` on the [MultiMesh] and [member BaseMaterial3D.vertex_color_use_as_albedo] is `true` on the material. If you intend to set an absolute color instead of tinting, make sure the material's albedo color is set to pure white (`Color(1, 1, 1)`).
*/
set_instance_color(instance: int64, color: Color): void
/** Gets a specific instance's color multiplier. */
get_instance_color(instance: int64): Color
/** Sets custom data for a specific instance. [param custom_data] is a [Color] type only to contain 4 floating-point numbers.
*
* **Note:** Each number is stored in 32 bits in the Forward+ and Mobile rendering methods, but is packed into 16 bits in the Compatibility rendering method.
* For the custom data to be used, ensure that [member use_custom_data] is `true`.
* This custom instance data has to be manually accessed in your custom shader using `INSTANCE_CUSTOM`.
*/
set_instance_custom_data(instance: int64, custom_data: Color): void
/** Returns the custom data that has been set for a specific instance. */
get_instance_custom_data(instance: int64): Color
/** When using *physics interpolation* , this function allows you to prevent interpolation on an instance in the current physics tick.
* This allows you to move instances instantaneously, and should usually be used when initially placing an instance such as a bullet to prevent graphical glitches.
*/
reset_instance_physics_interpolation(instance: int64): void
/** Returns the visibility axis-aligned bounding box in local space. */
get_aabb(): AABB
/** An alternative to setting the [member buffer] property, which can be used with *physics interpolation* . This method takes two arrays, and can set the data for the current and previous tick in one go. The renderer will automatically interpolate the data at each frame.
* This is useful for situations where the order of instances may change from physics tick to tick, such as particle systems.
* When the order of instances is coherent, the simpler alternative of setting [member buffer] can still be used with interpolation.
*/
set_buffer_interpolated(buffer_curr: PackedFloat32Array | float32[], buffer_prev: PackedFloat32Array | float32[]): void
/** Format of transform used to transform mesh, either 2D or 3D. */
get transform_format(): int64
set transform_format(value: int64)
/** If `true`, the [MultiMesh] will use color data (see [method set_instance_color]). Can only be set when [member instance_count] is `0` or less. This means that you need to call this method before setting the instance count, or temporarily reset it to `0`. */
get use_colors(): boolean
set use_colors(value: boolean)
/** If `true`, the [MultiMesh] will use custom data (see [method set_instance_custom_data]). Can only be set when [member instance_count] is `0` or less. This means that you need to call this method before setting the instance count, or temporarily reset it to `0`. */
get use_custom_data(): boolean
set use_custom_data(value: boolean)
/** Custom AABB for this MultiMesh resource. Setting this manually prevents costly runtime AABB recalculations. */
get custom_aabb(): AABB
set custom_aabb(value: AABB)
/** Number of instances that will get drawn. This clears and (re)sizes the buffers. Setting data format or flags afterwards will have no effect.
* By default, all instances are drawn but you can limit this with [member visible_instance_count].
*/
get instance_count(): int64
set instance_count(value: int64)
/** Limits the number of instances drawn, -1 draws all instances. Changing this does not change the sizes of the buffers. */
get visible_instance_count(): int64
set visible_instance_count(value: int64)
/** [Mesh] resource to be instanced.
* The looks of the individual instances can be modified using [method set_instance_color] and [method set_instance_custom_data].
*/
get mesh(): null | Mesh
set mesh(value: null | Mesh)
get buffer(): PackedFloat32Array
set buffer(value: PackedFloat32Array | float32[])
/** Array containing each [Transform3D] value used by all instances of this mesh, as a [PackedVector3Array]. Each transform is divided into 4 [Vector3] values corresponding to the transforms' `x`, `y`, `z`, and `origin`. */
get transform_array(): PackedVector3Array
set transform_array(value: PackedVector3Array | Vector3[])
/** Array containing each [Transform2D] value used by all instances of this mesh, as a [PackedVector2Array]. Each transform is divided into 3 [Vector2] values corresponding to the transforms' `x`, `y`, and `origin`. */
get transform_2d_array(): PackedVector2Array
set transform_2d_array(value: PackedVector2Array | Vector2[])
/** Array containing each [Color] used by all instances of this mesh. */
get color_array(): PackedColorArray
set color_array(value: PackedColorArray | Color[])
/** Array containing each custom data value used by all instances of this mesh, as a [PackedColorArray]. */
get custom_data_array(): PackedColorArray
set custom_data_array(value: PackedColorArray | Color[])
/** Choose whether to use an interpolation method that favors speed or quality.
* When using low physics tick rates (typically below 20) or high rates of object rotation, you may get better results from the high quality setting.
*
* **Note:** Fast quality does not equate to low quality. Except in the special cases mentioned above, the quality should be comparable to high quality.
*/
get physics_interpolation_quality(): int64
set physics_interpolation_quality(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiMesh;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiMeshInstance2D extends __NameMapNode2D {
}
/** Node that instances a [MultiMesh] in 2D.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multimeshinstance2d.html
*/
class MultiMeshInstance2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** The [MultiMesh] that will be drawn by the [MultiMeshInstance2D]. */
get multimesh(): null | MultiMesh
set multimesh(value: null | MultiMesh)
/** The [Texture2D] that will be used if using the default [CanvasItemMaterial]. Can be accessed as `TEXTURE` in CanvasItem shader. */
get texture(): null | Texture2D
set texture(value: null | Texture2D)
/** Emitted when the [member texture] is changed. */
readonly texture_changed: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiMeshInstance2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiMeshInstance3D extends __NameMapGeometryInstance3D {
}
/** Node that instances a [MultiMesh].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multimeshinstance3d.html
*/
class MultiMeshInstance3D<Map extends NodePathMap = any> extends GeometryInstance3D<Map> {
constructor(identifier?: any)
/** The [MultiMesh] resource that will be used and shared among all instances of the [MultiMeshInstance3D]. */
get multimesh(): null | MultiMesh
set multimesh(value: null | MultiMesh)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiMeshInstance3D;
}
namespace MultiplayerAPI {
enum RPCMode {
/** Used with [method Node.rpc_config] to disable a method or property for all RPC calls, making it unavailable. Default for all methods. */
RPC_MODE_DISABLED = 0,
/** Used with [method Node.rpc_config] to set a method to be callable remotely by any peer. Analogous to the `@rpc("any_peer")` annotation. Calls are accepted from all remote peers, no matter if they are node's authority or not. */
RPC_MODE_ANY_PEER = 1,
/** Used with [method Node.rpc_config] to set a method to be callable remotely only by the current multiplayer authority (which is the server by default). Analogous to the `@rpc("authority")` annotation. See [method Node.set_multiplayer_authority]. */
RPC_MODE_AUTHORITY = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiplayerAPI extends __NameMapRefCounted {
}
/** High-level multiplayer API interface.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multiplayerapi.html
*/
class MultiplayerAPI extends RefCounted {
constructor(identifier?: any)
/** Returns `true` if there is a [member multiplayer_peer] set. */
has_multiplayer_peer(): boolean
/** Returns the unique peer ID of this MultiplayerAPI's [member multiplayer_peer]. */
get_unique_id(): int64
/** Returns `true` if this MultiplayerAPI's [member multiplayer_peer] is valid and in server mode (listening for connections). */
is_server(): boolean
/** Returns the sender's peer ID for the RPC currently being executed.
*
* **Note:** This method returns `0` when called outside of an RPC. As such, the original peer ID may be lost when code execution is delayed (such as with GDScript's `await` keyword).
*/
get_remote_sender_id(): int64
/** Method used for polling the MultiplayerAPI. You only need to worry about this if you set [member SceneTree.multiplayer_poll] to `false`. By default, [SceneTree] will poll its MultiplayerAPI(s) for you.
*
* **Note:** This method results in RPCs being called, so they will be executed in the same context of this function (e.g. `_process`, `physics`, [Thread]).
*/
poll(): Error
/** Sends an RPC to the target [param peer]. The given [param method] will be called on the remote [param object] with the provided [param arguments]. The RPC may also be called locally depending on the implementation and RPC configuration. See [method Node.rpc] and [method Node.rpc_config].
*
* **Note:** Prefer using [method Node.rpc], [method Node.rpc_id], or `my_method.rpc(peer, arg1, arg2, ...)` (in GDScript), since they are faster. This method is mostly useful in conjunction with [MultiplayerAPIExtension] when extending or replacing the multiplayer capabilities.
*/
rpc(peer: int64, object: Object, method: StringName, arguments_?: GArray /* = [] */): Error
/** Notifies the MultiplayerAPI of a new [param configuration] for the given [param object]. This method is used internally by [SceneTree] to configure the root path for this MultiplayerAPI (passing `null` and a valid [NodePath] as [param configuration]). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. [SceneMultiplayer]) for details on how they use it.
*
* **Note:** This method is mostly relevant when extending or overriding the MultiplayerAPI behavior via [MultiplayerAPIExtension].
*/
object_configuration_add(object: Object, configuration: any): Error
/** Notifies the MultiplayerAPI to remove a [param configuration] for the given [param object]. This method is used internally by [SceneTree] to configure the root path for this MultiplayerAPI (passing `null` and an empty [NodePath] as [param configuration]). This method can be further used by MultiplayerAPI implementations to provide additional features, refer to specific implementation (e.g. [SceneMultiplayer]) for details on how they use it.
*
* **Note:** This method is mostly relevant when extending or overriding the MultiplayerAPI behavior via [MultiplayerAPIExtension].
*/
object_configuration_remove(object: Object, configuration: any): Error
/** Returns the peer IDs of all connected peers of this MultiplayerAPI's [member multiplayer_peer]. */
get_peers(): PackedInt32Array
/** Sets the default MultiplayerAPI implementation class. This method can be used by modules and extensions to configure which implementation will be used by [SceneTree] when the engine starts. */
static set_default_interface(interface_name: StringName): void
/** Returns the default MultiplayerAPI implementation class name. This is usually `"SceneMultiplayer"` when [SceneMultiplayer] is available. See [method set_default_interface]. */
static get_default_interface(): StringName
/** Returns a new instance of the default MultiplayerAPI. */
static create_default_interface(): MultiplayerAPI
/** The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the MultiplayerAPI will become a network server (check with [method is_server]) and will set root node's network mode to authority, or it will become a regular client peer. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to MultiplayerAPI's signals. */
get multiplayer_peer(): null | MultiplayerPeer
set multiplayer_peer(value: null | MultiplayerPeer)
/** Emitted when this MultiplayerAPI's [member multiplayer_peer] connects with a new peer. ID is the peer ID of the new peer. Clients get notified when other clients connect to the same server. Upon connecting to a server, a client also receives this signal for the server (with ID being 1). */
readonly peer_connected: Signal<(id: int64) => void>
/** Emitted when this MultiplayerAPI's [member multiplayer_peer] disconnects from a peer. Clients get notified when other clients disconnect from the same server. */
readonly peer_disconnected: Signal<(id: int64) => void>
/** Emitted when this MultiplayerAPI's [member multiplayer_peer] successfully connected to a server. Only emitted on clients. */
readonly connected_to_server: Signal<() => void>
/** Emitted when this MultiplayerAPI's [member multiplayer_peer] fails to establish a connection to a server. Only emitted on clients. */
readonly connection_failed: Signal<() => void>
/** Emitted when this MultiplayerAPI's [member multiplayer_peer] disconnects from server. Only emitted on clients. */
readonly server_disconnected: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiplayerAPI;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiplayerAPIExtension extends __NameMapMultiplayerAPI {
}
/** Base class used for extending the [MultiplayerAPI].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multiplayerapiextension.html
*/
class MultiplayerAPIExtension extends MultiplayerAPI {
constructor(identifier?: any)
/** Callback for [method MultiplayerAPI.poll]. */
/* gdvirtual */ _poll(): Error
/** Called when the [member MultiplayerAPI.multiplayer_peer] is set. */
/* gdvirtual */ _set_multiplayer_peer(multiplayer_peer: MultiplayerPeer): void
/** Called when the [member MultiplayerAPI.multiplayer_peer] is retrieved. */
/* gdvirtual */ _get_multiplayer_peer(): null | MultiplayerPeer
/** Callback for [method MultiplayerAPI.get_unique_id]. */
/* gdvirtual */ _get_unique_id(): int64
/** Callback for [method MultiplayerAPI.get_peers]. */
/* gdvirtual */ _get_peer_ids(): PackedInt32Array
/** Callback for [method MultiplayerAPI.rpc]. */
/* gdvirtual */ _rpc(peer: int64, object: Object, method: StringName, args: GArray): Error
/** Callback for [method MultiplayerAPI.get_remote_sender_id]. */
/* gdvirtual */ _get_remote_sender_id(): int64
/** Callback for [method MultiplayerAPI.object_configuration_add]. */
/* gdvirtual */ _object_configuration_add(object: Object, configuration: any): Error
/** Callback for [method MultiplayerAPI.object_configuration_remove]. */
/* gdvirtual */ _object_configuration_remove(object: Object, configuration: any): Error
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiplayerAPIExtension;
}
namespace MultiplayerPeer {
enum ConnectionStatus {
/** The MultiplayerPeer is disconnected. */
CONNECTION_DISCONNECTED = 0,
/** The MultiplayerPeer is currently connecting to a server. */
CONNECTION_CONNECTING = 1,
/** This MultiplayerPeer is connected. */
CONNECTION_CONNECTED = 2,
}
enum TransferMode {
/** Packets are not acknowledged, no resend attempts are made for lost packets. Packets may arrive in any order. Potentially faster than [constant TRANSFER_MODE_UNRELIABLE_ORDERED]. Use for non-critical data, and always consider whether the order matters. */
TRANSFER_MODE_UNRELIABLE = 0,
/** Packets are not acknowledged, no resend attempts are made for lost packets. Packets are received in the order they were sent in. Potentially faster than [constant TRANSFER_MODE_RELIABLE]. Use for non-critical data or data that would be outdated if received late due to resend attempt(s) anyway, for example movement and positional data. */
TRANSFER_MODE_UNRELIABLE_ORDERED = 1,
/** Packets must be received and resend attempts should be made until the packets are acknowledged. Packets must be received in the order they were sent in. Most reliable transfer mode, but potentially the slowest due to the overhead. Use for critical data that must be transmitted and arrive in order, for example an ability being triggered or a chat message. Consider carefully if the information really is critical, and use sparingly. */
TRANSFER_MODE_RELIABLE = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiplayerPeer extends __NameMapPacketPeer {
}
/** Abstract class for specialized [PacketPeer]s used by the [MultiplayerAPI].
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multiplayerpeer.html
*/
class MultiplayerPeer extends PacketPeer {
/** Packets are sent to all connected peers. */
static readonly TARGET_PEER_BROADCAST = 0
/** Packets are sent to the remote peer acting as server. */
static readonly TARGET_PEER_SERVER = 1
constructor(identifier?: any)
/** Sets the peer to which packets will be sent.
* The [param id] can be one of: [constant TARGET_PEER_BROADCAST] to send to all connected peers, [constant TARGET_PEER_SERVER] to send to the peer acting as server, a valid peer ID to send to that specific peer, a negative peer ID to send to all peers except that one. By default, the target peer is [constant TARGET_PEER_BROADCAST].
*/
set_target_peer(id: int64): void
/** Returns the ID of the [MultiplayerPeer] who sent the next available packet. See [method PacketPeer.get_available_packet_count]. */
get_packet_peer(): int64
/** Returns the channel over which the next available packet was received. See [method PacketPeer.get_available_packet_count]. */
get_packet_channel(): int64
/** Returns the transfer mode the remote peer used to send the next available packet. See [method PacketPeer.get_available_packet_count]. */
get_packet_mode(): MultiplayerPeer.TransferMode
/** Waits up to 1 second to receive a new network event. */
poll(): void
/** Immediately close the multiplayer peer returning to the state [constant CONNECTION_DISCONNECTED]. Connected peers will be dropped without emitting [signal peer_disconnected]. */
close(): void
/** Disconnects the given [param peer] from this host. If [param force] is `true` the [signal peer_disconnected] signal will not be emitted for this peer. */
disconnect_peer(peer: int64, force?: boolean /* = false */): void
/** Returns the current state of the connection. */
get_connection_status(): MultiplayerPeer.ConnectionStatus
/** Returns the ID of this [MultiplayerPeer]. */
get_unique_id(): int64
/** Returns a randomly generated integer that can be used as a network unique ID. */
generate_unique_id(): int64
/** Returns `true` if the server can act as a relay in the current configuration. That is, if the higher level [MultiplayerAPI] should notify connected clients of other peers, and implement a relay protocol to allow communication between them. */
is_server_relay_supported(): boolean
/** If `true`, this [MultiplayerPeer] refuses new connections. */
get refuse_new_connections(): boolean
set refuse_new_connections(value: boolean)
/** The manner in which to send packets to the target peer. See the [method set_target_peer] method. */
get transfer_mode(): int64
set transfer_mode(value: int64)
/** The channel to use to send packets. Many network APIs such as ENet and WebRTC allow the creation of multiple independent channels which behaves, in a way, like separate connections. This means that reliable data will only block delivery of other packets on that channel, and ordering will only be in respect to the channel the packet is being sent on. Using different channels to send **different and independent** state updates is a common way to optimize network usage and decrease latency in fast-paced games.
*
* **Note:** The default channel (`0`) actually works as 3 separate channels (one for each [enum TransferMode]) so that [constant TRANSFER_MODE_RELIABLE] and [constant TRANSFER_MODE_UNRELIABLE_ORDERED] does not interact with each other by default. Refer to the specific network API documentation (e.g. ENet or WebRTC) to learn how to set up channels correctly.
*/
get transfer_channel(): int64
set transfer_channel(value: int64)
/** Emitted when a remote peer connects. */
readonly peer_connected: Signal<(id: int64) => void>
/** Emitted when a remote peer has disconnected. */
readonly peer_disconnected: Signal<(id: int64) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiplayerPeer;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiplayerPeerExtension extends __NameMapMultiplayerPeer {
}
/** Class that can be inherited to implement custom multiplayer API networking layers via GDExtension.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multiplayerpeerextension.html
*/
class MultiplayerPeerExtension extends MultiplayerPeer {
constructor(identifier?: any)
/** Called when a packet needs to be received by the [MultiplayerAPI], with [param r_buffer_size] being the size of the binary [param r_buffer] in bytes. */
/* gdvirtual */ _get_packet(r_buffer: int64, r_buffer_size: int64): Error
/** Called when a packet needs to be sent by the [MultiplayerAPI], with [param p_buffer_size] being the size of the binary [param p_buffer] in bytes. */
/* gdvirtual */ _put_packet(p_buffer: int64, p_buffer_size: int64): Error
/** Called when the available packet count is internally requested by the [MultiplayerAPI]. */
/* gdvirtual */ _get_available_packet_count(): int64
/** Called when the maximum allowed packet size (in bytes) is requested by the [MultiplayerAPI]. */
/* gdvirtual */ _get_max_packet_size(): int64
/** Called when a packet needs to be received by the [MultiplayerAPI], if [method _get_packet] isn't implemented. Use this when extending this class via GDScript. */
/* gdvirtual */ _get_packet_script(): PackedByteArray
/** Called when a packet needs to be sent by the [MultiplayerAPI], if [method _put_packet] isn't implemented. Use this when extending this class via GDScript. */
/* gdvirtual */ _put_packet_script(p_buffer: PackedByteArray | byte[] | ArrayBuffer): Error
/** Called to get the channel over which the next available packet was received. See [method MultiplayerPeer.get_packet_channel]. */
/* gdvirtual */ _get_packet_channel(): int64
/** Called to get the transfer mode the remote peer used to send the next available packet. See [method MultiplayerPeer.get_packet_mode]. */
/* gdvirtual */ _get_packet_mode(): MultiplayerPeer.TransferMode
/** Called when the channel to use is set for this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]). */
/* gdvirtual */ _set_transfer_channel(p_channel: int64): void
/** Called when the transfer channel to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_channel]). */
/* gdvirtual */ _get_transfer_channel(): int64
/** Called when the transfer mode is set on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]). */
/* gdvirtual */ _set_transfer_mode(p_mode: MultiplayerPeer.TransferMode): void
/** Called when the transfer mode to use is read on this [MultiplayerPeer] (see [member MultiplayerPeer.transfer_mode]). */
/* gdvirtual */ _get_transfer_mode(): MultiplayerPeer.TransferMode
/** Called when the target peer to use is set for this [MultiplayerPeer] (see [method MultiplayerPeer.set_target_peer]). */
/* gdvirtual */ _set_target_peer(p_peer: int64): void
/** Called when the ID of the [MultiplayerPeer] who sent the most recent packet is requested (see [method MultiplayerPeer.get_packet_peer]). */
/* gdvirtual */ _get_packet_peer(): int64
/** Called when the "is server" status is requested on the [MultiplayerAPI]. See [method MultiplayerAPI.is_server]. */
/* gdvirtual */ _is_server(): boolean
/** Called when the [MultiplayerAPI] is polled. See [method MultiplayerAPI.poll]. */
/* gdvirtual */ _poll(): void
/** Called when the multiplayer peer should be immediately closed (see [method MultiplayerPeer.close]). */
/* gdvirtual */ _close(): void
/** Called when the connected [param p_peer] should be forcibly disconnected (see [method MultiplayerPeer.disconnect_peer]). */
/* gdvirtual */ _disconnect_peer(p_peer: int64, p_force: boolean): void
/** Called when the unique ID of this [MultiplayerPeer] is requested (see [method MultiplayerPeer.get_unique_id]). The value must be between `1` and `2147483647`. */
/* gdvirtual */ _get_unique_id(): int64
/** Called when the "refuse new connections" status is set on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]). */
/* gdvirtual */ _set_refuse_new_connections(p_enable: boolean): void
/** Called when the "refuse new connections" status is requested on this [MultiplayerPeer] (see [member MultiplayerPeer.refuse_new_connections]). */
/* gdvirtual */ _is_refusing_new_connections(): boolean
/** Called to check if the server can act as a relay in the current configuration. See [method MultiplayerPeer.is_server_relay_supported]. */
/* gdvirtual */ _is_server_relay_supported(): boolean
/** Called when the connection status is requested on the [MultiplayerPeer] (see [method MultiplayerPeer.get_connection_status]). */
/* gdvirtual */ _get_connection_status(): MultiplayerPeer.ConnectionStatus
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiplayerPeerExtension;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiplayerSpawner extends __NameMapNode {
}
/** Automatically replicates spawnable nodes from the authority to other multiplayer peers.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multiplayerspawner.html
*/
class MultiplayerSpawner<Map extends NodePathMap = any> extends Node<Map> {
constructor(identifier?: any)
/** Adds a scene path to spawnable scenes, making it automatically replicated from the multiplayer authority to other peers when added as children of the node pointed by [member spawn_path]. */
add_spawnable_scene(path: string): void
/** Returns the count of spawnable scene paths. */
get_spawnable_scene_count(): int64
/** Returns the spawnable scene path by index. */
get_spawnable_scene(index: int64): string
/** Clears all spawnable scenes. Does not despawn existing instances on remote peers. */
clear_spawnable_scenes(): void
/** Requests a custom spawn, with [param data] passed to [member spawn_function] on all peers. Returns the locally spawned node instance already inside the scene tree, and added as a child of the node pointed by [member spawn_path].
*
* **Note:** Spawnable scenes are spawned automatically. [method spawn] is only needed for custom spawns.
*/
spawn(data?: any /* = <any> {} */): null | Node
get _spawnable_scenes(): PackedStringArray
set _spawnable_scenes(value: PackedStringArray | string[])
/** Path to the spawn root. Spawnable scenes that are added as direct children are replicated to other peers. */
get spawn_path(): NodePath
set spawn_path(value: NodePath | string)
/** Maximum number of nodes allowed to be spawned by this spawner. Includes both spawnable scenes and custom spawns.
* When set to `0` (the default), there is no limit.
*/
get spawn_limit(): int64
set spawn_limit(value: int64)
/** Method called on all peers when a custom [method spawn] is requested by the authority. Will receive the `data` parameter, and should return a [Node] that is not in the scene tree.
*
* **Note:** The returned node should **not** be added to the scene with [method Node.add_child]. This is done automatically.
*/
get spawn_function(): Callable
set spawn_function(value: Callable)
/** Emitted when a spawnable scene or custom spawn was despawned by the multiplayer authority. Only called on remote peers. */
readonly despawned: Signal<(node: Node) => void>
/** Emitted when a spawnable scene or custom spawn was spawned by the multiplayer authority. Only called on remote peers. */
readonly spawned: Signal<(node: Node) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiplayerSpawner;
}
namespace MultiplayerSynchronizer {
enum VisibilityUpdateMode {
/** Visibility filters are updated during process frames (see [constant Node.NOTIFICATION_INTERNAL_PROCESS]). */
VISIBILITY_PROCESS_IDLE = 0,
/** Visibility filters are updated during physics frames (see [constant Node.NOTIFICATION_INTERNAL_PHYSICS_PROCESS]). */
VISIBILITY_PROCESS_PHYSICS = 1,
/** Visibility filters are not updated automatically, and must be updated manually by calling [method update_visibility]. */
VISIBILITY_PROCESS_NONE = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMultiplayerSynchronizer extends __NameMapNode {
}
/** Synchronizes properties from the multiplayer authority to the remote peers.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_multiplayersynchronizer.html
*/
class MultiplayerSynchronizer<Map extends NodePathMap = any> extends Node<Map> {
constructor(identifier?: any)
/** Updates the visibility of [param for_peer] according to visibility filters. If [param for_peer] is `0` (the default), all peers' visibilties are updated. */
update_visibility(for_peer?: int64 /* = 0 */): void
/** Adds a peer visibility filter for this synchronizer.
* [param filter] should take a peer ID [int] and return a [bool].
*/
add_visibility_filter(filter: Callable): void
/** Removes a peer visibility filter from this synchronizer. */
remove_visibility_filter(filter: Callable): void
/** Sets the visibility of [param peer] to [param visible]. If [param peer] is `0`, the value of [member public_visibility] will be updated instead. */
set_visibility_for(peer: int64, visible: boolean): void
/** Queries the current visibility for peer [param peer]. */
get_visibility_for(peer: int64): boolean
/** Node path that replicated properties are relative to.
* If [member root_path] was spawned by a [MultiplayerSpawner], the node will be also be spawned and despawned based on this synchronizer visibility options.
*/
get root_path(): NodePath
set root_path(value: NodePath | string)
/** Time interval between synchronizations. Used when the replication is set to [constant SceneReplicationConfig.REPLICATION_MODE_ALWAYS]. If set to `0.0` (the default), synchronizations happen every network process frame. */
get replication_interval(): float64
set replication_interval(value: float64)
/** Time interval between delta synchronizations. Used when the replication is set to [constant SceneReplicationConfig.REPLICATION_MODE_ON_CHANGE]. If set to `0.0` (the default), delta synchronizations happen every network process frame. */
get delta_interval(): float64
set delta_interval(value: float64)
/** Resource containing which properties to synchronize. */
get replication_config(): null | SceneReplicationConfig
set replication_config(value: null | SceneReplicationConfig)
/** Specifies when visibility filters are updated. */
get visibility_update_mode(): int64
set visibility_update_mode(value: int64)
/** Whether synchronization should be visible to all peers by default. See [method set_visibility_for] and [method add_visibility_filter] for ways of configuring fine-grained visibility options. */
get public_visibility(): boolean
set public_visibility(value: boolean)
/** Emitted when a new synchronization state is received by this synchronizer after the properties have been updated. */
readonly synchronized: Signal<() => void>
/** Emitted when a new delta synchronization state is received by this synchronizer after the properties have been updated. */
readonly delta_synchronized: Signal<() => void>
/** Emitted when visibility of [param for_peer] is updated. See [method update_visibility]. */
readonly visibility_changed: Signal<(for_peer: int64) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMultiplayerSynchronizer;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapMutex extends __NameMapRefCounted {
}
/** A binary [Semaphore] for synchronization of multiple [Thread]s.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_mutex.html
*/
class Mutex extends RefCounted {
constructor(identifier?: any)
/** Locks this [Mutex], blocks until it is unlocked by the current owner.
*
* **Note:** This function returns without blocking if the thread already has ownership of the mutex.
*/
lock(): void
/** Tries locking this [Mutex], but does not block. Returns `true` on success, `false` otherwise.
*
* **Note:** This function returns `true` if the thread already has ownership of the mutex.
*/
try_lock(): boolean
/** Unlocks this [Mutex], leaving it to other threads.
*
* **Note:** If a thread called [method lock] or [method try_lock] multiple times while already having ownership of the mutex, it must also call [method unlock] the same number of times in order to unlock it correctly.
* **Warning:** Calling [method unlock] more times that [method lock] on a given thread, thus ending up trying to unlock a non-locked mutex, is wrong and may causes crashes or deadlocks.
*/
unlock(): void
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapMutex;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationAgent2D extends __NameMapNode {
}
/** A 2D agent used to pathfind to a position while avoiding obstacles.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationagent2d.html
*/
class NavigationAgent2D<Map extends NodePathMap = any> extends Node<Map> {
constructor(identifier?: any)
/** Returns the [RID] of this agent on the [NavigationServer2D]. */
get_rid(): RID
/** Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_navigation_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_navigation_layer_value(layer_number: int64): boolean
/** Sets the [RID] of the navigation map this NavigationAgent node should use and also updates the `agent` on the NavigationServer. */
set_navigation_map(navigation_map: RID): void
/** Returns the [RID] of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use [method set_navigation_map] to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer. */
get_navigation_map(): RID
/** Returns the length of the currently calculated path. The returned value is `0.0`, if the path is still calculating or no calculation has been requested yet. */
get_path_length(): float64
/** Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent. */
get_next_path_position(): Vector2
/** Replaces the internal velocity in the collision avoidance simulation with [param velocity]. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. */
set_velocity_forced(velocity: Vector2): void
/** Returns the distance to the target position, using the agent's global position. The user must set [member target_position] in order for this to be accurate. */
distance_to_target(): float64
/** Returns the path query result for the path the agent is currently following. */
get_current_navigation_result(): null | NavigationPathQueryResult2D
/** Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended [method get_next_path_position] once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. */
get_current_navigation_path(): PackedVector2Array
/** Returns which index the agent is currently on in the navigation path's [PackedVector2Array]. */
get_current_navigation_path_index(): int64
/** Returns `true` if the agent reached the target, i.e. the agent moved within [member target_desired_distance] of the [member target_position]. It may not always be possible to reach the target but it should always be possible to reach the final position. See [method get_final_position]. */
is_target_reached(): boolean
/** Returns `true` if [method get_final_position] is within [member target_desired_distance] of the [member target_position]. */
is_target_reachable(): boolean
/** Returns `true` if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached.
*
* **Note:** While `true` prefer to stop calling update functions like [method get_next_path_position]. This avoids jittering the standing agent due to calling repeated path updates.
*/
is_navigation_finished(): boolean
/** Returns the reachable final position of the current navigation path in global coordinates. This position can change if the agent needs to update the navigation path which makes the agent emit the [signal path_changed] signal. */
get_final_position(): Vector2
_avoidance_done(new_velocity: Vector2): void
/** Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_avoidance_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_avoidance_layer_value(layer_number: int64): boolean
/** Based on [param value], enables or disables the specified mask in the [member avoidance_mask] bitmask, given a [param mask_number] between 1 and 32. */
set_avoidance_mask_value(mask_number: int64, value: boolean): void
/** Returns whether or not the specified mask of the [member avoidance_mask] bitmask is enabled, given a [param mask_number] between 1 and 32. */
get_avoidance_mask_value(mask_number: int64): boolean
/** If set, a new navigation path from the current agent position to the [member target_position] is requested from the NavigationServer. */
get target_position(): Vector2
set target_position(value: Vector2)
/** The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to it leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot the distance to the next point on each physics frame update. */
get path_desired_distance(): float64
set path_desired_distance(value: float64)
/** The distance threshold before the target is considered to be reached. On reaching the target, [signal target_reached] is emitted and navigation ends (see [method is_navigation_finished] and [signal navigation_finished]).
* You can make navigation end early by setting this property to a value greater than [member path_desired_distance] (navigation will end before reaching the last waypoint).
* You can also make navigation end closer to the target than each individual path position by setting this property to a value lower than [member path_desired_distance] (navigation won't immediately end when reaching the last waypoint). However, if the value set is too low, the agent will be stuck in a repath loop because it will constantly overshoot the distance to the target on each physics frame update.
*/
get target_desired_distance(): float64
set target_desired_distance(value: float64)
/** The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path. */
get path_max_distance(): float64
set path_max_distance(value: float64)
/** A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers. */
get navigation_layers(): int64
set navigation_layers(value: int64)
/** The pathfinding algorithm used in the path query. */
get pathfinding_algorithm(): int64
set pathfinding_algorithm(value: int64)
/** The path postprocessing applied to the raw path corridor found by the [member pathfinding_algorithm]. */
get path_postprocessing(): int64
set path_postprocessing(value: int64)
/** Additional information to return with the navigation path. */
get path_metadata_flags(): int64
set path_metadata_flags(value: int64)
/** If `true` a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by [member simplify_epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.
* Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".
*/
get simplify_path(): boolean
set simplify_path(value: boolean)
/** The path simplification amount in worlds units. */
get simplify_epsilon(): float64
set simplify_epsilon(value: float64)
/** The maximum allowed length of the returned path in world units. A path will be clipped when going over this length. */
get path_return_max_length(): float64
set path_return_max_length(value: float64)
/** The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. Compared to [member path_return_max_length], this allows the agent to go that much further, if they need to walk around a corner.
*
* **Note:** This will perform a sphere clip considering only the actual navigation mesh path points with the first path position being the sphere's center.
*/
get path_return_max_radius(): float64
set path_return_max_radius(value: float64)
/** The maximum number of polygons that are searched before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted. */
get path_search_max_polygons(): int64
set path_search_max_polygons(value: int64)
/** The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted. */
get path_search_max_distance(): float64
set path_search_max_distance(value: float64)
/** If `true` the agent is registered for an RVO avoidance callback on the [NavigationServer2D]. When [member velocity] is used and the processing is completed a `safe_velocity` Vector2 is received with a signal connection to [signal velocity_computed]. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it. */
get avoidance_enabled(): boolean
set avoidance_enabled(value: boolean)
/** Sets the new wanted velocity for the agent. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agents and obstacles. When an agent is teleported to a new position, use [method set_velocity_forced] as well to reset the internal simulation velocity. */
get velocity(): Vector2
set velocity(value: Vector2)
/** The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by [member neighbor_distance]).
* Does not affect normal pathfinding. To change an actor's pathfinding radius bake [NavigationPolygon] resources with a different [member NavigationPolygon.agent_radius] property and use different navigation maps for each actor size.
*/
get radius(): float64
set radius(value: float64)
/** The distance to search for other agents. */
get neighbor_distance(): float64
set neighbor_distance(value: float64)
/** The maximum number of neighbors for the agent to consider. */
get max_neighbors(): int64
set max_neighbors(value: int64)
/** The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. */
get time_horizon_agents(): float64
set time_horizon_agents(value: float64)
/** The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to static avoidance obstacles. The larger the number, the sooner the agent will respond to static avoidance obstacles, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. */
get time_horizon_obstacles(): float64
set time_horizon_obstacles(value: float64)
/** The maximum speed that an agent can move. */
get max_speed(): float64
set max_speed(value: float64)
/** A bitfield determining the avoidance layers for this NavigationAgent. Other agents with a matching bit on the [member avoidance_mask] will avoid this agent. */
get avoidance_layers(): int64
set avoidance_layers(value: int64)
/** A bitfield determining what other avoidance agents and obstacles this NavigationAgent will avoid when a bit matches at least one of their [member avoidance_layers]. */
get avoidance_mask(): int64
set avoidance_mask(value: int64)
/** The agent does not adjust the velocity for other agents that would match the [member avoidance_mask] but have a lower [member avoidance_priority]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. */
get avoidance_priority(): float64
set avoidance_priority(value: float64)
/** If `true` shows debug visuals for this agent. */
get debug_enabled(): boolean
set debug_enabled(value: boolean)
/** If `true` uses the defined [member debug_path_custom_color] for this agent instead of global color. */
get debug_use_custom(): boolean
set debug_use_custom(value: boolean)
/** If [member debug_use_custom] is `true` uses this color for this agent instead of global color. */
get debug_path_custom_color(): Color
set debug_path_custom_color(value: Color)
/** If [member debug_use_custom] is `true` uses this rasterized point size for rendering path points for this agent instead of global point size. */
get debug_path_custom_point_size(): float64
set debug_path_custom_point_size(value: float64)
/** If [member debug_use_custom] is `true` uses this line width for rendering paths for this agent instead of global line width. */
get debug_path_custom_line_width(): float64
set debug_path_custom_line_width(value: float64)
/** Emitted when the agent had to update the loaded path:
* - because path was previously empty.
* - because navigation map has changed.
* - because agent pushed further away from the current path segment than the [member path_max_distance].
*/
readonly path_changed: Signal<() => void>
/** Signals that the agent reached the target, i.e. the agent moved within [member target_desired_distance] of the [member target_position]. This signal is emitted only once per loaded path.
* This signal will be emitted just before [signal navigation_finished] when the target is reachable.
* It may not always be possible to reach the target but it should always be possible to reach the final position. See [method get_final_position].
*/
readonly target_reached: Signal<() => void>
/** Signals that the agent reached a waypoint. Emitted when the agent moves within [member path_desired_distance] of the next position of the path.
* The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
* - `position`: The position of the waypoint that was reached.
* - `type`: The type of navigation primitive (region or link) that contains this waypoint.
* - `rid`: The [RID] of the containing navigation primitive (region or link).
* - `owner`: The object which manages the containing navigation primitive (region or link).
*/
readonly waypoint_reached: Signal<(details: GDictionary) => void>
/** Signals that the agent reached a navigation link. Emitted when the agent moves within [member path_desired_distance] of the next position of the path when that position is a navigation link.
* The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
* - `position`: The start position of the link that was reached.
* - `type`: Always [constant NavigationPathQueryResult2D.PATH_SEGMENT_TYPE_LINK].
* - `rid`: The [RID] of the link.
* - `owner`: The object which manages the link (usually [NavigationLink2D]).
* - `link_entry_position`: If `owner` is available and the owner is a [NavigationLink2D], it will contain the global position of the link's point the agent is entering.
* - `link_exit_position`: If `owner` is available and the owner is a [NavigationLink2D], it will contain the global position of the link's point which the agent is exiting.
*/
readonly link_reached: Signal<(details: GDictionary) => void>
/** Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path.
* This signal will be emitted just after [signal target_reached] when the target is reachable.
*/
readonly navigation_finished: Signal<() => void>
/** Notifies when the collision avoidance velocity is calculated. Emitted every update as long as [member avoidance_enabled] is `true` and the agent has a navigation map. */
readonly velocity_computed: Signal<(safe_velocity: Vector2) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationAgent2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationAgent3D extends __NameMapNode {
}
/** A 3D agent used to pathfind to a position while avoiding obstacles.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationagent3d.html
*/
class NavigationAgent3D<Map extends NodePathMap = any> extends Node<Map> {
constructor(identifier?: any)
/** Returns the [RID] of this agent on the [NavigationServer3D]. */
get_rid(): RID
/** Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_navigation_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_navigation_layer_value(layer_number: int64): boolean
/** Sets the [RID] of the navigation map this NavigationAgent node should use and also updates the `agent` on the NavigationServer. */
set_navigation_map(navigation_map: RID): void
/** Returns the [RID] of the navigation map for this NavigationAgent node. This function returns always the map set on the NavigationAgent node and not the map of the abstract agent on the NavigationServer. If the agent map is changed directly with the NavigationServer API the NavigationAgent node will not be aware of the map change. Use [method set_navigation_map] to change the navigation map for the NavigationAgent and also update the agent on the NavigationServer. */
get_navigation_map(): RID
/** Returns the length of the currently calculated path. The returned value is `0.0`, if the path is still calculating or no calculation has been requested yet. */
get_path_length(): float64
/** Returns the next position in global coordinates that can be moved to, making sure that there are no static objects in the way. If the agent does not have a navigation path, it will return the position of the agent's parent. The use of this function once every physics frame is required to update the internal path logic of the NavigationAgent. */
get_next_path_position(): Vector3
/** Replaces the internal velocity in the collision avoidance simulation with [param velocity]. When an agent is teleported to a new position this function should be used in the same frame. If called frequently this function can get agents stuck. */
set_velocity_forced(velocity: Vector3): void
/** Returns the distance to the target position, using the agent's global position. The user must set [member target_position] in order for this to be accurate. */
distance_to_target(): float64
/** Returns the path query result for the path the agent is currently following. */
get_current_navigation_result(): null | NavigationPathQueryResult3D
/** Returns this agent's current path from start to finish in global coordinates. The path only updates when the target position is changed or the agent requires a repath. The path array is not intended to be used in direct path movement as the agent has its own internal path logic that would get corrupted by changing the path array manually. Use the intended [method get_next_path_position] once every physics frame to receive the next path point for the agents movement as this function also updates the internal path logic. */
get_current_navigation_path(): PackedVector3Array
/** Returns which index the agent is currently on in the navigation path's [PackedVector3Array]. */
get_current_navigation_path_index(): int64
/** Returns `true` if the agent reached the target, i.e. the agent moved within [member target_desired_distance] of the [member target_position]. It may not always be possible to reach the target but it should always be possible to reach the final position. See [method get_final_position]. */
is_target_reached(): boolean
/** Returns `true` if [method get_final_position] is within [member target_desired_distance] of the [member target_position]. */
is_target_reachable(): boolean
/** Returns `true` if the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached.
*
* **Note:** While `true` prefer to stop calling update functions like [method get_next_path_position]. This avoids jittering the standing agent due to calling repeated path updates.
*/
is_navigation_finished(): boolean
/** Returns the reachable final position of the current navigation path in global coordinates. This position can change if the agent needs to update the navigation path which makes the agent emit the [signal path_changed] signal. */
get_final_position(): Vector3
_avoidance_done(new_velocity: Vector3): void
/** Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_avoidance_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_avoidance_layer_value(layer_number: int64): boolean
/** Based on [param value], enables or disables the specified mask in the [member avoidance_mask] bitmask, given a [param mask_number] between 1 and 32. */
set_avoidance_mask_value(mask_number: int64, value: boolean): void
/** Returns whether or not the specified mask of the [member avoidance_mask] bitmask is enabled, given a [param mask_number] between 1 and 32. */
get_avoidance_mask_value(mask_number: int64): boolean
/** If set, a new navigation path from the current agent position to the [member target_position] is requested from the NavigationServer. */
get target_position(): Vector3
set target_position(value: Vector3)
/** The distance threshold before a path point is considered to be reached. This allows agents to not have to hit a path point on the path exactly, but only to reach its general area. If this value is set too high, the NavigationAgent will skip points on the path, which can lead to it leaving the navigation mesh. If this value is set too low, the NavigationAgent will be stuck in a repath loop because it will constantly overshoot the distance to the next point on each physics frame update. */
get path_desired_distance(): float64
set path_desired_distance(value: float64)
/** The distance threshold before the target is considered to be reached. On reaching the target, [signal target_reached] is emitted and navigation ends (see [method is_navigation_finished] and [signal navigation_finished]).
* You can make navigation end early by setting this property to a value greater than [member path_desired_distance] (navigation will end before reaching the last waypoint).
* You can also make navigation end closer to the target than each individual path position by setting this property to a value lower than [member path_desired_distance] (navigation won't immediately end when reaching the last waypoint). However, if the value set is too low, the agent will be stuck in a repath loop because it will constantly overshoot the distance to the target on each physics frame update.
*/
get target_desired_distance(): float64
set target_desired_distance(value: float64)
/** The height offset is subtracted from the y-axis value of any vector path position for this NavigationAgent. The NavigationAgent height offset does not change or influence the navigation mesh or pathfinding query result. Additional navigation maps that use regions with navigation meshes that the developer baked with appropriate agent radius or height values are required to support different-sized agents. */
get path_height_offset(): float64
set path_height_offset(value: float64)
/** The maximum distance the agent is allowed away from the ideal path to the final position. This can happen due to trying to avoid collisions. When the maximum distance is exceeded, it recalculates the ideal path. */
get path_max_distance(): float64
set path_max_distance(value: float64)
/** A bitfield determining which navigation layers of navigation regions this agent will use to calculate a path. Changing it during runtime will clear the current navigation path and generate a new one, according to the new navigation layers. */
get navigation_layers(): int64
set navigation_layers(value: int64)
/** The pathfinding algorithm used in the path query. */
get pathfinding_algorithm(): int64
set pathfinding_algorithm(value: int64)
/** The path postprocessing applied to the raw path corridor found by the [member pathfinding_algorithm]. */
get path_postprocessing(): int64
set path_postprocessing(value: int64)
/** Additional information to return with the navigation path. */
get path_metadata_flags(): int64
set path_metadata_flags(value: int64)
/** If `true` a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by [member simplify_epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.
* Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".
*/
get simplify_path(): boolean
set simplify_path(value: boolean)
/** The path simplification amount in worlds units. */
get simplify_epsilon(): float64
set simplify_epsilon(value: float64)
/** The maximum allowed length of the returned path in world units. A path will be clipped when going over this length. */
get path_return_max_length(): float64
set path_return_max_length(value: float64)
/** The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. Compared to [member path_return_max_length], this allows the agent to go that much further, if they need to walk around a corner.
*
* **Note:** This will perform a sphere clip considering only the actual navigation mesh path points with the first path position being the sphere's center.
*/
get path_return_max_radius(): float64
set path_return_max_radius(value: float64)
/** The maximum number of polygons that are searched before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted. */
get path_search_max_polygons(): int64
set path_search_max_polygons(value: int64)
/** The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted. */
get path_search_max_distance(): float64
set path_search_max_distance(value: float64)
/** If `true` the agent is registered for an RVO avoidance callback on the [NavigationServer3D]. When [member velocity] is set and the processing is completed a `safe_velocity` Vector3 is received with a signal connection to [signal velocity_computed]. Avoidance processing with many registered agents has a significant performance cost and should only be enabled on agents that currently require it. */
get avoidance_enabled(): boolean
set avoidance_enabled(value: boolean)
/** Sets the new wanted velocity for the agent. The avoidance simulation will try to fulfill this velocity if possible but will modify it to avoid collision with other agents and obstacles. When an agent is teleported to a new position, use [method set_velocity_forced] as well to reset the internal simulation velocity. */
get velocity(): Vector3
set velocity(value: Vector3)
/** The height of the avoidance agent. Agents will ignore other agents or obstacles that are above or below their current position + height in 2D avoidance. Does nothing in 3D avoidance which uses radius spheres alone. */
get height(): float64
set height(value: float64)
/** The radius of the avoidance agent. This is the "body" of the avoidance agent and not the avoidance maneuver starting radius (which is controlled by [member neighbor_distance]).
* Does not affect normal pathfinding. To change an actor's pathfinding radius bake [NavigationMesh] resources with a different [member NavigationMesh.agent_radius] property and use different navigation maps for each actor size.
*/
get radius(): float64
set radius(value: float64)
/** The distance to search for other agents. */
get neighbor_distance(): float64
set neighbor_distance(value: float64)
/** The maximum number of neighbors for the agent to consider. */
get max_neighbors(): int64
set max_neighbors(value: int64)
/** The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to other agents. The larger the number, the sooner the agent will respond to other agents, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. */
get time_horizon_agents(): float64
set time_horizon_agents(value: float64)
/** The minimal amount of time for which this agent's velocities, that are computed with the collision avoidance algorithm, are safe with respect to static avoidance obstacles. The larger the number, the sooner the agent will respond to static avoidance obstacles, but less freedom in choosing its velocities. A too high value will slow down agents movement considerably. Must be positive. */
get time_horizon_obstacles(): float64
set time_horizon_obstacles(value: float64)
/** The maximum speed that an agent can move. */
get max_speed(): float64
set max_speed(value: float64)
/** If `true`, the agent calculates avoidance velocities in 3D omnidirectionally, e.g. for games that take place in air, underwater or space. Agents using 3D avoidance only avoid other agents using 3D avoidance, and react to radius-based avoidance obstacles. They ignore any vertex-based obstacles.
* If `false`, the agent calculates avoidance velocities in 2D along the x and z-axes, ignoring the y-axis. Agents using 2D avoidance only avoid other agents using 2D avoidance, and react to radius-based avoidance obstacles or vertex-based avoidance obstacles. Other agents using 2D avoidance that are below or above their current position including [member height] are ignored.
*/
get use_3d_avoidance(): boolean
set use_3d_avoidance(value: boolean)
/** If `true`, and the agent uses 2D avoidance, it will remember the set y-axis velocity and reapply it after the avoidance step. While 2D avoidance has no y-axis and simulates on a flat plane this setting can help to soften the most obvious clipping on uneven 3D geometry. */
get keep_y_velocity(): boolean
set keep_y_velocity(value: boolean)
/** A bitfield determining the avoidance layers for this NavigationAgent. Other agents with a matching bit on the [member avoidance_mask] will avoid this agent. */
get avoidance_layers(): int64
set avoidance_layers(value: int64)
/** A bitfield determining what other avoidance agents and obstacles this NavigationAgent will avoid when a bit matches at least one of their [member avoidance_layers]. */
get avoidance_mask(): int64
set avoidance_mask(value: int64)
/** The agent does not adjust the velocity for other agents that would match the [member avoidance_mask] but have a lower [member avoidance_priority]. This in turn makes the other agents with lower priority adjust their velocities even more to avoid collision with this agent. */
get avoidance_priority(): float64
set avoidance_priority(value: float64)
/** If `true` shows debug visuals for this agent. */
get debug_enabled(): boolean
set debug_enabled(value: boolean)
/** If `true` uses the defined [member debug_path_custom_color] for this agent instead of global color. */
get debug_use_custom(): boolean
set debug_use_custom(value: boolean)
/** If [member debug_use_custom] is `true` uses this color for this agent instead of global color. */
get debug_path_custom_color(): Color
set debug_path_custom_color(value: Color)
/** If [member debug_use_custom] is `true` uses this rasterized point size for rendering path points for this agent instead of global point size. */
get debug_path_custom_point_size(): float64
set debug_path_custom_point_size(value: float64)
/** Emitted when the agent had to update the loaded path:
* - because path was previously empty.
* - because navigation map has changed.
* - because agent pushed further away from the current path segment than the [member path_max_distance].
*/
readonly path_changed: Signal<() => void>
/** Signals that the agent reached the target, i.e. the agent moved within [member target_desired_distance] of the [member target_position]. This signal is emitted only once per loaded path.
* This signal will be emitted just before [signal navigation_finished] when the target is reachable.
* It may not always be possible to reach the target but it should always be possible to reach the final position. See [method get_final_position].
*/
readonly target_reached: Signal<() => void>
/** Signals that the agent reached a waypoint. Emitted when the agent moves within [member path_desired_distance] of the next position of the path.
* The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
* - `position`: The position of the waypoint that was reached.
* - `type`: The type of navigation primitive (region or link) that contains this waypoint.
* - `rid`: The [RID] of the containing navigation primitive (region or link).
* - `owner`: The object which manages the containing navigation primitive (region or link).
*/
readonly waypoint_reached: Signal<(details: GDictionary) => void>
/** Signals that the agent reached a navigation link. Emitted when the agent moves within [member path_desired_distance] of the next position of the path when that position is a navigation link.
* The details dictionary may contain the following keys depending on the value of [member path_metadata_flags]:
* - `position`: The start position of the link that was reached.
* - `type`: Always [constant NavigationPathQueryResult3D.PATH_SEGMENT_TYPE_LINK].
* - `rid`: The [RID] of the link.
* - `owner`: The object which manages the link (usually [NavigationLink3D]).
* - `link_entry_position`: If `owner` is available and the owner is a [NavigationLink3D], it will contain the global position of the link's point the agent is entering.
* - `link_exit_position`: If `owner` is available and the owner is a [NavigationLink3D], it will contain the global position of the link's point which the agent is exiting.
*/
readonly link_reached: Signal<(details: GDictionary) => void>
/** Signals that the agent's navigation has finished. If the target is reachable, navigation ends when the target is reached. If the target is unreachable, navigation ends when the last waypoint of the path is reached. This signal is emitted only once per loaded path.
* This signal will be emitted just after [signal target_reached] when the target is reachable.
*/
readonly navigation_finished: Signal<() => void>
/** Notifies when the collision avoidance velocity is calculated. Emitted every update as long as [member avoidance_enabled] is `true` and the agent has a navigation map. */
readonly velocity_computed: Signal<(safe_velocity: Vector3) => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationAgent3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationLink2D extends __NameMapNode2D {
}
/** A link between two positions on [NavigationRegion2D]s that agents can be routed through.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationlink2d.html
*/
class NavigationLink2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** Returns the [RID] of this link on the [NavigationServer2D]. */
get_rid(): RID
/** Sets the [RID] of the navigation map this link should use. By default the link will automatically join the [World2D] default navigation map so this function is only required to override the default map. */
set_navigation_map(navigation_map: RID): void
/** Returns the current navigation map [RID] used by this link. */
get_navigation_map(): RID
/** Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_navigation_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_navigation_layer_value(layer_number: int64): boolean
/** Sets the [member start_position] that is relative to the link from a global [param position]. */
set_global_start_position(position: Vector2): void
/** Returns the [member start_position] that is relative to the link as a global position. */
get_global_start_position(): Vector2
/** Sets the [member end_position] that is relative to the link from a global [param position]. */
set_global_end_position(position: Vector2): void
/** Returns the [member end_position] that is relative to the link as a global position. */
get_global_end_position(): Vector2
/** Whether this link is currently active. If `false`, [method NavigationServer2D.map_get_path] will ignore this link. */
get enabled(): boolean
set enabled(value: boolean)
/** Whether this link can be traveled in both directions or only from [member start_position] to [member end_position]. */
get bidirectional(): boolean
set bidirectional(value: boolean)
/** A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with [method NavigationServer2D.map_get_path]. */
get navigation_layers(): int64
set navigation_layers(value: int64)
/** Starting position of the link.
* This position will search out the nearest polygon in the navigation mesh to attach to.
* The distance the link will search is controlled by [method NavigationServer2D.map_set_link_connection_radius].
*/
get start_position(): Vector2
set start_position(value: Vector2)
/** Ending position of the link.
* This position will search out the nearest polygon in the navigation mesh to attach to.
* The distance the link will search is controlled by [method NavigationServer2D.map_set_link_connection_radius].
*/
get end_position(): Vector2
set end_position(value: Vector2)
/** When pathfinding enters this link from another regions navigation mesh the [member enter_cost] value is added to the path distance for determining the shortest path. */
get enter_cost(): float64
set enter_cost(value: float64)
/** When pathfinding moves along the link the traveled distance is multiplied with [member travel_cost] for determining the shortest path. */
get travel_cost(): float64
set travel_cost(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationLink2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationLink3D extends __NameMapNode3D {
}
/** A link between two positions on [NavigationRegion3D]s that agents can be routed through.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationlink3d.html
*/
class NavigationLink3D<Map extends NodePathMap = any> extends Node3D<Map> {
constructor(identifier?: any)
/** Returns the [RID] of this link on the [NavigationServer3D]. */
get_rid(): RID
/** Sets the [RID] of the navigation map this link should use. By default the link will automatically join the [World3D] default navigation map so this function is only required to override the default map. */
set_navigation_map(navigation_map: RID): void
/** Returns the current navigation map [RID] used by this link. */
get_navigation_map(): RID
/** Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_navigation_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_navigation_layer_value(layer_number: int64): boolean
/** Sets the [member start_position] that is relative to the link from a global [param position]. */
set_global_start_position(position: Vector3): void
/** Returns the [member start_position] that is relative to the link as a global position. */
get_global_start_position(): Vector3
/** Sets the [member end_position] that is relative to the link from a global [param position]. */
set_global_end_position(position: Vector3): void
/** Returns the [member end_position] that is relative to the link as a global position. */
get_global_end_position(): Vector3
/** Whether this link is currently active. If `false`, [method NavigationServer3D.map_get_path] will ignore this link. */
get enabled(): boolean
set enabled(value: boolean)
/** Whether this link can be traveled in both directions or only from [member start_position] to [member end_position]. */
get bidirectional(): boolean
set bidirectional(value: boolean)
/** A bitfield determining all navigation layers the link belongs to. These navigation layers will be checked when requesting a path with [method NavigationServer3D.map_get_path]. */
get navigation_layers(): int64
set navigation_layers(value: int64)
/** Starting position of the link.
* This position will search out the nearest polygon in the navigation mesh to attach to.
* The distance the link will search is controlled by [method NavigationServer3D.map_set_link_connection_radius].
*/
get start_position(): Vector3
set start_position(value: Vector3)
/** Ending position of the link.
* This position will search out the nearest polygon in the navigation mesh to attach to.
* The distance the link will search is controlled by [method NavigationServer3D.map_set_link_connection_radius].
*/
get end_position(): Vector3
set end_position(value: Vector3)
/** When pathfinding enters this link from another regions navigation mesh the [member enter_cost] value is added to the path distance for determining the shortest path. */
get enter_cost(): float64
set enter_cost(value: float64)
/** When pathfinding moves along the link the traveled distance is multiplied with [member travel_cost] for determining the shortest path. */
get travel_cost(): float64
set travel_cost(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationLink3D;
}
namespace NavigationMesh {
enum SamplePartitionType {
/** Watershed partitioning. Generally the best choice if you precompute the navigation mesh, use this if you have large open areas. */
SAMPLE_PARTITION_WATERSHED = 0,
/** Monotone partitioning. Use this if you want fast navigation mesh generation. */
SAMPLE_PARTITION_MONOTONE = 1,
/** Layer partitioning. Good choice to use for tiled navigation mesh with medium and small sized tiles. */
SAMPLE_PARTITION_LAYERS = 2,
/** Represents the size of the [enum SamplePartitionType] enum. */
SAMPLE_PARTITION_MAX = 3,
}
enum ParsedGeometryType {
/** Parses mesh instances as geometry. This includes [MeshInstance3D], [CSGShape3D], and [GridMap] nodes. */
PARSED_GEOMETRY_MESH_INSTANCES = 0,
/** Parses [StaticBody3D] colliders as geometry. The collider should be in any of the layers specified by [member geometry_collision_mask]. */
PARSED_GEOMETRY_STATIC_COLLIDERS = 1,
/** Both [constant PARSED_GEOMETRY_MESH_INSTANCES] and [constant PARSED_GEOMETRY_STATIC_COLLIDERS]. */
PARSED_GEOMETRY_BOTH = 2,
/** Represents the size of the [enum ParsedGeometryType] enum. */
PARSED_GEOMETRY_MAX = 3,
}
enum SourceGeometryMode {
/** Scans the child nodes of the root node recursively for geometry. */
SOURCE_GEOMETRY_ROOT_NODE_CHILDREN = 0,
/** Scans nodes in a group and their child nodes recursively for geometry. The group is specified by [member geometry_source_group_name]. */
SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN = 1,
/** Uses nodes in a group for geometry. The group is specified by [member geometry_source_group_name]. */
SOURCE_GEOMETRY_GROUPS_EXPLICIT = 2,
/** Represents the size of the [enum SourceGeometryMode] enum. */
SOURCE_GEOMETRY_MAX = 3,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationMesh extends __NameMapResource {
}
/** A navigation mesh that defines traversable areas and obstacles.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationmesh.html
*/
class NavigationMesh extends Resource {
constructor(identifier?: any)
/** Based on [param value], enables or disables the specified layer in the [member geometry_collision_mask], given a [param layer_number] between 1 and 32. */
set_collision_mask_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member geometry_collision_mask] is enabled, given a [param layer_number] between 1 and 32. */
get_collision_mask_value(layer_number: int64): boolean
/** Adds a polygon using the indices of the vertices you get when calling [method get_vertices]. */
add_polygon(polygon: PackedInt32Array | int32[]): void
/** Returns the number of polygons in the navigation mesh. */
get_polygon_count(): int64
/** Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon. */
get_polygon(idx: int64): PackedInt32Array
/** Clears the array of polygons, but it doesn't clear the array of vertices. */
clear_polygons(): void
/** Initializes the navigation mesh by setting the vertices and indices according to a [Mesh].
*
* **Note:** The given [param mesh] must be of type [constant Mesh.PRIMITIVE_TRIANGLES] and have an index array.
*/
create_from_mesh(mesh: Mesh): void
/** Clears the internal arrays for vertices and polygon indices. */
clear(): void
get vertices(): PackedVector3Array
set vertices(value: PackedVector3Array | Vector3[])
get polygons(): GArray
set polygons(value: GArray)
/** Partitioning algorithm for creating the navigation mesh polys. */
get sample_partition_type(): int64
set sample_partition_type(value: int64)
/** Determines which type of nodes will be parsed as geometry. */
get geometry_parsed_geometry_type(): int64
set geometry_parsed_geometry_type(value: int64)
/** The physics layers to scan for static colliders.
* Only used when [member geometry_parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH].
*/
get geometry_collision_mask(): int64
set geometry_collision_mask(value: int64)
/** The source of the geometry used when baking. */
get geometry_source_geometry_mode(): int64
set geometry_source_geometry_mode(value: int64)
/** The name of the group to scan for geometry.
* Only used when [member geometry_source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT].
*/
get geometry_source_group_name(): string
set geometry_source_group_name(value: string)
/** The cell size used to rasterize the navigation mesh vertices on the XZ plane. Must match with the cell size on the navigation map. */
get cell_size(): float64
set cell_size(value: float64)
/** The cell height used to rasterize the navigation mesh vertices on the Y axis. Must match with the cell height on the navigation map. */
get cell_height(): float64
set cell_height(value: float64)
/** The size of the non-navigable border around the bake bounding area.
* In conjunction with the [member filter_baking_aabb] and a [member edge_max_error] value at `1.0` or below the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by [member agent_radius].
*
* **Note:** If this value is not `0.0`, it will be rounded up to the nearest multiple of [member cell_size] during baking.
*/
get border_size(): float64
set border_size(value: float64)
/** The minimum floor to ceiling height that will still allow the floor area to be considered walkable.
*
* **Note:** While baking, this value will be rounded up to the nearest multiple of [member cell_height].
*/
get agent_height(): float64
set agent_height(value: float64)
/** The distance to erode/shrink the walkable area of the heightfield away from obstructions.
*
* **Note:** While baking, this value will be rounded up to the nearest multiple of [member cell_size].
*
* **Note:** The radius must be equal or higher than `0.0`. If the radius is `0.0`, it won't be possible to fix invalid outline overlaps and other precision errors during the baking process. As a result, some obstacles may be excluded incorrectly from the final navigation mesh, or may delete the navigation mesh's polygons.
*/
get agent_radius(): float64
set agent_radius(value: float64)
/** The minimum ledge height that is considered to still be traversable.
*
* **Note:** While baking, this value will be rounded down to the nearest multiple of [member cell_height].
*/
get agent_max_climb(): float64
set agent_max_climb(value: float64)
/** The maximum slope that is considered walkable, in degrees. */
get agent_max_slope(): float64
set agent_max_slope(value: float64)
/** The minimum size of a region for it to be created.
*
* **Note:** This value will be squared to calculate the minimum number of cells allowed to form isolated island areas. For example, a value of 8 will set the number of cells to 64.
*/
get region_min_size(): float64
set region_min_size(value: float64)
/** Any regions with a size smaller than this will be merged with larger regions if possible.
*
* **Note:** This value will be squared to calculate the number of cells. For example, a value of 20 will set the number of cells to 400.
*/
get region_merge_size(): float64
set region_merge_size(value: float64)
/** The maximum allowed length for contour edges along the border of the mesh. A value of `0.0` disables this feature.
*
* **Note:** While baking, this value will be rounded up to the nearest multiple of [member cell_size].
*/
get edge_max_length(): float64
set edge_max_length(value: float64)
/** The maximum distance a simplified contour's border edges should deviate the original raw contour. */
get edge_max_error(): float64
set edge_max_error(value: float64)
/** The maximum number of vertices allowed for polygons generated during the contour to polygon conversion process. */
get vertices_per_polygon(): float64
set vertices_per_polygon(value: float64)
/** The sampling distance to use when generating the detail mesh, in cell unit. */
get detail_sample_distance(): float64
set detail_sample_distance(value: float64)
/** The maximum distance the detail mesh surface should deviate from heightfield, in cell unit. */
get detail_sample_max_error(): float64
set detail_sample_max_error(value: float64)
/** If `true`, marks non-walkable spans as walkable if their maximum is within [member agent_max_climb] of a walkable neighbor. */
get filter_low_hanging_obstacles(): boolean
set filter_low_hanging_obstacles(value: boolean)
/** If `true`, marks spans that are ledges as non-walkable. */
get filter_ledge_spans(): boolean
set filter_ledge_spans(value: boolean)
/** If `true`, marks walkable spans as not walkable if the clearance above the span is less than [member agent_height]. */
get filter_walkable_low_height_spans(): boolean
set filter_walkable_low_height_spans(value: boolean)
/** If the baking [AABB] has a volume the navigation mesh baking will be restricted to its enclosing area. */
get filter_baking_aabb(): AABB
set filter_baking_aabb(value: AABB)
/** The position offset applied to the [member filter_baking_aabb] [AABB]. */
get filter_baking_aabb_offset(): Vector3
set filter_baking_aabb_offset(value: Vector3)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationMesh;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationMeshSourceGeometryData2D extends __NameMapResource {
}
/** Container for parsed source geometry data used in navigation mesh baking.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationmeshsourcegeometrydata2d.html
*/
class NavigationMeshSourceGeometryData2D extends Resource {
constructor(identifier?: any)
/** Clears the internal data. */
clear(): void
/** Returns `true` when parsed source geometry data exists. */
has_data(): boolean
/** Appends another array of [param traversable_outlines] at the end of the existing traversable outlines array. */
append_traversable_outlines(traversable_outlines: GArray<PackedVector2Array>): void
/** Appends another array of [param obstruction_outlines] at the end of the existing obstruction outlines array. */
append_obstruction_outlines(obstruction_outlines: GArray<PackedVector2Array>): void
/** Adds the outline points of a shape as traversable area. */
add_traversable_outline(shape_outline: PackedVector2Array | Vector2[]): void
/** Adds the outline points of a shape as obstructed area. */
add_obstruction_outline(shape_outline: PackedVector2Array | Vector2[]): void
/** Adds the geometry data of another [NavigationMeshSourceGeometryData2D] to the navigation mesh baking data. */
merge(other_geometry: NavigationMeshSourceGeometryData2D): void
/** Adds a projected obstruction shape to the source geometry. If [param carve] is `true` the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process. */
add_projected_obstruction(vertices: PackedVector2Array | Vector2[], carve: boolean): void
/** Clears all projected obstructions. */
clear_projected_obstructions(): void
/** Returns an axis-aligned bounding box that covers all the stored geometry data. The bounds are calculated when calling this function with the result cached until further geometry changes are made. */
get_bounds(): Rect2
get traversable_outlines(): GArray
set traversable_outlines(value: GArray)
get obstruction_outlines(): GArray
set obstruction_outlines(value: GArray)
get projected_obstructions(): GArray
set projected_obstructions(value: GArray)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationMeshSourceGeometryData2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationMeshSourceGeometryData3D extends __NameMapResource {
}
/** Container for parsed source geometry data used in navigation mesh baking.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationmeshsourcegeometrydata3d.html
*/
class NavigationMeshSourceGeometryData3D extends Resource {
constructor(identifier?: any)
/** Appends arrays of [param vertices] and [param indices] at the end of the existing arrays. Adds the existing index as an offset to the appended indices. */
append_arrays(vertices: PackedFloat32Array | float32[], indices: PackedInt32Array | int32[]): void
/** Clears the internal data. */
clear(): void
/** Returns `true` when parsed source geometry data exists. */
has_data(): boolean
/** Adds the geometry data of a [Mesh] resource to the navigation mesh baking data. The mesh must have valid triangulated mesh data to be considered. Since [NavigationMesh] resources have no transform, all vertex positions need to be offset by the node's transform using [param xform]. */
add_mesh(mesh: Mesh, xform: Transform3D): void
/** Adds an [Array] the size of [constant Mesh.ARRAY_MAX] and with vertices at index [constant Mesh.ARRAY_VERTEX] and indices at index [constant Mesh.ARRAY_INDEX] to the navigation mesh baking data. The array must have valid triangulated mesh data to be considered. Since [NavigationMesh] resources have no transform, all vertex positions need to be offset by the node's transform using [param xform]. */
add_mesh_array(mesh_array: GArray, xform: Transform3D): void
/** Adds an array of vertex positions to the geometry data for navigation mesh baking to form triangulated faces. For each face the array must have three vertex positions in clockwise winding order. Since [NavigationMesh] resources have no transform, all vertex positions need to be offset by the node's transform using [param xform]. */
add_faces(faces: PackedVector3Array | Vector3[], xform: Transform3D): void
/** Adds the geometry data of another [NavigationMeshSourceGeometryData3D] to the navigation mesh baking data. */
merge(other_geometry: NavigationMeshSourceGeometryData3D): void
/** Adds a projected obstruction shape to the source geometry. The [param vertices] are considered projected on an xz-axes plane, placed at the global y-axis [param elevation] and extruded by [param height]. If [param carve] is `true` the carved shape will not be affected by additional offsets (e.g. agent radius) of the navigation mesh baking process. */
add_projected_obstruction(vertices: PackedVector3Array | Vector3[], elevation: float64, height: float64, carve: boolean): void
/** Clears all projected obstructions. */
clear_projected_obstructions(): void
/** Returns an axis-aligned bounding box that covers all the stored geometry data. The bounds are calculated when calling this function with the result cached until further geometry changes are made. */
get_bounds(): AABB
get vertices(): PackedVector3Array
set vertices(value: PackedVector3Array | Vector3[])
get indices(): PackedInt32Array
set indices(value: PackedInt32Array | int32[])
get projected_obstructions(): GArray
set projected_obstructions(value: GArray)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationMeshSourceGeometryData3D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationObstacle2D extends __NameMapNode2D {
}
/** 2D obstacle used to affect navigation mesh baking or constrain velocities of avoidance controlled agents.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationobstacle2d.html
*/
class NavigationObstacle2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** Returns the [RID] of this obstacle on the [NavigationServer2D]. */
get_rid(): RID
/** Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the `obstacle` on the NavigationServer. */
set_navigation_map(navigation_map: RID): void
/** Returns the [RID] of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use [method set_navigation_map] to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer. */
get_navigation_map(): RID
/** Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_avoidance_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_avoidance_layer_value(layer_number: int64): boolean
/** Sets the avoidance radius for the obstacle. */
get radius(): float64
set radius(value: float64)
/** The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle. */
get vertices(): PackedVector2Array
set vertices(value: PackedVector2Array | Vector2[])
/** If enabled and parsed in a navigation mesh baking process the obstacle will discard source geometry inside its [member vertices] defined shape. */
get affect_navigation_mesh(): boolean
set affect_navigation_mesh(value: boolean)
/** If enabled the obstacle vertices will carve into the baked navigation mesh with the shape unaffected by additional offsets (e.g. agent radius).
* It will still be affected by further postprocessing of the baking process, like edge and polygon simplification.
* Requires [member affect_navigation_mesh] to be enabled.
*/
get carve_navigation_mesh(): boolean
set carve_navigation_mesh(value: boolean)
/** If `true` the obstacle affects avoidance using agents. */
get avoidance_enabled(): boolean
set avoidance_enabled(value: boolean)
/** Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices. */
get velocity(): Vector2
set velocity(value: Vector2)
/** A bitfield determining the avoidance layers for this obstacle. Agents with a matching bit on the their avoidance mask will avoid this obstacle. */
get avoidance_layers(): int64
set avoidance_layers(value: int64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationObstacle2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationObstacle3D extends __NameMapNode3D {
}
/** 3D obstacle used to affect navigation mesh baking or constrain velocities of avoidance controlled agents.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationobstacle3d.html
*/
class NavigationObstacle3D<Map extends NodePathMap = any> extends Node3D<Map> {
constructor(identifier?: any)
/** Returns the [RID] of this obstacle on the [NavigationServer3D]. */
get_rid(): RID
/** Sets the [RID] of the navigation map this NavigationObstacle node should use and also updates the `obstacle` on the NavigationServer. */
set_navigation_map(navigation_map: RID): void
/** Returns the [RID] of the navigation map for this NavigationObstacle node. This function returns always the map set on the NavigationObstacle node and not the map of the abstract obstacle on the NavigationServer. If the obstacle map is changed directly with the NavigationServer API the NavigationObstacle node will not be aware of the map change. Use [method set_navigation_map] to change the navigation map for the NavigationObstacle and also update the obstacle on the NavigationServer. */
get_navigation_map(): RID
/** Based on [param value], enables or disables the specified layer in the [member avoidance_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_avoidance_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member avoidance_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_avoidance_layer_value(layer_number: int64): boolean
/** Sets the avoidance radius for the obstacle. */
get radius(): float64
set radius(value: float64)
/** Sets the obstacle height used in 2D avoidance. 2D avoidance using agent's ignore obstacles that are below or above them. */
get height(): float64
set height(value: float64)
/** The outline vertices of the obstacle. If the vertices are winded in clockwise order agents will be pushed in by the obstacle, else they will be pushed out. Outlines can not be crossed or overlap. Should the vertices using obstacle be warped to a new position agent's can not predict this movement and may get trapped inside the obstacle. */
get vertices(): PackedVector3Array
set vertices(value: PackedVector3Array | Vector3[])
/** If enabled and parsed in a navigation mesh baking process the obstacle will discard source geometry inside its [member vertices] and [member height] defined shape. */
get affect_navigation_mesh(): boolean
set affect_navigation_mesh(value: boolean)
/** If enabled the obstacle vertices will carve into the baked navigation mesh with the shape unaffected by additional offsets (e.g. agent radius).
* It will still be affected by further postprocessing of the baking process, like edge and polygon simplification.
* Requires [member affect_navigation_mesh] to be enabled.
*/
get carve_navigation_mesh(): boolean
set carve_navigation_mesh(value: boolean)
/** If `true` the obstacle affects avoidance using agents. */
get avoidance_enabled(): boolean
set avoidance_enabled(value: boolean)
/** Sets the wanted velocity for the obstacle so other agent's can better predict the obstacle if it is moved with a velocity regularly (every frame) instead of warped to a new position. Does only affect avoidance for the obstacles [member radius]. Does nothing for the obstacles static vertices. */
get velocity(): Vector3
set velocity(value: Vector3)
/** A bitfield determining the avoidance layers for this obstacle. Agents with a matching bit on the their avoidance mask will avoid this obstacle. */
get avoidance_layers(): int64
set avoidance_layers(value: int64)
/** If `true` the obstacle affects 3D avoidance using agent's with obstacle [member radius].
* If `false` the obstacle affects 2D avoidance using agent's with both obstacle [member vertices] as well as obstacle [member radius].
*/
get use_3d_avoidance(): boolean
set use_3d_avoidance(value: boolean)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationObstacle3D;
}
namespace NavigationPathQueryParameters2D {
enum PathfindingAlgorithm {
/** The path query uses the default A* pathfinding algorithm. */
PATHFINDING_ALGORITHM_ASTAR = 0,
}
enum PathPostProcessing {
/** Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navigation mesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes. */
PATH_POSTPROCESSING_CORRIDORFUNNEL = 0,
/** Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center. */
PATH_POSTPROCESSING_EDGECENTERED = 1,
/** Applies no postprocessing and returns the raw path corridor as found by the pathfinding algorithm. */
PATH_POSTPROCESSING_NONE = 2,
}
enum PathMetadataFlags {
/** Don't include any additional metadata about the returned path. */
PATH_METADATA_INCLUDE_NONE = 0,
/** Include the type of navigation primitive (region or link) that each point of the path goes through. */
PATH_METADATA_INCLUDE_TYPES = 1,
/** Include the [RID]s of the regions and links that each point of the path goes through. */
PATH_METADATA_INCLUDE_RIDS = 2,
/** Include the `ObjectID`s of the [Object]s which manage the regions and links each point of the path goes through. */
PATH_METADATA_INCLUDE_OWNERS = 4,
/** Include all available metadata about the returned path. */
PATH_METADATA_INCLUDE_ALL = 7,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationPathQueryParameters2D extends __NameMapRefCounted {
}
/** Provides parameters for 2D navigation path queries.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationpathqueryparameters2d.html
*/
class NavigationPathQueryParameters2D extends RefCounted {
constructor(identifier?: any)
/** The navigation map [RID] used in the path query. */
get map(): RID
set map(value: RID)
/** The pathfinding start position in global coordinates. */
get start_position(): Vector2
set start_position(value: Vector2)
/** The pathfinding target position in global coordinates. */
get target_position(): Vector2
set target_position(value: Vector2)
/** The navigation layers the query will use (as a bitmask). */
get navigation_layers(): int64
set navigation_layers(value: int64)
/** The pathfinding algorithm used in the path query. */
get pathfinding_algorithm(): int64
set pathfinding_algorithm(value: int64)
/** The path postprocessing applied to the raw path corridor found by the [member pathfinding_algorithm]. */
get path_postprocessing(): int64
set path_postprocessing(value: int64)
/** Additional information to include with the navigation path. */
get metadata_flags(): int64
set metadata_flags(value: int64)
/** If `true` a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by [member simplify_epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.
* Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".
*/
get simplify_path(): boolean
set simplify_path(value: boolean)
/** The path simplification amount in worlds units. */
get simplify_epsilon(): float64
set simplify_epsilon(value: float64)
/** The list of region [RID]s that will be excluded from the path query. Use [method NavigationRegion2D.get_rid] to get the [RID] associated with a [NavigationRegion2D] node.
*
* **Note:** The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again.
*/
get excluded_regions(): GArray<RID>
set excluded_regions(value: GArray<RID>)
/** The list of region [RID]s that will be included by the path query. Use [method NavigationRegion2D.get_rid] to get the [RID] associated with a [NavigationRegion2D] node. If left empty all regions are included. If a region ends up being both included and excluded at the same time it will be excluded.
*
* **Note:** The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again.
*/
get included_regions(): GArray<RID>
set included_regions(value: GArray<RID>)
/** The maximum allowed length of the returned path in world units. A path will be clipped when going over this length. A value of `0` or below counts as disabled. */
get path_return_max_length(): float64
set path_return_max_length(value: float64)
/** The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. A value of `0` or below counts as disabled.
*
* **Note:** This will perform a circle shaped clip operation on the path with the first path position being the circle's center position.
*/
get path_return_max_radius(): float64
set path_return_max_radius(value: float64)
/** The maximum number of polygons that are searched before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted. */
get path_search_max_polygons(): int64
set path_search_max_polygons(value: int64)
/** The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted. */
get path_search_max_distance(): float64
set path_search_max_distance(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationPathQueryParameters2D;
}
namespace NavigationPathQueryParameters3D {
enum PathfindingAlgorithm {
/** The path query uses the default A* pathfinding algorithm. */
PATHFINDING_ALGORITHM_ASTAR = 0,
}
enum PathPostProcessing {
/** Applies a funnel algorithm to the raw path corridor found by the pathfinding algorithm. This will result in the shortest path possible inside the path corridor. This postprocessing very much depends on the navigation mesh polygon layout and the created corridor. Especially tile- or gridbased layouts can face artificial corners with diagonal movement due to a jagged path corridor imposed by the cell shapes. */
PATH_POSTPROCESSING_CORRIDORFUNNEL = 0,
/** Centers every path position in the middle of the traveled navigation mesh polygon edge. This creates better paths for tile- or gridbased layouts that restrict the movement to the cells center. */
PATH_POSTPROCESSING_EDGECENTERED = 1,
/** Applies no postprocessing and returns the raw path corridor as found by the pathfinding algorithm. */
PATH_POSTPROCESSING_NONE = 2,
}
enum PathMetadataFlags {
/** Don't include any additional metadata about the returned path. */
PATH_METADATA_INCLUDE_NONE = 0,
/** Include the type of navigation primitive (region or link) that each point of the path goes through. */
PATH_METADATA_INCLUDE_TYPES = 1,
/** Include the [RID]s of the regions and links that each point of the path goes through. */
PATH_METADATA_INCLUDE_RIDS = 2,
/** Include the `ObjectID`s of the [Object]s which manage the regions and links each point of the path goes through. */
PATH_METADATA_INCLUDE_OWNERS = 4,
/** Include all available metadata about the returned path. */
PATH_METADATA_INCLUDE_ALL = 7,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationPathQueryParameters3D extends __NameMapRefCounted {
}
/** Provides parameters for 3D navigation path queries.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationpathqueryparameters3d.html
*/
class NavigationPathQueryParameters3D extends RefCounted {
constructor(identifier?: any)
/** The navigation map [RID] used in the path query. */
get map(): RID
set map(value: RID)
/** The pathfinding start position in global coordinates. */
get start_position(): Vector3
set start_position(value: Vector3)
/** The pathfinding target position in global coordinates. */
get target_position(): Vector3
set target_position(value: Vector3)
/** The navigation layers the query will use (as a bitmask). */
get navigation_layers(): int64
set navigation_layers(value: int64)
/** The pathfinding algorithm used in the path query. */
get pathfinding_algorithm(): int64
set pathfinding_algorithm(value: int64)
/** The path postprocessing applied to the raw path corridor found by the [member pathfinding_algorithm]. */
get path_postprocessing(): int64
set path_postprocessing(value: int64)
/** Additional information to include with the navigation path. */
get metadata_flags(): int64
set metadata_flags(value: int64)
/** If `true` a simplified version of the path will be returned with less critical path points removed. The simplification amount is controlled by [member simplify_epsilon]. The simplification uses a variant of Ramer-Douglas-Peucker algorithm for curve point decimation.
* Path simplification can be helpful to mitigate various path following issues that can arise with certain agent types and script behaviors. E.g. "steering" agents or avoidance in "open fields".
*/
get simplify_path(): boolean
set simplify_path(value: boolean)
/** The path simplification amount in worlds units. */
get simplify_epsilon(): float64
set simplify_epsilon(value: float64)
/** The list of region [RID]s that will be excluded from the path query. Use [method NavigationRegion3D.get_rid] to get the [RID] associated with a [NavigationRegion3D] node.
*
* **Note:** The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again.
*/
get excluded_regions(): GArray<RID>
set excluded_regions(value: GArray<RID>)
/** The list of region [RID]s that will be included by the path query. Use [method NavigationRegion3D.get_rid] to get the [RID] associated with a [NavigationRegion3D] node. If left empty all regions are included. If a region ends up being both included and excluded at the same time it will be excluded.
*
* **Note:** The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then set it to the property again.
*/
get included_regions(): GArray<RID>
set included_regions(value: GArray<RID>)
/** The maximum allowed length of the returned path in world units. A path will be clipped when going over this length. A value of `0` or below counts as disabled. */
get path_return_max_length(): float64
set path_return_max_length(value: float64)
/** The maximum allowed radius in world units that the returned path can be from the path start. The path will be clipped when going over this radius. A value of `0` or below counts as disabled.
*
* **Note:** This will perform a sphere shaped clip operation on the path with the first path position being the sphere's center position.
*/
get path_return_max_radius(): float64
set path_return_max_radius(value: float64)
/** The maximum number of polygons that are searched before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted. */
get path_search_max_polygons(): int64
set path_search_max_polygons(value: int64)
/** The maximum distance a searched polygon can be away from the start polygon before the pathfinding cancels the search for a path to the (possibly unreachable or very far away) target position polygon. In this case the pathfinding resets and builds a path from the start polygon to the polygon that was found closest to the target position so far. A value of `0` or below counts as unlimited. In case of unlimited the pathfinding will search all polygons connected with the start polygon until either the target position polygon is found or all available polygon search options are exhausted. */
get path_search_max_distance(): float64
set path_search_max_distance(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationPathQueryParameters3D;
}
namespace NavigationPathQueryResult2D {
enum PathSegmentType {
/** This segment of the path goes through a region. */
PATH_SEGMENT_TYPE_REGION = 0,
/** This segment of the path goes through a link. */
PATH_SEGMENT_TYPE_LINK = 1,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationPathQueryResult2D extends __NameMapRefCounted {
}
/** Represents the result of a 2D pathfinding query.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationpathqueryresult2d.html
*/
class NavigationPathQueryResult2D extends RefCounted {
constructor(identifier?: any)
/** Reset the result object to its initial state. This is useful to reuse the object across multiple queries. */
reset(): void
/** The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer2D.map_get_path]. */
get path(): PackedVector2Array
set path(value: PackedVector2Array | Vector2[])
/** The type of navigation primitive (region or link) that each point of the path goes through. */
get path_types(): PackedInt32Array
set path_types(value: PackedInt32Array | int32[])
/** The [RID]s of the regions and links that each point of the path goes through. */
get path_rids(): GArray<RID>
set path_rids(value: GArray<RID>)
/** The `ObjectID`s of the [Object]s which manage the regions and links each point of the path goes through. */
get path_owner_ids(): PackedInt64Array
set path_owner_ids(value: PackedInt64Array | int64[])
/** Returns the length of the path. */
get path_length(): float64
set path_length(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationPathQueryResult2D;
}
namespace NavigationPathQueryResult3D {
enum PathSegmentType {
/** This segment of the path goes through a region. */
PATH_SEGMENT_TYPE_REGION = 0,
/** This segment of the path goes through a link. */
PATH_SEGMENT_TYPE_LINK = 1,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationPathQueryResult3D extends __NameMapRefCounted {
}
/** Represents the result of a 3D pathfinding query.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationpathqueryresult3d.html
*/
class NavigationPathQueryResult3D extends RefCounted {
constructor(identifier?: any)
/** Reset the result object to its initial state. This is useful to reuse the object across multiple queries. */
reset(): void
/** The resulting path array from the navigation query. All path array positions are in global coordinates. Without customized query parameters this is the same path as returned by [method NavigationServer3D.map_get_path]. */
get path(): PackedVector3Array
set path(value: PackedVector3Array | Vector3[])
/** The type of navigation primitive (region or link) that each point of the path goes through. */
get path_types(): PackedInt32Array
set path_types(value: PackedInt32Array | int32[])
/** The [RID]s of the regions and links that each point of the path goes through. */
get path_rids(): GArray<RID>
set path_rids(value: GArray<RID>)
/** The `ObjectID`s of the [Object]s which manage the regions and links each point of the path goes through. */
get path_owner_ids(): PackedInt64Array
set path_owner_ids(value: PackedInt64Array | int64[])
/** Returns the length of the path. */
get path_length(): float64
set path_length(value: float64)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationPathQueryResult3D;
}
namespace NavigationPolygon {
enum SamplePartitionType {
/** Convex partitioning that yields navigation mesh with convex polygons. */
SAMPLE_PARTITION_CONVEX_PARTITION = 0,
/** Triangulation partitioning that yields navigation mesh with triangle polygons. */
SAMPLE_PARTITION_TRIANGULATE = 1,
/** Represents the size of the [enum SamplePartitionType] enum. */
SAMPLE_PARTITION_MAX = 2,
}
enum ParsedGeometryType {
/** Parses mesh instances as obstruction geometry. This includes [Polygon2D], [MeshInstance2D], [MultiMeshInstance2D], and [TileMap] nodes.
* Meshes are only parsed when they use a 2D vertices surface format.
*/
PARSED_GEOMETRY_MESH_INSTANCES = 0,
/** Parses [StaticBody2D] and [TileMap] colliders as obstruction geometry. The collider should be in any of the layers specified by [member parsed_collision_mask]. */
PARSED_GEOMETRY_STATIC_COLLIDERS = 1,
/** Both [constant PARSED_GEOMETRY_MESH_INSTANCES] and [constant PARSED_GEOMETRY_STATIC_COLLIDERS]. */
PARSED_GEOMETRY_BOTH = 2,
/** Represents the size of the [enum ParsedGeometryType] enum. */
PARSED_GEOMETRY_MAX = 3,
}
enum SourceGeometryMode {
/** Scans the child nodes of the root node recursively for geometry. */
SOURCE_GEOMETRY_ROOT_NODE_CHILDREN = 0,
/** Scans nodes in a group and their child nodes recursively for geometry. The group is specified by [member source_geometry_group_name]. */
SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN = 1,
/** Uses nodes in a group for geometry. The group is specified by [member source_geometry_group_name]. */
SOURCE_GEOMETRY_GROUPS_EXPLICIT = 2,
/** Represents the size of the [enum SourceGeometryMode] enum. */
SOURCE_GEOMETRY_MAX = 3,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationPolygon extends __NameMapResource {
}
/** A 2D navigation mesh that describes a traversable surface for pathfinding.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationpolygon.html
*/
class NavigationPolygon extends Resource {
constructor(identifier?: any)
/** Adds a polygon using the indices of the vertices you get when calling [method get_vertices]. */
add_polygon(polygon: PackedInt32Array | int32[]): void
/** Returns the count of all polygons. */
get_polygon_count(): int64
/** Returns a [PackedInt32Array] containing the indices of the vertices of a created polygon. */
get_polygon(idx: int64): PackedInt32Array
/** Clears the array of polygons, but it doesn't clear the array of outlines and vertices. */
clear_polygons(): void
/** Returns the [NavigationMesh] resulting from this navigation polygon. This navigation mesh can be used to update the navigation mesh of a region with the [method NavigationServer3D.region_set_navigation_mesh] API directly. */
get_navigation_mesh(): null | NavigationMesh
/** Appends a [PackedVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines. */
add_outline(outline: PackedVector2Array | Vector2[]): void
/** Adds a [PackedVector2Array] that contains the vertices of an outline to the internal array that contains all the outlines at a fixed position. */
add_outline_at_index(outline: PackedVector2Array | Vector2[], index: int64): void
/** Returns the number of outlines that were created in the editor or by script. */
get_outline_count(): int64
/** Changes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. */
set_outline(idx: int64, outline: PackedVector2Array | Vector2[]): void
/** Returns a [PackedVector2Array] containing the vertices of an outline that was created in the editor or by script. */
get_outline(idx: int64): PackedVector2Array
/** Removes an outline created in the editor or by script. You have to call [method make_polygons_from_outlines] for the polygons to update. */
remove_outline(idx: int64): void
/** Clears the array of the outlines, but it doesn't clear the vertices and the polygons that were created by them. */
clear_outlines(): void
/** Creates polygons from the outlines added in the editor or by script. */
make_polygons_from_outlines(): void
/** Based on [param value], enables or disables the specified layer in the [member parsed_collision_mask], given a [param layer_number] between 1 and 32. */
set_parsed_collision_mask_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member parsed_collision_mask] is enabled, given a [param layer_number] between 1 and 32. */
get_parsed_collision_mask_value(layer_number: int64): boolean
/** Clears the internal arrays for vertices and polygon indices. */
clear(): void
get vertices(): PackedVector2Array
set vertices(value: PackedVector2Array | Vector2[])
get polygons(): GArray
set polygons(value: GArray)
get outlines(): GArray
set outlines(value: GArray)
/** Partitioning algorithm for creating the navigation mesh polys. */
get sample_partition_type(): int64
set sample_partition_type(value: int64)
/** Determines which type of nodes will be parsed as geometry. */
get parsed_geometry_type(): int64
set parsed_geometry_type(value: int64)
/** The physics layers to scan for static colliders.
* Only used when [member parsed_geometry_type] is [constant PARSED_GEOMETRY_STATIC_COLLIDERS] or [constant PARSED_GEOMETRY_BOTH].
*/
get parsed_collision_mask(): int64
set parsed_collision_mask(value: int64)
/** The source of the geometry used when baking. */
get source_geometry_mode(): int64
set source_geometry_mode(value: int64)
/** The group name of nodes that should be parsed for baking source geometry.
* Only used when [member source_geometry_mode] is [constant SOURCE_GEOMETRY_GROUPS_WITH_CHILDREN] or [constant SOURCE_GEOMETRY_GROUPS_EXPLICIT].
*/
get source_geometry_group_name(): string
set source_geometry_group_name(value: string)
/** The cell size used to rasterize the navigation mesh vertices. Must match with the cell size on the navigation map. */
get cell_size(): float64
set cell_size(value: float64)
/** The size of the non-navigable border around the bake bounding area defined by the [member baking_rect] [Rect2].
* In conjunction with the [member baking_rect] the border size can be used to bake tile aligned navigation meshes without the tile edges being shrunk by [member agent_radius].
*/
get border_size(): float64
set border_size(value: float64)
/** The distance to erode/shrink the walkable surface when baking the navigation mesh.
*
* **Note:** The radius must be equal or higher than `0.0`. If the radius is `0.0`, it won't be possible to fix invalid outline overlaps and other precision errors during the baking process. As a result, some obstacles may be excluded incorrectly from the final navigation mesh, or may delete the navigation mesh's polygons.
*/
get agent_radius(): float64
set agent_radius(value: float64)
/** If the baking [Rect2] has an area the navigation mesh baking will be restricted to its enclosing area. */
get baking_rect(): Rect2
set baking_rect(value: Rect2)
/** The position offset applied to the [member baking_rect] [Rect2]. */
get baking_rect_offset(): Vector2
set baking_rect_offset(value: Vector2)
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationPolygon;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationRegion2D extends __NameMapNode2D {
}
/** A traversable 2D region that [NavigationAgent2D]s can use for pathfinding.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationregion2d.html
*/
class NavigationRegion2D<Map extends NodePathMap = any> extends Node2D<Map> {
constructor(identifier?: any)
/** Returns the [RID] of this region on the [NavigationServer2D]. Combined with [method NavigationServer2D.map_get_closest_point_owner] can be used to identify the [NavigationRegion2D] closest to a point on the merged navigation map. */
get_rid(): RID
/** Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World2D] default navigation map so this function is only required to override the default map. */
set_navigation_map(navigation_map: RID): void
/** Returns the current navigation map [RID] used by this region. */
get_navigation_map(): RID
/** Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_navigation_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_navigation_layer_value(layer_number: int64): boolean
/** Returns the [RID] of this region on the [NavigationServer2D]. */
get_region_rid(): RID
/** Bakes the [NavigationPolygon]. If [param on_thread] is set to `true` (default), the baking is done on a separate thread. */
bake_navigation_polygon(on_thread?: boolean /* = true */): void
/** Returns `true` when the [NavigationPolygon] is being baked on a background thread. */
is_baking(): boolean
_navigation_polygon_changed(): void
/** Returns the axis-aligned rectangle for the region's transformed navigation mesh. */
get_bounds(): Rect2
/** The [NavigationPolygon] resource to use. */
get navigation_polygon(): null | NavigationPolygon
set navigation_polygon(value: null | NavigationPolygon)
/** Determines if the [NavigationRegion2D] is enabled or disabled. */
get enabled(): boolean
set enabled(value: boolean)
/** If enabled the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. */
get use_edge_connections(): boolean
set use_edge_connections(value: boolean)
/** A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with [method NavigationServer2D.map_get_path]. */
get navigation_layers(): int64
set navigation_layers(value: int64)
/** When pathfinding enters this region's navigation mesh from another regions navigation mesh the [member enter_cost] value is added to the path distance for determining the shortest path. */
get enter_cost(): float64
set enter_cost(value: float64)
/** When pathfinding moves inside this region's navigation mesh the traveled distances are multiplied with [member travel_cost] for determining the shortest path. */
get travel_cost(): float64
set travel_cost(value: float64)
/** Emitted when the used navigation polygon is replaced or changes to the internals of the current navigation polygon are committed. */
readonly navigation_polygon_changed: Signal<() => void>
/** Emitted when a navigation polygon bake operation is completed. */
readonly bake_finished: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationRegion2D;
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNavigationRegion3D extends __NameMapNode3D {
}
/** A traversable 3D region that [NavigationAgent3D]s can use for pathfinding.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_navigationregion3d.html
*/
class NavigationRegion3D<Map extends NodePathMap = any> extends Node3D<Map> {
constructor(identifier?: any)
/** Returns the [RID] of this region on the [NavigationServer3D]. Combined with [method NavigationServer3D.map_get_closest_point_owner] can be used to identify the [NavigationRegion3D] closest to a point on the merged navigation map. */
get_rid(): RID
/** Sets the [RID] of the navigation map this region should use. By default the region will automatically join the [World3D] default navigation map so this function is only required to override the default map. */
set_navigation_map(navigation_map: RID): void
/** Returns the current navigation map [RID] used by this region. */
get_navigation_map(): RID
/** Based on [param value], enables or disables the specified layer in the [member navigation_layers] bitmask, given a [param layer_number] between 1 and 32. */
set_navigation_layer_value(layer_number: int64, value: boolean): void
/** Returns whether or not the specified layer of the [member navigation_layers] bitmask is enabled, given a [param layer_number] between 1 and 32. */
get_navigation_layer_value(layer_number: int64): boolean
/** Returns the [RID] of this region on the [NavigationServer3D]. */
get_region_rid(): RID
/** Bakes the [NavigationMesh]. If [param on_thread] is set to `true` (default), the baking is done on a separate thread. Baking on separate thread is useful because navigation baking is not a cheap operation. When it is completed, it automatically sets the new [NavigationMesh]. Please note that baking on separate thread may be very slow if geometry is parsed from meshes as async access to each mesh involves heavy synchronization. Also, please note that baking on a separate thread is automatically disabled on operating systems that cannot use threads (such as Web with threads disabled). */
bake_navigation_mesh(on_thread?: boolean /* = true */): void
/** Returns `true` when the [NavigationMesh] is being baked on a background thread. */
is_baking(): boolean
/** Returns the axis-aligned bounding box for the region's transformed navigation mesh. */
get_bounds(): AABB
/** The [NavigationMesh] resource to use. */
get navigation_mesh(): null | NavigationMesh
set navigation_mesh(value: null | NavigationMesh)
/** Determines if the [NavigationRegion3D] is enabled or disabled. */
get enabled(): boolean
set enabled(value: boolean)
/** If enabled the navigation region will use edge connections to connect with other navigation regions within proximity of the navigation map edge connection margin. */
get use_edge_connections(): boolean
set use_edge_connections(value: boolean)
/** A bitfield determining all navigation layers the region belongs to. These navigation layers can be checked upon when requesting a path with [method NavigationServer3D.map_get_path]. */
get navigation_layers(): int64
set navigation_layers(value: int64)
/** When pathfinding enters this region's navigation mesh from another regions navigation mesh the [member enter_cost] value is added to the path distance for determining the shortest path. */
get enter_cost(): float64
set enter_cost(value: float64)
/** When pathfinding moves inside this region's navigation mesh the traveled distances are multiplied with [member travel_cost] for determining the shortest path. */
get travel_cost(): float64
set travel_cost(value: float64)
/** Notifies when the [NavigationMesh] has changed. */
readonly navigation_mesh_changed: Signal<() => void>
/** Notifies when the navigation mesh bake operation is completed. */
readonly bake_finished: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNavigationRegion3D;
}
namespace NinePatchRect {
enum AxisStretchMode {
/** Stretches the center texture across the NinePatchRect. This may cause the texture to be distorted. */
AXIS_STRETCH_MODE_STRETCH = 0,
/** Repeats the center texture across the NinePatchRect. This won't cause any visible distortion. The texture must be seamless for this to work without displaying artifacts between edges. */
AXIS_STRETCH_MODE_TILE = 1,
/** Repeats the center texture across the NinePatchRect, but will also stretch the texture to make sure each tile is visible in full. This may cause the texture to be distorted, but less than [constant AXIS_STRETCH_MODE_STRETCH]. The texture must be seamless for this to work without displaying artifacts between edges. */
AXIS_STRETCH_MODE_TILE_FIT = 2,
}
}
/** @deprecated Internal use. Does not exist at runtime. */
interface __NameMapNinePatchRect extends __NameMapControl {
}
/** A control that displays a texture by keeping its corners intact, but tiling its edges and center.
*
* @link https://docs.godotengine.org/en/4.5/classes/class_ninepatchrect.html
*/
class NinePatchRect<Map extends NodePathMap = any> extends Control<Map> {
constructor(identifier?: any)
/** Sets the size of the margin on the specified [enum Side] to [param value] pixels. */
set_patch_margin(margin: Side, value: int64): void
/** Returns the size of the margin on the specified [enum Side]. */
get_patch_margin(margin: Side): int64
/** The node's texture resource. */
get texture(): null | Texture2D
set texture(value: null | Texture2D)
/** If `true`, draw the panel's center. Else, only draw the 9-slice's borders. */
get draw_center(): boolean
set draw_center(value: boolean)
/** Rectangular region of the texture to sample from. If you're working with an atlas, use this property to define the area the 9-slice should use. All other properties are relative to this one. If the rect is empty, NinePatchRect will use the whole texture. */
get region_rect(): Rect2
set region_rect(value: Rect2)
/** The width of the 9-slice's left column. A margin of 16 means the 9-slice's left corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. */
get patch_margin_left(): int64
set patch_margin_left(value: int64)
/** The height of the 9-slice's top row. A margin of 16 means the 9-slice's top corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. */
get patch_margin_top(): int64
set patch_margin_top(value: int64)
/** The width of the 9-slice's right column. A margin of 16 means the 9-slice's right corners and side will have a width of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. */
get patch_margin_right(): int64
set patch_margin_right(value: int64)
/** The height of the 9-slice's bottom row. A margin of 16 means the 9-slice's bottom corners and side will have a height of 16 pixels. You can set all 4 margin values individually to create panels with non-uniform borders. */
get patch_margin_bottom(): int64
set patch_margin_bottom(value: int64)
/** The stretch mode to use for horizontal stretching/tiling. */
get axis_stretch_horizontal(): int64
set axis_stretch_horizontal(value: int64)
/** The stretch mode to use for vertical stretching/tiling. */
get axis_stretch_vertical(): int64
set axis_stretch_vertical(value: int64)
/** Emitted when the node's texture changes. */
readonly texture_changed: Signal<() => void>
/** @deprecated Internal use. Does not exist at runtime. */
__godotNameMap: __NameMapNinePatchRect;
}
}
Reference in New Issue View Git Blame Copy Permalink