V5 DocsAthenaClient.interface.hotkeys.KeyInfo ​
client/interface/hotkeys.KeyInfo
Hierarchy ​
↳
KeyInfo
Properties ​
allowIfDead ​
• Optional allowIfDead: true
Allow using the keybind even if the player is dead.
Memberof
BaseKeyInfo
Inherited from ​
Defined in ​
client/interface/hotkeys.ts:209
allowInAnyMenu ​
• Optional allowInAnyMenu: true
If set to true, any page / menu will allow triggering this keybind.
Inherited from ​
Defined in ​
client/interface/hotkeys.ts:201
allowInSpecificPage ​
• Optional allowInSpecificPage: string
Allows the keybind to be ignore menu checks if in a specific page.
Inherited from ​
BaseKeyInfo.allowInSpecificPage
Defined in ​
client/interface/hotkeys.ts:217
delayedKeyDown ​
• Optional delayedKeyDown: Object
Only triggered when msToTrigger is also specified for this key bind.
Type declaration ​
| Name | Type | Description |
|---|---|---|
callback | Function | Function to call after the criteria is met. |
msToTrigger? | number | Milliseconds needed to trigger this keybind. Used for triggering if the key is held long enough. The trigger is fired instantly after the time point is exceeded. |
Overrides ​
Defined in ​
client/interface/hotkeys.ts:80
description ​
• description: string
Describe what this keybind is meant to do.
Inherited from ​
Defined in ​
client/interface/hotkeys.ts:141
disabled ​
• Optional disabled: boolean
Set a key as disabled, preventing all function callbacks.
Defined in ​
client/interface/hotkeys.ts:123
doNotAllowRebind ​
• Optional doNotAllowRebind: boolean
Prevent his key from being rebound?
Inherited from ​
Defined in ​
client/interface/hotkeys.ts:239
identifier ​
• identifier: string
Give a keybind an identifier, like a unique id.
Inherited from ​
Defined in ​
client/interface/hotkeys.ts:149
key ​
• key: number
The primary key for this keybind.
Inherited from ​
Defined in ​
client/interface/hotkeys.ts:133
keyDown ​
• Optional keyDown: Function
Call this function when the key is pressed down once.
Defined in ​
client/interface/hotkeys.ts:72
keyUp ​
• Optional keyUp: Function
Call this function when the key is let go. This function is only called when a key is released.
Overrides ​
Defined in ​
client/interface/hotkeys.ts:106
modifier ​
• Optional modifier: "shift" | "ctrl" | "alt"
Specify a modifier for this key to trigger
Inherited from ​
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.
Inherited from ​
Defined in ​
client/interface/hotkeys.ts:231
spamPreventionInMs ​
• Optional spamPreventionInMs: number
The amount of milliseconds before this hotkey can be pressed again.
Inherited from ​
BaseKeyInfo.spamPreventionInMs
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.