Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

> Unreal Engine API Reference > Plugins > StateTreeModule > FStateTreeExecutionContext

Light Theme

Dark Theme

FStateTreeExecutionContext

Runs StateTrees defined in [UStateTree](API\Plugins\StateTreeModule\UStateTree) asset.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

FStateTreeExecutionContext

FMassStateTreeExecutionContext

References

Module	StateTreeModule
Header	/Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeExecutionContext.h
Include	#include "StateTreeExecutionContext.h"

Syntax

USTRUCT()
struct FStateTreeExecutionContext

Remarks

Runs StateTrees defined in UStateTree asset. Uses constant data from StateTree, keeps local storage of variables, and creates instanced Evaluators and Tasks.

Variables

	Name	Description
TArray< FStateT...	DataViews	Array of data pointers (external data, tasks, evaluators, conditions), used during evaluation.
UObject *	Owner
const UStateTre...	StateTree	The StateTree asset the context is initialized for
FInstancedStruc...	StorageInstance	Optional Instance of the storage
EStateTreeStora...	StorageType	Storage type of the context
TArray< bool >	VisitedStates	States visited during a tick while updating evaluators.

Constructors

	Name	Description
	FStateTreeExecutionContext()

Destructors

	Name	Description
	~FStateTreeExecutionContext()

Functions

	Name	Description
void	AddStructReferencedObjects ( FReferenceCollector& Collector )
void	AddStructReferencedObjects ( const FStateTreeDataView ExternalSt..., FReferenceCollector& Collector )
bool	AreExternalDataViewsValid()
void	BeginGatedTransition ( const FStateTreeExecutionState& Ex... )	Callback when gated transition is triggered.
FString	DebugGetStatePath ( TArrayView< FStateTreeHandle > Acti..., int32 ActiveStateIndex )
void	DebugPrintInternalLayout ( FStateTreeDataView ExternalStorage )
EStateTreeRu...	EnterState ( FStateTreeDataView Storage, const FStateTreeTransitionResult& ... )	Handles logic for entering State.
void	ExitState ( FStateTreeDataView Storage, const FStateTreeTransitionResult& ... )	Handles logic for exiting State.
FString	GetActiveStateName ( FStateTreeDataView ExternalStorage )
int32	GetActiveStates ( const FStateTreeHandle StateHandle, TStaticArray< FStateTreeHandle, 32 ... )
FStateTreeEx...	GetExecState ( FStateTreeDataView Storage )
T::DataType ...	GetExternalData ( const T Handle )	Returns reference to external data based on provided handle.
TConstArrayV...	GetExternalDataDescs()	Init() must be called before calling this method.
FStateTreeEx...	GetExternalDataHandleByStruct ( const UStruct* InStruct )
T::DataType ...	GetExternalDataPtr ( const T Handle )	Returns pointer to external data based on provided item handle.
FStateTreeDa...	GetExternalDataView ( const FStateTreeExternalDataHandle ... )
T::DataType ...	GetInstanceData ( const T Handle )	Returns reference to instance data property based on provided handle.
FStateTreeDa...	GetInstanceData ( FStateTreeDataView Storage, const bool bIsObject, const int32 Index )
T::DataType ...	GetInstanceDataPtr ( const T Handle )	Returns pointer to instance data property based on provided handle.
FString	GetInstanceDescription()
T *	GetInstanceObjectInternal ( const int32 DataViewIndex )	Used internally by the Blueprint wrappers to get wrapped instance objects.
T &	GetItem ( const int32 Index )
EStateTreeRu...	GetLastTickStatus ( FStateTreeDataView ExternalStorage )
UObject *...	GetOwner()
FString	GetSafeStateName ( const FStateTreeHandle State )
const FBaked...	GetStateFromHandle ( const FStateTreeHandle StateHandle )
FString	GetStateStatusString ( const FStateTreeStateStatus StateSt... )
const UState...	GetStateTree()	Returns the StateTree asset in use.
UWorld *	GetWorld()
bool	Init ( UObject& InOwner, const UStateTree& InStateTree, const EStateTreeStorage InStorageTy... )	Initializes the StateTree instance to be used with specific owner and StateTree asset.
bool	InitInstanceData ( UObject& InOwner, FStateTreeDataView ExternalStorage )	Initializes external storage (no need to call, if using internal storage).
bool	IsValid()
void	Reset()	Resets the instance to initial empty state.
FStateTreeDa...	SelectMutableStorage ( FStateTreeDataView ExternalStorage )
FStateTreeTr...	SelectState ( FStateTreeDataView Storage, const FStateTreeStateStatus Initial..., const FStateTreeHandle InitialTarge..., const FStateTreeHandle NextState, const int Depth )	Runs state selection logic starting at the specified state, walking towards the leaf states.
const FState...	SelectStorage ( FStateTreeDataView ExternalStorage )
void	SetExternalData ( const FStateTreeExternalDataHandle ..., FStateTreeDataView DataView )	Sets external data view value for specific item.
EStateTreeRu...	Start ( FStateTreeDataView ExternalStorage )	Start executing.
void	StateCompleted ( FStateTreeDataView Storage, const FStateTreeHandle CurrentState, const EStateTreeRunStatus Completio... )	Handles logic for exiting State.
EStateTreeRu...	Stop ( FStateTreeDataView ExternalStorage )	Stop executing.
bool	TestAllConditions ( FStateTreeDataView Storage, const uint32 ConditionsOffset, const uint32 ConditionsNum )	Checks all conditions at given range
EStateTreeRu...	Tick ( const float DeltaTime, FStateTreeDataView ExternalStorage )	Tick the state tree logic.
void	TickEvaluators ( FStateTreeDataView Storage, const FStateTreeHandle CurrentState, const EStateTreeEvaluationType Eval..., const float DeltaTime )	Ticks evaluators of all active states starting from current state by delta time.
EStateTreeRu...	TickTasks ( FStateTreeDataView Storage, const FStateTreeHandle CurrentState, const float DeltaTime )	Ticks tasks of all active states starting from current state by delta time.
FStateTreeTr...	TriggerTransitions ( FStateTreeDataView Storage, const FStateTreeStateStatus Current..., const int Depth )	Triggers transitions based on current run status.