docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ClipAction

    Base class for a clip action. Inherit from this class to make an action that would react on selected clips after a menu click and/or a key shortcut.

    Inheritance
    object
    ClipAction
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEditor.Timeline.Actions
    Assembly: Unity.Timeline.Editor.dll
    Syntax
    [ActiveInMode(TimelineModes.Default)]
    public abstract class ClipAction
    Remarks

    To add an action as a menu item in the Timeline context menu, add MenuEntryAttribute on the action class. To make an action to react to a shortcut, use the Shortcut Manager API with TimelineShortcutAttribute. ShortcutAttribute

    Examples

    Simple Clip Action example (with context menu and shortcut support).

    [MenuEntry("Custom Actions/Sample clip Action")]
    public class SampleClipAction : ClipAction
    {
        public override ActionValidity Validate(IEnumerable<TimelineClip> clip)
        {
            return ActionValidity.Valid;
        }
    
        public override bool Execute(IEnumerable<TimelineClip> items)
        {
            Debug.Log("Test Action");
            return true;
        }
    
        [TimelineShortcut("SampleClipAction", KeyCode.K)]
        public static void HandleShortCut(ShortcutArguments args)
        {
            Invoker.InvokeWithSelectedClips<SampleClipAction>();
        }
    }

    Methods

    Execute(IEnumerable<TimelineClip>)

    Execute the action based on clips.

    Declaration
    public abstract bool Execute(IEnumerable<TimelineClip> clips)
    Parameters
    Type Name Description
    IEnumerable<TimelineClip> clips

    clips that the action will act on.

    Returns
    Type Description
    bool

    Returns true if the action has been correctly executed, false otherwise.

    Validate(IEnumerable<TimelineClip>)

    Defines the validity of an Action for a given set of clips.

    Declaration
    public abstract ActionValidity Validate(IEnumerable<TimelineClip> clips)
    Parameters
    Type Name Description
    IEnumerable<TimelineClip> clips

    The clips that the action will act on.

    Returns
    Type Description
    ActionValidity

    The validity of the set of clips.

    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)