Menu
Lumberyard
Legacy Reference

Managing Flow Graphs

Flow Graph is deprecated and will be removed in a future version of Lumberyard. Learn about Script Canvas, Lumberyard's new visual scripting environment.

This topic references tools and features that are legacy. If you want to use legacy tools in Lumberyard Editor, disable the CryEntity Removal gem using the Project Configurator or the command line. To learn about the latest features, see the Amazon Lumberyard User Guide.

Each flow graph is associated with a specific entity and is stored as a property of the entity. The name of the flow graph is the name of the entity for which it has been created. When the entity name is changed, the name in the flow graph is also automatically changed. When the entity is saved or exported, the flow graph belonging to it is also automatically saved.

There are two types of flow graphs: global flow graphs, which are used in multiple levels, and level flow graphs, which are associated with a single level.


                Flow graph

To create a flow graph for an entity

  1. In Rollup Bar, on the Objects tab, for an entity previously created, under Flow Graph, click Create.

  2. Alternatively, right-click the entity in the viewport, then click Create Flow Graph. If this is the first flow graph in a level, you need to select a group to place the flow graph with, or click New to create a new group name for the flow graph. The Flow Graphs window displays the new flow graph in the tree.

To manage flow graphs

  • In Flow Graph Editor, right-click the applicable flow graph in the Flow Graphs tree, then do the following as needed:

    • To delete a flow graph, click Delete Graph.

      Note

      When an entity is deleted from a level, the associated flow graph is also deleted.

    • To enable or disable a flow graph, toggle Enable or Disable.

    • To enable or disable all flow graphs in a group, right-click the parent folder, then click Enable All or Disable All as needed. A disabled flow graph is displayed as crossed out, which means that all nodes in the flow graph are ignored when the game is running.

    • To move a flow graph to another group, right-click the parent folder, click RenameFolder/MoveGraphs, then select a group from the list or click New to move it to it's own new group and name it.

When a level is exported with some flow graphs disabled, their disabled state is also exported to the game.

Saving Flow Graphs

The method of saving flow graphs differ depending on whether it is a global flow graph or a level flow graph.

Global flow graphs, which are listed under Graphs, Global, are saved by selecting the flow graph and then clicking File, Save.

Level flow graphs, which are listed under Graphs, Level, are saved automatically when either the level they are in is saved or the layer that they are on is saved. A layer gets saved whenever the corresponding level is saved.

Grouping Flow Graphs

To create a flow graph group

  1. In the graph pane, select two or more flow graph nodes by CTRL+ click on each one.

  2. Right-click the graph pane, and click Group. A box appears around the nodes.

  3. Type a name for the group.

You can rename, move, add to, and remove a group.

To manage flow graph groups

  1. To rename a group, double-click the group's name and type a new name.

  2. To collapse a group to save space, click the down-arrow icon for the group. To expand the group back, click on the icon again.

  3. To move a node within a group, click on the node's title bar and drag it to the desired location.

  4. To move a group, click on an empty space in the group and drag it to the desired location.

  5. To add a node to a group, click to select the group, Ctrl+click on the applicable node, right-click the graph pane, then click Add group.The group's box now encloses the new node.

  6. To remove a node from a group, click to select it, right-click on an empty space in the group, then click Ungroup. The nodes selected are removed from the group. If the group as a whole is selected, the group is removed entirely.

  7. To remove a group entirely, right-click the group's name and click in the Ungroup.

Importing and Exporting Flow Graphs

Flow graphs are saved as XML files and can be exported and imported.

To export a flow graph

  • Select the nodes for export by Ctrl+Click each node, then right-click the final node, click Selection, Export Selected Nodes, then enter a file name for it.

You can import a previously exported flow graph's nodes into another flow graph as follows:

To import a flow graph

  • Open the target flow graph you want to import to add the exported flow graph nodes to, right-click anywhere in the graph pane, click Import, then enter the name of file you want to import.

The imported flow graph is positioned relative to the old flow graph.