Radnen: /* Notes */

2013-05-20T22:16:36Z

‎Notes

Radnen: Created GetKey page

2013-05-20T22:16:15Z

Created GetKey page

New page

[[Category:Functions]]

Returns one instance of a KEY_* constant in the internal key queue.

==Usage==

{{Usage|returns=bool|func=GetKey}}

==Notes==

Best used with [[API:AreKeysLeft|AreKeysLeft]() since this can block all execution until a key has been encountered.

==Examples==

Blocking execution from continuing. It'll count each time you hit a random key.

<syntaxhighlight>

var font = GetSystemFont();

for (var i = 0; i < 10; ++i) {
font.drawText(0, 0, i);
FlipScreen();
GetKey();
}

</syntaxhighlight>

It can also be used to clear the key buffer.

<syntaxhighlight>

while (AreKeysLeft()) GetKey();

</syntaxhighlight>

==See also==

* [[API:AreKeysLeft|AreKeysLeft]]()
* [[API:GetSystemFont|GetSystemFont]]()
* [[API:FlipScreen|FlipScreen]]()
* [[API:font/drawText|font.drawText]](x, y, text)

@@ Line 9: / Line 9: @@
 ==Notes==
-Best used with [[API:AreKeysLeft|AreKeysLeft]() since this can block all execution until a key has been encountered.
+Best used with [[API:AreKeysLeft|AreKeysLeft]]() since this can block all execution until a key has been encountered.
 ==Examples==

Legacy:GetKey - Revision history

Radnen: /* Notes */

Radnen: Created GetKey page