Class ScriptGraphGraph

This class contains all the data of a script graph. The nodes, connections, parameters, etc.

Inheritance
System.Object
VersionedScriptableObject
ScriptGraphGraph
MapGraphGraph
Implements
Inherited Members
Namespace: InsaneScatterbrain.ScriptGraph
Syntax
public class ScriptGraphGraph : VersionedScriptableObject, IVersioned

Properties

ConsumerNodes

Gets all the graph's consumer nodes.

Declaration
public ReadOnlyCollection<IConsumerNode> ConsumerNodes { get; }
Property Value
Type Description
ReadOnlyCollection<IConsumerNode>

Id

Declaration
public string Id { get; }
Property Value
Type Description
System.String

InputNodes

Gets all the graph's input nodes.

Declaration
public ReadOnlyCollection<InputNode> InputNodes { get; }
Property Value
Type Description
ReadOnlyCollection<InputNode>

InputParameters

Declaration
public ScriptGraphParameters InputParameters { get; }
Property Value
Type Description
ScriptGraphParameters

Nodes

Gets all the graph's nodes.

Declaration
public ReadOnlyCollection<IScriptNode> Nodes { get; }
Property Value
Type Description
ReadOnlyCollection<IScriptNode>

OutputNodes

Gets all the graph's output nodes.

Declaration
public ReadOnlyCollection<OutputNode> OutputNodes { get; }
Property Value
Type Description
ReadOnlyCollection<OutputNode>

OutputParameters

Declaration
public ScriptGraphParameters OutputParameters { get; }
Property Value
Type Description
ScriptGraphParameters

Processor

Gets/sets the processor currently processing this graph.

Declaration
public ScriptGraphProcessor Processor { get; set; }
Property Value
Type Description
ScriptGraphProcessor

ProcessorNodes

Gets all the graph's processor nodes.

Declaration
public ReadOnlyCollection<IProcessorNode> ProcessorNodes { get; }
Property Value
Type Description
ReadOnlyCollection<IProcessorNode>

SortedProcessorNodes

Gets all the graph's processor nodes in the order they should be processed in.

Declaration
public ReadOnlyCollection<IProcessorNode> SortedProcessorNodes { get; }
Property Value
Type Description
ReadOnlyCollection<IProcessorNode>

Methods

Add(IScriptNode)

Add the given node to the graph.

Declaration
public void Add(IScriptNode node)
Parameters
Type Name Description
IScriptNode node

The node to add.

RegisterDependencies(DependencyContainer)

Declaration
public virtual void RegisterDependencies(DependencyContainer container)
Parameters
Type Name Description
DependencyContainer container

Remove(IScriptNode)

Remove the given node from the graph.

Declaration
public void Remove(IScriptNode node)
Parameters
Type Name Description
IScriptNode node

RemoveInputParameterNodes(String)

Remove the input parameter with given name from the graph.

Declaration
public void RemoveInputParameterNodes(string parameterId)
Parameters
Type Name Description
System.String parameterId

The input parameters name.

RemoveOutputParameterNodes(String)

Remove the output parameter with given name from the graph.

Declaration
public void RemoveOutputParameterNodes(string parameterId)
Parameters
Type Name Description
System.String parameterId

The output parameters name.

Sort()

Sorts the graph so that processor nodes are processed in the right order, i.e. a node will never be processed before the processor nodes it receiving input from.

Declaration
public void Sort()

Events

OnEnabled

Global event that's called every time a script graph has been enabled.

Declaration
public static event Action<ScriptGraphGraph> OnEnabled
Event Type
Type Description
Action<ScriptGraphGraph>

OnScriptNodeAdded

Declaration
public event Action<IScriptNode> OnScriptNodeAdded
Event Type
Type Description
Action<IScriptNode>

OnScriptNodeRemoved

Declaration
public event Action<IScriptNode> OnScriptNodeRemoved
Event Type
Type Description
Action<IScriptNode>

Implements