Interface IProviderNode

Interface for any node that provides (gives) data. In other words, any node that has one more out ports.

Inherited Members
Namespace: InsaneScatterbrain.ScriptGraph
Syntax
public interface IProviderNode : IScriptNode, INode

Properties

OutPorts

Gets all the out ports.

Declaration
ReadOnlyCollection<OutPort> OutPorts { get; }
Property Value
Type Description
System.Collections.ObjectModel.ReadOnlyCollection<T><OutPort>

Methods

GetOutPort(string)

Returns the out port with the given name.

Declaration
OutPort GetOutPort(string name)
Parameters
Type Name Description
string name

The name.
Returns
Type Description
OutPort

The out port.

HasOutPort(string)

Returns whether the out port with the given name exists on the node.

Declaration
bool HasOutPort(string name)
Parameters
Type Name Description
string name

The name.
Returns
Type Description
bool

True if the port exists, false otherwise.

MoveOut(int, int)

Move the out port to a different index

Declaration
void MoveOut(int oldIndex, int newIndex)
Parameters
Type Name Description
int oldIndex

The port's old index.
int newIndex

The port's new index.

OnLoadOutputPorts()

This method should contain all the out port initialization code. In other words, it should contain all the AddOut calls for the node.

Declaration
void OnLoadOutputPorts()

RemoveOut(string)

Removes the out port with the given name from the node.

Declaration
void RemoveOut(string name)
Parameters
Type Name Description
string name

The port's name.

RenameOut(string, string)

Renames the out port.

Declaration
void RenameOut(string oldName, string newName)
Parameters
Type Name Description
string oldName

The port's old name.
string newName

The port's new name.

Events

OnOutPortAdded

Event is triggered everytime an out port is added to the node.

Declaration
event Action<OutPort> OnOutPortAdded
Event Type
Type Description
System.Action<T><OutPort>

OnOutPortMoved

Event is triggered everytime an out port is moved.

Declaration
event Action<OutPort, int> OnOutPortMoved
Event Type
Type Description
System.Action<T1, T2><OutPort, int>

OnOutPortRemoved

Event is triggered everytime an out port is removed from the node.

Declaration
event Action<OutPort> OnOutPortRemoved
Event Type
Type Description
System.Action<T><OutPort>

OnOutPortRenamed

Event is triggered everytime an out port is renamed.

Declaration
event Action<OutPort, string, string> OnOutPortRenamed
Event Type
Type Description
System.Action<T1, T2, T3><OutPort, string, string>