1. Epic GamesDeveloper
  3. FStateTreeNodeBase

FStateTreeNodeBase

Base struct of StateTree Conditions, Considerations, Evaluators, and Tasks.

API > API/Plugins > API/Plugins/StateTreeModule

Inheritance Hierarchy

References

   
Module StateTreeModule
Header /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeNodeBase.h
Include #include "StateTreeNodeBase.h"

Syntax

USTRUCT ()  
struct FStateTreeNodeBase

Remarks

Base struct of StateTree Conditions, Considerations, Evaluators, and Tasks.

Variables

  Type Name Description
Public variable UProperty FStateTreeIndex16 BindingsBatch Property binding copy batch handle.
Public variable UProperty FStateTreeDataHandle InstanceDataHandle Data handle to access the instance data.
Public variable UProperty FStateTreeIndex16 InstanceTemplateIndex Index of template instance data for the node.
Public variable UProperty Category, EditDefaultsOnly, Meta FName Name Name of the node.

Constructors

  Type Name Description
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS  
Public function    
Public function    

Destructors

  Type Name Description
Public function Virtual PRAGMA_ENABLE_DEPRECATION_WARNINGS  

Functions

  Type Name Description
Public function Virtual EDataValidationResult

Compile ( FStateTreeDataView InstanceDataView,
TArray< FText >& ValidationMessages
)

 Called during State Tree compilation, allows to modify and validate the node and instance data.
Public function Virtual Const PRAGMA_ENABLE_DEPRECATION_WARNINGS FText

GetDescription ( const FGuid& ID,
FStateTreeDataView InstanceDataView,
const IStateTreeBindingLookup& BindingLookup,
EStateTreeNodeFormatting Formatting
)

 Returns description for the node, use in the UI.
Public function Virtual Const FColor  
Public function Virtual Const FName  
Public function Virtual Const const UStruct *  
Public function Virtual bool

Link ( FStateTreeLinker& Linker
)

 Called when the StateTree asset is linked. Allows to resolve references to other StateTree data.
Public function Virtual void

OnBindingChanged ( const FGuid& ID,
FStateTreeDataView InstanceDataView,
const FStateTreePropertyPath& SourcePath,
const FStateTreePropertyPath& TargetPath,
const IStateTreeBindingLookup& BindingLookup
)

 Called when binding of any of the properties in the node changes.
Public function Virtual PRAGMA_DISABLE_DEPRECATION_WARNINGS void

OnBindingChanged ( const FGuid& ID,
FStateTreeDataView InstanceData,
const FStateTreeEditorPropertyPath& SourcePath,
const FStateTreeEditorPropertyPath& TargetPath,
const IStateTreeBindingLookup& BindingLookup
)

  
Public function Virtual void

PostEditInstanceDataChangeChainProperty ( const FPropertyChangedChainEvent& PropertyChangedEvent,
FStateTreeDataView InstanceDataView
)

 Called when a property of node's instance data has been modified externally
Public function Virtual void

PostEditNodeChangeChainProperty ( const FPropertyChangedChainEvent& PropertyChangedEvent,
FStateTreeDataView InstanceDataView
)

 Called when a property of the node has been modified externally
Public function Virtual void

PostLoad ( FStateTreeDataView InstanceDataView
)

 Called after the state tree asset that contains this node is loaded from disk.

Operators

  Type Name Description
Public function FStateTreeNodeBase &  
Public function FStateTreeNodeBase &  

Deprecated Variables

  Type Name Description
Public variable UProperty uint8: 1 bInstanceIsObject_DEPRECATED  
Public variable UProperty FStateTreeIndex16 DataViewIndex_DEPRECATED  
Public variable UProperty FStateTreeIndex16 InstanceIndex_DEPRECATED  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page