Scripting/Squirrel/Functions/KickPlayer

This function disconnects a client from the server, aka kick a player.

Syntax

KickPlayer( player )

Arguments

• CPlayer player - the player you are going to kick.

Example

This example shows how to create a command to kick players.

function onPlayerCommand( player, cmd, text );
{
	if ( cmd == "kick" )
	{
		if ( player.Name == "Noob69" || player.Name == "Antonio_Morales" ) //This players can execute the command.
		{
			if ( text )
			{
				local plr = FindPlayer( text );
				if ( plr )
				{
					KickPlayer( plr );
				}
				else MessagePlayer( "Cannot find player "+text+"." , player );
			}
			else MessagePlayer( "Usage: /"+cmd+" <player>" , player );
		}
		else MessagePlayer( "You are not allowed to use this command." , player )
	}
}

Notes

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