Difference between revisions of "Events::addCommand"

From RAGE Multiplayer Wiki
Jump to navigation Jump to search
m (Replaced HTML with template)
 
Line 1: Line 1:
 +
__TOC__
 +
 +
{{ServersideJsFunction}}
 +
 
This function registers a command handler.
 
This function registers a command handler.
  
 +
 +
{{JSContainer|
 
==Syntax==
 
==Syntax==
 
<pre>
 
<pre>
 
mp.events.addCommand(commandName, handlerFunction);
 
mp.events.addCommand(commandName, handlerFunction);
 
</pre>  
 
</pre>  
===Required Arguments===
 
*'''commandName:''' The name of the command you wish to attach a handler to
 
*'''handlerFunction:''' The function that you want the command to trigger, which has to be defined before you add the handler
 
  
====Handler function parameters====
+
== Required Arguments ==
 +
*'''commandName:''' {{RageType|String}} (The name of the command you wish to attach a handler to)
 +
*'''handlerFunction:''' {{RageType|Void}} (The function that you want the command to trigger, which has to be defined before you add the handler)
 +
 
 +
===Handler function parameter ===
 
<pre>player, fullText [, arg1, arg2, ...] </pre>
 
<pre>player, fullText [, arg1, arg2, ...] </pre>
*'''player:''' The player object.
+
*'''player:''' {{RageType|Object}}
*'''fullText:''' All arguments after the command name.
+
*'''fullText:''' {{RageType|Array}} (All arguments after the command name)
*'''arg1, arg2, ...:''' Each argument after the command name.
+
*'''arg1, arg2, ...:''' {{RageType|Any}} (Each argument after the command name)
  
 
==Example==
 
==Example==
Line 35: Line 42:
 
});
 
});
 
</pre>
 
</pre>
 +
}}
 
}}
 
}}
  
 
==See Also==
 
==See Also==
 
{{Event_functions}}
 
{{Event_functions}}

Latest revision as of 11:51, 3 December 2019

Server-Side
Function

Js.png JavaScript



This function registers a command handler.


JavaScript Syntax
Jslogo.png

Syntax

mp.events.addCommand(commandName, handlerFunction);

Required Arguments

  • commandName: String (The name of the command you wish to attach a handler to)
  • handlerFunction: Void (The function that you want the command to trigger, which has to be defined before you add the handler)

Handler function parameter

player, fullText [, arg1, arg2, ...] 
  • player: Object
  • fullText: Array (All arguments after the command name)
  • arg1, arg2, ...: Any (Each argument after the command name)

Example

This example gives a weapon to the current player with the specified number of ammo. If not specified, it will give 10000.

Server-Side
mp.events.addCommand("weapon", (player, fullText, weapon, ammo) => {
	var weaponHash = mp.joaat(weapon);

	player.giveWeapon(weaponHash, parseInt(ammo) || 10000);

});

This example implements /me command

Server-Side
mp.events.addCommand("me", (player, message) => {
	mp.players.broadcast(`* ${player.name}: ${message}`);
});


See Also