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
mNo edit summary
No edit summary
Line 34: Line 34:
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.


== Related Events ==
== Related Functions ==


{{Scripting/Squirrel/Events/Player_Events}}
{{Scripting/Squirrel/Events/Player_Events}}
[[Category:Scripting/Squirrel/Events/Player_Events]]

Revision as of 22:16, 30 January 2017

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 text - 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 Functions