Node
Hereda: Object
Heredado por: AnimationMixer, AudioStreamPlayer, CanvasItem, CanvasLayer, EditorFileSystem, EditorPlugin, EditorResourcePreview, HTTPRequest, InstancePlaceholder, MissingNode, MultiplayerSpawner, MultiplayerSynchronizer, NavigationAgent2D, NavigationAgent3D, Node3D, ResourcePreloader, ShaderGlobalsOverride, StatusIndicator, Timer, Viewport, WorldEnvironment
Clase base para todos los objetos de escena.
Descripción
Los nodos son componentes fundamentales en Godot. Pueden asignarse como hijos de otros nodos, formando una disposición jerárquica en forma de árbol. Un nodo dado puede contener cualquier cantidad de nodos como hijos, con la condición de que todos los nodos hermanos (hijos directos de un nodo) tengan nombres únicos.
Un árbol de nodos se denomina escena. Las escenas pueden guardarse en el disco y luego instanciarse dentro de otras escenas, lo que permite una gran flexibilidad en la arquitectura y el modelo de datos de los proyectos en Godot.
Árbol de escenas: El SceneTree contiene el árbol activo de nodos. Cuando un nodo se añade al árbol de escenas, recibe la notificación NOTIFICATION_ENTER_TREE y se activa su callback _enter_tree(). Los nodos hijos siempre se añaden después de su nodo padre, es decir, el callback _enter_tree() del nodo padre se ejecutará antes que el del nodo hijo.
Una vez que todos los nodos se han añadido al árbol de escenas, reciben la notificación NOTIFICATION_READY y se activa su callback _ready(). Para los grupos de nodos, el callback _ready() se ejecuta en orden inverso, comenzando con los nodos hijos y avanzando hacia los nodos padre.
Esto significa que al agregar un nodo al árbol de escenas, el orden será el siguiente: _enter_tree() del padre, _enter_tree() de los hijos, _ready() de los hijos y, finalmente, _ready() del padre (de manera recursiva para todo el árbol de escenas).
Procesamiento: Los nodos pueden sobrescribir el estado de "proceso" para recibir un callback en cada fotograma que solicite realizar alguna acción. El procesamiento normal (_process(), activado con set_process()) se ejecuta lo más rápido posible y depende de la tasa de fotogramas, por lo que el tiempo de procesamiento (delta en segundos) se pasa como argumento. El procesamiento físico (_physics_process(), activado con set_physics_process()) ocurre un número fijo de veces por segundo (60 por defecto) y es útil para el código relacionado con el motor físico.
Los nodos también pueden procesar eventos de entrada. Cuando está presente, la función _input() se llamará para cada entrada que reciba el programa. En muchos casos, esto puede ser excesivo (a menos que se use en proyectos simples), y puede preferirse la función _unhandled_input(), que se activa cuando el evento de entrada no fue manejado por otros nodos (típicamente, los nodos de GUI como Control), asegurando que el nodo solo reciba los eventos destinados a él.
Para realizar un seguimiento de la jerarquía de la escena (especialmente al instanciar escenas dentro de otras), se puede asignar un "propietario" al nodo mediante la propiedad owner. Esto permite saber quién instanció qué nodo, lo cual es útil principalmente al escribir editores y herramientas.
Finalmente, cuando un nodo se libera mediante Object.free() o queue_free(), también libera a todos sus nodos hijos.
Grupos: Los nodos pueden añadirse a tantos grupos como sea necesario para facilitar su gestión. Por ejemplo, podrías crear grupos como "enemigos" o "coleccionables" dependiendo de tu juego. Véase add_to_group(), is_in_group() y remove_from_group(). Luego puedes recuperar todos los nodos en estos grupos, iterarlos e incluso llamar métodos a los grupos a través de los métodos del SceneTree.
Networking con nodos: Después de conectarte a un servidor (o crear uno, Véase ENetMultiplayerPeer), es posible utilizar el sistema incorporado de RPC (llamada de procedimiento remoto) para comunicarse a través de la red. Al llamar a rpc() con un nombre de método, este será llamado localmente y en todos los pares conectados (pares = clientes y el servidor que acepta conexiones). Para identificar qué nodo recibe la llamada RPC, Godot usará su NodePath (asegúrate de que los nombres de los nodos sean iguales en todos los pares). También te recomiendo revisar el tutorial de networking avanzado y sus demos correspondientes.
Nota: La propiedad script forma parte de la clase Object, no de Node. No está expuesta como la mayoría de las propiedades, pero tiene setter y getter (véase Object.set_script() y Object.get_script()).
Tutoriales
Propiedades
|
||
|
||
|
||
|
||
|
||
|
||
|
||
BitField[ProcessThreadMessages] |
||
|
Métodos
Señales
child_entered_tree(node: Node) 🔗
Emitted when the child node enters the SceneTree, usually because this node entered the tree (see tree_entered), or add_child() has been called.
This signal is emitted after the child node's own NOTIFICATION_ENTER_TREE and tree_entered.
child_exiting_tree(node: Node) 🔗
Emitted when the child node is about to exit the SceneTree, usually because this node is exiting the tree (see tree_exiting), or because the child node is being removed or freed.
When this signal is received, the child node is still accessible inside the tree. This signal is emitted after the child node's own tree_exiting and NOTIFICATION_EXIT_TREE.
child_order_changed() 🔗
Emitted when the list of children is changed. This happens when child nodes are added, moved or removed.
editor_description_changed(node: Node) 🔗
Emitida cuando el campo de descripción del editor del nodo cambia.
editor_state_changed() 🔗
Emitida cuando se modifica un atributo del nodo relevante para el editor. Solo se emite en el editor.
ready() 🔗
Emitted when the node is considered ready, after _ready() is called.
renamed() 🔗
Emitida cuando se cambia el name del nodo, si el nodo está dentro del árbol.
Emitted when this node is being replaced by the node, see replace_by().
This signal is emitted after node has been added as a child of the original parent node, but before all original child nodes have been reparented to node.
tree_entered() 🔗
Emitted when the node enters the tree.
This signal is emitted after the related NOTIFICATION_ENTER_TREE notification.
tree_exited() 🔗
Emitted after the node exits the tree and is no longer active.
This signal is emitted after the related NOTIFICATION_EXIT_TREE notification.
tree_exiting() 🔗
Emitted when the node is just about to exit the tree. The node is still valid. As such, this is the right place for de-initialization (or a "destructor", if you will).
This signal is emitted after the node's _exit_tree(), and before the related NOTIFICATION_EXIT_TREE.
Enumeraciones
enum ProcessMode: 🔗
ProcessMode PROCESS_MODE_INHERIT = 0
Hereda process_mode del padre del nodo. Este es el valor predeterminado para cualquier nodo recién creado.
ProcessMode PROCESS_MODE_PAUSABLE = 1
Detiene el procesamiento cuando SceneTree.paused es true. Esto es lo opuesto a PROCESS_MODE_WHEN_PAUSED, y el valor predeterminado para el nodo raíz.
ProcessMode PROCESS_MODE_WHEN_PAUSED = 2
Procesar solo cuando SceneTree.paused es true. Esto es lo opuesto a PROCESS_MODE_PAUSABLE.
ProcessMode PROCESS_MODE_ALWAYS = 3
Siempre procesar. Continúa procesando, ignorando SceneTree.paused. Esto es lo opuesto a PROCESS_MODE_DISABLED.
ProcessMode PROCESS_MODE_DISABLED = 4
Nunca procesar. Deshabilita completamente el procesamiento, ignorando SceneTree.paused. Esto es lo opuesto a PROCESS_MODE_ALWAYS.
enum ProcessThreadGroup: 🔗
ProcessThreadGroup PROCESS_THREAD_GROUP_INHERIT = 0
Procesa este nodo basándose en el modo de grupo de hilos del primer nodo padre (o abuelo) que tenga un modo de grupo de hilos que no sea heredado. Véase process_thread_group para más información.
ProcessThreadGroup PROCESS_THREAD_GROUP_MAIN_THREAD = 1
Procesa este nodo (y los nodos hijos configurados para heredar) en el hilo principal. Véase process_thread_group para más información.
ProcessThreadGroup PROCESS_THREAD_GROUP_SUB_THREAD = 2
Procesa este nodo (y los nodos hijos configurados para heredar) en un subhilo. Véase process_thread_group para más información.
flags ProcessThreadMessages: 🔗
ProcessThreadMessages FLAG_PROCESS_THREAD_MESSAGES = 1
Permite que este nodo procese mensajes multihilo creados con call_deferred_thread_group() justo antes de que se llame a _process().
ProcessThreadMessages FLAG_PROCESS_THREAD_MESSAGES_PHYSICS = 2
Permite que este nodo procese mensajes multihilo creados con call_deferred_thread_group() justo antes de que se llame a _physics_process().
ProcessThreadMessages FLAG_PROCESS_THREAD_MESSAGES_ALL = 3
Permite que este nodo procese mensajes multihilo creados con call_deferred_thread_group() justo antes de que se llamen a _process() o _physics_process().
enum PhysicsInterpolationMode: 🔗
PhysicsInterpolationMode PHYSICS_INTERPOLATION_MODE_INHERIT = 0
Hereda physics_interpolation_mode del padre del nodo. Este es el valor por defecto para cualquier nodo recién creado.
PhysicsInterpolationMode PHYSICS_INTERPOLATION_MODE_ON = 1
Habilita la interpolación física para este nodo y para los hijos configurados en PHYSICS_INTERPOLATION_MODE_INHERIT. Este es el valor por defecto para el nodo raíz.
PhysicsInterpolationMode PHYSICS_INTERPOLATION_MODE_OFF = 2
Deshabilita la interpolación física para este nodo y para los hijos configurados en PHYSICS_INTERPOLATION_MODE_INHERIT.
enum DuplicateFlags: 🔗
DuplicateFlags DUPLICATE_SIGNALS = 1
Duplica las conexiones de señal del nodo que están conectadas con la bandera Object.CONNECT_PERSIST.
DuplicateFlags DUPLICATE_GROUPS = 2
Duplica los grupos del nodo.
DuplicateFlags DUPLICATE_SCRIPTS = 4
Duplica el script del nodo (también sobrescribiendo los scripts de los hijos duplicados, si se combina con DUPLICATE_USE_INSTANTIATION).
DuplicateFlags DUPLICATE_USE_INSTANTIATION = 8
Duplica usando PackedScene.instantiate(). Si el nodo proviene de una escena guardada en disco, reutiliza PackedScene.instantiate() como base para el nodo duplicado y sus hijos.
DuplicateFlags DUPLICATE_INTERNAL_STATE = 16
Duplica también las variables no serializables (es decir, sin @GlobalScope.PROPERTY_USAGE_STORAGE).
DuplicateFlags DUPLICATE_DEFAULT = 15
Duplica usando las banderas por defecto. Esta constante es útil para añadir o quitar una sola bandera.
# Duplicar variables no exportadas.
var dupe = duplicate(DUPLICATE_DEFAULT | DUPLICATE_INTERNAL_STATE)
enum InternalMode: 🔗
InternalMode INTERNAL_MODE_DISABLED = 0
El nodo no será interno.
InternalMode INTERNAL_MODE_FRONT = 1
El nodo se colocará al principio de los hijos del padre, antes de cualquier hermano no interno.
InternalMode INTERNAL_MODE_BACK = 2
El nodo se colocará al final de los hijos del padre, después de cualquier hermano no interno.
enum AutoTranslateMode: 🔗
AutoTranslateMode AUTO_TRANSLATE_MODE_INHERIT = 0
Hereda auto_translate_mode del padre del nodo. Este es el valor por defecto para cualquier nodo recién creado.
AutoTranslateMode AUTO_TRANSLATE_MODE_ALWAYS = 1
Siempre traducir automáticamente. Esta es la inversa de AUTO_TRANSLATE_MODE_DISABLED, y el valor por defecto para el nodo raíz.
AutoTranslateMode AUTO_TRANSLATE_MODE_DISABLED = 2
Never automatically translate. This is the inverse of AUTO_TRANSLATE_MODE_ALWAYS.
String parsing for translation template generation will be skipped for this node and children that are set to AUTO_TRANSLATE_MODE_INHERIT.
Constantes
NOTIFICATION_ENTER_TREE = 10 🔗
Notificación recibida cuando el nodo entra en un SceneTree. Véase _enter_tree().
Esta notificación se recibe antes de la señal tree_entered relacionada.
NOTIFICATION_EXIT_TREE = 11 🔗
Notification received when the node is about to exit a SceneTree. See _exit_tree().
This notification is received after the related tree_exiting signal.
This notification is sent in reversed order.
NOTIFICATION_MOVED_IN_PARENT = 12 🔗
Obsoleto: This notification is no longer sent by the engine. Use NOTIFICATION_CHILD_ORDER_CHANGED instead.
NOTIFICATION_READY = 13 🔗
Notificación recibida cuando el nodo esté listo. Véase _ready().
NOTIFICATION_PAUSED = 14 🔗
Notificación recibida cuando el nodo está en pausa. Véase process_mode.
NOTIFICATION_UNPAUSED = 15 🔗
Notificación recibida cuando se reanuda la pausa del nodo. Véase process_mode.
NOTIFICATION_PHYSICS_PROCESS = 16 🔗
Notificación recibida del árbol en cada cuadro de física cuando is_physics_processing() devuelve true. Véase _physics_process().
NOTIFICATION_PROCESS = 17 🔗
Notification received from the tree every rendered frame when is_processing() returns true. See _process().
NOTIFICATION_PARENTED = 18 🔗
Notification received when the node is set as a child of another node (see add_child() and add_sibling()).
Note: This does not mean that the node entered the SceneTree.
NOTIFICATION_UNPARENTED = 19 🔗
Notification received when the parent node calls remove_child() on this node.
Note: This does not mean that the node exited the SceneTree.
NOTIFICATION_SCENE_INSTANTIATED = 20 🔗
Notification received only by the newly instantiated scene root node, when PackedScene.instantiate() is completed.
NOTIFICATION_DRAG_BEGIN = 21 🔗
Notification received when a drag operation begins. All nodes receive this notification, not only the dragged one.
Can be triggered either by dragging a Control that provides drag data (see Control._get_drag_data()) or using Control.force_drag().
Use Viewport.gui_get_drag_data() to get the dragged data.
NOTIFICATION_DRAG_END = 22 🔗
Notification received when a drag operation ends.
Use Viewport.gui_is_drag_successful() to check if the drag succeeded.
NOTIFICATION_PATH_RENAMED = 23 🔗
Notification received when the node's name or one of its ancestors' name is changed. This notification is not received when the node is removed from the SceneTree.
NOTIFICATION_CHILD_ORDER_CHANGED = 24 🔗
Notification received when the list of children is changed. This happens when child nodes are added, moved or removed.
NOTIFICATION_INTERNAL_PROCESS = 25 🔗
Notification received from the tree every rendered frame when is_processing_internal() returns true.
NOTIFICATION_INTERNAL_PHYSICS_PROCESS = 26 🔗
Notification received from the tree every physics frame when is_physics_processing_internal() returns true.
NOTIFICATION_POST_ENTER_TREE = 27 🔗
Notification received when the node enters the tree, just before NOTIFICATION_READY may be received. Unlike the latter, it is sent every time the node enters tree, not just once.
NOTIFICATION_DISABLED = 28 🔗
Notificación recibida cuando el nodo está deshabilitado. Véase PROCESS_MODE_DISABLED.
NOTIFICATION_ENABLED = 29 🔗
Notification received when the node is enabled again after being disabled. See PROCESS_MODE_DISABLED.
NOTIFICATION_RESET_PHYSICS_INTERPOLATION = 2001 🔗
Notification received when reset_physics_interpolation() is called on the node or its ancestors.
NOTIFICATION_EDITOR_PRE_SAVE = 9001 🔗
Notification received right before the scene with the node is saved in the editor. This notification is only sent in the Godot editor and will not occur in exported projects.
NOTIFICATION_EDITOR_POST_SAVE = 9002 🔗
Notification received right after the scene with the node is saved in the editor. This notification is only sent in the Godot editor and will not occur in exported projects.
NOTIFICATION_WM_MOUSE_ENTER = 1002 🔗
Notification received when the mouse enters the window.
Implemented for embedded windows and on desktop and web platforms.
NOTIFICATION_WM_MOUSE_EXIT = 1003 🔗
Notification received when the mouse leaves the window.
Implemented for embedded windows and on desktop and web platforms.
NOTIFICATION_WM_WINDOW_FOCUS_IN = 1004 🔗
Notification received from the OS when the node's Window ancestor is focused. This may be a change of focus between two windows of the same engine instance, or from the OS desktop or a third-party application to a window of the game (in which case NOTIFICATION_APPLICATION_FOCUS_IN is also received).
A Window node receives this notification when it is focused.
NOTIFICATION_WM_WINDOW_FOCUS_OUT = 1005 🔗
Notification received from the OS when the node's Window ancestor is defocused. This may be a change of focus between two windows of the same engine instance, or from a window of the game to the OS desktop or a third-party application (in which case NOTIFICATION_APPLICATION_FOCUS_OUT is also received).
A Window node receives this notification when it is defocused.
NOTIFICATION_WM_CLOSE_REQUEST = 1006 🔗
Notification received from the OS when a close request is sent (e.g. closing the window with a "Close" button or Alt + F4).
Implemented on desktop platforms.
NOTIFICATION_WM_GO_BACK_REQUEST = 1007 🔗
Notification received from the OS when a go back request is sent (e.g. pressing the "Back" button on Android).
Implemented only on Android.
NOTIFICATION_WM_SIZE_CHANGED = 1008 🔗
Notification received when the window is resized.
Note: Only the resized Window node receives this notification, and it's not propagated to the child nodes.
NOTIFICATION_WM_DPI_CHANGE = 1009 🔗
Notification received from the OS when the screen's dots per inch (DPI) scale is changed. Only implemented on macOS.
NOTIFICATION_VP_MOUSE_ENTER = 1010 🔗
Notification received when the mouse cursor enters the Viewport's visible area, that is not occluded behind other Controls or Windows, provided its Viewport.gui_disable_input is false and regardless if it's currently focused or not.
NOTIFICATION_VP_MOUSE_EXIT = 1011 🔗
Notification received when the mouse cursor leaves the Viewport's visible area, that is not occluded behind other Controls or Windows, provided its Viewport.gui_disable_input is false and regardless if it's currently focused or not.
NOTIFICATION_WM_POSITION_CHANGED = 1012 🔗
Notification received when the window is moved.
NOTIFICATION_OS_MEMORY_WARNING = 2009 🔗
Notification received from the OS when the application is exceeding its allocated memory.
Implemented only on iOS.
NOTIFICATION_TRANSLATION_CHANGED = 2010 🔗
Notificación recibida cuando las traducciones pueden haber cambiado. Puede ser activada por el usuario al cambiar la configuración regional, al cambiar auto_translate_mode o cuando el nodo entra en el árbol de la escena. Puede utilizarse para responder a cambios de idioma, por ejemplo, para cambiar las cadenas de la interfaz de usuario sobre la marcha. Útil cuando se trabaja con el soporte de traducción integrado, como Object.tr().
Nota: Esta notificación se recibe junto con NOTIFICATION_ENTER_TREE, así que si estás instanciando una escena, los nodos hijos aún no estarán inicializados. Puedes usarla para configurar las traducciones de este nodo, de los nodos hijos creados a partir de script, o si quieres acceder a los nodos hijos añadidos en el editor, asegúrate de que el nodo esté listo usando is_node_ready().
func _notification(what):
if what == NOTIFICATION_TRANSLATION_CHANGED:
if not is_node_ready():
await ready # Esperar hasta la señal de ready.
$Label.text = atr("%d Bananas") % banana_counter
NOTIFICATION_WM_ABOUT = 2011 🔗
Notificación recibida del sistema operativo cuando se envía una solicitud de información "Acerca de".
Implementado solo en macOS.
NOTIFICATION_CRASH = 2012 🔗
Notificación recibida del controlador de fallos de Godot cuando el motor está a punto de fallar.
Implementado en las plataformas de escritorio si el manejador de fallos está habilitado.
NOTIFICATION_OS_IME_UPDATE = 2013 🔗
Notification received from the OS when an update of the Input Method Engine occurs (e.g. change of IME cursor position or composition string).
Implemented on desktop and web platforms.
NOTIFICATION_APPLICATION_RESUMED = 2014 🔗
Notificación recibida del sistema operativo cuando se reanuda la aplicación.
Específica de las plataformas Android e iOS.
NOTIFICATION_APPLICATION_PAUSED = 2015 🔗
Notificación recibida del sistema operativo cuando la aplicación se pausa.
Específica de las plataformas Android e iOS.
Nota: En iOS, solo tienes aproximadamente 5 segundos para finalizar una tarea iniciada por esta señal. Si superas esta asignación, iOS cerrará la aplicación en lugar de pausarla.
NOTIFICATION_APPLICATION_FOCUS_IN = 2016 🔗
Notificación recibida del sistema operativo cuando la aplicación está enfocada, es decir, cuando se cambia el foco del escritorio del sistema operativo o de una aplicación de terceros a cualquier ventana abierta de la instancia de Godot.
Implementado en plataformas de escritorio y móviles.
NOTIFICATION_APPLICATION_FOCUS_OUT = 2017 🔗
Notificación recibida del sistema operativo cuando la aplicación pierde el foco, es decir, cuando se cambia el foco de cualquier ventana abierta de la instancia de Godot al escritorio del sistema operativo o a una aplicación de terceros.
Implementado en plataformas de escritorio y móviles.
NOTIFICATION_TEXT_SERVER_CHANGED = 2018 🔗
Notificación recibida cuando el TextServer es cambiado.
NOTIFICATION_ACCESSIBILITY_UPDATE = 3000 🔗
Notificación recibida cuando se requiere una actualización de la información de accesibilidad.
NOTIFICATION_ACCESSIBILITY_INVALIDATE = 3001 🔗
Notificación recibida cuando los elementos de accesibilidad son invalidados. Todos los elementos de accesibilidad del nodo son eliminados automáticamente después de recibir este mensaje, por lo tanto, todas las referencias existentes a dichos elementos deben ser descartadas.
Descripciones de Propiedades
AutoTranslateMode auto_translate_mode = 0 🔗
void set_auto_translate_mode(value: AutoTranslateMode)
AutoTranslateMode get_auto_translate_mode()
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 translation template generation.
Note: For the root node, auto translate mode can also be set via ProjectSettings.internationalization/rendering/root_node_auto_translate.
String editor_description = "" 🔗
An optional description to the node. It will be displayed as a tooltip when hovering over the node in the editor's Scene dock.
MultiplayerAPI multiplayer 🔗
MultiplayerAPI get_multiplayer()
The MultiplayerAPI instance associated with this node. See SceneTree.get_multiplayer().
Note: Renaming the node, or moving it in the tree, will not move the MultiplayerAPI to the new path, you will have to update this manually.
StringName name 🔗
void set_name(value: StringName)
StringName get_name()
The name of the node. This name must be unique among the siblings (other child nodes from the same parent). When set to an existing sibling's name, the node is automatically renamed.
Note: When changing the name, the following characters will be replaced with an underscore: (. : @ / " %). In particular, the @ character is reserved for auto-generated names. See also String.validate_node_name().
The owner of this node. The owner must be an ancestor of this node. When packing the owner node in a PackedScene, all the nodes it owns are also saved with it. See also unique_name_in_owner.
Note: In the editor, nodes not owned by the scene root are usually not displayed in the Scene dock, and will not be saved. To prevent this, remember to set the owner after calling add_child().
Note: The owner needs to be the current scene root. See Instancing scenes in the documentation for more information.
PhysicsInterpolationMode physics_interpolation_mode = 0 🔗
void set_physics_interpolation_mode(value: PhysicsInterpolationMode)
PhysicsInterpolationMode get_physics_interpolation_mode()
The physics interpolation mode to use for this node. Only effective if ProjectSettings.physics/common/physics_interpolation or SceneTree.physics_interpolation is true.
By default, nodes inherit the physics interpolation mode from their parent. This property can enable or disable physics interpolation individually for each node, regardless of their parents' physics interpolation mode.
Note: Some node types like VehicleWheel3D have physics interpolation disabled by default, as they rely on their own custom solution.
Note: When teleporting a node to a distant position, it's recommended to temporarily disable interpolation with reset_physics_interpolation() after moving the node. This avoids creating a visual streak between the old and new positions.
ProcessMode process_mode = 0 🔗
void set_process_mode(value: ProcessMode)
ProcessMode get_process_mode()
The node's processing behavior. To check if the node can process in its current mode, use can_process().
int process_physics_priority = 0 🔗
Similar to process_priority but for NOTIFICATION_PHYSICS_PROCESS, _physics_process(), or NOTIFICATION_INTERNAL_PHYSICS_PROCESS.
The node's execution order of the process callbacks (_process(), NOTIFICATION_PROCESS, and NOTIFICATION_INTERNAL_PROCESS). Nodes whose priority value is lower call their process callbacks first, regardless of tree order.
ProcessThreadGroup process_thread_group = 0 🔗
void set_process_thread_group(value: ProcessThreadGroup)
ProcessThreadGroup get_process_thread_group()
Set the process thread group for this node (basically, whether it receives NOTIFICATION_PROCESS, NOTIFICATION_PHYSICS_PROCESS, _process() or _physics_process() (and the internal versions) on the main thread or in a sub-thread.
By default, the thread group is PROCESS_THREAD_GROUP_INHERIT, which means that this node belongs to the same thread group as the parent node. The thread groups means that nodes in a specific thread group will process together, separate to other thread groups (depending on process_thread_group_order). If the value is set is PROCESS_THREAD_GROUP_SUB_THREAD, this thread group will occur on a sub thread (not the main thread), otherwise if set to PROCESS_THREAD_GROUP_MAIN_THREAD it will process on the main thread. If there is not a parent or grandparent node set to something other than inherit, the node will belong to the default thread group. This default group will process on the main thread and its group order is 0.
During processing in a sub-thread, accessing most functions in nodes outside the thread group is forbidden (and it will result in an error in debug mode). Use Object.call_deferred(), call_thread_safe(), call_deferred_thread_group() and the likes in order to communicate from the thread groups to the main thread (or to other thread groups).
To better understand process thread groups, the idea is that any node set to any other value than PROCESS_THREAD_GROUP_INHERIT will include any child (and grandchild) nodes set to inherit into its process thread group. This means that the processing of all the nodes in the group will happen together, at the same time as the node including them.
int process_thread_group_order 🔗
Change the process thread group order. Groups with a lesser order will process before groups with a greater order. This is useful when a large amount of nodes process in sub thread and, afterwards, another group wants to collect their result in the main thread, as an example.
BitField[ProcessThreadMessages] process_thread_messages 🔗
void set_process_thread_messages(value: BitField[ProcessThreadMessages])
BitField[ProcessThreadMessages] get_process_thread_messages()
Set whether the current thread group will process messages (calls to call_deferred_thread_group() on threads), and whether it wants to receive them during regular process or physics process callbacks.
The original scene's file path, if the node has been instantiated from a PackedScene file. Only scene root nodes contains this.
bool unique_name_in_owner = false 🔗
If true, the node can be accessed from any node sharing the same owner or from the owner itself, with special %Name syntax in get_node().
Note: If another node with the same owner shares the same name as this node, the other node will no longer be accessible as unique.
Descripciones de Métodos
void _enter_tree() virtual 🔗
Se llama cuando el nodo entra en el SceneTree (por ejemplo, al instanciar, cambiar de escena o después de llamar a add_child() en un script). Si el nodo tiene hijos, su callback _enter_tree() se llamará primero, y luego la de los hijos.
Corresponde a la notificación NOTIFICATION_ENTER_TREE en Object._notification().
void _exit_tree() virtual 🔗
Llamado cuando el nodo está a punto de salir del SceneTree (por ejemplo, al liberarse, al cambiar de escena o después de llamar a remove_child() en un script). Si el nodo tiene hijos, su llamada a _exit_tree() se llamará al final, después de que todos sus hijos hayan dejado el árbol.
Corresponde a la notificación NOTIFICATION_EXIT_TREE en Object._notification() y a la señal tree_exiting. Para ser notificado cuando el nodo ya ha dejado el árbol activo, conéctese al tree_exited.
PackedStringArray _get_accessibility_configuration_warnings() virtual const 🔗
Los elementos en el array devuelto por este método se muestran como advertencias en el dock de la escena si el script que lo sobrescribe es un script tool, y las advertencias de accesibilidad están habilitadas en la configuración del editor.
Devolver un array vacío no produce advertencias.
PackedStringArray _get_configuration_warnings() virtual const 🔗
Los elementos del array devuelto por este método se muestran como advertencias en el dock Escena si el script que lo sobrescribe es un script tool.
Devolver un array vacío no produce advertencias.
Llama a update_configuration_warnings() cuando sea necesario actualizar las advertencias de configuración de este nodo.
@export var energy = 0:
set(value):
energy = value
update_configuration_warnings()
func _get_configuration_warnings():
if energy < 0:
return ["La energía debe ser 0 o mayor."]
else:
return []
RID _get_focused_accessibility_element() virtual const 🔗
Se llama durante las actualizaciones de la información de accesibilidad para determinar el subelemento actualmente enfocado; debe devolver un RID de subelemento o el valor devuelto por get_accessibility_element().
void _input(event: InputEvent) virtual 🔗
Se llama cuando hay un evento de entrada. El evento de entrada se propaga a través del árbol de nodos hasta que un nodo lo consume.
Solo se llama si el procesamiento de entrada está habilitado, lo que se hace automáticamente si se sobrescribe este método y se puede alternar con set_process_input().
Para consumir el evento de entrada y evitar que se propague a otros nodos, se puede llamar a Viewport.set_input_as_handled().
Para la entrada de juego, _unhandled_input() y _unhandled_key_input() suelen ser una mejor opción, ya que permiten que la GUI intercepte los eventos primero.
Nota: Este método solo se llama si el nodo está presente en el árbol de escenas (es decir, si no es huérfano).
void _physics_process(delta: float) virtual 🔗
Se llama una vez en cada ciclo de física y permite a los Nodos sincronizar su lógica con los ciclos de física. delta es el tiempo lógico entre ciclos de física en segundos y es igual a Engine.time_scale / Engine.physics_ticks_per_second.
Solo se llama si el procesamiento de física está habilitado para este Nodo, lo que se hace automáticamente si se sobrescribe este método y se puede alternar con set_physics_process().
El procesamiento se realiza en orden de process_physics_priority, los valores de prioridad más bajos se llaman primero. Los nodos con la misma prioridad se procesan en orden de árbol, o de arriba a abajo como se ve en el editor (también conocido como recorrido de preorden).
Corresponde a la notificación NOTIFICATION_PHYSICS_PROCESS en Object._notification().
Nota: Este método solo se llama si el nodo está presente en el árbol de escenas (es decir, si no es huérfano).
Nota: El delta acumulado puede diferir de los segundos del mundo real.
void _process(delta: float) virtual 🔗
Se llama en cada fotograma inactivo, antes de la renderización y después de que se hayan procesado los ciclos de física. delta es el tiempo entre fotogramas en segundos.
Solo se llama si el procesamiento está habilitado para este Nodo, lo que se hace automáticamente si se sobrescribe este método y se puede alternar con set_process().
El procesamiento se realiza en orden de process_priority, los valores de prioridad más bajos se llaman primero. Los nodos con la misma prioridad se procesan en orden de árbol, o de arriba a abajo como se ve en el editor (también conocido como recorrido de preorden).
Corresponde a la notificación NOTIFICATION_PROCESS en Object._notification().
Nota: Este método solo se llama si el nodo está presente en el árbol de escenas (es decir, si no es huérfano).
Nota: Cuando el motor está teniendo dificultades y la velocidad de fotogramas se reduce, delta aumentará. Cuando delta aumenta, se limita a un máximo de Engine.time_scale * Engine.max_physics_steps_per_frame / Engine.physics_ticks_per_second. Como resultado, el delta acumulado puede no representar el tiempo del mundo real.
Nota: Cuando --fixed-fps está habilitado o el motor se está ejecutando en modo Movie Maker (ver MovieWriter), el proceso delta siempre será el mismo para cada fotograma, independientemente de cuánto tiempo tarde el fotograma en renderizarse.
Nota: El delta de fotogramas puede ser post-procesado por OS.delta_smoothing si esto está habilitado para el proyecto.
void _ready() virtual 🔗
Se llama cuando el nodo está "listo", es decir, cuando tanto el nodo como sus hijos han entrado en el árbol de escenas. Si el nodo tiene hijos, sus callbacks _ready() se activan primero, y el nodo padre recibirá la notificación de listo después.
Corresponde a la notificación NOTIFICATION_READY en Object._notification(). Véase también la anotación @onready para las variables.
Normalmente se usa para la inicialización. Para una inicialización aún más temprana, se puede usar Object._init(). Véase también _enter_tree().
Nota: Este método se puede llamar solo una vez para cada nodo. Después de eliminar un nodo del árbol de escenas y volver a agregarlo, _ready() no se llamará una segunda vez. Esto se puede evitar solicitando otra llamada con request_ready(), que se puede llamar en cualquier lugar antes de volver a agregar el nodo.
void _shortcut_input(event: InputEvent) virtual 🔗
Se llama cuando un InputEventKey, InputEventShortcut o InputEventJoypadButton no ha sido consumido por _input() o cualquier elemento Control de la GUI. Se llama antes de _unhandled_key_input() y _unhandled_input(). El evento de entrada se propaga a través del árbol de nodos hasta que un nodo lo consume.
Solo se llama si el procesamiento de atajos está habilitado, lo que se hace automáticamente si se sobrescribe este método y se puede alternar con set_process_shortcut_input().
Para consumir el evento de entrada y evitar que se propague a otros nodos, se puede llamar a Viewport.set_input_as_handled().
Este método se puede usar para manejar atajos. Para eventos genéricos de la GUI, usa _input() en su lugar. Los eventos de juego generalmente deben manejarse con _unhandled_input() o _unhandled_key_input().
Nota: Este método solo se llama si el nodo está presente en el árbol de escenas (es decir, si no es huérfano).
void _unhandled_input(event: InputEvent) virtual 🔗
Called when an InputEvent hasn't been consumed by _input() or any GUI Control item. It is called after _shortcut_input() and after _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 set_process_unhandled_input().
To consume the input event and stop it propagating further to other nodes, Viewport.set_input_as_handled() can be called.
For gameplay input, this method is usually a better fit than _input(), as GUI events need a higher priority. For keyboard shortcuts, consider using _shortcut_input() instead, as it is called before this method. Finally, to handle keyboard events, consider using _unhandled_key_input() for performance reasons.
Note: This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
void _unhandled_key_input(event: InputEvent) virtual 🔗
Called when an InputEventKey hasn't been consumed by _input() or any GUI Control item. It is called after _shortcut_input() but before _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 set_process_unhandled_key_input().
To consume the input event and stop it propagating further to other nodes, Viewport.set_input_as_handled() can be called.
This method can be used to handle Unicode character input with Alt, Alt + Ctrl, and Alt + Shift modifiers, after shortcuts were handled.
For gameplay input, this and _unhandled_input() are usually a better fit than _input(), as GUI events should be handled first. This method also performs better than _unhandled_input(), since unrelated events such as InputEventMouseMotion are automatically filtered. For shortcuts, consider using _shortcut_input() instead.
Note: This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
void add_child(node: Node, force_readable_name: bool = false, internal: InternalMode = 0) 🔗
Adds a child 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 force_readable_name is true, improves the readability of the added node. If not named, the node is renamed to its type, and if it shares name with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to false, which assigns a dummy name featuring @ in both situations.
If internal is different than INTERNAL_MODE_DISABLED, the child will be added as internal node. These nodes are ignored by methods like get_children(), unless their parameter include_internal is true. It also prevents these nodes being duplicated with their parent. 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.
Note: If node already has a parent, this method will fail. Use remove_child() first to remove node from its current parent. For example:
var child_node = get_child(0)
if child_node.get_parent():
child_node.get_parent().remove_child(child_node)
add_child(child_node)
Node childNode = GetChild(0);
if (childNode.GetParent() != null)
{
childNode.GetParent().RemoveChild(childNode);
}
AddChild(childNode);
If you need the child node to be added below a specific node in the list of children, use add_sibling() instead of this method.
Note: If you want a child to be persisted to a PackedScene, you must set owner in addition to calling add_child(). This is typically relevant for tool scripts and editor plugins. If add_child() is called without setting owner, the newly added Node will not be visible in the scene tree, though it will be visible in the 2D/3D view.
void add_sibling(sibling: Node, force_readable_name: bool = false) 🔗
Adds a sibling node to this node's parent, and moves the added sibling right below this node.
If force_readable_name is true, improves the readability of the added sibling. If not named, the sibling is renamed to its type, and if it shares name with a sibling, a number is suffixed more appropriately. This operation is very slow. As such, it is recommended leaving this to false, which assigns a dummy name featuring @ in both situations.
Use 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.
Note: If this node is internal, the added sibling will be internal too (see add_child()'s internal parameter).
void add_to_group(group: StringName, persistent: bool = false) 🔗
Adds the node to the group. Groups can be helpful to organize a subset of nodes, for example "enemies" or "collectables". See notes in the description, and the group methods in SceneTree.
If persistent is true, the group will be stored when saved inside a PackedScene. All groups created and displayed in the Groups dock are persistent.
Note: To improve performance, the order of group names is not guaranteed and may vary between project runs. Therefore, do not rely on the group order.
Note: SceneTree's group methods will not work on this node if not inside the tree (see is_inside_tree()).
String atr(message: String, context: StringName = "") const 🔗
Translates a message, using the translation catalogs configured in the Project Settings. Further 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 Object.tr(), with the addition of respecting the auto_translate_mode state.
If Object.can_translate_messages() is false, or no translation is available, this method returns the message without changes. See Object.set_message_translation().
For detailed examples, see Internationalizing games.
String atr_n(message: String, plural_message: StringName, n: int, context: StringName = "") const 🔗
Translates a message or plural_message, using the translation catalogs configured in the Project Settings. Further context can be specified to help with the translation.
This method works the same as Object.tr_n(), with the addition of respecting the auto_translate_mode state.
If Object.can_translate_messages() is false, or no translation is available, this method returns message or plural_message, without changes. See Object.set_message_translation().
The 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 Localization using gettext.
Note: Negative and float numbers may not properly apply to some countable subjects. It's recommended to handle these cases with atr().
Variant call_deferred_thread_group(method: StringName, ...) vararg 🔗
This function is similar to Object.call_deferred() except that the call will take place when the node thread group is processed. If the node thread group processes in sub-threads, then the call will be done on that thread, right before NOTIFICATION_PROCESS or NOTIFICATION_PHYSICS_PROCESS, the _process() or _physics_process() or their internal versions are called.
Variant call_thread_safe(method: StringName, ...) vararg 🔗
This function ensures that the calling of this function will succeed, no matter whether it's being done from a thread or not. If called from a thread that is not allowed to call the function, the call will become deferred. Otherwise, the call will go through directly.
bool can_auto_translate() const 🔗
Returns true if this node can automatically translate messages depending on the current locale. See auto_translate_mode, atr(), and atr_n().
Returns true if the node can receive processing notifications and input callbacks (NOTIFICATION_PROCESS, _input(), etc.) from the SceneTree and Viewport. The returned value depends on process_mode:
If set to PROCESS_MODE_PAUSABLE, returns
truewhen the game is processing, i.e. SceneTree.paused isfalse;If set to PROCESS_MODE_WHEN_PAUSED, returns
truewhen the game is paused, i.e. SceneTree.paused istrue;If set to PROCESS_MODE_ALWAYS, always returns
true;If set to PROCESS_MODE_DISABLED, always returns
false;If set to PROCESS_MODE_INHERIT, use the parent node's process_mode to determine the result.
If the node is not inside the tree, returns false no matter the value of process_mode.
Creates a new Tween and binds it to this node.
This is the equivalent of doing:
get_tree().create_tween().bind_node(self)
GetTree().CreateTween().BindNode(this);
The Tween will start automatically on the next process frame or physics frame (depending on TweenProcessMode). See Tween.bind_node() for more info on Tweens bound to nodes.
Note: 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.
Node duplicate(flags: int = 15) const 🔗
Duplicates the node, returning a new node with all of its properties, signals, groups, and children copied from the original, recursively. The behavior can be tweaked through the flags (see DuplicateFlags). Internal nodes are not duplicated.
Note: For nodes with a Script attached, if Object._init() has been defined with required parameters, the duplicated node will not have a Script.
Note: By default, this method will duplicate only properties marked for serialization (i.e. using @GlobalScope.PROPERTY_USAGE_STORAGE, or in GDScript, @GDScript.@export). If you want to duplicate all properties, use DUPLICATE_INTERNAL_STATE.
Node find_child(pattern: String, recursive: bool = true, owned: bool = true) const 🔗
Finds the first descendant of this node whose name matches pattern, returning null if no match is found. The matching is done against node names, not their paths, through String.match(). As such, it is case-sensitive, "*" matches zero or more characters, and "?" matches any single character.
If recursive is false, 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 internal parameter in add_child()).
If owned is true, only descendants with a valid owner node are checked.
Note: This method can be very slow. Consider storing a reference to the found node in a variable. Alternatively, use get_node() with unique names (see unique_name_in_owner).
Note: To find all descendant nodes matching a pattern or a class type, see find_children().
Array[Node] find_children(pattern: String, type: String = "", recursive: bool = true, owned: bool = true) const 🔗
Finds all descendants of this node whose names match pattern, returning an empty Array if no match is found. The matching is done against node names, not their paths, through String.match(). As such, it is case-sensitive, "*" matches zero or more characters, and "?" matches any single character.
If type is not empty, only ancestors inheriting from type are included (see Object.is_class()).
If recursive is false, 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 internal parameter in add_child()).
If owned is true, only descendants with a valid owner node are checked.
Note: This method can be very slow. Consider storing references to the found nodes in a variable.
Note: To find a single descendant node matching a pattern, see find_child().
Node find_parent(pattern: String) const 🔗
Finds the first ancestor of this node whose name matches pattern, returning null if no match is found. The matching is done through String.match(). As such, it is case-sensitive, "*" matches zero or more characters, and "?" matches any single character. See also find_child() and find_children().
Note: 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 get_node() with unique names (see unique_name_in_owner).
RID get_accessibility_element() const 🔗
Returns main accessibility element RID.
Note: This method should be called only during accessibility information updates (NOTIFICATION_ACCESSIBILITY_UPDATE).
Node get_child(idx: int, include_internal: bool = false) const 🔗
Fetches a child node by its index. Each child node has an index relative to its siblings (see 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 get_child_count() to iterate over this node's children. If no child exists at the given index, this method returns null and an error is generated.
If include_internal is false, internal children are ignored (see add_child()'s internal parameter).
# 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"
Note: To fetch a node by NodePath, use get_node().
int get_child_count(include_internal: bool = false) const 🔗
Returns the number of children of this node.
If include_internal is false, internal children are not counted (see add_child()'s internal parameter).
Array[Node] get_children(include_internal: bool = false) const 🔗
Returns all children of this node inside an Array.
If include_internal is false, excludes internal children from the returned array (see add_child()'s internal parameter).
Array[StringName] get_groups() const 🔗
Returns an Array of group names that the node has been added to.
Note: To improve performance, the order of group names is not guaranteed and may vary between project runs. Therefore, do not rely on the group order.
Note: This method may also return some group names starting with an underscore (_). 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:
# 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)
// 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);
}
int get_index(include_internal: bool = false) const 🔗
Returns this node's order among its siblings. The first node's index is 0. See also get_child().
If include_internal is false, returns the index ignoring internal children. The first, non-internal child will have an index of 0 (see add_child()'s internal parameter).
Window get_last_exclusive_window() const 🔗
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.
int get_multiplayer_authority() const 🔗
Returns the peer ID of the multiplayer authority for this node. See set_multiplayer_authority().
Node get_node(path: NodePath) const 🔗
Obtiene un nodo. La NodePath puede ser una ruta relativa (desde este nodo) o una ruta absoluta (desde el SceneTree.root) a un nodo. Si path no apunta a un nodo válido, genera un error y devuelve null. Los intentos de acceder a métodos sobre el valor de retorno resultarán en un error "Intento de llamar a".
Nota: La obtención por ruta absoluta solo funciona cuando el nodo está dentro del árbol de escenas (véase is_inside_tree()).
Ejemplo: Asume que este método es llamado desde el nodo Character, dentro del siguiente árbol:
┖╴root
┠╴Character (¡estás aquí!)
┃ ┠╴Sword
┃ ┖╴Backpack
┃ ┖╴Dagger
┠╴MyGame
┖╴Swamp
┠╴Alligator
┠╴Mosquito
┖╴Goblin
Las siguientes llamadas devolverán un nodo válido:
get_node("Sword")
get_node("Backpack/Dagger")
get_node("../Swamp/Alligator")
get_node("/root/MyGame")
GetNode("Sword");
GetNode("Backpack/Dagger");
GetNode("../Swamp/Alligator");
GetNode("/root/MyGame");
Array get_node_and_resource(path: NodePath) 🔗
Fetches a node and its most nested resource as specified by the NodePath's subname. Returns an Array of size 3 where:
Element
0is the Node, ornullif not found;Element
1is the subname's last nested Resource, ornullif not found;Element
2is the remaining NodePath, referring to an existing, non-Resource property (see Object.get_indexed()).
Example: Assume that the child's Sprite2D.texture has been assigned an AtlasTexture:
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"
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"
Node get_node_or_null(path: NodePath) const 🔗
Fetches a node by NodePath. Similar to get_node(), but does not generate an error if path does not point to a valid node.
Variant get_node_rpc_config() const 🔗
Returns a Dictionary mapping method names to their RPC configuration defined for this node using rpc_config().
Note: This method only returns the RPC configuration assigned via rpc_config(). See Script.get_rpc_config() to retrieve the RPCs defined by the Script.
Array[int] get_orphan_node_ids() static 🔗
Returns object IDs of all orphan nodes (nodes outside the SceneTree). Used for debugging.
Note: get_orphan_node_ids() only works in debug builds. When called in a project exported in release mode, get_orphan_node_ids() will return an empty array.
Returns this node's parent node, or null if the node doesn't have a parent.
Returns the node's absolute path, relative to the SceneTree.root. If the node is not inside the scene tree, this method fails and returns an empty NodePath.
NodePath get_path_to(node: Node, use_unique_path: bool = false) const 🔗
Returns the relative NodePath from this node to the specified node. Both nodes must be in the same SceneTree or scene hierarchy, otherwise this method fails and returns an empty NodePath.
If use_unique_path is true, returns the shortest path accounting for this node's unique name (see unique_name_in_owner).
Note: 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.
float get_physics_process_delta_time() const 🔗
Returns the time elapsed (in seconds) since the last physics callback. This value is identical to _physics_process()'s delta parameter, and is often consistent at run-time, unless Engine.physics_ticks_per_second is changed. See also NOTIFICATION_PHYSICS_PROCESS.
Note: The returned value will be larger than expected if running at a framerate lower than Engine.physics_ticks_per_second / Engine.max_physics_steps_per_frame FPS. This is done to avoid "spiral of death" scenarios where performance would plummet due to an ever-increasing number of physics steps per frame. This behavior affects both _process() and _physics_process(). As a result, avoid using delta for time measurements in real-world seconds. Use the Time singleton's methods for this purpose instead, such as Time.get_ticks_usec().
float get_process_delta_time() const 🔗
Returns the time elapsed (in seconds) since the last process callback. This value is identical to _process()'s delta parameter, and may vary from frame to frame. See also NOTIFICATION_PROCESS.
Note: The returned value will be larger than expected if running at a framerate lower than Engine.physics_ticks_per_second / Engine.max_physics_steps_per_frame FPS. This is done to avoid "spiral of death" scenarios where performance would plummet due to an ever-increasing number of physics steps per frame. This behavior affects both _process() and _physics_process(). As a result, avoid using delta for time measurements in real-world seconds. Use the Time singleton's methods for this purpose instead, such as Time.get_ticks_usec().
bool get_scene_instance_load_placeholder() const 🔗
Returns true if this node is an instance load placeholder. See InstancePlaceholder and set_scene_instance_load_placeholder().
Returns the SceneTree that contains this node. If this node is not inside the tree, generates an error and returns null. See also is_inside_tree().
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 get_node() function. It also can be used in game UI/UX.
May print, for example:
TheGame
TheGame/Menu
TheGame/Menu/Label
TheGame/Menu/Camera2D
TheGame/SplashScreen
TheGame/SplashScreen/Camera2D
String get_tree_string_pretty() 🔗
Similar to 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:
┖╴TheGame
┠╴Menu
┃ ┠╴Label
┃ ┖╴Camera2D
┖╴SplashScreen
┖╴Camera2D
Viewport get_viewport() const 🔗
Returns the node's closest Viewport ancestor, if the node is inside the tree. Otherwise, returns null.
Returns the Window that contains this node. If the node is in the main window, this is equivalent to getting the root node (get_tree().get_root()).
bool has_node(path: NodePath) const 🔗
Returns true if the path points to a valid node. See also get_node().
bool has_node_and_resource(path: NodePath) const 🔗
Returns true if path points to a valid node and its subnames point to a valid Resource, e.g. Area2D/CollisionShape2D:shape. Properties that are not Resource types (such as nodes or other Variant types) are not considered. See also get_node_and_resource().
bool is_ancestor_of(node: Node) const 🔗
Returns true if the given node is a direct or indirect child of this node.
bool is_displayed_folded() const 🔗
Returns true if the node is folded (collapsed) in the Scene dock. This method is intended to be used in editor plugins and tools. See also set_display_folded().
bool is_editable_instance(node: Node) const 🔗
Returns true if node has editable children enabled relative to this node. This method is intended to be used in editor plugins and tools. See also set_editable_instance().
bool is_greater_than(node: Node) const 🔗
Returns true if the given node occurs later in the scene hierarchy than this node. A node occurring later is usually processed last.
bool is_in_group(group: StringName) const 🔗
Returns true if this node has been added to the given group. See add_to_group() and remove_from_group(). See also notes in the description, and the SceneTree's group methods.
Returns true if this node is currently inside a SceneTree. See also get_tree().
bool is_multiplayer_authority() const 🔗
Returns true if the local system is the multiplayer authority of this node.
Returns true if the node is ready, i.e. it's inside scene tree and all its children are initialized.
request_ready() resets it back to false.
bool is_part_of_edited_scene() const 🔗
Returns true if the node is part of the scene currently opened in the editor.
bool is_physics_interpolated() const 🔗
Returns true if physics interpolation is enabled for this node (see physics_interpolation_mode).
Note: Interpolation will only be active if both the flag is set and physics interpolation is enabled within the SceneTree. This can be tested using is_physics_interpolated_and_enabled().
bool is_physics_interpolated_and_enabled() const 🔗
Returns true if physics interpolation is enabled (see physics_interpolation_mode) and enabled in the SceneTree.
This is a convenience version of is_physics_interpolated() that also checks whether physics interpolation is enabled globally.
See SceneTree.physics_interpolation and ProjectSettings.physics/common/physics_interpolation.
bool is_physics_processing() const 🔗
Devuelve true si el procesamiento de la física está activado (véase set_physics_process()).
bool is_physics_processing_internal() const 🔗
Devuelve true si el procesamiento de la física interna está activado (véase set_physics_process_internal()).
Devuelve true si el procesamiento está activado (véase set_process()).
bool is_processing_input() const 🔗
Devuelve true si el nodo está procesando la entrada (ver set_process_input()).
bool is_processing_internal() const 🔗
Devuelve true si el procesamiento interno está activado (véase set_process_internal()).
bool is_processing_shortcut_input() const 🔗
Returns true if the node is processing shortcuts (see set_process_shortcut_input()).
bool is_processing_unhandled_input() const 🔗
Devuelve true si el nodo está procesando una entrada no manejada (véase set_process_unhandled_input()).
bool is_processing_unhandled_key_input() const 🔗
Devuelve true si el nodo está procesando una entrada de clave no manejada (véase set_process_unhandled_key_input()).
void move_child(child_node: Node, to_index: int) 🔗
Moves child_node to the given index. A node's index is the order among its siblings. If to_index is negative, the index is counted from the end of the list. See also get_child() and get_index().
Note: The processing order of several engine callbacks (_ready(), _process(), etc.) and notifications sent through propagate_notification() is affected by tree order. CanvasItem nodes are also rendered in tree order. See also process_priority.
void notify_deferred_thread_group(what: int) 🔗
Similar to call_deferred_thread_group(), but for notifications.
void notify_thread_safe(what: int) 🔗
Similar to call_thread_safe(), but for notifications.
void print_orphan_nodes() static 🔗
Prints all orphan nodes (nodes outside the SceneTree). Useful for debugging.
Note: This method only works in debug builds. It does nothing in a project exported in release mode.
void print_tree() 🔗
Imprime el nodo y sus hijos en la consola, recursivamente. El nodo no tiene que estar dentro del árbol. Este método imprime NodePaths relativas a este nodo, y es útil para copiar/pegar en get_node(). Mira también print_tree_pretty().
Puede imprimir, por ejemplo:
.
Menu
Menu/Label
Menu/Camera2D
SplashScreen
SplashScreen/Camera2D
void print_tree_pretty() 🔗
Prints the node and its children to the console, recursively. The node does not have to be inside the tree. Similar to 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:
┖╴TheGame
┠╴Menu
┃ ┠╴Label
┃ ┖╴Camera2D
┖╴SplashScreen
┖╴Camera2D
void propagate_call(method: StringName, args: Array = [], parent_first: bool = false) 🔗
Calls the given method name, passing args as arguments, on this node and all of its children, recursively.
If parent_first is true, the method is called on this node first, then on all of its children. If false, the children's methods are called first.
void propagate_notification(what: int) 🔗
Calls Object.notification() with what on this node and all of its children, recursively.
void queue_accessibility_update() 🔗
Queues an accessibility information update for this node.
void queue_free() 🔗
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 Object.free(), the node is not deleted instantly, and it can still be accessed before deletion. It is also safe to call queue_free() multiple times. Use Object.is_queued_for_deletion() to check if the node will be deleted at the end of the frame.
Note: The node will only be freed after all other deferred calls are finished. Using this method is not always the same as calling Object.free() through Object.call_deferred().
void remove_child(node: Node) 🔗
Removes a child node. The node, along with its children, are not deleted. To delete a node, see queue_free().
Note: When this node is inside the tree, this method sets the owner of the removed node (or its descendants) to null, if their owner is no longer an ancestor (see is_ancestor_of()).
void remove_from_group(group: StringName) 🔗
Removes the node from the given group. Does nothing if the node is not in the group. See also notes in the description, and the SceneTree's group methods.
void reparent(new_parent: Node, keep_global_transform: bool = true) 🔗
Changes the parent of this Node to the new_parent. The node needs to already have a parent. The node's 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 keep_global_transform is true, the node's global transform will be preserved if supported. Node2D, Node3D and Control support this argument (but Control keeps only position).
void replace_by(node: Node, keep_groups: bool = false) 🔗
Replaces this node by the given node. All children of this node are moved to node.
If keep_groups is true, the node is added to the same groups that the replaced node is in (see add_to_group()).
Warning: The replaced node is removed from the tree, but it is not deleted. To prevent memory leaks, store a reference to the node in a variable, or use Object.free().
void request_ready() 🔗
Requests _ready() to be called again the next time the node enters the tree. Does not immediately call _ready().
Note: 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 _ready() callbacks will be the same as normal.
void reset_physics_interpolation() 🔗
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 NOTIFICATION_RESET_PHYSICS_INTERPOLATION will be received by the node and all children recursively.
Note: This function should be called after moving the node, rather than before.
Error rpc(method: StringName, ...) vararg 🔗
Sends a remote procedure call request for the given method to peers on the network (and locally), sending additional arguments to the method called by the RPC. The call request will only be received by nodes with the same NodePath, including the exact same name. Behavior depends on the RPC configuration for the given method (see rpc_config() and @GDScript.@rpc). By default, methods are not exposed to RPCs.
May return @GlobalScope.OK if the call is successful, @GlobalScope.ERR_INVALID_PARAMETER if the arguments passed in the method do not match, @GlobalScope.ERR_UNCONFIGURED if the node's multiplayer cannot be fetched (such as when the node is not inside the tree), @GlobalScope.ERR_CONNECTION_ERROR if multiplayer's connection is not available.
Note: You can only safely use RPCs on clients after you received the MultiplayerAPI.connected_to_server signal from the MultiplayerAPI. You also need to keep track of the connection state, either by the MultiplayerAPI signals like MultiplayerAPI.server_disconnected or by checking (get_multiplayer().peer.get_connection_status() == CONNECTION_CONNECTED).
void rpc_config(method: StringName, config: Variant) 🔗
Changes the RPC configuration for the given method. config should either be null to disable the feature (as by default), or a Dictionary containing the following entries:
rpc_mode: see RPCMode;transfer_mode: see TransferMode;call_local: iftrue, the method will also be called locally;channel: an int representing the channel to send the RPC on.
Note: In GDScript, this method corresponds to the @GDScript.@rpc annotation, with various parameters passed (@rpc(any), @rpc(authority)...). See also the high-level multiplayer tutorial.
Error rpc_id(peer_id: int, method: StringName, ...) vararg 🔗
Sends a rpc() to a specific peer identified by peer_id (see MultiplayerPeer.set_target_peer()).
May return @GlobalScope.OK if the call is successful, @GlobalScope.ERR_INVALID_PARAMETER if the arguments passed in the method do not match, @GlobalScope.ERR_UNCONFIGURED if the node's multiplayer cannot be fetched (such as when the node is not inside the tree), @GlobalScope.ERR_CONNECTION_ERROR if multiplayer's connection is not available.
void set_deferred_thread_group(property: StringName, value: Variant) 🔗
Similar to call_deferred_thread_group(), but for setting properties.
void set_display_folded(fold: bool) 🔗
If set to true, 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 is_displayed_folded().
void set_editable_instance(node: Node, is_editable: bool) 🔗
Set to true to allow all nodes owned by node to be available, and editable, in the Scene dock, even if their 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 is_editable_instance().
void set_multiplayer_authority(id: int, recursive: bool = true) 🔗
Sets the node's multiplayer authority to the peer with the given peer 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 rpc_config() and the MultiplayerAPI.
If recursive is true, the given peer is recursively set as the authority for all children of this node.
Warning: This does not 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 MultiplayerSpawner.spawn_function, an RPC, or a MultiplayerSynchronizer. Furthermore, the parent's authority does not propagate to newly added children.
void set_physics_process(enable: bool) 🔗
If set to true, enables physics (fixed framerate) processing. When a node is being processed, it will receive a NOTIFICATION_PHYSICS_PROCESS at a fixed (usually 60 FPS, see Engine.physics_ticks_per_second to change) interval (and the _physics_process() callback will be called if it exists).
Note: If _physics_process() is overridden, this will be automatically enabled before _ready() is called.
void set_physics_process_internal(enable: bool) 🔗
If set to true, enables internal physics for this node. Internal physics processing happens in isolation from the normal _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 (set_physics_process()).
Warning: 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.
void set_process(enable: bool) 🔗
If set to true, enables 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 it exists).
Note: If _process() is overridden, this will be automatically enabled before _ready() is called.
Note: This method only affects the _process() callback, i.e. it has no effect on other callbacks like _physics_process(). If you want to disable all processing for the node, set process_mode to PROCESS_MODE_DISABLED.
void set_process_input(enable: bool) 🔗
If set to true, enables input processing.
Note: If _input() is overridden, this will be automatically enabled before _ready() is called. Input processing is also already enabled for GUI controls, such as Button and TextEdit.
void set_process_internal(enable: bool) 🔗
If set to true, enables internal processing for this node. Internal processing happens in isolation from the normal _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 (set_process()).
Warning: 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.
void set_process_shortcut_input(enable: bool) 🔗
If set to true, enables shortcut processing for this node.
Note: If _shortcut_input() is overridden, this will be automatically enabled before _ready() is called.
void set_process_unhandled_input(enable: bool) 🔗
If set to true, enables unhandled input processing. It enables the node to receive all input that was not previously handled (usually by a Control).
Note: If _unhandled_input() is overridden, this will be automatically enabled before _ready() is called. Unhandled input processing is also already enabled for GUI controls, such as Button and TextEdit.
void set_process_unhandled_key_input(enable: bool) 🔗
If set to true, enables unhandled key input processing.
Note: If _unhandled_key_input() is overridden, this will be automatically enabled before _ready() is called.
void set_scene_instance_load_placeholder(load_placeholder: bool) 🔗
If set to true, the node becomes an InstancePlaceholder when packed and instantiated from a PackedScene. See also get_scene_instance_load_placeholder().
void set_thread_safe(property: StringName, value: Variant) 🔗
Similar to call_thread_safe(), but for setting properties.
void set_translation_domain_inherited() 🔗
Makes this node inherit the translation domain from its parent node. If this node has no parent, the main translation domain will be used.
This is the default behavior for all nodes. Calling Object.set_translation_domain() disables this behavior.
void update_configuration_warnings() 🔗
Refreshes the warnings displayed for this node in the Scene dock. Use _get_configuration_warnings() to customize the warning messages to display.