Keys::isUp: Difference between revisions

From RAGE Multiplayer Wiki
m (Altered wording)
No edit summary
Line 1: Line 1:
Returns true if the key specified has been released. Otherwise, returns false.
Function to check if specific key is released.  


==Parameters==
==Syntax==
* '''keycode''' - code of the key (Number).
<pre>mp.keys.isUp(keyCode);</pre>
 
===Required Arguments===
* '''keyCode''': {{RageType|Number}} - [https://keycode.info code of the key].
 
===Return Value===
* {{RageType|Boolean}} - <code>true</code> if the key specified is released, Otherwise <code>false</code>.


==Example==
==Example==
An interval that runs every half-second and outputs the state of the F2 key (pressed or not).
An interval that runs every half-second and outputs the state of the F2 key (pressed or not).
{{ClientSide}}
{{ClientsideCode|
<syntaxhighlight lang="javascript">
<syntaxhighlight lang="javascript">
setInterval(() => {
setInterval(() => {
     if (mp.keys.isUp(112) === true) { // 112 is the key code for F2
     if (mp.keys.isUp(113) === true) { // 113 is the key code for F2
         mp.gui.chat.push('F2 key is not pressed!');
         mp.gui.chat.push('F2 key is released!');
     } else {
     } else {
         mp.gui.chat.push('F2 key is pressed!');
         mp.gui.chat.push('F2 key is not released!');
     }
     }
}, 500);
}, 500);
</syntaxhighlight>
</syntaxhighlight>
}}


==See also==
==See also==
{{Keys_functions_c}}
{{Keys_functions_c}}
[[Category:Control]]
[[Category:Client-side Function]]

Revision as of 15:55, 14 May 2019

Function to check if specific key is released.

Syntax

mp.keys.isUp(keyCode);

Required Arguments

Return Value

  • Boolean - true if the key specified is released, Otherwise false.

Example

An interval that runs every half-second and outputs the state of the F2 key (pressed or not).

Client-Side
setInterval(() => {
    if (mp.keys.isUp(113) === true) { // 113 is the key code for F2
        mp.gui.chat.push('F2 key is released!');
    } else {
        mp.gui.chat.push('F2 key is not released!');
    }
}, 500);

See also