diff options
| author | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2021-11-23 00:56:43 +0100 |
|---|---|---|
| committer | Hugo Locurcio <hugo.locurcio@hugo.pro> | 2021-11-23 01:09:13 +0100 |
| commit | f8d9e4afdbc6dd7a35076e91d976daf3841de6a3 (patch) | |
| tree | 8964973b950dbc145d70764c745161580405be41 | |
| parent | dbef4bbd98b655d6f89601c9e44c679b373b3628 (diff) | |
Document the engine's use of internal groups in Node
| -rw-r--r-- | doc/classes/Node.xml | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/classes/Node.xml b/doc/classes/Node.xml index 423002d058..6b3aa30dd2 100644 --- a/doc/classes/Node.xml +++ b/doc/classes/Node.xml @@ -233,6 +233,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"> |