Skip to content

Commit 590b05f

Browse files
Mikea15Mikea15
committed
update docs
1 parent 2fb500a commit 590b05f

29 files changed

+271
-1032
lines changed

‎astro.config.mjs

+3
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,9 @@ export default defineConfig({
2727
editLink: {
2828
baseUrl: 'https://github.com/Mikea15/UEFlowPilot/tree/main/'
2929
},
30+
tableOfContents: {
31+
maxHeadingLevel: 4
32+
},
3033
sidebar: [{
3134
label: 'About',
3235
items: [

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,18 @@ title: FPTagActorComponent.h
33
description: Reference page for FPTagActorComponent.h
44
---
55

6-
## Class Info
7-
- __Parent Class:__ `UActorComponent`
8-
- __FileName:__ `FPTagActorComponent.h`
6+
## File Info
97

10-
## Properties
8+
__FileName:__ `FPTagActorComponent.h`
9+
- __Class List:__
10+
[ [`UFPTagActorComponent`](#ufptagactorcomponent) ]
1111

12-
No properties in this class
1312

14-
## Functions
13+
## `UFPTagActorComponent`
1514

16-
No functions in this class
1715

18-
## File Info
16+
__Parent Classes:__
17+
[ `UActorComponent` ]
1918

20-
__FileName:__ `FPTagActorComponent.h`
21-
- __Class List:__
22-
[ ]
19+
\
20+
Helper Component to add Tags to Actor.

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,18 @@ title: FPTaskRunner.h
33
description: Reference page for FPTaskRunner.h
44
---
55

6-
## Class Info
7-
- __Parent Class:__ `UFlowPilotParent`
8-
- __FileName:__ `FPTaskRunner.h`
6+
## File Info
97

10-
## Properties
8+
__FileName:__ `FPTaskRunner.h`
9+
- __Class List:__
10+
[ [`UFPTaskRunner`](#ufptaskrunner) ]
1111

12-
No properties in this class
1312

14-
## Functions
13+
## `UFPTaskRunner`
1514

16-
No functions in this class
1715

18-
## File Info
16+
__Parent Classes:__
17+
[ `UFlowPilotParent` ]
1918

20-
__FileName:__ `FPTaskRunner.h`
21-
- __Class List:__
22-
[ ]
19+
\
20+
Task Runner is the Base Class for Sequences and Selectors

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

+1-47
Original file line numberDiff line numberDiff line change
@@ -3,57 +3,11 @@ title: FPTask_BlueprintBase.h
33
description: Reference page for FPTask_BlueprintBase.h
44
---
55

6-
## Class Info
7-
- __FileName:__ `FPTask_BlueprintBase.h`
8-
9-
## Properties
10-
11-
No properties in this class
12-
13-
## Functions
14-
15-
### `ReceiveSetup`
16-
> Implement setup method. \
17-
> Called once, during FlowPilot Execution, even after restarts.
18-
```cpp
19-
void ReceiveSetup();
20-
21-
```
22-
23-
### `ReceiveEnter`
24-
> Implement enter Task
25-
```cpp
26-
bool ReceiveEnter();
27-
28-
```
29-
30-
### `ReceiveTick`
31-
> Implement tick Task
32-
```cpp
33-
EFPTaskResult ReceiveTick(float DeltaTime);
34-
35-
```
36-
37-
### `ReceiveExit`
38-
> Implement exit Task
39-
```cpp
40-
void ReceiveExit(EFPTaskResult TaskResult);
41-
42-
```
43-
44-
### `ReceiveGetRuntimeDescription`
45-
> Implement Runtime Description for debug purposes
46-
```cpp
47-
void ReceiveGetRuntimeDescription(TArray<FString>& OutLines) const;
48-
49-
```
50-
51-
526
## File Info
537

548
__FileName:__ `FPTask_BlueprintBase.h`
559
- __Class List:__
56-
[ [`UFPTask_BlueprintBase`](#UFPTask_BlueprintBase) ]
10+
[ [`UFPTask_BlueprintBase`](#ufptask_blueprintbase) ]
5711

5812

5913
## `UFPTask_BlueprintBase`

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

+1-18
Original file line numberDiff line numberDiff line change
@@ -3,28 +3,11 @@ title: FPTask_Delay.h
33
description: Reference page for FPTask_Delay.h
44
---
55

6-
## Class Info
7-
- __Parent Class:__ `UFlowPilotTask`
8-
- __FileName:__ `FPTask_Delay.h`
9-
10-
## Properties
11-
12-
```cpp
13-
// Adds random deviation (TimeAmount - RndDev, TimeAmount + RndDev), Clamped (0.0f - T)
14-
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits="s"))
15-
float RandomDeviation = 0.0f;
16-
17-
```
18-
19-
## Functions
20-
21-
No functions in this class
22-
236
## File Info
247

258
__FileName:__ `FPTask_Delay.h`
269
- __Class List:__
27-
[ [`UFPTask_Delay`](#UFPTask_Delay) ]
10+
[ [`UFPTask_Delay`](#ufptask_delay) ]
2811

2912

3013
## `UFPTask_Delay`

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

+1-22
Original file line numberDiff line numberDiff line change
@@ -3,32 +3,11 @@ title: FPTask_DestroyActor.h
33
description: Reference page for FPTask_DestroyActor.h
44
---
55

6-
## Class Info
7-
- __Parent Class:__ `UFlowPilotTask`
8-
- __FileName:__ `FPTask_DestroyActor.h`
9-
10-
## Properties
11-
12-
```cpp
13-
// Actors to Destroy
14-
UPROPERTY(EditAnywhere, Category = "FlowPilot")
15-
FFlowActorReference ActorReference;
16-
17-
// Destroy Delay
18-
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits="Seconds"))
19-
float Delay = 0.0f;
20-
21-
```
22-
23-
## Functions
24-
25-
No functions in this class
26-
276
## File Info
287

298
__FileName:__ `FPTask_DestroyActor.h`
309
- __Class List:__
31-
[ [`UFPTask_DestroyActor`](#UFPTask_DestroyActor) ]
10+
[ [`UFPTask_DestroyActor`](#ufptask_destroyactor) ]
3211

3312

3413
## `UFPTask_DestroyActor`

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

+10-11
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,19 @@ title: FPTask_FlowAsset.h
33
description: Reference page for FPTask_FlowAsset.h
44
---
55

6-
## Class Info
7-
- __Parent Class:__ `UFlowPilotTask`
8-
- __FileName:__ `FPTask_FlowAsset.h`
6+
## File Info
97

10-
## Properties
8+
__FileName:__ `FPTask_FlowAsset.h`
9+
- __Class List:__
10+
[ [`UFPTask_FlowAsset`](#ufptask_flowasset) ]
1111

12-
No properties in this class
1312

14-
## Functions
13+
## `UFPTask_FlowAsset`
1514

16-
No functions in this class
1715

18-
## File Info
16+
__Parent Classes:__
17+
[ `UFlowPilotTask` ]
1918

20-
__FileName:__ `FPTask_FlowAsset.h`
21-
- __Class List:__
22-
[ ]
19+
\
20+
FPTask_FlowAsset \
21+
- Loads and Runs another FlowDataAsset

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

+16-29
Original file line numberDiff line numberDiff line change
@@ -3,44 +3,31 @@ title: FPTask_FlowPilotControl.h
33
description: Reference page for FPTask_FlowPilotControl.h
44
---
55

6-
## Class Info
7-
- __Parent Class:__ `UFlowPilotTask`
8-
- __FileName:__ `FPTask_FlowPilotControl.h`
9-
10-
## Properties
6+
## File Info
117

12-
```cpp
13-
// Flow Actor reference to an Actors that have FlowPilotComponents
14-
UPROPERTY(EditAnywhere, Category = "FlowPilot")
15-
FFlowActorReference ActorReference;
8+
__FileName:__ `FPTask_FlowPilotControl.h`
9+
- __Class List:__
10+
[ [`UFPTask_FlowPilotControl`](#ufptask_flowpilotcontrol) ]
11+
- __Enum List:__
12+
[ [`EFlowControlSuccessCondition`](#eflowcontrolsuccesscondition) ]
1613

17-
// Flow Control Type
18-
UPROPERTY(EditAnywhere, Category = "FlowPilot")
19-
EFlowPilotControlType ControlType = EFlowPilotControlType::StartFlow;
2014

21-
// Flow Stop Type
22-
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType==EFlowPilotControlType::StopFlow", EditConditionHides))
23-
EFPStopType StopType = EFPStopType::CancelExecution;
15+
## `EFlowControlSuccessCondition`
2416

25-
// When starting a new FlowPilot, what's this Task's success condition?\
26-
// Essentially, we can Succeed instantly, or wait for InProgress or Stopped/Complete execution of the\
27-
// Controlled FlowPilot Component we're controlling.
28-
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(EditCondition="ControlType==EFlowPilotControlType::StartFlow", EditConditionHides))
29-
EFlowControlSuccessCondition SuccessCondition = EFlowControlSuccessCondition::Instant;
3017

31-
```
18+
### Properties
3219

33-
## Functions
20+
```cpp
21+
// Will succeed instantly after Request
22+
Instant,
3423

35-
No functions in this class
24+
// Will succeed when Flow has Started and is in Progress
25+
WaitForFlowStart,
3626

37-
## File Info
27+
// Will succeed when Flow has Started, and is Complete
28+
WaitForFlowComplete
3829

39-
__FileName:__ `FPTask_FlowPilotControl.h`
40-
- __Class List:__
41-
[ [`UFPTask_FlowPilotControl`](#UFPTask_FlowPilotControl) ]
42-
- __Enum List:__
43-
[ ]
30+
```
4431

4532

4633
## `UFPTask_FlowPilotControl`

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,18 @@ title: FPTask_LoadLevel.h
33
description: Reference page for FPTask_LoadLevel.h
44
---
55

6-
## Class Info
7-
- __Parent Class:__ `UFlowPilotTask`
8-
- __FileName:__ `FPTask_LoadLevel.h`
6+
## File Info
97

10-
## Properties
8+
__FileName:__ `FPTask_LoadLevel.h`
9+
- __Class List:__
10+
[ [`UFPTask_LoadLevel`](#ufptask_loadlevel) ]
1111

12-
No properties in this class
1312

14-
## Functions
13+
## `UFPTask_LoadLevel`
1514

16-
No functions in this class
1715

18-
## File Info
16+
__Parent Classes:__
17+
[ `UFlowPilotTask` ]
1918

20-
__FileName:__ `FPTask_LoadLevel.h`
21-
- __Class List:__
22-
[ ]
19+
\
20+
Load Level Task

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

+9-11
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,18 @@ title: FPTask_Loop.h
33
description: Reference page for FPTask_Loop.h
44
---
55

6-
## Class Info
7-
- __Parent Class:__ `UFlowPilotTask`
8-
- __FileName:__ `FPTask_Loop.h`
6+
## File Info
97

10-
## Properties
8+
__FileName:__ `FPTask_Loop.h`
9+
- __Class List:__
10+
[ [`UFPTask_Loop`](#ufptask_loop) ]
1111

12-
No properties in this class
1312

14-
## Functions
13+
## `UFPTask_Loop`
1514

16-
No functions in this class
1715

18-
## File Info
16+
__Parent Classes:__
17+
[ `UFlowPilotTask` ]
1918

20-
__FileName:__ `FPTask_Loop.h`
21-
- __Class List:__
22-
[ ]
19+
\
20+
Executes a Task in a Loop

0 commit comments

Comments
 (0)