Legacy Reference

Using Flow Graph Debugger

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.

Using the Flow Graph Debugger, you can add breakpoints to any input or output port of a node. Once a node port is triggered, the game is paused and the Flow Graph Editor displays the applicable node in the center of the graph pane.

To enable Flow Graph Debugger, click the bug (toggle visual flowgraph debugging) toolbar icon in Flow Graph Editor.

To resume the game once a breakpoint is triggered, click the play (Start Flowgraph Update) toolbar icon, or press F5.

To manage Flow Graph breakpoints

  • In Flow Graph Editor, right-click the applicable input or output node port, then do the following as needed:

    • To create a breakpoint, click Add Breakpoint. A red dot is displayed next to the node port.

    • To remove a breakpoint, click Remove Breakpoint.

    • To enable or disable a breakpoint, toggle the Enabled check box.

    • To remove all breakpoints on a node, or for all nodes on the entire flow graph, click Remove Breakpoints for Node or Remove Breakpoints for Graph respectively.

Every breakpoint can be converted to a tracepoint, which instead of pausing the game outputs the information about a triggered breakpoint to the console and to a log file. Simply right-click on the applicable breakpoint-enabled node port, then click Tracepoint.. The red dot changes to a red diamond to indicate that the port has a tracepoint enabled on it.

Tracepoint data sent to the Console looks like this, as an example:

[TRACEPOINT HIT - FrameID: 71054] GRAPH: AnimObject1 (ID: 96) - NODE: Entity:MaterialParam (ID: 5) - PORT: ValueColor - VALUE: 0.867136,0.005522,0.005522