Events::addCommand - Revision history

Unknown at 11:51, 3 December 2019

2019-12-03T11:51:26Z

← Older revision		Revision as of 11:51, 3 December 2019
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}}

Rootcause: Replaced HTML with template

2018-10-26T11:46:30Z

Replaced HTML with template

← Older revision		Revision as of 11:46, 26 October 2018
Line 17:		Line 17:
	==Example==		==Example==
	This example gives a weapon to the current player with the specified number of ammo. If not specified, it will give 10000.		This example gives a weapon to the current player with the specified number of ammo. If not specified, it will give 10000.
	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~
	<pre>		<pre>
	mp.events.addCommand("weapon", (player, fullText, weapon, ammo) => {		mp.events.addCommand("weapon", (player, fullText, weapon, ammo) => {
Line 27:		Line 26:
	});		});
	</pre>		</pre>
	~~</div>~~		}}

	This example implements /me command		This example implements /me command
	~~<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>~~
	<pre>		<pre>
	mp.events.addCommand("me", (player, message) => {		mp.events.addCommand("me", (player, message) => {
Line 37:		Line 35:
	});		});
	</pre>		</pre>
	~~</div>~~		}}

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}

MrPancakers: Cleaned up, made it more readable and understandable

2018-09-29T02:06:37Z

Cleaned up, made it more readable and understandable

← Older revision		Revision as of 02:06, 29 September 2018
Line 1:		Line 1:
	This function registers command handler.		This function registers a command handler.

	==Syntax==		==Syntax==
	<~~syntaxhighlight lang="typescript"~~>		<pre>
	~~void~~ events.addCommand(~~string~~ commandName, ~~function~~ handlerFunction);		mp.events.addCommand(commandName, handlerFunction);
	</~~syntaxhighlight~~>		</pre>
	===Required Arguments===		===Required Arguments===
	*'''commandName:''' The name of the command you wish to attach a handler to		*'''commandName:''' The name of the command you wish to attach a handler to
Line 10:		Line 10:

	====Handler function parameters====		====Handler function parameters====
	<~~syntaxhighlight lang="typescript"~~>~~Player playerSource~~, ~~string~~ fullText [, ~~string~~ arg1, ~~string~~ arg2, ...] </~~syntaxhighlight~~>		<pre>player, fullText [, arg1, arg2, ...] </pre>
	*'''~~playerSource~~:''' The player ~~who triggered the command~~.		*'''player:''' The player object.
	*'''fullText:''' All ~~words~~ after command name.		*'''fullText:''' All arguments after the command name.
	*'''arg1, arg2, ...:''' Each ~~word~~ after command name.		*'''arg1, arg2, ...:''' Each argument after the command name.

	==Example==		==Example==
	~~'''Example 1:'''~~ This example ~~give~~ weapon to current player with the specified number of ammo or 10000		This example gives a weapon to the current player with the specified number of ammo. If not specified, it will give 10000.
	<~~syntaxhighlight lang~~="~~typescript~~">		<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
			<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
			<pre>
	mp.events.addCommand("weapon", (player, fullText, weapon, ammo) => {		mp.events.addCommand("weapon", (player, fullText, weapon, ammo) => {
	var weaponHash = mp.joaat(weapon);		var weaponHash = mp.joaat(weapon);
Line 24:		Line 26:

	});		});
	</~~syntaxhighlight~~>		</pre>
	~~'''Example 2:'''~~ This example implements /me command		</div>
	<~~syntaxhighlight lang~~="~~typescript~~">
			This example implements /me command
			<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">
			<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
			<pre>
	mp.events.addCommand("me", (player, message) => {		mp.events.addCommand("me", (player, message) => {
	mp.players.broadcast(`* ${player.name}: ${message}`);		mp.players.broadcast(`* ${player.name}: ${message}`);
	});		});
	</~~syntaxhighlight~~>		</pre>
			</div>

	==See Also==		==See Also==
	{{Event_functions}}		{{Event_functions}}

CocaColaBear at 12:41, 17 April 2017

2017-04-17T12:41:41Z

← Older revision		Revision as of 12:41, 17 April 2017
Line 33:		Line 33:

	==See Also==		==See Also==
	{{~~Event_function~~}}		{{Event_functions}}

CocaColaBear at 12:41, 17 April 2017

2017-04-17T12:41:00Z

← Older revision		Revision as of 12:41, 17 April 2017
Line 33:		Line 33:

	==See Also==		==See Also==
	{{~~EntityPool_function~~}}		{{Event_function}}

CocaColaBear at 12:32, 17 April 2017

2017-04-17T12:32:24Z

← Older revision		Revision as of 12:32, 17 April 2017
Line 33:		Line 33:

	==See Also==		==See Also==
	{{~~Player_function~~}}		{{EntityPool_function}}

CocaColaBear at 12:29, 17 April 2017

2017-04-17T12:29:26Z

← Older revision		Revision as of 12:29, 17 April 2017
Line 31:		Line 31:
	});		});
	</syntaxhighlight>		</syntaxhighlight>

			==See Also==
			{{Player_function}}

CocaColaBear at 12:24, 17 April 2017

2017-04-17T12:24:32Z

← Older revision		Revision as of 12:24, 17 April 2017
Line 10:		Line 10:

	====Handler function parameters====		====Handler function parameters====
	<syntaxhighlight lang="typescript">~~player~~ playerSource, string fullText [, string arg1, string arg2, ...] </syntaxhighlight>		<syntaxhighlight lang="typescript">Player playerSource, string fullText [, string arg1, string arg2, ...] </syntaxhighlight>
	*'''playerSource:''' The player who triggered the command.		*'''playerSource:''' The player who triggered the command.
	*'''fullText:''' All words after command name.		*'''fullText:''' All words after command name.

CocaColaBear: Change syntaxhighlight to typescript (better for types)

2017-04-17T12:21:55Z

Change syntaxhighlight to typescript (better for types)

← Older revision		Revision as of 12:21, 17 April 2017
Line 2:		Line 2:

	==Syntax==		==Syntax==
	<syntaxhighlight lang="~~javascript~~">		<syntaxhighlight lang="typescript">
	void events.addCommand(string commandName, function handlerFunction);		void events.addCommand(string commandName, function handlerFunction);
	</syntaxhighlight>		</syntaxhighlight>
Line 10:		Line 10:

	====Handler function parameters====		====Handler function parameters====
	<syntaxhighlight lang="~~javascript~~">player playerSource, string fullText [, string arg1, string arg2, ...] </syntaxhighlight>		<syntaxhighlight lang="typescript">player playerSource, string fullText [, string arg1, string arg2, ...] </syntaxhighlight>
	*'''playerSource:''' The player who triggered the command.		*'''playerSource:''' The player who triggered the command.
	*'''fullText:''' All words after command name.		*'''fullText:''' All words after command name.
Line 17:		Line 17:
	==Example==		==Example==
	'''Example 1:''' This example give weapon to current player with the specified number of ammo or 10000		'''Example 1:''' This example give weapon to current player with the specified number of ammo or 10000
	<syntaxhighlight lang="~~javascript~~">		<syntaxhighlight lang="typescript">
	mp.events.addCommand("weapon", (player, fullText, weapon, ammo) => {		mp.events.addCommand("weapon", (player, fullText, weapon, ammo) => {
	var weaponHash = mp.joaat(weapon);		var weaponHash = mp.joaat(weapon);
Line 26:		Line 26:
	</syntaxhighlight>		</syntaxhighlight>
	'''Example 2:''' This example implements /me command		'''Example 2:''' This example implements /me command
	<syntaxhighlight lang="~~javascript~~">		<syntaxhighlight lang="typescript">
	mp.events.addCommand("me", (player, message) => {		mp.events.addCommand("me", (player, message) => {
	mp.players.broadcast(`* ${player.name}: ${message}`);		mp.players.broadcast(`* ${player.name}: ${message}`);
	});		});
	</syntaxhighlight>		</syntaxhighlight>

CocaColaBear at 10:49, 17 April 2017

2017-04-17T10:49:57Z

← Older revision		Revision as of 10:49, 17 April 2017
Line 3:		Line 3:
	==Syntax==		==Syntax==
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	events.addCommand(commandName, ~~commandFunction~~);		void events.addCommand(string commandName, function handlerFunction);
	</syntaxhighlight>		</syntaxhighlight>
			===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====
			<syntaxhighlight lang="javascript">player playerSource, string fullText [, string arg1, string arg2, ...] </syntaxhighlight>
			*'''playerSource:''' The player who triggered the command.
			*'''fullText:''' All words after command name.
			*'''arg1, arg2, ...:''' Each word after command name.

	==Example==		==Example==
			'''Example 1:''' This example give weapon to current player with the specified number of ammo or 10000
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	mp.events.addCommand("weapon", (player, ~~fullCommandText~~, weapon, ammo) => {		mp.events.addCommand("weapon", (player, fullText, weapon, ammo) => {
	var weaponHash = mp.joaat(weapon);		var weaponHash = mp.joaat(weapon);

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

			});
			</syntaxhighlight>
			'''Example 2:''' This example implements /me command
			<syntaxhighlight lang="javascript">
			mp.events.addCommand("me", (player, message) => {
			mp.players.broadcast(`* ${player.name}: ${message}`);
	});		});
	</syntaxhighlight>		</syntaxhighlight>