OnPlayerCommand: Difference between revisions

This wiki is using an old backup from 2020

Some information may be old/missing

Revision as of 16:48, 15 March 2016

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.

@@ Line 1: / Line 1: @@
 __NOTOC__
-When a player changes his weapon to newone or oldone.
+This is called when a player uses a command.
 == Syntax ==
-<pre>function onPlayerWeaponChange( player, oldwep, newwep )</pre>
+<pre>function onPlayerCommand( player, cmd, parameters )</pre>
 == Parameters ==
-* [[Scripting/Squirrel/Functions#Player_Functions|''Player'']] '''player''' - The player who changes the weapon.
+* string '''player''' - The player that use command.
-* '''oldwep''' - Players old weapon
+* string '''cmd''' - This is the command that player used.
-* '''newwep''' - Players new weapon
+* string '''parameters''' - This is the list of the parameters as a string.
 == Example ==
-If a player will try to change his weapon to "33" ( minigun ), this example will automatically set his weapons ammo to 0. and in result, he won't be able to use that weapon.
+This example command heal the player if they type '''/heal'''.
 <source lang=squirrel>
-function onPlayerWeaponChange( player, oldwep, newwep )
+function onPlayerCommand( player, cmd, text )
 {
-    if ( newwep == 33 )
+ if ( cmd == "heal" )
-    {
+ {
-        PrivMessage( player, "it is a blocked weapon" );
+  if ( player.Health == 100 ) PrivMessage( player, "You have the health to maximum.");
-        player.SetWeapon( 33,0 ); //sets weapons ammo to 0.
+  else
-    }
+  {
-return 1; //returns true for other weapons.
+   PrivMessage( player, "You healed successfully.");
+   player.Health = 100;
+ }
 }
 </source>
@@ Line 30: / Line 32: @@
 === Notes ===
-Function [[Scripting/Squirrel/Functions/PrivMessage|''PrivMessage'']] and function [[Scripting/Squirrel/Functions/Player.SetWeapon|''SetWeapon'']] were used in this example.
+Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
 == Related Events ==
-{{Scripting/Squirrel/Events/Player_Events}}
+{{Scripting/Squirrel/Events/Player/onPlayerCommand}}

OnPlayerCommand: Difference between revisions

Revision as of 16:48, 15 March 2016

Syntax

Parameters

Example

Notes

Related Events

Navigation menu

Search