update docs

Mikea15 · Sep 1, 2024 · 6eccdc6 · 6eccdc6
1 parent 0b5832d
commit 6eccdc6
Show file tree

Hide file tree

Showing 28 changed files with 117 additions and 177 deletions.
diff --git a/src/content/docs/reference/FFlowActorReference.mdx b/src/content/docs/reference/FFlowActorReference.mdx
diff --git a/src/content/docs/reference/FFlowPilotSettings.mdx b/src/content/docs/reference/FFlowPilotSettings.mdx
diff --git a/src/content/docs/reference/FPTagActorComponent.mdx b/src/content/docs/reference/FPTagActorComponent.mdx
@@ -1,13 +1,16 @@
 ---
 title: UFPTagActorComponent
-description: Reference page for UFPTagActorComponent class
+description: Reference page for UFPTagActorComponent
 ---
 
 ## Class Info
 - __Parent Class:__ `UActorComponent`
 - __FileName:__ `FPTagActorComponent.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTaskRunner.mdx b/src/content/docs/reference/FPTaskRunner.mdx
@@ -1,13 +1,16 @@
 ---
 title: UFPTaskRunner
-description: Reference page for UFPTaskRunner class
+description: Reference page for UFPTaskRunner
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotParent`
 - __FileName:__ `FPTaskRunner.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_BlueprintBase.mdx b/src/content/docs/reference/FPTask_BlueprintBase.mdx
@@ -1,13 +1,15 @@
 ---
 title: UFPTask_BlueprintBase
-description: Reference page for UFPTask_BlueprintBase class
+description: Reference page for UFPTask_BlueprintBase
 ---
 
 ## Class Info
 - __FileName:__ `FPTask_BlueprintBase.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
 ### `ReceiveSetup`

diff --git a/src/content/docs/reference/FPTask_Delay.mdx b/src/content/docs/reference/FPTask_Delay.mdx
@@ -1,11 +1,12 @@
 ---
 title: UFPTask_Delay
-description: Reference page for UFPTask_Delay class
+description: Reference page for UFPTask_Delay
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_Delay.h`
+
 ## Properties
 
 ```cpp
@@ -14,5 +15,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits=
 float RandomDeviation = 0.0f;
 
 ```
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_DestroyActor.mdx b/src/content/docs/reference/FPTask_DestroyActor.mdx
@@ -1,11 +1,12 @@
 ---
 title: UFPTask_DestroyActor
-description: Reference page for UFPTask_DestroyActor class
+description: Reference page for UFPTask_DestroyActor
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_DestroyActor.h`
+
 ## Properties
 
 ```cpp
@@ -18,5 +19,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits=
 float Delay = 0.0f;
 
 ```
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_FlowAsset.mdx b/src/content/docs/reference/FPTask_FlowAsset.mdx
@@ -1,13 +1,16 @@
 ---
 title: UFPTask_FlowAsset
-description: Reference page for UFPTask_FlowAsset class
+description: Reference page for UFPTask_FlowAsset
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_FlowAsset.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_FlowPilotControl.mdx b/src/content/docs/reference/FPTask_FlowPilotControl.mdx
@@ -1,11 +1,12 @@
 ---
 title: UFPTask_FlowPilotControl
-description: Reference page for UFPTask_FlowPilotControl class
+description: Reference page for UFPTask_FlowPilotControl
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_FlowPilotControl.h`
+
 ## Properties
 
 ```cpp
@@ -28,5 +29,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType
 EFlowControlSuccessCondition SuccessCondition = EFlowControlSuccessCondition::Instant;
 
 ```
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_LoadLevel.mdx b/src/content/docs/reference/FPTask_LoadLevel.mdx
@@ -1,13 +1,16 @@
 ---
 title: UFPTask_LoadLevel
-description: Reference page for UFPTask_LoadLevel class
+description: Reference page for UFPTask_LoadLevel
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_LoadLevel.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_Loop.mdx b/src/content/docs/reference/FPTask_Loop.mdx
@@ -1,13 +1,16 @@
 ---
 title: UFPTask_Loop
-description: Reference page for UFPTask_Loop class
+description: Reference page for UFPTask_Loop
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_Loop.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_Parallel.mdx b/src/content/docs/reference/FPTask_Parallel.mdx
@@ -1,6 +1,6 @@
 ---
 title: UFPTask_Parallel
-description: Reference page for UFPTask_Parallel class
+description: Reference page for UFPTask_Parallel
 ---
 import Ref from '../../../components/Ref.astro'
 import LinkRef from '../../../components/LinkRef.astro'
@@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_parallel.png';
 
 <Ref c="UFPTask_Parallel" p="UFlowPilotTask" />
 
-### Description
+## Description
 
 <Image src={schema} alt="UFPTask_Parallel Schema" />
 
@@ -26,6 +26,7 @@ There are various _Completion types_ for this task:
 ## Class Info
 - __Parent Class:__ `UFlowPilotParent`
 - __FileName:__ `FPTask_Parallel.h`
+
 ## Properties
 
 ```cpp
@@ -34,5 +35,7 @@ UPROPERTY(EditDefaultsOnly, Category="FlowPilot")
 EFlowParallelCompletionType DesiredCompletionType = EFlowParallelCompletionType::AllSucceed;
 
 ```
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_PlayAnimation.mdx b/src/content/docs/reference/FPTask_PlayAnimation.mdx
@@ -1,13 +1,16 @@
 ---
 title: UFPTask_PlayAnimation
-description: Reference page for UFPTask_PlayAnimation class
+description: Reference page for UFPTask_PlayAnimation
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_PlayAnimation.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_PlaySound.mdx b/src/content/docs/reference/FPTask_PlaySound.mdx
@@ -1,11 +1,12 @@
 ---
 title: UFPTask_PlaySound
-description: Reference page for UFPTask_PlaySound class
+description: Reference page for UFPTask_PlaySound
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_PlaySound.h`
+
 ## Properties
 
 ```cpp
@@ -14,5 +15,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot")
 FFlowActorReference ActorReference;
 
 ```
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_PlaySound2D.mdx b/src/content/docs/reference/FPTask_PlaySound2D.mdx
@@ -1,13 +1,16 @@
 ---
 title: UFPTask_PlaySound2D
-description: Reference page for UFPTask_PlaySound2D class
+description: Reference page for UFPTask_PlaySound2D
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_PlaySound2D.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_PossessPawn.mdx b/src/content/docs/reference/FPTask_PossessPawn.mdx
@@ -1,11 +1,12 @@
 ---
 title: UFPTask_PossessPawn
-description: Reference page for UFPTask_PossessPawn class
+description: Reference page for UFPTask_PossessPawn
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_PossessPawn.h`
+
 ## Properties
 
 ```cpp
@@ -22,5 +23,7 @@ UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="!bPossessByPl
 TSubclassOf<AController> ControllerClass;
 
 ```
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_Selector.mdx b/src/content/docs/reference/FPTask_Selector.mdx
@@ -1,6 +1,6 @@
 ---
 title: UFPTask_Selector
-description: Reference page for UFPTask_Selector class
+description: Reference page for UFPTask_Selector
 ---
 import Ref from '../../../components/Ref.astro'
 import LinkRef from '../../../components/LinkRef.astro'
@@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_selector.png';
 
 <Ref c="UFPTask_Selector" p="UFlowPilotTask" />
 
-### Description
+## Description
 
 <Image src={schema} alt="UFPTask_Selector Schema" />
 
@@ -26,8 +26,11 @@ If no task succeeded, then `UFPTask_Selector` will return failure.
 ## Class Info
 - __Parent Class:__ `UFPTaskRunner`
 - __FileName:__ `FPTask_Selector.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_Sequence.mdx b/src/content/docs/reference/FPTask_Sequence.mdx
@@ -1,6 +1,6 @@
 ---
 title: UFPTask_Sequence
-description: Reference page for UFPTask_Sequence class
+description: Reference page for UFPTask_Sequence
 ---
 import Ref from '../../../components/Ref.astro'
 import LinkRef from '../../../components/LinkRef.astro'
@@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_sequence.png';
 
 <Ref c="UFPTask_Sequence" p="UFlowPilotTask" />
 
-### Description
+## Description
 
 <Image src={schema} alt="UFPTask_Sequence Schema" />
 
@@ -21,13 +21,14 @@ The schema above explains how it should work.
 
 If one of the Tasks fail, `UFPTask_Sequence` will return failure.
 
-
-
 ## Class Info
 - __Parent Class:__ `UFPTaskRunner`
 - __FileName:__ `FPTask_Sequence.h`
+
 ## Properties
 
 No properties in this class
+
 ## Functions
 
+No functions in this class
diff --git a/src/content/docs/reference/FPTask_SpawnClass.mdx b/src/content/docs/reference/FPTask_SpawnClass.mdx
@@ -1,11 +1,12 @@
 ---
 title: UFPTask_SpawnClass
-description: Reference page for UFPTask_SpawnClass class
+description: Reference page for UFPTask_SpawnClass
 ---
 
 ## Class Info
 - __Parent Class:__ `UFlowPilotTask`
 - __FileName:__ `FPTask_SpawnClass.h`
+
 ## Properties
 
 ```cpp
@@ -34,5 +35,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot")
 ESpawnActorCollisionHandlingMethod SpawnCollisionMethods = ESpawnActorCollisionHandlingMethod::AdjustIfPossibleButAlwaysSpawn;
 
 ```
+
 ## Functions
 
+No functions in this class