Class TimelineAction

Base class for a timeline action. Inherit from this class to make an action on a timeline after a menu click and/or a key shortcut.

Inheritance

Object

TimelineAction

CreateAnnotationAction

Namespace: UnityEditor.Timeline.Actions

Syntax

public abstract class TimelineAction : object, IAction

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. ActiveInModeAttribute

Examples

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

    [MenuEntry("Custom Actions/Sample Timeline Action")]
    public class SampleTimelineAction : TimelineAction
    {
        public override ActionValidity Validate(ActionContext context)
        {
            return ActionValidity.Valid;
        }

        public override bool Execute(ActionContext context)
        {
            Debug.Log("Test Action");
            return true;
        }

        [TimelineShortcut("SampleTimelineAction", KeyCode.Q)]
        public static void HandleShortCut(ShortcutArguments args)
        {
            Invoker.InvokeWithSelected<SampleTimelineAction>();
        }
    }

Methods

Execute(ActionContext)

Execute the action.

Declaration

public abstract bool Execute(ActionContext context)

Parameters

Type	Name	Description
ActionContext	context	Context for the action.

Returns

Type	Description
Boolean	true if the action has been executed. false otherwise

Validate(ActionContext)

Defines the validity of an Action based on the context.

Declaration

public abstract ActionValidity Validate(ActionContext context)

Parameters

Type	Name	Description
ActionContext	context	Context for the action.

Returns

Type	Description
ActionValidity	Visual state of the menu for the action.