Squirrel/Server/Functions/Misc/KickPlayer

Revision as of 04:14, 14 November 2009

This function kicks a player from the server

Syntax

bool KickPlayer( player plr )

Arguments

• plr - pointer of the player to kick

Example

This will kick a player on join if his name is not 'Bob'

 
function OnPlayerJoin( player )
{
     if ( player.Name != "Bob" )
     {
          MessagePlayer( "Your name isn't Bob! Only Bob is allowed on this server!.", player );
          KickPlayer( player );
     }
}
 

Notes

The calls OnPlayerJoin and MessagePlayer were used in in this example. More info about there in the corresponding pages.

Related Functions

Template:Squirrel/Functions/Misc