onPlayerCommand

Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This is called when a player types a command.

Syntax

function onPlayerCommand( Player player, string command, string args )

Arguments

• player - The pointer of the player
• command - This is the typed command
• args - This is the list of parameters as a string

Returns

This event does not handle return values.

Example

This example command slaps the user if they type '/slap'.

 
function onPlayerCommand( player, cmd, text )
{
     if ( cmd == "slap" )
     {
          local pos = player.Pos;
          pos.z += 5.0;
          
          player.Pos = pos;
          MessagePlayer( "You slapped yourself! That wasn't very smart.", player );
     }
     
     return 1;
}
 

Notes

The functions MessagePlayer and [[Squirrel/Server/Functions/Players/Pos|Player.Pos] were used in this example. More info about them can be found in the corresponding pages.

Related Events

• onPlayerAction
• onPlayerArmourChange
• onPlayerCashChange
• onPlayerChat
• onPlayerCommand
• onPlayerConnect
• onPlayerDeath
• onPlayerFall
• onPlayerHealthChange
• onPlayerIslandChange
• onPlayerJoin
• onPlayerKeyStateChange
• onPlayerKill
• onPlayerPart
• onPlayerScoreChange
• onPlayerSkinChange
• onPlayerSpawn
• onPlayerUpdate
• onPlayerTeamChange
• onPlayerUseDetonator
• onPlayerVirtualWorldChange
• onPlayerWeaponChange