ISX.Keyboard Class Reference

A keyboard input device. More...

Inheritance diagram for ISX.Keyboard:

Properties
Action< char >	onTextInput
	Event that is fired for every single character entered on the keyboard. More...
string	layout [get, protected set]
	The name of the layout currently used by the keyboard. More...
AnyKeyControl	any [get]
	A synthetic button control that is considered pressed if any key on the keyboard is pressed. More...
KeyControl	space [get]
	The space key. More...
KeyControl	enter [get]
	The enter/return key. More...
KeyControl	tab [get]
	The tab key. More...
KeyControl	backquote [get]
	The backquote key. The leftmost key in the row of digits. Directly above tab. More...
KeyControl	quote [get]
	The quote key. The key immediately to the left of the enter/return key. More...
KeyControl	semicolon [get]
	The semicolon key. The key immediately to the left of the quote key. More...
KeyControl	comma [get]
	The comma key. Third key to the left of the right shift key. More...
KeyControl	this[Key key] [get]
	Look up a key control by its key code. More...
Properties inherited from ISX.InputDevice
bool	remote [get]
	Whether the device is mirrored from a remote input system and not actually present as a "real" device in the local system. More...
bool	native [get]
	Whether the device comes from the native Unity runtime. More...
double	lastUpdateTime [get]
	Timestamp of last state event used to update the device. More...

Additional Inherited Members
Public Member Functions inherited from ISX.InputDevice
virtual void	OnConfigurationChanged ()
	Called by the system when the configuration of the device has changed. More...

Detailed Description

A keyboard input device.

Keyboards allow for both individual button input as well as text input.

Be aware that identification of keys in the system is layout-agnostic. For example, the key referred to as the "a" key is always the key to the right of Caps Lock regardless of where the current keyboard layout actually puts the "a" character (if it even has any). To find what is actually behind a key according to the current keyboard layout, use KeyControl.displayName, KeyControl.shiftDisplayName, and KeyControl.altDisplayName.

Property Documentation

any

AnyKeyControl ISX.Keyboard.any

get

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

backquote

KeyControl ISX.Keyboard.backquote

get

The backquote key. The leftmost key in the row of digits. Directly above tab.

comma

KeyControl ISX.Keyboard.comma

get

The comma key. Third key to the left of the right shift key.

enter

KeyControl ISX.Keyboard.enter

get

The enter/return key.

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

layout

string ISX.Keyboard.layout

getprotected set

The name of the layout currently used by the keyboard.

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 KeyControl.displayName, KeyControl.shiftDisplayName, and KeyControl.altDisplayName.

onTextInput

Action<char> ISX.Keyboard.onTextInput

addremove

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

quote

KeyControl ISX.Keyboard.quote

get

The quote key. The key immediately to the left of the enter/return key.

semicolon

KeyControl ISX.Keyboard.semicolon

get

The semicolon key. The key immediately to the left of the quote key.

space

KeyControl ISX.Keyboard.space

get

The space key.

tab

KeyControl ISX.Keyboard.tab

get

The tab key.

this[Key key]

KeyControl ISX.Keyboard.this[Key key]

get

Look up a key control by its key code.

Parameters

key

Exceptions

ArgumentException

The given key is not valid.