Navigation
API > API/Plugins > API/Plugins/StateTreeModule
Inheritance Hierarchy
- FStateTreeNodeBase
- FStateTreePropertyFunctionBase
- FStateTreePropertyFunctionCommonBase
References
| Module | StateTreeModule |
| Header | /Engine/Plugins/Runtime/StateTree/Source/StateTreeModule/Public/StateTreePropertyFunctionBase.h |
| Include | #include "StateTreePropertyFunctionBase.h" |
Syntax
USTRUCT (Meta=(Hidden))
struct FStateTreePropertyFunctionBase : public FStateTreeNodeBase
Remarks
Base struct for all property functions. PropertyFunction is a node which is executed just before evaluating owner's bindings.
The property function's instance data is expected to have one property marked as output. This property is used to find which properties the function can be used for, and that property is hidden in the UI. It is expected that there's just one output property.
Example:
USTRUCT() struct FStateTreeBooleanOperationPropertyFunctionInstanceData {
bool bLeft = false;
bool bRight = false;
// This property is used to find which properties the function can be used for.
bool bResult = false; };
Functions
| Type | Name | Description | |
|---|---|---|---|
| void | Execute
(
FStateTreeExecutionContext& Context |
Called right before evaluating bindings for the owning node. |
Overridden from FStateTreeNodeBase
| Type | Name | Description | |
|---|---|---|---|
| FColor | GetIconColor () |
||
| FName | GetIconName () |