BanPlayer

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

This function bans a player from the server.

Syntax

bool BanPlayer( Player plr, [BanType type] )

Arguments

• plr - Pointer of the player to ban
• type - The type of ban to add. This can be any of the BANTYPE_ constants. Defaults to BANTYPE_IP

Example

This will ban anybody called 'Bob'

 
function onPlayerJoin( player )
{
     if ( player.Name == "Bob" )
     {
          MessagePlayer( "NO BOBS ALLOWED!", player );
          BanPlayer( player );
     }
}
 

Notes

The functions Player.Name, MessagePlayer and call onPlayerJoin were used in in this example. More info about there in the corresponding pages.

Related Functions

• BanIP
• BanPlayer
• BanLUID
• UnbanLUID
• UnbanName
• GetBodyPartName
• GetDistrictName
• KickPlayer
• print
• SendRconCommand
• UnbanIP