Apollolux: /* Notes */ see also

2013-06-01T22:01:04Z

‎Notes: see also

Apollolux: created from http://web.archive.org/web/20111228001515/http://www.spheredev.org/wiki/IsKeyPressed

2013-06-01T21:58:16Z

created from http://web.archive.org/web/20111228001515/http://www.spheredev.org/wiki/IsKeyPressed

New page

Check if a certain key is being held down on the keyboard.

==Usage==

{{Usage|returns=boolean|func=IsKeyPressed|params=key}}

* '''key''' String. The key code that should be checked. See the [[list of keycode constants]].

==Examples==

<syntaxhighlight>
if (IsKeyPressed(KEY_ENTER))
{
//Code
}
</syntaxhighlight>

IsKeyPressed() is often used in conditions and loops. The above will check if the Enter key was pressed, and if so, it will run the condition.

You can use !<code>IsKeyPressed</code> to negate the function: if the key was NOT pressed.

<syntaxhighlight>
if (!IsKeyPressed(KEY_ENTER))
{
// ...
</syntaxhighlight>

==Notes==

* This function does not halt the engine like [[API:GetKey|GetKey]]() does, and can therefore be used in continuous loops.
* Do not use this function to check for key strokes. This function doesn't use a key queue, so it's suited for controlling a spaceship or a person on a map. However, if you need to pick up every key stroke (e.g. for a text box), use [[API:GetKey|GetKey]]() instead.
* If you need to find out if any key is being pressed, it's better to use the [[API:IsAnyKeyPressed|IsAnyKeyPressed]]() function.

See also

* [[List of keycode constants]]
* [[API:IsAnyKeyPressed|IsAnyKeyPressed]]()
* [[API:AreKeysLeft|AreKeysLeft]]()
* [[API:GetKey|GetKey]]()

@@ Line 33: / Line 33: @@
 *	If you need to find out if any key is being pressed, it's better to use the [[API:IsAnyKeyPressed|IsAnyKeyPressed]]() function.
-See also
+==See also==
 * [[List of keycode constants]]

Legacy:IsKeyPressed - Revision history

Apollolux: /* Notes */ see also

Apollolux: created from http://web.archive.org/web/20111228001515/http://www.spheredev.org/wiki/IsKeyPressed