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

FSM -> FlowScript

A FlowCanvas FlowScript can be used as a FSM State to model the state completely with visual scripting! After you have downloaded the FlowCanvas bridge extension, it will be possible to add such a FlowScript State through the context menu and found under the “SubGraphs” category.

fsm

The FlowScript State node inspector has only two specific settings (apart from the FlowScript reference of course and everything else that is commong to subgraphs). Success and Failure Events.

flowscrptstateinspector

Since FlowScripts can Finish in Success or Failure, an event can optionally be sent to the FSM when this happens. These events are meant to be used by a CheckEvent condition added on the FlowScript State transitions like shown in the example FSM image above.

Using these events is completely optional. If you opt not to use them the FlowScript State will simply call the first ‘OnFinish’ transition as soon as the FlowScript is Finished.

Within the FlowScript, the OnEnable, OnDisable, and OnUpdate events can be used to model the state’s OnEnter, OnExit, and OnUpdate functionality respectively.

flowscriptfsm1

The FlowScript Finish node can be used to Finish the state. As explained earlier, when the Finish node is called and considering you have set event names to be used in the FlowScript State node inspector, either the Success or Failure event will be sent to the FlowScript State transitions. If no event names are set, the first OnFinish transition will simply take place.

flowscriptfsm2

Remember that you can also use SubGraph Variables Mapping as normal between FSM and FlowScript.

Yes No Suggest edit
4 of 4 users found this section helpful
« Behaviour Tree -> FlowScriptDialogue Tree -> FlowScript »
Suggest Edit