id
stringlengths
6
6
text
stringlengths
20
17.2k
title
stringclasses
1 value
123665
<methods> <method name="add_property_info"> <return type="void" /> <param index="0" name="hint" type="Dictionary" /> <description> Adds a custom property info to a property. The dictionary must contain: - [code]"name"[/code]: [String] (the property's name) - [code]"type"[/code]: [int] (see [enum ...
123666
<method name="save"> <return type="int" enum="Error" /> <description> Saves the configuration to the [code]project.godot[/code] file. [b]Note:[/b] This method is intended to be used by editor plugins, as modified [ProjectSettings] can't be loaded back in the running app. If you want to change project sett...
123673
<member name="debug/shader_language/warnings/magic_position_write" type="bool" setter="" getter="" default="true"> When set to [code]true[/code], produces a warning when the shader contains [code]POSITION = vec4(vertex,[/code] as this was very common code written in Godot 4.2 and earlier that was paired with a QuadM...
123675
member name="display/window/size/borderless" type="bool" setter="" getter="" default="false"> Forces the main window to be borderless. [b]Note:[/b] This setting is ignored on iOS, Android, and Web. </member> <member name="display/window/size/extend_to_title" type="bool" setter="" getter="" default="false"> ...
123676
member name="display/window/stretch/scale" type="float" setter="" getter="" default="1.0"> The scale factor multiplier to use for 2D elements. This multiplies the final scale factor determined by [member display/window/stretch/mode]. If using the [b]Disabled[/b] stretch mode, this scale factor is applied as-is. This...
123694
member name="rendering/2d/snap/snap_2d_transforms_to_pixel" type="bool" setter="" getter="" default="false"> If [code]true[/code], [CanvasItem] nodes will internally snap to full pixels. Useful for low-resolution pixel art games. Their position can still be sub-pixel, but the decimals will not have effect as the pos...
123731
<?xml version="1.0" encoding="UTF-8" ?> <class name="CanvasLayer" inherits="Node" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A node used for independent rendering of objects within a 2D scene. </brief_description> <description> [CanvasI...
123745
<?xml version="1.0" encoding="UTF-8" ?> <class name="NodePath" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A pre-parsed scene tree path. </brief_description> <description> The [NodePath] built-in [Variant] type represents a path to a nod...
123757
<?xml version="1.0" encoding="UTF-8" ?> <class name="Container" inherits="Control" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Base class for all GUI containers. </brief_description> <description> Base class for all GUI containers. A [Co...
123771
<?xml version="1.0" encoding="UTF-8" ?> <class name="ImageTexture" inherits="Texture2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A [Texture2D] based on an [Image]. </brief_description> <description> A [Texture2D] based on an [Image]. ...
123779
<?xml version="1.0" encoding="UTF-8" ?> <class name="SeparationRayShape3D" inherits="Shape3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A 3D ray shape used for physics collision that tries to separate itself from any collider. </brief_des...
123789
<brief_description> Texture for 2D and 3D. </brief_description> <description> A texture works by registering an image in the video hardware, which then can be used in 3D models or 2D [Sprite2D] or GUI [Control]. Textures are often created by loading them from a file. See [method @GDScript.load]. [Texture2D] i...
123791
<?xml version="1.0" encoding="UTF-8" ?> <class name="PackedByteArray" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A packed array of bytes. </brief_description> <description> An array specifically designed to hold bytes. Packs data tightl...
123794
<method name="fill"> <return type="void" /> <param index="0" name="value" type="int" /> <description> Assigns the given value to all elements in the array. This can typically be used together with [method resize] to create an array with a given size and initialized elements. </description> </method> ...
123798
<method name="get_singleton" qualifiers="const"> <return type="Object" /> <param index="0" name="name" type="StringName" /> <description> Returns the global singleton with the given [param name], or [code]null[/code] if it does not exist. Often used for plugins. See also [method has_singleton] and [method ...
123804
<?xml version="1.0" encoding="UTF-8" ?> <class name="Camera3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Camera node, displays from a point of view. </brief_description> <description> [Camera3D] is a special node that...
123806
<method name="unproject_position" qualifiers="const"> <return type="Vector2" /> <param index="0" name="world_point" type="Vector3" /> <description> Returns the 2D coordinate in the [Viewport] rectangle that maps to the given 3D point in world space. [b]Note:[/b] When using this to position GUI elements...
123807
<constants> <constant name="PROJECTION_PERSPECTIVE" value="0" enum="ProjectionType"> Perspective projection. Objects on the screen becomes smaller when they are far away. </constant> <constant name="PROJECTION_ORTHOGONAL" value="1" enum="ProjectionType"> Orthogonal projection, also known as orthographic pro...
123831
<?xml version="1.0" encoding="UTF-8" ?> <class name="Callable" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A built-in type representing a method or a standalone function. </brief_description> <description> [Callable] is a built-in [Varia...
123832
<methods> <method name="bind" qualifiers="vararg const"> <return type="Callable" /> <description> Returns a copy of this [Callable] with one or more arguments bound. When called, the bound arguments are passed [i]after[/i] the arguments supplied by [method call]. See also [method unbind]. [b]Note:[/b] W...
123833
<method name="rpc" qualifiers="vararg const"> <return type="void" /> <description> Perform an RPC (Remote Procedure Call) on all connected peers. This is used for multiplayer and is normally not available, unless the function being called has been marked as [i]RPC[/i] (using [annotation @GDScript.@rpc] or [me...
123843
<?xml version="1.0" encoding="UTF-8" ?> <class name="StreamPeerTCP" inherits="StreamPeer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A stream peer that handles TCP connections. </brief_description> <description> A stream peer that handl...
123855
<?xml version="1.0" encoding="UTF-8" ?> <class name="WorldBoundaryShape2D" inherits="Shape2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A 2D world boundary (half-plane) shape used for physics collision. </brief_description> <description>...
123857
<?xml version="1.0" encoding="UTF-8" ?> <class name="PhysicsTestMotionResult2D" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Describes the motion and collision result from [method PhysicsServer2D.body_test_motion]. </br...
123860
<?xml version="1.0" encoding="UTF-8" ?> <class name="Camera2D" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Camera node for 2D scenes. </brief_description> <description> Camera node for 2D scenes. It forces the screen (c...
123861
<members> <member name="anchor_mode" type="int" setter="set_anchor_mode" getter="get_anchor_mode" enum="Camera2D.AnchorMode" default="1"> The Camera2D's anchor point. See [enum AnchorMode] constants. </member> <member name="custom_viewport" type="Node" setter="set_custom_viewport" getter="get_custom_viewport">...
123862
<member name="rotation_smoothing_speed" type="float" setter="set_rotation_smoothing_speed" getter="get_rotation_smoothing_speed" default="5.0"> The angular, asymptotic speed of the camera's rotation smoothing effect when [member rotation_smoothing_enabled] is [code]true[/code]. </member> <member name="zoom" type...
123875
<methods> <method name="get_date_dict_from_system" qualifiers="const"> <return type="Dictionary" /> <param index="0" name="utc" type="bool" default="false" /> <description> Returns the current date as a dictionary of keys: [code]year[/code], [code]month[/code], [code]day[/code], and [code]weekday[/code]....
123903
<?xml version="1.0" encoding="UTF-8" ?> <class name="CollisionPolygon2D" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A node that provides a polygon shape to a [CollisionObject2D] parent. </brief_description> <description>...
123908
<methods> <method name="assign"> <return type="void" /> <param index="0" name="dictionary" type="Dictionary" /> <description> Assigns elements of another [param dictionary] into the dictionary. Resizes the dictionary to match [param dictionary]. Performs type conversions if the dictionary is typed. </...
123913
<?xml version="1.0" encoding="UTF-8" ?> <class name="VBoxContainer" inherits="BoxContainer" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A container that arranges its child controls vertically. </brief_description> <description> A variant...
123917
<signals> <signal name="request_completed"> <param index="0" name="result" type="int" /> <param index="1" name="response_code" type="int" /> <param index="2" name="headers" type="PackedStringArray" /> <param index="3" name="body" type="PackedByteArray" /> <description> Emitted when a request is com...
123922
<?xml version="1.0" encoding="UTF-8" ?> <class name="AnimationNodeBlendSpace2D" inherits="AnimationRootNode" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A set of [AnimationRootNode]s placed on 2D coordinates, crossfading between the three ad...
123928
<methods> <method name="add_gizmo"> <return type="void" /> <param index="0" name="gizmo" type="Node3DGizmo" /> <description> Attach an editor gizmo to this [Node3D]. [b]Note:[/b] The gizmo object would typically be an instance of [EditorNode3DGizmo], but the argument type is kept generic to avoid cre...
123930
<members> <member name="basis" type="Basis" setter="set_basis" getter="get_basis"> Basis of the [member transform] property. Represents the rotation, scale, and shear of this node. </member> <member name="global_basis" type="Basis" setter="set_global_basis" getter="get_global_basis"> Global basis of this no...
123937
<?xml version="1.0" encoding="UTF-8" ?> <class name="ConfigFile" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Helper class to handle INI-style files. </brief_description> <description> This helper class can be used t...
123953
<?xml version="1.0" encoding="UTF-8" ?> <class name="JSON" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Helper class for creating and parsing JSON data. </brief_description> <description> The [JSON] class enables all d...
123988
<methods> <method name="close"> <return type="void" /> <description> Closes the currently opened file and prevents subsequent read/write operations. Use [method flush] to persist the data to disk without closing the file. [b]Note:[/b] [FileAccess] will automatically close when it's freed, which happens ...
124006
<?xml version="1.0" encoding="UTF-8" ?> <class name="AnimatedSprite2D" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Sprite node that contains multiple textures as frames to play for animation. </brief_description> <descrip...
124035
<?xml version="1.0" encoding="UTF-8" ?> <class name="KinematicCollision2D" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Holds collision data from the movement of a [PhysicsBody2D]. </brief_description> <description> ...
124039
<?xml version="1.0" encoding="UTF-8" ?> <class name="Signal" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A built-in type representing a signal of an [Object]. </brief_description> <description> [Signal] is a built-in [Variant] type that ...
124044
<?xml version="1.0" encoding="UTF-8" ?> <class name="Area2D" inherits="CollisionObject2D" keywords="trigger" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A region of 2D space that detects other [CollisionObject2D]s entering or exiting it. </...
124046
gnals> <signal name="area_entered"> <param index="0" name="area" type="Area2D" /> <description> Emitted when the received [param area] enters this area. Requires [member monitoring] to be set to [code]true[/code]. </description> </signal> <signal name="area_exited"> <param index="0" name="area" ty...
124051
<?xml version="1.0" encoding="UTF-8" ?> <class name="Control" inherits="CanvasItem" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Base class for all GUI controls. Adapts its position and size based on its parent control. </brief_description> ...
124052
<methods> <method name="_can_drop_data" qualifiers="virtual const"> <return type="bool" /> <param index="0" name="at_position" type="Vector2" /> <param index="1" name="data" type="Variant" /> <description> Godot calls this method to test if [param data] from a control's [method _get_drag_data] can be ...
124055
<method name="get_rect" qualifiers="const"> <return type="Rect2" /> <description> Returns the position and size of the control in the coordinate system of the containing node. See [member position], [member scale] and [member size]. [b]Note:[/b] If [member rotation] is not the default rotation, the result...
124057
<method name="remove_theme_color_override"> <return type="void" /> <param index="0" name="name" type="StringName" /> <description> Removes a local override for a theme [Color] with the specified [param name] previously added by [method add_theme_color_override] or via the Inspector dock. </description> ...
124058
<method name="set_end"> <return type="void" /> <param index="0" name="position" type="Vector2" /> <description> Sets [member offset_right] and [member offset_bottom] at the same time. </description> </method> <method name="set_focus_neighbor"> <return type="void" /> <param index="0" name="side...
124059
<members> <member name="anchor_bottom" type="float" setter="_set_anchor" getter="get_anchor" default="0.0"> Anchors the bottom edge of the node to the origin, the center, or the end of its parent control. It changes how the bottom offset updates when the node moves or changes size. You can use one of the [enum Anc...
124060
<member name="mouse_default_cursor_shape" type="int" setter="set_default_cursor_shape" getter="get_default_cursor_shape" enum="Control.CursorShape" default="0"> The default cursor shape for this control. Useful for Godot plugins and applications or games that use the system's mouse cursors. [b]Note:[/b] On Linux,...
124062
<constants> <constant name="FOCUS_NONE" value="0" enum="FocusMode"> The node cannot grab focus. Use with [member focus_mode]. </constant> <constant name="FOCUS_CLICK" value="1" enum="FocusMode"> The node can only grab focus on mouse clicks. Use with [member focus_mode]. </constant> <constant name="FOCUS...
124063
<constant name="CURSOR_BDIAGSIZE" value="11" enum="CursorShape"> Show the system's window resize mouse cursor when the user hovers the node. The cursor is a double-headed arrow that goes from the bottom left to the top right. It tells the user they can resize the window or the panel both horizontally and vertically....
124064
<constant name="SIZE_SHRINK_CENTER" value="4" enum="SizeFlags" is_bitfield="true"> Tells the parent [Container] to center the node in the available space. It is mutually exclusive with [constant SIZE_FILL] and other shrink size flags, but can be used with [constant SIZE_EXPAND] in some containers. Use with [member s...
124084
ethod name="is_inf"> <return type="bool" /> <param index="0" name="x" type="float" /> <description> Returns [code]true[/code] if [param x] is either positive infinity or negative infinity. </description> </method> <method name="is_instance_id_valid"> <return type="bool" /> <param index="0" nam...
124101
me="PROPERTY_HINT_TYPE_STRING" value="23" enum="PropertyHint"> If a property is [String], hints that the property represents a particular type (class). This allows to select a type from the create dialog. The property will store the selected type as a string. If a property is [Array], hints the editor how to show...
124111
<?xml version="1.0" encoding="UTF-8" ?> <class name="Label" inherits="Control" keywords="text" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A control for displaying plain text. </brief_description> <description> A control for displaying p...
124115
<?xml version="1.0" encoding="UTF-8" ?> <class name="CharacterBody3D" inherits="PhysicsBody3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A 3D physics body specialized for characters moved by script. </brief_description> <description> [...
124116
<methods> <method name="apply_floor_snap"> <return type="void" /> <description> Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when [method is_on_floor] returns [code]true[/code]. </description> </method> <method name="get_floor_angle" quali...
124117
<members> <member name="floor_block_on_wall" type="bool" setter="set_floor_block_on_wall_enabled" getter="is_floor_block_on_wall_enabled" default="true"> If [code]true[/code], the body will be able to move on the floor only. This option avoids to be able to walk on walls, it will however allow to slide down along ...
124119
<?xml version="1.0" encoding="UTF-8" ?> <class name="Shape3D" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Abstract base class for 3D shapes used for physics collision. </brief_description> <description> Abstract base ...
124121
<?xml version="1.0" encoding="UTF-8" ?> <class name="PanelContainer" inherits="Container" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A container that keeps its child controls within the area of a [StyleBox]. </brief_description> <descript...
124156
<?xml version="1.0" encoding="UTF-8" ?> <class name="RayCast3D" inherits="Node3D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A ray in 3D space, used to find the first [CollisionObject3D] it intersects. </brief_description> <description> ...
124157
<members> <member name="collide_with_areas" type="bool" setter="set_collide_with_areas" getter="is_collide_with_areas_enabled" default="false"> If [code]true[/code], collisions with [Area3D]s will be reported. </member> <member name="collide_with_bodies" type="bool" setter="set_collide_with_bodies" getter="is_...
124201
<?xml version="1.0" encoding="UTF-8" ?> <class name="VisualShaderNodeFloatParameter" inherits="VisualShaderNodeParameter" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A scalar float parameter to be used within the visual shader graph. </brie...
124231
name="texture_proxy_create" deprecated="ProxyTexture was removed in Godot 4."> <return type="RID" /> <param index="0" name="base" type="RID" /> <description> This method does nothing and always returns an invalid [RID]. </description> </method> <method name="texture_proxy_update" deprecated="ProxyTe...
124255
<?xml version="1.0" encoding="UTF-8" ?> <class name="RichTextLabel" inherits="Control" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A control for displaying text that can contain different font styles, images, and basic formatting. </brief_d...
124276
<method name="draw_style_box"> <return type="void" /> <param index="0" name="style_box" type="StyleBox" /> <param index="1" name="rect" type="Rect2" /> <description> Draws a styled rectangle. </description> </method> <method name="draw_texture"> <return type="void" /> <param index="0" name=...
124288
<?xml version="1.0" encoding="UTF-8" ?> <class name="SceneTree" inherits="MainLoop" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Manages the game loop via a hierarchy of nodes. </brief_description> <description> As one of the most importa...
124291
<members> <member name="auto_accept_quit" type="bool" setter="set_auto_accept_quit" getter="is_auto_accept_quit" default="true"> If [code]true[/code], the application automatically accepts quitting requests. For mobile platforms, see [member quit_on_go_back]. </member> <member name="current_scene" type="Nod...
124305
<method name="add_index"> <return type="void" /> <param index="0" name="index" type="int" /> <description> Adds a vertex to index array if you are using indexed vertices. Does not need to be called before adding vertices. </description> </method> <method name="add_triangle_fan"> <return type="voi...
124315
<method name="get_root_motion_rotation" qualifiers="const"> <return type="Quaternion" /> <description> Retrieve the motion delta of rotation with the [member root_motion_track] as a [Quaternion] that can be used elsewhere. If [member root_motion_track] is not a path to a track of type [constant Animation....
124326
<?xml version="1.0" encoding="UTF-8" ?> <class name="ImmediateMesh" inherits="Mesh" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Mesh optimized for creating geometry manually. </brief_description> <description> A mesh type optimized for c...
124372
<?xml version="1.0" encoding="UTF-8" ?> <class name="Quaternion" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A unit quaternion used for representing 3D rotations. </brief_description> <description> The [Quaternion] built-in [Variant] typ...
124373
<methods> <method name="angle_to" qualifiers="const"> <return type="float" /> <param index="0" name="to" type="Quaternion" /> <description> Returns the angle between this quaternion and [param to]. This is the magnitude of the angle you would need to rotate by to get from one to the other. [b]Note:[/...
124374
<members> <member name="w" type="float" setter="" getter="" default="1.0"> W component of the quaternion. This is the "real" part. [b]Note:[/b] Quaternion components should usually not be manipulated directly. </member> <member name="x" type="float" setter="" getter="" default="0.0"> X component of the q...
124380
<?xml version="1.0" encoding="UTF-8" ?> <class name="CharacterBody2D" inherits="PhysicsBody2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A 2D physics body specialized for characters moved by script. </brief_description> <description> [...
124381
<methods> <method name="apply_floor_snap"> <return type="void" /> <description> Allows to manually apply a snap to the floor regardless of the body's velocity. This function does nothing when [method is_on_floor] returns [code]true[/code]. </description> </method> <method name="get_floor_angle" quali...
124382
<members> <member name="floor_block_on_wall" type="bool" setter="set_floor_block_on_wall_enabled" getter="is_floor_block_on_wall_enabled" default="true"> If [code]true[/code], the body will be able to move on the floor only. This option avoids to be able to walk on walls, it will however allow to slide down along ...
124407
<?xml version="1.0" encoding="UTF-8" ?> <class name="MeshDataTool" inherits="RefCounted" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Helper tool to access and edit [Mesh] data. </brief_description> <description> MeshDataTool provides acc...
124438
<?xml version="1.0" encoding="UTF-8" ?> <class name="Variant" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> The most important data type in Godot. </brief_description> <description> In computer programming, a Variant class is a class that ...
124445
<?xml version="1.0" encoding="UTF-8" ?> <class name="Area3D" inherits="CollisionObject3D" keywords="trigger" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A region of 3D space that detects other [CollisionObject3D]s entering or exiting it. </...
124462
<methods> <method name="edit_node"> <return type="void" /> <param index="0" name="node" type="Node" /> <description> Edits the given [Node]. The node will be also selected if it's inside the scene tree. </description> </method> <method name="edit_resource"> <return type="void" /> <param inde...
124532
<?xml version="1.0" encoding="UTF-8" ?> <class name="PlaneMesh" inherits="PrimitiveMesh" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Class representing a planar [PrimitiveMesh]. </brief_description> <description> Class representing a pla...
124533
<?xml version="1.0" encoding="UTF-8" ?> <class name="Node" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Base class for all scene objects. </brief_description> <description> Nodes are Godot's building blocks. They can be ...
124534
<methods> <method name="_enter_tree" qualifiers="virtual"> <return type="void" /> <description> Called when the node enters the [SceneTree] (e.g. upon instantiating, scene changing, or after calling [method add_child] in a script). If the node has children, its [method _enter_tree] callback will be called f...
124535
<method name="_unhandled_key_input" qualifiers="virtual"> <return type="void" /> <param index="0" name="event" type="InputEvent" /> <description> Called when an [InputEventKey] hasn't been consumed by [method _input] or any GUI [Control] item. It is called after [method _shortcut_input] but before [method ...
124538
<method name="get_node" qualifiers="const"> <return type="Node" /> <param index="0" name="path" type="NodePath" /> <description> Fetches a node. The [NodePath] can either be a relative path (from this node), or an absolute path (from the [member SceneTree.root]) to a node. If [param path] does not point to...
124541
<param index="1" name="keep_groups" type="bool" default="false" /> <description> Replaces this node by the given [param node]. All children of this node are moved to [param node]. If [param keep_groups] is [code]true[/code], the [param node] is added to the same groups that the replaced node is in (see [meth...
124543
_auto_translate_mode" enum="Node.AutoTranslateMode" default="0"> Defines if any text should automatically change to its translated version depending on the current locale (for nodes such as [Label], [RichTextLabel], [Window], etc.). Also decides if the node's strings should be parsed for POT generation. [b]Note:[...
124544
ription> Emitted when the child [param node] enters the [SceneTree], usually because this node entered the tree (see [signal tree_entered]), or [method add_child] has been called. This signal is emitted [i]after[/i] the child node's own [constant NOTIFICATION_ENTER_TREE] and [signal tree_entered]. </descript...
124548
<?xml version="1.0" encoding="UTF-8" ?> <class name="MainLoop" inherits="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Abstract base class for the game's main loop. </brief_description> <description> [MainLoop] is the abstract base...
124559
<?xml version="1.0" encoding="UTF-8" ?> <class name="Object" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> Base class for all other classes in the engine. </brief_description> <description> An advanced [Variant] type. All classes in the en...
124560
<methods> <method name="_get" qualifiers="virtual"> <return type="Variant" /> <param index="0" name="property" type="StringName" /> <description> Override this method to customize the behavior of [method get]. Should return the given [param property]'s value, or [code]null[/code] if the [param property] ...
124561
<method name="_iter_next" qualifiers="virtual"> <return type="bool" /> <param index="0" name="iter" type="Array" /> <description> Moves the iterator to the next iteration. [param iter] stores the iteration state. Since GDScript does not support passing arguments by reference, a single-element array is used...
124563
<method name="connect"> <return type="int" enum="Error" /> <param index="0" name="signal" type="StringName" /> <param index="1" name="callable" type="Callable" /> <param index="2" name="flags" type="int" default="0" /> <description> Connects a [param signal] by name to a [param callable]. Optional [p...
124564
<method name="emit_signal" qualifiers="vararg"> <return type="int" enum="Error" /> <param index="0" name="signal" type="StringName" /> <description> Emits the given [param signal] by name. The signal must exist, so it should be a built-in signal of this class or one of its inherited classes, or a user-defi...
124565
<method name="get_method_list" qualifiers="const"> <return type="Dictionary[]" /> <description> Returns this object's methods and their signatures as an [Array] of dictionaries. Each [Dictionary] contains the following entries: - [code]name[/code] is the name of the method, as a [String]; - [code]args...
124626
<?xml version="1.0" encoding="UTF-8" ?> <class name="Script" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd"> <brief_description> A class stored as a resource. </brief_description> <description> A class stored as a resource. A script extends ...
124653
<brief_description> A 2D physics body that is moved by a physics simulation. </brief_description> <description> [RigidBody2D] implements full 2D physics. It cannot be controlled directly, instead, you must apply forces to it (gravity, impulses, etc.), and the physics simulation will calculate the resulting moveme...
124659
<method name="area_set_monitor_callback"> <return type="void" /> <param index="0" name="area" type="RID" /> <param index="1" name="callback" type="Callable" /> <description> Sets the area's body monitor callback. This callback will be called when any other (shape of a) body enters or exits (a shape of) ...