keyboard_string

This variable holds a string containing the last (at most) 1024 characters typed on the keyboard. This string will only contain printable characters typed, but it will correctly respond to pressing the backspace key by erasing the last character. This variable is not read only and you can change it, for example to set it to "" (an empty string) if you handled it already, and you can use the String Functions to manipulate it.

NOTE When using the on-screen Virtual Keyboard, only this variable will be updated with the keyboard input.

NOTE On Xbox GDK, this variable will only function when using the virtual keyboard. See this Helpdesk article for more info.

Syntax:

keyboard_string

Returns:

String

Example:

if string_length(keyboard_string) > 15
{
    keyboard_string = string_copy(keyboard_string, 1, 15);
}

The above code will limit the length of the keyboard string to 15 characters, removing those that are over that limit by copying the first fifteen characters back into the variable.