Skip to content

Commit 48481ed

Browse files
Mikea15Mikea15
committed
update docs
1 parent 590b05f commit 48481ed

28 files changed

+176
-210
lines changed

‎src/content/docs/reference/FPTagActorComponent.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ __FileName:__ `FPTagActorComponent.h`
1616
__Parent Classes:__
1717
[ `UActorComponent` ]
1818

19-
\
19+
2020
Helper Component to add Tags to Actor.

‎src/content/docs/reference/FPTaskRunner.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ __FileName:__ `FPTaskRunner.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotParent` ]
1818

19-
\
19+
2020
Task Runner is the Base Class for Sequences and Selectors

‎src/content/docs/reference/FPTask_BlueprintBase.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@ __FileName:__ `FPTask_BlueprintBase.h`
1313
## `UFPTask_BlueprintBase`
1414

1515

16-
\
17-
Blueprint Base Task \
16+
17+
Blueprint Base Task
1818
- Inherit from Blueprints to have custom BP Tasks.
1919

2020
### Functions

‎src/content/docs/reference/FPTask_Delay.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ __FileName:__ `FPTask_Delay.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
19+
2020
Delays Execution
2121

2222
### Properties

‎src/content/docs/reference/FPTask_DestroyActor.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ __FileName:__ `FPTask_DestroyActor.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
19+
2020
Destroys Actors
2121

2222
### Properties

‎src/content/docs/reference/FPTask_FlowAsset.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,6 @@ __FileName:__ `FPTask_FlowAsset.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
20-
FPTask_FlowAsset \
19+
20+
FPTask_FlowAsset
2121
- Loads and Runs another FlowDataAsset

‎src/content/docs/reference/FPTask_FlowPilotControl.mdx

+18-14
Original file line numberDiff line numberDiff line change
@@ -6,28 +6,32 @@ description: Reference page for FPTask_FlowPilotControl.h
66
## File Info
77

88
__FileName:__ `FPTask_FlowPilotControl.h`
9+
- __Enum List:__
10+
[ [`EFlowPilotControlType`](#eflowpilotcontroltype) | [`EFlowControlSuccessCondition`](#eflowcontrolsuccesscondition) ]
911
- __Class List:__
1012
[ [`UFPTask_FlowPilotControl`](#ufptask_flowpilotcontrol) ]
11-
- __Enum List:__
12-
[ [`EFlowControlSuccessCondition`](#eflowcontrolsuccesscondition) ]
1313

1414

15-
## `EFlowControlSuccessCondition`
15+
### `EFlowPilotControlType`
1616

1717

18-
### Properties
18+
| Value | Description |
19+
| :-- | :-- |
20+
| `StartFlow UMETA(DisplayName="Start / Resume Flow")` | StartFlow UMETA(DisplayName="Start / Resume Flow") |
21+
| `PauseFlow UMETA(DisplayName="Pause Flow")` | PauseFlow UMETA(DisplayName="Pause Flow") |
22+
| `StopFlow UMETA(DisplayName="Stops Flow")` | StopFlow UMETA(DisplayName="Stops Flow") |
1923

20-
```cpp
21-
// Will succeed instantly after Request
22-
Instant,
2324

24-
// Will succeed when Flow has Started and is in Progress
25-
WaitForFlowStart,
2625

27-
// Will succeed when Flow has Started, and is Complete
28-
WaitForFlowComplete
26+
### `EFlowControlSuccessCondition`
27+
28+
29+
| Value | Description |
30+
| :-- | :-- |
31+
| `Instant` | Will succeed instantly after Request |
32+
| `WaitForFlowStart` | Will succeed when Flow has Started and is in Progress |
33+
| `WaitForFlowComplete` | Will succeed when Flow has Started, and is Complete |
2934

30-
```
3135

3236

3337
## `UFPTask_FlowPilotControl`
@@ -36,8 +40,8 @@ WaitForFlowComplete
3640
__Parent Classes:__
3741
[ `UFlowPilotTask` ]
3842

39-
\
40-
FlowPilot Control \
43+
44+
FlowPilot Control
4145
- Starts, Pauses, Stops a FlowPilot Component's execution
4246

4347
### Properties

‎src/content/docs/reference/FPTask_LoadLevel.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ __FileName:__ `FPTask_LoadLevel.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
19+
2020
Load Level Task

‎src/content/docs/reference/FPTask_Loop.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ __FileName:__ `FPTask_Loop.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
19+
2020
Executes a Task in a Loop

‎src/content/docs/reference/FPTask_Parallel.mdx

+12-21
Original file line numberDiff line numberDiff line change
@@ -6,31 +6,22 @@ description: Reference page for FPTask_Parallel.h
66
## File Info
77

88
__FileName:__ `FPTask_Parallel.h`
9-
- __Class List:__
10-
[ [`UFPTask_Parallel`](#ufptask_parallel) ]
119
- __Enum List:__
1210
[ [`EFlowParallelCompletionType`](#eflowparallelcompletiontype) ]
11+
- __Class List:__
12+
[ [`UFPTask_Parallel`](#ufptask_parallel) ]
1313

1414

15-
## `EFlowParallelCompletionType`
16-
17-
18-
### Properties
19-
20-
```cpp
21-
// Succeed when one child Succeeds
22-
AnySucceed,
23-
24-
// Succeed when all child Succeed
25-
AllSucceed,
15+
### `EFlowParallelCompletionType`
2616

27-
// Succeed when one child Fails
28-
AnyFail,
2917

30-
// Succeed when all child Fail
31-
AllFail
18+
| Value | Description |
19+
| :-- | :-- |
20+
| `AnySucceed` | Succeed when one child Succeeds |
21+
| `AllSucceed` | Succeed when all child Succeed |
22+
| `AnyFail` | Succeed when one child Fails |
23+
| `AllFail` | Succeed when all child Fail |
3224

33-
```
3425

3526

3627
## `UFPTask_Parallel`
@@ -39,9 +30,9 @@ AllFail
3930
__Parent Classes:__
4031
[ `UFlowPilotParent` ]
4132

42-
\
43-
Parallel Task \
44-
- Run multiple Tasks in the same tick function. \
33+
34+
Parallel Task
35+
- Run multiple Tasks in the same tick function.
4536
- They are run one by one, so not 'really' parallel.
4637

4738
### Properties

‎src/content/docs/reference/FPTask_PlayAnimation.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ description: Reference page for FPTask_PlayAnimation.h
66
## File Info
77

88
__FileName:__ `FPTask_PlayAnimation.h`
9-
- __Class List:__
10-
[ [`UFPTask_PlayAnimation`](#ufptask_playanimation) ]
119
- __Struct List:__
1210
[ ]
11+
- __Class List:__
12+
[ [`UFPTask_PlayAnimation`](#ufptask_playanimation) ]
1313

1414

1515
## `UFPTask_PlayAnimation`
@@ -18,5 +18,5 @@ __FileName:__ `FPTask_PlayAnimation.h`
1818
__Parent Classes:__
1919
[ `UFlowPilotTask` ]
2020

21-
\
21+
2222

‎src/content/docs/reference/FPTask_PlaySound.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ __FileName:__ `FPTask_PlaySound.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
19+
2020
Plays SoundCues or SoundWaves
2121

2222
### Properties

‎src/content/docs/reference/FPTask_PlaySound2D.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ __FileName:__ `FPTask_PlaySound2D.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
19+
2020
Play 2D Sounds

‎src/content/docs/reference/FPTask_PossessPawn.mdx

+13-6
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,30 @@ __FileName:__ `FPTask_PossessPawn.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
20-
Possess Pawn \
21-
- Spawns a Controller and Possesses a Pawn \
22-
- Can Posses multiple Pawns at the same time
19+
20+
Posses Pawn:
21+
- Spawns a Controller and Possesses a Pawn
22+
- Can Possess multiple Pawns at the same time using a shared GameplayTag 🏷️
2323

2424
### Properties
2525

2626
```cpp
2727
// Pawns to Possess
28+
// if possessed by Player, will only search for 1 Pawn.
29+
// if possessed by AI Controller, will search for multiple Pawns.
2830
UPROPERTY(EditAnywhere, Category="FlowPilot")
2931
FFlowActorReference PawnsToPossess;
3032

31-
// Player Possesses only 1 Pawn
33+
// If true, the Player will posses the Pawn
3234
UPROPERTY(EditAnywhere, Category="FlowPilot")
3335
bool bPossessByPlayer = false;
3436

35-
// AI Controller Class to Posses Pawns with.
37+
// Player Controller Index, in single player games this is usually 0.
38+
// for more complex cases, this could be parameterized
39+
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="bPossessByPlayer", EditConditionHides))
40+
int32 PlayerIndex = 0;
41+
42+
// AI Controller class to posses Pawn with
3643
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="!bPossessByPlayer", EditConditionHides))
3744
TSubclassOf<AController> ControllerClass;
3845

‎src/content/docs/reference/FPTask_Selector.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ __FileName:__ `FPTask_Selector.h`
1616
__Parent Classes:__
1717
[ `UFPTaskRunner` ]
1818

19-
\
20-
Selector Task \
21-
- Run one FlowPilotTask after another \
19+
20+
Selector Task
21+
- Run one FlowPilotTask after another
2222
- Stops execution when one Task succeeds

‎src/content/docs/reference/FPTask_Sequence.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ __FileName:__ `FPTask_Sequence.h`
1616
__Parent Classes:__
1717
[ `UFPTaskRunner` ]
1818

19-
\
20-
Sequence Task \
21-
- Run one FlowPilotTask after another \
19+
20+
Sequence Task
21+
- Run one FlowPilotTask after another
2222
- Stops execution when one Task fails.

‎src/content/docs/reference/FPTask_SpawnClass.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ __FileName:__ `FPTask_SpawnClass.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
19+
2020
Spawns a Class
2121

2222
### Properties

‎src/content/docs/reference/FPTask_TriggerDistance.mdx

+25-3
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,32 @@ description: Reference page for FPTask_TriggerDistance.h
66
## File Info
77

88
__FileName:__ `FPTask_TriggerDistance.h`
9+
- __Enum List:__
10+
[ [`ETriggerDistanceOp`](#etriggerdistanceop) | [`EDistanceMethod`](#edistancemethod) ]
911
- __Class List:__
1012
[ [`UFPTask_TriggerDistance`](#ufptask_triggerdistance) ]
11-
- __Enum List:__
12-
[ ]
13+
14+
15+
### `ETriggerDistanceOp`
16+
17+
18+
| Value | Description |
19+
| :-- | :-- |
20+
| `LessThan` | LessThan |
21+
| `LessThanOrEqual` | LessThanOrEqual |
22+
| `GreaterThan` | GreaterThan |
23+
| `GreaterThanOrEqual` | GreaterThanOrEqual |
24+
25+
26+
27+
### `EDistanceMethod`
28+
29+
30+
| Value | Description |
31+
| :-- | :-- |
32+
| `Distance3D` | Distance3D |
33+
| `Distance2D` | Distance2D |
34+
1335

1436

1537
## `UFPTask_TriggerDistance`
@@ -18,7 +40,7 @@ __FileName:__ `FPTask_TriggerDistance.h`
1840
__Parent Classes:__
1941
[ `UFlowPilotTask` ]
2042

21-
\
43+
2244
Trigger by Distance
2345

2446
### Properties

‎src/content/docs/reference/FPTask_TriggerVolume.mdx

+18-6
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,20 @@ description: Reference page for FPTask_TriggerVolume.h
66
## File Info
77

88
__FileName:__ `FPTask_TriggerVolume.h`
9+
- __Enum List:__
10+
[ [`ETriggerVolumeEvent`](#etriggervolumeevent) ]
911
- __Class List:__
1012
[ [`UFPTask_TriggerVolume`](#ufptask_triggervolume) ]
11-
- __Enum List:__
12-
[ ]
13+
14+
15+
### `ETriggerVolumeEvent`
16+
17+
18+
| Value | Description |
19+
| :-- | :-- |
20+
| `OnEnter` | Triggers when Entering Volume |
21+
| `OnExit` | Triggers when Exiting Volume |
22+
1323

1424

1525
## `UFPTask_TriggerVolume`
@@ -18,17 +28,19 @@ __FileName:__ `FPTask_TriggerVolume.h`
1828
__Parent Classes:__
1929
[ `UFlowPilotTask` ]
2030

21-
\
22-
Trigger by Volume
31+
32+
Trigger by Volume Task
33+
- Allows choosing to Trigger (succeed task) on Entry or Exit of a volume
34+
- Allows to wait on multiple Pawns
2335

2436
### Properties
2537

2638
```cpp
27-
// Trigger to Listen to
39+
// Trigger Event to Listen to
2840
UPROPERTY(EditAnywhere, Category = "FlowPilot")
2941
ETriggerVolumeEvent TriggerEvent;
3042

31-
// Volume Reference Actor
43+
// Volume Reference Actor. Should be single actor
3244
UPROPERTY(EditAnywhere, Category = "FlowPilot")
3345
FFlowActorReference VolumeReference;
3446

‎src/content/docs/reference/FPTask_UnloadStreamedLevel.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ __FileName:__ `FPTask_UnloadStreamedLevel.h`
1616
__Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

19-
\
19+
2020
Unloads Streamed Level
2121

2222
### Properties

‎src/content/docs/reference/FlowActorReference.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ __FileName:__ `FlowActorReference.h`
1313
## `FFlowActorReference`
1414

1515

16-
\
16+
1717
FFlowActorReference
1818

1919
### Properties

‎src/content/docs/reference/FlowPilot.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ __FileName:__ `FlowPilot.h`
1616
__Parent Classes:__
1717
[ `UDataAsset` ]
1818

19-
\
19+
2020
FlowPilot Data
2121

2222
### Properties

0 commit comments

Comments
 (0)