Navigation
API > API/Plugins > API/Plugins/StateTreeModule > API/Plugins/StateTreeModule/Blueprint
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UStateTreeNodeBlueprintBase
- UStateTreeTaskBlueprintBase
References
| Module | StateTreeModule |
| Header | /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/Blueprint/StateTreeTaskBlueprintBase.h |
| Include | #include "Blueprint/StateTreeTaskBlueprintBase.h" |
Syntax
UCLASS&40;Abstract, Blueprintable&41;
class UStateTreeTaskBlueprintBase : public UStateTreeNodeBlueprintBase
Remarks
Base class for Blueprint based Tasks.
Variables
| Type | Name | Description | |
|---|---|---|---|
 |
uint8: 1 | bHasExitState | |
 |
uint8: 1 | bHasLatentEnterState | |
 |
uint8: 1 | bHasLatentTick | |
 |
uint8: 1 | bHasStateCompleted | |
 |
uint8: 1 | bShouldCallTick | If set to true, Tick() is called. |
   |
uint8: 1 | bShouldCallTickOnlyOnEvents | If set to true, Tick() is called. |
   |
uint8: 1 | bShouldCopyBoundPropertiesOnExitState | If set to true, copy the values of bound properties before calling ExitState(). |
   |
uint8: 1 | bShouldCopyBoundPropertiesOnTick | If set to true, copy the values of bound properties before calling Tick(). |
   |
uint8: 1 | bShouldStateChangeOnReselect | If set to true, the task will receive EnterState/ExitState even if the state was previously active. |
 |
EStateTreeRunStatus | RunStatus | Run status when using latent EnterState and Tick |
Constructors
| Type | Name | Description | |
|---|---|---|---|
 |
UStateTreeTaskBlueprintBase
(
const FObjectInitializer& ObjectInitializer |
Functions
| Type | Name | Description | |
|---|---|---|---|
  |
EStateTreeRunStatus | EnterState
(
FStateTreeExecutionContext& Context, |
|
  |
void | ExitState
(
FStateTreeExecutionContext& Context, |
|
   |
void | FinishTask
(
const bool bSucceeded |
Finish the task and sets it's status. |
   |
void | ReceiveExitState
(
const FStateTreeTransitionResult& Transition |
Called when a current state is exited and task is part of active states. |
   |
void | ReceiveLatentEnterState
(
const FStateTreeTransitionResult& Transition |
Called when a new state is entered and task is part of active states. |
   |
void | ReceiveLatentTick
(
const float DeltaTime |
Called during state tree tick when the task is on active state. |
   |
void | ReceiveStateCompleted
(
const EStateTreeRunStatus CompletionStatus, |
Called right after a state has been completed, but before new state has been selected. |
  |
void | StateCompleted
(
FStateTreeExecutionContext& Context, |
|
  |
EStateTreeRunStatus | Tick
(
FStateTreeExecutionContext& Context, |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
 |
uint8: 1 | bHasEnterState_DEPRECATED | Use bHasLatentEnterState instead. |
 |
uint8: 1 | bHasTick_DEPRECATED | Use bHasLatentTick instead. |
Deprecated Functions
| Type | Name | Description | |
|---|---|---|---|
  |
EStateTreeRunStatus | EnterState
(
FStateTreeExecutionContext& Context, |
Use EnterState without ChangeType instead. |
  |
void | ExitState
(
FStateTreeExecutionContext& Context, |
Use ExitState without ChangeType instead. |
   |
EStateTreeRunStatus | ReceiveEnterState
(
const FStateTreeTransitionResult& Transition |
Use the new EnterState event without without return value instead. Task status is now controlled via FinishTask node, instead of a return value. Default status is running. |
   |
EStateTreeRunStatus | ReceiveTick
(
const float DeltaTime |
Use the new Tick event without without return value instead. Task status is now controlled via FinishTask node, instead of a return value. Default status is running. |