docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class StateCanvas

    Inheritance
    object
    VisualScriptingCanvas<StateGraph>
    StateCanvas
    Implements
    ICanvas
    IDisposable
    IDragAndDropHandler
    Inherited Members
    VisualScriptingCanvas<StateGraph>.Dispose()
    VisualScriptingCanvas<StateGraph>.Cache()
    VisualScriptingCanvas<StateGraph>.CacheWidgetItems()
    VisualScriptingCanvas<StateGraph>.Recollect()
    VisualScriptingCanvas<StateGraph>.CacheWidgetCollections()
    VisualScriptingCanvas<StateGraph>.Open()
    VisualScriptingCanvas<StateGraph>.RegisterControls()
    VisualScriptingCanvas<StateGraph>.Update()
    VisualScriptingCanvas<StateGraph>.BeforeFrame()
    VisualScriptingCanvas<StateGraph>.OnGUI()
    VisualScriptingCanvas<StateGraph>.UpdateViewport()
    VisualScriptingCanvas<StateGraph>.TweenViewport(Vector2, float, float)
    VisualScriptingCanvas<StateGraph>.CacheWidgetVisibility()
    VisualScriptingCanvas<StateGraph>.ViewElements(IEnumerable<IGraphElement>)
    VisualScriptingCanvas<StateGraph>.IsVisible(IWidget)
    VisualScriptingCanvas<StateGraph>.CacheWidgetPositions()
    VisualScriptingCanvas<StateGraph>.BeginDrag(EventWrapper)
    VisualScriptingCanvas<StateGraph>.Drag(EventWrapper)
    VisualScriptingCanvas<StateGraph>.EndDrag(EventWrapper)
    VisualScriptingCanvas<StateGraph>.DeleteSelection()
    VisualScriptingCanvas<StateGraph>.Align(AlignOperation)
    VisualScriptingCanvas<StateGraph>.Distribute(DistributeOperation)
    VisualScriptingCanvas<StateGraph>.UpdateDragAndDrop()
    VisualScriptingCanvas<StateGraph>.ExitDragAndDrop()
    VisualScriptingCanvas<StateGraph>.widgetProvider
    VisualScriptingCanvas<StateGraph>.selection
    VisualScriptingCanvas<StateGraph>.window
    VisualScriptingCanvas<StateGraph>.graph
    VisualScriptingCanvas<StateGraph>.zoom
    VisualScriptingCanvas<StateGraph>.pan
    VisualScriptingCanvas<StateGraph>.viewport
    VisualScriptingCanvas<StateGraph>.mousePosition
    VisualScriptingCanvas<StateGraph>.isMouseOver
    VisualScriptingCanvas<StateGraph>.isMouseOverBackground
    VisualScriptingCanvas<StateGraph>.hoveredWidget
    VisualScriptingCanvas<StateGraph>.isLassoing
    VisualScriptingCanvas<StateGraph>.lassoArea
    VisualScriptingCanvas<StateGraph>.isSelecting
    VisualScriptingCanvas<StateGraph>.selectionArea
    VisualScriptingCanvas<StateGraph>.isGrouping
    VisualScriptingCanvas<StateGraph>.groupArea
    VisualScriptingCanvas<StateGraph>.isDragging
    VisualScriptingCanvas<StateGraph>.alignableAndDistributable
    VisualScriptingCanvas<StateGraph>.dragAndDropVisualMode
    VisualScriptingCanvas<StateGraph>.frameDeltaTime
    VisualScriptingCanvas<StateGraph>.eventDeltaTime
    VisualScriptingCanvas<StateGraph>.repaintDeltaTime
    VisualScriptingCanvas<StateGraph>.delayedCalls
    VisualScriptingCanvas<StateGraph>.delayCall
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: Unity.VisualScripting
    Assembly: Unity.VisualScripting.State.Editor.dll
    Syntax
    [Canvas(typeof(StateGraph))]
    public sealed class StateCanvas : VisualScriptingCanvas<StateGraph>, ICanvas, IDisposable, IDragAndDropHandler

    Constructors

    StateCanvas(StateGraph)

    Declaration
    public StateCanvas(StateGraph graph)
    Parameters
    Type Name Description
    StateGraph graph

    Properties

    isCreatingTransition

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

    shouldEdgePan

    Declaration
    protected override bool shouldEdgePan { get; }
    Property Value
    Type Description
    bool
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.shouldEdgePan

    transitionSource

    Declaration
    public IState transitionSource { get; set; }
    Property Value
    Type Description
    IState

    Methods

    AcceptsDragAndDrop()

    Declaration
    public override bool AcceptsDragAndDrop()
    Returns
    Type Description
    bool
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.AcceptsDragAndDrop()

    AddState(IState, Vector2)

    Declaration
    public void AddState(IState state, Vector2 position)
    Parameters
    Type Name Description
    IState state
    Vector2 position

    CancelTransition()

    Declaration
    public void CancelTransition()

    Close()

    Declaration
    public override void Close()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.Close()

    CompleteTransitionToNewState()

    Declaration
    public void CompleteTransitionToNewState()

    DrawBackground()

    Declaration
    protected override void DrawBackground()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.DrawBackground()

    DrawDragAndDropPreview()

    Declaration
    public override void DrawDragAndDropPreview()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.DrawDragAndDropPreview()

    EndTransition(IState)

    Declaration
    public void EndTransition(IState destination)
    Parameters
    Type Name Description
    IState destination

    GetContextOptions()

    Declaration
    protected override IEnumerable<DropdownOption> GetContextOptions()
    Returns
    Type Description
    IEnumerable<DropdownOption>
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.GetContextOptions()

    HandleHighPriorityInput()

    Declaration
    protected override void HandleHighPriorityInput()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.HandleHighPriorityInput()

    OnContext()

    Declaration
    protected override void OnContext()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.OnContext()

    OnToolbarGUI()

    Declaration
    public override void OnToolbarGUI()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.OnToolbarGUI()

    PerformDragAndDrop()

    Declaration
    public override void PerformDragAndDrop()
    Overrides
    Unity.VisualScripting.VisualScriptingCanvas<Unity.VisualScripting.StateGraph>.PerformDragAndDrop()

    ShrinkCopyGroup(HashSet<IGraphElement>)

    Declaration
    public override void ShrinkCopyGroup(HashSet<IGraphElement> copyGroup)
    Parameters
    Type Name Description
    HashSet<IGraphElement> copyGroup
    Overrides
    VisualScriptingCanvas<StateGraph>.ShrinkCopyGroup(HashSet<IGraphElement>)

    StartTransition(IState)

    Declaration
    public void StartTransition(IState source)
    Parameters
    Type Name Description
    IState source

    Implements

    ICanvas
    IDisposable
    IDragAndDropHandler

    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
    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)