Skip to content

Commit 1adc232

Browse files
committed
update docs
1 parent 0c5c2b7 commit 1adc232

10 files changed

+52
-47
lines changed

src/content/docs/reference/FPTask_BlueprintBase.mdx

+6-5
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ __FileName:__ `FPTask_BlueprintBase.h`
1414

1515

1616

17-
Blueprint Base Task
18-
- Inherit from Blueprints to have custom BP Tasks.
17+
Create Blueprint Tasks using this class as base.
18+
- If Tick is not implemented, will instantly succeed on first tick.
1919

2020
### Functions
2121

@@ -26,17 +26,18 @@ Blueprint Base Task
2626
void ReceiveSetup();
2727
```
2828
#### `ReceiveEnter`
29-
> Implement enter Task
29+
> Implement Enter Task
3030
```cpp
3131
bool ReceiveEnter();
3232
```
3333
#### `ReceiveTick`
34-
> Implement tick Task
34+
> Implement Tick Task \
35+
> auto succeeds if not implemented in Blueprint Task
3536
```cpp
3637
EFPTaskResult ReceiveTick(float DeltaTime);
3738
```
3839
#### `ReceiveExit`
39-
> Implement exit Task
40+
> Implement Exit Task
4041
```cpp
4142
void ReceiveExit(EFPTaskResult TaskResult);
4243
```

src/content/docs/reference/FPTask_Delay.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ __Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

1919

20-
Delays Execution
20+
Simple task that adds a delay to the execution flow
2121

2222
### Properties
2323

src/content/docs/reference/FPTask_Loop.mdx

+18-1
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,21 @@ __Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

1919

20-
Executes a Task in a Loop
20+
Loops a Task's execution for X amount of times, or infinite
21+
22+
### Properties
23+
24+
```cpp
25+
// Task to loop
26+
UPROPERTY(EditDefaultsOnly, Instanced, Category = "FlowPilot")
27+
TObjectPtr<UFlowPilotTask> Task;
28+
29+
// Will forever loop if True
30+
UPROPERTY(EditDefaultsOnly, Category = "FlowPilot")
31+
uint8 bIsInfinite : 1;
32+
33+
// Number of times to repeat the same task
34+
UPROPERTY(EditDefaultsOnly, Category = "FlowPilot", meta=(ClampMin=1, EditCondition="!bIsInfinite"))
35+
int32 Loops = 3;
36+
37+
```

src/content/docs/reference/FPTask_PlayAnimation.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,26 @@ __Parent Classes:__
1919
[ `UFlowPilotTask` ]
2020

2121

22-
Play Animation
23-
- Can Play an animation on many Pawns
24-
- Can wait for animations to finish to continue
22+
Task that plays an animation
23+
- Will play the animation to one or multiple Pawns found via FlowActorReference
24+
- Option to wait for animations to complete before succeeding
2525

2626
### Properties
2727

2828
```cpp
29-
// Actors this animation asset will be played on
29+
// Pawns to play animations on
3030
UPROPERTY(EditAnywhere, Category="FlowPilot")
3131
FFlowActorReference ActorsToPlayAnimationOn;
3232

33-
// Animation Asset to use
33+
// Animation Asset to play
3434
UPROPERTY(EditAnywhere, Category="FlowPilot")
3535
TSoftObjectPtr<UAnimationAsset> AnimationAsset;
3636

37-
// Loop animation if true
37+
// if true, will loop animations
3838
UPROPERTY(EditAnywhere, Category="FlowPilot")
3939
uint8 bLooping : 1;
4040

41-
// Waits for animation to complete to continue execution
41+
// if true, will wait for animation to finish before succeeding task
4242
UPROPERTY(EditAnywhere, Category="FlowPilot")
4343
uint8 bWaitForAnimationEnd : 1;
4444

src/content/docs/reference/FPTask_PlaySound.mdx

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ Plays SoundCues or SoundWaves
2222
### Properties
2323

2424
```cpp
25-
// Where to play sound from.
25+
// Actor Reference to use as source location
2626
UPROPERTY(EditAnywhere, Category = "FlowPilot")
2727
FFlowActorReference ActorReference;
2828

29-
// SoundCue to Play
29+
// Sound Cue to play
3030
UPROPERTY(EditAnywhere, Category="FlowPilot")
3131
TObjectPtr<USoundCue> SoundToPlay;
3232

33-
// SoundWave to Play
33+
// Sound Wave to play
3434
UPROPERTY(EditAnywhere, Category="FlowPilot")
3535
TObjectPtr<USoundWave> SoundWaveToPlay;
3636

src/content/docs/reference/FPTask_PlaySound2D.mdx

+7-7
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,15 @@ Play 2D Sounds
2222
### Properties
2323

2424
```cpp
25-
// SoundCue to play
25+
// Sound Cue to Play
2626
UPROPERTY(EditAnywhere, Category="FlowPilot")
2727
TObjectPtr<USoundCue> SoundToPlay;
2828

29-
// SoundWave to play
29+
// Sound Wave to Play
3030
UPROPERTY(EditAnywhere, Category="FlowPilot")
3131
TObjectPtr<USoundWave> SoundWaveToPlay;
3232

33-
// Is UI Sound
33+
// if true, will play as UI sound
3434
UPROPERTY(EditAnywhere, Category="FlowPilot")
3535
uint8 bIsUISound : 1;
3636

@@ -42,19 +42,19 @@ float VolumeMultiplier = 1.0f;
4242
UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
4343
float PitchMultiplier = 1.0f;
4444

45-
// Play Start time
45+
// Play Start Time
4646
UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
4747
float StartTime = 0.0f;
4848

49-
// Concurrency Settings
49+
// Sound Concurrency Settings
5050
UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
5151
USoundConcurrency* ConcurrencySettings = nullptr;
5252

53-
// If the Sound persists across level changes
53+
// if True, sound will persist across level changes
5454
UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
5555
bool bPersistAcrossLevels = false;
5656

57-
// Automatically destroy sound when finished playing
57+
// if true, sound actor will auto destroy once finished playing
5858
UPROPERTY(EditAnywhere, Category="FlowPilot", AdvancedDisplay)
5959
bool bAutoDestroy = true;
6060

src/content/docs/reference/FPTask_PossessPawn.mdx

+4-11
Original file line numberDiff line numberDiff line change
@@ -17,29 +17,22 @@ __Parent Classes:__
1717
[ `UFlowPilotTask` ]
1818

1919

20-
Posses Pawn:
20+
Possess Pawn
2121
- Spawns a Controller and Possesses a Pawn
22-
- Can Possess multiple Pawns at the same time using a shared GameplayTag 🏷️
22+
- Can Possess multiple Pawns at the same time
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.
3028
UPROPERTY(EditAnywhere, Category="FlowPilot")
3129
FFlowActorReference PawnsToPossess;
3230

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

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
35+
// AI Controller Class to Posses Pawns with.
4336
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="!bPossessByPlayer", EditConditionHides))
4437
TSubclassOf<AController> ControllerClass;
4538

src/content/docs/reference/FPTask_SpawnClass.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Spawns a Class
2222
### Properties
2323

2424
```cpp
25-
// Spawn Lifetime dictates when we Destroy this Actor or leave it alive forever
25+
// SpawnLifetime dictates when we Destroy this Actor, (or leave it alive forever)
2626
UPROPERTY(EditAnywhere, Category = "FlowPilot")
2727
EFlowActorSpawnLifetime ActorSpawnLifetime = EFlowActorSpawnLifetime::Persistent;
2828

src/content/docs/reference/FPTask_TriggerDistance.mdx

-4
Original file line numberDiff line numberDiff line change
@@ -54,10 +54,6 @@ FFlowActorReference FirstActorReference;
5454
UPROPERTY(EditAnywhere, Category = "FlowPilot")
5555
ETriggerDistanceOp Operation = ETriggerDistanceOp::LessThan;
5656

57-
// Distance Method
58-
UPROPERTY(EditAnywhere, Category = "FlowPilot")
59-
EDistanceMethod Method = EDistanceMethod::Distance3D;
60-
6157
// Threshold to check distance against
6258
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f))
6359
float ThresholdDistance;

src/content/docs/reference/FPTask_TriggerVolume.mdx

+5-7
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ __FileName:__ `FPTask_TriggerVolume.h`
1717

1818
| Value | Description |
1919
| :-- | :-- |
20-
| `OnEnter` | Triggers when Entering Volume |
21-
| `OnExit` | Triggers when Exiting Volume |
20+
| `OnEnter` | OnEnter |
21+
| `OnExit` | OnExit |
2222

2323

2424

@@ -29,18 +29,16 @@ __Parent Classes:__
2929
[ `UFlowPilotTask` ]
3030

3131

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
32+
Trigger by Volume
3533

3634
### Properties
3735

3836
```cpp
39-
// Trigger Event to Listen to
37+
// Trigger to Listen to
4038
UPROPERTY(EditAnywhere, Category = "FlowPilot")
4139
ETriggerVolumeEvent TriggerEvent;
4240

43-
// Volume Reference Actor. Should be single actor
41+
// Volume Reference Actor
4442
UPROPERTY(EditAnywhere, Category = "FlowPilot")
4543
FFlowActorReference VolumeReference;
4644

0 commit comments

Comments
 (0)