Class ScriptGraphProcessor
This class processes the processor nodes in the correct order.
Inheritance
object
ScriptGraphProcessor
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Syntax
[Serializable]
public class ScriptGraphProcessor
Properties
AutoDispose
Declaration
public bool AutoDispose { get; set; }
Property Value
ComponentDependencies
Declaration
public List<ComponentDependency> ComponentDependencies { get; set; }
Property Value
CustomDependencies
Declaration
public DependencyContainer CustomDependencies { get; }
Property Value
Disposer
Declaration
public Disposer Disposer { get; set; }
Property Value
Graph
Gets/sets the graph to process.
Declaration
public ScriptGraphGraph Graph { get; set; }
Property Value
InstanceProvider
Declaration
public IInstanceProvider InstanceProvider { get; set; }
Property Value
IsAborted
Declaration
public bool IsAborted { get; }
Property Value
IsMainThreadTimePerFrameLimitEnabled
Declaration
public bool IsMainThreadTimePerFrameLimitEnabled { get; set; }
Property Value
IsMultiThreadingEnabled
Declaration
public bool IsMultiThreadingEnabled { get; set; }
Property Value
IsProcessing
Gets whether the processor is currently processing a graph or not.
Declaration
public bool IsProcessing { get; }
Property Value
IsSeedRandom
Gets/sets whether a random RNG seed is used or the one set in seed property.
Declaration
public bool IsSeedRandom { get; set; }
Property Value
Rng
Declaration
[Obsolete("Will be removed in version 2.0. Check the manual page about custom nodes to see how to access dependencies, such as the Rng object.")]
public Rng Rng { get; }
Property Value
RngStartState
Declaration
public RngState? RngStartState { get; set; }
Property Value
ScriptGraphInstanceProvider
Declaration
public IScriptGraphInstanceProvider ScriptGraphInstanceProvider { get; set; }
Property Value
Seed
Declaration
public int Seed { get; set; }
Property Value
SeedGuid
Declaration
public string SeedGuid { get; set; }
Property Value
SeedType
Declaration
public SeedType SeedType { get; set; }
Property Value
Methods
Cancel()
Declaration
ContainsInParameterId(string)
Declaration
public bool ContainsInParameterId(string id)
Parameters
| Type |
Name |
Description |
| string |
id |
|
Returns
FlagInUnconnected(string)
Flags the given in parameter as unconnected.
Declaration
public void FlagInUnconnected(string id)
Parameters
| Type |
Name |
Description |
| string |
id |
The input parameters ID.
|
Get<T>()
Declaration
public static T Get<T>() where T : class
Returns
Type Parameters
GetConsumerNodes()
Declaration
public IEnumerable<IConsumerNode> GetConsumerNodes()
Returns
| Type |
Description |
| System.Collections.Generic.IEnumerable<T><IConsumerNode> |
|
GetInParameterId(string)
Declaration
public string GetInParameterId(string inName)
Parameters
| Type |
Name |
Description |
| string |
inName |
|
Returns
GetInParameterIds()
Declaration
public IEnumerable<string> GetInParameterIds()
Returns
| Type |
Description |
| System.Collections.Generic.IEnumerable<T><string> |
|
GetInParameterName(string)
Declaration
public string GetInParameterName(string id)
Parameters
| Type |
Name |
Description |
| string |
id |
|
Returns
GetInParameterType(string)
Declaration
public Type GetInParameterType(string id)
Parameters
| Type |
Name |
Description |
| string |
id |
|
Returns
| Type |
Description |
| System.Type |
|
In(string, Func<object>)
Set input providers for the given input parameter.
Declaration
public void In(string name, Func<object> value)
Parameters
| Type |
Name |
Description |
| string |
name |
The parameter name.
|
| System.Func<TResult><object> |
value |
Input provider.
|
In<T>(string, Func<T>)
Declaration
public void In<T>(string name, Func<T> value)
Parameters
| Type |
Name |
Description |
| string |
name |
|
| System.Func<TResult><T> |
value |
|
Type Parameters
Process(ScriptGraphGraph, DependencyContainer)
Processes the given graph.
Declaration
public Dictionary<string, object> Process(ScriptGraphGraph graphToProcess = null, DependencyContainer customDependencies = null)
Parameters
| Type |
Name |
Description |
| ScriptGraphGraph |
graphToProcess |
The graph to process.
|
| DependencyContainer |
customDependencies |
Optional parameter to add optional dependencies that custom nodes may depend on.
|
Returns
| Type |
Description |
| System.Collections.Generic.Dictionary<TKey, TValue><string, object> |
The values for each output parameter.
|
Exceptions
| Type |
Condition |
| System.InvalidOperationException |
InvalidOperationException is thrown if the graph is already processing.
|
RegisterGlobalDependency(Type, Func<object>)
Declaration
public static void RegisterGlobalDependency(Type type, Func<object> dependency)
Parameters
| Type |
Name |
Description |
| System.Type |
type |
|
| System.Func<TResult><object> |
dependency |
|
RegisterGlobalDependency<T>(Func<T>)
Declaration
public static void RegisterGlobalDependency<T>(Func<T> dependency) where T : class
Parameters
| Type |
Name |
Description |
| System.Func<TResult><T> |
dependency |
|
Type Parameters
SetGraph(ScriptGraphGraph)
Declaration
public void SetGraph(ScriptGraphGraph setGraph)
Parameters
Unprepare()
Declaration
Events
OnProcess
Global event that's called each time a script graph is about to be processed by any script graph processor.
Declaration
public static event Action<ScriptGraphProcessor> OnProcess
Event Type
OnProgress
Declaration
public event Action<int, int> OnProgress
Event Type
| Type |
Description |
| System.Action<T1, T2><int, int> |
|