FPTask_FlowPilotControl.h

File Info

FileName: FPTask_FlowPilotControl.h

• Enum List: [ EFlowPilotControlType | EFlowControlSuccessCondition ]
• Class List: [ UFPTask_FlowPilotControl ]

EFlowPilotControlType

Value	Description
StartFlow UMETA(DisplayName="Start / Resume Flow")	StartFlow UMETA(DisplayName=“Start / Resume Flow”)
PauseFlow UMETA(DisplayName="Pause Flow")	PauseFlow UMETA(DisplayName=“Pause Flow”)
StopFlow UMETA(DisplayName="Stops Flow")	StopFlow UMETA(DisplayName=“Stops Flow”)

EFlowControlSuccessCondition

Value	Description
Instant	Will succeed instantly after Request
WaitForFlowStart	Will succeed when Flow has Started and is in Progress
WaitForFlowComplete	Will succeed when Flow has Started, and is Complete

UFPTask_FlowPilotControl

Parent Classes: [ UFlowPilotTask ]

FlowPilot Control

• Starts, Pauses, Stops a FlowPilot Component’s execution

Properties

// Flow Actor reference to an Actors that have FlowPilotComponents
UPROPERTY(EditAnywhere, Category = "FlowPilot")
FFlowActorReference ActorReference;

// Flow Control Type
UPROPERTY(EditAnywhere, Category = "FlowPilot")
EFlowPilotControlType ControlType = EFlowPilotControlType::StartFlow;

// Flow Stop Type
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType==EFlowPilotControlType::StopFlow", EditConditionHides))
EFPStopType StopType = EFPStopType::CancelExecution;

// When starting a new FlowPilot, what's this Task's success condition?
// Essentially, we can Succeed instantly, or wait for InProgress or Stopped/Complete execution of the
// Controlled FlowPilot Component we're controlling.
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType==EFlowPilotControlType::StartFlow", EditConditionHides))
EFlowControlSuccessCondition SuccessCondition = EFlowControlSuccessCondition::Instant;