Navigation
API > API/Plugins > API/Plugins/StateGraph
Inheritance Hierarchy
- TSharedFromThis
- FNoncopyable
- FStateGraphNode
- FStateGraphNodeFunction
References
| Module | StateGraph |
| Header | /Engine/Plugins/Experimental/StateGraph/Source/StateGraph/Public/StateGraph.h |
| Include | #include "StateGraph.h" |
Syntax
class FStateGraphNode :
public TSharedFromThis< FStateGraphNode > ,
public FNoncopyable
Remarks
Abstract base class for all nodes in the state graph.
Variables
Constructors
| Type | Name | Description | |
|---|---|---|---|
FStateGraphNode
(
FName InName |
Destructors
| Type | Name | Description | |
|---|---|---|---|
Functions
| Type | Name | Description | |
|---|---|---|---|
| bool | Returns true if all dependencies are met and the node can be started. | ||
| void | Complete () |
Set Status to Completed and notify the state graph to start other nodes which may have been blocked on this node. | |
| const FString & | Get the name of the node. | ||
| const FString & | |||
| double | GetDuration () |
Get duration of time that the node has taken to run. Returns 0 if not yet started. | |
| FName | GetName () |
Get the name of the node. | |
| FStateGraphPtr | Get the state graph for this node, which may be invalid if this node has not been added or was removed. | ||
| EStatus | GetStatus () |
Get the status of the node. | |
| const TCHAR * | GetStatusName
(
EStatus Status |
||
| const TCHAR * | Get the status of the node as a string. | ||
| double | GetTimeout () |
Get timeout in seconds. | |
| 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. | |
| FStateGraphNodeFunctionPtr | Next
(
ArgsTypes&&... Args |
||
| void | Removed () |
Node was removed from the state graph. Override to cleanup up any state or pending async tasks. | |
| void | Reset () |
Reset this node to NotStarted so it is run again. | |
| void | SetTimeout
(
double InTimeout |
Set timeout in seconds from when Start is run until Complete is run. | |
| void | Start () |
Start this node. | |
| void | TimedOut () |
Node timed out. | |
| void | UpdateConfig () |
Update config from INI files. |
Enums
| Type | Name | Description | |
|---|---|---|---|
| EStatus |