update docs

Mikea15 · Sep 7, 2024 · 48481ed · 48481ed
1 parent 590b05f
commit 48481ed
Show file tree

Hide file tree

Showing 28 changed files with 176 additions and 210 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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<AController> ControllerClass;
 

diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -16,7 +16,7 @@ __FileName:__ `FlowPilot.h`
 __Parent Classes:__
 [ `UDataAsset` ]
 
- \
+
 FlowPilot Data 
 
 ### Properties
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,7 +13,7 @@ __FileName:__ `FlowActorReference.h` @@
     ## `FFlowActorReference`
-     \
     FFlowActorReference
     ### Properties
@@ Expand Down @@