Scripting/Squirrel/Functions/Player.Kick: 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
No edit summary
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{Scripting/Needs_Text}}
This function will kick Player defined.


== Syntax ==
== Syntax ==
Line 5: Line 5:
<pre>player.Kick();</pre>
<pre>player.Kick();</pre>


{{Scripting/Needs_Example}}
== Example ==
 
This example kicks player on move if the ping is >/= to 300.
 
<source lang="squirrel">
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();
}
</source>
 
=== Notes ===
 
Function [[Scripting/Squirrel/Functions/ClientMessageToAll|ClientMessageToAll]] and event [[Scripting/Squirrel/Events/onPlayerMove|onPlayerMove]] were used in this example. More info about them in corresponding pages.
 
== Related Functions ==
 
{{Scripting/Squirrel/Functions/Player_Functions}}
[[Category:Scripting/Squirrel/Functions/Player_Functions]]

Latest revision as of 18:50, 30 January 2017

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.

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