mirror of
https://github.com/ParadiseSS13/Paradise.git
synced 2026-07-12 15:45:25 +01:00
Sean
98912fcea9
* more 516 fixes and tweaks * cleaned build output --------- Co-authored-by: Burzah <116982774+Burzah@users.noreply.github.com>
56 lines
1.3 KiB
TypeScript
56 lines
1.3 KiB
TypeScript
/**
|
|
* ### Key codes.
|
|
* event.keyCode is deprecated, use this reference instead.
|
|
*
|
|
* Handles modifier keys (Shift, Alt, Control) and arrow keys.
|
|
*
|
|
* For alphabetical keys, use the actual character (e.g. 'a') instead of the key code.
|
|
*
|
|
* Something isn't here that you want? Just add it:
|
|
* @url https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/key/Key_Values
|
|
* @usage
|
|
* ```ts
|
|
* import { KEY } from 'tgui/common/keys';
|
|
*
|
|
* if (event.key === KEY.Enter) {
|
|
* // do something
|
|
* }
|
|
* ```
|
|
*/
|
|
export enum KEY {
|
|
Alt = 'Alt',
|
|
Backspace = 'Backspace',
|
|
Control = 'Control',
|
|
Delete = 'Delete',
|
|
Down = 'Down',
|
|
End = 'End',
|
|
Enter = 'Enter',
|
|
Esc = 'Esc',
|
|
Escape = 'Escape',
|
|
Home = 'Home',
|
|
Insert = 'Insert',
|
|
Left = 'Left',
|
|
PageDown = 'PageDown',
|
|
PageUp = 'PageUp',
|
|
Right = 'Right',
|
|
Shift = 'Shift',
|
|
Space = ' ',
|
|
Tab = 'Tab',
|
|
Up = 'Up',
|
|
}
|
|
|
|
/**
|
|
* ### isEscape
|
|
*
|
|
* Checks if the user has hit the 'ESC' key on their keyboard.
|
|
* There's a weirdness in BYOND where this could be either the string
|
|
* 'Escape' or 'Esc' depending on the browser. This function handles
|
|
* both cases.
|
|
*
|
|
* @param key - the key to check, typically from event.key
|
|
* @returns true if key is Escape or Esc, false otherwise
|
|
*/
|
|
export const isEscape = (key: string): boolean => {
|
|
return key === KEY.Esc || key === KEY.Escape;
|
|
};
|