RSX Code Reference
    Preparing search index...
    • rsx
    • ShortcutActionBase

    Class ShortcutActionBaseAbstract

    A shortcut action that can be triggered by the shortcut manager. Each action is associated to a shortcut context and has zero or more key bindings for it. If any of it's active key bindings are pressed and there are no other bindings with higher priority, the associated action callback will be triggered whenever the user presses the key combination.

    If the context is "effectively enabled" and the action is also enabled, then the action is also "effectively enabled". This means that the action is registered with the shortcut manager and will respond to user key presses.

    Hierarchy (View Summary)

    Index
    • Parameters

      • OptionalisInternalConstructor: boolean

      Returns ShortcutActionBase

    • get activeTranslatedBinding(): Immutable<ShortcutKey>

      This is similar to GetTranslatedBinding, but will also check if the binding is active. If not active, an empty ShortcutKey is returned.

      Returns Immutable<ShortcutKey>

    • get effectivePriority(): number

      Gets the effective priority for the action. This is the priority that will actually be used to resolve conflicts, it is calculated by multiplying the base action priority by all the base priorities of the parent contexts.

      Returns number

    • get identifier(): string

      Gets the action identifier.

      Returns string

    • get isBindingActive(): boolean

      Checks if a bound shortcut action binding is active and has no other higher priority action using the same key.

      Returns boolean

    • get isDefault(): boolean

      Checks if the binding is currently set to the default and hasn't been customized by the user by calling SetBinding or SetTranslatedBinding.

      Returns boolean

    • get isEffectivelyEnabled(): boolean

      Checks if the action is "effectively enabled", that is, it and all it's parent contexts are in enabled status.

      Returns boolean

    • get isEnabled(): boolean

      A toggle that can be used to enable or disable the action. This does not dictate whether the action is effectively enabled or disabled, to check for it's effective status, taking parent contexts into consideration, use IsEffectivelyEnabled

      Returns boolean

    • set isEnabled(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get isHeld(): boolean

      Checks if the action shortcut binding are being held. If the action is not effectively enabled, this always returns false.

      Returns boolean

    • get isPressed(): boolean

      Checks if the action shortcut binding has been pressed in this frame. If the action is not effectively enabled, this always returns false.

      Returns boolean

    • get isReleased(): boolean

      Checks if the action shortcut binding has been released in this frame. If the action is not effectively enabled, this always returns false.

      Returns boolean

    • get name(): string

      Gets the action name.

      Returns string

    • get path(): string

      Gets the action full path.

      Returns string

    • get priority(): number

      A property that defines the base priority for the action. This is not the effective priority that will be used by the system to resolve conflicts, to get the effective priority use GetEffectivePriority

      Returns number

    • set priority(value: number): void

      Parameters

      • value: number

      Returns void

    • Removes the shortcut binding.

      Returns void

    • Resets the binding to the default binding.

      Returns void