Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve errors for add_to_group and remove_from_group, improve documentation #63986

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
+11 −8
Open

Improve errors for add_to_group and remove_from_group, improve documentation #63986

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 7 additions & 2 deletions doc/classes/Node.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,10 @@
<argument index="0" name="group" type="StringName" />
<argument index="1" name="persistent" type="bool" default="false" />
<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].
Adds this node to the given [code]group[/code]. 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]).
Prints an error if this node is already in the group.
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>
Expand Down Expand Up @@ -601,7 +604,9 @@
<return type="void" />
<argument index="0" name="group" type="StringName" />
<description>
Removes a node from a group. See notes in the description, and the group methods in [SceneTree].
Removes this node from the given [code]group[/code].
Prints an error if this node is not in the group.
See notes in the description, and the group methods in [SceneTree].
</description>
</method>
<method name="replace_by">
Expand Down
10 changes: 4 additions & 6 deletions scene/main/node.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1745,11 +1745,8 @@ bool Node::is_in_group(const StringName &p_identifier) const {
}

void Node::add_to_group(const StringName &p_identifier, bool p_persistent) {
ERR_FAIL_COND(!p_identifier.operator String().length());

if (data.grouped.has(p_identifier)) {
return;
}
ERR_FAIL_COND_MSG(p_identifier.operator String().is_empty(), "Group identifier is empty.");
ERR_FAIL_COND_MSG(data.grouped.has(p_identifier), "Node is already in group '" + p_identifier + "'.");

GroupData gd;

Expand All @@ -1765,7 +1762,8 @@ void Node::add_to_group(const StringName &p_identifier, bool p_persistent) {
}

void Node::remove_from_group(const StringName &p_identifier) {
ERR_FAIL_COND(!data.grouped.has(p_identifier));
ERR_FAIL_COND_MSG(p_identifier.operator String().is_empty(), "Group identifier is empty.");
ERR_FAIL_COND_MSG(!data.grouped.has(p_identifier), "Node is not in group '" + p_identifier + "'.");

HashMap<StringName, GroupData>::Iterator E = data.grouped.find(p_identifier);

Expand Down