Scripting/Squirrel/Functions/KickPlayer

From Vice City Multiplayer
Revision as of 13:28, 9 March 2016 by KAKAN (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 kicks the player out of the server, i.e, disconnects the client from the server.

Syntax

KickPlayer( player )

Arguments

  • CPlayer player - the player instance, or, the one you want to kick.

Example

function onPlayerCommand( player, cmd, text );
if ( cmd == "kick" )
       {
		if ( player.Name == "Your Name" )
		{
			local plr = FindPlayer( text );
			if ( plr )
			{

		    ClientMessageToAll( "Admin:[ " + player.Name + " ] Kick:[ " + plr.Name + " ] [ Kick From the server ]" , 500, 102, 103 );                                          
          KickPlayer( plr )
		    }
        }			
		    else MessagePlayer( "---> Type /kick < player name >." , player);
	}

Notes

Call onPlayerCommand were used in this example. More info about them in the corresponding pages.