Key::bind: Difference between revisions

From RAGE Multiplayer Wiki
(Better example that presents the new "keyhold" boolean parameter.)
(Changed word "Int" to "Number" for semantic reasons, as this is JavaScript.)
Line 2: Line 2:


==Parameters==
==Parameters==
* '''keycode''' - code of key (Int).
* '''keycode''' - code of key (Number).
* '''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.

Revision as of 10:32, 28 November 2017

This function binds the key .

Parameters

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

Example

This example calling server event.

Client-Side
// 113 is the F2 key code
mp.keys.bind(113, 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