Scripting/Squirrel/Events/Player/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
(Created page with "__NOTOC__ This is called when a player uses a command. == Syntax == <pre>function onPlayerCommand( player, cmd, parameters )</pre> == Parameters == * string '''player''' -...")
 
No edit summary
Line 8: Line 8:
== Parameters ==
== Parameters ==


* string '''player''' - The pointer of the player.
* string '''player''' - The player that use command.
* string '''cmd''' - This is the command player used.
* string '''cmd''' - This is the command that player used.
* string '''parameters''' - This is the list of the parameters as a string.
* string '''parameters''' - This is the list of the parameters as a string.


Line 36: Line 36:
== Related Events ==
== Related Events ==


{{Squirrel/Events/Player}}
{{Scripting/Squirrel/Events/onPlayerCommand}}

Revision as of 09:11, 24 July 2014

This is called when a player uses a command.

Syntax

function onPlayerCommand( player, cmd, parameters )

Parameters

  • string player - The player that use command.
  • string cmd - This is the command that player used.
  • string parameters - This is the list of the parameters as a 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

Template:Scripting/Squirrel/Events/onPlayerCommand