Scripting API

Keyboard

class in UnityEngine.InputSystem · Unity.InputSystem · inherits from InputDevice

142 of 154 of Unity's members

Constructors 1

Fields 1

const int KeyCount

Properties 136

KeyControl aKey { get; }
static IReadOnlyList<Keyboard> all { get; }
ReadOnlyArray<KeyControl> allKeys { get; }
ButtonControl altKey { get; }
AnyKeyControl anyKey { get; }
KeyControl bKey { get; }
KeyControl backquoteKey { get; }
KeyControl backslashKey { get; }
KeyControl backspaceKey { get; }
KeyControl cKey { get; }
KeyControl capsLockKey { get; }
KeyControl commaKey { get; }
KeyControl contextMenuKey { get; }
ButtonControl ctrlKey { get; }
static Keyboard? current { get; }
KeyControl dKey { get; }
KeyControl deleteKey { get; }
KeyControl digit0Key { get; }
KeyControl digit1Key { get; }
KeyControl digit2Key { get; }
KeyControl digit3Key { get; }
KeyControl digit4Key { get; }
KeyControl digit5Key { get; }
KeyControl digit6Key { get; }
KeyControl digit7Key { get; }
KeyControl digit8Key { get; }
KeyControl digit9Key { get; }
KeyControl downArrowKey { get; }
KeyControl eKey { get; }
KeyControl endKey { get; }
KeyControl enterKey { get; }
KeyControl equalsKey { get; }
KeyControl escapeKey { get; }
KeyControl f10Key { get; }
KeyControl f11Key { get; }
KeyControl f12Key { get; }
KeyControl f13Key { get; }
KeyControl f14Key { get; }
KeyControl f15Key { get; }
KeyControl f16Key { get; }
KeyControl f17Key { get; }
KeyControl f18Key { get; }
KeyControl f19Key { get; }
KeyControl f1Key { get; }
KeyControl f20Key { get; }
KeyControl f21Key { get; }
KeyControl f22Key { get; }
KeyControl f23Key { get; }
KeyControl f24Key { get; }
KeyControl f2Key { get; }
KeyControl f3Key { get; }
KeyControl f4Key { get; }
KeyControl f5Key { get; }
KeyControl f6Key { get; }
KeyControl f7Key { get; }
KeyControl f8Key { get; }
KeyControl f9Key { get; }
KeyControl fKey { get; }
KeyControl gKey { get; }
KeyControl hKey { get; }
KeyControl homeKey { get; }
KeyControl iKey { get; }
KeyControl insertKey { get; }
KeyControl jKey { get; }
KeyControl kKey { get; }
KeyControl lKey { get; }
KeyControl leftAltKey { get; }
KeyControl leftAppleKey { get; }
KeyControl leftArrowKey { get; }
KeyControl leftBracketKey { get; }
KeyControl leftCommandKey { get; }
KeyControl leftCtrlKey { get; }
KeyControl leftMetaKey { get; }
KeyControl leftShiftKey { get; }
KeyControl leftWindowsKey { get; }
KeyControl mKey { get; }
KeyControl minusKey { get; }
KeyControl nKey { get; }
KeyControl numLockKey { get; }
KeyControl numpad0Key { get; }
KeyControl numpad1Key { get; }
KeyControl numpad2Key { get; }
KeyControl numpad3Key { get; }
KeyControl numpad4Key { get; }
KeyControl numpad5Key { get; }
KeyControl numpad6Key { get; }
KeyControl numpad7Key { get; }
KeyControl numpad8Key { get; }
KeyControl numpad9Key { get; }
KeyControl numpadDivideKey { get; }
KeyControl numpadEnterKey { get; }
KeyControl numpadEqualsKey { get; }
KeyControl numpadMinusKey { get; }
KeyControl numpadMultiplyKey { get; }
KeyControl numpadPeriodKey { get; }
KeyControl numpadPlusKey { get; }
KeyControl oKey { get; }
KeyControl oem1Key { get; }
KeyControl oem2Key { get; }
KeyControl oem3Key { get; }
KeyControl oem4Key { get; }
KeyControl oem5Key { get; }
KeyControl pKey { get; }
KeyControl pageDownKey { get; }
KeyControl pageUpKey { get; }
KeyControl pauseKey { get; }
KeyControl periodKey { get; }
KeyControl printScreenKey { get; }
KeyControl qKey { get; }
KeyControl quoteKey { get; }
KeyControl rKey { get; }
KeyControl rightAltKey { get; }
KeyControl rightAppleKey { get; }
KeyControl rightArrowKey { get; }
KeyControl rightBracketKey { get; }
KeyControl rightCommandKey { get; }
KeyControl rightCtrlKey { get; }
KeyControl rightMetaKey { get; }
KeyControl rightShiftKey { get; }
KeyControl rightWindowsKey { get; }
KeyControl sKey { get; }
KeyControl scrollLockKey { get; }
KeyControl semicolonKey { get; }
ButtonControl shiftKey { get; }
KeyControl slashKey { get; }
KeyControl spaceKey { get; }
KeyControl tKey { get; }
KeyControl tabKey { get; }
KeyControl this[Key key] { get; }
KeyControl uKey { get; }
KeyControl upArrowKey { get; }
KeyControl vKey { get; }
KeyControl wKey { get; }
KeyControl xKey { get; }
KeyControl yKey { get; }
KeyControl zKey { get; }

Methods 3

void MakeCurrent()
void SetIMECursorPosition(Vector2 position)
void SetIMEEnabled(bool enabled)

Events 2

event Action<IMECompositionString>? onIMECompositionChange
event Action<char>? onTextInput

A character was typed (once per character, after the frame's key states update).

Not in Tassix yet 12

FindKeyOnCurrentKeyboardLayout FinishSetup OnIMECompositionChanged OnRemoved OnTextInput RefreshConfiguration imeSelected keyboardLayout keys mediaForward mediaPlayPause mediaRewind