Documentation

Learn how to use NodeCanvas

Download PDF Version

The Editor

EditorOverview

1.Toolbar

File

  • Clear: Completely clears all nodes.
  • Import JSON: Let’s you import a graph exported previously in json format.
  • Export JSON: Export the graph in a json file format.
  • Show JSON: Shows the serialization json of the graph in a text editor.

Edit

  • Bind To Owner: Binds the current graph to the GraphOwner.
  • Save To Asset: Saves the current graph to an .asset file.
  • Create Defined Parameters to Variables: Fills the blackboard with variables for all defined parameters found in the current graph.

Prefs

  • Show Icons: Toggles between icon or text only modes for the nodes
  • Show Node Help: Will toggle the node help text on and off.
  • Show Comments: Will toggle node and graph comments on and off.
  • Show Summary Info: Will show the full summary info of what a task assigned on a node will do, otherwise only the name of the assigned task will be shown.
  • Show Node IDs: Will show the ID of each node next to that node for debugging purposes.
  • Grid Snap: Toggles grid snapping for the nodes.
  • Log Events: Will log event-related functionality to the console.
  • Automatic Hierarchy Move: If true, when moving a node, all of it’s children will move as well. (This is also possible with the SHIFT key pressed down when moving a node)
  • Open Preferred Types Editor…: Will open up the Preferred Types Editor window.

2.Node Inspector Panel

The selected node’s options/settings and parameters will show up into this popup panel if a node is selected. This panel is not shown if no node is selected. At the top, the node help will show if the relevant preference is turned on, as well as common options for the node’s name, tag and comments. Clicking on the header of the panel will minimize/maximize it.

If a node has a task assigned, the task inspector is also shown here.

3.Blackboard Variables Panel

The variables of the blackboard will show here. Clicking Add Variable will open up the relevant context menu for adding a new variable. Clicking on the header of the panel will minimize/maximize it.

4.Canvas

This is where everything takes shape. Right clicking in the canvas will show a popup for adding new nodes. Either behaviour tree nodes, or FSM nodes, depending on what you are working with now.

AddNode

All nodes have a title name or icon and show information as of what they will finaly do. One node is always marked as “START”. This is the first node to execute. You can change the start node by right clicking on the node and select “Make Start”.

Yes No Suggest edit
4 of 4 users found this section helpful
Suggest Edit