1. Epic GamesDeveloper
  3. StateTreeModule

StateTreeModule

API > API/Plugins

Filters

Classes

  Type Name Description
Public struct UStruct FCompactEventDesc Runtime representation of an event description.  
Public struct UStruct FCompactStateTransition Runtime representation of a StateTree transition.  
Public struct UStruct FCompactStateTreeParameters    
Public struct UStruct FCompactStateTreeState Runtime representation of a StateTree state.  
Public struct FConstStateTreeExecutionContextView The const version of a StateTree Execution Context that prevents using the FStateTreeInstanceData with non-const member function.  
Public struct UStruct FRecordedStateTreeExecutionFrame Captured state tree execution frame that can be cached for recording purposes.  
Public struct UStruct FRecordedStateTreeTransitionResult Captured state tree transition result that can be cached for recording purposes.  
Public struct UStruct BlueprintType FStateTreeActiveStates Describes an array of active states in a State Tree.  
Public struct UStruct FStateTreeAnyEnum Enum that can be any type in the UI. Helper class to deal with any enum in property binding.  
Public struct UStruct FStateTreeBindableStructDesc Descriptor for a struct or class that can be a binding source or target.  
Public struct UStruct BlueprintType displayname FStateTreeBlueprintPropertyRef FStateTreeBlueprintPropertyRef is a PropertyRef intended to be used in State Tree Blueprint nodes like tasks, conditions or evaluators, but also as a StateTree parameter.  
Public struct UStruct meta FStateTreeConditionBase Base struct for all conditions.  
Public struct UStruct meta FStateTreeConditionCommonBase Base class (namespace) for all common Conditions that are generally applicable.  
Public struct UStruct meta FStateTreeConsiderationBase This feature is experimental and the API is expected to change.  
Public struct UStruct meta FStateTreeConsiderationCommonBase Base class (namespace) for all common Utility Considerations that are generally applicable.  
Public struct FStateTreeCustomVersion Custom serialization version for StateTree Asset  
Public struct UStruct BlueprintType FStateTreeDataHandle Handle to a StateTree data  
Public struct FStateTreeDataView Short lived pointer to an UOBJECT() or USTRUCT().  
Public struct UStruct meta FStateTreeEvaluatorBase Base struct of StateTree Evaluators.  
Public struct UStruct meta FStateTreeEvaluatorCommonBase Base class (namespace) for all common Evaluators that are generally applicable.  
Public struct UStruct BlueprintType FStateTreeEvent StateTree event with payload.  
Public struct UStruct FStateTreeEventQueue Event queue buffering all the events to be processed by a State Tree.  
Public struct FStateTreeExecutionContext StateTree Execution Context is a helper that is used to update StateTree instance data.  
Public struct UStruct BlueprintType FStateTreeExecutionFrame Describes an active branch of a State Tree.  
Public struct UStruct FStateTreeExecutionState Describes the execution state of the current State Tree instance.  
Public struct UStruct FStateTreeExternalDataDesc Describes an external data.  
Public struct UStruct FStateTreeExternalDataHandle Handle to access an external struct or object. Note: Use the templated version below.  
Public struct FStateTreeFrameStateSelectionEvents Contains StateTree events used during State Selection for a single execution frame.  
Public struct UStruct BlueprintType FStateTreeIndex16 Uint16 index that can be invalid.  
Public struct UStruct BlueprintType FStateTreeIndex8 Uint8 index that can be invalid.  
Public struct UStruct FStateTreeInstanceData StateTree instance data is used to store the runtime state of a StateTree.  
Public struct UStruct FStateTreeInstanceObjectWrapper Wrapper class to store an object amongst the structs.  
Public struct UStruct FStateTreeInstanceStorage State Tree instance data is used to store the runtime state of a State Tree.  
Public struct FStateTreeInstanceStorageCustomVersion    
Public struct FStateTreeLinker The StateTree linker is used to resolved references to various StateTree data at load time.  
Public struct FStateTreeMemoryUsage Struct containing information about the StateTree runtime memory usage.  
Public struct UStruct FStateTreeNodeBase Base struct of StateTree Conditions, Considerations, Evaluators, and Tasks.  
Public struct UStruct FStateTreeNodeIdToIndex Pair of node id and its associated node index created at compilation.  
Public struct UStruct FStateTreePropertyAccess Describes access to referenced property.  
Public struct UStruct FStateTreePropertyBindings Runtime storage and execution of property bindings.  
Public struct UStruct FStateTreePropertyCopy Used internally.  
Public struct UStruct FStateTreePropertyCopyBatch Describes a batch of property copies from many sources to one target struct.  
Public struct UStruct meta FStateTreePropertyFunctionBase Base struct for all property functions.  
Public struct UStruct meta FStateTreePropertyFunctionCommonBase    
Public struct UStruct FStateTreePropertyIndirection Used internally.  
Public struct UStruct FStateTreePropertyPath Representation of a property path used for property binding in StateTree.  
Public struct UStruct FStateTreePropertyPathBinding Representation of a property binding in StateTree  
Public struct FStateTreePropertyPathIndirection Struct describing an indirection at specific segment at path.  
Public struct UStruct FStateTreePropertyPathSegment Struct describing a path segment in FStateTreePropertyPath.  
Public struct UStruct FStateTreePropertyRef Property ref allows to get a pointer to selected property in StateTree.  
Public struct FStateTreePropertyRefExternalHandle External Handle allows to wrap-up property reference to make it accessible without having an access to StateTreeExecutionContext.  
Public struct UStruct FStateTreePropertyRefPath Representation of a property reference binding in StateTree.  
Public struct UStruct FStateTreeRandomTimeDuration Time duration with random variance.  
Public struct UStruct BlueprintType FStateTreeReference Struct to hold reference to a StateTree asset along with values to parameterized it.  
Public struct UStruct FStateTreeReferenceOverrideItem Item describing a state tree override for a state with a specific tag.  
Public struct UStruct FStateTreeReferenceOverrides Overrides for linked State Trees.  
Public struct UStruct FStateTreeSharedEvent A struct wrapping FStateTreeEvent in shared struct, used to make it easier to refer to the events during State Tree update.  
Public struct UStruct BlueprintType FStateTreeStateHandle Handle to a StateTree state  
Public struct UStruct FStateTreeStateIdToHandle Pair of state guid and its associated state handle created at compilation.  
Public struct UStruct BlueprintType FStateTreeStateLink Link to another state in StateTree  
Public struct UStruct BlueprintType FStateTreeStructRef StateTree struct ref allows to get a reference/pointer to a specified type via property binding.  
Public struct UStruct meta FStateTreeTaskBase Base struct for StateTree Tasks. Tasks are logic executed in an active state.  
Public struct UStruct meta FStateTreeTaskCommonBase Base class (namespace) for all common Tasks that are generally applicable.  
Public struct UStruct FStateTreeTemporaryInstanceData Holds temporary instance data created during state selection.  
Public struct UStruct FStateTreeTransitionDelayedState Describes current state of a delayed transition.  
Public struct UStruct FStateTreeTransitionIdToIndex Pair of transition id and its associated compact transition index created at compilation.  
Public struct UStruct BlueprintType FStateTreeTransitionRequest Transition request  
Public struct UStruct BlueprintType FStateTreeTransitionResult Describes a state tree transition.  
Public struct UStruct FStateTreeTransitionSource Describes the origin of an applied transition.  
Public struct IStateTreeBindingLookup Helper interface to reason about bound properties. The implementation is in the editor plugin.  
Public class IStateTreeModule The public interface to this module  
Public class IStateTreeSchemaProvider Implementing this interface allows derived class to override the schema used to filter valid state trees for a FStateTreeReference.  
Public struct TStateTreeExternalDataHandle Handle to access an external struct or object.  
Public struct TStateTreeInstanceDataStructRef Stores indexed reference to a instance data struct.  
Public struct TStateTreePropertyRef TStateTreePropertyRef is a type-safe FStateTreePropertyRef wrapper against a single given type.  
Public struct TStateTreePropertyRefExternalHandle Single type safe external handle allows to wrap-up property reference to make it accessible without having an access to StateTreeExecutionContext.  
Public class UClass BlueprintType UStateTree StateTree asset. Contains the StateTree definition in both editor and runtime (baked) formats.  
Public class UClass Abstract UStateTreeSchema Schema describing which inputs, evaluators, and tasks a StateTree can contain.  
Public class UStateTreeSchemaProvider    
Public class UClass Config defaultconfig, displayname UStateTreeSettings Default StateTree settings  
Public struct Validator    

Typedefs

Name Description
FOnBreakpointsChanged Called when breakpoints of the StateTree EditorData changed.
FOnCollectStateTreeExternalData Delegate used by the execution context to collect external data views for a given StateTree asset.
FOnGlobalDataChanged Called when Global Tasks or Evaluators of the StateTree EditorData changed.
FOnIdentifierChanged Called when linkable name in a StateTree has changed.
FOnParametersChanged Called when parameters of the StateTree EditorData changed.
FOnPostCompile Called when compilation succeeds
FOnRequestCompile Request StateTree compilation. Works only in editor.
FOnRequestEditorHash Request the editor hash of the given state tree.
FOnSchemaChanged Called when schema of the StateTree EditorData has changed.
FOnStateParametersChanged Called when parameters of a StateTree State changed.
FOnVisualThemeChanged Called when the theme colors change.

Enums

  Type Name Description
Public enum UEnum EStateTreeBindableStructSource    
Public enum EStateTreeCompare    
Public enum UEnum EStateTreeConditionEvaluationMode Defines how to assign the result of a condition to evaluate.  
Public enum UEnum BlueprintType EStateTreeDataSourceType Data type the FStateTreeDataHandle is pointing at.  
Public enum UEnum EStateTreeExpressionOperand Operand in an expression  
Public enum UEnum EStateTreeExternalDataRequirement    
Public enum UEnum EStateTreeLinkerStatus    
Public enum UEnum EStateTreeLoopEvents Enum used for flow control during event iteration.  
Public enum UEnum BlueprintType EStateTreeNodeFormatting Enum describing in what format a text is expected to be returned.  
Public enum EStateTreePropertyAccessCompatibility Enum describing property compatibility  
Public enum UEnum EStateTreePropertyAccessType The type of access a property path describes.  
Public enum UEnum EStateTreePropertyCopyType Describes how the copy should be performed.  
Public enum UEnum EStateTreePropertyRefType    
Public enum UEnum EStateTreePropertyUsage    
Public enum UEnum EStateTreeRecordTransitions Enumeration for the different transition recording types.  
Public enum UEnum BlueprintType EStateTreeRunStatus Status describing current run status of a State Tree.  
Public enum UEnum EStateTreeSelectionFallback Fallback behavior indicating what to do after failing to select a state  
Public enum UEnum EStateTreeStateChangeType State change type.  
Public enum UEnum EStateTreeStateSelectionBehavior    
Public enum UEnum EStateTreeStateType    
Public enum UEnum EStateTreeTransitionSourceType    
Public enum UEnum EStateTreeTransitionTrigger Transitions trigger.  
Public enum UEnum EStateTreeTransitionType Transitions behavior.  
Public enum UEnum EStateTreeUpdatePhase Enumeration for the different update phases.  

Functions

  Type Name Description
Public function  

FStateTreeEditorPropertyPath ( const FGuid& InStructID,
const TCHAR* PropertyName
)

  
Public function Const bool

IsValid ()

  
Public function bool

operator!= ( const EStateTreeTransitionPriority Lhs,
const EStateTreeTransitionPriority Rhs
)

  
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGS bool  
Public function bool

operator== ( const EStateTreeTransitionPriority Lhs,
const EStateTreeTransitionPriority Rhs
)

  
Public function bool

operator> ( const EStateTreeTransitionPriority Lhs,
const EStateTreeTransitionPriority Rhs
)

  
Public function bool

operator>= ( const EStateTreeTransitionPriority Lhs,
const EStateTreeTransitionPriority Rhs
)

  
Public function Const FString

ToString ( const int32 HighlightedSegment,
const TCHAR* HighlightPrefix,
const TCHAR* HighlightPostfix
)

 Returns the property path as a one string. Highlight allows to decorate a specific segment.
Public function FText

UE::StateTree::DescHelpers::GetDescriptionForMathOperation ( FText OperationText,
const FGuid& ID,
FStateTreeDataView InstanceDataView,
const IStateTreeBindingLookup& BindingLookup,
EStateTreeNodeFormatting Formatting
)

  
Public function FText

UE::StateTree::DescHelpers::GetDescriptionForSingleParameterFunc ( FText OperationText,
const FGuid& ID,
FStateTreeDataView InstanceDataView,
const IStateTreeBindingLookup& BindingLookup,
EStateTreeNodeFormatting Formatting
)

  
Public function Static T *

UE::StateTree::PropertyRefHelpers::GetMutablePtrToProperty ( const FStateTreePropertyRef& PropertyRef,
FStateTreeInstanceStorage& InstanceDataStorage,
const FStateTreeExecutionFrame& ExecutionFrame,
const FStateTreeExecutionFrame* ParentExecutionFrame,
const FProperty** OutSourceProperty
)

  
Public function Static TTuple< T *... >  
Public function bool

UE::StateTree::PropertyRefHelpers::IsPropertyCompatibleWithClass ( const FProperty& Property,
const UClass& Class
)

 Checks if provided property is compatible with selected Class.
Public function bool

UE::StateTree::PropertyRefHelpers::IsPropertyCompatibleWithEnum ( const FProperty& Property,
const UEnum& Enum
)

 Checks if provided property is compatible with selected Enum.
Public function bool

UE::StateTree::PropertyRefHelpers::IsPropertyCompatibleWithStruct ( const FProperty& Property,
const UScriptStruct& Struct
)

 Checks if provided property is compatible with selected ScriptStruct.
Public function const FName

UE::StateTree::SchemaCanBeOverridenTag ( TEXT("SchemaCanBeOverriden")
)

  
Public function const FName

UE::StateTree::SchemaTag ( TEXT("Schema")
)

  

Variables

  Type Name Description
Public variable UProperty FStateTreeIndex16 ArrayIndex Deprecated.
Public variable UProperty EStateTreePropertyCopyType CopyType The type of copy to use between the properties.
Public variable int32 MaxConditionIndent  
Public variable int32 MaxExpressionIndent  
Public variable UProperty FStateTreeIndex16 NextIndex Index to next segment.
Public variable UProperty TArray< FString > Path Property path segments
Public variable   PRAGMA_ENABLE_DEPRECATION_WARNINGS  
Public variable UProperty FStateTreeIndex16 SourceStructIndex Index to the source struct the source path refers to, sources are stored in FStateTreePropertyBindings.
Public variable UProperty FGuid StructID Handle of the struct this property path is relative to.
Public variable UProperty FStateTreePropertySegment TargetPath Deprecated.
Public variable UProperty EStateTreePropertyAccessType Type Type of access/indirection.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page