docs.unity3d.com
    Show / Hide Table of Contents

    Class FlowGraph

    Inheritance
    Object
    Graph
    FlowGraph
    Inherited Members
    Graph.ToString()
    Graph.CreateDebugData()
    Graph.Instantiate(GraphReference)
    Graph.Uninstantiate(GraphReference)
    Graph.elements
    Graph.title
    Graph.summary
    Graph.pan
    Graph.zoom
    Graph.deserializationDependencies
    Graph.OnBeforeSerialize()
    Graph.OnAfterDeserialize()
    Graph.OnAfterDependenciesDeserialized()
    Graph.GetAotStubs(HashSet<Object>)
    Graph.Prewarm()
    Graph.Dispose()
    Namespace: Unity.VisualScripting
    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
    Implements
    IGraphWithVariables.variables

    Methods

    CreateData()

    Declaration
    public override IGraphData CreateData()
    Returns
    Type Description
    IGraphData
    Overrides
    Graph.CreateData()
    Implements
    IGraph.CreateData()

    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>
    Implements
    IGraphWithVariables.GetDynamicVariableNames(VariableKind, GraphReference)

    IsListening(GraphPointer)

    Declaration
    public bool IsListening(GraphPointer pointer)
    Parameters
    Type Name Description
    GraphPointer pointer
    Returns
    Type Description
    Boolean
    Implements
    IGraphEventListener.IsListening(GraphPointer)

    PortDefinitionsChanged()

    Declaration
    public void PortDefinitionsChanged()

    StartListening(GraphStack)

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

    StopListening(GraphStack)

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

    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

    Extension Methods

    XFlowGraph.GetUnitsRecursive(FlowGraph, Recursion)
    XAnalyserProvider.Analyser(Object, IGraphContext)
    XAnalyserProvider.Analyser<TAnalyser>(Object, IGraphContext)
    XAnalyserProvider.Analysis(Object, IGraphContext)
    XAnalyserProvider.Analysis<TAnalysis>(Object, IGraphContext)
    XAnalyserProvider.Analyser(Object, GraphReference)
    XAnalyserProvider.Analyser<TAnalyser>(Object, GraphReference)
    XAnalyserProvider.Analysis(Object, GraphReference)
    XAnalyserProvider.Analysis<TAnalysis>(Object, GraphReference)
    XCanvasProvider.Canvas(IGraph)
    XCanvasProvider.Canvas<TCanvas>(IGraph)
    XDescriptorProvider.Describe(Object)
    XDescriptorProvider.HasDescriptor(Object)
    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    XDescriptorProvider.Description(Object)
    XDescriptorProvider.Description<TDescription>(Object)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.CloneViaFakeSerialization(Object)
    Cloning.CloneViaFakeSerialization<T>(T)
    XGraphEventListener.StartListening(IGraphEventListener, GraphReference)
    XGraphEventListener.StopListening(IGraphEventListener, GraphReference)
    ConversionUtility.IsConvertibleTo(Object, Type, Boolean)
    ConversionUtility.IsConvertibleTo<T>(Object, Boolean)
    ConversionUtility.ConvertTo(Object, Type)
    ConversionUtility.ConvertTo<T>(Object)
    TypeUtility.ToShortString(Object, Int32)
    Serialization.CloneViaSerialization<T>(T, Boolean)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, Boolean)
    Serialization.Serialize(Object, Boolean)
    LinqUtility.Yield<T>(T)
    UnityObjectUtility.IsUnityNull(Object)
    UnityObjectUtility.ToSafeString(Object)
    In This Article
    • Constructors
      • FlowGraph()
    • Properties
      • controlConnections
      • controlInputDefinitions
      • controlOutputDefinitions
      • groups
      • invalidConnections
      • sticky
      • units
      • validPortDefinitions
      • valueConnections
      • valueInputDefinitions
      • valueOutputDefinitions
      • variables
    • Methods
      • CreateData()
      • GetDynamicVariableNames(VariableKind, GraphReference)
      • IsListening(GraphPointer)
      • PortDefinitionsChanged()
      • StartListening(GraphStack)
      • StopListening(GraphStack)
      • WithInputOutput()
      • WithStartUpdate()
    • Events
      • onPortDefinitionsChanged
    • Extension Methods
    Back to top
    Terms of use
    Copyright © 2023 Unity Technologies — Terms of use
    • Legal
    • Privacy Policy
    • Cookies
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)
    "Unity", Unity logos, and other Unity trademarks are trademarks or registered trademarks of Unity Technologies or its affiliates in the U.S. and elsewhere (more info here). Other names or brands are trademarks of their respective owners.
    Generated by DocFX on 18 October 2023