Navigation
API > API/Plugins > API/Plugins/StateGraph
Abstract base class for all nodes in the state graph.
| Name | FStateGraphNode |
| Type | class |
| Header File | /Engine/Plugins/Experimental/StateGraph/Source/StateGraph/Public/StateGraph.h |
| Include Path | #include "StateGraph.h" |
Syntax
class FStateGraphNode :
public TSharedFromThis< FStateGraphNode >,
public FNoncopyable
Inheritance Hierarchy
- TSharedFromThis< FStateGraphNode > → FStateGraphNode
- FNoncopyable → FStateGraphNode
Derived Classes
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FStateGraphNode
(
FName InName |
StateGraph.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~FStateGraphNode() |
StateGraph.h |
Enums
Public
| Name | Remarks |
|---|---|
| EStatus |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| Dependencies | TSet< FName > | StateGraph.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| CompletedTime | FDateTime | StateGraph.h | ||
| ConfigSectionName | FString | StateGraph.h | ||
| FStateGraph | friend | StateGraph.h | ||
| LogName | FString | StateGraph.h | ||
| Name | FName | StateGraph.h | ||
| StartTime | FDateTime | StateGraph.h | ||
| StateGraphWeakPtr | FStateGraphWeakPtr | StateGraph.h | ||
| Status | EStatus | StateGraph.h | ||
| Timeout | double | StateGraph.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool CheckDependencies () |
Returns true if all dependencies are met and the node can be started. | StateGraph.h | |
virtual void Complete() |
Set Status to Completed and notify the state graph to start other nodes which may have been blocked on this node. | StateGraph.h | |
FDateTime GetCompletedTime() |
StateGraph.h | ||
double GetDuration() |
Get duration of time that the node has taken to run. Returns 0 if not yet started. | StateGraph.h | |
const FString & GetLogName() |
StateGraph.h | ||
FName GetName() |
Get the name of the node. | StateGraph.h | |
FDateTime GetStartTime() |
StateGraph.h | ||
FStateGraphPtr GetStateGraph() |
Get the state graph for this node, which may be invalid if this node has not been added or was removed. | StateGraph.h | |
EStatus GetStatus() |
Get the status of the node. | StateGraph.h | |
const TCHAR * GetStatusName () |
Get the status of the node as a string. | StateGraph.h | |
double GetTimeout() |
Get timeout in seconds. | StateGraph.h | |
TSharedPtr< NodeType, ESPMode::ThreadSafe > Next
(
ArgsTypes&&... Args |
Helper function to create a new node, add it to this node's StateGraph, and add this node as a dependency. | StateGraph.h | |
FStateGraphNodeFunctionPtr Next
(
ArgsTypes&&... Args |
StateGraph.h | ||
virtual void Reset () |
Reset this node to NotStarted so it is run again. | StateGraph.h | |
void SetTimeout
(
double InTimeout |
Set timeout in seconds from when Start is run until Complete is run. | StateGraph.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
const FString & GetConfigSectionName() |
Get the name of the node. | StateGraph.h | |
virtual void Removed() |
Node was removed from the state graph. Override to cleanup up any state or pending async tasks. | StateGraph.h | |
void Start() |
Start this node. | StateGraph.h | |
virtual void TimedOut () |
Node timed out. | StateGraph.h | |
virtual void UpdateConfig () |
Update config from INI files. | StateGraph.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static const TCHAR * GetStatusName
(
EStatus Status |
StateGraph.h |