Skip to content

Commit

Permalink
doc update
Browse files Browse the repository at this point in the history
  • Loading branch information
Mikea15 committed Sep 1, 2024
1 parent f487f42 commit 0b5832d
Show file tree
Hide file tree
Showing 26 changed files with 415 additions and 960 deletions.
34 changes: 5 additions & 29 deletions src/content/docs/reference/FPTagActorComponent.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,11 @@ title: UFPTagActorComponent
description: Reference page for UFPTagActorComponent class
---

import Ref from '../../../components/Ref.astro'

<Ref c="UFPTagActorComponent" p="UDeveloperSettings" />

### Description

`UFPTagActorComponent` is a helper component that adds `FGameplayTag`'s to an Actor.
You can add the tag in `BeingPlay`, or by default in `InitializeComponent`.

## Class Info
__Parent Class:__ `UActorComponent`

### Properties

| Property | Description |
| :--- | :--- |
| `FGameplayTagContainer TagsToAdd;` | |

### Functions

#### `UFPTagActorComponent`

```cpp
UFPTagActorComponent();
```

#### `InitializeComponent`
- __Parent Class:__ `UActorComponent`
- __FileName:__ `FPTagActorComponent.h`
## Properties

```cpp
virtual void InitializeComponent() override;
```
No properties in this class
## Functions

66 changes: 5 additions & 61 deletions src/content/docs/reference/FPTaskRunner.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,66 +4,10 @@ description: Reference page for UFPTaskRunner class
---

## Class Info
__Parent Class:__ `UFlowPilotParent`
- __Parent Class:__ `UFlowPilotParent`
- __FileName:__ `FPTaskRunner.h`
## Properties

### Properties

| Property | Description |
| :--- | :--- |

### Functions

#### `UFPTaskRunner`

```cpp
UFPTaskRunner();
```

#### `Setup`

```cpp
virtual void Setup(FFlowContext* InContext) override;
```
#### `Enter`
```cpp
virtual bool Enter() override;
```

#### `Tick`

```cpp
virtual EFPTaskResult Tick(float DeltaTime) override;
```
#### `Exit`
```cpp
virtual void Exit(EFPTaskResult TaskResult) override;
```

#### `Reset`

```cpp
virtual void Reset() override;
```

#### `InternalEnterChildTask`

```cpp
bool InternalEnterChildTask();
```

#### `InternalExitChildTask`

```cpp
void InternalExitChildTask(EFPTaskResult TaskResult);
```
#### `GetNextTaskIndex`
```cpp
uint32 GetNextTaskIndex() const;
```
No properties in this class
## Functions

65 changes: 20 additions & 45 deletions src/content/docs/reference/FPTask_BlueprintBase.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,70 +4,45 @@ description: Reference page for UFPTask_BlueprintBase class
---

## Class Info
### Properties
- __FileName:__ `FPTask_BlueprintBase.h`
## Properties

| Property | Description |
| :--- | :--- |
No properties in this class
## Functions

### Functions

#### `Setup`

```cpp
virtual void Setup(FFlowContext* InContext) override;
```
#### `Enter`
```cpp
virtual bool Enter() override;
```

#### `Tick`

```cpp
virtual EFPTaskResult Tick(float DeltaTime) override;
```
#### `Exit`
```cpp
virtual void Exit(EFPTaskResult TaskResult) override;
```

#### `ReceiveSetup`
Implement setup method.
Called once, during FlowPilot Execution, even after restarts.
### `ReceiveSetup`
> Implement setup method. \
> Called once, during FlowPilot Execution, even after restarts.
```cpp
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
void ReceiveSetup();

```

#### `ReceiveEnter`
Implement enter Task
### `ReceiveEnter`
> Implement enter Task
```cpp
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
bool ReceiveEnter();

```

#### `ReceiveTick`
Implement tick Task
### `ReceiveTick`
> Implement tick Task
```cpp
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
EFPTaskResult ReceiveTick(float DeltaTime);

```
#### `ReceiveExit`
Implement exit Task
### `ReceiveExit`
> Implement exit Task
```cpp
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
void ReceiveExit(EFPTaskResult TaskResult);
```

#### `ReceiveGetRuntimeDescription`
Implement Runtime Description for debug purposes
### `ReceiveGetRuntimeDescription`
> Implement Runtime Description for debug purposes
```cpp
UFUNCTION(BlueprintImplementableEvent, Category = "FlowPilot")
void ReceiveGetRuntimeDescription(TArray<FString>& OutLines) const;

```
31 changes: 7 additions & 24 deletions src/content/docs/reference/FPTask_Delay.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,15 @@ description: Reference page for UFPTask_Delay class
---

## Class Info
__Parent Class:__ `UFlowPilotTask`

### Properties

| Property | Description |
| :--- | :--- |
| `float DelayTime = 0.0f;` | |
| `float RandomDeviation = 0.0f;` | Adds random deviation (TimeAmount - RndDev, TimeAmount + RndDev), Clamped (0.0f - T) |

### Functions

#### `UFPTask_Delay`
- __Parent Class:__ `UFlowPilotTask`
- __FileName:__ `FPTask_Delay.h`
## Properties

```cpp
UFPTask_Delay();
```

#### `Enter`
// Adds random deviation (TimeAmount - RndDev, TimeAmount + RndDev), Clamped (0.0f - T)
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits="s"))
float RandomDeviation = 0.0f;

```cpp
virtual bool Enter() override;
```

#### `Tick`

```cpp
virtual EFPTaskResult Tick(float DeltaTime) override;
```
## Functions
33 changes: 10 additions & 23 deletions src/content/docs/reference/FPTask_DestroyActor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,32 +4,19 @@ description: Reference page for UFPTask_DestroyActor class
---

## Class Info
__Parent Class:__ `UFlowPilotTask`

### Properties

| Property | Description |
| :--- | :--- |
| `FFlowActorReference ActorReference;` | Actors to Destroy |
| `float Delay = 0.0f;` | Destroy Delay |

### Functions

#### `UFPTask_DestroyActor`

```cpp
UFPTask_DestroyActor();
```

#### `Setup`
- __Parent Class:__ `UFlowPilotTask`
- __FileName:__ `FPTask_DestroyActor.h`
## Properties

```cpp
virtual void Setup(FFlowContext* InContext) override;
```
// Actors to Destroy
UPROPERTY(EditAnywhere, Category = "FlowPilot")
FFlowActorReference ActorReference;

#### `Enter`
// Destroy Delay
UPROPERTY(EditAnywhere, Category = "FlowPilot", meta=(ClampMin=0.0f, ForceUnits="Seconds"))
float Delay = 0.0f;

```cpp
virtual bool Enter() override;
```
## Functions
50 changes: 5 additions & 45 deletions src/content/docs/reference/FPTask_FlowAsset.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,50 +4,10 @@ description: Reference page for UFPTask_FlowAsset class
---

## Class Info
__Parent Class:__ `UFlowPilotTask`
- __Parent Class:__ `UFlowPilotTask`
- __FileName:__ `FPTask_FlowAsset.h`
## Properties

### Properties

| Property | Description |
| :--- | :--- |
| `TObjectPtr<UFlowPilot> FlowPilotAsset;` | |
| `UFlowPilot* FlowPilotInstance = nullptr;` | |

### Functions

#### `UFPTask_FlowAsset`

```cpp
UFPTask_FlowAsset();
```

#### `Setup`

```cpp
virtual void Setup(FFlowContext* InContext) override;
```
#### `Enter`
```cpp
virtual bool Enter() override;
```

#### `Tick`

```cpp
virtual EFPTaskResult Tick(float DeltaTime) override;
```
#### `Exit`
```cpp
virtual void Exit(EFPTaskResult TaskResult) override;
```

#### `Reset`

```cpp
virtual void Reset() override;
```
No properties in this class
## Functions

Loading

0 comments on commit 0b5832d

Please sign in to comment.