Skip to main content

PlayerCommand

This event is triggered when a player sends a command.

Server-side event

JavaScript​

Parameters​

  • player: Player - player, who send command.
  • command: String - command (without slash) with arguments.

Example​

This example will write "Hello!" to player, who will enter command /meetme into chatbox.s

mp.events.add("playerCommand", (player, command) => {
	const args = command.split(/[ ]+/);
	const commandName = args.splice(0, 1)[0];

	if (commandName === "meetme") {
		player.outputChatBox("Hello!");
	}
});

Example​

Detecting Invalid Commands:

mp.events.add('playerCommand', (player, command) => {
    player.outputChatBox(`${command} is not a valid command. Use /help to find a list of commands.`);
});
Client-side event

C#​

public delegate void OnPlayerCommandDelegate(string cmd, CancelEventArgs cancel);

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.

Events.OnPlayerCommand += OnPlayerCommand;
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);
    }
}

JavaScript​

Parameters​

  • command: String - command (without slash) with arguments.

Example​

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]"

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(",")}]`);
	}
});