Input System: ISX.KeyControl Class Reference

Inheritance diagram for ISX.KeyControl:

Properties
Key	keyCode `[get, set]`
	The code used in Unity to identify the key. More...

int	scanCode `[get]`
	The code that the underlying platform uses to identify the key. More...

string	shiftDisplayName `[get]`
	Display name for key when used in combination with the shift key. More...

string	altDisplayName `[get]`
	Display name for key when used in combination with the alt key. More...

Detailed Description

A key on a Keyboard.

This is an extended button control which adds various features to account for the fact that keys have symbols associated with them which may change depending on keyboard layout as well as in combination with other keys.

Note that there is no text input associated with individual keys as text composition is highly layout specific and does not need to be key-by-key. For general text input, see Keyboard.onTextInput. To find the text displayed on a key, use KeyControl.displayName.

Property Documentation

◆ altDisplayName

string ISX.KeyControl.altDisplayName

get

Display name for key when used in combination with the alt key.

◆ keyCode

Key ISX.KeyControl.keyCode

getset

The code used in Unity to identify the key.

This property must be initialized by InputControl.FinishControlSetup of the device owning the control.

◆ scanCode

int ISX.KeyControl.scanCode

get

The code that the underlying platform uses to identify the key.

REVIEW: rename this to something like platformKeyCode? We're not really dealing with scan code here.

◆ shiftDisplayName

string ISX.KeyControl.shiftDisplayName

get