Class FlowGraph

Inheritance
object
Graph
FlowGraph
Implements
Inherited Members
Namespace: Unity.VisualScripting
Assembly: Unity.VisualScripting.Flow.dll
Syntax
[SerializationVersion("A", new Type[] { })]
public sealed class FlowGraph : Graph, IGraphWithVariables, IGraph, IDisposable, IPrewarmable, IAotStubbable, ISerializationDepender, ISerializationCallbackReceiver, IGraphEventListener

Constructors

FlowGraph()

Declaration
public FlowGraph()

Properties

controlConnections

Declaration
[DoNotSerialize]
public GraphConnectionCollection<ControlConnection, ControlOutput, ControlInput> controlConnections { get; }
Property Value
Type Description
GraphConnectionCollection<ControlConnection, ControlOutput, ControlInput>

controlInputDefinitions

Declaration
[Serialize]
[InspectorLabel("Trigger Inputs")]
[InspectorWide(true)]
[WarnBeforeRemoving("Remove Port Definition", "Removing this definition will break any existing connection to this port. Are you sure you want to continue?")]
public UnitPortDefinitionCollection<ControlInputDefinition> controlInputDefinitions { get; }
Property Value
Type Description
UnitPortDefinitionCollection<ControlInputDefinition>

controlOutputDefinitions

Declaration
[Serialize]
[InspectorLabel("Trigger Outputs")]
[InspectorWide(true)]
[WarnBeforeRemoving("Remove Port Definition", "Removing this definition will break any existing connection to this port. Are you sure you want to continue?")]
public UnitPortDefinitionCollection<ControlOutputDefinition> controlOutputDefinitions { get; }
Property Value
Type Description
UnitPortDefinitionCollection<ControlOutputDefinition>

groups

Declaration
[DoNotSerialize]
public GraphElementCollection<GraphGroup> groups { get; }
Property Value
Type Description
GraphElementCollection<GraphGroup>

invalidConnections

Declaration
[DoNotSerialize]
public GraphConnectionCollection<InvalidConnection, IUnitOutputPort, IUnitInputPort> invalidConnections { get; }
Property Value
Type Description
GraphConnectionCollection<InvalidConnection, IUnitOutputPort, IUnitInputPort>

sticky

Declaration
[DoNotSerialize]
public GraphElementCollection<StickyNote> sticky { get; }
Property Value
Type Description
GraphElementCollection<StickyNote>

units

Declaration
[DoNotSerialize]
public GraphElementCollection<IUnit> units { get; }
Property Value
Type Description
GraphElementCollection<IUnit>

validPortDefinitions

Declaration
public IEnumerable<IUnitPortDefinition> validPortDefinitions { get; }
Property Value
Type Description
IEnumerable<IUnitPortDefinition>

valueConnections

Declaration
[DoNotSerialize]
public GraphConnectionCollection<ValueConnection, ValueOutput, ValueInput> valueConnections { get; }
Property Value
Type Description
GraphConnectionCollection<ValueConnection, ValueOutput, ValueInput>

valueInputDefinitions

Declaration
[Serialize]
[InspectorLabel("Data Inputs")]
[InspectorWide(true)]
[WarnBeforeRemoving("Remove Port Definition", "Removing this definition will break any existing connection to this port. Are you sure you want to continue?")]
public UnitPortDefinitionCollection<ValueInputDefinition> valueInputDefinitions { get; }
Property Value
Type Description
UnitPortDefinitionCollection<ValueInputDefinition>

valueOutputDefinitions

Declaration
[Serialize]
[InspectorLabel("Data Outputs")]
[InspectorWide(true)]
[WarnBeforeRemoving("Remove Port Definition", "Removing this definition will break any existing connection to this port. Are you sure you want to continue?")]
public UnitPortDefinitionCollection<ValueOutputDefinition> valueOutputDefinitions { get; }
Property Value
Type Description
UnitPortDefinitionCollection<ValueOutputDefinition>

variables

Declaration
[Serialize]
public VariableDeclarations variables { get; }
Property Value
Type Description
VariableDeclarations

Methods

CreateData()

Declaration
public override IGraphData CreateData()
Returns
Type Description
IGraphData
Overrides

GetDynamicVariableNames(VariableKind, GraphReference)

Declaration
public IEnumerable<string> GetDynamicVariableNames(VariableKind kind, GraphReference reference)
Parameters
Type Name Description
VariableKind kind
GraphReference reference
Returns
Type Description
IEnumerable<string>

IsListening(GraphPointer)

Declaration
public bool IsListening(GraphPointer pointer)
Parameters
Type Name Description
GraphPointer pointer
Returns
Type Description
bool

PortDefinitionsChanged()

Declaration
public void PortDefinitionsChanged()

StartListening(GraphStack)

Declaration
public void StartListening(GraphStack stack)
Parameters
Type Name Description
GraphStack stack

StopListening(GraphStack)

Declaration
public void StopListening(GraphStack stack)
Parameters
Type Name Description
GraphStack stack

WithInputOutput()

Declaration
public static FlowGraph WithInputOutput()
Returns
Type Description
FlowGraph

WithStartUpdate()

Declaration
public static FlowGraph WithStartUpdate()
Returns
Type Description
FlowGraph

Events

onPortDefinitionsChanged

Declaration
public event Action onPortDefinitionsChanged
Event Type
Type Description
Action

Implements

Extension Methods