Enum ScyllaKey

Keyboard key enumeration for the Scylla Input module. Provides a framework-owned abstraction over Unity's InputSystem.Key enum, allowing game code and other Scylla modules to reference keyboard keys without taking a direct compile-time dependency on the Unity Input System package.

Namespace: Scylla.Input

Assembly: ScyllaInput.dll

Syntax

public enum ScyllaKey

Remarks

Key names follow the physical US keyboard layout, meaning the name describes where the key is located on a standard US keyboard rather than the character it produces under the current OS key mapping. For example, Backquote always refers to the key in the top-left corner of the alphanumeric block regardless of locale.

The integer values in this enum are intentionally kept identical to the corresponding values in Unity's UnityEngine.InputSystem.Key enum. This allows the ScyllaKeyConverter to perform conversions with a simple switch-expression at zero allocation cost, and it means a direct cast between the two types is valid today - though callers should always prefer ToInputSystemKey(ScyllaKey) and FromInputSystemKey(Key) to remain safe against future layout changes.

Several values in the modifier-key range are intentional aliases that share the same numeric constant: AltGr equals RightAlt; LeftWindows, LeftCommand, and LeftApple all equal LeftMeta; and RightWindows, RightCommand, and RightApple all equal RightMeta. These aliases exist to make intent clear across Windows, macOS, and Linux codebases without requiring conditional compilation.

For modifier-only logic (Shift, Ctrl, Alt combinations), prefer ScyllaModifier, which is a [Flags] enum designed for composing keyboard shortcuts.

Fields

Name	Description
A	The A key.
AltGr	AltGr key (alternate graphics). Same physical key as RightAlt on many keyboards.
B	The B key.
Backquote	Backquote/grave accent key (`). Also known as tilde key.
Backslash	Backslash key ().
Backspace	Backspace key.
C	The C key.
CapsLock	Caps Lock key.
Comma	Comma key (,).
ContextMenu	Context menu key (application key, usually between Right Alt and Right Ctrl).
D	The D key.
Delete	Delete key.
Digit0	The 0 key on the number row.
Digit1	The 1 key on the number row.
Digit2	The 2 key on the number row.
Digit3	The 3 key on the number row.
Digit4	The 4 key on the number row.
Digit5	The 5 key on the number row.
Digit6	The 6 key on the number row.
Digit7	The 7 key on the number row.
Digit8	The 8 key on the number row.
Digit9	The 9 key on the number row.
DownArrow	Down arrow key.
E	The E key.
End	End key.
Enter	Enter/Return key.
Equals	Equals key (=).
Escape	Escape key.
F	The F key.
F1	F1 function key.
F10	F10 function key.
F11	F11 function key.
F12	F12 function key.
F2	F2 function key.
F3	F3 function key.
F4	F4 function key.
F5	F5 function key.
F6	F6 function key.
F7	F7 function key.
F8	F8 function key.
F9	F9 function key.
G	The G key.
H	The H key.
Home	Home key.
I	The I key.
Insert	Insert key.
J	The J key.
K	The K key.
L	The L key.
LeftAlt	Left Alt key (Option key on Mac).
LeftApple	Left Apple key on Mac (alias for LeftMeta).
LeftArrow	Left arrow key.
LeftBracket	Left bracket key ([).
LeftCommand	Left Command key on Mac (alias for LeftMeta).
LeftCtrl	Left Control key.
LeftMeta	Left Meta key (Windows key on PC, Command key on Mac).
LeftShift	Left Shift key.
LeftWindows	Left Windows key (alias for LeftMeta).
M	The M key.
Minus	Minus/hyphen key (-).
N	The N key.
None	Invalid key. Does not represent a key on the keyboard.
NumLock	Num Lock key.
Numpad0	The 0 key on the numeric keypad.
Numpad1	The 1 key on the numeric keypad.
Numpad2	The 2 key on the numeric keypad.
Numpad3	The 3 key on the numeric keypad.
Numpad4	The 4 key on the numeric keypad.
Numpad5	The 5 key on the numeric keypad.
Numpad6	The 6 key on the numeric keypad.
Numpad7	The 7 key on the numeric keypad.
Numpad8	The 8 key on the numeric keypad.
Numpad9	The 9 key on the numeric keypad.
NumpadDivide	Divide (/) key on the numeric keypad.
NumpadEnter	Enter key on the numeric keypad.
NumpadEquals	Equals (=) key on the numeric keypad (Mac keyboards).
NumpadMinus	Minus (-) key on the numeric keypad.
NumpadMultiply	Multiply (*) key on the numeric keypad.
NumpadPeriod	Period/decimal (.) key on the numeric keypad.
NumpadPlus	Plus (+) key on the numeric keypad.
O	The O key.
OEM1	OEM key 1. Varies by keyboard layout.
OEM2	OEM key 2. Varies by keyboard layout.
OEM3	OEM key 3. Varies by keyboard layout.
OEM4	OEM key 4. Varies by keyboard layout.
OEM5	OEM key 5. Varies by keyboard layout.
P	The P key.
PageDown	Page Down key.
PageUp	Page Up key.
Pause	Pause/Break key.
Period	Period/dot key (.).
PrintScreen	Print Screen key.
Q	The Q key.
Quote	Single quote/apostrophe key (').
R	The R key.
RightAlt	Right Alt key (Option key on Mac). Also AltGr on some international keyboards.
RightApple	Right Apple key on Mac (alias for RightMeta).
RightArrow	Right arrow key.
RightBracket	Right bracket key (]).
RightCommand	Right Command key on Mac (alias for RightMeta).
RightCtrl	Right Control key.
RightMeta	Right Meta key (Windows key on PC, Command key on Mac).
RightShift	Right Shift key.
RightWindows	Right Windows key (alias for RightMeta).
S	The S key.
ScrollLock	Scroll Lock key.
Semicolon	Semicolon key (;).
Slash	Forward slash key (/).
Space	Space bar key.
T	The T key.
Tab	Tab key.
U	The U key.
UpArrow	Up arrow key.
V	The V key.
W	The W key.
X	The X key.
Y	The Y key.
Z	The Z key.