Class Unit
Assembly: solution.dll
Syntax
[SerializationVersionAttribute]
public abstract class Unit : GraphElement<FlowGraph>, IUnit, IGraphElementWithDebugData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IAnalyticsIdentifiable
Constructors
Unit()
Declaration
Properties
canDefine
Gets a value indicating whether this unit can be defined.
Declaration
[DoNotSerializeAttribute]
public virtual bool canDefine { get; }
Property Value
connections
Gets all connections associated with this unit.
Declaration
[DoNotSerializeAttribute]
public IEnumerable<IUnitConnection> connections { get; }
Property Value
Gets the collection of control input ports for this unit.
Declaration
[DoNotSerializeAttribute]
public IUnitPortCollection<ControlInput> controlInputs { get; }
Property Value
controlOutputs
Gets the collection of control output ports for this unit.
Declaration
[DoNotSerializeAttribute]
public IUnitPortCollection<ControlOutput> controlOutputs { get; }
Property Value
defaultValues
Gets a dictionary of default values used by the unit.
The keys represent port names, and the values represent their corresponding defaults.
Declaration
[SerializeAttribute]
public Dictionary<string, object> defaultValues { get; }
Property Value
| Type |
Description |
| Dictionary<string, object> |
|
definitionException
Gets the exception that occurred during the definition process, if the unit failed to define.
Declaration
[DoNotSerializeAttribute]
public Exception definitionException { get; protected set; }
Property Value
| Type |
Description |
| Exception |
|
failedToDefine
Gets a value indicating whether this unit failed to define.
Declaration
[DoNotSerializeAttribute]
public bool failedToDefine { get; }
Property Value
Gets all input ports (both valid and invalid) for this unit.
Declaration
[DoNotSerializeAttribute]
public IEnumerable<IUnitInputPort> inputs { get; }
Property Value
Gets the collection of invalid input ports for this unit, which represent connections with unresolved compatibility issues.
Declaration
[DoNotSerializeAttribute]
public IUnitPortCollection<InvalidInput> invalidInputs { get; }
Property Value
invalidOutputs
Gets the collection of invalid output ports for this unit, which represent connections with unresolved compatibility issues.
Declaration
[DoNotSerializeAttribute]
public IUnitPortCollection<InvalidOutput> invalidOutputs { get; }
Property Value
invalidPorts
Gets the invalid ports for this unit.
Declaration
[DoNotSerializeAttribute]
public IEnumerable<IUnitPort> invalidPorts { get; }
Property Value
isControlRoot
Gets a value indicating whether this unit is the control root of its graph.
Declaration
[DoNotSerializeAttribute]
public virtual bool isControlRoot { get; protected set; }
Property Value
isDefined
Gets a value indicating whether this unit is currently defined.
Declaration
[DoNotSerializeAttribute]
public bool isDefined { get; }
Property Value
outputs
Gets all output ports (both valid and invalid) for this unit.
Declaration
[DoNotSerializeAttribute]
public IEnumerable<IUnitOutputPort> outputs { get; }
Property Value
ports
Gets all ports (valid and invalid) for this unit.
Declaration
[DoNotSerializeAttribute]
public IEnumerable<IUnitPort> ports { get; }
Property Value
position
Gets or sets the position of this unit in the graph editor interface.
Declaration
[SerializeAttribute]
public Vector2 position { get; set; }
Property Value
relations
Gets the collection of port-to-port relationships (or connections) in this unit.
Declaration
[DoNotSerializeAttribute]
public IConnectionCollection<IUnitRelation, IUnitPort, IUnitPort> relations { get; }
Property Value
Gets the valid input ports for this unit.
Declaration
[DoNotSerializeAttribute]
public IEnumerable<IUnitInputPort> validInputs { get; }
Property Value
validOutputs
Gets the valid output ports for this unit.
Declaration
[DoNotSerializeAttribute]
public IEnumerable<IUnitOutputPort> validOutputs { get; }
Property Value
validPorts
Gets the valid ports for this unit.
Declaration
[DoNotSerializeAttribute]
public IEnumerable<IUnitPort> validPorts { get; }
Property Value
Gets the collection of value input ports for this unit.
Declaration
[DoNotSerializeAttribute]
public IUnitPortCollection<ValueInput> valueInputs { get; }
Property Value
valueOutputs
Gets the collection of value output ports for this unit.
Declaration
[DoNotSerializeAttribute]
public IUnitPortCollection<ValueOutput> valueOutputs { get; }
Property Value
Methods
AfterAdd()
Declaration
public override void AfterAdd()
Overrides
AfterDefine()
Declaration
protected virtual void AfterDefine()
Triggering the source may assign the destination value on the flow.
Declaration
protected void Assignment(ControlInput source, ValueOutput destination)
Parameters
BeforeRemove()
Declaration
public override void BeforeRemove()
Overrides
BeforeUndefine()
Declaration
protected virtual void BeforeUndefine()
Declaration
protected ControlInput ControlInput(string key, Func<Flow, ControlOutput> action)
Parameters
Returns
Declaration
protected ControlInput ControlInputCoroutine(string key, Func<Flow, IEnumerator> coroutineAction)
Parameters
| Type |
Name |
Description |
| string |
key |
|
| Func<Flow, IEnumerator> |
coroutineAction |
|
Returns
Declaration
protected ControlInput ControlInputCoroutine(string key, Func<Flow, ControlOutput> action, Func<Flow, IEnumerator> coroutineAction)
Parameters
Returns
ControlOutput(string)
Declaration
protected ControlOutput ControlOutput(string key)
Parameters
| Type |
Name |
Description |
| string |
key |
|
Returns
CopyFrom(Unit)
Declaration
protected void CopyFrom(Unit source)
Parameters
| Type |
Name |
Description |
| Unit |
source |
|
CreateDebugData()
Declaration
public virtual IGraphElementDebugData CreateDebugData()
Returns
Define()
Defines this unit by setting up its ports, connections, and other requirements.
Declaration
Definition()
Declaration
protected abstract void Definition()
Disconnect()
Declaration
EnsureDefined()
Ensures that this unit is properly defined, invoking definition if necessary.
Declaration
public void EnsureDefined()
Declaration
protected void EnsureUniqueInput(string key)
Parameters
| Type |
Name |
Description |
| string |
key |
|
EnsureUniqueOutput(string)
Declaration
protected void EnsureUniqueOutput(string key)
Parameters
| Type |
Name |
Description |
| string |
key |
|
GetAnalyticsIdentifier()
Declaration
public override AnalyticsIdentifier GetAnalyticsIdentifier()
Returns
Overrides
Instantiate(GraphReference)
Declaration
public override void Instantiate(GraphReference instance)
Parameters
Overrides
PortsChanged()
Called to notify that ports in the unit have changed.
Declaration
public void PortsChanged()
RemoveUnconnectedInvalidPorts()
Removes any unconnected invalid ports from this unit.
Declaration
public void RemoveUnconnectedInvalidPorts()
Triggering the destination may fetch the source value.
Declaration
protected void Requirement(ValueInput source, ControlInput destination)
Parameters
Getting the value of the destination may fetch the value of the source.
Declaration
protected void Requirement(ValueInput source, ValueOutput destination)
Parameters
Triggering the source may trigger the destination.
Declaration
protected void Succession(ControlInput source, ControlOutput destination)
Parameters
Uninstantiate(GraphReference)
Declaration
public override void Uninstantiate(GraphReference instance)
Parameters
Overrides
Declaration
protected ValueInput ValueInput(Type type, string key)
Parameters
| Type |
Name |
Description |
| Type |
type |
|
| string |
key |
|
Returns
Declaration
protected ValueInput ValueInput<T>(string key)
Parameters
| Type |
Name |
Description |
| string |
key |
|
Returns
Type Parameters
Declaration
protected ValueInput ValueInput<T>(string key, T @default)
Parameters
| Type |
Name |
Description |
| string |
key |
|
| T |
default |
|
Returns
Type Parameters
ValueOutput(Type, string)
Declaration
protected ValueOutput ValueOutput(Type type, string key)
Parameters
| Type |
Name |
Description |
| Type |
type |
|
| string |
key |
|
Returns
ValueOutput(Type, string, Func<Flow, object>)
Declaration
protected ValueOutput ValueOutput(Type type, string key, Func<Flow, object> getValue)
Parameters
| Type |
Name |
Description |
| Type |
type |
|
| string |
key |
|
| Func<Flow, object> |
getValue |
|
Returns
ValueOutput<T>(string)
Declaration
protected ValueOutput ValueOutput<T>(string key)
Parameters
| Type |
Name |
Description |
| string |
key |
|
Returns
Type Parameters
ValueOutput<T>(string, Func<Flow, T>)
Declaration
protected ValueOutput ValueOutput<T>(string key, Func<Flow, T> getValue)
Parameters
| Type |
Name |
Description |
| string |
key |
|
| Func<Flow, T> |
getValue |
|
Returns
Type Parameters
Events
onPortsChanged
Event triggered when ports in the unit have changed.
Declaration
public event Action onPortsChanged
Event Type
Implements
IDisposable
Extension Methods