Function shortcutAction

  • An attribute that can be added to a static method to create a new shortcut. You can add a default binding to the shortcut, but if the shortcut doesn't have any binding the user can still bind a key to the action.

    Whenever the user presses the associated key combination, the system will call the associated static method.

    Parameters

    • displayName: string

      The name/path of the shortcut action.

    • OptionalshortcutModifier: EnumValue<ButtonModifier, number>

      A modifier key to bind the action to by default.

    • OptionalshortcutKeys: EnumValue<ButtonCode, number> | EnumValue<ButtonCode, number>[]

      A key code to bind the action to by default.

    • Optionalflags: EnumValue<ShortcutBindingFlag, number>

      A set of optional flags to be given to the default key binding.

    • Optionalpriority: number

      An optional priority value for the new action.

    • Optionalplatform: EnumValue<ShortcutPlatformID, number>

      The platform for which this shortcut is enabled.

    Returns AttributeDecorator<Attribute>