Navigation
API > API/Plugins > API/Plugins/StateTreeModule
Describes an active branch of a State Tree.
| Name | FStateTreeExecutionFrame |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeExecutionTypes.h |
| Include Path | #include "StateTreeExecutionTypes.h" |
Syntax
USTRUCT (BlueprintType )
struct FStateTreeExecutionFrame
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
PRAGMA_DISABLE_DEPRECATION_WARNINGS FStateTreeExecutionFrame () |
StateTreeExecutionTypes.h | ||
FStateTreeExecutionFrame
(
const FStateTreeExecutionFrame& |
StateTreeExecutionTypes.h | ||
| StateTreeExecutionTypes.h | |||
FStateTreeExecutionFrame
(
const FRecordedStateTreeExecutionFrame& RecordedExecutionFrame |
StateTreeExecutionTypes.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ActiveInstanceIndexBase | FStateTreeIndex16 | Index within the instance data to the first active state's instance data (e.g. tasks) | StateTreeExecutionTypes.h | |
| ActiveNodeIndex | FStateTreeIndex16 | The evaluator or task node index that was "entered". | StateTreeExecutionTypes.h | |
| ActiveStates | FStateTreeActiveStates | Active states in this frame | StateTreeExecutionTypes.h | |
| ActiveTasksStatus | FStateTreeTasksCompletionStatus | Flag to track the completion of a global task or a task from a state in the ActiveStates. | StateTreeExecutionTypes.h |
|
| bHaveEntered | uint8 | If true, the global tasks/evaluator received the "EnterState". | StateTreeExecutionTypes.h | |
| bIsGlobalFrame | uint8 | If true, the global tasks of the State Tree should be handle in this frame. | StateTreeExecutionTypes.h | |
| ExecutionRuntimeIndexBase | FStateTreeIndex16 | Index within the execution runtime data to the first execution runtime's instance data (e.g. tasks). | StateTreeExecutionTypes.h | |
| ExternalDataBaseIndex | FStateTreeIndex16 | First index of the external data for this frame. | StateTreeExecutionTypes.h | |
| FrameID | UE::StateTree::FActiveFrameID | Unique frame ID for this frame. Can be used to identify the frame. | StateTreeExecutionTypes.h | |
| GlobalInstanceIndexBase | FStateTreeIndex16 | Index within the instance data to the first global instance data (e.g. global tasks) | StateTreeExecutionTypes.h | |
| GlobalParameterDataHandle | FStateTreeDataHandle | Handle to the global parameter data, exists in ParentFrame. | StateTreeExecutionTypes.h | |
| NumCurrentlyActiveStates | uint8 | StateTreeExecutionTypes.h | ||
| RootState | FStateTreeStateHandle | The root state of the frame (e.g. Root state or a subtree). | StateTreeExecutionTypes.h | |
| StateParameterDataHandle | FStateTreeDataHandle | Handle to the state parameter data, exists in ParentFrame. | StateTreeExecutionTypes.h | |
| StateTree | TObjectPtr< const UStateTree > | The State Tree used by the frame. | StateTreeExecutionTypes.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool HasRoot
(
const UE::StateTree::FExecutionFrameHandle& FrameHandle |
StateTreeExecutionTypes.h | ||
bool HasRoot
(
TNotNull< const UStateTree* > InStateTree, |
StateTreeExecutionTypes.h | ||
bool HasSameRoot
(
const FStateTreeExecutionFrame& OtherFrame |
StateTreeExecutionTypes.h | ||
bool IsSameFrame
(
const FStateTreeExecutionFrame& OtherFrame |
StateTreeExecutionTypes.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStateTreeExecutionFrame & operator=
(
const FStateTreeExecutionFrame& |
StateTreeExecutionTypes.h | ||
| StateTreeExecutionTypes.h |