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
 
Line 32: Line 32:
=== Notes ===
=== Notes ===


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]] and functions [[Scripting/Squirrel/Functions/PrivMessage|PrivMessage]] + [[Scripting/Squirrel/Functions/Player.Health|player.Health]] were used in this example. More info about them in the corresponding pages.


== Related Functions ==
== Related Functions ==

Latest revision as of 19:28, 4 August 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 and functions PrivMessage + player.Health were used in this example. More info about them in the corresponding pages.

Related Functions