From 48481edfa66b3ea15de2a70a9dd620a460212a58 Mon Sep 17 00:00:00 2001 From: Michael Adaixo Date: Sat, 7 Sep 2024 23:56:38 +0100 Subject: [PATCH] update docs --- .../docs/reference/FPTagActorComponent.mdx | 2 +- src/content/docs/reference/FPTaskRunner.mdx | 2 +- .../docs/reference/FPTask_BlueprintBase.mdx | 4 +- src/content/docs/reference/FPTask_Delay.mdx | 2 +- .../docs/reference/FPTask_DestroyActor.mdx | 2 +- .../docs/reference/FPTask_FlowAsset.mdx | 4 +- .../reference/FPTask_FlowPilotControl.mdx | 32 ++-- .../docs/reference/FPTask_LoadLevel.mdx | 2 +- src/content/docs/reference/FPTask_Loop.mdx | 2 +- .../docs/reference/FPTask_Parallel.mdx | 33 ++-- .../docs/reference/FPTask_PlayAnimation.mdx | 6 +- .../docs/reference/FPTask_PlaySound.mdx | 2 +- .../docs/reference/FPTask_PlaySound2D.mdx | 2 +- .../docs/reference/FPTask_PossessPawn.mdx | 19 +- .../docs/reference/FPTask_Selector.mdx | 6 +- .../docs/reference/FPTask_Sequence.mdx | 6 +- .../docs/reference/FPTask_SpawnClass.mdx | 2 +- .../docs/reference/FPTask_TriggerDistance.mdx | 28 ++- .../docs/reference/FPTask_TriggerVolume.mdx | 24 ++- .../reference/FPTask_UnloadStreamedLevel.mdx | 2 +- .../docs/reference/FlowActorReference.mdx | 2 +- src/content/docs/reference/FlowPilot.mdx | 2 +- .../docs/reference/FlowPilotComponent.mdx | 4 +- .../docs/reference/FlowPilotParent.mdx | 8 +- .../docs/reference/FlowPilotSettings.mdx | 2 +- .../docs/reference/FlowPilotSubsystem.mdx | 6 +- src/content/docs/reference/FlowPilotTask.mdx | 4 +- src/content/docs/reference/FlowTypes.mdx | 176 ++++++------------ 28 files changed, 176 insertions(+), 210 deletions(-) diff --git a/src/content/docs/reference/FPTagActorComponent.mdx b/src/content/docs/reference/FPTagActorComponent.mdx index 74aaf70..dc350df 100644 --- a/src/content/docs/reference/FPTagActorComponent.mdx +++ b/src/content/docs/reference/FPTagActorComponent.mdx @@ -16,5 +16,5 @@ __FileName:__ `FPTagActorComponent.h` __Parent Classes:__ [ `UActorComponent` ] - \ + Helper Component to add Tags to Actor. diff --git a/src/content/docs/reference/FPTaskRunner.mdx b/src/content/docs/reference/FPTaskRunner.mdx index dc15765..7bdd3e0 100644 --- a/src/content/docs/reference/FPTaskRunner.mdx +++ b/src/content/docs/reference/FPTaskRunner.mdx @@ -16,5 +16,5 @@ __FileName:__ `FPTaskRunner.h` __Parent Classes:__ [ `UFlowPilotParent` ] - \ + Task Runner is the Base Class for Sequences and Selectors diff --git a/src/content/docs/reference/FPTask_BlueprintBase.mdx b/src/content/docs/reference/FPTask_BlueprintBase.mdx index b66c4d8..3622868 100644 --- a/src/content/docs/reference/FPTask_BlueprintBase.mdx +++ b/src/content/docs/reference/FPTask_BlueprintBase.mdx @@ -13,8 +13,8 @@ __FileName:__ `FPTask_BlueprintBase.h` ## `UFPTask_BlueprintBase` - \ -Blueprint Base Task \ + +Blueprint Base Task - Inherit from Blueprints to have custom BP Tasks. ### Functions diff --git a/src/content/docs/reference/FPTask_Delay.mdx b/src/content/docs/reference/FPTask_Delay.mdx index e2e850a..acaa685 100644 --- a/src/content/docs/reference/FPTask_Delay.mdx +++ b/src/content/docs/reference/FPTask_Delay.mdx @@ -16,7 +16,7 @@ __FileName:__ `FPTask_Delay.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Delays Execution ### Properties diff --git a/src/content/docs/reference/FPTask_DestroyActor.mdx b/src/content/docs/reference/FPTask_DestroyActor.mdx index 97ddef2..28dbd35 100644 --- a/src/content/docs/reference/FPTask_DestroyActor.mdx +++ b/src/content/docs/reference/FPTask_DestroyActor.mdx @@ -16,7 +16,7 @@ __FileName:__ `FPTask_DestroyActor.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Destroys Actors ### Properties diff --git a/src/content/docs/reference/FPTask_FlowAsset.mdx b/src/content/docs/reference/FPTask_FlowAsset.mdx index ad56c0d..ae2ef5a 100644 --- a/src/content/docs/reference/FPTask_FlowAsset.mdx +++ b/src/content/docs/reference/FPTask_FlowAsset.mdx @@ -16,6 +16,6 @@ __FileName:__ `FPTask_FlowAsset.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ -FPTask_FlowAsset \ + +FPTask_FlowAsset - Loads and Runs another FlowDataAsset diff --git a/src/content/docs/reference/FPTask_FlowPilotControl.mdx b/src/content/docs/reference/FPTask_FlowPilotControl.mdx index a29ed6c..717dce4 100644 --- a/src/content/docs/reference/FPTask_FlowPilotControl.mdx +++ b/src/content/docs/reference/FPTask_FlowPilotControl.mdx @@ -6,28 +6,32 @@ description: Reference page for FPTask_FlowPilotControl.h ## File Info __FileName:__ `FPTask_FlowPilotControl.h` +- __Enum List:__ +[ [`EFlowPilotControlType`](#eflowpilotcontroltype) | [`EFlowControlSuccessCondition`](#eflowcontrolsuccesscondition) ] - __Class List:__ [ [`UFPTask_FlowPilotControl`](#ufptask_flowpilotcontrol) ] -- __Enum List:__ -[ [`EFlowControlSuccessCondition`](#eflowcontrolsuccesscondition) ] -## `EFlowControlSuccessCondition` +### `EFlowPilotControlType` -### Properties +| 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") | -```cpp -// Will succeed instantly after Request -Instant, -// Will succeed when Flow has Started and is in Progress -WaitForFlowStart, -// Will succeed when Flow has Started, and is Complete -WaitForFlowComplete +### `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` @@ -36,8 +40,8 @@ WaitForFlowComplete __Parent Classes:__ [ `UFlowPilotTask` ] - \ -FlowPilot Control \ + +FlowPilot Control - Starts, Pauses, Stops a FlowPilot Component's execution ### Properties diff --git a/src/content/docs/reference/FPTask_LoadLevel.mdx b/src/content/docs/reference/FPTask_LoadLevel.mdx index b89d852..ee8e58d 100644 --- a/src/content/docs/reference/FPTask_LoadLevel.mdx +++ b/src/content/docs/reference/FPTask_LoadLevel.mdx @@ -16,5 +16,5 @@ __FileName:__ `FPTask_LoadLevel.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Load Level Task diff --git a/src/content/docs/reference/FPTask_Loop.mdx b/src/content/docs/reference/FPTask_Loop.mdx index 9fb17c8..dd1fced 100644 --- a/src/content/docs/reference/FPTask_Loop.mdx +++ b/src/content/docs/reference/FPTask_Loop.mdx @@ -16,5 +16,5 @@ __FileName:__ `FPTask_Loop.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Executes a Task in a Loop diff --git a/src/content/docs/reference/FPTask_Parallel.mdx b/src/content/docs/reference/FPTask_Parallel.mdx index 7721e23..62fef52 100644 --- a/src/content/docs/reference/FPTask_Parallel.mdx +++ b/src/content/docs/reference/FPTask_Parallel.mdx @@ -6,31 +6,22 @@ description: Reference page for FPTask_Parallel.h ## File Info __FileName:__ `FPTask_Parallel.h` -- __Class List:__ -[ [`UFPTask_Parallel`](#ufptask_parallel) ] - __Enum List:__ [ [`EFlowParallelCompletionType`](#eflowparallelcompletiontype) ] +- __Class List:__ +[ [`UFPTask_Parallel`](#ufptask_parallel) ] -## `EFlowParallelCompletionType` - - -### Properties - -```cpp -// Succeed when one child Succeeds -AnySucceed, - -// Succeed when all child Succeed -AllSucceed, +### `EFlowParallelCompletionType` -// Succeed when one child Fails -AnyFail, -// Succeed when all child Fail -AllFail +| Value | Description | +| :-- | :-- | +| `AnySucceed` | Succeed when one child Succeeds | +| `AllSucceed` | Succeed when all child Succeed | +| `AnyFail` | Succeed when one child Fails | +| `AllFail` | Succeed when all child Fail | -``` ## `UFPTask_Parallel` @@ -39,9 +30,9 @@ AllFail __Parent Classes:__ [ `UFlowPilotParent` ] - \ -Parallel Task \ -- Run multiple Tasks in the same tick function. \ + +Parallel Task +- Run multiple Tasks in the same tick function. - They are run one by one, so not 'really' parallel. ### Properties diff --git a/src/content/docs/reference/FPTask_PlayAnimation.mdx b/src/content/docs/reference/FPTask_PlayAnimation.mdx index 10ed4c7..65877b6 100644 --- a/src/content/docs/reference/FPTask_PlayAnimation.mdx +++ b/src/content/docs/reference/FPTask_PlayAnimation.mdx @@ -6,10 +6,10 @@ description: Reference page for FPTask_PlayAnimation.h ## File Info __FileName:__ `FPTask_PlayAnimation.h` -- __Class List:__ -[ [`UFPTask_PlayAnimation`](#ufptask_playanimation) ] - __Struct List:__ [ ] +- __Class List:__ +[ [`UFPTask_PlayAnimation`](#ufptask_playanimation) ] ## `UFPTask_PlayAnimation` @@ -18,5 +18,5 @@ __FileName:__ `FPTask_PlayAnimation.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + diff --git a/src/content/docs/reference/FPTask_PlaySound.mdx b/src/content/docs/reference/FPTask_PlaySound.mdx index 0d3be9d..e1985ad 100644 --- a/src/content/docs/reference/FPTask_PlaySound.mdx +++ b/src/content/docs/reference/FPTask_PlaySound.mdx @@ -16,7 +16,7 @@ __FileName:__ `FPTask_PlaySound.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Plays SoundCues or SoundWaves ### Properties diff --git a/src/content/docs/reference/FPTask_PlaySound2D.mdx b/src/content/docs/reference/FPTask_PlaySound2D.mdx index 8ac00d0..d9f1e04 100644 --- a/src/content/docs/reference/FPTask_PlaySound2D.mdx +++ b/src/content/docs/reference/FPTask_PlaySound2D.mdx @@ -16,5 +16,5 @@ __FileName:__ `FPTask_PlaySound2D.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Play 2D Sounds diff --git a/src/content/docs/reference/FPTask_PossessPawn.mdx b/src/content/docs/reference/FPTask_PossessPawn.mdx index 511a7c9..e2fc3a0 100644 --- a/src/content/docs/reference/FPTask_PossessPawn.mdx +++ b/src/content/docs/reference/FPTask_PossessPawn.mdx @@ -16,23 +16,30 @@ __FileName:__ `FPTask_PossessPawn.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ -Possess Pawn \ -- Spawns a Controller and Possesses a Pawn \ -- Can Posses multiple Pawns at the same time + +Posses Pawn: +- Spawns a Controller and Possesses a Pawn +- Can Possess multiple Pawns at the same time using a shared GameplayTag 🏷️ ### Properties ```cpp // Pawns to Possess +// if possessed by Player, will only search for 1 Pawn. +// if possessed by AI Controller, will search for multiple Pawns. UPROPERTY(EditAnywhere, Category="FlowPilot") FFlowActorReference PawnsToPossess; -// Player Possesses only 1 Pawn +// If true, the Player will posses the Pawn UPROPERTY(EditAnywhere, Category="FlowPilot") bool bPossessByPlayer = false; -// AI Controller Class to Posses Pawns with. +// Player Controller Index, in single player games this is usually 0. +// for more complex cases, this could be parameterized +UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="bPossessByPlayer", EditConditionHides)) +int32 PlayerIndex = 0; + +// AI Controller class to posses Pawn with UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="!bPossessByPlayer", EditConditionHides)) TSubclassOf ControllerClass; diff --git a/src/content/docs/reference/FPTask_Selector.mdx b/src/content/docs/reference/FPTask_Selector.mdx index d9e09ee..c40bec7 100644 --- a/src/content/docs/reference/FPTask_Selector.mdx +++ b/src/content/docs/reference/FPTask_Selector.mdx @@ -16,7 +16,7 @@ __FileName:__ `FPTask_Selector.h` __Parent Classes:__ [ `UFPTaskRunner` ] - \ -Selector Task \ -- Run one FlowPilotTask after another \ + +Selector Task +- Run one FlowPilotTask after another - Stops execution when one Task succeeds diff --git a/src/content/docs/reference/FPTask_Sequence.mdx b/src/content/docs/reference/FPTask_Sequence.mdx index 44a30d5..f8749f9 100644 --- a/src/content/docs/reference/FPTask_Sequence.mdx +++ b/src/content/docs/reference/FPTask_Sequence.mdx @@ -16,7 +16,7 @@ __FileName:__ `FPTask_Sequence.h` __Parent Classes:__ [ `UFPTaskRunner` ] - \ -Sequence Task \ -- Run one FlowPilotTask after another \ + +Sequence Task +- Run one FlowPilotTask after another - Stops execution when one Task fails. diff --git a/src/content/docs/reference/FPTask_SpawnClass.mdx b/src/content/docs/reference/FPTask_SpawnClass.mdx index 2bb2f7f..50a1318 100644 --- a/src/content/docs/reference/FPTask_SpawnClass.mdx +++ b/src/content/docs/reference/FPTask_SpawnClass.mdx @@ -16,7 +16,7 @@ __FileName:__ `FPTask_SpawnClass.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Spawns a Class ### Properties diff --git a/src/content/docs/reference/FPTask_TriggerDistance.mdx b/src/content/docs/reference/FPTask_TriggerDistance.mdx index d49ee0f..d8d1c72 100644 --- a/src/content/docs/reference/FPTask_TriggerDistance.mdx +++ b/src/content/docs/reference/FPTask_TriggerDistance.mdx @@ -6,10 +6,32 @@ description: Reference page for FPTask_TriggerDistance.h ## File Info __FileName:__ `FPTask_TriggerDistance.h` +- __Enum List:__ +[ [`ETriggerDistanceOp`](#etriggerdistanceop) | [`EDistanceMethod`](#edistancemethod) ] - __Class List:__ [ [`UFPTask_TriggerDistance`](#ufptask_triggerdistance) ] -- __Enum List:__ -[ ] + + +### `ETriggerDistanceOp` + + +| Value | Description | +| :-- | :-- | +| `LessThan` | LessThan | +| `LessThanOrEqual` | LessThanOrEqual | +| `GreaterThan` | GreaterThan | +| `GreaterThanOrEqual` | GreaterThanOrEqual | + + + +### `EDistanceMethod` + + +| Value | Description | +| :-- | :-- | +| `Distance3D` | Distance3D | +| `Distance2D` | Distance2D | + ## `UFPTask_TriggerDistance` @@ -18,7 +40,7 @@ __FileName:__ `FPTask_TriggerDistance.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Trigger by Distance ### Properties diff --git a/src/content/docs/reference/FPTask_TriggerVolume.mdx b/src/content/docs/reference/FPTask_TriggerVolume.mdx index ca7989a..eccbe51 100644 --- a/src/content/docs/reference/FPTask_TriggerVolume.mdx +++ b/src/content/docs/reference/FPTask_TriggerVolume.mdx @@ -6,10 +6,20 @@ description: Reference page for FPTask_TriggerVolume.h ## File Info __FileName:__ `FPTask_TriggerVolume.h` +- __Enum List:__ +[ [`ETriggerVolumeEvent`](#etriggervolumeevent) ] - __Class List:__ [ [`UFPTask_TriggerVolume`](#ufptask_triggervolume) ] -- __Enum List:__ -[ ] + + +### `ETriggerVolumeEvent` + + +| Value | Description | +| :-- | :-- | +| `OnEnter` | Triggers when Entering Volume | +| `OnExit` | Triggers when Exiting Volume | + ## `UFPTask_TriggerVolume` @@ -18,17 +28,19 @@ __FileName:__ `FPTask_TriggerVolume.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ -Trigger by Volume + +Trigger by Volume Task +- Allows choosing to Trigger (succeed task) on Entry or Exit of a volume +- Allows to wait on multiple Pawns ### Properties ```cpp -// Trigger to Listen to +// Trigger Event to Listen to UPROPERTY(EditAnywhere, Category = "FlowPilot") ETriggerVolumeEvent TriggerEvent; -// Volume Reference Actor +// Volume Reference Actor. Should be single actor UPROPERTY(EditAnywhere, Category = "FlowPilot") FFlowActorReference VolumeReference; diff --git a/src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx b/src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx index 7d44f56..748b4e8 100644 --- a/src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx +++ b/src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx @@ -16,7 +16,7 @@ __FileName:__ `FPTask_UnloadStreamedLevel.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ + Unloads Streamed Level ### Properties diff --git a/src/content/docs/reference/FlowActorReference.mdx b/src/content/docs/reference/FlowActorReference.mdx index 3ba78bd..8055918 100644 --- a/src/content/docs/reference/FlowActorReference.mdx +++ b/src/content/docs/reference/FlowActorReference.mdx @@ -13,7 +13,7 @@ __FileName:__ `FlowActorReference.h` ## `FFlowActorReference` - \ + FFlowActorReference ### Properties diff --git a/src/content/docs/reference/FlowPilot.mdx b/src/content/docs/reference/FlowPilot.mdx index f7e10bb..cc14bca 100644 --- a/src/content/docs/reference/FlowPilot.mdx +++ b/src/content/docs/reference/FlowPilot.mdx @@ -16,7 +16,7 @@ __FileName:__ `FlowPilot.h` __Parent Classes:__ [ `UDataAsset` ] - \ + FlowPilot Data ### Properties diff --git a/src/content/docs/reference/FlowPilotComponent.mdx b/src/content/docs/reference/FlowPilotComponent.mdx index abeb9bc..058809a 100644 --- a/src/content/docs/reference/FlowPilotComponent.mdx +++ b/src/content/docs/reference/FlowPilotComponent.mdx @@ -16,8 +16,8 @@ __FileName:__ `FlowPilotComponent.h` __Parent Classes:__ [ `UActorComponent` ] - \ -FlowComponent \ + +FlowComponent - Initializes, Maintains and Runs a Flow Data Asset. ### Properties diff --git a/src/content/docs/reference/FlowPilotParent.mdx b/src/content/docs/reference/FlowPilotParent.mdx index 1503611..2873c8f 100644 --- a/src/content/docs/reference/FlowPilotParent.mdx +++ b/src/content/docs/reference/FlowPilotParent.mdx @@ -16,8 +16,8 @@ __FileName:__ `FlowPilotParent.h` __Parent Classes:__ [ `UFlowPilotTask` ] - \ -FlowPilotParent \ -Base class that contains an array of Tasks \ - \ + +FlowPilotParent +Base class that contains an array of Tasks + - Implements base functionality to query, add, remove tasks, etc.. diff --git a/src/content/docs/reference/FlowPilotSettings.mdx b/src/content/docs/reference/FlowPilotSettings.mdx index 3c3cfd9..e8b9faa 100644 --- a/src/content/docs/reference/FlowPilotSettings.mdx +++ b/src/content/docs/reference/FlowPilotSettings.mdx @@ -16,7 +16,7 @@ __FileName:__ `FlowPilotSettings.h` __Parent Classes:__ [ `UDeveloperSettings` ] - \ + FlowPilot Project User Settings. ### Properties diff --git a/src/content/docs/reference/FlowPilotSubsystem.mdx b/src/content/docs/reference/FlowPilotSubsystem.mdx index 849c127..fdf5469 100644 --- a/src/content/docs/reference/FlowPilotSubsystem.mdx +++ b/src/content/docs/reference/FlowPilotSubsystem.mdx @@ -6,10 +6,10 @@ description: Reference page for FlowPilotSubsystem.h ## File Info __FileName:__ `FlowPilotSubsystem.h` -- __Class List:__ -[ [`UFlowPilotSubsystem`](#uflowpilotsubsystem) ] - __Struct List:__ [ ] +- __Class List:__ +[ [`UFlowPilotSubsystem`](#uflowpilotsubsystem) ] ## `UFlowPilotSubsystem` @@ -18,5 +18,5 @@ __FileName:__ `FlowPilotSubsystem.h` __Parent Classes:__ [ `UWorldSubsystem` ] - \ + FlowPilot Subsystem diff --git a/src/content/docs/reference/FlowPilotTask.mdx b/src/content/docs/reference/FlowPilotTask.mdx index e1f05d0..84eb052 100644 --- a/src/content/docs/reference/FlowPilotTask.mdx +++ b/src/content/docs/reference/FlowPilotTask.mdx @@ -16,8 +16,8 @@ __FileName:__ `FlowPilotTask.h` __Parent Classes:__ [ `UObject` ] - \ -FlowPilotTask \ + +FlowPilotTask - Can Tick ### Properties diff --git a/src/content/docs/reference/FlowTypes.mdx b/src/content/docs/reference/FlowTypes.mdx index 5f3d78e..956b199 100644 --- a/src/content/docs/reference/FlowTypes.mdx +++ b/src/content/docs/reference/FlowTypes.mdx @@ -6,169 +6,99 @@ description: Reference page for FlowTypes.h ## File Info __FileName:__ `FlowTypes.h` -- __Struct List:__ -[ [`FFlowContext`](#fflowcontext) ] - __Enum List:__ [ [`EFPInternalTaskState`](#efpinternaltaskstate) | [`EFPStopType`](#efpstoptype) | [`EFPTaskResult`](#efptaskresult) | [`EFlowState`](#eflowstate) | [`EFlowActorScope`](#eflowactorscope) | [`EFlowActorSpawnLifetime`](#eflowactorspawnlifetime) | [`EFlowMode`](#eflowmode) ] +- __Struct List:__ +[ [`FFlowContext`](#fflowcontext) ] -## `EFPInternalTaskState` - - -### Properties - -```cpp -// Not started yet -Invalid = 0, - -// Setup done -Setup, - -// Started Execution -Started, - -// Is in Progress -Ticking, - -// ---- -// > Ticking = Completed -// Completed -Completed - -``` - - -## `EFPStopType` - - -### Properties - -```cpp -// Cancel Execution will call Exit with Failure state on Running Tasks -CancelExecution, - -// Stop Now will just stop execution. Exit won't be called. -StopNow - -``` - - -## `EFPTaskResult` - - -### Properties - -```cpp -// Not started yet -None, - -// In progress and Ticking -InProgress, - -// Complete with Success Result -Succeeded, - -// Complete with Fail Result -Failed, - -// Not Complete. Return Error -Error - -``` - - -## `EFlowState` - - -### Properties +### `EFPInternalTaskState` -```cpp -// Not started yet -None, -// FlowPilot Running -InProgress, +| Value | Description | +| :-- | :-- | +| `Invalid = 0` | Not started yet | +| `Setup` | Setup done | +| `Started` | Started Execution | +| `Ticking` | Is in Progress | +| `Completed` | ----, > Ticking = Completed, Completed | -// FlowPilot has started but is paused -Paused, -// FlowPilot Done with Success -Succeeded, -// FlowPilot Done with fail -Failed, +### `EFPStopType` -// FlowPilot not Done, with Error -Error -``` +| Value | Description | +| :-- | :-- | +| `CancelExecution` | Cancel Execution will call Exit with Failure state on Running Tasks | +| `StopNow` | Stop Now will just stop execution. Exit won't be called. | -## `EFlowActorScope` +### `EFPTaskResult` -### Properties -```cpp -// Actor or Component is in Own Actor -Self, +| Value | Description | +| :-- | :-- | +| `None` | Not started yet | +| `InProgress` | In progress and Ticking | +| `Succeeded` | Complete with Success Result | +| `Failed` | Complete with Fail Result | +| `Error` | Not Complete. Return Error | -// Actor that live in the world -InLevel, -// Actors spawned at Runtime -Runtime, -``` +### `EFlowState` -## `EFlowActorSpawnLifetime` +| Value | Description | +| :-- | :-- | +| `None` | Not started yet | +| `InProgress` | FlowPilot Running | +| `Paused` | FlowPilot has started but is paused | +| `Succeeded` | FlowPilot Done with Success | +| `Failed` | FlowPilot Done with fail | +| `Error` | FlowPilot not Done, with Error | -### Properties -```cpp -// Spawned actor will live during FlowPilot Execution, will despawn automatically when Flow Ends. -FlowPilot, +### `EFlowActorScope` -// 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. -Persistent -``` +| Value | Description | +| :-- | :-- | +| `Self` | Actor or Component is in Own Actor | +| `InLevel` | Actor that live in the world | +| `Runtime` | Actors spawned at Runtime | -## `EFlowMode` +### `EFlowActorSpawnLifetime` -### Properties -```cpp -// Executes Flow Once. -RunOnce, +| Value | Description | +| :-- | :-- | +| `FlowPilot` | Spawned actor will live during FlowPilot Execution, will despawn automatically when Flow Ends. | +| `Persistent` | 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. | -// Executes until Succeeds Once -RunUntilSucceed, -// Executes until Fails Once -RunUntilFail, -// Executes in Loop while Succeeds -RunWhileSucceed, +### `EFlowMode` -// Executes in Loop while Fails -RunWhileFail, -// Run non stop. -RunNonStop +| Value | Description | +| :-- | :-- | +| `RunOnce` | Executes Flow Once. | +| `RunUntilSucceed` | Executes until Succeeds Once | +| `RunUntilFail` | Executes until Fails Once | +| `RunWhileSucceed` | Executes in Loop while Succeeds | +| `RunWhileFail` | Executes in Loop while Fails | +| `RunNonStop` | Run non stop. | -``` ## `FFlowContext` - \ + Flow Context