Navigation
API > API/Plugins > API/Plugins/StateTreeModule
Handle to a StateTree state
| Name | FStateTreeStateHandle |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeTypes.h |
| Include Path | #include "StateTreeTypes.h" |
Syntax
USTRUCT (BlueprintType )
struct FStateTreeStateHandle
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| StateTreeTypes.h | |||
FStateTreeStateHandle
(
const uint16 InIndex |
StateTreeTypes.h | ||
FStateTreeStateHandle
(
const int32 InIndex |
StateTreeTypes.h |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| Failed | const FStateTreeStateHandle | StateTreeTypes.h | |
| FailedIndex | uint16 | StateTreeTypes.h | |
| Invalid | const FStateTreeStateHandle | StateTreeTypes.h | |
| InvalidIndex | uint16 | StateTreeTypes.h | |
| Root | const FStateTreeStateHandle | StateTreeTypes.h | |
| Stopped | const FStateTreeStateHandle | StateTreeTypes.h | |
| StoppedIndex | uint16 | StateTreeTypes.h | |
| Succeeded | const FStateTreeStateHandle | StateTreeTypes.h | |
| SucceededIndex | uint16 | StateTreeTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Index | uint16 | StateTreeTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FString Describe() |
StateTreeTypes.h | ||
void Invalidate() |
StateTreeTypes.h | ||
bool IsCompletionState() |
StateTreeTypes.h | ||
bool IsValid() |
StateTreeTypes.h | ||
EStateTreeRunStatus ToCompletionStatus() |
StateTreeTypes.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FStateTreeStateHandle FromCompletionStatus
(
const EStateTreeRunStatus Status |
StateTreeTypes.h | ||
static bool IsValidIndex
(
const int32 Index |
StateTreeTypes.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool operator!=
(
const FStateTreeStateHandle& RHS |
StateTreeTypes.h | ||
bool operator==
(
const FStateTreeStateHandle& RHS |
StateTreeTypes.h |