docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class SwitchUnit<T>

    Inheritance
    object
    GraphElement<FlowGraph>
    Unit
    SwitchUnit<T>
    SwitchOnInteger
    SwitchOnString
    Implements
    IBranchUnit
    IUnit
    IGraphElementWithDebugData
    IGraphElement
    IGraphItem
    INotifiedCollectionItem
    IDisposable
    IPrewarmable
    IAotStubbable
    IIdentifiable
    IAnalyticsIdentifiable
    Inherited Members
    Unit.CreateDebugData()
    Unit.AfterAdd()
    Unit.BeforeRemove()
    Unit.Instantiate(GraphReference)
    Unit.Uninstantiate(GraphReference)
    Unit.CopyFrom(Unit)
    Unit.failedToDefine
    Unit.isDefined
    Unit.AfterDefine()
    Unit.BeforeUndefine()
    Unit.EnsureDefined()
    Unit.Define()
    Unit.RemoveUnconnectedInvalidPorts()
    Unit.controlInputs
    Unit.controlOutputs
    Unit.valueInputs
    Unit.valueOutputs
    Unit.invalidInputs
    Unit.invalidOutputs
    Unit.inputs
    Unit.outputs
    Unit.validInputs
    Unit.validOutputs
    Unit.ports
    Unit.invalidPorts
    Unit.validPorts
    Unit.onPortsChanged
    Unit.PortsChanged()
    Unit.defaultValues
    Unit.relations
    Unit.connections
    Unit.Disconnect()
    Unit.isControlRoot
    Unit.EnsureUniqueInput(string)
    Unit.EnsureUniqueOutput(string)
    Unit.ControlInput(string, Func<Flow, ControlOutput>)
    Unit.ControlInputCoroutine(string, Func<Flow, IEnumerator>)
    Unit.ControlInputCoroutine(string, Func<Flow, ControlOutput>, Func<Flow, IEnumerator>)
    Unit.ControlOutput(string)
    Unit.ValueInput(Type, string)
    Unit.ValueInput<T>(string)
    Unit.ValueInput<T>(string, T)
    Unit.ValueOutput(Type, string)
    Unit.ValueOutput(Type, string, Func<Flow, object>)
    Unit.ValueOutput<T>(string)
    Unit.ValueOutput<T>(string, Func<Flow, T>)
    Unit.Requirement(ValueInput, ControlInput)
    Unit.Requirement(ValueInput, ValueOutput)
    Unit.Assignment(ControlInput, ValueOutput)
    Unit.Succession(ControlInput, ControlOutput)
    Unit.position
    Unit.definitionException
    Unit.GetAnalyticsIdentifier()
    GraphElement<FlowGraph>.guid
    GraphElement<FlowGraph>.BeforeAdd()
    GraphElement<FlowGraph>.AfterRemove()
    GraphElement<FlowGraph>.Dispose()
    GraphElement<FlowGraph>.InstantiateNest()
    GraphElement<FlowGraph>.UninstantiateNest()
    GraphElement<FlowGraph>.dependencyOrder
    GraphElement<FlowGraph>.HandleDependencies()
    GraphElement<FlowGraph>.graph
    GraphElement<FlowGraph>.deserializationDependencies
    GraphElement<FlowGraph>.GetAotStubs(HashSet<object>)
    GraphElement<FlowGraph>.Prewarm()
    GraphElement<FlowGraph>.CopyFrom(GraphElement<FlowGraph>)
    GraphElement<FlowGraph>.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.VisualScripting
    Assembly: Unity.VisualScripting.Flow.dll
    Syntax
    [TypeIcon(typeof(IBranchUnit))]
    public abstract class SwitchUnit<T> : Unit, IBranchUnit, IUnit, IGraphElementWithDebugData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IAnalyticsIdentifiable
    Type Parameters
    Name Description
    T

    Properties

    branches

    Declaration
    [DoNotSerialize]
    public List<KeyValuePair<T, ControlOutput>> branches { get; }
    Property Value
    Type Description
    List<KeyValuePair<T, ControlOutput>>

    canDefine

    Gets a value indicating whether this unit can be defined.

    Declaration
    public override bool canDefine { get; }
    Property Value
    Type Description
    bool
    Overrides
    Unit.canDefine

    default

    The branch to take if the input value does not match any other option.

    Declaration
    [DoNotSerialize]
    public ControlOutput @default { get; }
    Property Value
    Type Description
    ControlOutput

    enter

    The entry point for the switch.

    Declaration
    [DoNotSerialize]
    public ControlInput enter { get; }
    Property Value
    Type Description
    ControlInput

    options

    Declaration
    [Inspectable]
    [Serialize]
    public List<T> options { get; set; }
    Property Value
    Type Description
    List<T>

    selector

    The value on which to switch.

    Declaration
    [DoNotSerialize]
    public ValueInput selector { get; }
    Property Value
    Type Description
    ValueInput

    Methods

    Definition()

    Declaration
    protected override void Definition()
    Overrides
    Unit.Definition()

    Enter(Flow)

    Declaration
    public ControlOutput Enter(Flow flow)
    Parameters
    Type Name Description
    Flow flow
    Returns
    Type Description
    ControlOutput

    Matches(T, T)

    Declaration
    protected virtual bool Matches(T a, T b)
    Parameters
    Type Name Description
    T a
    T b
    Returns
    Type Description
    bool

    Implements

    IBranchUnit
    IUnit
    IGraphElementWithDebugData
    IGraphElement
    IGraphItem
    INotifiedCollectionItem
    IDisposable
    IPrewarmable
    IAotStubbable
    IIdentifiable
    IAnalyticsIdentifiable

    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)
    GraphsExceptionUtility.GetException(IGraphElementWithDebugData, GraphPointer)
    GraphsExceptionUtility.HandleException(IGraphElementWithDebugData, GraphPointer, Exception)
    GraphsExceptionUtility.SetException(IGraphElementWithDebugData, GraphPointer, Exception)
    XUnit.CompatibleValueInput(IUnit, Type)
    XUnit.CompatibleValueOutput(IUnit, Type)
    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
    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)