docs.unity3d.com
    Show / Hide Table of Contents

    Class SwitchOnEnum

    Branches flow by switching over an enum.

    Inheritance
    Object
    GraphElement<FlowGraph>
    Unit
    SwitchOnEnum
    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
    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>.IGraphElement.graph
    GraphElement<FlowGraph>.IGraphItem.graph
    GraphElement<FlowGraph>.deserializationDependencies
    GraphElement<FlowGraph>.aotStubs
    GraphElement<FlowGraph>.Prewarm()
    GraphElement<FlowGraph>.CopyFrom(GraphElement<FlowGraph>)
    GraphElement<FlowGraph>.ToString()
    Namespace: Unity.VisualScripting
    Syntax
    [UnitCategory("Control")]
    [UnitTitle("Switch On Enum")]
    [UnitShortTitle("Switch")]
    [UnitSubtitle("On Enum")]
    [UnitOrder(3)]
    [TypeIcon(typeof(IBranchUnit))]
    public sealed class SwitchOnEnum : Unit, IBranchUnit, IUnit, IGraphElementWithDebugData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable

    Properties

    branches

    Declaration
    [DoNotSerialize]
    public Dictionary<Enum, ControlOutput> branches { get; }
    Property Value
    Type Description
    Dictionary<Enum, ControlOutput>

    canDefine

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

    enter

    The entry point for the switch.

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

    enum

    The enum value on which to switch.

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

    enumType

    Declaration
    [Serialize]
    [Inspectable]
    [UnitHeaderInspectable]
    [TypeFilter(new Type[]{}, Enums = true, Classes = false, Interfaces = false, Structs = false, Primitives = false)]
    public Type enumType { get; set; }
    Property Value
    Type Description
    Type

    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

    Extension Methods

    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)
    XDescriptorProvider.Describe(Object)
    XDescriptorProvider.HasDescriptor(Object)
    XDescriptorProvider.Descriptor(Object)
    XDescriptorProvider.Descriptor<TDescriptor>(Object)
    XDescriptorProvider.Description(Object)
    XDescriptorProvider.Description<TDescription>(Object)
    XUnitOptionProvider.Option(IUnit)
    XUnitOptionProvider.Option<TOption>(IUnit)
    Cloning.Clone(Object, ICloner, Boolean)
    Cloning.Clone<T>(T, ICloner, Boolean)
    Cloning.CloneViaFakeSerialization(Object)
    Cloning.CloneViaFakeSerialization<T>(T)
    GraphsExceptionUtility.GetException(IGraphElementWithDebugData, GraphPointer)
    GraphsExceptionUtility.SetException(IGraphElementWithDebugData, GraphPointer, Exception)
    GraphsExceptionUtility.HandleException(IGraphElementWithDebugData, GraphPointer, Exception)
    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)
    XUnit.CompatibleValueInput(IUnit, Type)
    XUnit.CompatibleValueOutput(IUnit, Type)
    Back to top
    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