AthenaClient.interface.hotkeys.BaseKeyInfo ​

client/interface/hotkeys.BaseKeyInfo

Hierarchy ​

• BaseKeyInfo

  ↳ KeyInfo

Properties ​

allowIfDead ​

• Optional allowIfDead: true

Allow using the keybind even if the player is dead.

Memberof

BaseKeyInfo

Defined in ​

client/interface/hotkeys.ts:209

allowInAnyMenu ​

• Optional allowInAnyMenu: true

If set to true, any page / menu will allow triggering this keybind.

Defined in ​

client/interface/hotkeys.ts:201

allowInSpecificPage ​

• Optional allowInSpecificPage: string

Allows the keybind to be ignore menu checks if in a specific page.

Defined in ​

client/interface/hotkeys.ts:217

delayedKeyDown ​

• Optional delayedKeyDown: Object

Only triggered when msToTrigger is also specified for this key bind.

Type declaration ​

Defined in ​

client/interface/hotkeys.ts:157

description ​

• description: string

Describe what this keybind is meant to do.

Defined in ​

client/interface/hotkeys.ts:141

doNotAllowRebind ​

• Optional doNotAllowRebind: boolean

Prevent his key from being rebound?

Defined in ​

client/interface/hotkeys.ts:239

identifier ​

• identifier: string

Give a keybind an identifier, like a unique id.

Defined in ​

client/interface/hotkeys.ts:149

key ​

• key: number

The primary key for this keybind.

Defined in ​

client/interface/hotkeys.ts:133

keyUp ​

• Optional keyUp: Function

Call this function when the key is let go. This function is only called when a key is released.

Defined in ​

client/interface/hotkeys.ts:176

modifier ​

• Optional modifier: "shift" | "ctrl" | "alt"

Specify a modifier for this key to trigger

Defined in ​

client/interface/hotkeys.ts:193

restrictions ​

• Optional restrictions: KeyBindRestrictions

Restrictions to apply to this key bind. These are all optional. By default key binds work regardless of setting these values.

Defined in ​

client/interface/hotkeys.ts:231

spamPreventionInMs ​

• Optional spamPreventionInMs: number

The amount of milliseconds before this hotkey can be pressed again.

Defined in ​

client/interface/hotkeys.ts:225

whilePressed ​

• Optional whilePressed: Function

Call this function on repeat while this key is held down. Equivalent to an everyTick.

Defined in ​

client/interface/hotkeys.ts:185