docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class FlowGraph

    Inheritance
    object
    Graph
    FlowGraph
    Implements
    IGraphWithVariables
    IGraph
    IDisposable
    IPrewarmable
    IAotStubbable
    ISerializationDepender
    ISerializationCallbackReceiver
    IGraphEventListener
    Inherited Members
    Graph.ToString()
    Graph.CreateDebugData()
    Graph.Instantiate(GraphReference)
    Graph.Uninstantiate(GraphReference)
    Graph.OnBeforeSerialize()
    Graph.OnAfterDeserialize()
    Graph.OnAfterDependenciesDeserialized()
    Graph.GetAotStubs(HashSet<object>)
    Graph.Prewarm()
    Graph.Dispose()
    Graph.elements
    Graph.title
    Graph.summary
    Graph.pan
    Graph.zoom
    Graph.deserializationDependencies
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    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
    Graph.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>

    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

    IGraphWithVariables
    IGraph
    IDisposable
    IPrewarmable
    IAotStubbable
    ISerializationDepender
    ISerializationCallbackReceiver
    IGraphEventListener

    Extension Methods

    Cloning.Clone(object, ICloner, bool)
    Cloning.Clone(object, ICloner, bool)
    Cloning.CloneViaFakeSerialization(object)
    Cloning.CloneViaFakeSerialization(object)
    ConversionUtility.ConvertTo(object, Type)
    ConversionUtility.ConvertTo(object, Type)
    ConversionUtility.ConvertTo<T>(object)
    ConversionUtility.ConvertTo<T>(object)
    ConversionUtility.IsConvertibleTo(object, Type, bool)
    ConversionUtility.IsConvertibleTo(object, Type, bool)
    ConversionUtility.IsConvertibleTo<T>(object, bool)
    ConversionUtility.IsConvertibleTo<T>(object, bool)
    Serialization.Serialize(object, bool)
    Serialization.Serialize(object, bool)
    TypeUtility.ToShortString(object, int)
    TypeUtility.ToShortString(object, int)
    UnityObjectUtility.IsUnityNull(object)
    UnityObjectUtility.IsUnityNull(object)
    UnityObjectUtility.ToSafeString(object)
    UnityObjectUtility.ToSafeString(object)
    XAnalyserProvider.Analyser(object, GraphReference)
    XAnalyserProvider.Analyser(object, IGraphContext)
    XAnalyserProvider.Analyser<TAnalyser>(object, GraphReference)
    XAnalyserProvider.Analyser<TAnalyser>(object, IGraphContext)
    XAnalyserProvider.Analysis(object, GraphReference)
    XAnalyserProvider.Analysis(object, IGraphContext)
    XAnalyserProvider.Analysis<TAnalysis>(object, GraphReference)
    XAnalyserProvider.Analysis<TAnalysis>(object, IGraphContext)
    XDescriptorProvider.Describe(object)
    XDescriptorProvider.Description(object)
    XDescriptorProvider.Description<TDescription>(object)
    XDescriptorProvider.Descriptor(object)
    XDescriptorProvider.Descriptor<TDescriptor>(object)
    XDescriptorProvider.HasDescriptor(object)
    Cloning.CloneViaFakeSerialization<T>(T)
    Cloning.CloneViaFakeSerialization<T>(T)
    Cloning.Clone<T>(T, ICloner, bool)
    Cloning.Clone<T>(T, ICloner, bool)
    LinqUtility.Yield<T>(T)
    LinqUtility.Yield<T>(T)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, bool)
    Serialization.CloneViaSerializationInto<TSource, TDestination>(TSource, ref TDestination, bool)
    Serialization.CloneViaSerialization<T>(T, bool)
    Serialization.CloneViaSerialization<T>(T, bool)

    Did you find this page useful? Please give it a rating:

    Thanks for rating this page!

    Report a problem on this page

    What kind of problem would you like to report?

    • This page needs code samples
    • Code samples do not work
    • Information is missing
    • Information is incorrect
    • Information is unclear or confusing
    • There is a spelling/grammar error on this page
    • Something else

    Thanks for letting us know! This page has been marked for review based on your feedback.

    If you have time, you can provide more information to help us fix the problem faster.

    Provide more information

    You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:

    You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:

    You've told us there is information missing from this page. Please tell us more about what's missing:

    You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:

    You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:

    You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:

    You've told us this page has a problem. Please tell us more about what's wrong:

    Thank you for helping to make the Unity documentation better!

    Your feedback has been submitted as a ticket for our documentation team to review.

    We are not able to reply to every ticket submitted.

    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
    • Implements
    • Extension Methods
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)