Skip to content

Commit 8833e0e

Browse files
Mikea15Mikea15
committed
update reference
1 parent 22abe66 commit 8833e0e

13 files changed

+136
-42
lines changed

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

+7-7
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ description: Reference page for FPTask_FlowPilotControl.h
77

88
__FileName:__ `FPTask_FlowPilotControl.h`
99
- __Enum List:__
10-
[ [`EFlowPilotControlType`](#eflowpilotcontroltype) | [`EFlowControlSuccessCondition`](#eflowcontrolsuccesscondition) ]
10+
[ [`EFPControlType`](#efpcontroltype) | [`EFPControlSuccessCondition`](#efpcontrolsuccesscondition) ]
1111
- __Class List:__
1212
[ [`UFPTask_FlowPilotControl`](#ufptask_flowpilotcontrol) ]
1313

1414

15-
### `EFlowPilotControlType`
15+
### `EFPControlType`
1616

1717

1818
| Value | Description |
@@ -23,7 +23,7 @@ __FileName:__ `FPTask_FlowPilotControl.h`
2323

2424

2525

26-
### `EFlowControlSuccessCondition`
26+
### `EFPControlSuccessCondition`
2727

2828

2929
| Value | Description |
@@ -53,16 +53,16 @@ FFlowActorReference ActorReference;
5353

5454
// Flow Control Type
5555
UPROPERTY(EditAnywhere, Category = "FlowPilot")
56-
EFlowPilotControlType ControlType = EFlowPilotControlType::StartFlow;
56+
EFPControlType ControlType = EFPControlType::StartFlow;
5757

5858
// Flow Stop Type
59-
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType==EFlowPilotControlType::StopFlow", EditConditionHides))
59+
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType==EFPControlType::StopFlow", EditConditionHides))
6060
EFPStopType StopType = EFPStopType::CancelExecution;
6161

6262
// When starting a new FlowPilot, what's this Task's success condition?
6363
// Essentially, we can Succeed instantly, or wait for InProgress or Stopped/Complete execution of the
6464
// Controlled FlowPilot Component we're controlling.
65-
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType==EFlowPilotControlType::StartFlow", EditConditionHides))
66-
EFlowControlSuccessCondition SuccessCondition = EFlowControlSuccessCondition::Instant;
65+
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType==EFPControlType::StartFlow", EditConditionHides))
66+
EFPControlSuccessCondition SuccessCondition = EFPControlSuccessCondition::Instant;
6767

6868
```

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

+9-10
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,14 @@ description: Reference page for FPTask_InsideVolume.h
55

66
## File Info
77

8-
98
__FileName:__ `FPTask_InsideVolume.h`
109
- __Enum List:__
11-
[ [`EInsideVolumeFilterType`](#einsidevolumefiltertype) | [`EInsideVolumeComparisonOp`](#einsidevolumecomparisonop) ]
10+
[ [`EFPInsideVolumeFilterType`](#efpinsidevolumefiltertype) | [`EFPInsideVolumeComparisonOp`](#efpinsidevolumecomparisonop) ]
1211
- __Class List:__
1312
[ [`UFPTask_InsideVolume`](#ufptask_insidevolume) ]
1413

1514

16-
### `EInsideVolumeFilterType`
15+
### `EFPInsideVolumeFilterType`
1716

1817

1918
| Value | Description |
@@ -23,7 +22,7 @@ __FileName:__ `FPTask_InsideVolume.h`
2322

2423

2524

26-
### `EInsideVolumeComparisonOp`
25+
### `EFPInsideVolumeComparisonOp`
2726

2827

2928
| Value | Description |
@@ -57,22 +56,22 @@ FFlowActorReference VolumeActorReference;
5756

5857
// Actor Filter Type
5958
UPROPERTY(EditAnywhere, Category="FlowPilot")
60-
EInsideVolumeFilterType FilterActorType = EInsideVolumeFilterType::ByActor;
59+
EFPInsideVolumeFilterType FilterActorType = EFPInsideVolumeFilterType::ByActor;
6160

6261
// Actor Type Reference
63-
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EInsideVolumeFilterType::ByActor"))
62+
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EFPInsideVolumeFilterType::ByActor"))
6463
FFlowActorReference ActorTypeReference;
6564

6665
// Class Type Reference
67-
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EInsideVolumeFilterType::ByClass"))
66+
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EFPInsideVolumeFilterType::ByClass"))
6867
TSoftClassPtr<AActor> ClassType;
6968

7069
// Comparison Operation for Actors Requires Inside Volume
71-
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EInsideVolumeFilterType::ByClass"))
72-
EInsideVolumeComparisonOp ComparisonOperation = EInsideVolumeComparisonOp::Equal;
70+
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EFPInsideVolumeFilterType::ByClass"))
71+
EFPInsideVolumeComparisonOp ComparisonOperation = EFPInsideVolumeComparisonOp::Equal;
7372

7473
// How many Actors required inside volume
75-
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EInsideVolumeFilterType::ByClass"))
74+
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(EditCondition="FilterActorType==EFPInsideVolumeFilterType::ByClass"))
7675
int32 RequiredActorsCount = 1;
7776

7877
```

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

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

1919

20-
Load Level Task
20+
Load Level
21+
- Tasks that loads a level, streamed in or not.
22+
23+
### Properties
24+
25+
```cpp
26+
// Level to load
27+
UPROPERTY(EditAnywhere, Category = "FlowPilot")
28+
TSoftObjectPtr<UWorld> Level;
29+
30+
// Streams level if true
31+
UPROPERTY(EditAnywhere, Category = "FlowPilot")
32+
uint8 bStreamLevel : 1;
33+
34+
// Blocks main thread when loading
35+
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="bStreamLevel"))
36+
uint8 bBlockOnLoad : 1;
37+
38+
// Makes visible after loading if true
39+
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="bStreamLevel"))
40+
uint8 bMakeVisibleAfterLoad : 1;
41+
42+
// if true, options are reset.
43+
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="!bStreamLevel"))
44+
uint8 bAbsolute : 1;
45+
46+
// Load level options
47+
UPROPERTY(EditAnywhere, Category = "FlowPilot")
48+
FString OpenOptions;
49+
50+
```

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ description: Reference page for FPTask_Parallel.h
77

88
__FileName:__ `FPTask_Parallel.h`
99
- __Enum List:__
10-
[ [`EFlowParallelCompletionType`](#eflowparallelcompletiontype) ]
10+
[ [`EFPParallelCompletionType`](#efpparallelcompletiontype) ]
1111
- __Class List:__
1212
[ [`UFPTask_Parallel`](#ufptask_parallel) ]
1313

1414

15-
### `EFlowParallelCompletionType`
15+
### `EFPParallelCompletionType`
1616

1717

1818
| Value | Description |
@@ -41,6 +41,6 @@ Parallel Task
4141
// Desired Completion Type allows changing the Parallel Task Behavior
4242
// See EFlowParallelCompletetionType enum
4343
UPROPERTY(EditDefaultsOnly, Category="FlowPilot")
44-
EFlowParallelCompletionType DesiredCompletionType = EFlowParallelCompletionType::AllSucceed;
44+
EFPParallelCompletionType DesiredCompletionType = EFPParallelCompletionType::AllSucceed;
4545

4646
```

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

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
---
2+
title: FPTask_ScreenFade.h
3+
description: Reference page for FPTask_ScreenFade.h
4+
---
5+
6+
## File Info
7+
8+
__FileName:__ `FPTask_ScreenFade.h`
9+
- __Enum List:__
10+
[ [`EFPFadeType`](#efpfadetype) ]
11+
- __Class List:__
12+
[ [`UFPTask_ScreenFade`](#ufptask_screenfade) ]
13+
14+
15+
### `EFPFadeType`
16+
17+
18+
| Value | Description |
19+
| :-- | :-- |
20+
| `FadeIn` | Fade From Transparency to Color |
21+
| `FadeOut` | Fade From Color to Transparency |
22+
23+
24+
25+
## `UFPTask_ScreenFade`
26+
27+
28+
__Parent Classes:__
29+
[ `UFlowPilotTask` ]
30+
31+
32+
ScreenFade.
33+
- Allows Starting at a particular screen color
34+
- Allows Fading towards another color over time
35+
- Allows Fading Audio in Sync
36+
- Options to keep Fade at the end of the transition
37+
38+
### Properties
39+
40+
```cpp
41+
// Player camera index, usually 0 for first/single player
42+
UPROPERTY(EditAnywhere, Category="FlowPilot")
43+
uint8 PlayerCameraIndex = 0;
44+
45+
// FadeType controls if you want to go from Transparent to Color (FadeIn), or inverse (FadeOut)
46+
UPROPERTY(EditAnywhere, Category="FlowPilot")
47+
EFPFadeType FadeType = EFPFadeType::FadeIn;
48+
49+
// Color to Fade Screen/Camera to.
50+
UPROPERTY(EditAnywhere, Category="FlowPilot")
51+
FLinearColor FadeColor = FLinearColor::Black;
52+
53+
// Fade Duration
54+
UPROPERTY(EditAnywhere, Category="FlowPilot", meta=(ForceUnits="s"))
55+
float FadeDuration = 1.0f;
56+
57+
// Option to sync audio with the fade
58+
UPROPERTY(EditAnywhere, Category="FlowPilot")
59+
bool bSyncAudioFade = true;
60+
61+
// Option to hold the fade when complete (true) or reset (false)
62+
UPROPERTY(EditAnywhere, Category="FlowPilot")
63+
bool bHoldFadeWhenComplete = true;
64+
65+
```

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Generic Spawn Class Task
3838
```cpp
3939
// SpawnLifetime dictates when we Destroy this Actor, (or leave it alive forever)
4040
UPROPERTY(EditAnywhere, Category = "FlowPilot")
41-
EFlowActorSpawnLifetime ActorSpawnLifetime = EFlowActorSpawnLifetime::Persistent;
41+
EFPSpawnLifetime ActorSpawnLifetime = EFPSpawnLifetime::Persistent;
4242

4343
// UClass to Spawn
4444
UPROPERTY(EditAnywhere, Category = "FlowPilot")

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

-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@ description: Reference page for FPTask_SubFlow.h
55

66
## File Info
77

8-
98
__FileName:__ `FPTask_SubFlow.h`
109
- __Class List:__
1110
[ [`UFPTask_SubFlow`](#ufptask_subflow) ]

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ description: Reference page for FPTask_TriggerDistance.h
77

88
__FileName:__ `FPTask_TriggerDistance.h`
99
- __Enum List:__
10-
[ [`EDistanceComparisonOp`](#edistancecomparisonop) | [`EDistanceMethod`](#edistancemethod) ]
10+
[ [`EFPDistanceComparisonOp`](#efpdistancecomparisonop) | [`EFPDistanceMethod`](#efpdistancemethod) ]
1111
- __Class List:__
1212
[ [`UFPTask_TriggerDistance`](#ufptask_triggerdistance) ]
1313

1414

15-
### `EDistanceComparisonOp`
15+
### `EFPDistanceComparisonOp`
1616

1717

1818
| Value | Description |
@@ -24,7 +24,7 @@ __FileName:__ `FPTask_TriggerDistance.h`
2424

2525

2626

27-
### `EDistanceMethod`
27+
### `EFPDistanceMethod`
2828

2929

3030
| Value | Description |
@@ -54,11 +54,11 @@ FFlowActorReference SourceActorReference;
5454

5555
// Distance Comparison Operation
5656
UPROPERTY(EditAnywhere, Category = "FlowPilot")
57-
EDistanceComparisonOp Operation = EDistanceComparisonOp::LessThan;
57+
EFPDistanceComparisonOp Operation = EFPDistanceComparisonOp::LessThan;
5858

5959
// Distance method to use.
6060
UPROPERTY(EditAnywhere, Category = "FlowPilot")
61-
EDistanceMethod Method = EDistanceMethod::Distance3D;
61+
EFPDistanceMethod Method = EFPDistanceMethod::Distance3D;
6262

6363
// Threshold to check distance against
6464
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f))

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ description: Reference page for FPTask_TriggerVolume.h
77

88
__FileName:__ `FPTask_TriggerVolume.h`
99
- __Enum List:__
10-
[ [`ETriggerVolumeEvent`](#etriggervolumeevent) ]
10+
[ [`EFPTriggerVolumeEvent`](#efptriggervolumeevent) ]
1111
- __Class List:__
1212
[ [`UFPTask_TriggerVolume`](#ufptask_triggervolume) ]
1313

1414

15-
### `ETriggerVolumeEvent`
15+
### `EFPTriggerVolumeEvent`
1616

1717

1818
| Value | Description |
@@ -36,7 +36,7 @@ Trigger by Volume
3636
```cpp
3737
// Trigger to Listen to
3838
UPROPERTY(EditAnywhere, Category = "FlowPilot")
39-
ETriggerVolumeEvent TriggerEvent;
39+
EFPTriggerVolumeEvent TriggerEvent;
4040

4141
// Volume Reference Actor
4242
UPROPERTY(EditAnywhere, Category = "FlowPilot")

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

+3-3
Original file line numberDiff line numberDiff line change
@@ -22,14 +22,14 @@ FFlowActorReference
2222
// What's the scope of the Subject Actor
2323
// (Self, In Level or Runtime)
2424
UPROPERTY(EditAnywhere, Category = "Actor Reference")
25-
EFlowActorScope Scope = EFlowActorScope::Self;
25+
EFPActorScope Scope = EFPActorScope::Self;
2626

2727
// Level Actor Reference
28-
UPROPERTY(EditAnywhere, Category = "Actor Reference", meta=(EditCondition="Scope==EFlowActorScope::InLevel", EditConditionHides))
28+
UPROPERTY(EditAnywhere, Category = "Actor Reference", meta=(EditCondition="Scope==EFPActorScope::InLevel", EditConditionHides))
2929
TSoftObjectPtr<AActor> LevelActor;
3030

3131
// Runtime Actor, found via Gameplay Tag.
32-
UPROPERTY(EditAnywhere, Category = "Actor Reference", meta=(EditCondition="Scope==EFlowActorScope::Runtime", EditConditionHides))
32+
UPROPERTY(EditAnywhere, Category = "Actor Reference", meta=(EditCondition="Scope==EFPActorScope::Runtime", EditConditionHides))
3333
FGameplayTag ExternalActorTag;
3434

3535
```

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -52,10 +52,10 @@ TObjectPtr<UFlowPilot> FlowPilotAsset;
5252

5353
// Overrides FlowPilotAsset with ExecutionMode
5454
UPROPERTY(EditAnywhere, Category=FlowPilot)
55-
EFlowMode ExecutionMode = EFlowMode::RunOnce;
55+
EFPExecutionMode ExecutionMode = EFPExecutionMode::RunOnce;
5656

5757
// Execution Mode retry delay
58-
UPROPERTY(EditAnywhere, Category=FlowPilot, meta=(ClampMin="0.0", EditCondition="ExecutionMode != EFlowMode::RunOnce"))
58+
UPROPERTY(EditAnywhere, Category=FlowPilot, meta=(ClampMin="0.0", EditCondition="ExecutionMode != EFPExecutionMode::RunOnce"))
5959
float RetryDelay = 0.0f;
6060

6161
// FlowPilotLifetimeActors are spawned from FlowPilot, and will auto destroy when Ending

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ UPROPERTY(EditAnywhere, Config, Category="Performance")
2828
TEnumAsByte<ETickingGroup> DefaultTickingGroup = ETickingGroup::TG_DuringPhysics;
2929

3030
// Will prefetch Actors on FlowPilot Setup Phase
31-
UPROPERTY(EditAnywhere, Config, Category="Caching")
31+
UPROPERTY(EditAnywhere, Config, Category="Performance")
3232
bool bPrefetchActorsOnSetup = true;
3333

3434
// Show Runtime Descriptions On Active Tasks Only

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

+6-5
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description: Reference page for FlowTypes.h
77

88
__FileName:__ `FlowTypes.h`
99
- __Enum List:__
10-
[ [`EFPInternalTaskState`](#efpinternaltaskstate) | [`EFPStopType`](#efpstoptype) | [`EFPTaskResult`](#efptaskresult) | [`EFlowState`](#eflowstate) | [`EFlowActorScope`](#eflowactorscope) | [`EFlowActorSpawnLifetime`](#eflowactorspawnlifetime) | [`EFlowMode`](#eflowmode) ]
10+
[ [`EFPInternalTaskState`](#efpinternaltaskstate) | [`EFPStopType`](#efpstoptype) | [`EFPTaskResult`](#efptaskresult) | [`EFlowState`](#eflowstate) | [`EFPActorScope`](#efpactorscope) | [`EFPSpawnLifetime`](#efpspawnlifetime) | [`EFPExecutionMode`](#efpexecutionmode) ]
1111
- __Struct List:__
1212
[ [`FFlowContext`](#fflowcontext) ]
1313

@@ -21,7 +21,7 @@ __FileName:__ `FlowTypes.h`
2121
| `Setup` | Setup done |
2222
| `Started` | Started Execution |
2323
| `Ticking` | Is in Progress |
24-
| `Completed` | ----, > Ticking = Completed, Completed |
24+
| `Completed` | Completed |
2525

2626

2727

@@ -62,7 +62,7 @@ __FileName:__ `FlowTypes.h`
6262

6363

6464

65-
### `EFlowActorScope`
65+
### `EFPActorScope`
6666

6767

6868
| Value | Description |
@@ -73,7 +73,7 @@ __FileName:__ `FlowTypes.h`
7373

7474

7575

76-
### `EFlowActorSpawnLifetime`
76+
### `EFPSpawnLifetime`
7777

7878

7979
| Value | Description |
@@ -83,7 +83,7 @@ __FileName:__ `FlowTypes.h`
8383

8484

8585

86-
### `EFlowMode`
86+
### `EFPExecutionMode`
8787

8888

8989
| Value | Description |
@@ -102,3 +102,4 @@ __FileName:__ `FlowTypes.h`
102102

103103

104104
Flow Context
105+
- Contains information passed to each Task that has information about their owner, and runners.

0 commit comments

Comments
 (0)