1. Epic GamesDeveloper
  3. UStateTreeEditorData

UStateTreeEditorData

Edit time data for StateTree asset.

API > API/Plugins > API/Plugins/StateTreeEditorModule

Edit time data for StateTree asset. This data gets baked into runtime format before being used by the StateTreeInstance.

   
Name UStateTreeEditorData
Type class
Header File /Engine/Plugins/Runtime/StateTree/Source/StateTreeEditorModule/Public/StateTreeEditorData.h
Include Path #include "StateTreeEditorData.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, EditInlineNew, CollapseCategories, Within="StateTree",  
       Meta=(DisallowLevelActorReference=true))  
class UStateTreeEditorData :  
    public UObject ,  
    public IStateTreeEditorPropertyBindingsOwner

Inheritance Hierarchy

Implements Interfaces

Derived Classes

Constructors

Name Remarks Include Path Unreal Specifiers

UStateTreeEditorData()

   StateTreeEditorData.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
Breakpoints TArray< FStateTreeEditorBreakpoint > Transient list of breakpoints added in the debugging session. StateTreeEditorData.h
  • Transient
Colors TSet< FStateTreeEditorColor > Color Options to assign to a State StateTreeEditorData.h
  • EditDefaultsOnly
  • Category="Theme"
CompiledDispatchers TArray< FStateTreeEditorDelegateDispatcherCompiledBinding > List of the previous compiled delegate dispatchers. StateTreeEditorData.h
  • DuplicateTransient
EditorBindings FStateTreeEditorPropertyBindings   StateTreeEditorData.h  
EditorSchema TObjectPtr< UStateTreeEditorSchema > Schema describing how the editor schema is customized. StateTreeEditorData.h
  • Instanced
  • NoClear
Evaluators TArray< FStateTreeEditorNode >   StateTreeEditorData.h
  • EditDefaultsOnly
  • Category="Evaluators"
  • Meta=(BaseStruct="/Script/StateTreeModule.StateTreeEvaluatorBase", BaseClass="/Script/StateTreeModule.StateTreeEvaluatorBlueprintBase")
Extensions TArray< TObjectPtr< UStateTreeEditorDataExtension > > The editor data extensions. A place to add extra information for plugins. StateTreeEditorData.h
  • EditDefaultsOnly
  • Instanced
  • Category="Extension"
  • NoClear
GlobalTasks TArray< FStateTreeEditorNode >   StateTreeEditorData.h
  • EditDefaultsOnly
  • Category="Global Tasks"
  • Meta=(BaseStruct="/Script/StateTreeModule.StateTreeTaskBase", BaseClass="/Script/StateTreeModule.StateTreeTaskBlueprintBase")
GlobalTasksCompletion EStateTreeTaskCompletionType   StateTreeEditorData.h
  • EditDefaultsOnly
  • Category="Global Tasks"
RootParameters FStateTreeStateParameters Public parameters that could be used for bindings within the Tree. StateTreeEditorData.h
  • Meta=(DeprecatedProperty)
Schema TObjectPtr< UStateTreeSchema > Schema describing which inputs, evaluators, and tasks a StateTree can contain. StateTreeEditorData.h
  • EditDefaultsOnly
  • Instanced
  • Category="Common"
  • NoClear
SubTrees TArray< TObjectPtr< UStateTreeState > > Top level States. StateTreeEditorData.h
  • Instanced

Protected

Name Type Remarks Include Path Unreal Specifiers
OnParametersChangedHandle FDelegateHandle   StateTreeEditorData.h  
OnStateParametersChangedHandle FDelegateHandle   StateTreeEditorData.h  
RootParameterPropertyBag FInstancedPropertyBag Public parameters property bag that could be used for bindings within the Tree. StateTreeEditorData.h
  • EditDefaultsOnly
  • Category=Parameters
RootParametersGuid FGuid Public parameters ID that could be used for bindings within the Tree. StateTreeEditorData.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

TStateTreeEditorNode< T > & AddEvaluator ( TArgs&&... InArgs
)

 Adds Evaluator of specified type. StateTreeEditorData.h  

TStateTreeEditorNode< T > & AddGlobalTask ( TArgs&&... InArgs
)

 Adds Global Task of specified type. StateTreeEditorData.h  

void AddPropertyBinding ( const UScriptStruct* PropertyFunctionNodeStruct,
TConstArrayView< FPropertyBindingPathSegment > SourcePathSegments,
const FPropertyBindingPath& TargetPath
)

 Adds property binding to PropertyFunction of provided type. StateTreeEditorData.h  

void AddPropertyBinding ( const UScriptStruct* PropertyFunctionNodeStruct,
TConstArrayView< FPropertyBindingPathSegment > SourcePathSegments,
const FStateTreePropertyPath& TargetPath
)

   StateTreeEditorData.h  

bool AddPropertyBinding ( const FStateTreeEditorNode& SourceNode,
const FString SourcePathStr,
const FStateTreeEditorNode& TargetNode,
const FString TargetPathStr
)

 Adds property binding between two structs. StateTreeEditorData.h  

PRAGMA_DISABLE_DEPRECATION_WARNINGS void AddPropertyBinding ( const FStateTreePropertyPath& SourcePath,
const FStateTreePropertyPath& TargetPath
)

   StateTreeEditorData.h  

void AddPropertyBinding ( const FPropertyBindingPath& SourcePath,
const FPropertyBindingPath& TargetPath
)

 Adds property binding between two structs. StateTreeEditorData.h  

UStateTreeState & AddRootState()

 Adds new Subtree named "Root". StateTreeEditorData.h  

UStateTreeState & AddSubTree ( const FName Name
)

 Adds new Subtree with specified name. StateTreeEditorData.h  

virtual void CreateRootProperties ( TArrayView< UE::PropertyBinding::FPropertyCreationDescriptor > InOutCreationDescs
)

   StateTreeEditorData.h  

const FStateTreeEditorColor * FindColor ( const FStateTreeEditorColorRef& ColorRef
) const

 Attempts to find a Color matching the provided Color Key StateTreeEditorData.h  

void GetAccessibleStruct ( const TConstArrayView< const UStateTreeState* > Path,
const FGuid TargetStructID,
TArray< TInstancedStruct< FPropertyBindingBindableStructDescriptor > >& OutStructDescs
) const

   StateTreeEditorData.h  

void GetAccessibleStructsInExecutionPath ( const TConstArrayView< const UStateTreeState* > Path,
const FGuid TargetStructID,
TArray< TInstancedStruct< FPropertyBindingBindableStructDescriptor > >& OutStructDescs
) const

 Returns array of nodes along the execution path, up to the TargetStruct. StateTreeEditorData.h  

void GetAllStructValues ( TMap< FGuid, const FPropertyBindingDataView >& OutAllValues
) const

   StateTreeEditorData.h  

void GetAllStructValues ( TMap< FGuid, const FStateTreeDataView >& OutAllValues
) const

   StateTreeEditorData.h  

ExtensionType * GetExtension()

 Find the first extension of the requested type. StateTreeEditorData.h  

UStateTreeState * GetMutableStateByID ( const FGuid StateID
)

   StateTreeEditorData.h  

FText GetNodeDescription ( const FStateTreeEditorNode& Node,
const EStateTreeNodeFormatting Formatting
) const

 Returns the description for the node for UI. StateTreeEditorData.h  

FGuid GetRootParametersGuid()

   StateTreeEditorData.h  

virtual const FInstancedPropertyBag & GetRootParametersPropertyBag()

   StateTreeEditorData.h  

const UStateTreeState * GetStateByID ( const FGuid StateID
) const

   StateTreeEditorData.h  

const UStateTreeState * GetStateByStructID ( const FGuid TargetStructID
) const

   StateTreeEditorData.h  
Find the first extension of the requested type. StateTreeEditorData.h
  • BlueprintCallable
  • Category="StateTree|Extension"
  • Meta=(DisplayName="Get Extension", DeterminesOutputType="ExtensionType")

void OnParametersChanged ( const UStateTree& StateTree
)

   StateTreeEditorData.h  

void OnStateParametersChanged ( const UStateTree& StateTree,
const FGuid StateID
)

   StateTreeEditorData.h  

void ReparentStates()

   StateTreeEditorData.h  
Iterates over all structs that are related to binding. StateTreeEditorData.h  
Iterates over all structs at the global level (context, tree parameters, evaluators, global tasks) that are related to binding. StateTreeEditorData.h  

EStateTreeVisitor VisitHierarchy ( TFunctionRef< EStateTreeVisitor(UStateTreeState&State, UStateTreeState*ParentState)> InFunc
) const

 Iterates over all structs that are related to binding StateTreeEditorData.h  
Iterates over all structs in the state hierarchy that are related to binding. StateTreeEditorData.h  
Iterates over all nodes in a given state. StateTreeEditorData.h  

EStateTreeVisitor VisitStructBoundPropertyFunctions ( FGuid StructID,
const FString& StatePath,
TFunctionRef< EStateTreeVisitor(const FStateTreeEditorNode&EditorNode, const FStateTreeBindableStru...
) const

 Iterates recursively over all property functions of the provided node. Also nested ones. StateTreeEditorData.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void BeginDestroy()

   StateTreeEditorData.h  

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   StateTreeEditorData.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   StateTreeEditorData.h  

virtual void PostInitProperties()

   StateTreeEditorData.h  

virtual void PostLoad()

   StateTreeEditorData.h  

virtual void Serialize ( FArchive& Ar
)

   StateTreeEditorData.h  

Overridden from IStateTreeEditorPropertyBindingsOwner

Name Remarks Include Path Unreal Specifiers
Iterates over all template property function nodes. StateTreeEditorData.h  

virtual FStateTreeBindableStructDesc FindContextData ( const UStruct* ObjectType,
const FString ObjectNameHint
) const

 Finds a bindable context struct based on name and type. StateTreeEditorData.h  
  StateTreeEditorData.h  
  StateTreeEditorData.h  

Overridden from IPropertyBindingBindingCollectionOwner

Name Remarks Include Path Unreal Specifiers

virtual void AppendBindablePropertyFunctionStructs ( TArray< TInstancedStruct< FPropertyBindingBindableStructDescriptor > >& InOutStructs
) const

   StateTreeEditorData.h  

virtual bool CanCreateParameter ( const FGuid InStructID
) const

   StateTreeEditorData.h  

virtual void CreateParametersForStruct ( const FGuid InStructID,
TArrayView< UE::PropertyBinding::FPropertyCreationDescriptor > InOutCreationDescs
)

   StateTreeEditorData.h  

virtual bool GetBindableStructByID ( const FGuid StructID,
TInstancedStruct< FPropertyBindingBindableStructDescriptor >& OutStructDesc
) const

   StateTreeEditorData.h  

virtual void GetBindableStructs ( const FGuid TargetStructID,
TArray< TInstancedStruct< FPropertyBindingBindableStructDescriptor > >& OutStructDescs
) const

   StateTreeEditorData.h  

virtual bool GetBindingDataViewByID ( const FGuid StructID,
FPropertyBindingDataView& OutDataView
) const

   StateTreeEditorData.h  
  StateTreeEditorData.h  
  StateTreeEditorData.h  

virtual void OnPropertyBindingChanged ( const FPropertyBindingPath& InSourcePath,
const FPropertyBindingPath& InTargetPath
)

 Todo: (jira UE-337309) we have many sites that manipulate state/node which will change bindings, but not calling this function. Currently it is only called when you change binding from the details view StateTreeEditorData.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page