Skip to content

Commit 5c65f80

Browse files
committed
Update Node.xml: specify that normal processing happens in tree order
1 parent db66bd3 commit 5c65f80

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

doc/classes/Node.xml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@
7373
<description>
7474
Called during the physics processing step of the main loop. Physics processing means that the frame rate is synced to the physics, i.e. the [param delta] variable should be constant. [param delta] is in seconds.
7575
It is only called if physics processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_physics_process].
76+
Processing happens in order of [member process_physics_priority], lower priority values are called first. Nodes with the same priority are processed in tree order, or top to bottom as seen in the editor (also known as pre-order traversal).
7677
Corresponds to the [constant NOTIFICATION_PHYSICS_PROCESS] notification in [method Object._notification].
7778
[b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
7879
</description>
@@ -83,6 +84,7 @@
8384
<description>
8485
Called during the processing step of the main loop. Processing happens at every frame and as fast as possible, so the [param delta] time since the previous frame is not constant. [param delta] is in seconds.
8586
It is only called if processing is enabled, which is done automatically if this method is overridden, and can be toggled with [method set_process].
87+
Processing happens in order of [member process_priority], lower priority values are called first. Nodes with the same priority are processed in tree order, or top to bottom as seen in the editor (also known as pre-order traversal).
8688
Corresponds to the [constant NOTIFICATION_PROCESS] notification in [method Object._notification].
8789
[b]Note:[/b] This method is only called if the node is present in the scene tree (i.e. if it's not an orphan).
8890
</description>
@@ -1015,10 +1017,10 @@
10151017
The node's processing behavior (see [enum ProcessMode]). To check if the node can process in its current mode, use [method can_process].
10161018
</member>
10171019
<member name="process_physics_priority" type="int" setter="set_physics_process_priority" getter="get_physics_process_priority" default="0">
1018-
Similar to [member process_priority] but for [constant NOTIFICATION_PHYSICS_PROCESS], [method _physics_process] or the internal version.
1020+
Similar to [member process_priority] but for [constant NOTIFICATION_PHYSICS_PROCESS], [method _physics_process], or [constant NOTIFICATION_INTERNAL_PHYSICS_PROCESS].
10191021
</member>
10201022
<member name="process_priority" type="int" setter="set_process_priority" getter="get_process_priority" default="0">
1021-
The node's execution order of the process callbacks ([method _process], [method _physics_process], and internal processing). Nodes whose priority value is [i]lower[/i] call their process callbacks first, regardless of tree order.
1023+
The node's execution order of the process callbacks ([method _process], [constant NOTIFICATION_PROCESS], and [constant NOTIFICATION_INTERNAL_PROCESS]). Nodes whose priority value is [i]lower[/i] call their process callbacks first, regardless of tree order.
10221024
</member>
10231025
<member name="process_thread_group" type="int" setter="set_process_thread_group" getter="get_process_thread_group" enum="Node.ProcessThreadGroup" default="0">
10241026
Set the process thread group for this node (basically, whether it receives [constant NOTIFICATION_PROCESS], [constant NOTIFICATION_PHYSICS_PROCESS], [method _process] or [method _physics_process] (and the internal versions) on the main thread or in a sub-thread.

0 commit comments

Comments
 (0)