update docs

Author: Mikea15

src/content/docs/reference/FPTagActorComponent.mdx

@@ -18,3 +18,4 @@ __Parent Classes:__
 
 
 Helper Component to add Tags to Actor. 
+- Adds Tags to Actor on `InitializeComponent` 

src/content/docs/reference/FPTask_BlueprintBase.mdx

@@ -14,8 +14,8 @@ __FileName:__ `FPTask_BlueprintBase.h`
 
 
 
-Blueprint Base Task 
-- Inherit from Blueprints to have custom BP Tasks. 
+Create Blueprint Tasks using this class as base. 
+- If Tick is not implemented, will instantly succeed on first tick. 
 
 ### Functions
 
@@ -26,17 +26,18 @@ Blueprint Base Task
 void ReceiveSetup();
 ```
 #### `ReceiveEnter`
-> Implement enter Task 
+> Implement Enter Task 
 ```cpp
 bool ReceiveEnter();
 ```
 #### `ReceiveTick`
-> Implement tick Task 
+> Implement Tick from Blueprint \
+> !! FinishTask has to be called from ReceiveTick !! 
 ```cpp
-EFPTaskResult ReceiveTick(float DeltaTime);
+void ReceiveTick(float DeltaTime);
 ```
 #### `ReceiveExit`
-> Implement exit Task 
+> Implement Exit from Blueprint 
 ```cpp
 void ReceiveExit(EFPTaskResult TaskResult);
 ```

src/content/docs/reference/FPTask_Delay.mdx

@@ -17,11 +17,15 @@ __Parent Classes:__
 [ `UFlowPilotTask` ]
 
 
-Delays Execution 
+Simple task that adds a delay to the execution flow 
 
 ### Properties
 
 ```cpp
+// Delay Time 
+UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits="s"))
+float DelayTime = 0.0f;
+
 // Adds random deviation (TimeAmount - RndDev, TimeAmount + RndDev), Clamped (0.0f - T) 
 UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits="s"))
 float RandomDeviation = 0.0f;

src/content/docs/reference/FPTask_FlowAsset.mdx

@@ -0,0 +1,78 @@
+---
+title: FPTask_InsideVolume.h
+description: Reference page for FPTask_InsideVolume.h
+---
+
+## File Info
+
+
+__FileName:__ `FPTask_InsideVolume.h`
+- __Enum List:__ 
+[ [`EInsideVolumeFilterType`](#einsidevolumefiltertype) | [`EInsideVolumeComparisonOp`](#einsidevolumecomparisonop) ]
+- __Class List:__ 
+[ [`UFPTask_InsideVolume`](#ufptask_insidevolume) ]
+
+
+### `EInsideVolumeFilterType` 
+
+
+| Value | Description | 
+| :-- | :-- | 
+| `ByActor` | Filter Actors by Reference | 
+| `ByClass` | Filter Actors by Class | 
+
+
+
+### `EInsideVolumeComparisonOp` 
+
+
+| Value | Description | 
+| :-- | :-- | 
+| `Equal` | Equal | 
+| `NotEqual` | NotEqual | 
+| `MoreThan` | MoreThan | 
+| `MoreThanOrEqual` | MoreThanOrEqual | 
+| `LessThan` | LessThan | 
+| `LessThanOrEqual` | LessThanOrEqual | 
+
+
+
+## `UFPTask_InsideVolume` 
+
+
+__Parent Classes:__
+[ `UFlowPilotTask` ]
+
+ 
+Inside Volume 
+- Specific "Trigger Volume" class that only checks if N Actors are inside a volume. 
+- Actors can be found by ActorReference or Class Type 
+
+### Properties
+
+```cpp
+// Trigger Volume Reference 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+FFlowActorReference VolumeActorReference;
+
+// Actor Filter Type 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+EInsideVolumeFilterType FilterActorType = EInsideVolumeFilterType::ByActor;
+
+// Actor Type Reference 
+UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EInsideVolumeFilterType::ByActor"))
+FFlowActorReference ActorTypeReference;
+
+// Class Type Reference 
+UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EInsideVolumeFilterType::ByClass"))
+TSoftClassPtr<AActor> ClassType;
+
+// Comparison Operation for Actors Requires Inside Volume 
+UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EInsideVolumeFilterType::ByClass"))
+EInsideVolumeComparisonOp ComparisonOperation = EInsideVolumeComparisonOp::Equal;
+
+// How many Actors required inside volume 
+UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EInsideVolumeFilterType::ByClass"))
+int32 RequiredActorsCount = 1;
+
+```

src/content/docs/reference/FPTask_InsideVolume.mdx

@@ -17,4 +17,21 @@ __Parent Classes:__
 [ `UFlowPilotTask` ]
 
 
-Executes a Task in a Loop 
+Loops a Task's execution for X amount of times, or infinite 
+
+### Properties
+
+```cpp
+// Task to loop 
+UPROPERTY(EditDefaultsOnly, Instanced, Category = "FlowPilot")
+TObjectPtr<UFlowPilotTask> Task;
+
+// Will forever loop if True 
+UPROPERTY(EditDefaultsOnly, Category = "FlowPilot")
+uint8 bIsInfinite : 1;
+
+// Number of times to repeat the same task 
+UPROPERTY(EditDefaultsOnly, Category = "FlowPilot", meta=(ClampMin=1, EditCondition="!bIsInfinite"))
+int32 Loops = 3;
+
+```

src/content/docs/reference/FPTask_Loop.mdx

@@ -38,7 +38,8 @@ Parallel Task
 ### Properties
 
 ```cpp
-// This defines what makes this Task succeed to continue flow. 
+// Desired Completion Type allows changing the Parallel Task Behavior 
+// See EFlowParallelCompletetionType enum 
 UPROPERTY(EditDefaultsOnly, Category="FlowPilot")
 EFlowParallelCompletionType DesiredCompletionType = EFlowParallelCompletionType::AllSucceed;
 

src/content/docs/reference/FPTask_Parallel.mdx

@@ -19,26 +19,26 @@ __Parent Classes:__
 [ `UFlowPilotTask` ]
 
 
-Play Animation 
-- Can Play an animation on many Pawns 
-- Can wait for animations to finish to continue 
+Task that plays an animation 
+- Will play the animation to one or multiple Pawns found via FlowActorReference 
+- Option to wait for animations to complete before succeeding 
 
 ### Properties
 
 ```cpp
-// Actors this animation asset will be played on 
+// Pawns to play animations on 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 FFlowActorReference ActorsToPlayAnimationOn;
 
-// Animation Asset to use 
+// Animation Asset to play 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 TSoftObjectPtr<UAnimationAsset> AnimationAsset;
 
-// Loop animation if true 
+// if true, will loop animations 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 uint8 bLooping : 1;
 
-// Waits for animation to complete to continue execution 
+// if true, will wait for animation to finish before succeeding task 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 uint8 bWaitForAnimationEnd : 1;
 

src/content/docs/reference/FPTask_PlayAnimation.mdx

@@ -22,15 +22,15 @@ Plays SoundCues or SoundWaves
 ### Properties
 
 ```cpp
-// Where to play sound from. 
+// Actor Reference to use as source location 
 UPROPERTY(EditAnywhere, Category = "FlowPilot")
 FFlowActorReference ActorReference;
 
-// SoundCue to Play 
+// Sound Cue to play 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 TObjectPtr<USoundCue> SoundToPlay;
 
-// SoundWave to Play 
+// Sound Wave to play 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 TObjectPtr<USoundWave> SoundWaveToPlay;
 

src/content/docs/reference/FPTask_PlaySound.mdx

@@ -22,15 +22,15 @@ Play 2D Sounds
 ### Properties
 
 ```cpp
-// SoundCue to play 
+// Sound Cue to Play 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 TObjectPtr<USoundCue> SoundToPlay;
 
-// SoundWave to play 
+// Sound Wave to Play 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 TObjectPtr<USoundWave> SoundWaveToPlay;
 
-// Is UI Sound 
+// if true, will play as UI sound 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 uint8 bIsUISound : 1;
 
@@ -42,19 +42,19 @@ float VolumeMultiplier = 1.0f;
 UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
 float PitchMultiplier = 1.0f;
 
-// Play Start time 
+// Play Start Time 
 UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
 float StartTime = 0.0f;
 
-// Concurrency Settings 
+// Sound Concurrency Settings 
 UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
 USoundConcurrency* ConcurrencySettings = nullptr;
 
-// If the Sound persists across level changes 
+// if True, sound will persist across level changes 
 UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
 bool bPersistAcrossLevels = false;
 
-// Automatically destroy sound when finished playing 
+// if true, sound actor will auto destroy once finished playing 
 UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
 bool bAutoDestroy = true;
 

src/content/docs/reference/FPTask_PlaySound2D.mdx

@@ -17,29 +17,22 @@ __Parent Classes:__
 [ `UFlowPilotTask` ]
 
 
-Posses Pawn: 
+Possess Pawn 
 - Spawns a Controller and Possesses a Pawn 
-- Can Possess multiple Pawns at the same time using a shared GameplayTag 🏷️ 
+- Can Possess multiple Pawns at the same time 
 
 ### 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;
 
-// If true, the Player will posses the Pawn 
+// Player Possesses only 1 Pawn 
 UPROPERTY(EditAnywhere, Category="FlowPilot")
 bool bPossessByPlayer = false;
 
-// 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 
+// AI Controller Class to Posses Pawns with. 
 UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="!bPossessByPlayer", EditConditionHides))
 TSubclassOf<AController> ControllerClass;
 

src/content/docs/reference/FPTask_PossessPawn.mdx

@@ -14,7 +14,7 @@ __FileName:__ `FPTask_Selector.h`
 
 
 __Parent Classes:__
-[ `UFPTaskRunner` ]
+[ `UFPTask_Sequence` ]
 
 
 Selector Task 

src/content/docs/reference/FPTask_Selector.mdx

@@ -14,7 +14,7 @@ __FileName:__ `FPTask_Sequence.h`
 
 
 __Parent Classes:__
-[ `UFPTaskRunner` ]
+[ `UFlowPilotParent` ]
 
 
 Sequence Task