1. Epic GamesDeveloper
  3. StateTreeModule

StateTreeModule

API > API/Plugins

Filters

Classes

  Type Name 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 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 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 FStateTreeCustomVersion Custom serialization version for StateTree Asset  
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 and access StateTree instance data.  
Public struct UStruct FStateTreeExecutionState    
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 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 FStateTreeInstanceStorage State Tree instance data is used to store the runtime state of a State Tree.  
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, Evaluators, and Tasks.  
Public struct UStruct FStateTreeNodeIdToIndex Pair of node id and its associated node index created at compilation.  
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 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 FStateTreeRandomTimeDuration Time duration with random variance.  
Public struct UStruct FStateTreeReference Struct to hold reference to a StateTree asset along with values to parameterized it.  
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 FStateTreeTransitionDelayedState    
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 struct TStateTreeExternalDataHandle Handle to access an external struct or object.  
Public struct TStateTreeInstanceDataStructRef Stores indexed reference to a instance data struct.  
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 UClass Config defaultconfig, displayname UStateTreeSettings Default StateTree settings  

Typedefs

Name Description
FOnBreakpointsChanged Called when breakpoints 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.
FOnSchemaChanged Called when schema of the StateTree EditorData has changed.
FOnStateParametersChanged Called when parameters of a StateTree State changed.

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 EStateTreeConditionOperand Operand between conditions  
Public enum UEnum EStateTreeExternalDataRequirement    
Public enum UEnum EStateTreeLinkerStatus    
Public enum UEnum EStateTreeLoopEvents Enum used for flow control during event iteration.  
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 EStateTreePropertyUsage    
Public enum UEnum BlueprintType EStateTreeRunStatus Status describing current run status of a State Tree.  
Public enum UEnum EStateTreeStateChangeType State change type.  
Public enum UEnum EStateTreeStateSelectionBehavior    
Public enum UEnum EStateTreeStateType    
Public enum UEnum BlueprintType EStateTreeTransitionPriority Transition priority.  
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
)

 Use FStateTreePropertyPath instead.
Public function Const bool

IsValid ()

  
Public function constexpr bool  
Public function bool  
Public function constexpr EStateTreeTransitionTrigger  
Public function EStateTreeTransitionTrigger &  
Public function constexpr EStateTreeTransitionTrigger  
Public function EStateTreeTransitionTrigger &  
Public function constexpr EStateTreeTransitionTrigger  
Public function EStateTreeTransitionTrigger &  
Public function constexpr EStateTreeTransitionTrigger  
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGSbool  
Public function bool  
Public function bool  
Public function bool  
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 const FName

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

  

Variables

  Type Name Description
Public variable UProperty FStateTreeIndex16 ArrayIndex Use FStateTreePropertyPath instead.
Public variable UProperty EStateTreePropertyCopyType CopyType The type of copy to use between the properties.
Public variable constexpr int32 MaxConditionIndent  
Public variable UProperty FStateTreeIndex16 NextIndex Index to next segment.
Public variable UProperty TArray< FString > Path Property path segments
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 Use FStateTreePropertyPath instead.
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