1. Epic GamesDeveloper
  3. FStateTreeExecutionContext

FStateTreeExecutionContext

StateTree Execution Context is a helper that is used to update StateTree instance data.

API > API/Plugins > API/Plugins/StateTreeModule

StateTree Execution Context is a helper that is used to update StateTree instance data.

The context is meant to be temporary, you should not store a context across multiple frames.

The owner is used as the owner of the instantiated UObjects in the instance data and logging, it should have same or greater lifetime as the InstanceData.

In common case you can use the constructor to initialize the context, and us a helper struct to set up the context data and external data getter: FStateTreeExecutionContext Context(*GetOwner(), *StateTreeRef.GetStateTree(), InstanceData); if (SetContextRequirements(Context)) { Context.Tick(DeltaTime); }

bool UMyComponent::SetContextRequirements(FStateTreeExecutionContext& Context) { if (!Context.IsValid()) { return false; } // Setup context data Context.SetContextDataByName(...); ...

Context.SetCollectExternalDataCallback(FOnCollectStateTreeExternalData::CreateUObject(this, &UMyComponent::CollectExternalData);

return Context.AreContextDataViewsValid(); }

bool UMyComponent::CollectExternalData(const FStateTreeExecutionContext& Context, const UStateTree* StateTree, TArrayView ExternalDataDescs, TArrayView OutDataViews) { ... for (int32 Index = 0; Index < ExternalDataDescs.Num(); Index++) { const FStateTreeExternalDataDesc& Desc = ExternalDataDescs[Index]; if (Desc.Struct->IsChildOf(UWorldSubsystem::StaticClass())) { UWorldSubsystem* Subsystem = World->GetSubsystemBase(Cast(const_cast(Desc.Struct.Get()))); OutDataViews[Index] = FStateTreeDataView(Subsystem); } ... } return true; }

In this example the SetContextRequirements() method is used to set the context defined in the schema, and the delegate FOnCollectStateTreeExternalData is used to query the external data required by the tasks and conditions.

In case the State Tree links to other state tree assets, the collect external data might get called multiple times, once for each asset.

   
Name FStateTreeExecutionContext
Type struct
Header File /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeExecutionContext.h
Include Path #include "StateTreeExecutionContext.h"

Syntax

struct FStateTreeExecutionContext : public FStateTreeMinimalExecutionContext

Inheritance Hierarchy

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

FStateTreeExecutionContext ( const FStateTreeExecutionContext& InContextToCopy,
const UStateTree& InStateTree,
FStateTreeInstanceData& InInstanceData
)

 Construct an execution context from a parent context and another tree. StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  

FStateTreeExecutionContext ( TNotNull< UObject* > Owner,
TNotNull< const UStateTree* > StateTree,
FStateTreeInstanceData& InInstanceData,
const FOnCollectStateTreeExternalData& CollectExternalDataCallback,
const EStateTreeRecordTransitions RecordTransitions
)

   StateTreeExecutionContext.h  

FStateTreeExecutionContext ( const FStateTreeExecutionContext& InContextToCopy,
TNotNull< const UStateTree* > StateTree,
FStateTreeInstanceData& InInstanceData
)

 Construct an execution context from a parent context and another tree. StateTreeExecutionContext.h  

FStateTreeExecutionContext ( UObject& InOwner,
const UStateTree& InStateTree,
FStateTreeInstanceData& InInstanceData,
const FOnCollectStateTreeExternalData& CollectExternalDataCallback,
const EStateTreeRecordTransitions RecordTransitions
)

 FStateTreeExecutionContext implementation StateTreeExecutionContext.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FStateTreeExecutionContext()

   StateTreeExecutionContext.h  

Structs

Name Remarks
FAllowDirectTransitionsScope Helper struct to track when it is allowed to request transitions.
FCollectedExternalDataCache  
FCurrentFrameStateSelectionEventsScope  
FCurrentlyProcessedFrameScope Helper struct to track currently processed frame.
FCurrentlyProcessedStateScope Helper struct to track currently processed state.
FCurrentlyProcessedTransitionEventScope Helper struct to track currently processed transition event.
FEvaluationScopeDataCache Holds the container. Multiple instances with the same state tree can occur in a recursive call.
FExternalGlobalParameters Structure to-be-populated and set for any StateTree using any EStateTreeDataSourceType::ExternalGlobalParameterData bindings
FNodeInstanceDataScope Helper struct to set current node data.
FRequestTransitionResult The result of the RequestTransition function.
FSelectionEventWithID Event used during state selection. Identified by the ID of the active state that consumed it.
FSelectStateArguments  
FSelectStateInternalArguments  
FSelectStateResult Describes a result of States Selection.
FStartParameters  
FStateSelectionResult  
FTickTaskArguments  
FTickTaskResult  
FTransitionArguments Optional arguments for a transition request.

Enums

Protected

Name Remarks
ECopyBindings  
ESelectStateBehavior The different type of selections.

Typedefs

Name Type Remarks Include Path
FMemoryRequirement UE::StateTree::InstanceData::FEvaluationScopeInstanceContainer::FMemoryRequirement   StateTreeExecutionContext.h

Constants

Name Type Remarks Include Path
ExpectedEvaluationScopeCacheLength int32   StateTreeExecutionContext.h

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AddDelegateListener ( const FStateTreeDelegateListener& Listener,
FSimpleDelegate Delegate
)

 Adds delegate listener. StateTreeExecutionContext.h  

bool AreContextDataViewsValid()

   StateTreeExecutionContext.h  

void BindDelegate ( const FStateTreeDelegateListener& Listener,
FSimpleDelegate Delegate
)

 Registers the delegate to the listener. StateTreeExecutionContext.h  

void BroadcastDelegate ( const FStateTreeDelegateDispatcher& Dispatcher
)

 Broadcasts the delegate. StateTreeExecutionContext.h  

void ConsumeEvent ( const FStateTreeSharedEvent& Event
)

 Consumes and removes the specified event from the event queue. StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void FinishTask ( const UE::StateTree::FFinishedTask& Task,
EStateTreeFinishTaskType FinishType
)

 Finishes a task. StateTreeExecutionContext.h  

void FinishTask ( const FStateTreeTaskBase& Task,
EStateTreeFinishTaskType FinishType
)

 Finishes a task. StateTreeExecutionContext.h  
Forces transition to a state. StateTreeExecutionContext.h  

TEnableIf< TIsInvocable< TFunc, FStateTreeEvent >::Value, void >::Type ForEachEvent ( TFunc&& Function
) const

 Iterates over all events. StateTreeExecutionContext.h  

TEnableIf< TIsInvocable< TFunc, FStateTreeSharedEvent >::Value, void >::Type ForEachEvent ( TFunc&& Function
) const

 Iterates over all events. StateTreeExecutionContext.h  

FStateTreeDataView GetContextDataByName ( const FName Name
) const

   StateTreeExecutionContext.h  

TConstArrayView< FStateTreeExternalDataDesc > GetContextDataDescs()

   StateTreeExecutionContext.h  

const FStateTreeExecutionFrame * GetCurrentlyProcessedFrame()

   StateTreeExecutionContext.h  

FStateTreeDataHandle GetCurrentlyProcessedNode()

   StateTreeExecutionContext.h  

FStateTreeIndex16 GetCurrentlyProcessedNodeIndex()

   StateTreeExecutionContext.h  

FStateTreeDataHandle GetCurrentlyProcessedNodeInstanceData()

   StateTreeExecutionContext.h  

const FStateTreeExecutionFrame * GetCurrentlyProcessedParentFrame()

   StateTreeExecutionContext.h  

FStateTreeStateHandle GetCurrentlyProcessedState()

   StateTreeExecutionContext.h  

TSharedPtr< UE::StateTree::ExecutionContext::ITemporaryStorage > GetCurrentlyProcessedTemporaryStorage()

   StateTreeExecutionContext.h  

const FStateTreeEventQueue & GetEventQueue()

   StateTreeExecutionContext.h  

TConstArrayView< FStateTreeSharedEvent > GetEventsToProcessView()

   StateTreeExecutionContext.h  

T::FExecutionRuntimeDataType & GetExecutionRuntimeData ( const T& Node
) const

   StateTreeExecutionContext.h  

T & GetExecutionRuntimeData ( const FStateTreeNodeBase& Node
) const

   StateTreeExecutionContext.h  

T * GetExecutionRuntimeDataPtr ( const FStateTreeNodeBase& Node
) const

   StateTreeExecutionContext.h  

T::DataType & GetExternalData ( const T Handle
) const

 Returns reference to external data based on provided handle. StateTreeExecutionContext.h  

T::DataType * GetExternalDataPtr ( const T Handle
) const

 Returns pointer to external data based on provided item handle. StateTreeExecutionContext.h  

FStateTreeDataView GetExternalDataView ( const FStateTreeExternalDataHandle Handle
)

   StateTreeExecutionContext.h  

T & GetInstanceData ( const FStateTreeNodeBase& Node
) const

   StateTreeExecutionContext.h  

T::FInstanceDataType & GetInstanceData ( const T& Node
) const

   StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  

T * GetInstanceDataPtr ( const FStateTreeNodeBase& Node
) const

   StateTreeExecutionContext.h  

TStateTreeInstanceDataStructRef< typename T::FInstanceDataType > GetInstanceDataStructRef ( const T& Node
) const

   StateTreeExecutionContext.h  

const FStateTreeReference * GetLinkedStateTreeOverrideForTag ( const FGameplayTag StateTag
) const

   StateTreeExecutionContext.h  

FStateTreeEventQueue & GetMutableEventQueue()

   StateTreeExecutionContext.h  

TArrayView< FStateTreeSharedEvent > GetMutableEventsToProcessView()

   StateTreeExecutionContext.h  

FStateTreeInstanceData * GetMutableInstanceData()

   StateTreeExecutionContext.h  

TConstArrayView< FRecordedStateTreeTransitionResult > GetRecordedTransitions()

 Returns the recorded transitions for this context. StateTreeExecutionContext.h  

FStateTreeWeakExecutionContext MakeWeakExecutionContext()

   StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FStateTreeWeakTaskRef MakeWeakTaskRef ( const FStateTreeTaskBase& Node
) const

 Similar to GetInstanceData, the node needs to be the current processing node. StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FStateTreeWeakTaskRef MakeWeakTaskRefFromInstanceData ( const T& InInstanceData
) const

 Similar to GetInstanceData, the instance data needs to be the current processing node. StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FStateTreeWeakTaskRef MakeWeakTaskRefFromInstanceDataPtr ( const T* InInstanceData
) const

 Similar to GetInstanceData, the instance data needs to be the current processing node. StateTreeExecutionContext.h  

void RemoveDelegateListener ( const FStateTreeDelegateListener& Listener
)

 Removes delegate listener. StateTreeExecutionContext.h  
Requests transition to a state. StateTreeExecutionContext.h  
Requests transition to a state. StateTreeExecutionContext.h  

void SetCollectExternalDataCallback ( const FOnCollectStateTreeExternalData& Callback
)

 Sets callback used to collect external data views during State Tree execution. StateTreeExecutionContext.h  

void SetContextData ( const FStateTreeExternalDataHandle Handle,
FStateTreeDataView DataView
)

 Sets context data view value for specific item. StateTreeExecutionContext.h  

bool SetContextDataByName ( const FName Name,
FStateTreeDataView DataView
)

 Sets the context data based on name (name is defined in the schema), returns true if data was found StateTreeExecutionContext.h  

void SetExternalGlobalParameters ( const FExternalGlobalParameters* Parameters
)

   StateTreeExecutionContext.h  

void SetLinkedStateTreeOverrides ( const FStateTreeReferenceOverrides* InLinkedStateTreeOverrides
)

 Overrides for linked State Trees. StateTreeExecutionContext.h  

void SetLinkedStateTreeOverrides ( FStateTreeReferenceOverrides InLinkedStateTreeOverrides
)

 Overrides for linked State Trees. StateTreeExecutionContext.h  

EStateTreeRunStatus Start ( const FInstancedPropertyBag* InitialParameters,
int32 RandomSeed
)

 Start executing. StateTreeExecutionContext.h  
Start executing. StateTreeExecutionContext.h  

EStateTreeRunStatus Stop ( const EStateTreeRunStatus CompletionStatus
)

 Stop executing if the tree is running. StateTreeExecutionContext.h  

EStateTreeRunStatus Tick ( const float DeltaTime
)

 Tick the state tree logic, updates the tasks and triggers transitions. StateTreeExecutionContext.h  
Tick the state tree logic partially, triggers the transitions. StateTreeExecutionContext.h  

EStateTreeRunStatus TickUpdateTasks ( const float DeltaTime
)

 Tick the state tree logic partially, updates the tasks. StateTreeExecutionContext.h  

void UnbindDelegate ( const FStateTreeDelegateListener& Listener
)

 Unregisters the callback bound to the listener. StateTreeExecutionContext.h  

Protected

Name Remarks Include Path Unreal Specifiers

FStateTreeDataView AddTemporaryInstance ( const FStateTreeExecutionFrame& Frame,
const FStateTreeIndex16 OwnerNodeIndex,
const FStateTreeDataHandle DataHandle,
FConstStructView NewInstanceData
)

 Adds a temporary instance that can be located using frame and data handle later. StateTreeExecutionContext.h  

void BeginApplyTransition ( const FStateTreeTransitionResult& InTransitionResult
)

 Gives Execution Extension a chance to react. StateTreeExecutionContext.h  

virtual void BeginDelayedTransition ( const FStateTreeTransitionDelayedState& DelayedState
)

 Callback when delayed transition is triggered. StateTreeExecutionContext.h  

void CallStopOnEvaluatorsAndGlobalTasks ( const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& Frame,
const FStateTreeTransitionResult& Transition,
const FStateTreeIndex16 LastInitializedTaskIndex
)

   StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void CaptureNewStateEvents ( TConstArrayView< FStateTreeExecutionFrame > PrevFrames,
TConstArrayView< FStateTreeExecutionFrame > NewFrames,
TArrayView< FStateTreeFrameStateSelectionEvents > FramesStateSelectionEvents
)

   StateTreeExecutionContext.h  

void CaptureNewStateEvents ( const TSharedRef< const FSelectStateResult >& Args
)

 Captures StateTree events used during the state selection. StateTreeExecutionContext.h  
Collects external data for all StateTrees in active frames. StateTreeExecutionContext.h  
Collects external data for all StateTrees in active frames. StateTreeExecutionContext.h  
Collects external data for specific State Tree asset. StateTreeExecutionContext.h  

void CopyAllBindingsOnActiveInstances ( ECopyBindings CopyType
)

 Copy the binding on all valid active instances. StateTreeExecutionContext.h  

bool CopyBatchOnActiveInstances ( const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeDataView TargetView,
const FStateTreeIndex16 BindingsBatch
)

 Copies a batch of properties to the data in TargetView. StateTreeExecutionContext.h  

bool CopyBatchWithValidation ( const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeDataView TargetView,
const FStateTreeIndex16 BindingsBatch
)

 Copies a batch of properties to the data in TargetView. StateTreeExecutionContext.h  

FString DebugGetEventsAsString()

   StateTreeExecutionContext.h  

FString DebugGetStatePath ( TConstArrayView< FStateTreeExecutionFrame > ActiveFrames,
const FStateTreeExecutionFrame* CurrentFrame,
const int32 ActiveStateIndex
) const

   StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  

EStateTreeRunStatus EnterState ( const TSharedPtr< FSelectStateResult >& SelectStateResult,
const FStateTreeTransitionResult& Transition
)

 Handles logic for entering State. StateTreeExecutionContext.h  

void EvaluatePropertyFunctionsOnActiveInstances ( const FStateTreeExecutionFrame* CurrentParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
FStateTreeIndex16 FuncsBegin,
uint16 FuncsNum
)

 Evaluate all function at given range. StateTreeExecutionContext.h  

void EvaluatePropertyFunctionsWithValidation ( const FStateTreeExecutionFrame* CurrentParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
FStateTreeIndex16 FuncsBegin,
uint16 FuncsNum
)

 Evaluate all function at given range. StateTreeExecutionContext.h  

float EvaluateUtility ( const FStateTreeExecutionFrame* CurrentParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
const int32 ConsiderationsOffset,
const int32 ConsiderationsNum,
const float StateWeight
)

   StateTreeExecutionContext.h  

float EvaluateUtilityWithValidation ( const FStateTreeExecutionFrame* CurrentParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
FStateTreeStateHandle StateHandle,
const FMemoryRequirement& MemoryRequirement,
const int32 ConsiderationsBegin,
const int32 ConsiderationsNum,
const float StateWeight
)

 Calculate the final score of all considerations at given range. StateTreeExecutionContext.h  

void ExitState ( const TSharedPtr< const FSelectStateResult >& SelectStateResult,
const FStateTreeTransitionResult& Transition
)

 Handles logic for exiting State. StateTreeExecutionContext.h  

void ExitState ( const FStateTreeTransitionResult& Transition
)

   StateTreeExecutionContext.h  

bool ForceTransitionInternal ( const TArrayView< const UE::StateTree::ExecutionContext::FStateHandleContext > States,
const TSharedRef< FSelectStateResult >& OutSelectionResult
)

 Forces transition to a state. It will skip all conditions. StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  

FStateTreeDataView GetExecutionRuntimeDataView()

   StateTreeExecutionContext.h  

EStateTreeRunStatus GetGlobalTasksCompletedStatesStatus()

 In the list of completed states, returns the run status when it's completed by a global task. StateTreeExecutionContext.h  

virtual FString GetInstanceDescription()

   StateTreeExecutionContext.h  

FString GetSafeStateName ( const UStateTree* StateTree,
const FStateTreeStateHandle State
) const

   StateTreeExecutionContext.h  

FString GetSafeStateName ( const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeStateHandle State
) const

   StateTreeExecutionContext.h  

FString GetStateStatusString ( const FStateTreeExecutionState& ExecState
) const

   StateTreeExecutionContext.h  

FStateTreeDataView GetTemporaryDataView ( const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeDataHandle Handle
)

   StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSbool IsFinishedTaskValid ( const UE::StateTree::FFinishedTask& Task
) const

 Confirms that the frame and state ID are valid and the task index is correct. StateTreeExecutionContext.h  

bool IsHandleSourceValid ( const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeDataHandle Handle
) const

   StateTreeExecutionContext.h  

bool IsHandleSourceValid ( const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
const FPropertyBindingCopyInfo& CopyInfo
) const

   StateTreeExecutionContext.h  
Create a new recorded transition from a transition result. StateTreeExecutionContext.h  
Create a new recorded transition from a select state result. StateTreeExecutionContext.h  
Create a new transition result from a recorded transition result. StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS FStateTreeWeakTaskRef MakeWeakTaskRefInternal()

   StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void MarkStateCompleted ( UE::StateTree::FFinishedTask& FinisedTask
)

 Adds the state to the completed list from a finished task. StateTreeExecutionContext.h  

void PopEvaluationScopeInstanceContainer ( UE::StateTree::InstanceData::FEvaluationScopeInstanceContainer& Container
)

   StateTreeExecutionContext.h  

void PushEvaluationScopeInstanceContainer ( UE::StateTree::InstanceData::FEvaluationScopeInstanceContainer& Container,
const FStateTreeExecutionFrame& Frame
)

   StateTreeExecutionContext.h  

void RemoveAllDelegateListeners()

 Removes all delegate listeners. StateTreeExecutionContext.h  

bool RequestTransition ( const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeStateHandle NextState,
const EStateTreeTransitionPriority Priority,
const FStateTreeSharedEvent* TransitionEvent,
const EStateTreeSelectionFallback Fallback
)

   StateTreeExecutionContext.h  

bool RequestTransitionInternal ( const FStateTreeExecutionFrame& SourceFrame,
UE::StateTree::FActiveStateID SourceStateID,
UE::StateTree::ExecutionContext::FStateHandleContext TargetState,
const FTransitionArguments& Args
)

 Requests transition to a specified state. StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSbool SelectState ( const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeStateHandle NextState,
FStateSelectionResult& OutSelectionResult,
const FStateTreeSharedEvent* TransitionEvent,
const EStateTreeSelectionFallback Fallback
)

   StateTreeExecutionContext.h  

bool SelectState ( const FSelectStateArguments& SelectStateArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult
)

 Starting at the specified state, walking towards the leaf states. StateTreeExecutionContext.h  

TOptional< bool > SelectStateFromSourceInternal ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult,
const FStateTreeExecutionFrame& NextFrame,
const FCompactStateTreeState& NextState,
FStateTreeStateHandle NextStateHandle,
bool bNewFrameCreated
)

 Used internally to select state until we reach the transition source or the transition target. StateTreeExecutionContext.h  

bool SelectStateInternal ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult
)

 Used internally to do the recursive part of the SelectState(). StateTreeExecutionContext.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGSbool SelectStateInternal ( const FStateTreeExecutionFrame* CurrentParentFrame,
FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeExecutionFrame* CurrentFrameInActiveFrames,
TConstArrayView< FStateTreeStateHandle > PathToNextState,
FStateSelectionResult& OutSelectionResult,
const FStateTreeSharedEvent* TransitionEvent
)

   StateTreeExecutionContext.h  

bool SelectStateInternal_Linked ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult,
TNotNull< const UStateTree* > NextStateTree,
const FCompactStateTreeState& NextState,
bool bShouldCreateNewState
)

   StateTreeExecutionContext.h  

bool SelectStateInternal_LinkedAsset ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult,
TNotNull< const UStateTree* > NextStateTree,
const FCompactStateTreeState& NextState,
const UStateTree* NextLinkedStateAsset,
bool bShouldCreateNewState
)

   StateTreeExecutionContext.h  

bool SelectStateInternal_TryFollowTransitions ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult,
TNotNull< const UStateTree* > NextStateTree,
const FCompactStateTreeState& TargetState,
const FStateTreeStateHandle TargetStateHandle
)

   StateTreeExecutionContext.h  

bool SelectStateInternal_TrySelectChildrenAtRandom ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult,
TNotNull< const UStateTree* > NextStateTree,
const FCompactStateTreeState& TargetState,
const FStateTreeStateHandle TargetStateHandle
)

   StateTreeExecutionContext.h  

bool SelectStateInternal_TrySelectChildrenAtRandomWeightedByUtility ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult,
TNotNull< const UStateTree* > NextStateTree,
const FCompactStateTreeState& TargetState,
const FStateTreeStateHandle TargetStateHandle
)

   StateTreeExecutionContext.h  

bool SelectStateInternal_TrySelectChildrenInOrder ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult,
TNotNull< const UStateTree* > NextStateTree,
const FCompactStateTreeState& TargetState,
const FStateTreeStateHandle TargetStateHandle
)

   StateTreeExecutionContext.h  

bool SelectStateInternal_TrySelectChildrenWithHighestUtility ( const FSelectStateArguments& Args,
const FSelectStateInternalArguments& InternalArgs,
const TSharedRef< FSelectStateResult >& OutSelectionResult,
TNotNull< const UStateTree* > NextStateTree,
const FCompactStateTreeState& TargetState,
const FStateTreeStateHandle TargetStateHandle
)

   StateTreeExecutionContext.h  

bool SetGlobalParameters ( const FInstancedPropertyBag& Parameters
)

 Stores copy of provided parameters as State Tree global parameters. StateTreeExecutionContext.h  

void SetUpdatePhaseInExecutionState ( FStateTreeExecutionState& ExecutionState,
EStateTreeUpdatePhase UpdatePhase
) const

 Updates the update phase of the statetree execution state. StateTreeExecutionContext.h  

void SetupNextTransition ( const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeStateHandle NextState,
const EStateTreeTransitionPriority Priority
)

   StateTreeExecutionContext.h  
Sets up NextTransition based on the provided parameters and the current execution status. StateTreeExecutionContext.h  
Sets up NextTransition based on the provided parameters and the current execution status. StateTreeExecutionContext.h  
Starts active global evaluators and global tasks. StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  
Start the frame's evaluators and the frame's tasks. StateTreeExecutionContext.h  
Start the frame's evaluators and the frame's tasks. StateTreeExecutionContext.h  
Starts temporary instances of global evaluators and tasks for a given frame. StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  

void StateCompleted ()

 Handles logic for signaling State completed. StateTreeExecutionContext.h  

void StopEvaluatorsAndGlobalTasks ( const EStateTreeRunStatus CompletionStatus,
const FStateTreeIndex16 LastInitializedTaskIndex
)

   StateTreeExecutionContext.h  

void StopEvaluatorsAndGlobalTasks ( const EStateTreeRunStatus CompletionStatus
)

 Stops active global evaluators and active global tasks. StateTreeExecutionContext.h  
Stop the frame's evaluators and the frame's tasks. StateTreeExecutionContext.h  
Stop the frame's evaluators and the frame's tasks. StateTreeExecutionContext.h  
Stops temporary frame's evaluators and frame's tasks for the provided frame. StateTreeExecutionContext.h  

void StopTemporaryEvaluatorsAndGlobalTasks ( const FStateTreeExecutionFrame* CurrentParentFrame,
const FStateTreeExecutionFrame& CurrentFrame
)

   StateTreeExecutionContext.h  

bool TestAllConditions ( const FStateTreeExecutionFrame* CurrentParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
const int32 ConditionsOffset,
const int32 ConditionsNum
)

   StateTreeExecutionContext.h  

bool TestAllConditionsOnActiveInstances ( const FStateTreeExecutionFrame* CurrentParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
FStateTreeStateHandle CurrentStateHandle,
const FMemoryRequirement& MemoryRequirement,
const int32 ConditionsOffset,
const int32 ConditionsNum,
EStateTreeUpdatePhase Phase
)

 Checks all conditions at given range. StateTreeExecutionContext.h  

bool TestAllConditionsWithValidation ( const FStateTreeExecutionFrame* CurrentParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
FStateTreeStateHandle CurrentStateHandle,
const FMemoryRequirement& MemoryRequirement,
const int32 ConditionsOffset,
const int32 ConditionsNum,
EStateTreeUpdatePhase Phase
)

 Checks all conditions at given range. StateTreeExecutionContext.h  

EStateTreeRunStatus TickEvaluatorsAndGlobalTasks ( float DeltaTime,
bool bTickGlobalTasks
)

 Tick evaluators and global tasks by delta time. StateTreeExecutionContext.h  

EStateTreeRunStatus TickEvaluatorsAndGlobalTasksForFrame ( float DeltaTime,
bool bTickGlobalTasks,
int32 FrameIndex,
const FStateTreeExecutionFrame* CurrentParentFrame,
const TNotNull< FStateTreeExecutionFrame* > CurrentFrame
)

 Tick the frame's evaluators and the frame's tasks. StateTreeExecutionContext.h  

void TickGlobalEvaluatorsForFrameOnActiveInstances ( float DeltaTime,
const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& Frame
)

 Stop the frame's evaluators. StateTreeExecutionContext.h  

void TickGlobalEvaluatorsForFrameWithValidation ( float DeltaTime,
const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& Frame
)

 Tick the frame's evaluators. StateTreeExecutionContext.h  

EStateTreeRunStatus TickPostlude()

   StateTreeExecutionContext.h  

EStateTreeRunStatus TickPrelude()

 Common functionality shared by the tick methods. StateTreeExecutionContext.h  
Ticks tasks and updates the bindings for a specific state or frame. StateTreeExecutionContext.h  

EStateTreeRunStatus TickTasks ( const float DeltaTime
)

 Ticks tasks of all active states starting from current state by delta time. StateTreeExecutionContext.h  

void TickTriggerTransitionsInternal()

 Handles transition triggering part of the tick. StateTreeExecutionContext.h  

void TickUpdateTasksInternal ( float DeltaTime
)

 Handles task ticking part of the tick. StateTreeExecutionContext.h  
Tick (if needed) event, delayed, delegate and, tick state completion transitions. StateTreeExecutionContext.h  
  StateTreeExecutionContext.h  

void UpdateCompletedStateList ( bool bMarkTaskProcessed
)

 Removes stale entries and fills the completed states list. StateTreeExecutionContext.h  

void UpdateInstanceData ( const TSharedPtr< FSelectStateResult >& SelectStateResult
)

 Allocate the instance data. Fixup the TemporarySelectedFrame with the correct data. StateTreeExecutionContext.h  

void UpdateInstanceData ( TConstArrayView< FStateTreeExecutionFrame > CurrentActiveFrames,
TArrayView< FStateTreeExecutionFrame > NextActiveFrames
)

   StateTreeExecutionContext.h  

Static

Name Remarks Include Path Unreal Specifiers

static const FStateTreeExecutionFrame * FindFrame ( const UStateTree* StateTree,
FStateTreeStateHandle RootState,
TConstArrayView< FStateTreeExecutionFrame > Frames,
const FStateTreeExecutionFrame*& OutParentFrame
)

 Looks for a frame in provided list of frames. StateTreeExecutionContext.h  

static FStateTreeDataView GetDataViewFromInstanceStorage ( FStateTreeInstanceStorage& InstanceDataStorage,
FStateTreeInstanceStorage* CurrentlyProcessedSharedInstanceStorage,
const FStateTreeExecutionFrame* ParentFrame,
const FStateTreeExecutionFrame& CurrentFrame,
const FStateTreeDataHandle Handle
)

   StateTreeExecutionContext.h  

Operators

Name Remarks Include Path Unreal Specifiers
  StateTreeExecutionContext.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page