PlayerCommand - Revision history

RoboN1X at 14:53, 23 May 2019

2019-05-23T14:53:32Z

@@ Line 1: / Line 1: @@
 This event is triggered when a player sends a command.
-{{ServersideCsJsEvent}}
+{{ServersideJsEvent}}
 {{JSContainer|
 {{Parameters}}
-* '''player''' - player, who send command.
+* '''player''': {{RageType|Player}} - [[:Category:Player API|player]], who send command.
-* '''command''' - string with arguments.
+* '''command''': {{RageType|String}} - command (without slash) with arguments.
 {{Example}}
@@ Line 21: / Line 22: @@
 {{Example}}
 '''Detecting Invalid Commands: '''
 <pre>
@@ Line 45: / Line 29: @@
 </pre>
 }}
 {{ClientsideCsJsEvent}}
 {{CSharpContainer|
-<syntaxhighlight lang="c#">
+<syntaxhighlight lang="csharp">
 public delegate void OnPlayerCommandDelegate(string cmd, CancelEventArgs cancel);
 </syntaxhighlight>
@@ Line 74: / Line 60: @@
 </syntaxhighlight>
 }}
 ==See also==
 {{Player_events}}

RoboN1X: Category

2019-04-30T10:48:52Z

TedJr: Fixes last page edition

2019-02-09T03:13:00Z

Fixes last page edition

← Older revision		Revision as of 03:13, 9 February 2019
Line 38:		Line 38:
	</pre>		</pre>

	'''Detecting ~~invalid commands~~:		'''Detecting Invalid Commands: '''
	<pre>		<pre>
	mp.events.add('playerCommand', (player, command) => {		mp.events.add('playerCommand', (player, command) => {
Line 72:		Line 72:
	}		}
	}		}
			</syntaxhighlight>

	}}		}}
	==See also==		==See also==
	{{Player_events}}		{{Player_events}}

TedJr: Adds detection for unknown commands

2019-02-09T03:10:07Z

Adds detection for unknown commands

← Older revision		Revision as of 03:10, 9 February 2019
Line 35:		Line 35:
	mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(",")}]`);		mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(",")}]`);
	}		}
			});
			</pre>

			'''Detecting invalid commands:
			<pre>
			mp.events.add('playerCommand', (player, command) => {
			player.outputChatBox(`${command} is not a valid command. Use /help to find a list of commands.`);
	});		});
	</pre>		</pre>
Line 65:		Line 72:
	}		}
	}		}
	~~</syntaxhighlight>~~

	}}		}}
	==See also==		==See also==
	{{Player_events}}		{{Player_events}}

Sake at 00:13, 29 November 2018

2018-11-29T00:13:40Z

← Older revision		Revision as of 00:13, 29 November 2018
Line 1:		Line 1:
			This event is triggered when a player sends a command.

	~~This event is triggered when player send command .~~		{{ServersideCsJsEvent}}
			{{JSContainer\|
	==Parameters==		{{Parameters}}
	* '''player''' - player, who send command.		* '''player''' - player, who send command.
	* '''command''' - string with arguments.		* '''command''' - string with arguments.

	==Example ~~#1==~~		{{Example}}
	This example will write "Hello!" to player, who will enter command /meetme into chatbox.s		This example will write "Hello!" to player, who will enter command /meetme into chatbox.s
	~~{{ServersideCode\|~~
	<pre>		<pre>
	mp.events.add("playerCommand", (player, command) => {		mp.events.add("playerCommand", (player, command) => {
Line 19:		Line 19:
	});		});
	</pre>		</pre>
	}}

	==Example ~~#2==~~		{{Example}}
	This example will output info about entered command into client chatbox.		This example will output info about entered command into client chatbox.

	if you enter "/blah 123 566", it will output next message:		if you enter "/blah 123 566", it will output next message:
	"You enter command a "blah", and all arguments it a [123,566]"		"You enter command a "blah", and all arguments it a [123,566]"
	~~{{ServersideCode\|~~
	<pre>		<pre>
	mp.events.add("playerCommand", (command) => {		mp.events.add("playerCommand", (command) => {
Line 40:		Line 38:
	</pre>		</pre>
	}}		}}
			{{ClientsideCsJsEvent}}
			{{CSharpContainer\|
			<syntaxhighlight lang="c#">
			public delegate void OnPlayerCommandDelegate(string cmd, CancelEventArgs cancel);
			</syntaxhighlight>

			{{Parameters}}
			* '''cmd''': colshape, expects '''System.String''' type.
			* '''cancel''': cancel, expects '''RAGE.Events.CancelEventArgs''' type.

			{{Example}}
			This example will set player restore player health to max when command '''/heal''' is used, or set players armour to max when command '''/armour''' is used.
			<syntaxhighlight lang="c#">
			Events.OnPlayerCommand += OnPlayerCommand;
			</syntaxhighlight>
			<syntaxhighlight lang="c#">
			public void OnPlayerCommand(string cmd, RAGE.Events.CancelEventArgs cancel)
			{
			if (cmd == "heal")
			{
			RAGE.Elements.Player.LocalPlayer.SetHealth(100);
			}
			else if (cmd == "armour")
			{
			RAGE.Elements.Player.LocalPlayer.SetArmour(100);
			}
			}
			</syntaxhighlight>
			}}
	==See also==		==See also==
	{{Player_events}}		{{Player_events}}

Rootcause: Replaced HTML with template

2018-10-26T12:06:47Z

Replaced HTML with template

← Older revision		Revision as of 12:06, 26 October 2018
Line 8:		Line 8:
	==Example #1==		==Example #1==
	This example will write "Hello!" to player, who will enter command /meetme into chatbox.s		This example will write "Hello!" to player, who will enter command /meetme into chatbox.s
	~~<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>
	<~~syntaxhighlight lang="javascript"~~>
	mp.events.add("playerCommand", (player, command) => {		mp.events.add("playerCommand", (player, command) => {
	const args = command.split(/[ ]+/);		const args = command.split(/[ ]+/);
Line 19:		Line 18:
	}		}
	});		});
	</~~syntaxhighlight~~>		</pre>
	~~</div>~~		}}

	==Example #2==		==Example #2==
Line 27:		Line 26:
	if you enter "/blah 123 566", it will output next message:		if you enter "/blah 123 566", it will output next message:
	"You enter command a "blah", and all arguments it a [123,566]"		"You enter command a "blah", and all arguments it a [123,566]"
	~~<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">~~		{{ServersideCode\|
	~~<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>~~		<pre>
	<~~syntaxhighlight lang="javascript"~~>
	mp.events.add("playerCommand", (command) => {		mp.events.add("playerCommand", (command) => {
	const args = command.split(/[ ]+/);		const args = command.split(/[ ]+/);
Line 40:		Line 38:
	}		}
	});		});
	</~~syntaxhighlight~~>		</pre>
	~~</div>~~		}}

	==See also==		==See also==
	{{Player_events}}		{{Player_events}}

Aurusse: remove unnecessary semicolons and add a semicolon at the right place

2018-07-30T15:36:37Z

remove unnecessary semicolons and add a semicolon at the right place

← Older revision		Revision as of 15:36, 30 July 2018
Line 17:		Line 17:
	if (commandName === "meetme") {		if (commandName === "meetme") {
	player.outputChatBox("Hello!");		player.outputChatBox("Hello!");
	};		}
	});		});
	</syntaxhighlight>		</syntaxhighlight>
Line 37:		Line 37:

	if (commandName === "blah") {		if (commandName === "blah") {
	mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(",")}]`)		mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(",")}]`);
	};		}
	});		});
	</syntaxhighlight>		</syntaxhighlight>

CocaColaBear at 20:35, 15 October 2017

2017-10-15T20:35:20Z

← Older revision		Revision as of 20:35, 15 October 2017
Line 11:		Line 11:
	<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	mp.events.add("playerCommand",		mp.events.add("playerCommand", (player, command) => {
	(player, command) => {		const args = command.split(/[ ]+/);
	const args = command.split(/[ ]+/);		const commandName = args.splice(0, 1)[0];
	const commandName = args.splice(0, 1)[0];

	if (commandName == "meetme") {		if (commandName === "meetme") {
	player.outputChatBox("Hello!");		player.outputChatBox("Hello!");
	};		};
	}		});
	);
	</syntaxhighlight>		</syntaxhighlight>
	</div>		</div>
Line 32:		Line 30:
	<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>		<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	mp.events.add(`playerCommand`,		mp.events.add("playerCommand", (command) => {
	(command) => {		const args = command.split(/[ ]+/);
	const args = command.split(/[ ]+/);		const commandName = args[0];
	const commandName = args[0];
	args.shift();		args.shift();

	if (commandName == `blah`) {		if (commandName === "blah") {
	mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(`,`)}]`)		mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(",")}]`)
	};		};
	}		});
	);
	</syntaxhighlight>		</syntaxhighlight>
	</div>		</div>

SalwadoR at 15:26, 26 September 2017

2017-09-26T15:26:06Z

← Older revision		Revision as of 15:26, 26 September 2017
Line 3:		Line 3:

	==Parameters==		==Parameters==
	* '''player - player, who send command.'''		* '''player''' - player, who send command.
	* '''~~command~~ - string with arguments.~~'''~~		* '''command''' - string with arguments.

	==Example #1==		==Example #1==

SalwadoR at 09:38, 26 September 2017

2017-09-26T09:38:41Z

← Older revision		Revision as of 09:38, 26 September 2017
Line 6:		Line 6:
	* '''command - string with arguments.'''		* '''command - string with arguments.'''

	==Example==		==Example #1==
			This example will write "Hello!" to player, who will enter command /meetme into chatbox.s
	<div class="header" style="background-color: #408DAE; color: #FFFFFF; border: 2px solid #408DAE;">		<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>		<div style="margin: 10px 10px 10px 10px;"><b>Server-Side</b></div>
	<syntaxhighlight lang="javascript">		<syntaxhighlight lang="javascript">
	mp.events.add(		mp.events.add("playerCommand",
	{		(player, command) => {
	"playerCommand": (player, command) => {		const args = command.split(/[ ]+/);
	~~let~~ args = command.split(/[ ]+/);		const commandName = args.splice(0, 1)[0];

	const commandName = args.splice(0, 1)[0];		if (commandName == "meetme") {
	if (commandName == "meetme") {		player.outputChatBox("Hello!");
	player.outputChatBox("Hello!");		};
	}		}
	}		);
	}		</syntaxhighlight>
			</div>

			==Example #2==
			This example will output info about entered command into client chatbox.

			if you enter "/blah 123 566", it will output next message:
			"You enter command a "blah", and all arguments it a [123,566]"
			<div class="header" style="background-color: #AE4040; color: #FFFFFF; border: 2px solid #AE4040;">
			<div style="margin: 10px 10px 10px 10px;"><b>Client-Side</b></div>
			<syntaxhighlight lang="javascript">
			mp.events.add(`playerCommand`,
			(command) => {
			const args = command.split(/[ ]+/);
			const commandName = args[0];
			args.shift();

			if (commandName == `blah`) {
			mp.gui.chat.push(`You enter command a "${commandName}", and all arguments it a [${args.join(`,`)}]`)
			};
			}
	);		);
	</syntaxhighlight>		</syntaxhighlight>

← Older revision		Revision as of 10:48, 30 April 2019
Line 76:		Line 76:
	==See also==		==See also==
	{{Player_events}}		{{Player_events}}

			[[Category:Player]]
			[[Category:Server-side Event]]
			[[Category:Client-side Event]]