Scripting/Squirrel/Functions/KickPlayer - Revision history

Thijn at 18:45, 30 January 2017

2017-01-30T18:45:41Z

← Older revision		Revision as of 18:45, 30 January 2017
Line 36:		Line 36:
	=== Notes ===		=== Notes ===
	Call [[Scripting/Squirrel/Events/Player/OnPlayerCommand\|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.		Call [[Scripting/Squirrel/Events/Player/OnPlayerCommand\|onPlayerCommand]] were used in this example. More info about them in the corresponding pages.

			== Related Functions ==

			{{Scripting/Squirrel/Functions/Player_Functions}}
			[[Category:Scripting/Squirrel/Functions/Player_Functions]]

PerikiyoXD at 19:34, 18 April 2016

2016-04-18T19:34:35Z

← Older revision		Revision as of 19:34, 18 April 2016
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 );
	{		{
	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 )
	}		}
	}		}

	~~by: kennedyarz~~

	</source>		</source>

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

Kennedyarz: /* Example */

2016-03-21T20:46:50Z

Example

← Older revision		Revision as of 20:46, 21 March 2016
Line 10:		Line 10:
	<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" )

Kennedyarz: /* Example */

2016-03-21T20:46:13Z

Example

← Older revision		Revision as of 20:46, 21 March 2016
Line 10:		Line 10:
	<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 == "~~Your Name~~" )		if ( player.Name == "kennedyarz" )
	{		{
	~~local~~ plr = FindPlayer( text );		if ( text )
	if ( plr )		{
	{		local plr = FindPlayer( text );
			if ( plr )
			{
			KickPlayer( plr );
			}
			else MessagePlayer( "[#ffffff]Invalid Player " , player );
			}
			else MessagePlayer( "[#ffffff]Type /kick <player> " , player );
			}
			else MessagePlayer( "[#F02F0F] Your are not admin. " , player )
			}
			}

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

	</source>		</source>

KAKAN at 13:28, 9 March 2016

2016-03-09T13:28:11Z

← Older revision		Revision as of 13:28, 9 March 2016
Line 1:		Line 1:
	~~{{Scripting/Needs_Text}}~~		This function kicks the player out of the server, i.e, disconnects the client from the server.

	== Syntax ==		== Syntax ==
			<pre>KickPlayer( player )</pre>

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

	~~<pre>KickPlayer( player )</pre>~~
	== Example ==		== Example ==
	<source lang=squirrel>		<source lang=squirrel>

Stormeus at 18:50, 26 July 2014

2014-07-26T18:50:49Z

← Older revision		Revision as of 18:50, 26 July 2014
Line 1:		Line 1:
			{{Scripting/Needs_Text}}

	== Syntax ==		== Syntax ==

Mariu22S: /* Example */

2014-07-25T15:26:42Z

Example

← Older revision		Revision as of 15:26, 25 July 2014
Line 14:		Line 14:

	ClientMessageToAll( "Admin:[ " + player.Name + " ] Kick:[ " + plr.Name + " ] [ Kick From the server ]" , 500, 102, 103 );		ClientMessageToAll( "Admin:[ " + player.Name + " ] Kick:[ " + plr.Name + " ] [ Kick From the server ]" , 500, 102, 103 );
	KickPlayer( plr )		KickPlayer( plr )
	}		}
	}		}

Mariu22S: /* Example */

2014-07-25T15:26:35Z

Example

← Older revision		Revision as of 15:26, 25 July 2014
Line 13:		Line 13:
	{		{

	ClientMessageToAll( "Admin:[ " + player.Name + " ] Kick:[ " + plr.Name + " ] [ Kick From the server ]" , 500, 102, 103 ); KickPlayer( plr )		ClientMessageToAll( "Admin:[ " + player.Name + " ] Kick:[ " + plr.Name + " ] [ Kick From the server ]" , 500, 102, 103 );
			KickPlayer( plr )
	}		}
	}		}

Mariu22S: /* Example */

2014-07-25T15:26:17Z

Example

← Older revision		Revision as of 15:26, 25 July 2014
Line 12:		Line 12:
	if ( plr )		if ( plr )
	{		{
	~~KickPlayer( plr )~~
	ClientMessageToAll( "Admin:[ " + player.Name + " ] Kick:[ " + plr.Name + " ] [ Kick From the server ]" , 500, 102, 103 );		ClientMessageToAll( "Admin:[ " + player.Name + " ] Kick:[ " + plr.Name + " ] [ Kick From the server ]" , 500, 102, 103 ); KickPlayer( plr )
	}		}
	}		}

Mariu22S: /* Syntax */

2014-07-25T08:38:35Z

Syntax

← Older revision		Revision as of 08:38, 25 July 2014
Line 2:		Line 2:

	<pre>KickPlayer( player )</pre>		<pre>KickPlayer( player )</pre>
			== Example ==
	<source lang=squirrel>		<source lang=squirrel>
	function onPlayerCommand( player, cmd, text );		function onPlayerCommand( player, cmd, text );