Skip to content

Commit bf8c53b

Browse files
authored
Merge pull request #9461 from Dowsley/updated-groups-tutorial
Update groups tutorial for project-wide node groups
2 parents 204b091 + 6f0b105 commit bf8c53b

11 files changed

+25
-24
lines changed

tutorials/scripting/groups.rst

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -21,51 +21,52 @@ removed by removing all nodes from a given group.
2121

2222
There are two ways to add/remove nodes to groups:
2323

24-
- During design, by using the Node dock in the editor.
24+
- During design, by using the Node dock in the editor, or the Global Groups in project settings.
2525
- During execution, by calling :ref:`Node.add_to_group() <class_Node_method_add_to_group>`
2626
or :ref:`Node.remove_from_group() <class_Node_method_remove_from_group>`.
2727

2828

2929
Using the Node dock
3030
~~~~~~~~~~~~~~~~~~~
3131

32-
You can add nodes in the current scene to groups using the Groups tab in the
33-
Node dock.
32+
You can create new groups using the Groups tab in the Node dock.
3433

3534
.. image:: img/groups_node_tab.webp
3635

37-
Select one or more nodes in the Scene dock and write the group name in the
38-
field, then click Add.
36+
Select one or more nodes in the Scene dock then click the add button with the + symbol.
3937

40-
.. image:: img/groups_add_node_to_group.webp
38+
.. image:: img/groups_add_new_group_button.webp
4139

42-
You should now see the group appear.
40+
You should now see the Create New Group modal appear. Write the group name in the field.
4341

44-
.. image:: img/groups_node_after_adding.webp
42+
You can optionally mark the option "Global", which will make the group visible project-wide,
43+
and able to be reused in any project scene. This will also allow you to give it a description.
4544

46-
In a complex project, you may end up with many groups or large scenes with many
47-
nodes. You can add or remove any node to groups using the Group Editor window.
48-
To access it, click the Manage Groups button.
45+
When done, press Ok to create it.
4946

50-
.. image:: img/groups_manage_groups_button.webp
47+
.. image:: img/groups_add_new_group_modal.webp
5148

52-
The Group Editor window appears. Here's a screenshot from a complex project to
53-
illustrate the tool's purpose.
49+
You should see the new groups appear in the Groups tab under Scene Groups if the Global option was
50+
unmarked, or under Global Groups if that option was marked.
5451

55-
.. image:: img/groups_group_editor_window.webp
52+
Selected Node(s) from the Scene dock can be added into groups by marking the checkbox on the left side
53+
of the groups in the Groups dock. The node(s) you had selected when creating a new group will be automatically checked.
5654

57-
It has three columns:
55+
.. image:: img/groups_node_tab_with_created_groups.webp
5856

59-
1. A list of groups used by nodes in the current scene.
60-
2. A list of nodes that are not part of the selected group.
61-
3. A list of nodes in the group.
57+
All groups present in the project that were marked as Global, created from any scene, will be visible under Global Groups.
6258

63-
The fields at the bottom allow you to add new groups or filter nodes in the
64-
second and third columns.
59+
Any other group derived from nodes in the current scene will appear under Scene Groups.
6560

66-
.. note:: Any node name that's greyed out means the node was added to the group
67-
in a different scene and you cannot edit it here. This happens on
68-
scene instances in particular.
61+
.. warning:: The same underlying logic is used for both Global and Scene groups.
62+
Groups with the same name are considered one and the same. This feature is purely organizational.
63+
64+
.. image:: img/groups_node_tab_with_multiple_types_of_groups.webp
65+
66+
You can manage Global Groups in the Global Groups dock, inside Project Settings. There, you will be able to add new
67+
global groups, or change existing groups' names and descriptions.
68+
69+
.. image:: img/groups_global_groups_settings.webp
6970

7071
Using code
7172
~~~~~~~~~~
7.31 KB
Loading
7.4 KB
Loading
-5.57 KB
Binary file not shown.
14.7 KB
Loading
-43.7 KB
Binary file not shown.
-4.77 KB
Binary file not shown.
-5.32 KB
Binary file not shown.
2.57 KB
Loading
6.72 KB
Loading

0 commit comments

Comments
 (0)