Documentation

Learn how to use NodeCanvas

  1. Getting Started
    1. Framework Concepts
    2. The GraphOwner Component
    3. The "Self" Parameter
    4. BBParameters
    5. Visual Debugging
  2. The Editor
    1. Controls & Shortcuts
    2. Assigning Tasks
    3. Canvas Groups
  3. The Blackboard
    1. Data Binding Variables
    2. Blackboard Parenting
    3. Global Variables
    4. Dynamic Variables
    5. Network Sync
    6. Save & Load
  4. Tasks (Actions & Conditions)
    1. Tasks Included
    2. The Reflection Tasks
    3. Using Task Lists
    4. Creating Custom Tasks
    5. Using Task Attributes
    6. Using BBParameters in Tasks
    7. Creating Generic Tasks
    8. Using FixedUpdate and OnGUI
  5. Behaviour Trees
    1. BT Nodes Reference
    2. Reactive Evaluation
    3. Creating Custom BT Nodes
  6. State Machines (FSM)
    1. FSM Nodes Reference
    2. FSM Callbacks
    3. Creating Custom FSM Nodes
  7. Dialogue Trees
    1. Dialogue Tree Nodes Reference
  8. Mapping Sub Graph Variables
  9. Using Graph Events
  10. Using Signal Events
  11. Working with Custom Types
  12. Working with AOT Platforms
  13. Using the Graph Console
  14. Using the Graph Refactor
  15. Using the Graph Explorer
  16. JSON Import/Export
  17. Scripting
    1. Interfacing with your code
    2. GraphOwner API
    3. Blackboard API
    4. Runtime Instantiation Tips
    5. Creating a Behaviour in Code
    6. Creating Custom Object Drawers
    7. Appending Custom AutoConverters
  18. FlowCanvas Integration
    1. Behaviour Tree -> FlowScript
    2. FSM -> FlowScript
    3. Dialogue Tree -> FlowScript
    4. FlowCanvas -> NodeCanvas
    5. Using Tasks in FlowScripts
  19. Full API

Visual Debugging

NodeCanvas has a rather informative and advanced runtime visual debugger. In play mode and while a behaviour is running, you are able to see exactly what’s going on within the graph editor window, where nodes and their connections will get highlighted with specific colors to indicate their status. In the context of behaviour trees, these have a more specific meaning as follows.

  • Blue is for Resting.
  • Yellow is for Running, along with a clock icon.
  • Green is for Success, along with a checkmark icon.
  • Red is for Failure, along with a cross icon.

BTDebug

Also remember, that you can Live Edit the graph while it’s running as much as you wish. Adding nodes, connecting disconnecting etc.

Yes No Suggest edit
37 of 38 users found this section helpful
« BBParametersThe Editor »
Suggest Edit

© Paradox Notion 2014-2024. All rights reserved.