Class ScriptGraphRunner

The script graph runner is a component that acts as a wrapper for the script graph processor, so that it can be run easily in the editor or at runtime without writing any additional code.

Inheritance

System.Object

VersionedMonoBehaviour

ScriptGraphMonoBehaviour

ScriptGraphRunner

Implements

IVersioned

Inherited Members

ScriptGraphMonoBehaviour.DefaultVersion

VersionedMonoBehaviour.Version

VersionedMonoBehaviour.Reset()

Namespace: InsaneScatterbrain.ScriptGraph

Syntax

public class ScriptGraphRunner : ScriptGraphMonoBehaviour, IVersioned

Properties

Graph

Declaration

public ScriptGraphGraph Graph { get; }

Property Value

Type	Description
ScriptGraphGraph

GraphProcessor

Gets the graph processor.

Declaration

public ScriptGraphProcessor GraphProcessor { get; }

Property Value

Type	Description
ScriptGraphProcessor

IsRunning

Declaration

public bool IsRunning { get; }

Property Value

Type	Description
System.Boolean

LatestResult

Declaration

public IReadOnlyDictionary<string, object> LatestResult { get; }

Property Value

Type	Description
IReadOnlyDictionary<System.String, System.Object>

MainThreadTimePerFrameLimitEnabled

Declaration

public bool MainThreadTimePerFrameLimitEnabled { get; }

Property Value

Type	Description
System.Boolean

RunAsynchronously

Declaration

public bool RunAsynchronously { get; }

Property Value

Type	Description
System.Boolean

Methods

GetIn(String)

Declaration

public object GetIn(string inName)

Parameters

Type	Name	Description
System.String	inName

Returns

Type	Description
System.Object

GetIn<T>(String)

Gets the current value for the parameter associated with the given name.

Declaration

public T GetIn<T>(string inName)

Parameters

Type	Name	Description
System.String	inName	The parameters name.

Returns

Type	Description
T	The value.

Type Parameters

Name	Description
T	The parameter's type.

Run()

Runs the script graph processor. If run asynchronously is true, it will run its own thread (with the exception if Unity API stuff of course). It will run on synchronously on the main thread otherwise.

Declaration

public void Run()

RunAsync()

Runs the script graph processor asynchronously.

Declaration

public void RunAsync()

RunSync()

Runs the script graph processor synchronously.

Declaration

public void RunSync()

SetIn(String, Object)

Sets the value for the parameter associated with the given name.

Declaration

public void SetIn(string inName, object value)

Parameters

Type	Name	Description
System.String	inName	The parameter's name.
System.Object	value	The value.

SetInById(String, Object)

Declaration

public void SetInById(string id, object value)

Parameters

Type	Name	Description
System.String	id
System.Object	value

SetIsSeedRandom(Boolean)

Sets whether or not the RNG seed is randomized.

Declaration

public void SetIsSeedRandom(bool isSeedRandom)

Parameters

Type	Name	Description
System.Boolean	isSeedRandom	Whether the seed is random.

SetStaticSeed(Int32)

Sets a static seed on the graph processor.

Declaration

public void SetStaticSeed(int seed)

Parameters

Type	Name	Description
System.Int32	seed	The RNG seed.

SetStaticSeed(String)

Sets a static seed on the graph processor.

Declaration

public void SetStaticSeed(string seed)

Parameters

Type	Name	Description
System.String	seed	The RNG seed.

Events

OnChecksFailed

Global event that's called whenever checks fail when a graph is ran by any script graph runner.

Declaration

public static event Action<ScriptGraphRunner, IEnumerable<IScriptNode>> OnChecksFailed

Event Type

Type	Description
Action<ScriptGraphRunner, IEnumerable<IScriptNode>>

OnError

Event that is triggered each time the script graph processor fails processing.

Declaration

public event Action OnError

Event Type

Type	Description
Action

OnProcessed

Event that is triggered each time the script graph processor is done processing.

Declaration

public event Action<IReadOnlyDictionary<string, object>> OnProcessed

Event Type

Type	Description
Action<IReadOnlyDictionary<System.String, System.Object>>

OnProgress

Declaration

public event Action<int, int> OnProgress

Event Type

Type	Description
Action<System.Int32, System.Int32>

OnRun

Global event that's called whenever a graph runner is about to run.

Declaration

public static event Action<ScriptGraphRunner> OnRun

Event Type

Type	Description
Action<ScriptGraphRunner>

OnStop

Global event that's called whenever a graph is stopped, finishing successfully or otherwise.

Declaration

public static event Action<ScriptGraphRunner> OnStop

Event Type

Type	Description
Action<ScriptGraphRunner>

Implements

IVersioned