Skip to content

FlowPilot Task Abstract ​

UFlowPilotTask · Inherits UObject · Core/FlowPilotTask.h

FlowPilotTask

  • Can Tick

Lifecycle ​

Every Task goes through the same steps:

StepWhenWhat a Task does there
SetupOnce per flow execution, even across restartsCache references, prefetch Actors.
EnterThe Task startsStart its work. Returning false stops the flow with an error.
TickEvery frame while runningReturn InProgress, Succeeded or Failed, or call FinishTask.
ExitThe Task ends, or the flow is cancelledClean up delegates and timers.
ResetBefore a restartReturn to the Setup state.

Task execution flow

See Creating Your Own Task to write one.

Properties ​

PropertyDefaultDescription
Task Name
TaskName · FName
Description
Description · FName
Enabled
bEnabled · bool
trueIf False, Will skip this Task's execution

Blueprint Functions ​

Callable from Blueprint and C++.

FunctionDescription
Finish Task
void FinishTask(bool bSuccess)
Method to call to finish a task. This method will set EFPTaskResul to Success or Fail on next Tick.
Has Started
bool HasStarted() const
Returns true when Task Started
Is Active
bool IsActive() const
Returns true when Task in Progress and Not Complete
Is Complete
bool IsComplete() const
Returns true when Task is Complete
Get Flow Pilot Component Tasks only
UFlowPilotComponent* GetFlowPilotComponent() const
Returns FlowPilotComponent
Get Flow Pilot Owner Actor Tasks only
AActor* GetFlowPilotOwnerActor() const
Returns FlowPilotComponent Owner Actor
Get World Context Tasks only
UWorld* GetWorldContext() const
Returns FlowPilot Actor World