AthenaClient.systems.hotkeyRegistry ​

Type Aliases ​

KeyInfoDefault ​

Ƭ KeyInfoDefault: player & { default: number }

Defined in ​

client/systems/hotkeyRegistry.ts:8

Functions ​

add ​

Add a key bind to the start listening for key presses. https://www.toptal.com/developers/keycode

Parameters ​

Returns ​

void

Defined in ​

client/systems/hotkeyRegistry.ts:240

checkValidation ​

Used to check if a keybind passes certain validation metrics. Useful for show on-screen data related to a key bind. Should only be called periodically. Roughly every 500ms~1s

Parameters ​

Returns ​

boolean

Defined in ​

client/systems/hotkeyRegistry.ts:258

disable ​

Disble a keybind

Parameters ​

Returns ​

void

Defined in ​

client/systems/hotkeyRegistry.ts:272

enable ​

Enable a keybind

Parameters ​

Returns ​

void

Defined in ​

client/systems/hotkeyRegistry.ts:281

hotkey ​

Return a keybind information for a key. Returns undefined if key is not bound, or found.

Parameters ​

Returns ​

player | undefined

Defined in ​

client/systems/hotkeyRegistry.ts:355

hotkeys ​

Returns all hotkeys and their relevant information.

Returns ​

KeyInfoDefault[]

Defined in ​

client/systems/hotkeyRegistry.ts:344

overwrite ​

Fully overwrites a keybind.

Call this function after onTicksStart

You may need to set a small delay after as well.

Export

Parameters ​

Returns ​

void

Defined in ​

client/systems/hotkeyRegistry.ts:323

rebind ​

Allows a key to be rebound at runtime. Once a key is rebound, it will automatically be loaded on server rejoin.

Parameters ​

Returns ​

void

Defined in ​

client/systems/hotkeyRegistry.ts:290