Squirrel/Server/Functions/Misc/KickPlayer

From Liberty Unleashed Wiki
(Difference between revisions)
Jump to: navigation, search
(updated)
Line 4: Line 4:
 
== Syntax ==
 
== Syntax ==
  
−
<code>bool KickPlayer( player plr )</code>
+
<code>bool KickPlayer( Player plr )</code>
  
 
== Arguments ==
 
== Arguments ==
Line 15: Line 15:
  
 
<code lang="squirrel">
 
<code lang="squirrel">
−
function OnPlayerJoin( player )
+
function onPlayerJoin( player )
 
{
 
{
 
     if ( player.Name != "Bob" )
 
     if ( player.Name != "Bob" )
Line 27: Line 27:
 
=== Notes ===
 
=== Notes ===
  
−
The calls [[Squirrel/Events/Player/OnPlayerJoin|OnPlayerJoin]] and [[Squirrel/Functions/Misc/MessagePlayer|MessagePlayer]] were used in in this example. More info about there in the corresponding pages.
+
The functions [[Squirrel/Server/Functions/Players/Name|Player.Name]], [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] and call [[Squirrel/Server/Events/Players/onPlayerJoin|onPlayerJoin]] were used in in this example. More info about there in the corresponding pages.
  
 
== Related Functions ==
 
== Related Functions ==
  
−
{{Squirrel/Functions/Misc}}
+
{{Squirrel/Server/Functions/Misc}}

Revision as of 01:49, 27 November 2009

This function kicks a player from the server

Syntax 

  1. bool KickPlayer( Player plr )

Arguments

  • plr - pointer of the player to kick

Example

This will kick a player on join if his name is not 'Bob' 

  1.  
  2. function onPlayerJoin( player )
  3. {
  4.      if ( player.Name != "Bob" )
  5.      {
  6.           MessagePlayer( "Your name isn't Bob! Only Bob is allowed on this server!.", player );
  7.           KickPlayer( player );
  8.      }
  9. }
  10.  

Notes

The functions Player.Name, MessagePlayer and call onPlayerJoin were used in in this example. More info about there in the corresponding pages.

Related Functions

Retrieved from "http://liberty-unleashed.co.uk/libertywiki/index.php?title=Squirrel/Server/Functions/Misc/KickPlayer&oldid=611"
Personal tools
Namespaces

Variants
Actions
Navigation
scripting
Toolbox