summaryrefslogtreecommitdiff
path: root/doc/classes
diff options
context:
space:
mode:
authorHugo Locurcio <hugo.locurcio@hugo.pro>2021-09-01 15:36:51 +0200
committerHugo Locurcio <hugo.locurcio@hugo.pro>2021-09-01 15:36:51 +0200
commit0adf1a6683217b331d4ccf7f1d146781f6185dce (patch)
tree1c0766bc7ae02f95a8f9b29a27f89ae47ef922e5 /doc/classes
parent8259a3b1c2aee729584f1960686db4e9708f7f19 (diff)
Document that node groups don't have a guaranteed order
Diffstat (limited to 'doc/classes')
-rw-r--r--doc/classes/Node.xml2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml
index 7d79c50466..20435c7582 100644
--- a/doc/classes/Node.xml
+++ b/doc/classes/Node.xml
@@ -153,6 +153,7 @@
<description>
Adds the node to a group. Groups are helpers to name and organize a subset of nodes, 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 until they are inside the scene tree (see [method is_inside_tree]). See notes in the description, and the group methods in [SceneTree].
The [code]persistent[/code] option is used when packing node to [PackedScene] and saving to file. Non-persistent groups aren't stored.
+ [b]Note:[/b] For performance reasons, the order of node groups is [i]not[/i] guaranteed. The order of node groups should not be relied upon as it can vary across project runs.
</description>
</method>
<method name="can_process" qualifiers="const">
@@ -236,6 +237,7 @@
<return type="Array" />
<description>
Returns an array listing the groups that the node is a member of.
+ [b]Note:[/b] For performance reasons, the order of node groups is [i]not[/i] guaranteed. The order of node groups should not be relied upon as it can vary across project runs.
</description>
</method>
<method name="get_index" qualifiers="const">