Lumberyard
User Guide (Version 1.21)

Grouping Nodes

As your Script Canvas graphs grow in size, you can group nodes to logically organize parts of a script or reduce its visual complexity. Groups can be nested, named, and color-coded.

Creating and Managing Node Groups

To create a node group from existing nodes and/or node groups

  1. Select the nodes that you want to group.

  2. Right-click the graph and choose Group or New group.

  3. Enter a name for the node group, and then press Enter.

To create an empty group

  • Right-click an empty portion of the graph, and then choose New group. You can expand the group's borders and add nodes to it as you would on the main graph.

To collapse a group

  • Do one of the following:

    • Double-click the group.

    • Right-click the group, and choose Collapse.

    • In Node Inspector, select the Collapse Group option.

    A collapsed group has a border with a dashed line.

To expand a group

  • Do one of the following:

    • Double-click the group.

    • Right-click the group, and choose Expand.

    • In Node Inspector, clear the Collapse Group option.

    
                        Creating a node group in the Script Canvas editor.

To edit the name of a group

  • Do one of the following:

    • Right-click the title bar of the expanded group, and choose Edit group title.

    • In Node Inspector, in the Group Name box, edit the name.

To resize a group's borders to fit the contents of the group

  1. To reduce empty horizontal space within the group, double-click the group's left or right border.

  2. To reduce empty vertical space within the group, double-click the group's top or bottom border.

To ungroup a group

  • Right-click the group, and choose Ungroup.

To delete a group

  • Right-click the group, and choose Delete.

    Note

    Deleting a group removes all of the nodes in the group and their connections to other nodes outside of the group. If you want to remove the group container but keep its nodes and connections, choose Ungroup.

Enabling Groups as Bookmarks

To quickly navigate through the groups in your graphs, you can enable groups as bookmarks.

To bookmark a group

  1. Select the group.

  2. In Node Inspector, select Enable as Bookmark.

Customizing Groups

You can use the Node Inspector to customize the color of a group and to change the font settings of the group title.

To change the color of a node group

  1. Select the node group.

  2. In Node Inspector, do one of the following:

    • If you know the RGB values that you want to use, enter them in the Group Color text box.

    • Click the Group Color icon to use the Select Color dialog box.

    
                        Click the Group Color icon in the
                            Script Canvas Node Inspector to customize the
                            color of a node group.
  3. In the Select Color dialog box, specify the color that you want to use. You can choose from basic colors, create a custom color, or click Pick Screen Color to choose a color on your screen with your pointer.

    
                        Choose or create a color for a group node in the Script Canvas
                            editor.
  4. Click OK.

To change the font settings for the node group title

  1. In Node Inspector, expand Font Settings.

  2. Enter or choose the values that you want to use for the group title font. The changes that you make are immediately visible.

    
                        Expand a node group's Font Settings section in
                            the Script Canvas Node Inspector.

    Font Setting Description
    Font Color If you know the RGB values that you want to use, enter them in the text box. Otherwise, click the color icon and use the Select Color dialog box to specify a color. The default is black (0,0,0).
    Font Family Enter the name of a font family (for example, Verdana or Arial Black).
    Pixel Size Enter a size for the font. Valid values are from 1 through 200. The default is 16.
    Weight Choose a preselected font weight. Possible values are Thin, Extra Light, Light, Normal, Medium, Demi-Bold, Bold, or Extra Bold. The default is Normal.
    Style Choose a font style. Possible values are Normal, Italic, and Oblique. The default is Normal.
    Vertical Alignment Choose the vertical position of the title text within the group header. Possible values are Top, Middle, or Bottom. The default is Top.
    Horizontal Alignment Choose the horizontal position of the title text within the group header. Possible values are Left, Center, or Right. The default is Left.