Key::bind: Difference between revisions

From RAGE Multiplayer Wiki
m (Replace integer keycodes with hexadecimal keycodes)
Line 2: Line 2:


==Parameters==
==Parameters==
* '''keycode''' - code of key (Hexadecimal).
* '''keycode''' - code of [https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 key] (Hexadecimal).
* '''keyhold''' - call function as long as key is held pressed? (Bool)
* '''keyhold''' - call function as long as key is held pressed? (Bool)
* '''handler''' - function-handler.
* '''handler''' - function-handler.
[https://msdn.microsoft.com/en-us/library/windows/desktop/dd375731 Keycodes can be found here]


==Example==
==Example==

Revision as of 13:30, 4 March 2018

This function binds the key .

Parameters

  • keycode - code of key (Hexadecimal).
  • keyhold - call function as long as key is held pressed? (Bool)
  • handler - function-handler.

Example

This example calling server event.

Client-Side
// 0x71 is the F2 key code
mp.keys.bind(0x71, true, function() {
    mp.events.callRemote('keypress:F2'); // Calling server event "keypress:F2"
    mp.gui.chat.push('F2 key is pressed. This message will be shown until you release the key, because "keyhold" is true.');
});

See also