Node

package
v0.0.0-...-660914d Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 31, 2025 License: MIT Imports: 19 Imported by: 0

Documentation

Overview

Package Node provides methods for working with Node object instances.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func PrintOrphanNodes 

func PrintOrphanNodes()

Prints all orphan nodes (nodes outside the [SceneTree]). Useful for debugging. [b]Note:[/b] This method only works in debug builds. Does nothing in a project exported in release mode.

Types

type Advanced 

type Advanced = class

Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.

type Any 

type Any interface {
	gd.IsClass
	AsNode() Instance
}

type AutoTranslateMode 

type AutoTranslateMode = gdclass.NodeAutoTranslateMode //gd:Node.AutoTranslateMode

const (
	/*Inherits [member auto_translate_mode] from the node's parent. This is the default for any newly created node.*/
	AutoTranslateModeInherit AutoTranslateMode = 0
	/*Always automatically translate. This is the inverse of [constant AUTO_TRANSLATE_MODE_DISABLED], and the default for the root node.*/
	AutoTranslateModeAlways AutoTranslateMode = 1
	/*Never automatically translate. This is the inverse of [constant AUTO_TRANSLATE_MODE_ALWAYS].
	  String parsing for POT generation will be skipped for this node and children that are set to [constant AUTO_TRANSLATE_MODE_INHERIT].*/
	AutoTranslateModeDisabled AutoTranslateMode = 2
)

type DuplicateFlags 

type DuplicateFlags = gdclass.NodeDuplicateFlags //gd:Node.DuplicateFlags

const (
	/*Duplicate the node's signal connections.*/
	DuplicateSignals DuplicateFlags = 1
	/*Duplicate the node's groups.*/
	DuplicateGroups DuplicateFlags = 2
	/*Duplicate the node's script (also overriding the duplicated children's scripts, if combined with [constant DUPLICATE_USE_INSTANTIATION]).*/
	DuplicateScripts DuplicateFlags = 4
	/*Duplicate using [method PackedScene.instantiate]. If the node comes from a scene saved on disk, re-uses [method PackedScene.instantiate] as the base for the duplicated node and its children.*/
	DuplicateUseInstantiation DuplicateFlags = 8
)

type Implementation 

type Implementation = implementation

Implementation implements Interface with empty methods.

type Instance 

type Instance [1]gdclass.Node

Nodes are Godot's building blocks. They can be assigned as the child of another node, resulting in a tree arrangement. A given node can contain any number of nodes as children with the requirement that all siblings (direct children of a node) should have unique names. A tree of nodes is called a [i]scene[/i]. Scenes can be saved to the disk and then instantiated into other scenes. This allows for very high flexibility in the architecture and data model of Godot projects. [b]Scene tree:[/b] The [SceneTree] contains the active tree of nodes. When a node is added to the scene tree, it receives the [constant NOTIFICATION_ENTER_TREE] notification and its [method _enter_tree] callback is triggered. Child nodes are always added [i]after[/i] their parent node, i.e. the [method _enter_tree] callback of a parent node will be triggered before its child's. Once all nodes have been added in the scene tree, they receive the [constant NOTIFICATION_READY] notification and their respective [method _ready] callbacks are triggered. For groups of nodes, the [method _ready] callback is called in reverse order, starting with the children and moving up to the parent nodes. This means that when adding a node to the scene tree, the following order will be used for the callbacks: [method _enter_tree] of the parent, [method _enter_tree] of the children, [method _ready] of the children and finally [method _ready] of the parent (recursively for the entire scene tree). [b]Processing:[/b] Nodes can override the "process" state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback [method _process], toggled with [method set_process]) happens as fast as possible and is dependent on the frame rate, so the processing time [i]delta[/i] (in seconds) is passed as an argument. Physics processing (callback [method _physics_process], toggled with [method set_physics_process]) happens a fixed number of times per second (60 by default) and is useful for code related to the physics engine. Nodes can also process input events. When present, the [method _input] function will be called for each input that the program receives. In many cases, this can be overkill (unless used for simple projects), and the [method _unhandled_input] function might be preferred; it is called when the input event was not handled by anyone else (typically, GUI [Control] nodes), ensuring that the node only receives the events that were meant for it. To keep track of the scene hierarchy (especially when instantiating scenes into other scenes), an "owner" can be set for the node with the [member owner] property. This keeps track of who instantiated what. This is mostly useful when writing editors and tools, though. Finally, when a node is freed with [method Object.free] or [method queue_free], it will also free all its children. [b]Groups:[/b] Nodes can be added to as many groups as you want to be easy to manage, you could create groups like "enemies" or "collectables" for example, depending on your game. See [method add_to_group], [method is_in_group] and [method remove_from_group]. You can then retrieve all nodes in these groups, iterate them and even call methods on groups via the methods on [SceneTree]. [b]Networking with nodes:[/b] After connecting to a server (or making one, see [ENetMultiplayerPeer]), it is possible to use the built-in RPC (remote procedure call) system to communicate over the network. By calling [method rpc] with a method name, it will be called locally and in all connected peers (peers = clients and the server that accepts connections). To identify which node receives the RPC call, Godot will use its [NodePath] (make sure node names are the same on all peers). Also, take a look at the high-level networking tutorial and corresponding demos. [b]Note:[/b] The [code]script[/code] property is part of the [Object] class, not [Node]. It isn't exposed like most properties but does have a setter and getter (see [method Object.set_script] and [method Object.get_script]). 

See [Interface] for methods that can be overridden by a [Class] that extends it.

%!(EXTRA string=Node) 

var Nil Instance

Nil is a nil/null instance of the class. Equivalent to the zero value.

func New 

func New() Instance

func (Instance) AddChild 

func (self Instance) AddChild(node [1]gdclass.Node)

Adds a child [param node]. Nodes can have any number of children, but every child must have a unique name. Child nodes are automatically deleted when the parent node is deleted, so an entire scene can be removed by deleting its topmost node. If [param force_readable_name] is [code]true[/code], improves the readability of the added [param node]. If not named, the [param node] is renamed to its type, and if it shares [member name] with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to [code]false[/code], which assigns a dummy name featuring [code]@[/code] in both situations. If [param internal] is different than [constant INTERNAL_MODE_DISABLED], the child will be added as internal node. These nodes are ignored by methods like [method get_children], unless their parameter [code]include_internal[/code] is [code]true[/code]. The intended usage is to hide the internal nodes from the user, so the user won't accidentally delete or modify them. Used by some GUI nodes, e.g. [ColorPicker]. See [enum InternalMode] for available modes. [b]Note:[/b] If [param node] already has a parent, this method will fail. Use [method remove_child] first to remove [param node] from its current parent. For example: [codeblocks] [gdscript] var child_node = get_child(0) if child_node.get_parent(): 

child_node.get_parent().remove_child(child_node)

add_child(child_node) [/gdscript] [csharp] Node childNode = GetChild(0); if (childNode.GetParent() != null) 

{
    childNode.GetParent().RemoveChild(childNode);
}

AddChild(childNode); [/csharp] [/codeblocks] If you need the child node to be added below a specific node in the list of children, use [method add_sibling] instead of this method. [b]Note:[/b] If you want a child to be persisted to a [PackedScene], you must set [member owner] in addition to calling [method add_child]. This is typically relevant for [url=$DOCS_URL/tutorials/plugins/running_code_in_the_editor.html]tool scripts[/url] and [url=$DOCS_URL/tutorials/plugins/editor/index.html]editor plugins[/url]. If [method add_child] is called without setting [member owner], the newly added [Node] will not be visible in the scene tree, though it will be visible in the 2D/3D view.

func (Instance) AddSibling 

func (self Instance) AddSibling(sibling [1]gdclass.Node)

Adds a [param sibling] node to this node's parent, and moves the added sibling right below this node. If [param force_readable_name] is [code]true[/code], improves the readability of the added [param sibling]. If not named, the [param sibling] is renamed to its type, and if it shares [member name] with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to [code]false[/code], which assigns a dummy name featuring [code]@[/code] in both situations. Use [method add_child] instead of this method if you don't need the child node to be added below a specific node in the list of children. [b]Note:[/b] If this node is internal, the added sibling will be internal too (see [method add_child]'s [code]internal[/code] parameter).

func (Instance) AddToGroup 

func (self Instance) AddToGroup(group string)

Adds the node to the [param group]. Groups can be helpful to organize a subset of nodes, for example [code]"enemies"[/code] or [code]"collectables"[/code]. See notes in the description, and the group methods in [SceneTree]. If [param persistent] is [code]true[/code], the group will be stored when saved inside a [PackedScene]. All groups created and displayed in the Node dock are persistent. [b]Note:[/b] To improve performance, the order of group names is [i]not[/i] guaranteed and may vary between project runs. Therefore, do not rely on the group order. [b]Note:[/b] [SceneTree]'s group methods will [i]not[/i] work on this node if not inside the tree (see [method is_inside_tree]).

func (Instance) AsNode 

func (self Instance) AsNode() Instance

func (Instance) AsObject 

func (self Instance) AsObject() [1]gd.Object

func (Instance) Atr 

func (self Instance) Atr(message string) string

Translates a [param message], using the translation catalogs configured in the Project Settings. Further [param context] can be specified to help with the translation. Note that most [Control] nodes automatically translate their strings, so this method is mostly useful for formatted strings or custom drawn text. This method works the same as [method Object.tr], with the addition of respecting the [member auto_translate_mode] state. If [method Object.can_translate_messages] is [code]false[/code], or no translation is available, this method returns the [param message] without changes. See [method Object.set_message_translation]. For detailed examples, see [url=$DOCS_URL/tutorials/i18n/internationalizing_games.html]Internationalizing games[/url].

func (Instance) AtrN 

func (self Instance) AtrN(message string, plural_message string, n int) string

Translates a [param message] or [param plural_message], using the translation catalogs configured in the Project Settings. Further [param context] can be specified to help with the translation. This method works the same as [method Object.tr_n], with the addition of respecting the [member auto_translate_mode] state. If [method Object.can_translate_messages] is [code]false[/code], or no translation is available, this method returns [param message] or [param plural_message], without changes. See [method Object.set_message_translation]. The [param n] is the number, or amount, of the message's subject. It is used by the translation system to fetch the correct plural form for the current language. For detailed examples, see [url=$DOCS_URL/tutorials/i18n/localization_using_gettext.html]Localization using gettext[/url]. [b]Note:[/b] Negative and [float] numbers may not properly apply to some countable subjects. It's recommended to handle these cases with [method atr].

func (Instance) AutoTranslateMode 

func (self Instance) AutoTranslateMode() gdclass.NodeAutoTranslateMode

func (Instance) CanProcess 

func (self Instance) CanProcess() bool

Returns [code]true[/code] if the node can receive processing notifications and input callbacks ([constant NOTIFICATION_PROCESS], [method _input], etc.) from the [SceneTree] and [Viewport]. The returned value depends on [member process_mode]: - If set to [constant PROCESS_MODE_PAUSABLE], returns [code]true[/code] when the game is processing, i.e. [member SceneTree.paused] is [code]false[/code]; - If set to [constant PROCESS_MODE_WHEN_PAUSED], returns [code]true[/code] when the game is paused, i.e. [member SceneTree.paused] is [code]true[/code]; - If set to [constant PROCESS_MODE_ALWAYS], always returns [code]true[/code]; - If set to [constant PROCESS_MODE_DISABLED], always returns [code]false[/code]; - If set to [constant PROCESS_MODE_INHERIT], use the parent node's [member process_mode] to determine the result. If the node is not inside the tree, returns [code]false[/code] no matter the value of [member process_mode].

func (Instance) CreateTween 

func (self Instance) CreateTween() [1]gdclass.Tween

Creates a new [Tween] and binds it to this node. This is the equivalent of doing: [codeblocks] [gdscript] get_tree().create_tween().bind_node(self) [/gdscript] [csharp] GetTree().CreateTween().BindNode(this); [/csharp] [/codeblocks] The Tween will start automatically on the next process frame or physics frame (depending on [enum Tween.TweenProcessMode]). See [method Tween.bind_node] for more info on Tweens bound to nodes. [b]Note:[/b] The method can still be used when the node is not inside [SceneTree]. It can fail in an unlikely case of using a custom [MainLoop].

func (Instance) Duplicate 

func (self Instance) Duplicate() [1]gdclass.Node

Duplicates the node, returning a new node with all of its properties, signals and groups copied from the original. The behavior can be tweaked through the [param flags] (see [enum DuplicateFlags]). [b]Note:[/b] For nodes with a [Script] attached, if [method Object._init] has been defined with required parameters, the duplicated node will not have a [Script].

func (Instance) EditorDescription 

func (self Instance) EditorDescription() string

func (Instance) FindChild 

func (self Instance) FindChild(pattern string) [1]gdclass.Node

Finds the first descendant of this node whose [member name] matches [param pattern], returning [code]null[/code] if no match is found. The matching is done against node names, [i]not[/i] their paths, through [method String.match]. As such, it is case-sensitive, [code]"*"[/code] matches zero or more characters, and [code]"?"[/code] matches any single character. If [param recursive] is [code]false[/code], only this node's direct children are checked. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. Internal children are also included in the search (see [code]internal[/code] parameter in [method add_child]). If [param owned] is [code]true[/code], only descendants with a valid [member owner] node are checked. [b]Note:[/b] This method can be very slow. Consider storing a reference to the found node in a variable. Alternatively, use [method get_node] with unique names (see [member unique_name_in_owner]). [b]Note:[/b] To find all descendant nodes matching a pattern or a class type, see [method find_children].

func (Instance) FindChildren 

func (self Instance) FindChildren(pattern string) [][1]gdclass.Node

Finds all descendants of this node whose names match [param pattern], returning an empty [Array] if no match is found. The matching is done against node names, [i]not[/i] their paths, through [method String.match]. As such, it is case-sensitive, [code]"*"[/code] matches zero or more characters, and [code]"?"[/code] matches any single character. If [param type] is not empty, only ancestors inheriting from [param type] are included (see [method Object.is_class]). If [param recursive] is [code]false[/code], only this node's direct children are checked. Nodes are checked in tree order, so this node's first direct child is checked first, then its own direct children, etc., before moving to the second direct child, and so on. Internal children are also included in the search (see [code]internal[/code] parameter in [method add_child]). If [param owned] is [code]true[/code], only descendants with a valid [member owner] node are checked. [b]Note:[/b] This method can be very slow. Consider storing references to the found nodes in a variable. [b]Note:[/b] To find a single descendant node matching a pattern, see [method find_child].

func (Instance) FindParent 

func (self Instance) FindParent(pattern string) [1]gdclass.Node

Finds the first ancestor of this node whose [member name] matches [param pattern], returning [code]null[/code] if no match is found. The matching is done through [method String.match]. As such, it is case-sensitive, [code]"*"[/code] matches zero or more characters, and [code]"?"[/code] matches any single character. See also [method find_child] and [method find_children]. [b]Note:[/b] As this method walks upwards in the scene tree, it can be slow in large, deeply nested nodes. Consider storing a reference to the found node in a variable. Alternatively, use [method get_node] with unique names (see [member unique_name_in_owner]).

func (Instance) GetChild 

func (self Instance) GetChild(idx int) [1]gdclass.Node

Fetches a child node by its index. Each child node has an index relative its siblings (see [method get_index]). The first child is at index 0. Negative values can also be used to start from the end of the list. This method can be used in combination with [method get_child_count] to iterate over this node's children. If no child exists at the given index, this method returns [code]null[/code] and an error is generated. If [param include_internal] is [code]false[/code], internal children are ignored (see [method add_child]'s [code]internal[/code] parameter). [codeblock] # Assuming the following are children of this node, in order: # First, Middle, Last.

var a = get_child(0).name # a is "First" var b = get_child(1).name # b is "Middle" var b = get_child(2).name # b is "Last" var c = get_child(-1).name # c is "Last" [/codeblock] [b]Note:[/b] To fetch a node by [NodePath], use [method get_node].

func (Instance) GetChildCount 

func (self Instance) GetChildCount() int

Returns the number of children of this node. If [param include_internal] is [code]false[/code], internal children are not counted (see [method add_child]'s [code]internal[/code] parameter).

func (Instance) GetChildren 

func (self Instance) GetChildren() [][1]gdclass.Node

Returns all children of this node inside an [Array]. If [param include_internal] is [code]false[/code], excludes internal children from the returned array (see [method add_child]'s [code]internal[/code] parameter).

func (Instance) GetGroups 

func (self Instance) GetGroups() []string

Returns an [Array] of group names that the node has been added to. [b]Note:[/b] To improve performance, the order of group names is [i]not[/i] guaranteed and may vary between project runs. Therefore, do not rely on the group order. [b]Note:[/b] This method may also return some group names starting with an underscore ([code]_[/code]). These are internally used by the engine. To avoid conflicts, do not use custom groups starting with underscores. To exclude internal groups, see the following code snippet: [codeblocks] [gdscript] # Stores the node's non-internal groups only (as an array of StringNames). var non_internal_groups = [] for group in get_groups(): 

if not str(group).begins_with("_"):
    non_internal_groups.push_back(group)

[/gdscript] [csharp] // Stores the node's non-internal groups only (as a List of StringNames). List<string> nonInternalGroups = new List<string>(); foreach (string group in GetGroups()) 

{
    if (!group.BeginsWith("_"))
        nonInternalGroups.Add(group);
}

[/csharp] [/codeblocks]

func (Instance) GetIndex 

func (self Instance) GetIndex() int

Returns this node's order among its siblings. The first node's index is [code]0[/code]. See also [method get_child]. If [param include_internal] is [code]false[/code], returns the index ignoring internal children. The first, non-internal child will have an index of [code]0[/code] (see [method add_child]'s [code]internal[/code] parameter).

func (Instance) GetLastExclusiveWindow 

func (self Instance) GetLastExclusiveWindow() [1]gdclass.Window

Returns the [Window] that contains this node, or the last exclusive child in a chain of windows starting with the one that contains this node.

func (Instance) GetMultiplayerAuthority 

func (self Instance) GetMultiplayerAuthority() int

Returns the peer ID of the multiplayer authority for this node. See [method set_multiplayer_authority].

func (Instance) GetNode 

func (self Instance) GetNode(path string) [1]gdclass.Node

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 a valid node, generates an error and returns [code]null[/code]. Attempts to access methods on the return value will result in an [i]"Attempt to call <method> on a null instance."[/i] error. [b]Note:[/b] Fetching by absolute path only works when the node is inside the scene tree (see [method is_inside_tree]). [b]Example:[/b] Assume this method is called from the Character node, inside the following tree: [codeblock lang=text] 

┖╴root
   ┠╴Character (you are here!)
   ┃  ┠╴Sword
   ┃  ┖╴Backpack
   ┃     ┖╴Dagger
   ┠╴MyGame
   ┖╴Swamp
      ┠╴Alligator
      ┠╴Mosquito
      ┖╴Goblin

[/codeblock] The following calls will return a valid node: [codeblocks] [gdscript] get_node("Sword") get_node("Backpack/Dagger") get_node("../Swamp/Alligator") get_node("/root/MyGame") [/gdscript] [csharp] GetNode("Sword"); GetNode("Backpack/Dagger"); GetNode("../Swamp/Alligator"); GetNode("/root/MyGame"); [/csharp] [/codeblocks]

func (Instance) GetNodeAndResource 

func (self Instance) GetNodeAndResource(path string) []any

Fetches a node and its most nested resource as specified by the [NodePath]'s subname. Returns an [Array] of size [code]3[/code] where: - Element [code]0[/code] is the [Node], or [code]null[/code] if not found; - Element [code]1[/code] is the subname's last nested [Resource], or [code]null[/code] if not found; - Element [code]2[/code] is the remaining [NodePath], referring to an existing, non-[Resource] property (see [method Object.get_indexed]). [b]Example:[/b] Assume that the child's [member Sprite2D.texture] has been assigned a [AtlasTexture]: [codeblocks] [gdscript] var a = get_node_and_resource("Area2D/Sprite2D") print(a[0].name) # Prints Sprite2D print(a[1]) # Prints <null> print(a[2]) # Prints ^""

var b = get_node_and_resource("Area2D/Sprite2D:texture:atlas") print(b[0].name) # Prints Sprite2D print(b[1].get_class()) # Prints AtlasTexture print(b[2]) # Prints ^""

var c = get_node_and_resource("Area2D/Sprite2D:texture:atlas:region") print(c[0].name) # Prints Sprite2D print(c[1].get_class()) # Prints AtlasTexture print(c[2]) # Prints ^":region" [/gdscript] [csharp] var a = GetNodeAndResource(NodePath("Area2D/Sprite2D")); GD.Print(a[0].Name); // Prints Sprite2D GD.Print(a[1]); // Prints <null> GD.Print(a[2]); // Prints ^"

var b = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas")); GD.Print(b[0].name); // Prints Sprite2D GD.Print(b[1].get_class()); // Prints AtlasTexture GD.Print(b[2]); // Prints ^""

var c = GetNodeAndResource(NodePath("Area2D/Sprite2D:texture:atlas:region")); GD.Print(c[0].name); // Prints Sprite2D GD.Print(c[1].get_class()); // Prints AtlasTexture GD.Print(c[2]); // Prints ^":region" [/csharp] [/codeblocks]

func (Instance) GetNodeOrNull 

func (self Instance) GetNodeOrNull(path string) [1]gdclass.Node

Fetches a node by [NodePath]. Similar to [method get_node], but does not generate an error if [param path] does not point to a valid node.

func (Instance) GetParent 

func (self Instance) GetParent() [1]gdclass.Node

Returns this node's parent node, or [code]null[/code] if the node doesn't have a parent.

func (Instance) GetPath 

func (self Instance) GetPath() string

Returns the node's absolute path, relative to the [member SceneTree.root]. If the node is not inside the scene tree, this method fails and returns an empty [NodePath].

func (Instance) GetPathTo 

func (self Instance) GetPathTo(node [1]gdclass.Node) string

Returns the relative [NodePath] from this node to the specified [param node]. Both nodes must be in the same [SceneTree] or scene hierarchy, otherwise this method fails and returns an empty [NodePath]. If [param use_unique_path] is [code]true[/code], returns the shortest path accounting for this node's unique name (see [member unique_name_in_owner]). [b]Note:[/b] If you get a relative path which starts from a unique node, the path may be longer than a normal relative path, due to the addition of the unique node's name.

func (Instance) GetPhysicsProcessDeltaTime 

func (self Instance) GetPhysicsProcessDeltaTime() Float.X

Returns the time elapsed (in seconds) since the last physics callback. This value is identical to [method _physics_process]'s [code]delta[/code] parameter, and is often consistent at run-time, unless [member Engine.physics_ticks_per_second] is changed. See also [constant NOTIFICATION_PHYSICS_PROCESS].

func (Instance) GetProcessDeltaTime 

func (self Instance) GetProcessDeltaTime() Float.X

Returns the time elapsed (in seconds) since the last process callback. This value is identical to [method _process]'s [code]delta[/code] parameter, and may vary from frame to frame. See also [constant NOTIFICATION_PROCESS].

func (Instance) GetSceneInstanceLoadPlaceholder 

func (self Instance) GetSceneInstanceLoadPlaceholder() bool

Returns [code]true[/code] if this node is an instance load placeholder. See [InstancePlaceholder] and [method set_scene_instance_load_placeholder].

func (Instance) GetTree 

func (self Instance) GetTree() [1]gdclass.SceneTree

Returns the [SceneTree] that contains this node. If this node is not inside the tree, generates an error and returns [code]null[/code]. See also [method is_inside_tree].

func (Instance) GetTreeString 

func (self Instance) GetTreeString() string

Returns the tree as a [String]. Used mainly for debugging purposes. This version displays the path relative to the current node, and is good for copy/pasting into the [method get_node] function. It also can be used in game UI/UX. May print, for example: [codeblock lang=text] TheGame TheGame/Menu TheGame/Menu/Label TheGame/Menu/Camera2D TheGame/SplashScreen TheGame/SplashScreen/Camera2D [/codeblock]

func (Instance) GetTreeStringPretty 

func (self Instance) GetTreeStringPretty() string

Similar to [method get_tree_string], this returns the tree as a [String]. This version displays a more graphical representation similar to what is displayed in the Scene Dock. It is useful for inspecting larger trees. May print, for example: [codeblock lang=text] 

┖╴TheGame
   ┠╴Menu
   ┃  ┠╴Label
   ┃  ┖╴Camera2D
   ┖╴SplashScreen
      ┖╴Camera2D

[/codeblock]

func (Instance) GetViewport 

func (self Instance) GetViewport() [1]gdclass.Viewport

Returns the node's closest [Viewport] ancestor, if the node is inside the tree. Otherwise, returns [code]null[/code].

func (Instance) GetWindow 

func (self Instance) GetWindow() [1]gdclass.Window

Returns the [Window] that contains this node. If the node is in the main window, this is equivalent to getting the root node ([code]get_tree().get_root()[/code]).

func (Instance) HasNode 

func (self Instance) HasNode(path string) bool

Returns [code]true[/code] if the [param path] points to a valid node. See also [method get_node].

func (Instance) HasNodeAndResource 

func (self Instance) HasNodeAndResource(path string) bool

Returns [code]true[/code] if [param path] points to a valid node and its subnames point to a valid [Resource], e.g. [code]Area2D/CollisionShape2D:shape[/code]. Properties that are not [Resource] types (such as nodes or other [Variant] types) are not considered. See also [method get_node_and_resource].

func (Instance) IsAncestorOf 

func (self Instance) IsAncestorOf(node [1]gdclass.Node) bool

Returns [code]true[/code] if the given [param node] is a direct or indirect child of this node.

func (Instance) IsDisplayedFolded 

func (self Instance) IsDisplayedFolded() bool

Returns [code]true[/code] if the node is folded (collapsed) in the Scene dock. This method is intended to be used in editor plugins and tools. See also [method set_display_folded].

func (Instance) IsEditableInstance 

func (self Instance) IsEditableInstance(node [1]gdclass.Node) bool

Returns [code]true[/code] if [param node] has editable children enabled relative to this node. This method is intended to be used in editor plugins and tools. See also [method set_editable_instance].

func (Instance) IsGreaterThan 

func (self Instance) IsGreaterThan(node [1]gdclass.Node) bool

Returns [code]true[/code] if the given [param node] occurs later in the scene hierarchy than this node. A node occurring later is usually processed last.

func (Instance) IsInGroup 

func (self Instance) IsInGroup(group string) bool

Returns [code]true[/code] if this node has been added to the given [param group]. See [method add_to_group] and [method remove_from_group]. See also notes in the description, and the [SceneTree]'s group methods.

func (Instance) IsInsideTree 

func (self Instance) IsInsideTree() bool

Returns [code]true[/code] if this node is currently inside a [SceneTree]. See also [method get_tree].

func (Instance) IsMultiplayerAuthority 

func (self Instance) IsMultiplayerAuthority() bool

Returns [code]true[/code] if the local system is the multiplayer authority of this node.

func (Instance) IsNodeReady 

func (self Instance) IsNodeReady() bool

Returns [code]true[/code] if the node is ready, i.e. it's inside scene tree and all its children are initialized. [method request_ready] resets it back to [code]false[/code].

func (Instance) IsPartOfEditedScene 

func (self Instance) IsPartOfEditedScene() bool

Returns [code]true[/code] if the node is part of the scene currently opened in the editor.

func (Instance) IsPhysicsInterpolated 

func (self Instance) IsPhysicsInterpolated() bool

Returns [code]true[/code] if physics interpolation is enabled for this node (see [member physics_interpolation_mode]). [b]Note:[/b] Interpolation will only be active if both the flag is set [b]and[/b] physics interpolation is enabled within the [SceneTree]. This can be tested using [method is_physics_interpolated_and_enabled].

func (Instance) IsPhysicsInterpolatedAndEnabled 

func (self Instance) IsPhysicsInterpolatedAndEnabled() bool

Returns [code]true[/code] if physics interpolation is enabled (see [member physics_interpolation_mode]) [b]and[/b] enabled in the [SceneTree]. This is a convenience version of [method is_physics_interpolated] that also checks whether physics interpolation is enabled globally. See [member SceneTree.physics_interpolation] and [member ProjectSettings.physics/common/physics_interpolation].

func (Instance) IsPhysicsProcessing 

func (self Instance) IsPhysicsProcessing() bool

Returns [code]true[/code] if physics processing is enabled (see [method set_physics_process]).

func (Instance) IsPhysicsProcessingInternal 

func (self Instance) IsPhysicsProcessingInternal() bool

Returns [code]true[/code] if internal physics processing is enabled (see [method set_physics_process_internal]).

func (Instance) IsProcessing 

func (self Instance) IsProcessing() bool

Returns [code]true[/code] if processing is enabled (see [method set_process]).

func (Instance) IsProcessingInput 

func (self Instance) IsProcessingInput() bool

Returns [code]true[/code] if the node is processing input (see [method set_process_input]).

func (Instance) IsProcessingInternal 

func (self Instance) IsProcessingInternal() bool

Returns [code]true[/code] if internal processing is enabled (see [method set_process_internal]).

func (Instance) IsProcessingShortcutInput 

func (self Instance) IsProcessingShortcutInput() bool

Returns [code]true[/code] if the node is processing shortcuts (see [method set_process_shortcut_input]).

func (Instance) IsProcessingUnhandledInput 

func (self Instance) IsProcessingUnhandledInput() bool

Returns [code]true[/code] if the node is processing unhandled input (see [method set_process_unhandled_input]).

func (Instance) IsProcessingUnhandledKeyInput 

func (self Instance) IsProcessingUnhandledKeyInput() bool

Returns [code]true[/code] if the node is processing unhandled key input (see [method set_process_unhandled_key_input]).

func (Instance) IsQueuedForDeletion 

func (self Instance) IsQueuedForDeletion() bool

IsQueuedForDeletion returns true if the Instance.QueueFree method was called for the object.

func (Instance) MoveChild 

func (self Instance) MoveChild(child_node [1]gdclass.Node, to_index int)

Moves [param child_node] to the given index. A node's index is the order among its siblings. If [param to_index] is negative, the index is counted from the end of the list. See also [method get_child] and [method get_index]. [b]Note:[/b] The processing order of several engine callbacks ([method _ready], [method _process], etc.) and notifications sent through [method propagate_notification] is affected by tree order. [CanvasItem] nodes are also rendered in tree order. See also [member process_priority].

func (Instance) Multiplayer 

func (self Instance) Multiplayer() [1]gdclass.MultiplayerAPI

func (Instance) Name 

func (self Instance) Name() string

func (Instance) NotifyDeferredThreadGroup 

func (self Instance) NotifyDeferredThreadGroup(what int)

Similar to [method call_deferred_thread_group], but for notifications.

func (Instance) NotifyThreadSafe 

func (self Instance) NotifyThreadSafe(what int)

Similar to [method call_thread_safe], but for notifications.

func (Instance) OnChildEnteredTree 

func (self Instance) OnChildEnteredTree(cb func(node [1]gdclass.Node))

func (Instance) OnChildExitingTree 

func (self Instance) OnChildExitingTree(cb func(node [1]gdclass.Node))

func (Instance) OnChildOrderChanged 

func (self Instance) OnChildOrderChanged(cb func())

func (Instance) OnEditorDescriptionChanged 

func (self Instance) OnEditorDescriptionChanged(cb func(node [1]gdclass.Node))

func (Instance) OnReady 

func (self Instance) OnReady(cb func())

func (Instance) OnRenamed 

func (self Instance) OnRenamed(cb func())

func (Instance) OnReplacingBy 

func (self Instance) OnReplacingBy(cb func(node [1]gdclass.Node))

func (Instance) OnTreeEntered 

func (self Instance) OnTreeEntered(cb func())

func (Instance) OnTreeExited 

func (self Instance) OnTreeExited(cb func())

func (Instance) OnTreeExiting 

func (self Instance) OnTreeExiting(cb func())

func (Instance) Owner 

func (self Instance) Owner() [1]gdclass.Node

func (Instance) PhysicsInterpolationMode 

func (self Instance) PhysicsInterpolationMode() gdclass.NodePhysicsInterpolationMode

func (Instance) PrintTree 

func (self Instance) PrintTree()

Prints the node and its children to the console, recursively. The node does not have to be inside the tree. This method outputs [NodePath]s relative to this node, and is good for copy/pasting into [method get_node]. See also [method print_tree_pretty]. May print, for example: [codeblock lang=text] . Menu Menu/Label Menu/Camera2D SplashScreen SplashScreen/Camera2D [/codeblock]

func (Instance) PrintTreePretty 

func (self Instance) PrintTreePretty()

Prints the node and its children to the console, recursively. The node does not have to be inside the tree. Similar to [method print_tree], but the graphical representation looks like what is displayed in the editor's Scene dock. It is useful for inspecting larger trees. May print, for example: [codeblock lang=text] 

┖╴TheGame
   ┠╴Menu
   ┃  ┠╴Label
   ┃  ┖╴Camera2D
   ┖╴SplashScreen
      ┖╴Camera2D

[/codeblock]

func (Instance) ProcessMode 

func (self Instance) ProcessMode() gdclass.NodeProcessMode

func (Instance) ProcessPhysicsPriority 

func (self Instance) ProcessPhysicsPriority() int

func (Instance) ProcessPriority 

func (self Instance) ProcessPriority() int

func (Instance) ProcessThreadGroup 

func (self Instance) ProcessThreadGroup() gdclass.NodeProcessThreadGroup

func (Instance) ProcessThreadGroupOrder 

func (self Instance) ProcessThreadGroupOrder() int

func (Instance) ProcessThreadMessages 

func (self Instance) ProcessThreadMessages() gdclass.NodeProcessThreadMessages

func (Instance) PropagateCall 

func (self Instance) PropagateCall(method string)

Calls the given [param method] name, passing [param args] as arguments, on this node and all of its children, recursively. If [param parent_first] is [code]true[/code], the method is called on this node first, then on all of its children. If [code]false[/code], the children's methods are called first.

func (Instance) PropagateNotification 

func (self Instance) PropagateNotification(what int)

Calls [method Object.notification] with [param what] on this node and all of its children, recursively.

func (Instance) QueueFree 

func (self Instance) QueueFree()

Queues this node to be deleted at the end of the current frame. When deleted, all of its children are deleted as well, and all references to the node and its children become invalid. Unlike with [method Object.free], the node is not deleted instantly, and it can still be accessed before deletion. It is also safe to call [method queue_free] multiple times. Use [method Object.is_queued_for_deletion] to check if the node will be deleted at the end of the frame. [b]Note:[/b] The node will only be freed after all other deferred calls are finished. Using this method is not always the same as calling [method Object.free] through [method Object.call_deferred].

func (Instance) RemoveChild 

func (self Instance) RemoveChild(node [1]gdclass.Node)

Removes a child [param node]. The [param node], along with its children, are [b]not[/b] deleted. To delete a node, see [method queue_free]. [b]Note:[/b] When this node is inside the tree, this method sets the [member owner] of the removed [param node] (or its descendants) to [code]null[/code], if their [member owner] is no longer an ancestor (see [method is_ancestor_of]).

func (Instance) RemoveFromGroup 

func (self Instance) RemoveFromGroup(group string)

Removes the node from the given [param group]. Does nothing if the node is not in the [param group]. See also notes in the description, and the [SceneTree]'s group methods.

func (Instance) Reparent 

func (self Instance) Reparent(new_parent [1]gdclass.Node)

Changes the parent of this [Node] to the [param new_parent]. The node needs to already have a parent. The node's [member owner] is preserved if its owner is still reachable from the new location (i.e., the node is still a descendant of the new parent after the operation). If [param keep_global_transform] is [code]true[/code], the node's global transform will be preserved if supported. [Node2D], [Node3D] and [Control] support this argument (but [Control] keeps only position).

func (Instance) ReplaceBy 

func (self Instance) ReplaceBy(node [1]gdclass.Node)

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 [method add_to_group]). [b]Warning:[/b] The replaced node is removed from the tree, but it is [b]not[/b] deleted. To prevent memory leaks, store a reference to the node in a variable, or use [method Object.free].

func (Instance) RequestReady 

func (self Instance) RequestReady()

Requests [method _ready] to be called again the next time the node enters the tree. Does [b]not[/b] immediately call [method _ready]. [b]Note:[/b] This method only affects the current node. If the node's children also need to request ready, this method needs to be called for each one of them. When the node and its children enter the tree again, the order of [method _ready] callbacks will be the same as normal.

func (Instance) ResetPhysicsInterpolation 

func (self Instance) ResetPhysicsInterpolation()

When physics interpolation is active, moving a node to a radically different transform (such as placement within a level) can result in a visible glitch as the object is rendered moving from the old to new position over the physics tick. That glitch can be prevented by calling this method, which temporarily disables interpolation until the physics tick is complete. The notification [constant NOTIFICATION_RESET_PHYSICS_INTERPOLATION] will be received by the node and all children recursively. [b]Note:[/b] This function should be called [b]after[/b] moving the node, rather than before.

func (Instance) RpcConfig 

func (self Instance) RpcConfig(method string, config any)

Changes the RPC configuration for the given [param method]. [param config] should either be [code]null[/code] to disable the feature (as by default), or a [Dictionary] containing the following entries: - [code]rpc_mode[/code]: see [enum MultiplayerAPI.RPCMode]; - [code]transfer_mode[/code]: see [enum MultiplayerPeer.TransferMode]; - [code]call_local[/code]: if [code]true[/code], the method will also be called locally; - [code]channel[/code]: an [int] representing the channel to send the RPC on. [b]Note:[/b] In GDScript, this method corresponds to the [annotation @GDScript.@rpc] annotation, with various parameters passed ([code]@rpc(any)[/code], [code]@rpc(authority)[/code]...). See also the [url=$DOCS_URL/tutorials/networking/high_level_multiplayer.html]high-level multiplayer[/url] tutorial.

func (Instance) SceneFilePath 

func (self Instance) SceneFilePath() string

func (Instance) SetAutoTranslateMode 

func (self Instance) SetAutoTranslateMode(value gdclass.NodeAutoTranslateMode)

func (Instance) SetDeferredThreadGroup 

func (self Instance) SetDeferredThreadGroup(property string, value any)

Similar to [method call_deferred_thread_group], but for setting properties.

func (Instance) SetDisplayFolded 

func (self Instance) SetDisplayFolded(fold bool)

If set to [code]true[/code], the node appears folded in the Scene dock. As a result, all of its children are hidden. This method is intended to be used in editor plugins and tools, but it also works in release builds. See also [method is_displayed_folded].

func (Instance) SetEditableInstance 

func (self Instance) SetEditableInstance(node [1]gdclass.Node, is_editable bool)

Set to [code]true[/code] to allow all nodes owned by [param node] to be available, and editable, in the Scene dock, even if their [member owner] is not the scene root. This method is intended to be used in editor plugins and tools, but it also works in release builds. See also [method is_editable_instance].

func (Instance) SetEditorDescription 

func (self Instance) SetEditorDescription(value string)

func (Instance) SetMultiplayerAuthority 

func (self Instance) SetMultiplayerAuthority(id int)

Sets the node's multiplayer authority to the peer with the given peer [param id]. The multiplayer authority is the peer that has authority over the node on the network. Defaults to peer ID 1 (the server). Useful in conjunction with [method rpc_config] and the [MultiplayerAPI]. If [param recursive] is [code]true[/code], the given peer is recursively set as the authority for all children of this node. [b]Warning:[/b] This does [b]not[/b] automatically replicate the new authority to other peers. It is the developer's responsibility to do so. You may replicate the new authority's information using [member MultiplayerSpawner.spawn_function], an RPC, or a [MultiplayerSynchronizer]. Furthermore, the parent's authority does [b]not[/b] propagate to newly added children.

func (Instance) SetName 

func (self Instance) SetName(value string)

func (Instance) SetOwner 

func (self Instance) SetOwner(value [1]gdclass.Node)

func (Instance) SetPhysicsInterpolationMode 

func (self Instance) SetPhysicsInterpolationMode(value gdclass.NodePhysicsInterpolationMode)

func (Instance) SetPhysicsProcess 

func (self Instance) SetPhysicsProcess(enable bool)

If set to [code]true[/code], enables physics (fixed framerate) processing. When a node is being processed, it will receive a [constant NOTIFICATION_PHYSICS_PROCESS] at a fixed (usually 60 FPS, see [member Engine.physics_ticks_per_second] to change) interval (and the [method _physics_process] callback will be called if it exists). [b]Note:[/b] If [method _physics_process] is overridden, this will be automatically enabled before [method _ready] is called.

func (Instance) SetPhysicsProcessInternal 

func (self Instance) SetPhysicsProcessInternal(enable bool)

If set to [code]true[/code], enables internal physics for this node. Internal physics processing happens in isolation from the normal [method _physics_process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or physics processing is disabled for scripting ([method set_physics_process]). [b]Warning:[/b] Built-in nodes rely on internal processing for their internal logic. Disabling it is unsafe and may lead to unexpected behavior. Use this method if you know what you are doing.

func (Instance) SetProcess 

func (self Instance) SetProcess(enable bool)

If set to [code]true[/code], enables processing. When a node is being processed, it will receive a [constant NOTIFICATION_PROCESS] on every drawn frame (and the [method _process] callback will be called if it exists). [b]Note:[/b] If [method _process] is overridden, this will be automatically enabled before [method _ready] is called. [b]Note:[/b] This method only affects the [method _process] callback, i.e. it has no effect on other callbacks like [method _physics_process]. If you want to disable all processing for the node, set [member process_mode] to [constant PROCESS_MODE_DISABLED].

func (Instance) SetProcessInput 

func (self Instance) SetProcessInput(enable bool)

If set to [code]true[/code], enables input processing. [b]Note:[/b] If [method _input] is overridden, this will be automatically enabled before [method _ready] is called. Input processing is also already enabled for GUI controls, such as [Button] and [TextEdit].

func (Instance) SetProcessInternal 

func (self Instance) SetProcessInternal(enable bool)

If set to [code]true[/code], enables internal processing for this node. Internal processing happens in isolation from the normal [method _process] calls and is used by some nodes internally to guarantee proper functioning even if the node is paused or processing is disabled for scripting ([method set_process]). [b]Warning:[/b] Built-in nodes rely on internal processing for their internal logic. Disabling it is unsafe and may lead to unexpected behavior. Use this method if you know what you are doing.

func (Instance) SetProcessMode 

func (self Instance) SetProcessMode(value gdclass.NodeProcessMode)

func (Instance) SetProcessPhysicsPriority 

func (self Instance) SetProcessPhysicsPriority(value int)

func (Instance) SetProcessPriority 

func (self Instance) SetProcessPriority(value int)

func (Instance) SetProcessShortcutInput 

func (self Instance) SetProcessShortcutInput(enable bool)

If set to [code]true[/code], enables shortcut processing for this node. [b]Note:[/b] If [method _shortcut_input] is overridden, this will be automatically enabled before [method _ready] is called.

func (Instance) SetProcessThreadGroup 

func (self Instance) SetProcessThreadGroup(value gdclass.NodeProcessThreadGroup)

func (Instance) SetProcessThreadGroupOrder 

func (self Instance) SetProcessThreadGroupOrder(value int)

func (Instance) SetProcessThreadMessages 

func (self Instance) SetProcessThreadMessages(value gdclass.NodeProcessThreadMessages)

func (Instance) SetProcessUnhandledInput 

func (self Instance) SetProcessUnhandledInput(enable bool)

If set to [code]true[/code], enables unhandled input processing. It enables the node to receive all input that was not previously handled (usually by a [Control]). [b]Note:[/b] If [method _unhandled_input] is overridden, this will be automatically enabled before [method _ready] is called. Unhandled input processing is also already enabled for GUI controls, such as [Button] and [TextEdit].

func (Instance) SetProcessUnhandledKeyInput 

func (self Instance) SetProcessUnhandledKeyInput(enable bool)

If set to [code]true[/code], enables unhandled key input processing. [b]Note:[/b] If [method _unhandled_key_input] is overridden, this will be automatically enabled before [method _ready] is called.

func (Instance) SetSceneFilePath 

func (self Instance) SetSceneFilePath(value string)

func (Instance) SetSceneInstanceLoadPlaceholder 

func (self Instance) SetSceneInstanceLoadPlaceholder(load_placeholder bool)

If set to [code]true[/code], the node becomes a [InstancePlaceholder] when packed and instantiated from a [PackedScene]. See also [method get_scene_instance_load_placeholder].

func (Instance) SetThreadSafe 

func (self Instance) SetThreadSafe(property string, value any)

Similar to [method call_thread_safe], but for setting properties.

func (Instance) SetUniqueNameInOwner 

func (self Instance) SetUniqueNameInOwner(value bool)

func (Instance) UniqueNameInOwner 

func (self Instance) UniqueNameInOwner() bool

func (*Instance) UnsafePointer 

func (self *Instance) UnsafePointer() unsafe.Pointer

func (Instance) UpdateConfigurationWarnings 

func (self Instance) UpdateConfigurationWarnings()

Refreshes the warnings displayed for this node in the Scene dock. Use [method _get_configuration_warnings] to customize the warning messages to display.

func (Instance) Virtual 

func (self Instance) Virtual(name string) reflect.Value

type Interface 

type Interface interface {
	//Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [param delta] time since the previous frame is not constant. [param delta] is in seconds.
	//It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process].
	//Corresponds to the [constant NOTIFICATION_PROCESS] notification in [method Object._notification].
	//[b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
	Process(delta Float.X)
	//Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [param delta] variable should be constant. [param delta] is in seconds.
	//It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_physics_process].
	//Corresponds to the [constant NOTIFICATION_PHYSICS_PROCESS] notification in [method Object._notification].
	//[b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
	PhysicsProcess(delta Float.X)
	//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 first, and then that of the children.
	//Corresponds to the [constant NOTIFICATION_ENTER_TREE] notification in [method Object._notification].
	EnterTree()
	//Called when the node is about to leave the [SceneTree] (e.g. upon freeing, scene changing, or after calling [method remove_child] in a script). If the node has children, its [method _exit_tree] callback will be called last, after all its children have left the tree.
	//Corresponds to the [constant NOTIFICATION_EXIT_TREE] notification in [method Object._notification] and signal [signal tree_exiting]. To get notified when the node has already left the active tree, connect to the [signal tree_exited].
	ExitTree()
	//Called when the node is "ready", i.e. when both the node and its children have entered the scene tree. If the node has children, their [method _ready] callbacks get triggered first, and the parent node will receive the ready notification afterwards.
	//Corresponds to the [constant NOTIFICATION_READY] notification in [method Object._notification]. See also the [code]@onready[/code] annotation for variables.
	//Usually used for initialization. For even earlier initialization, [method Object._init] may be used. See also [method _enter_tree].
	//[b]Note:[/b] This method may be called only once for each node. After removing a node from the scene tree and adding it again, [method _ready] will [b]not[/b] be called a second time. This can be bypassed by requesting another call with [method request_ready], which may be called anywhere before adding the node again.
	Ready()
	//The elements in the array returned from this method are displayed as warnings in the Scene dock if the script that overrides it is a [code]tool[/code] script.
	//Returning an empty array produces no warnings.
	//Call [method update_configuration_warnings] when the warnings need to be updated for this node.
	//[codeblock]
	//@export var energy = 0:
	//    set(value):
	//        energy = value
	//        update_configuration_warnings()
	//
	//func _get_configuration_warnings():
	//    if energy < 0:
	//        return ["Energy must be 0 or greater."]
	//    else:
	//        return []
	//[/codeblock]
	GetConfigurationWarnings() []string
	//Called when there is an input event. The input event propagates up through the node tree until a node consumes it.
	//It is only called if input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_input].
	//To consume the input event and stop it propagating further to other nodes, [method Viewport.set_input_as_handled] can be called.
	//For gameplay input, [method _unhandled_input] and [method _unhandled_key_input] are usually a better fit as they allow the GUI to intercept the events first.
	//[b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
	Input(event [1]gdclass.InputEvent)
	//Called when an [InputEventKey], [InputEventShortcut], or [InputEventJoypadButton] hasn't been consumed by [method _input] or any GUI [Control] item. It is called before [method _unhandled_key_input] and [method _unhandled_input]. The input event propagates up through the node tree until a node consumes it.
	//It is only called if shortcut processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_shortcut_input].
	//To consume the input event and stop it propagating further to other nodes, [method Viewport.set_input_as_handled] can be called.
	//This method can be used to handle shortcuts. For generic GUI events, use [method _input] instead. Gameplay events should usually be handled with either [method _unhandled_input] or [method _unhandled_key_input].
	//[b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not orphan).
	ShortcutInput(event [1]gdclass.InputEvent)
	//Called when an [InputEvent] hasn't been consumed by [method _input] or any GUI [Control] item. It is called after [method _shortcut_input] and after [method _unhandled_key_input]. The input event propagates up through the node tree until a node consumes it.
	//It is only called if unhandled input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_input].
	//To consume the input event and stop it propagating further to other nodes, [method Viewport.set_input_as_handled] can be called.
	//For gameplay input, this method is usually a better fit than [method _input], as GUI events need a higher priority. For keyboard shortcuts, consider using [method _shortcut_input] instead, as it is called before this method. Finally, to handle keyboard events, consider using [method _unhandled_key_input] for performance reasons.
	//[b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
	UnhandledInput(event [1]gdclass.InputEvent)
	//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 _unhandled_input]. The input event propagates up through the node tree until a node consumes it.
	//It is only called if unhandled key input processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process_unhandled_key_input].
	//To consume the input event and stop it propagating further to other nodes, [method Viewport.set_input_as_handled] can be called.
	//This method can be used to handle Unicode character input with [kbd]Alt[/kbd], [kbd]Alt + Ctrl[/kbd], and [kbd]Alt + Shift[/kbd] modifiers, after shortcuts were handled.
	//For gameplay input, this and [method _unhandled_input] are usually a better fit than [method _input], as GUI events should be handled first. This method also performs better than [method _unhandled_input], since unrelated events such as [InputEventMouseMotion] are automatically filtered. For shortcuts, consider using [method _shortcut_input] instead.
	//[b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
	UnhandledKeyInput(event [1]gdclass.InputEvent)
}

type InternalMode 

type InternalMode = gdclass.NodeInternalMode //gd:Node.InternalMode

const (
	/*The node will not be internal.*/
	InternalModeDisabled InternalMode = 0
	/*The node will be placed at the beginning of the parent's children, before any non-internal sibling.*/
	InternalModeFront InternalMode = 1
	/*The node will be placed at the end of the parent's children, after any non-internal sibling.*/
	InternalModeBack InternalMode = 2
)

type PhysicsInterpolationMode 

type PhysicsInterpolationMode = gdclass.NodePhysicsInterpolationMode //gd:Node.PhysicsInterpolationMode

const (
	/*Inherits [member physics_interpolation_mode] from the node's parent. This is the default for any newly created node.*/
	PhysicsInterpolationModeInherit PhysicsInterpolationMode = 0
	/*Enables physics interpolation for this node and for children set to [constant PHYSICS_INTERPOLATION_MODE_INHERIT]. This is the default for the root node.*/
	PhysicsInterpolationModeOn PhysicsInterpolationMode = 1
	/*Disables physics interpolation for this node and for children set to [constant PHYSICS_INTERPOLATION_MODE_INHERIT].*/
	PhysicsInterpolationModeOff PhysicsInterpolationMode = 2
)

type ProcessMode 

type ProcessMode = gdclass.NodeProcessMode //gd:Node.ProcessMode

const (
	/*Inherits [member process_mode] from the node's parent. This is the default for any newly created node.*/
	ProcessModeInherit ProcessMode = 0
	/*Stops processing when [member SceneTree.paused] is [code]true[/code]. This is the inverse of [constant PROCESS_MODE_WHEN_PAUSED], and the default for the root node.*/
	ProcessModePausable ProcessMode = 1
	/*Process [b]only[/b] when [member SceneTree.paused] is [code]true[/code]. This is the inverse of [constant PROCESS_MODE_PAUSABLE].*/
	ProcessModeWhenPaused ProcessMode = 2
	/*Always process. Keeps processing, ignoring [member SceneTree.paused]. This is the inverse of [constant PROCESS_MODE_DISABLED].*/
	ProcessModeAlways ProcessMode = 3
	/*Never process. Completely disables processing, ignoring [member SceneTree.paused]. This is the inverse of [constant PROCESS_MODE_ALWAYS].*/
	ProcessModeDisabled ProcessMode = 4
)

type ProcessThreadGroup 

type ProcessThreadGroup = gdclass.NodeProcessThreadGroup //gd:Node.ProcessThreadGroup

const (
	/*Process this node based on the thread group mode of the first parent (or grandparent) node that has a thread group mode that is not inherit. See [member process_thread_group] for more information.*/
	ProcessThreadGroupInherit ProcessThreadGroup = 0
	/*Process this node (and child nodes set to inherit) on the main thread. See [member process_thread_group] for more information.*/
	ProcessThreadGroupMainThread ProcessThreadGroup = 1
	/*Process this node (and child nodes set to inherit) on a sub-thread. See [member process_thread_group] for more information.*/
	ProcessThreadGroupSubThread ProcessThreadGroup = 2
)

type ProcessThreadMessages 

type ProcessThreadMessages = gdclass.NodeProcessThreadMessages //gd:Node.ProcessThreadMessages

const (
	/*Allows this node to process threaded messages created with [method call_deferred_thread_group] right before [method _process] is called.*/
	FlagProcessThreadMessages ProcessThreadMessages = 1
	/*Allows this node to process threaded messages created with [method call_deferred_thread_group] right before [method _physics_process] is called.*/
	FlagProcessThreadMessagesPhysics ProcessThreadMessages = 2
	/*Allows this node to process threaded messages created with [method call_deferred_thread_group] right before either [method _process] or [method _physics_process] are called.*/
	FlagProcessThreadMessagesAll ProcessThreadMessages = 3
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.