1. Epic GamesDeveloper
  3. UStateTreeEditorData

UStateTreeEditorData

Edit time data for StateTree asset.

API > API/Plugins > API/Plugins/StateTreeEditorModule

Inheritance Hierarchy

References

   
Module StateTreeEditorModule
Header /Engine/Plugins/Runtime/StateTree/Source/StateTreeEditorModule/Public/StateTreeEditorData.h
Include #include "StateTreeEditorData.h"

Syntax

UCLASS (BlueprintType, EditInlineNew, CollapseCategories)  
class UStateTreeEditorData :  
    public UObject ,  
    public IStateTreeEditorPropertyBindingsOwner

Remarks

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

Variables

  Type Name Description
Public variable UProperty Transient TArray< FStateTreeEditorBreakpoint > Breakpoints Transient list of breakpoints added in the debugging session.
Public variable UProperty Category, EditDefaultsOnly TSet< FStateTreeEditorColor > Colors Color Options to assign to a State
Public variable UProperty Meta FStateTreeEditorPropertyBindings EditorBindings  
Public variable UProperty Category, EditDefaultsOnly, Meta TArray< FStateTreeEditorNode > Evaluators  
Public variable UProperty Category, EditDefaultsOnly, Meta TArray< FStateTreeEditorNode > GlobalTasks  
Public variable UProperty Category, EditDefaultsOnly FStateTreeStateParameters RootParameters Public parameters that could be used for bindings within the Tree.
Public variable UProperty Category, EditDefaultsOnly instanced TObjectPtr< UStateTreeSchema > Schema Schema describing which inputs, evaluators, and tasks a StateTree can contain
Public variable UProperty TArray< TObjectPtr< UStateTreeState > > SubTrees Top level States.

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function TStateTreeEditorNode< T > &

AddEvaluator ( TArgs&&... InArgs
)

 Adds Evaluator of specified type.
Public function TStateTreeEditorNode< T > &

AddGlobalTask ( TArgs&&... InArgs
)

 Adds Global Task of specified type.
Public function void

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

 Adds property binding to PropertyFunction of provided type.
Public function PRAGMA_ENABLE_DEPRECATION_WARNINGS bool

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

 Adds property binding between two structs.
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS void  
Public function void

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

 Adds property binding between two structs.
Public function UStateTreeState & Adds new Subtree named "Root".
Public function UStateTreeState &

AddSubTree ( const FName Name
)

 Adds new Subtree with specified name.
Public function Virtual void

CreateParameters ( const FGuid StructID,
TArrayView< FStateTreeEditorPropertyCreationDesc > InOutCreationDescs
)

  
Public function Const const FStateTreeEditorColor *

FindColor ( const FStateTreeEditorColorRef& ColorRef
)

 Attempts to find a Color matching the provided Color Key
Public function Const void

GetAccessibleStructs ( const TConstArrayView< const UStateTreeState* > Path,
const FGuid TargetStructID,
TArray< FStateTreeBindableStructDesc >& OutStructDescs
)

 Returns array of nodes along the execution path, up to the TargetStruct.
Public function Const void

GetAllStructIDs ( TMap< FGuid, const UStruct* >& AllStructs
)

  
Public function Const void

GetAllStructValues ( TMap< FGuid, const FStateTreeDataView >& AllValues
)

  
Public function UStateTreeState *

GetMutableStateByID ( const FGuid StateID
)

  
Public function Const FText Returns the description for the node for UI.
Public function Const const UStateTreeState *

GetStateByID ( const FGuid StateID
)

  
Public function Const const UStateTreeState *

GetStateByStructID ( const FGuid TargetStructID
)

  
Public function void  
Public function void

OnParametersChanged ( const UStateTree& StateTree
)

  
Public function void

OnStateParametersChanged ( const UStateTree& StateTree,
const FGuid StateID
)

  
Public function void

OnUserDefinedStructReinstanced ( const UUserDefinedStruct& UserDefinedStruct
)

  
Public function void  
Public function Const EStateTreeVisitor Iterates over all structs that are related to binding.
Public function Const EStateTreeVisitor Iterates over all structs at the global level (context, tree parameters, evaluators, global tasks) that are related to binding.
Public function Const EStateTreeVisitor Iterates over all structs that are related to binding
Public function Const EStateTreeVisitor Iterates over all structs in the state hierarchy that are related to binding.
Public function Const void  
Public function Const EStateTreeVisitor Iterates over all nodes in a given state.
Public function Const EStateTreeVisitor  
Public function Const EStateTreeVisitor Iterates recursively over all property functions of the provided node. Also nested ones.

Overridden from UObject

  Type Name Description
Public function Virtual void Called before destroying the object.
Public function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Public function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Public function Virtual void Do any object-specific cleanup required immediately after loading an object.

Overridden from IStateTreeEditorPropertyBindingsOwner

  Type Name Description
Public function Virtual Const bool

CanCreateParameter ( const FGuid StructID
)

 Determines whether the struct matching the given struct id is capable of adding new properties
Public function Virtual Const EStateTreeVisitor  
Public function Virtual Const FStateTreeBindableStructDesc

FindContextData ( const UStruct* ObjectType,
const FString ObjectNameHint
)

 Finds a bindable context struct based on name and type.
Public function Virtual Const void

GetAccessibleStructs ( const FGuid TargetStructID,
TArray< FStateTreeBindableStructDesc >& OutStructDescs
)

 IStateTreeEditorPropertyBindingsOwner.
Public function Virtual Const bool

GetDataViewByID ( const FGuid StructID,
FStateTreeDataView& OutDataView
)

 Returns data view based on struct ID.
Public function Virtual Const const FStateTreeEditorPropertyBindings *  
Public function Virtual FStateTreeEditorPropertyBindings *  
Public function Virtual Const bool

GetStructByID ( const FGuid StructID,
FStateTreeBindableStructDesc& OutStructDesc
)

 Returns struct descriptor based on struct ID.

Typedefs

Name Description
FReplacementObjectMap  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page