Merge pull request #87539 from SysError99/3.x-get_first_node_in_group

[3.x] Add `SceneTree::get_first_node_in_group` following 4.x
This commit is contained in:
Rémi Verschelde 2024-01-29 23:29:04 +01:00
commit 721eba5d5d
No known key found for this signature in database
GPG key ID: C3336907360768E1
3 changed files with 24 additions and 0 deletions

View file

@ -80,6 +80,13 @@
Creates and returns a new [SceneTreeTween].
</description>
</method>
<method name="get_first_node_in_group">
<return type="Node" />
<argument index="0" name="group" type="String" />
<description>
Returns the first node in the specified group, or [code]null[/code] if the group is empty or does not exist.
</description>
</method>
<method name="get_frame" qualifiers="const">
<return type="int" />
<description>

View file

@ -1228,6 +1228,21 @@ Array SceneTree::_get_nodes_in_group(const StringName &p_group) {
return ret;
}
Node *SceneTree::_get_first_node_in_group(const StringName &p_group) {
Map<StringName, Group>::Element *E = group_map.find(p_group);
if (!E) {
return nullptr; // No group.
}
_update_group_order(E->get()); // Update order just in case.
if (E->get().nodes.empty()) {
return nullptr;
}
return E->get().nodes[0];
}
bool SceneTree::has_group(const StringName &p_identifier) const {
return group_map.has(p_identifier);
}
@ -2091,6 +2106,7 @@ void SceneTree::_bind_methods() {
ClassDB::bind_method(D_METHOD("set_group", "group", "property", "value"), &SceneTree::set_group);
ClassDB::bind_method(D_METHOD("get_nodes_in_group", "group"), &SceneTree::_get_nodes_in_group);
ClassDB::bind_method(D_METHOD("get_first_node_in_group", "group"), &SceneTree::_get_first_node_in_group);
ClassDB::bind_method(D_METHOD("set_current_scene", "child_node"), &SceneTree::set_current_scene);
ClassDB::bind_method(D_METHOD("get_current_scene"), &SceneTree::get_current_scene);

View file

@ -177,6 +177,7 @@ private:
_FORCE_INLINE_ void _update_group_order(Group &g, bool p_use_priority = false);
Array _get_nodes_in_group(const StringName &p_group);
Node *_get_first_node_in_group(const StringName &p_group);
Node *current_scene;