Introduction
FlowPilot runs gameplay flows made of Tasks. A flow is a FlowPilot asset: a tree of Tasks that an Actor runs through a FlowPilot Component. Use it for level scripting (music, fades, spawns, level streaming, win and lose conditions) or for local logic such as interactive objects.
If you know Behavior Trees, the ideas are the same: a Sequence runs its Tasks until one fails, a Selector runs them until one succeeds.
Core concepts
| Concept | What it is |
|---|---|
| FlowPilot Asset | A data asset holding the flow. Its Root is a Sequence. |
| FlowPilot Component | Runs a FlowPilot asset on an Actor. Start, pause and stop it from Blueprint, or auto start it. |
| Task | One step of the flow. It starts, runs for as long as it needs, then succeeds or fails. |
| Flow Actor Reference | How Tasks point at Actors: Self, an Actor In Level, or Actors found at Runtime by GameplayTag. |
| FlowPilot Subsystem | Tracks every FlowPilot Component and caches Actors found by GameplayTag. |
Tasks that organise other Tasks
| Task | Runs its Tasks | Succeeds when |
|---|---|---|
| Sequence | One after another | All succeed. Stops at the first failure. |
| Selector | One after another | One succeeds. Stops at the first success. |
| Parallel | All at once | Depends on its Completion Type (any/all succeed or fail). |
| Loop | Its single Task, N times or forever | All iterations succeed. |
| Sub Flow | Another FlowPilot asset | That asset's flow succeeds. |
Disabled Tasks are skipped. Every Task, built-in or your own, is listed in the Reference.
What's included
- Content example map: try each Task on its own.
- Game map template: a full level using streaming levels, spawning, gating, a simple character, progression and UI notifications.
- Tag Actor Component: tags Actors so flows can find them by GameplayTag.
- Example Component: barebones health and inventory used by the game map template.
Next steps
- Getting Started: build and run your first flow.
- Tutorial: Spawn an AI: a hands-on walkthrough in the tutorial level.
- Debugging Flows: watch flows run, breakpoints and the in-game overlay.
- Creating Your Own Task: extend FlowPilot in Blueprint or C++.
Questions or ideas: Discord or GitHub issues.