onPlayerCommand

From Liberty Unleashed Wiki
Jump to: navigation, search
Home   |   Squirrel Scripting   |   Server Functions   |   Server Events   |   Client Functions   |   Client Events

This is called when a player types a command.

Syntax

  1. 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'.

  1.  
  2. function onPlayerCommand( player, cmd, text )
  3. {
  4. if ( cmd == "slap" )
  5. {
  6. local pos = player.Pos;
  7. pos.z += 5.0;
  8. player.Pos = pos;
  9. MessagePlayer( "You slapped yourself! That wasn't very smart.", player );
  10. }
  11. return 1;
  12. }
  13.  

Notes

The functions MessagePlayer and Player.Pos were used in this example. More info about them can be found in the corresponding pages.

Related Events

Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox