1. Epic GamesDeveloper
  3. FStateGraph

FStateGraph

State graph class to run and manage nodes with.

API > API/Plugins > API/Plugins/StateGraph

Inheritance Hierarchy

References

   
Module StateGraph
Header /Engine/Plugins/Experimental/StateGraph/Source/StateGraph/Public/StateGraph.h
Include #include "StateGraph.h"

Syntax

class FStateGraph :  
    public TSharedFromThis< FStateGraph > ,  
    public FNoncopyable

Remarks

State graph class to run and manage nodes with.

Variables

  Type Name Description
Protected variable bool bRunAgain  
Protected variable bool bRunning  
Protected variable double CompletedTime  
Protected variable FString ConfigSectionName  
Protected variable FDelegateHandle ConfigSectionsChangedDelegate  
Protected variable FString ContextName  
Protected variable FName Name  
Protected variable TMap< FName, FStateGraphNodeRef > Nodes  
Public variable FNodeStatusChanged OnNodeStatusChanged  
Public variable FStatusChanged OnStatusChanged  
Protected variable double StartTime  
Protected variable EStatus Status  
Protected variable double Timeout  
Protected variable FTSTicker::FDelegateHandle TimeoutTicker  

Constructors

  Type Name Description
Public function  

FStateGraph ( FName InName,
const FString& InContextName
)

  

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool

AddDependencies ( FName NodeName,
const TArrayView< const FName > Dependencies
)

 Helper function for adding dependencies to a node.
Public function bool

AddNode ( const FStateGraphNodeRef& Node
)

 Add a node to the state graph.
Public function TEnableIf< TIsClass< ObjectType >::Value &&TIsInvocable< FunctionType, FStateGraph &, FStateGraphNod...

CreateNode ( FName NodeName,
ObjectType* Object,
FunctionType Function,
ArgsTypes&&... Args
)

 Create a new function node for lambdas tied to objects.
Public function TEnableIf< TIsClass< ObjectType >::Value &&TIsInvocable< FunctionType, ObjectType, FStateGraph &, FS...

CreateNode ( FName NodeName,
ObjectType* Object,
FunctionType Function,
ArgsTypes&&... Args
)

 Create a new function node for member functions.
Public function TEnableIf< TIsInvocable< FunctionType, FStateGraph &, FStateGraphNodeFunctionComplete, ArgsTypes... ...

CreateNode ( FName NodeName,
FunctionType Function,
ArgsTypes&&... Args
)

 Create a new function node for lambas and static methods.
Public function TSharedRef< NodeType, ESPMode::ThreadSafe >

CreateNode ( ArgsTypes&&... Args
)

 Create and add a new node for a given node class type.
Public function Const const FString &  
Public function Const double Get duration of time that the state graph has taken to run. Returns 0 if not yet started.
Public function Const FName

GetName ()

 Get the name of the state graph.
Public function TSharedPtr< NodeType, ESPMode::ThreadSafe >

GetNode ( FName NodeName
)

 Get a node from the state graph, casting to a derived type if needed.
Public function FStateGraphNodeRef *

GetNodeRef ( FName NodeName
)

 Get a node from the state graph. References should not be cached in case the node is destroyed.
Public function Const EStatus Get the status of the state graph.
Public function Static const TCHAR *

GetStatusName ( EStatus Status
)

  
Public function Const const TCHAR * Get the status of the state graph as a string.
Public function Const double Get timeout in seconds.
Public function void Perform state graph initialization that could not run in constructor due to shared pointers not being ready, such as registering for hotfixes.
Public function void Log debug info for the state graph and each node.
Protected function void

OnConfigSectionsChanged ( const FString& IniFilename,
const TSet< FString >& SectionNames
)

 Callback to update state graph and node configuration during hotfixes.
Public function void

Pause ()

 Pause the state graph and prevent additional nodes from being started.
Public function void Remove all nodes from the state graph that exist when this function is started.
Public function bool

RemoveNode ( FName NodeName
)

 Remove a node from the state graph.
Public function void

Reset ()

 Stop and reset the state graph and all nodes.
Public function void

Run ()

 Run the state graph.
Protected function void

SetStatus ( EStatus NewStatus
)

 Set status and fire delegate if needed.
Public function void

SetTimeout ( double InTimeout
)

 Set timeout in seconds from the initial run call (when Status changes from NotStarted to Running) to when Status changes to Completed.
Protected function void Update config from INI files. Called from Initialize and during hotfixes.

Enums

  Type Name Description
Public enum EStatus    

Typedefs

Name Description
FNodeStatusChanged Delegate fired when a node status changes.
FStatusChanged Delegate fired when the state graph status changes.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page