docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class State

    Inheritance
    object
    GraphElement<StateGraph>
    State
    AnyState
    NesterState<TGraph, TMacro>
    Implements
    IState
    IGraphElementWithDebugData
    IGraphElementWithData
    IGraphElement
    IGraphItem
    INotifiedCollectionItem
    IDisposable
    IPrewarmable
    IAotStubbable
    IIdentifiable
    IAnalyticsIdentifiable
    Inherited Members
    GraphElement<StateGraph>.guid
    GraphElement<StateGraph>.BeforeAdd()
    GraphElement<StateGraph>.AfterAdd()
    GraphElement<StateGraph>.AfterRemove()
    GraphElement<StateGraph>.Dispose()
    GraphElement<StateGraph>.InstantiateNest()
    GraphElement<StateGraph>.UninstantiateNest()
    GraphElement<StateGraph>.dependencyOrder
    GraphElement<StateGraph>.HandleDependencies()
    GraphElement<StateGraph>.graph
    GraphElement<StateGraph>.deserializationDependencies
    GraphElement<StateGraph>.GetAotStubs(HashSet<object>)
    GraphElement<StateGraph>.Prewarm()
    GraphElement<StateGraph>.CopyFrom(GraphElement<StateGraph>)
    GraphElement<StateGraph>.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    Namespace: Unity.VisualScripting
    Assembly: Unity.VisualScripting.State.dll
    Syntax
    public abstract class State : GraphElement<StateGraph>, IState, IGraphElementWithDebugData, IGraphElementWithData, IGraphElement, IGraphItem, INotifiedCollectionItem, IDisposable, IPrewarmable, IAotStubbable, IIdentifiable, IAnalyticsIdentifiable

    Fields

    DefaultWidth

    Declaration
    public const float DefaultWidth = 170
    Field Value
    Type Description
    float

    Properties

    canBeDestination

    Declaration
    [DoNotSerialize]
    public virtual bool canBeDestination { get; }
    Property Value
    Type Description
    bool

    canBeSource

    Declaration
    [DoNotSerialize]
    public virtual bool canBeSource { get; }
    Property Value
    Type Description
    bool

    incomingTransitions

    Declaration
    public IEnumerable<IStateTransition> incomingTransitions { get; }
    Property Value
    Type Description
    IEnumerable<IStateTransition>

    isStart

    Declaration
    [Serialize]
    public bool isStart { get; set; }
    Property Value
    Type Description
    bool

    outgoingTransitions

    Declaration
    public IEnumerable<IStateTransition> outgoingTransitions { get; }
    Property Value
    Type Description
    IEnumerable<IStateTransition>

    outgoingTransitionsNoAlloc

    Declaration
    protected List<IStateTransition> outgoingTransitionsNoAlloc { get; }
    Property Value
    Type Description
    List<IStateTransition>

    position

    Declaration
    [Serialize]
    public Vector2 position { get; set; }
    Property Value
    Type Description
    Vector2

    transitions

    Declaration
    public IEnumerable<IStateTransition> transitions { get; }
    Property Value
    Type Description
    IEnumerable<IStateTransition>

    width

    Declaration
    [Serialize]
    public float width { get; set; }
    Property Value
    Type Description
    float

    Methods

    BeforeRemove()

    Declaration
    public override void BeforeRemove()
    Overrides
    GraphElement<StateGraph>.BeforeRemove()

    CopyFrom(State)

    Declaration
    protected void CopyFrom(State source)
    Parameters
    Type Name Description
    State source

    CreateData()

    Declaration
    public IGraphElementData CreateData()
    Returns
    Type Description
    IGraphElementData

    CreateDebugData()

    Declaration
    public IGraphElementDebugData CreateDebugData()
    Returns
    Type Description
    IGraphElementDebugData

    Disconnect()

    Declaration
    public void Disconnect()

    FixedUpdateImplementation(Flow)

    Declaration
    protected virtual void FixedUpdateImplementation(Flow flow)
    Parameters
    Type Name Description
    Flow flow

    GetAnalyticsIdentifier()

    Declaration
    public override AnalyticsIdentifier GetAnalyticsIdentifier()
    Returns
    Type Description
    AnalyticsIdentifier
    Overrides
    GraphElement<StateGraph>.GetAnalyticsIdentifier()

    Instantiate(GraphReference)

    Declaration
    public override void Instantiate(GraphReference instance)
    Parameters
    Type Name Description
    GraphReference instance
    Overrides
    GraphElement<StateGraph>.Instantiate(GraphReference)

    LateUpdateImplementation(Flow)

    Declaration
    protected virtual void LateUpdateImplementation(Flow flow)
    Parameters
    Type Name Description
    Flow flow

    OnBranchTo(Flow, IState)

    Declaration
    public virtual void OnBranchTo(Flow flow, IState destination)
    Parameters
    Type Name Description
    Flow flow
    IState destination

    OnEnter(Flow, StateEnterReason)

    Declaration
    public virtual void OnEnter(Flow flow, StateEnterReason reason)
    Parameters
    Type Name Description
    Flow flow
    StateEnterReason reason

    OnEnterImplementation(Flow)

    Declaration
    protected virtual void OnEnterImplementation(Flow flow)
    Parameters
    Type Name Description
    Flow flow

    OnExit(Flow, StateExitReason)

    Declaration
    public virtual void OnExit(Flow flow, StateExitReason reason)
    Parameters
    Type Name Description
    Flow flow
    StateExitReason reason

    OnExitImplementation(Flow)

    Declaration
    protected virtual void OnExitImplementation(Flow flow)
    Parameters
    Type Name Description
    Flow flow

    Uninstantiate(GraphReference)

    Declaration
    public override void Uninstantiate(GraphReference instance)
    Parameters
    Type Name Description
    GraphReference instance
    Overrides
    GraphElement<StateGraph>.Uninstantiate(GraphReference)

    UpdateImplementation(Flow)

    Declaration
    protected virtual void UpdateImplementation(Flow flow)
    Parameters
    Type Name Description
    Flow flow

    Implements

    IState
    IGraphElementWithDebugData
    IGraphElementWithData
    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)
    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)