asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions 1

Document the engine's use of internal groups in Node

Browse source 
(cherry picked from commit f8d9e4afdb)
This commit is contained in:
Hugo Locurcio 2021-11-23 00:56:43 +01:00 committed by Rémi Verschelde
parent f2ef3e67a1
commit 5555a69b5e
No known key found for this signature in database
GPG key ID: C3336907360768E1
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
doc/classes/Node.xml
View file

@ -202,6 +202,14 @@
<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.
[b]Note:[/b] The engine uses some group names internally (all starting with an underscore). To avoid conflicts with internal groups, do not add custom groups whose name starts with an underscore. To exclude internal groups while looping over [method get_groups], use the following snippet:
[codeblock]
# Stores the node's non-internal groups only (as an array of Strings).
var non_internal_groups = []
for group in get_groups():
if not group.begins_with("_"):
non_internal_groups.push_back(group)
[/codeblock]
</description>
</method>
<method name="get_index" qualifiers="const">