inkey

inkey (STRING*);

Enters keyboard input into the given string. The local keyboard layout will be activated. The instruction waits for the termination of the input via [Enter] or [Tab] and then proceeds with the calling function, similar to wait. [Esc], [Up], [Down], [PgUp], [PgDn] or [F1]..[F11] abort the entry; the previous content of the string will then be restored, and the scan code of the key will be returned. The text of the input can be edited using [BackSpace], [Del], [Right], [Left], [Home] and [End] .

Parameters:

STRING* - String pointer to receive keyboard entry.

Returns:

1	input terminated because inkey_active was set to OFF or another keyboard entry was active at the same time.
9	input terminated by [Tab]
13	input terminated by [Enter]
27	input terminated by [Esc]
72	input terminated by [Up]
73	input terminated by [PgUp]
80	input terminated by [Down]
81	input terminated by [PgDn]

Modifies:

string	String receives keyboard entry.
inkey_active	is set to ON during entry.

Remarks:

If the string appears in a TEXT object displayed on screen, the input as well as the cursor are visible. The cursor is the character 127 from a bitmap font, or the character 59 (underscore '_') from a TrueType font. The str_cursor function can be used to get the current cursor position while the string is edited.
Inkey is limited to the length of the string. If the end of the string is reached, no further keyboard input will be accepted.
Keyboard entry can be aborted externally by setting the inkey_active variable to OFF.
No game_save/game_load instructions can be executed during keyboard entry.
Key events (on_a etc.) are inactive during keyboard entry.

Example: