Types

Enums and types declared in FlowTypes.h.

Enums

EFPStopType

FlowPilot Stop Type

Value	Description
Cancel Execution CancelExecution	Cancel Execution will call Exit with Failure state on Running Tasks
Stop Now StopNow	Stop Now will just stop execution. Exit won't be called.

EFPTaskResult

Task Execution Result

Value	Description
None None	Not started yet
In Progress InProgress	In progress and Ticking
Succeeded Succeeded	Complete with Success Result
Failed Failed	Complete with Fail Result
Error Error	Not Complete. Return Error

EFlowState

Flow State

Value	Description
None None	Not started yet
In Progress InProgress	FlowPilot Running
Paused Paused	FlowPilot has started but is paused
Succeeded Succeeded	FlowPilot Done with Success
Failed Failed	FlowPilot Done with fail
Error Error	FlowPilot not Done, with Error

EFPActorScope

Actor Scope

• Helps determine the search scope when referencing an actor with FFlowActorReference

Value	Description
Self Self	Actor or Component is in Own Actor
In Level InLevel	Actor that live in the world
Runtime Runtime	Actors spawned at Runtime

EFPSpawnLifetime

Spawn Lifetime Enum

• Helps Setup automatic Destroy when lifetime is bound to a FlowPilot Execution

Value	Description
Flow Pilot FlowPilot	Spawned actor will live during FlowPilot Execution, will despawn automatically when Flow Ends.
Persistent Persistent	TODO (MA): Add a Checkpoint lifetime? or internal scope, example, when we add another FlowAsset, or a Parallel, sequence or selector. Spawned actors will stay on the level event when Flow Stops.

EFPExecutionMode

Execution Mode

• Dictates how we should run a FlowPilot asset

Value	Description
Run Once RunOnce	Executes Flow Once.
Run Until Succeed RunUntilSucceed	Executes until Succeeds Once
Run Until Fail RunUntilFail	Executes until Fails Once
Run While Succeed RunWhileSucceed	Executes in Loop while Succeeds
Run While Fail RunWhileFail	Executes in Loop while Fails
Run Non Stop RunNonStop	Run non stop.

FFlowContext

Flow Context

• Contains information passed to each Task that has information about their owner, and runners.

Field	Type	Description
World	UWorld
OwnerActor	AActor
OwnerComponent	UFlowPilotComponent