Skip to content

Commit 0b5832d

Browse files
committed
doc update
1 parent f487f42 commit 0b5832d

26 files changed

+415
-960
lines changed

src/content/docs/reference/FPTagActorComponent.mdx

+5-29
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,11 @@ title: UFPTagActorComponent
33
description: Reference page for UFPTagActorComponent class
44
---
55

6-
import Ref from '../../../components/Ref.astro'
7-
8-
<Ref c="UFPTagActorComponent" p="UDeveloperSettings" />
9-
10-
### Description
11-
12-
`UFPTagActorComponent` is a helper component that adds `FGameplayTag`'s to an Actor.
13-
You can add the tag in `BeingPlay`, or by default in `InitializeComponent`.
14-
156
## Class Info
16-
__Parent Class:__ `UActorComponent`
17-
18-
### Properties
19-
20-
| Property | Description |
21-
| :--- | :--- |
22-
| `FGameplayTagContainer TagsToAdd;` | |
23-
24-
### Functions
25-
26-
#### `UFPTagActorComponent`
27-
28-
```cpp
29-
UFPTagActorComponent();
30-
```
31-
32-
#### `InitializeComponent`
7+
- __Parent Class:__ `UActorComponent`
8+
- __FileName:__ `FPTagActorComponent.h`
9+
## Properties
3310

34-
```cpp
35-
virtual void InitializeComponent() override;
36-
```
11+
No properties in this class
12+
## Functions
3713

src/content/docs/reference/FPTaskRunner.mdx

+5-61
Original file line numberDiff line numberDiff line change
@@ -4,66 +4,10 @@ description: Reference page for UFPTaskRunner class
44
---
55

66
## Class Info
7-
__Parent Class:__ `UFlowPilotParent`
7+
- __Parent Class:__ `UFlowPilotParent`
8+
- __FileName:__ `FPTaskRunner.h`
9+
## Properties
810

9-
### Properties
10-
11-
| Property | Description |
12-
| :--- | :--- |
13-
14-
### Functions
15-
16-
#### `UFPTaskRunner`
17-
18-
```cpp
19-
UFPTaskRunner();
20-
```
21-
22-
#### `Setup`
23-
24-
```cpp
25-
virtual void Setup(FFlowContext* InContext) override;
26-
```
27-
28-
#### `Enter`
29-
30-
```cpp
31-
virtual bool Enter() override;
32-
```
33-
34-
#### `Tick`
35-
36-
```cpp
37-
virtual EFPTaskResult Tick(float DeltaTime) override;
38-
```
39-
40-
#### `Exit`
41-
42-
```cpp
43-
virtual void Exit(EFPTaskResult TaskResult) override;
44-
```
45-
46-
#### `Reset`
47-
48-
```cpp
49-
virtual void Reset() override;
50-
```
51-
52-
#### `InternalEnterChildTask`
53-
54-
```cpp
55-
bool InternalEnterChildTask();
56-
```
57-
58-
#### `InternalExitChildTask`
59-
60-
```cpp
61-
void InternalExitChildTask(EFPTaskResult TaskResult);
62-
```
63-
64-
#### `GetNextTaskIndex`
65-
66-
```cpp
67-
uint32 GetNextTaskIndex() const;
68-
```
11+
No properties in this class
12+
## Functions
6913

src/content/docs/reference/FPTask_BlueprintBase.mdx

+20-45
Original file line numberDiff line numberDiff line change
@@ -4,70 +4,45 @@ description: Reference page for UFPTask_BlueprintBase class
44
---
55

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

9-
| Property | Description |
10-
| :--- | :--- |
10+
No properties in this class
11+
## Functions
1112

12-
### Functions
13-
14-
#### `Setup`
15-
16-
```cpp
17-
virtual void Setup(FFlowContext* InContext) override;
18-
```
19-
20-
#### `Enter`
21-
22-
```cpp
23-
virtual bool Enter() override;
24-
```
25-
26-
#### `Tick`
27-
28-
```cpp
29-
virtual EFPTaskResult Tick(float DeltaTime) override;
30-
```
31-
32-
#### `Exit`
33-
34-
```cpp
35-
virtual void Exit(EFPTaskResult TaskResult) override;
36-
```
37-
38-
#### `ReceiveSetup`
39-
Implement setup method.
40-
Called once, during FlowPilot Execution, even after restarts.
13+
### `ReceiveSetup`
14+
> Implement setup method. \
15+
> Called once, during FlowPilot Execution, even after restarts.
4116
```cpp
42-
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
4317
void ReceiveSetup();
18+
4419
```
4520

46-
#### `ReceiveEnter`
47-
Implement enter Task
21+
### `ReceiveEnter`
22+
> Implement enter Task
4823
```cpp
49-
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
5024
bool ReceiveEnter();
25+
5126
```
5227

53-
#### `ReceiveTick`
54-
Implement tick Task
28+
### `ReceiveTick`
29+
> Implement tick Task
5530
```cpp
56-
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
5731
EFPTaskResult ReceiveTick(float DeltaTime);
32+
5833
```
5934
60-
#### `ReceiveExit`
61-
Implement exit Task
35+
### `ReceiveExit`
36+
> Implement exit Task
6237
```cpp
63-
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
6438
void ReceiveExit(EFPTaskResult TaskResult);
39+
6540
```
6641

67-
#### `ReceiveGetRuntimeDescription`
68-
Implement Runtime Description for debug purposes
42+
### `ReceiveGetRuntimeDescription`
43+
> Implement Runtime Description for debug purposes
6944
```cpp
70-
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
7145
void ReceiveGetRuntimeDescription(TArray<FString>& OutLines) const;
46+
7247
```
7348

src/content/docs/reference/FPTask_Delay.mdx

+7-24
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,15 @@ description: Reference page for UFPTask_Delay class
44
---
55

66
## Class Info
7-
__Parent Class:__ `UFlowPilotTask`
8-
9-
### Properties
10-
11-
| Property | Description |
12-
| :--- | :--- |
13-
| `float DelayTime = 0.0f;` | |
14-
| `float RandomDeviation = 0.0f;` | Adds random deviation (TimeAmount - RndDev, TimeAmount + RndDev), Clamped (0.0f - T) |
15-
16-
### Functions
17-
18-
#### `UFPTask_Delay`
7+
- __Parent Class:__ `UFlowPilotTask`
8+
- __FileName:__ `FPTask_Delay.h`
9+
## Properties
1910

2011
```cpp
21-
UFPTask_Delay();
22-
```
23-
24-
#### `Enter`
12+
// Adds random deviation (TimeAmount - RndDev, TimeAmount + RndDev), Clamped (0.0f - T)
13+
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits="s"))
14+
float RandomDeviation = 0.0f;
2515

26-
```cpp
27-
virtual bool Enter() override;
28-
```
29-
30-
#### `Tick`
31-
32-
```cpp
33-
virtual EFPTaskResult Tick(float DeltaTime) override;
3416
```
17+
## Functions
3518

src/content/docs/reference/FPTask_DestroyActor.mdx

+10-23
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,19 @@ description: Reference page for UFPTask_DestroyActor class
44
---
55

66
## Class Info
7-
__Parent Class:__ `UFlowPilotTask`
8-
9-
### Properties
10-
11-
| Property | Description |
12-
| :--- | :--- |
13-
| `FFlowActorReference ActorReference;` | Actors to Destroy |
14-
| `float Delay = 0.0f;` | Destroy Delay |
15-
16-
### Functions
17-
18-
#### `UFPTask_DestroyActor`
19-
20-
```cpp
21-
UFPTask_DestroyActor();
22-
```
23-
24-
#### `Setup`
7+
- __Parent Class:__ `UFlowPilotTask`
8+
- __FileName:__ `FPTask_DestroyActor.h`
9+
## Properties
2510

2611
```cpp
27-
virtual void Setup(FFlowContext* InContext) override;
28-
```
12+
// Actors to Destroy
13+
UPROPERTY(EditAnywhere, Category = "FlowPilot")
14+
FFlowActorReference ActorReference;
2915

30-
#### `Enter`
16+
// Destroy Delay
17+
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits="Seconds"))
18+
float Delay = 0.0f;
3119

32-
```cpp
33-
virtual bool Enter() override;
3420
```
21+
## Functions
3522

src/content/docs/reference/FPTask_FlowAsset.mdx

+5-45
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,10 @@ description: Reference page for UFPTask_FlowAsset class
44
---
55

66
## Class Info
7-
__Parent Class:__ `UFlowPilotTask`
7+
- __Parent Class:__ `UFlowPilotTask`
8+
- __FileName:__ `FPTask_FlowAsset.h`
9+
## Properties
810

9-
### Properties
10-
11-
| Property | Description |
12-
| :--- | :--- |
13-
| `TObjectPtr<UFlowPilot> FlowPilotAsset;` | |
14-
| `UFlowPilot* FlowPilotInstance = nullptr;` | |
15-
16-
### Functions
17-
18-
#### `UFPTask_FlowAsset`
19-
20-
```cpp
21-
UFPTask_FlowAsset();
22-
```
23-
24-
#### `Setup`
25-
26-
```cpp
27-
virtual void Setup(FFlowContext* InContext) override;
28-
```
29-
30-
#### `Enter`
31-
32-
```cpp
33-
virtual bool Enter() override;
34-
```
35-
36-
#### `Tick`
37-
38-
```cpp
39-
virtual EFPTaskResult Tick(float DeltaTime) override;
40-
```
41-
42-
#### `Exit`
43-
44-
```cpp
45-
virtual void Exit(EFPTaskResult TaskResult) override;
46-
```
47-
48-
#### `Reset`
49-
50-
```cpp
51-
virtual void Reset() override;
52-
```
11+
No properties in this class
12+
## Functions
5313

0 commit comments

Comments
 (0)