OnPlayerCommand

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

The function PrivMessage and call onPlayerCommand were used in this example. More info about them in the corresponding pages.

Related Events

• onPlayerJoin( player )
• onPlayerPart( player, reason )

• onPlayerRequestClass( player, classID )
• onPlayerRequestSpawn( player )
• onPlayerSpawn( player )

• onPlayerDeath( player, reason )
• onPlayerKill( killer, player, reason, bodypart )
• onPlayerTeamKill( killer, player, reason, bodypart )

• onPlayerChat( player, message )
• onPlayerCommand( player, command, arguments )
• onPlayerPM( player, playerTo, message )

• onPlayerBeginTyping( player )
• onPlayerEndTyping( player )

• onLoginAttempt( playerName, password, ipAddress )
• onNameChangeable( player ) // Currently can't work.

• onPlayerMove( player, lastX, lastY, lastZ, newX, newY, newZ )
• onPlayerHealthChange( player, lastHP, newHP )
• onPlayerArmourChange( player, lastArmour, newArmour )
• onPlayerWeaponChange( player, oldWep, newWep )

• onKeyDown( player, bindID )
• onKeyUp( player, bindID )
• onPlayerAwayChange( player, newStatus )
• onPlayerSpectate( player, target )
• onPlayerCrashDump( player, crashReport )
• onPlayerNameChange( player, oldName, newName )
• onPlayerActionChange( player, oldAction, newAction )
• onPlayerStateChange( player, oldState, newState )
• onPlayerOnFireChange( player, isOnFireNow )
• onPlayerCrouchChange( player, isCrouchingNow )
• onPlayerGameKeysChange( player, oldKeys, newKeys )