From 0c5c2b7ca12c454416580ce6a50209f58616f627 Mon Sep 17 00:00:00 2001
From: Michael Adaixo <michael.adaixo@gmail.com>
Date: Sun, 8 Sep 2024 00:03:15 +0100
Subject: [PATCH] doc updates

---
 .../docs/reference/FPTask_PlayAnimation.mdx   | 25 ++++++++++-
 .../docs/reference/FPTask_PlaySound.mdx       |  8 ++++
 .../docs/reference/FPTask_PlaySound2D.mdx     | 41 +++++++++++++++++++
 .../docs/reference/FPTask_SpawnClass.mdx      |  2 +-
 .../docs/reference/FPTask_TriggerDistance.mdx |  4 ++
 5 files changed, 78 insertions(+), 2 deletions(-)

diff --git a/src/content/docs/reference/FPTask_PlayAnimation.mdx b/src/content/docs/reference/FPTask_PlayAnimation.mdx
index 65877b6..b7ff74d 100644
--- a/src/content/docs/reference/FPTask_PlayAnimation.mdx
+++ b/src/content/docs/reference/FPTask_PlayAnimation.mdx
@@ -19,4 +19,27 @@ __Parent Classes:__
 [ `UFlowPilotTask` ]
 
  
- 
+Play Animation 
+- Can Play an animation on many Pawns 
+- Can wait for animations to finish to continue 
+
+### Properties
+
+```cpp
+// Actors this animation asset will be played on 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+FFlowActorReference ActorsToPlayAnimationOn;
+
+// Animation Asset to use 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+TSoftObjectPtr<UAnimationAsset> AnimationAsset;
+
+// Loop animation if true 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+uint8 bLooping : 1;
+
+// Waits for animation to complete to continue execution 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+uint8 bWaitForAnimationEnd : 1;
+
+```
diff --git a/src/content/docs/reference/FPTask_PlaySound.mdx b/src/content/docs/reference/FPTask_PlaySound.mdx
index e1985ad..8485478 100644
--- a/src/content/docs/reference/FPTask_PlaySound.mdx
+++ b/src/content/docs/reference/FPTask_PlaySound.mdx
@@ -26,4 +26,12 @@ Plays SoundCues or SoundWaves
 UPROPERTY(EditAnywhere, Category = "FlowPilot")
 FFlowActorReference ActorReference;
 
+// SoundCue to Play 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+TObjectPtr<USoundCue> SoundToPlay;
+
+// SoundWave to Play 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+TObjectPtr<USoundWave> SoundWaveToPlay;
+
 ```
diff --git a/src/content/docs/reference/FPTask_PlaySound2D.mdx b/src/content/docs/reference/FPTask_PlaySound2D.mdx
index d9f1e04..d8eb38b 100644
--- a/src/content/docs/reference/FPTask_PlaySound2D.mdx
+++ b/src/content/docs/reference/FPTask_PlaySound2D.mdx
@@ -18,3 +18,44 @@ __Parent Classes:__
 
  
 Play 2D Sounds 
+
+### Properties
+
+```cpp
+// SoundCue to play 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+TObjectPtr<USoundCue> SoundToPlay;
+
+// SoundWave to play 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+TObjectPtr<USoundWave> SoundWaveToPlay;
+
+// Is UI Sound 
+UPROPERTY(EditAnywhere, Category="FlowPilot")
+uint8 bIsUISound : 1;
+
+// Volume Multiplier 
+UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
+float VolumeMultiplier = 1.0f;
+
+// Pitch Multiplier 
+UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
+float PitchMultiplier = 1.0f;
+
+// Play Start time 
+UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
+float StartTime = 0.0f;
+
+// Concurrency Settings 
+UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
+USoundConcurrency* ConcurrencySettings = nullptr;
+
+// If the Sound persists across level changes 
+UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
+bool bPersistAcrossLevels = false;
+
+// Automatically destroy sound when finished playing 
+UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
+bool bAutoDestroy = true;
+
+```
diff --git a/src/content/docs/reference/FPTask_SpawnClass.mdx b/src/content/docs/reference/FPTask_SpawnClass.mdx
index 50a1318..70b0f26 100644
--- a/src/content/docs/reference/FPTask_SpawnClass.mdx
+++ b/src/content/docs/reference/FPTask_SpawnClass.mdx
@@ -22,7 +22,7 @@ Spawns a Class
 ### Properties
 
 ```cpp
-// SpawnLifetime dictates when we Destroy this Actor, (or leave it alive forever) 
+// Spawn Lifetime dictates when we Destroy this Actor or leave it alive forever 
 UPROPERTY(EditAnywhere, Category = "FlowPilot")
 EFlowActorSpawnLifetime ActorSpawnLifetime = EFlowActorSpawnLifetime::Persistent;
 
diff --git a/src/content/docs/reference/FPTask_TriggerDistance.mdx b/src/content/docs/reference/FPTask_TriggerDistance.mdx
index d8d1c72..a5455f1 100644
--- a/src/content/docs/reference/FPTask_TriggerDistance.mdx
+++ b/src/content/docs/reference/FPTask_TriggerDistance.mdx
@@ -54,6 +54,10 @@ FFlowActorReference FirstActorReference;
 UPROPERTY(EditAnywhere, Category = "FlowPilot")
 ETriggerDistanceOp Operation = ETriggerDistanceOp::LessThan;
 
+// Distance Method 
+UPROPERTY(EditAnywhere, Category = "FlowPilot")
+EDistanceMethod Method = EDistanceMethod::Distance3D;
+
 // Threshold to check distance against 
 UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f))
 float ThresholdDistance;