Navigation
API > API/Plugins > API/Plugins/StateTreeModule
Base struct of StateTree Conditions, Considerations, Evaluators, and Tasks.
| Name | FStateTreeNodeBase |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreeNodeBase.h |
| Include Path | #include "StateTreeNodeBase.h" |
Syntax
USTRUCT ()
struct FStateTreeNodeBase
Derived Classes
FStateTreeNodeBase derived class hierarchy
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| StateTreeNodeBase.h | |||
PRAGMA_DISABLE_DEPRECATION_WARNINGS FStateTreeNodeBase () |
StateTreeNodeBase.h | ||
FStateTreeNodeBase
(
const FStateTreeNodeBase& |
StateTreeNodeBase.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FStateTreeNodeBase() |
StateTreeNodeBase.h |
Structs
| Name | Remarks |
|---|---|
| FNoInstanceDataType |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| FExecutionRuntimeDataType | FNoInstanceDataType | The execution runtime data type. | StateTreeNodeBase.h |
| FInstanceDataType | FNoInstanceDataType | The instance data type. | StateTreeNodeBase.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BindingsBatch | FStateTreeIndex16 | Property binding copy batch handle. | StateTreeNodeBase.h | |
| ExecutionRuntimeTemplateIndex | FStateTreeIndex16 | Index of template execution runtime data for the node. | StateTreeNodeBase.h | |
| InstanceDataHandle | FStateTreeDataHandle | Data handle to access the instance data. | StateTreeNodeBase.h | |
| InstanceTemplateIndex | FStateTreeIndex16 | Index of template instance data for the node. | StateTreeNodeBase.h | |
| Name | FName | Name of the node. | StateTreeNodeBase.h |
|
| OutputBindingsBatch | FStateTreeIndex16 | Property output binding copy batch handle. | StateTreeNodeBase.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual EDataValidationResult Compile
(
UE::StateTree::ICompileNodeContext& CompileContext |
Called during State Tree compilation, allows to modify and validate the node and instance data. | StateTreeNodeBase.h | |
virtual EDataValidationResult Compile
(
FStateTreeDataView InstanceDataView, |
Called during State Tree compilation, allows to modify and validate the node and instance data. | StateTreeNodeBase.h | |
virtual FText GetDescription
(
const FGuid& ID, |
Returns description for the node, use in the UI. | StateTreeNodeBase.h | |
virtual const UStruct * GetExecutionRuntimeDataType () |
Execution runtime data is always valid between an FStateTreeExecutionContext::Start and FStateTreeExecutionContext::Stop. | StateTreeNodeBase.h | |
virtual FColor GetIconColor() |
StateTreeNodeBase.h | ||
virtual FName GetIconName() |
StateTreeNodeBase.h | ||
virtual const UStruct * GetInstanceDataType() |
StateTreeNodeBase.h | ||
virtual bool Link
(
FStateTreeLinker& Linker |
Called when the StateTree asset is linked. Allows to resolve references to other StateTree data. | StateTreeNodeBase.h | |
virtual void OnBindingChanged
(
const FGuid& ID, |
StateTreeNodeBase.h | ||
virtual void OnBindingChanged
(
const FGuid& ID, |
Called when binding of any of the properties in the node changes. | StateTreeNodeBase.h | |
virtual void PostEditInstanceDataChangeChainProperty
(
const FPropertyChangedChainEvent& PropertyChangedEvent, |
Called when a property of node's instance data has been modified externally | StateTreeNodeBase.h | |
virtual void PostEditNodeChangeChainProperty
(
const FPropertyChangedChainEvent& PropertyChangedEvent, |
Called when a property of the node has been modified externally | StateTreeNodeBase.h | |
virtual void PostLoad
(
FStateTreeDataView InstanceDataView |
Called after the state tree asset that contains this node is loaded from disk. | StateTreeNodeBase.h |
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| StateTreeNodeBase.h | |||
FStateTreeNodeBase & operator=
(
const FStateTreeNodeBase& |
StateTreeNodeBase.h |