Click or drag to resize

Flow Graph Editor

UI EditorManual / Content Creation / Flow Graph EditorPhysical Objects Creation

Flow Graph Editor

Contents
Overview

Flow Graph Editor is a node editor, that allows to adjust interactions between objects visually.

The editor can be used for various purposes. For example, for scripting project logic. You can create event handlers, code methods.

Screenshot999999324.png

Also the editor can be used as a base for other specialized editors. For example, in the engine, graph editor used for Material Editor.

Screenshot999999194.png
Example of creating an event handler

The process of the creation and configuration of Flow Graph will be described by creating an event handler. Visual script will be created, which will be called during scene initialization. Precisely, the method of adding a message to the Player App console will be invoked when the scene is initialized.

To begin, create a scene. Next you need to select the scene object, in Settings Window go to the Events tab. Then click on the add handler button. In this case, we need an Enabled Event (scene enable event).

Screenshot999999520 2.png

After clicking on the button, a context menu appears in which you need to select the creation of Flow Graph.

Screenshot999999529.png

The graph editor opens. It will have one Event Handler node.

Screenshot999999530.png

Next, attach another node to it with a call to the Log.Warning method. To do this, find the Log.Warning method in Resources Window, and drop it into the workspace. The method can be found at All types\NeoAxis\Log.

Screenshot999999531 2.png

Now you can adjust the properties of the new node. In order to be able to connect the node with others, property Flow Support should be set to True. Fill in the Message parameter.

Screenshot999999534 2.png

Next, connect the first node's Handler Flow output to the second Entry input.

Screenshot999999536 2.png

Now you can start the player (Play button in the Ribbon). A message will be displayed on the Player app console.

Screenshot999999538.png
Adding control flow nodes

There are some control flow objects available. For example, If, While. These objects are located in the Resources Window, in the Base\Scripting\Flow control group.

Screenshot999999539 2.png
Node settings

Nodes can be customized. For example, one can change their width, or add comments.

To do this, select the necessary nodes by the selection frame. You need to select it with the selection frame, since with a point click, it is not the node itself that is allocated, but the object inside the node.

Screenshot999999540.png

The result of changing the settings.

Screenshot999999541.png
Samples
Scripting Flow graph.scene

Samples\Starter Content\Scenes\Scripting Flow graph.scene

Screenshot999999654.png
Screenshot999999655.png
See also
UI EditorPhysical Objects Creation