Navigation
API > API/Plugins > API/Plugins/StateTreeModule
References
| Module | StateTreeModule |
| Header | /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeExecutionTypes.h |
| Include | #include "StateTreeExecutionTypes.h" |
Syntax
USTRUCT ()
struct FStateTreeExecutionState
Remarks
Describes the execution state of the current State Tree instance.
Variables
| Type | Name | Description | |
|---|---|---|---|
| TArray< FStateTreeExecutionFrame > | ActiveFrames | Currently active frames (and states) | |
| FStateTreeIndex16 | CompletedFrameIndex | Handle of the state that was first to report state completed (success or failure), used to trigger completion transitions. | |
| FStateTreeStateHandle | CompletedStateHandle | ||
| EStateTreeUpdatePhase | CurrentPhase | Current update phase used to validate reentrant calls to the main entry points of the execution context (i.e. Start, Stop, Tick). | |
| TArray< FStateTreeTransitionDelayedState > | DelayedTransitions | Pending delayed transitions. | |
| FStateTreeIndex16 | EnterStateFailedFrameIndex | The index of the task that failed during enter state. | |
| FStateTreeIndex16 | EnterStateFailedTaskIndex | The index of the frame that failed during enter state. | |
| EStateTreeRunStatus | LastTickStatus | Result of last tick | |
| FRandomStream | RandomStream | Used by state tree random-based operations. | |
| EStateTreeRunStatus | RequestedStop | Completion status stored if Stop was called during the Tick and needed to be deferred. | |
| uint16 | StateChangeCount | Number of times a new state has been changed. | |
| EStateTreeRunStatus | TreeRunStatus | Running status of the instance |
Constructors
| Type | Name | Description | |
|---|---|---|---|
| PRAGMA_DISABLE_DEPRECATION_WARNINGS | |||
FStateTreeExecutionState
(
const FStateTreeExecutionState& |
|||
Functions
| Type | Name | Description | |
|---|---|---|---|
| TArray< FStateTreeTransitionDelayedState, TInlineAllocator< 8 > > | FindAndRemoveExpiredDelayedTransitions
(
const UStateTree* OwnerStateTree, |
Finds all delayed transition states for a specific transition and removes them. | |
| FStateTreeTransitionDelayedState * | FindDelayedTransition
(
const UStateTree* OwnerStateTree, |
||
| PRAGMA_ENABLE_DEPRECATION_WARNINGS void | Reset () |
Operators
| Type | Name | Description | |
|---|---|---|---|
| FStateTreeExecutionState & | operator=
(
const FStateTreeExecutionState& |
||
| FStateTreeExecutionState & |
Deprecated Variables
| Type | Name | Description | |
|---|---|---|---|
| FStateTreeActiveStates | CurrentActiveStates_DEPRECATED | ||
| FStateTreeIndex16 | FirstTaskObjectIndex_DEPRECATED | Index of the first task object in the currently initialized instance data. | |
| FStateTreeIndex16 | FirstTaskStructIndex_DEPRECATED | Index of the first task struct in the currently initialized instance data. |