docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Flow

    Inheritance
    object
    Flow
    Implements
    IPoolable
    IDisposable
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.VisualScripting
    Assembly: Unity.VisualScripting.Flow.dll
    Syntax
    public sealed class Flow : IPoolable, IDisposable

    Fields

    loopIdentifier

    Declaration
    public int loopIdentifier
    Field Value
    Type Description
    int

    variables

    Declaration
    public readonly VariableDeclarations variables
    Field Value
    Type Description
    VariableDeclarations

    Properties

    coroutineRunner

    Declaration
    public MonoBehaviour coroutineRunner { get; }
    Property Value
    Type Description
    MonoBehaviour

    currentLoop

    Declaration
    public int currentLoop { get; }
    Property Value
    Type Description
    int

    enableDebug

    Declaration
    public bool enableDebug { get; }
    Property Value
    Type Description
    bool

    isCoroutine

    Declaration
    public bool isCoroutine { get; }
    Property Value
    Type Description
    bool

    isInspected

    Declaration
    public bool isInspected { get; }
    Property Value
    Type Description
    bool

    isInspectedBinding

    Declaration
    public static Func<GraphPointer, bool> isInspectedBinding { get; set; }
    Property Value
    Type Description
    Func<GraphPointer, bool>

    isPrediction

    Declaration
    public bool isPrediction { get; }
    Property Value
    Type Description
    bool

    stack

    Declaration
    public GraphStack stack { get; }
    Property Value
    Type Description
    GraphStack

    Methods

    BreakLoop()

    Declaration
    public void BreakLoop()

    CanPredict(IUnitValuePort, GraphReference)

    Declaration
    public static bool CanPredict(IUnitValuePort port, GraphReference reference)
    Parameters
    Type Name Description
    IUnitValuePort port
    GraphReference reference
    Returns
    Type Description
    bool

    Dispose()

    Declaration
    public void Dispose()

    DisposePreservedStack(GraphStack)

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

    EnterLoop()

    Declaration
    public int EnterLoop()
    Returns
    Type Description
    int

    ExitLoop(int)

    Declaration
    public void ExitLoop(int loop)
    Parameters
    Type Name Description
    int loop

    FetchValue(ValueInput, Type, GraphReference)

    Declaration
    public static object FetchValue(ValueInput input, Type type, GraphReference reference)
    Parameters
    Type Name Description
    ValueInput input
    Type type
    GraphReference reference
    Returns
    Type Description
    object

    FetchValue(ValueInput, GraphReference)

    Declaration
    public static object FetchValue(ValueInput input, GraphReference reference)
    Parameters
    Type Name Description
    ValueInput input
    GraphReference reference
    Returns
    Type Description
    object

    FetchValue<T>(ValueInput, GraphReference)

    Declaration
    public static T FetchValue<T>(ValueInput input, GraphReference reference)
    Parameters
    Type Name Description
    ValueInput input
    GraphReference reference
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    GetConvertedValue(ValueInput)

    Declaration
    public object GetConvertedValue(ValueInput input)
    Parameters
    Type Name Description
    ValueInput input
    Returns
    Type Description
    object

    GetValue(ValueInput)

    Declaration
    public object GetValue(ValueInput input)
    Parameters
    Type Name Description
    ValueInput input
    Returns
    Type Description
    object

    GetValue(ValueInput, Type)

    Declaration
    public object GetValue(ValueInput input, Type type)
    Parameters
    Type Name Description
    ValueInput input
    Type type
    Returns
    Type Description
    object

    GetValue<T>(ValueInput)

    Declaration
    public T GetValue<T>(ValueInput input)
    Parameters
    Type Name Description
    ValueInput input
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    Invoke(ControlOutput)

    Declaration
    public void Invoke(ControlOutput output)
    Parameters
    Type Name Description
    ControlOutput output

    IsLocal(IUnitValuePort)

    Declaration
    public bool IsLocal(IUnitValuePort port)
    Parameters
    Type Name Description
    IUnitValuePort port
    Returns
    Type Description
    bool

    LoopIsNotBroken(int)

    Declaration
    public bool LoopIsNotBroken(int loop)
    Parameters
    Type Name Description
    int loop
    Returns
    Type Description
    bool

    New(GraphReference)

    Declaration
    public static Flow New(GraphReference reference)
    Parameters
    Type Name Description
    GraphReference reference
    Returns
    Type Description
    Flow

    Predict(IUnitValuePort, GraphReference)

    Declaration
    public static object Predict(IUnitValuePort port, GraphReference reference)
    Parameters
    Type Name Description
    IUnitValuePort port
    GraphReference reference
    Returns
    Type Description
    object

    Predict(IUnitValuePort, GraphReference, Type)

    Declaration
    public static object Predict(IUnitValuePort port, GraphReference reference, Type type)
    Parameters
    Type Name Description
    IUnitValuePort port
    GraphReference reference
    Type type
    Returns
    Type Description
    object

    Predict<T>(IUnitValuePort, GraphReference)

    Declaration
    public static T Predict<T>(IUnitValuePort port, GraphReference pointer)
    Parameters
    Type Name Description
    IUnitValuePort port
    GraphReference pointer
    Returns
    Type Description
    T
    Type Parameters
    Name Description
    T

    PreserveStack()

    Declaration
    public GraphStack PreserveStack()
    Returns
    Type Description
    GraphStack

    RestoreStack(GraphStack)

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

    Run(ControlOutput)

    Declaration
    public void Run(ControlOutput port)
    Parameters
    Type Name Description
    ControlOutput port

    SetValue(IUnitValuePort, object)

    Declaration
    public void SetValue(IUnitValuePort port, object value)
    Parameters
    Type Name Description
    IUnitValuePort port
    object value

    StartCoroutine(ControlOutput, ICollection<Flow>)

    Declaration
    public void StartCoroutine(ControlOutput port, ICollection<Flow> registry = null)
    Parameters
    Type Name Description
    ControlOutput port
    ICollection<Flow> registry

    StopCoroutine(bool)

    Declaration
    public void StopCoroutine(bool disposeInstantly)
    Parameters
    Type Name Description
    bool disposeInstantly

    TryGetDefaultValue(ValueInput, out object)

    Declaration
    public bool TryGetDefaultValue(ValueInput input, out object defaultValue)
    Parameters
    Type Name Description
    ValueInput input
    object defaultValue
    Returns
    Type Description
    bool

    Implements

    IPoolable
    IDisposable

    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)
    In This Article
    • Fields
      • loopIdentifier
      • variables
    • Properties
      • coroutineRunner
      • currentLoop
      • enableDebug
      • isCoroutine
      • isInspected
      • isInspectedBinding
      • isPrediction
      • stack
    • Methods
      • BreakLoop()
      • CanPredict(IUnitValuePort, GraphReference)
      • Dispose()
      • DisposePreservedStack(GraphStack)
      • EnterLoop()
      • ExitLoop(int)
      • FetchValue(ValueInput, Type, GraphReference)
      • FetchValue(ValueInput, GraphReference)
      • FetchValue<T>(ValueInput, GraphReference)
      • GetConvertedValue(ValueInput)
      • GetValue(ValueInput)
      • GetValue(ValueInput, Type)
      • GetValue<T>(ValueInput)
      • Invoke(ControlOutput)
      • IsLocal(IUnitValuePort)
      • LoopIsNotBroken(int)
      • New(GraphReference)
      • Predict(IUnitValuePort, GraphReference)
      • Predict(IUnitValuePort, GraphReference, Type)
      • Predict<T>(IUnitValuePort, GraphReference)
      • PreserveStack()
      • RestoreStack(GraphStack)
      • Run(ControlOutput)
      • SetValue(IUnitValuePort, object)
      • StartCoroutine(ControlOutput, ICollection<Flow>)
      • StopCoroutine(bool)
      • TryGetDefaultValue(ValueInput, out object)
    • 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)