Class Keyboard

Represents a standard, physical PC-type keyboard.

Inheritance
System.Object
InputControl
InputDevice
Keyboard
Inherited Members
Namespace: UnityEngine.InputSystem
Syntax
public class Keyboard : InputDevice, ITextInputReceiver
Remarks

Keyboards allow for both individual button input as well as text input. To receive button input, use the individual KeyControl-type controls present on the keyboard. For example, aKey. To receive text input, use the onTextInput callback.

The naming/identification of keys is agnostic to keyboard layouts. This means that aKey, for example, will always be the key to the right of capsLockKey regardless of where the current keyboard language layout puts the "a" character. This also means that having a binding to "<Keyboard>/a" on an InputAction, for example, will bind to the same key regardless of locale -- an important feature, for example, for getting stable WASD bindings.

To find what text character (if any) is produced by a key, you can use the key's displayName property. This can also be used in bindings. "<Keyboard>/#(a)", for example, will bind to the key that produces the "a" character according to the currently active keyboard layout.

To find out which keyboard layout is currently active, you can use the keyboardLayout property. Note that keyboard layout names are platform-dependent.

Fields

KeyCount

Total number of key controls on a keyboard, i.e. the number of controls in allKeys.

Declaration
public const int KeyCount = 110
Field Value
Type Description
System.Int32

Total number of key controls.

Properties

aKey

The 'a' key. The key immediately to the right of capsLockKey.

Declaration
public KeyControl aKey { get; }
Property Value
Type Description
KeyControl

Control representing the a key.

allKeys

List of all key controls on the keyboard.

Declaration
public ReadOnlyArray<KeyControl> allKeys { get; }
Property Value
Type Description
ReadOnlyArray<KeyControl>

anyKey

A synthetic button control that is considered pressed if any key on the keyboard is pressed.

Declaration
public AnyKeyControl anyKey { get; }
Property Value
Type Description
AnyKeyControl

Control representing the synthetic "anyKey".

backquoteKey

The ` key. The leftmost key in the row of digits. Directly above tabKey.

Declaration
public KeyControl backquoteKey { get; }
Property Value
Type Description
KeyControl

Control representing the backtick/quote key.

backslashKey

The '&apos; key. The key immediately to the right of rightBracketKey and next to or above enterKey.

Declaration
public KeyControl backslashKey { get; }
Property Value
Type Description
KeyControl

Control representing the backslash key.

backspaceKey

Declaration
public KeyControl backspaceKey { get; }
Property Value
Type Description
KeyControl

bKey

The 'b' key. The key in-between the vKey to the left and the nKey to the right in the bottom-most row of alphabetic characters.

Declaration
public KeyControl bKey { get; }
Property Value
Type Description
KeyControl

Control representing the b key.

capsLockKey

Declaration
public KeyControl capsLockKey { get; }
Property Value
Type Description
KeyControl

cKey

The 'c' key. The key in-between the xKey to the left and the vKey to the right in the bottom-most row of alphabetic characters.

Declaration
public KeyControl cKey { get; }
Property Value
Type Description
KeyControl

Control representing the c key.

commaKey

The ',' key. Third key to the left of rightShiftKey.

Declaration
public KeyControl commaKey { get; }
Property Value
Type Description
KeyControl

Control representing the comma key.

contextMenuKey

Declaration
public KeyControl contextMenuKey { get; }
Property Value
Type Description
KeyControl

current

Declaration
public static Keyboard current { get; }
Property Value
Type Description
Keyboard

deleteKey

Declaration
public KeyControl deleteKey { get; }
Property Value
Type Description
KeyControl

digit0Key

Declaration
public KeyControl digit0Key { get; }
Property Value
Type Description
KeyControl

digit1Key

Declaration
public KeyControl digit1Key { get; }
Property Value
Type Description
KeyControl

digit2Key

Declaration
public KeyControl digit2Key { get; }
Property Value
Type Description
KeyControl

digit3Key

Declaration
public KeyControl digit3Key { get; }
Property Value
Type Description
KeyControl

digit4Key

Declaration
public KeyControl digit4Key { get; }
Property Value
Type Description
KeyControl

digit5Key

Declaration
public KeyControl digit5Key { get; }
Property Value
Type Description
KeyControl

digit6Key

Declaration
public KeyControl digit6Key { get; }
Property Value
Type Description
KeyControl

digit7Key

Declaration
public KeyControl digit7Key { get; }
Property Value
Type Description
KeyControl

digit8Key

Declaration
public KeyControl digit8Key { get; }
Property Value
Type Description
KeyControl

digit9Key

Declaration
public KeyControl digit9Key { get; }
Property Value
Type Description
KeyControl

dKey

Declaration
public KeyControl dKey { get; }
Property Value
Type Description
KeyControl

downArrowKey

Declaration
public KeyControl downArrowKey { get; }
Property Value
Type Description
KeyControl

eKey

Declaration
public KeyControl eKey { get; }
Property Value
Type Description
KeyControl

endKey

Declaration
public KeyControl endKey { get; }
Property Value
Type Description
KeyControl

enterKey

The enter/return key in the main key block.

Declaration
public KeyControl enterKey { get; }
Property Value
Type Description
KeyControl

Control representing the enter key.
Remarks

This key is distinct from the enter key on the numpad which is numpadEnterKey.

equalsKey

The '=' key in the main key block. The key in-between minusKey to the left and backspaceKey to the right.

Declaration
public KeyControl equalsKey { get; }
Property Value
Type Description
KeyControl

Control representing the equals key.

escapeKey

Declaration
public KeyControl escapeKey { get; }
Property Value
Type Description
KeyControl

f10Key

Declaration
public KeyControl f10Key { get; }
Property Value
Type Description
KeyControl

f11Key

Declaration
public KeyControl f11Key { get; }
Property Value
Type Description
KeyControl

f12Key

Declaration
public KeyControl f12Key { get; }
Property Value
Type Description
KeyControl

f1Key

Declaration
public KeyControl f1Key { get; }
Property Value
Type Description
KeyControl

f2Key

Declaration
public KeyControl f2Key { get; }
Property Value
Type Description
KeyControl

f3Key

Declaration
public KeyControl f3Key { get; }
Property Value
Type Description
KeyControl

f4Key

Declaration
public KeyControl f4Key { get; }
Property Value
Type Description
KeyControl

f5Key

Declaration
public KeyControl f5Key { get; }
Property Value
Type Description
KeyControl

f6Key

Declaration
public KeyControl f6Key { get; }
Property Value
Type Description
KeyControl

f7Key

Declaration
public KeyControl f7Key { get; }
Property Value
Type Description
KeyControl

f8Key

Declaration
public KeyControl f8Key { get; }
Property Value
Type Description
KeyControl

f9Key

Declaration
public KeyControl f9Key { get; }
Property Value
Type Description
KeyControl

fKey

Declaration
public KeyControl fKey { get; }
Property Value
Type Description
KeyControl

gKey

Declaration
public KeyControl gKey { get; }
Property Value
Type Description
KeyControl

hKey

Declaration
public KeyControl hKey { get; }
Property Value
Type Description
KeyControl

homeKey

Declaration
public KeyControl homeKey { get; }
Property Value
Type Description
KeyControl

iKey

Declaration
public KeyControl iKey { get; }
Property Value
Type Description
KeyControl

imeSelected

True when IME composition is enabled. Requires SetIMEEnabled(Boolean) to be called to enable IME, and the user to enable it at the OS level.

Declaration
public ButtonControl imeSelected { get; }
Property Value
Type Description
ButtonControl
Remarks

Some languages use complex input methods which involve opening windows to insert characters. Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text.

See SetIMEEnabled(Boolean) for turning IME on/off

insertKey

Declaration
public KeyControl insertKey { get; }
Property Value
Type Description
KeyControl

Item[Key]

Look up a key control by its key code.

Declaration
public KeyControl this[Key key] { get; }
Parameters
Type Name Description
Key key
Property Value
Type Description
KeyControl
Exceptions
Type Condition
System.ArgumentException

The given is not valid.

jKey

Declaration
public KeyControl jKey { get; }
Property Value
Type Description
KeyControl

keyboardLayout

The name of the layout currently used by the keyboard.

Declaration
public string keyboardLayout { get; protected set; }
Property Value
Type Description
System.String
Remarks

Note that keyboard layout names are platform-specific.

The value of this property reflects the currently used layout and thus changes whenever the layout of the system or the one for the application is changed.

To determine what a key represents in the current layout, use displayName, , and .

kKey

Declaration
public KeyControl kKey { get; }
Property Value
Type Description
KeyControl

leftAltKey

Declaration
public KeyControl leftAltKey { get; }
Property Value
Type Description
KeyControl

leftAppleKey

Declaration
public KeyControl leftAppleKey { get; }
Property Value
Type Description
KeyControl

leftArrowKey

Declaration
public KeyControl leftArrowKey { get; }
Property Value
Type Description
KeyControl

leftBracketKey

The '[' key. The key immediately to the left of rightBracketKey.

Declaration
public KeyControl leftBracketKey { get; }
Property Value
Type Description
KeyControl

Control representing the left bracket key.

leftCommandKey

Declaration
public KeyControl leftCommandKey { get; }
Property Value
Type Description
KeyControl

leftCtrlKey

Declaration
public KeyControl leftCtrlKey { get; }
Property Value
Type Description
KeyControl

leftMetaKey

Declaration
public KeyControl leftMetaKey { get; }
Property Value
Type Description
KeyControl

leftShiftKey

Declaration
public KeyControl leftShiftKey { get; }
Property Value
Type Description
KeyControl

leftWindowsKey

Declaration
public KeyControl leftWindowsKey { get; }
Property Value
Type Description
KeyControl

lKey

Declaration
public KeyControl lKey { get; }
Property Value
Type Description
KeyControl

minusKey

The '-' key. The second key to the left of backspaceKey.

Declaration
public KeyControl minusKey { get; }
Property Value
Type Description
KeyControl

Control representing the minus key.

mKey

Declaration
public KeyControl mKey { get; }
Property Value
Type Description
KeyControl

nKey

Declaration
public KeyControl nKey { get; }
Property Value
Type Description
KeyControl

numLockKey

Declaration
public KeyControl numLockKey { get; }
Property Value
Type Description
KeyControl

numpad0Key

Declaration
public KeyControl numpad0Key { get; }
Property Value
Type Description
KeyControl

numpad1Key

Declaration
public KeyControl numpad1Key { get; }
Property Value
Type Description
KeyControl

numpad2Key

Declaration
public KeyControl numpad2Key { get; }
Property Value
Type Description
KeyControl

numpad3Key

Declaration
public KeyControl numpad3Key { get; }
Property Value
Type Description
KeyControl

numpad4Key

Declaration
public KeyControl numpad4Key { get; }
Property Value
Type Description
KeyControl

numpad5Key

Declaration
public KeyControl numpad5Key { get; }
Property Value
Type Description
KeyControl

numpad6Key

Declaration
public KeyControl numpad6Key { get; }
Property Value
Type Description
KeyControl

numpad7Key

Declaration
public KeyControl numpad7Key { get; }
Property Value
Type Description
KeyControl

numpad8Key

Declaration
public KeyControl numpad8Key { get; }
Property Value
Type Description
KeyControl

numpad9Key

Declaration
public KeyControl numpad9Key { get; }
Property Value
Type Description
KeyControl

numpadDivideKey

Declaration
public KeyControl numpadDivideKey { get; }
Property Value
Type Description
KeyControl

numpadEnterKey

Declaration
public KeyControl numpadEnterKey { get; }
Property Value
Type Description
KeyControl

numpadEqualsKey

Declaration
public KeyControl numpadEqualsKey { get; }
Property Value
Type Description
KeyControl

numpadMinusKey

Declaration
public KeyControl numpadMinusKey { get; }
Property Value
Type Description
KeyControl

numpadMultiplyKey

Declaration
public KeyControl numpadMultiplyKey { get; }
Property Value
Type Description
KeyControl

numpadPeriodKey

Declaration
public KeyControl numpadPeriodKey { get; }
Property Value
Type Description
KeyControl

numpadPlusKey

Declaration
public KeyControl numpadPlusKey { get; }
Property Value
Type Description
KeyControl

oem1Key

Declaration
public KeyControl oem1Key { get; }
Property Value
Type Description
KeyControl

oem2Key

Declaration
public KeyControl oem2Key { get; }
Property Value
Type Description
KeyControl

oem3Key

Declaration
public KeyControl oem3Key { get; }
Property Value
Type Description
KeyControl

oem4Key

Declaration
public KeyControl oem4Key { get; }
Property Value
Type Description
KeyControl

oem5Key

Declaration
public KeyControl oem5Key { get; }
Property Value
Type Description
KeyControl

oKey

Declaration
public KeyControl oKey { get; }
Property Value
Type Description
KeyControl

pageDownKey

Declaration
public KeyControl pageDownKey { get; }
Property Value
Type Description
KeyControl

pageUpKey

Declaration
public KeyControl pageUpKey { get; }
Property Value
Type Description
KeyControl

pauseKey

Declaration
public KeyControl pauseKey { get; }
Property Value
Type Description
KeyControl

periodKey

The '.' key. Second key to the left of rightShiftKey.

Declaration
public KeyControl periodKey { get; }
Property Value
Type Description
KeyControl

Control representing the period key.

pKey

Declaration
public KeyControl pKey { get; }
Property Value
Type Description
KeyControl

printScreenKey

Declaration
public KeyControl printScreenKey { get; }
Property Value
Type Description
KeyControl

qKey

Declaration
public KeyControl qKey { get; }
Property Value
Type Description
KeyControl

quoteKey

The ' key. The key immediately to the left of enterKey.

Declaration
public KeyControl quoteKey { get; }
Property Value
Type Description
KeyControl

Control representing the quote key.

rightAltKey

Declaration
public KeyControl rightAltKey { get; }
Property Value
Type Description
KeyControl

rightAppleKey

Declaration
public KeyControl rightAppleKey { get; }
Property Value
Type Description
KeyControl

rightArrowKey

Declaration
public KeyControl rightArrowKey { get; }
Property Value
Type Description
KeyControl

rightBracketKey

The ']' key. The key in-between leftBracketKey to the left and backslashKey to the right.

Declaration
public KeyControl rightBracketKey { get; }
Property Value
Type Description
KeyControl

Control representing the right bracket key.

rightCommandKey

Declaration
public KeyControl rightCommandKey { get; }
Property Value
Type Description
KeyControl

rightCtrlKey

Declaration
public KeyControl rightCtrlKey { get; }
Property Value
Type Description
KeyControl

rightMetaKey

Declaration
public KeyControl rightMetaKey { get; }
Property Value
Type Description
KeyControl

rightShiftKey

Declaration
public KeyControl rightShiftKey { get; }
Property Value
Type Description
KeyControl

rightWindowsKey

Declaration
public KeyControl rightWindowsKey { get; }
Property Value
Type Description
KeyControl

rKey

Declaration
public KeyControl rKey { get; }
Property Value
Type Description
KeyControl

scrollLockKey

Declaration
public KeyControl scrollLockKey { get; }
Property Value
Type Description
KeyControl

semicolonKey

The ';' key. The key immediately to the left of quoteKey.

Declaration
public KeyControl semicolonKey { get; }
Property Value
Type Description
KeyControl

Control representing the semicolon key.

sKey

Declaration
public KeyControl sKey { get; }
Property Value
Type Description
KeyControl

slashKey

The '/' key. The key immediately to the left of rightShiftKey.

Declaration
public KeyControl slashKey { get; }
Property Value
Type Description
KeyControl

Control representing the forward slash key.

spaceKey

The space bar key.

Declaration
public KeyControl spaceKey { get; }
Property Value
Type Description
KeyControl

Control representing the space bar key.

tabKey

The tab key.

Declaration
public KeyControl tabKey { get; }
Property Value
Type Description
KeyControl

Control representing the tab key.

tKey

Declaration
public KeyControl tKey { get; }
Property Value
Type Description
KeyControl

uKey

Declaration
public KeyControl uKey { get; }
Property Value
Type Description
KeyControl

upArrowKey

Declaration
public KeyControl upArrowKey { get; }
Property Value
Type Description
KeyControl

vKey

Declaration
public KeyControl vKey { get; }
Property Value
Type Description
KeyControl

wKey

Declaration
public KeyControl wKey { get; }
Property Value
Type Description
KeyControl

xKey

Declaration
public KeyControl xKey { get; }
Property Value
Type Description
KeyControl

yKey

Declaration
public KeyControl yKey { get; }
Property Value
Type Description
KeyControl

zKey

Declaration
public KeyControl zKey { get; }
Property Value
Type Description
KeyControl

Methods

FinishSetup()

Perform final initialization tasks after the control hierarchy has been put into place.

Declaration
protected override void FinishSetup()
Overrides
Remarks

This method can be overridden to perform control- or device-specific setup work. The most common use case is for looking up child controls and storing them in local getters.

public class MyDevice : InputDevice
{
    public ButtonControl button { get; private set; }
    public AxisControl axis { get; private set; }

    protected override void OnFinishSetup()
    {
        // Cache controls in getters.
        button = GetChildControl("button");
        axis = GetChildControl("axis");
    }
}

MakeCurrent()

Make the keyboard the current keyboard (i.e. current).

Declaration
public override void MakeCurrent()
Overrides
Remarks

A keyboard will automatically be made current when receiving input events.

OnIMECompositionChanged(IMECompositionString)

Declaration
public void OnIMECompositionChanged(IMECompositionString compositionString)
Parameters
Type Name Description
IMECompositionString compositionString
Implements

OnRemoved()

Declaration
protected override void OnRemoved()
Overrides

OnTextInput(Char)

Declaration
public void OnTextInput(char character)
Parameters
Type Name Description
System.Char character
Implements

RefreshConfiguration()

Declaration
protected override void RefreshConfiguration()
Overrides

SetIMECursorPosition(Vector2)

Sets the cursor position for IME composition dialogs. Units are from the upper left, in pixels, moving down and to the right.

Declaration
public void SetIMECursorPosition(Vector2 position)
Parameters
Type Name Description
Vector2 position
Remarks

Some languages use complex input methods which involve opening windows to insert characters. Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text.

See SetIMEEnabled(Boolean) for turning IME on/off

SetIMEEnabled(Boolean)

Activates/deactivates IME composition while typing. This decides whether or not to use the OS supplied IME system.

Declaration
public void SetIMEEnabled(bool enabled)
Parameters
Type Name Description
System.Boolean enabled
Remarks

Some languages use complex input methods which involve opening windows to insert characters. Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text. Setting this to On, will enable the OS-level IME system when the user presses keystrokes.

See SetIMECursorPosition(Vector2), onIMECompositionChange, imeSelected for more IME settings and data.

Events

onIMECompositionChange

An event that is fired to get IME composition strings. Fired once for every change, sends the entire string to date, and sends a blank string whenever a composition is submitted or reset.

Declaration
public event Action<IMECompositionString> onIMECompositionChange
Event Type
Type Description
System.Action<IMECompositionString>
Remarks

Some languages use complex input methods which involve opening windows to insert characters. Typically, this is not desirable while playing a game, as games may just interpret key strokes as game input, not as text.

See SetIMEEnabled(Boolean) for turning IME on/off

onTextInput

Event that is fired for every single character entered on the keyboard.

Declaration
public event Action<char> onTextInput
Event Type
Type Description
System.Action<System.Char>
Remarks
Keyboard.current.onTextInput +=
    ch =>
    {
        TODO
    }

Extension Methods