docs.unity3d.com
    Show / Hide Table of Contents

    Class StateUnit

    Inheritance
    Object
    GraphElement<FlowGraph>
    Unit
    NesterUnit<StateGraph, StateGraphAsset>
    StateUnit
    Inherited Members
    NesterUnit<StateGraph, StateGraphAsset>.canDefine
    NesterUnit<StateGraph, StateGraphAsset>.nest
    NesterUnit<StateGraph, StateGraphAsset>.IGraphNester.nest
    NesterUnit<StateGraph, StateGraphAsset>.IGraphParent.childGraph
    NesterUnit<StateGraph, StateGraphAsset>.IGraphParent.isSerializationRoot
    NesterUnit<StateGraph, StateGraphAsset>.IGraphParent.serializedObject
    NesterUnit<StateGraph, StateGraphAsset>.deserializationDependencies
    NesterUnit<StateGraph, StateGraphAsset>.aotStubs
    NesterUnit<StateGraph, StateGraphAsset>.CopyFrom(NesterUnit<StateGraph, StateGraphAsset>)
    NesterUnit<StateGraph, StateGraphAsset>.DefaultGraph()
    NesterUnit<StateGraph, StateGraphAsset>.IGraphParent.DefaultGraph()
    NesterUnit<StateGraph, StateGraphAsset>.IGraphNester.InstantiateNest()
    NesterUnit<StateGraph, StateGraphAsset>.IGraphNester.UninstantiateNest()
    Unit.CreateDebugData()
    Unit.AfterAdd()
    Unit.BeforeRemove()
    Unit.Instantiate(GraphReference)
    Unit.Uninstantiate(GraphReference)
    Unit.CopyFrom(Unit)
    Unit.canDefine
    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
    [TypeIcon(typeof(StateGraph))]
    [UnitCategory("Nesting")]
    public sealed class StateUnit : NesterUnit<StateGraph, StateGraphAsset>, INesterUnit, IUnit, IGraphElementWithDebugData, IGraphNesterElement, IGraphParentElement, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IGraphNester, IGraphParent

    Constructors

    StateUnit()

    Declaration
    public StateUnit()

    StateUnit(StateGraphAsset)

    Declaration
    public StateUnit(StateGraphAsset macro)
    Parameters
    Type Name Description
    StateGraphAsset macro

    Properties

    start

    The entry point to start the state graph.

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

    started

    The action to execute after the state graph has been started.

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

    stop

    The entry point to stop the state graph.

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

    stopped

    The action to execute after the state graph has been stopped.

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

    Methods

    DefaultGraph()

    Declaration
    public override StateGraph DefaultGraph()
    Returns
    Type Description
    StateGraph
    Overrides
    Unity.VisualScripting.NesterUnit<Unity.VisualScripting.StateGraph, Unity.VisualScripting.StateGraphAsset>.DefaultGraph()

    Definition()

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

    WithStart()

    Declaration
    public static StateUnit WithStart()
    Returns
    Type Description
    StateUnit

    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