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

Using Graph Events

Graph Events are a great way to signal the graph that something happened and react accordingly. NodeCanvas has an internal Event system which can be used in any type of graph. Events can also have any type of variable included and thus possible to also communicate variables with them.

As of version 3.x, there is also an alternative way for utilizing graph events called Signals.

Sending an Event

You can send an event using the included Action Tasks SendEvent or SendEvent<T> in case it is a value event. When using the SendEvent<T> you will also be able to provide a value for the event to transfer from within the editor inspector. Following is an example of a SendEvent<float>.

SendEventT

You can also send an event easily from code of course. You can do this by having a reference to the GraphOwner. For example.

Checking an Event

To Check for an event in the Graph, you should use the included Condition Task called CheckEvent or CheckEvent<T> in case of a value event.

CheckEventT

Using the CheckEvent<T> also allows you to store the received event value to a Blackboard Variable for later usage. The CheckEvent condition will return true for only one frame; Not until the event is consumed.

In regards to FSMs, using events is very straightforward, but using events in Behaviour Trees along with the various Decorators included allows for a lot of flexibility in designing a behaviour tree. For example:

  • You can use a CheckEvent along with an Interruptor Decorator to interrupt the decorated child when the event is received.
  • You can use a CheckEvent along with a Conditional Decorator to trigger access to the decorated child when the event is received.
Yes No Suggest edit
15 of 16 users found this section helpful
« Mapping Sub Graph VariablesUsing Signal Events »
Suggest Edit

© Paradox Notion 2014-2024. All rights reserved.