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

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Namespace: UnityEditor.Timeline.Actions

Assembly: solution.dll

Syntax

[ActiveInMode(TimelineModes.Default)]
public abstract class TimelineAction

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

Name	Description
Execute(ActionContext)	Execute the action.
Validate(ActionContext)	Defines the validity of an Action based on the context.