OnPlayerCommand: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
No edit summary
(Fixed arguments. (again))
Line 8: Line 8:
== Parameters ==
== Parameters ==


* string '''player''' - The player that use command.
* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player that used the command.
* string '''cmd''' - This is the command that player used.
* ''string'' '''cmd''' - The command that player used.
* string '''parameters''' - This is the list of the parameters as a string.
* ''string'' '''parameters''' - List of command parameters as string.


== Example ==
== Example ==

Revision as of 14:56, 14 November 2016

This is called when a player uses a command.

Syntax

function onPlayerCommand( player, cmd, parameters )

Parameters

  • Player player - The player that used the command.
  • string cmd - The command that player used.
  • string parameters - List of command parameters as string.

Example

This example command heal the player if they type /heal.

function onPlayerCommand( player, cmd, text )
{
 if ( cmd == "heal" )
 {
  if ( player.Health == 100 ) PrivMessage( player, "You have the health to maximum.");
  else 
  {
   PrivMessage( player, "You healed successfully.");
   player.Health = 100;
 }
}

Notes

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Events