Scripting/Squirrel/Functions/KickPlayer: Difference between revisions

From Vice City Multiplayer
Jump to navigation Jump to search
Caution icon
This wiki is using an old backup from 2020
Some information may be old/missing
No edit summary
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
This function kicks the player out of the server, i.e, disconnects the client from the server.
This function disconnects a client from the server, aka kick a player.


== Syntax ==
== Syntax ==
Line 5: Line 5:


== Arguments ==
== Arguments ==
* ''CPlayer'' '''player''' - the player instance, or, the one you want to kick.
* ''CPlayer'' '''player''' - the player you are going to kick.


== Example ==
== Example ==
This example shows how to create a command to kick players.
<source lang=squirrel>
<source lang=squirrel>
function onPlayerCommand( player, cmd, text );
function onPlayerCommand( player, cmd, text );
function onPlayerCommand( player, cmd, text )
{
{
if ( cmd == "kick" )
if ( cmd == "kick" )
    {
{
        if ( player.Name == "kennedyarz" )
if ( player.Name == "Noob69" || player.Name == "Antonio_Morales" ) //This players can execute the command.
        {
{
            if ( text )
if ( text )
            {
{
           local plr = FindPlayer( text );
local plr = FindPlayer( text );
               if ( plr )
if ( plr )
               {
{
               KickPlayer( plr );
KickPlayer( plr );
               }
}
               else MessagePlayer( "[#ffffff]Invalid Player " , player );
else MessagePlayer( "Cannot find player "+text+"." , player );
            }
}
            else MessagePlayer( "[#ffffff]Type /kick <player> " , player );
else MessagePlayer( "Usage: /"+cmd+" <player>" , player );
        }
}
        else MessagePlayer( "[#F02F0F] Your are not admin. " , player )
else MessagePlayer( "You are not allowed to use this command." , player )
    }
}
}
}
</source>


by: kennedyarz
=== Notes ===
Call [[Scripting/Squirrel/Events/Player/OnPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.


</source>
== Related Functions ==


=== Notes ===
{{Scripting/Squirrel/Functions/Player_Functions}}
Call [[Scripting/Squirrel/Events/Player/onPlayerCommand|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Latest revision as of 18:45, 30 January 2017

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.

Related Functions

Player Game Functions

These functions exist for compatibility with the R2 Squirrel server.

Retrieved from "http://wiki.vc-mp.org/index.php?title=Scripting/Squirrel/Functions/KickPlayer&oldid=19683"