Scripting/Squirrel/Functions/Player.Kick

From Vice City Multiplayer
Jump to navigation Jump to search

This function will kick Player defined.

Syntax

player.Kick();

Example

This example kicks player on move if the ping is >/= to 300.

function onPlayerMove( player, x1, y1, z1, x2, y2, z2 )
{
     if( player.Ping >= 300 )  
     ClientMessageToAll( player.Name + " has been kicked for high ping." , 255, 0, 0 ); 
     player.Kick();
}

Notes

Function ClientMessageToAll and event onPlayerMove were used in this example. More info about them in corresponding pages.

Related Functions

Player Game Functions

These functions exist for compatibility with the R2 Squirrel server.