Documentation 📖

Your guide to using NodeCanvas in Unity

  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
    2. Dialogue Tree Localization
  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

Working with Custom Types

NodeCanvas is built to work with any type you may need. To depict this within the editor though, keeping it clean and not cluttered by the thousands of possible types available, a custom editor window called Preferred Types Editor exists, within which you can restrict the types that will be shown within various menus when working with NodeCanvas. Specifically, the cases where this list will come into use, include:

  • Creating a Blackboard variable.
  • Working with generic nodes and tasks (T).
  • Working with Reflection tasks when the agent is unknown.
  • Generating necessary files for AOT Platforms (WebGL, xBox, iOS)

Opening the Preferred Types Editor can be done through the “Tools/ParadoxNotion/NodeCanvas/Preferred Types Editor” unity top menu. As you will find out, there are a number of types already in the list by default, but feel free to modify the list however you see fit for your project.

PreferredTypes

This editor and its use is strictly an editor thing for faster workflow and has nothing to do with runtime.

Yes No
Last updated on January 10, 2020
« Using Signal EventsWorking with AOT Platforms »
Suggest Edit

© Paradox Notion 2014-2025. All rights reserved.