Documentation

Learn how to use NodeCanvas

Download PDF Version

  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. Save & Load
    3. Network Sync
    4. Global Variables
    5. Dynamic Variables
  4. Tasks (Actions & Conditions)
    1. List of Tasks
    2. Creating Custom Tasks
    3. Using Task Attributes
    4. Using BBParameters in Tasks
    5. Creating Generic Tasks
    6. The Script Control Tasks
    7. 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 Node Reference
    2. FSM Callbacks
    3. Creating Custom FSM Nodes
  7. Dialogue Trees
  8. Using Graph Events
  9. Working with Custom Types
  10. Working with AOT Platforms
  11. Creating Custom Object Drawers
  12. JSON Import/Export
  13. Scripting
    1. Interfacing with your code
    2. GraphOwner API
    3. Blackboard API
    4. Runtime Instantiation Tips
    5. Creating a Behaviour in Code
  14. FlowCanvas Integration
    1. Behaviour Tree -> FlowScript
    2. FSM -> FlowScript
    3. Using Tasks in FlowScripts
  15. Playmaker Integration
  16. Full API

Working with Custom Types

NodeCanvas is built to work with any type you might 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. Specificaly, the cases where this list will come into use, include:

  • Creating a Blackboard variable.
  • Working with generic nodes and tasks (T).
  • Working with the Script Control 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 “Window/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 to your project.

PreferredTypes

Adding types in the list, can also be easily done by drag and dropping an object (like a component) or a script file in this editor window.

 

This editor and it’s use, is strictly an editor thing for faster workflow and has nothing to do with runtime.

Yes No Suggest edit
2 of 3 users found this section helpful
« Using Graph EventsWorking with AOT Platforms »
Suggest Edit