docs.unity3d.com
    Show / Hide Table of Contents

    Class TimelineEditorWindow

    Base class of the TimelineWindow.

    Inheritance
    Object
    TimelineEditorWindow
    Namespace: UnityEditor.Timeline
    Syntax
    public abstract class TimelineEditorWindow : EditorWindow

    Properties

    locked

    Allows retrieving and and setting the Timeline Window lock state. When the lock is off, the window focus follows the Unity selection.

    Declaration
    public abstract bool locked { get; set; }
    Property Value
    Type Description
    Boolean
    Remarks

    When lock transitions from true to false, the focused timeline will be synchronized with the Unity selection.

    Methods

    ClearTimeline()

    Allows clearing the TimelineAsset that is shown in the TimelineWindow.

    Declaration
    public abstract void ClearTimeline()
    Remarks

    Ignores window lock mode.

    SetTimeline(PlayableDirector)

    Allows setting which TimelineAsset is shown in the TimelineWindow and which PlayableDirector is used to evaluate it.

    Declaration
    public abstract void SetTimeline(PlayableDirector director)
    Parameters
    Type Name Description
    PlayableDirector director

    The PlayableDirector who's timeline should be shown.

    Remarks

    Ignores window lock mode. Calling with null, will clear the displayed timeline.

    SetTimeline(TimelineAsset)

    Allows setting which TimelineAsset is shown in the TimelineWindow.

    Declaration
    public abstract void SetTimeline(TimelineAsset sequence)
    Parameters
    Type Name Description
    TimelineAsset sequence

    The asset to show.

    Remarks

    Calling this method will put the window in asset edit mode and certain features might be missing (eg: timeline cannot be evaluated, bindings will not be available, etc). Ignores window lock mode. Calling with null, will clear the displayed timeline.

    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