Skip to content

Commit 6eccdc6

Browse files
committed
update docs
1 parent 0b5832d commit 6eccdc6

28 files changed

+117
-177
lines changed

src/content/docs/reference/FFlowActorReference.mdx

-14
This file was deleted.

src/content/docs/reference/FFlowPilotSettings.mdx

-12
This file was deleted.
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
22
title: UFPTagActorComponent
3-
description: Reference page for UFPTagActorComponent class
3+
description: Reference page for UFPTagActorComponent
44
---
55

66
## Class Info
77
- __Parent Class:__ `UActorComponent`
88
- __FileName:__ `FPTagActorComponent.h`
9+
910
## Properties
1011

1112
No properties in this class
13+
1214
## Functions
1315

16+
No functions in this class
+4-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
22
title: UFPTaskRunner
3-
description: Reference page for UFPTaskRunner class
3+
description: Reference page for UFPTaskRunner
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotParent`
88
- __FileName:__ `FPTaskRunner.h`
9+
910
## Properties
1011

1112
No properties in this class
13+
1214
## Functions
1315

16+
No functions in this class

src/content/docs/reference/FPTask_BlueprintBase.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
---
22
title: UFPTask_BlueprintBase
3-
description: Reference page for UFPTask_BlueprintBase class
3+
description: Reference page for UFPTask_BlueprintBase
44
---
55

66
## Class Info
77
- __FileName:__ `FPTask_BlueprintBase.h`
8+
89
## Properties
910

1011
No properties in this class
12+
1113
## Functions
1214

1315
### `ReceiveSetup`
+4-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: UFPTask_Delay
3-
description: Reference page for UFPTask_Delay class
3+
description: Reference page for UFPTask_Delay
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_Delay.h`
9+
910
## Properties
1011

1112
```cpp
@@ -14,5 +15,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits=
1415
float RandomDeviation = 0.0f;
1516

1617
```
18+
1719
## Functions
1820
21+
No functions in this class

src/content/docs/reference/FPTask_DestroyActor.mdx

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: UFPTask_DestroyActor
3-
description: Reference page for UFPTask_DestroyActor class
3+
description: Reference page for UFPTask_DestroyActor
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_DestroyActor.h`
9+
910
## Properties
1011

1112
```cpp
@@ -18,5 +19,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits=
1819
float Delay = 0.0f;
1920

2021
```
22+
2123
## Functions
2224
25+
No functions in this class
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
22
title: UFPTask_FlowAsset
3-
description: Reference page for UFPTask_FlowAsset class
3+
description: Reference page for UFPTask_FlowAsset
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_FlowAsset.h`
9+
910
## Properties
1011

1112
No properties in this class
13+
1214
## Functions
1315

16+
No functions in this class

src/content/docs/reference/FPTask_FlowPilotControl.mdx

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: UFPTask_FlowPilotControl
3-
description: Reference page for UFPTask_FlowPilotControl class
3+
description: Reference page for UFPTask_FlowPilotControl
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_FlowPilotControl.h`
9+
910
## Properties
1011

1112
```cpp
@@ -28,5 +29,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType
2829
EFlowControlSuccessCondition SuccessCondition = EFlowControlSuccessCondition::Instant;
2930

3031
```
32+
3133
## Functions
3234
35+
No functions in this class
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
22
title: UFPTask_LoadLevel
3-
description: Reference page for UFPTask_LoadLevel class
3+
description: Reference page for UFPTask_LoadLevel
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_LoadLevel.h`
9+
910
## Properties
1011

1112
No properties in this class
13+
1214
## Functions
1315

16+
No functions in this class
+4-1
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
22
title: UFPTask_Loop
3-
description: Reference page for UFPTask_Loop class
3+
description: Reference page for UFPTask_Loop
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_Loop.h`
9+
910
## Properties
1011

1112
No properties in this class
13+
1214
## Functions
1315

16+
No functions in this class

src/content/docs/reference/FPTask_Parallel.mdx

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: UFPTask_Parallel
3-
description: Reference page for UFPTask_Parallel class
3+
description: Reference page for UFPTask_Parallel
44
---
55
import Ref from '../../../components/Ref.astro'
66
import LinkRef from '../../../components/LinkRef.astro'
@@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_parallel.png';
1010

1111
<Ref c="UFPTask_Parallel" p="UFlowPilotTask" />
1212

13-
### Description
13+
## Description
1414

1515
<Image src={schema} alt="UFPTask_Parallel Schema" />
1616

@@ -26,6 +26,7 @@ There are various _Completion types_ for this task:
2626
## Class Info
2727
- __Parent Class:__ `UFlowPilotParent`
2828
- __FileName:__ `FPTask_Parallel.h`
29+
2930
## Properties
3031

3132
```cpp
@@ -34,5 +35,7 @@ UPROPERTY(EditDefaultsOnly, Category="FlowPilot")
3435
EFlowParallelCompletionType DesiredCompletionType = EFlowParallelCompletionType::AllSucceed;
3536

3637
```
38+
3739
## Functions
3840
41+
No functions in this class
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
22
title: UFPTask_PlayAnimation
3-
description: Reference page for UFPTask_PlayAnimation class
3+
description: Reference page for UFPTask_PlayAnimation
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_PlayAnimation.h`
9+
910
## Properties
1011

1112
No properties in this class
13+
1214
## Functions
1315

16+
No functions in this class
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: UFPTask_PlaySound
3-
description: Reference page for UFPTask_PlaySound class
3+
description: Reference page for UFPTask_PlaySound
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_PlaySound.h`
9+
910
## Properties
1011

1112
```cpp
@@ -14,5 +15,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot")
1415
FFlowActorReference ActorReference;
1516

1617
```
18+
1719
## Functions
1820
21+
No functions in this class
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,16 @@
11
---
22
title: UFPTask_PlaySound2D
3-
description: Reference page for UFPTask_PlaySound2D class
3+
description: Reference page for UFPTask_PlaySound2D
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_PlaySound2D.h`
9+
910
## Properties
1011

1112
No properties in this class
13+
1214
## Functions
1315

16+
No functions in this class

src/content/docs/reference/FPTask_PossessPawn.mdx

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: UFPTask_PossessPawn
3-
description: Reference page for UFPTask_PossessPawn class
3+
description: Reference page for UFPTask_PossessPawn
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_PossessPawn.h`
9+
910
## Properties
1011

1112
```cpp
@@ -22,5 +23,7 @@ UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="!bPossessByPl
2223
TSubclassOf<AController> ControllerClass;
2324

2425
```
26+
2527
## Functions
2628
29+
No functions in this class

src/content/docs/reference/FPTask_Selector.mdx

+5-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: UFPTask_Selector
3-
description: Reference page for UFPTask_Selector class
3+
description: Reference page for UFPTask_Selector
44
---
55
import Ref from '../../../components/Ref.astro'
66
import LinkRef from '../../../components/LinkRef.astro'
@@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_selector.png';
1010

1111
<Ref c="UFPTask_Selector" p="UFlowPilotTask" />
1212

13-
### Description
13+
## Description
1414

1515
<Image src={schema} alt="UFPTask_Selector Schema" />
1616

@@ -26,8 +26,11 @@ If no task succeeded, then `UFPTask_Selector` will return failure.
2626
## Class Info
2727
- __Parent Class:__ `UFPTaskRunner`
2828
- __FileName:__ `FPTask_Selector.h`
29+
2930
## Properties
3031

3132
No properties in this class
33+
3234
## Functions
3335

36+
No functions in this class

src/content/docs/reference/FPTask_Sequence.mdx

+5-4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
title: UFPTask_Sequence
3-
description: Reference page for UFPTask_Sequence class
3+
description: Reference page for UFPTask_Sequence
44
---
55
import Ref from '../../../components/Ref.astro'
66
import LinkRef from '../../../components/LinkRef.astro'
@@ -10,7 +10,7 @@ import schema from '../../../assets/ufptask_sequence.png';
1010

1111
<Ref c="UFPTask_Sequence" p="UFlowPilotTask" />
1212

13-
### Description
13+
## Description
1414

1515
<Image src={schema} alt="UFPTask_Sequence Schema" />
1616

@@ -21,13 +21,14 @@ The schema above explains how it should work.
2121

2222
If one of the Tasks fail, `UFPTask_Sequence` will return failure.
2323

24-
25-
2624
## Class Info
2725
- __Parent Class:__ `UFPTaskRunner`
2826
- __FileName:__ `FPTask_Sequence.h`
27+
2928
## Properties
3029

3130
No properties in this class
31+
3232
## Functions
3333

34+
No functions in this class

src/content/docs/reference/FPTask_SpawnClass.mdx

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: UFPTask_SpawnClass
3-
description: Reference page for UFPTask_SpawnClass class
3+
description: Reference page for UFPTask_SpawnClass
44
---
55

66
## Class Info
77
- __Parent Class:__ `UFlowPilotTask`
88
- __FileName:__ `FPTask_SpawnClass.h`
9+
910
## Properties
1011

1112
```cpp
@@ -34,5 +35,7 @@ UPROPERTY(EditAnywhere, Category = "FlowPilot")
3435
ESpawnActorCollisionHandlingMethod SpawnCollisionMethods = ESpawnActorCollisionHandlingMethod::AdjustIfPossibleButAlwaysSpawn;
3536

3637
```
38+
3739
## Functions
3840
41+
No functions in this class

0 commit comments

Comments
 (0)