Node

Inherits: Object

Inherited By: Viewport, AudioStreamPlayer, EditorFileSystem, CanvasLayer, Spatial, AnimationPlayer, EditorPlugin, ResourcePreloader, AnimationTreePlayer, WorldEnvironment, InstancePlaceholder, HTTPRequest, EditorInterface, EditorResourcePreview, CanvasItem, Timer, Tween

Category: Core

Brief Description

Base class for all the scene elements.

Member Functions

void _enter_tree ( ) virtual
void _exit_tree ( ) virtual
void _input ( InputEvent event ) virtual
void _physics_process ( float delta ) virtual
void _process ( float delta ) virtual
void _ready ( ) virtual
void _unhandled_input ( InputEvent event ) virtual
void _unhandled_key_input ( InputEventKey event ) virtual
void add_child ( Node node, bool legible_unique_name=false )
void add_child_below_node ( Node node, Node child_node, bool legible_unique_name=false )
void add_to_group ( String group, bool persistent=false )
bool can_process ( ) const
Node duplicate ( int flags=15 ) const
Node find_node ( String mask, bool recursive=true, bool owned=true ) const
Node get_child ( int idx ) const
int get_child_count ( ) const
Array get_children ( ) const
String get_filename ( ) const
Array get_groups ( ) const
int get_index ( ) const
String get_name ( ) const
int get_network_master ( ) const
Node get_node ( NodePath path ) const
Array get_node_and_resource ( NodePath path )
Node get_owner ( ) const
Node get_parent ( ) const
NodePath get_path ( ) const
NodePath get_path_to ( Node node ) const
float get_physics_process_delta_time ( ) const
int get_position_in_parent ( ) const
float get_process_delta_time ( ) const
bool get_scene_instance_load_placeholder ( ) const
SceneTree get_tree ( ) const
Viewport get_viewport ( ) const
bool has_node ( NodePath path ) const
bool has_node_and_resource ( NodePath path ) const
bool is_a_parent_of ( Node node ) const
bool is_displayed_folded ( ) const
bool is_greater_than ( Node node ) const
bool is_in_group ( String group ) const
bool is_inside_tree ( ) const
bool is_network_master ( ) const
bool is_physics_processing ( ) const
bool is_physics_processing_internal ( ) const
bool is_processing ( ) const
bool is_processing_input ( ) const
bool is_processing_internal ( ) const
bool is_processing_unhandled_input ( ) const
bool is_processing_unhandled_key_input ( ) const
void move_child ( Node child_node, int to_position )
void print_stray_nodes ( )
void print_tree ( )
void propagate_call ( String method, Array args=[ ], bool parent_first=false )
void propagate_notification ( int what )
void queue_free ( )
void raise ( )
void remove_and_skip ( )
void remove_child ( Node node )
void remove_from_group ( String group )
void replace_by ( Node node, bool keep_data=false )
void request_ready ( )
Variant rpc ( String method ) vararg
void rpc_config ( String method, int mode )
Variant rpc_id ( int peer_id, String method ) vararg
Variant rpc_unreliable ( String method ) vararg
Variant rpc_unreliable_id ( int peer_id, String method ) vararg
void rset ( String property, Variant value )
void rset_config ( String property, int mode )
void rset_id ( int peer_id, String property, Variant value )
void rset_unreliable ( String property, Variant value )
void rset_unreliable_id ( int peer_id, String property, Variant value )
void set_display_folded ( bool fold )
void set_filename ( String filename )
void set_name ( String name )
void set_network_master ( int id, bool recursive=true )
void set_owner ( Node owner )
void set_physics_process ( bool enable )
void set_physics_process_internal ( bool enable )
void set_process ( bool enable )
void set_process_input ( bool enable )
void set_process_internal ( bool enable )
void set_process_unhandled_input ( bool enable )
void set_process_unhandled_key_input ( bool enable )
void set_scene_instance_load_placeholder ( bool load_placeholder )

Signals

  • renamed ( )

Emitted when the node is renamed.

  • tree_entered ( )

Emitted when Node enters the tree.

  • tree_exited ( )

Emitted when Node exits the tree.

Member Variables

  • int pause_mode

Numeric Constants

  • NOTIFICATION_ENTER_TREE = 10 — Notification received when the node enters a SceneTree.
  • NOTIFICATION_EXIT_TREE = 11 — Notification received when the node exits a SceneTree.
  • NOTIFICATION_MOVED_IN_PARENT = 12 — Notification received when the node is moved in the parent.
  • NOTIFICATION_READY = 13 — Notification received when the node is ready. See _ready.
  • NOTIFICATION_PAUSED = 14 — Notification received when the node is paused.
  • NOTIFICATION_UNPAUSED = 15 — Notification received when the node is unpaused.
  • NOTIFICATION_PHYSICS_PROCESS = 16 — Notification received every frame when the physics process flag is set (see set_physics_process).
  • NOTIFICATION_PROCESS = 17 — Notification received every frame when the process flag is set (see set_process).
  • NOTIFICATION_PARENTED = 18 — Notification received when a node is set as a child of another node. Note that this doesn’t mean that a node entered the Scene Tree.
  • NOTIFICATION_UNPARENTED = 19 — Notification received when a node is unparented (parent removed it from the list of children).
  • NOTIFICATION_INSTANCED = 20 — Notification received when the node is instanced.
  • NOTIFICATION_DRAG_BEGIN = 21 — Notification received when a drag begins.
  • NOTIFICATION_DRAG_END = 22 — Notification received when a drag ends.
  • NOTIFICATION_PATH_CHANGED = 23 — Notification received when the node’s NodePath changed.
  • NOTIFICATION_TRANSLATION_CHANGED = 24
  • NOTIFICATION_INTERNAL_PROCESS = 25
  • NOTIFICATION_INTERNAL_PHYSICS_PROCESS = 26
  • RPC_MODE_DISABLED = 0
  • RPC_MODE_REMOTE = 1 — Call a method remotely.
  • RPC_MODE_SYNC = 2 — Call a method both remotely and locally.
  • RPC_MODE_MASTER = 3 — Call a method if the Node is Master.
  • RPC_MODE_SLAVE = 4 — Call a method if the Node is Slave.
  • PAUSE_MODE_INHERIT = 0 — Inherits pause mode from parent. For root node, it is equivalent to PAUSE_MODE_STOP.
  • PAUSE_MODE_STOP = 1 — Stop processing when SceneTree is paused.
  • PAUSE_MODE_PROCESS = 2 — Continue to process regardless of SceneTree pause state.
  • DUPLICATE_SIGNALS = 1 — Duplicate the node’s signals.
  • DUPLICATE_GROUPS = 2 — Duplicate the node’s groups.
  • DUPLICATE_SCRIPTS = 4 — Duplicate the node’s scripts.
  • DUPLICATE_USE_INSTANCING = 8 — Duplicate using instancing.

Description

Nodes are the base bricks with which Godot games are developed. They can be set as children of other nodes, resulting in a tree arrangement. A given node can contain any number of nodes as children (but there is only one scene tree root node) with the requirement that all siblings (direct children of a node) should have unique names.

Any tree of nodes is called a scene. Scenes can be saved to the disk and then instanced into other scenes. This allows for very high flexibility in the architecture and data model of the projects. Nodes can optionally be added to groups. This makes it easy to reach a number of nodes from the code (for example an “enemies” group) to perform grouped actions.

Scene tree: The SceneTree contains the active tree of nodes. When a node is added to the scene tree, it receives the NOTIFICATION_ENTER_TREE notification and its _enter_tree callback is triggered. Children nodes are always added after their parent node, i.e. the _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 NOTIFICATION_READY notification and their respective _ready callbacks are triggered. For groups of nodes, the _ready callback is called in reverse order, from the children up to the parent nodes.

It means that when adding a scene to the scene tree, the following order will be used for the callbacks: _enter_tree of the parent, _enter_tree of the children, _ready of the children and finally _ready of the parent (and that recursively for the whole scene).

Processing: Nodes can be set to the “process” state, so that they receive a callback on each frame requesting them to process (do something). Normal processing (callback _process, toggled with set_process) happens as fast as possible and is dependent on the frame rate, so the processing time delta is variable. Physics processing (callback _physics_process, toggled with set_physics_process) happens a fixed amount of times per second (by default 60) and is useful to link itself to the physics.

Nodes can also process input events. When set, the _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 _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 instancing scenes into other scenes), an “owner” can be set for the node with set_owner. This keeps track of who instanced what. This is mostly useful when writing editors and tools, though.

Finally, when a node is freed with free or queue_free, it will also free all its children.

Networking with nodes: After connecting to a server (or making one, see NetworkedMultiplayerENet) it is possible to use the built-in RPC (remote procedure call) system to easily communicate over the network. By calling rpc with a method name, it will be called locally, and in all connected peers (peers = clients and the server that accepts connections), with behaviour varying depending on the network mode (set_network_mode) on the receiving peer. To identify which Node receives the RPC call Godot will use its NodePath (make sure node names are the same on all peers).

Member Function Description

  • void _enter_tree ( ) virtual

Called when the node enters the SceneTree (e.g. upon instancing, scene changing or after calling add_child in a script). If the node has children, its _enter_tree callback will be called first, and then that of the children.

Corresponds to the NOTIFICATION_ENTER_TREE notification in Object._notification.

  • void _exit_tree ( ) virtual

Called when the node leaves the SceneTree (e.g. upon freeing, scene changing or after calling remove_child in a script). If the node has children, its _exit_tree callback will be called last, after all its children have left the tree.

Corresponds to the NOTIFICATION_EXIT_TREE notification in Object._notification.

Called when there is a change to input devices. Propagated 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 overriden, and can be toggled with set_process_input.

  • void _physics_process ( float delta ) virtual

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 delta variable should be constant.

It is only called if physics processing is enabled, which is done automatically if this method is overriden, and can be toggled with set_physics_process.

Corresponds to the NOTIFICATION_PHYSICS_PROCESS notification in Object._notification.

  • void _process ( float delta ) virtual

Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the delta time since the previous frame is not constant.

It is only called if processing is enabled, which is done automatically if this method is overriden, and can be toggled with set_process.

Corresponds to the NOTIFICATION_PROCESS notification in Object._notification.

  • void _ready ( ) virtual

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 _ready callback gets triggered first, and the node will receive the ready notification only afterwards.

Corresponds to the NOTIFICATION_READY notification in Object._notification.

  • void _unhandled_input ( InputEvent event ) virtual

Propagated to all nodes when the previous InputEvent is not consumed by any nodes.

It is only called if unhandled input processing is enabled, which is done automatically if this method is overriden, and can be toggled with set_process_unhandled_input.

  • void add_child ( Node node, bool legible_unique_name=false )

Add a child Node. Nodes can have as many children as they want, but every child must have a unique name. Children nodes are automatically deleted when the parent node is deleted, so deleting a whole scene is performed by deleting its topmost node.

The optional boolean argument enforces creating child nodes with human-readable names, based on the name of the node being instanced instead of its type only.

  • void add_child_below_node ( Node node, Node child_node, bool legible_unique_name=false )
  • void add_to_group ( String group, bool persistent=false )

Add a node to a group. Groups are helpers to name and organize a subset of nodes, like for example “enemies” or “collectables”. A Node can be in any number of groups. Nodes can be assigned a group at any time, but will not be added to it until they are inside the scene tree (see is_inside_tree).

  • bool can_process ( ) const

Return true if the node can process, i.e. whether its pause mode allows processing while the scene tree is paused (see set_pause_mode). Always returns true if the scene tree is not paused, and false if the node is not in the tree. FIXME: Why FAIL_COND?

  • Node duplicate ( int flags=15 ) const

Duplicate the node, returning a new Node.

You can fine-tune the behavior using the flags, which are based on the DUPLICATE_* constants.

Finds a descendant of this node whose name matches mask as in String.match (i.e. case sensitive, but ‘*’ matches zero or more characters and ‘?’ matches any single character except ‘.’). Note that it does not match against the full path, just against individual node names.

Returns a child node by its index (see get_child_count). This method is often used for iterating all children of a node.

  • int get_child_count ( ) const

Returns the amount of child nodes.

  • Array get_children ( ) const

Returns an array of references (Node) to the child nodes.

  • String get_filename ( ) const

Returns a filename that may be contained by the node. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded (see set_filename).

  • Array get_groups ( ) const

Returns an array listing the groups that the node is part of.

  • int get_index ( ) const

Returns the node index, i.e. its position among the siblings of its parent.

Returns the name of the node. This name is unique among the siblings (other child nodes from the same parent).

  • int get_network_master ( ) const

Returns the peer ID of the network master for this node.

Fetches a node. The NodePath must be valid (or else an error will be raised) and can be either the path to child node, a relative path (from the current node to another node), or an absolute path to a node.

Note: fetching absolute paths only works when the node is inside the scene tree (see is_inside_tree).

Example: Assume your current node is Character and the following tree:

/root
/root/Character
/root/Character/Sword
/root/Character/Backpack/Dagger
/root/MyGame
/root/Swamp/Alligator
/root/Swamp/Mosquito
/root/Swamp/Goblin

Possible paths are:

get_node("Sword")
get_node("Backpack/Dagger")
get_node("../Swamp/Alligator")
get_node("/root/MyGame")
  • Node get_owner ( ) const

Returns the node owner (see set_owner).

  • Node get_parent ( ) const

Returns the parent node of the current node, or an empty Node if the node lacks a parent.

Returns the absolute path of the current node. This only works if the current node is inside the scene tree (see is_inside_tree).

Returns the relative path from the current node to the specified node in “node” argument. Both nodes must be in the same scene, or else the function will fail.

  • float get_physics_process_delta_time ( ) const

Returns the time elapsed since the last physics-bound frame (see _physics_process). This is always a constant value in physics processing unless the frames per second is changed in OS.

  • int get_position_in_parent ( ) const

Returns the order in the node tree branch, i.e. if called by the first child Node, return 0.

  • float get_process_delta_time ( ) const

Returns the time elapsed (in seconds) since the last process callback. This is almost always different each time.

  • bool get_scene_instance_load_placeholder ( ) const

Returns the SceneTree that this node is inside.

Returns the Viewport for this node.

Returns true if the node that the NodePath points to exists.

  • bool is_a_parent_of ( Node node ) const

Returns true if the “node” argument is a direct or indirect child of the current node, otherwise return ``false[code].

  • bool is_displayed_folded ( ) const
  • bool is_greater_than ( Node node ) const

Returns true if node occurs later in the scene hierarchy than the current node, otherwise return false.

Returns true if this Node is in the specified group.

  • bool is_inside_tree ( ) const

Returns true if this Node is currently inside a SceneTree.

  • bool is_network_master ( ) const
  • bool is_physics_processing ( ) const

Returns true if physics processing is enabled (see set_physics_process).

  • bool is_physics_processing_internal ( ) const
  • bool is_processing ( ) const

Returns true if processing is enabled (see set_process).

  • bool is_processing_input ( ) const

Returns true if the node is processing input (see set_process_input).

  • bool is_processing_internal ( ) const
  • bool is_processing_unhandled_input ( ) const

Returns true if the node is processing unhandled input (see set_process_unhandled_input).

  • bool is_processing_unhandled_key_input ( ) const

Returns true if the node is processing unhandled key input (see set_process_unhandled_key_input).

  • void move_child ( Node child_node, int to_position )

Moves a child node to a different position (order) amongst the other children. Since calls, signals, etc are performed by tree order, changing the order of children nodes may be useful.

  • void print_stray_nodes ( )
  • void print_tree ( )

Prints the scene to stdout. Used mainly for debugging purposes.

  • void propagate_call ( String method, Array args=[ ], bool parent_first=false )

Calls the method (if present) with the arguments given in “args” on this Node and recursively on all children. If the parent_first argument is true then the method will be called on the current Node first, then on all children. If it is false then the children will get called first.

  • void propagate_notification ( int what )

Notify the current node and all its children recursively by calling notification() in all of them.

  • void queue_free ( )

Queues a node for deletion at the end of the current frame. When deleted, all of its children nodes will be deleted as well. This method ensures it’s safe to delete the node, contrary to Object.free. Use Object.is_queued_for_deletion to know whether a node will be deleted at the end of the frame.

  • void raise ( )

Moves this node to the top of the array of nodes of the parent node. This is often useful on GUIs (Control), because their order of drawing fully depends on their order in the tree.

  • void remove_and_skip ( )

Removes a node and set all its children as children of the parent node (if exists). All even subscriptions that pass by the removed node will be unsubscribed.

  • void remove_child ( Node node )

Removes a child Node. Node is NOT deleted and will have to be deleted manually.

  • void remove_from_group ( String group )

Removes a node from a group.

  • void replace_by ( Node node, bool keep_data=false )

Replaces a node in a scene by a given one. Subscriptions that pass through this node will be lost.

  • void request_ready ( )

Requests that _ready be called again.

Sends a remote procedure call request to all peers on the network (and locally), optionally sending additional data as arguments. Call request will be received by nodes with the same NodePath.

  • void rpc_config ( String method, int mode )

Changes the method’s RPC mode (one of RPC_MODE_* constants).

Sends a rpc to a specific peer identified by peer_id.

Sends a rpc using an unreliable protocol.

Sends a rpc to a specific peer identified by peer_id using an unreliable protocol.

Remotely changes property’s value on other peers (and locally).

  • void rset_config ( String property, int mode )

Changes the property’s RPC mode (one of RPC_MODE_* constants).

Remotely changes property’s value on a specific peer identified by peer_id.

Remotely changes property’s value on other peers (and locally) using an unreliable protocol.

Remotely changes property’s value on a specific peer identified by peer_id using an unreliable protocol.

  • void set_display_folded ( bool fold )
  • void set_filename ( String filename )

A node can contain a filename. This filename should not be changed by the user, unless writing editors and tools. When a scene is instanced from a file, it topmost node contains the filename from where it was loaded.

  • void set_name ( String name )

Sets the name of the Node. Name must be unique within parent, and setting an already existing name will cause for the node to be automatically renamed.

  • void set_network_master ( int id, bool recursive=true )

Sets the node network master to the peer with the given peer ID. The network master is the peer that has authority over it on the network. Inherited from the parent node by default, which ultimately defaults to peer ID 1 (the server).

  • void set_owner ( Node owner )

Sets the node owner. A node can have any other node as owner (as long as a valid parent, grandparent, etc ascending in the tree). When saving a node (using SceneSaver) all the nodes it owns will be saved with it. This allows to create complex SceneTrees, with instancing and subinstancing.

  • void set_physics_process ( bool enable )

Enables or disables the node’s physics (alias fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 fps, check OS to change that) interval (and the _physics_process callback will be called if exists). Enabled automatically if _physics_process is overriden. Any calls to this before _ready will be ignored.

  • void set_physics_process_internal ( bool enable )
  • void set_process ( bool enable )

Enables or disables node processing. When a node is being processed, it will receive a NOTIFICATION_PROCESS on every drawn frame (and the _process callback will be called if exists). Enabled automatically if _process is overriden. Any calls to this before _ready will be ignored.

  • void set_process_input ( bool enable )

Enables input processing for node. This is not required for GUI controls! It hooks up the node to receive all input (see _input). Enabled automatically if _input is overriden. Any calls to this before _ready will be ignored.

  • void set_process_internal ( bool enable )
  • void set_process_unhandled_input ( bool enable )

Enables unhandled input processing for node. This is not required for GUI controls! It hooks up the node to receive all input that was not previously handled before (usually by a Control). Enabled automatically if _unhandled_input is overriden. Any calls to this before _ready will be ignored.

  • void set_process_unhandled_key_input ( bool enable )

Enables unhandled key input processing for node. Enabled automatically if _unhandled_key_input is overriden. Any calls to this before _ready will be ignored.

  • void set_scene_instance_load_placeholder ( bool load_placeholder )