Scripting/Squirrel/Functions/Player.Kick

From Vice City Multiplayer
Revision as of 18:47, 6 December 2015 by Skbyt (talk | contribs)
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing

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.