Squirrel/Server/Events/Player/onPlayerPart

Latest revision as of 19:43, 22 December 2010

This is called when a player disconnects from the server.

function onPlayerPart( Player player, int reason )

This event does not handle return values.

This example will say <name> left the server when a player leaves the server.

 
function onPlayerPart( player, reason )
{
     Message( "* " + player.Name + " left the server" );
     
     return 1;
}

The functions Message and Player.Name were used in this example. More info about them can be found in the corresponding pages.

@@ Line 1: / Line 1: @@
-__NOTOC__
+{{Squirrel/Title|onPlayerPart}}
-This is called when a player leaves the server.
+This is called when a player disconnects from the server.
 == Syntax ==
@@ Line 6: / Line 6: @@
 <code>function onPlayerPart( Player player, int reason )</code>
-== Parameters ==
+=== Arguments ===
 * '''player''' - The pointer of the new player
 * '''reason''' - The [[Squirrel/Server/Constants#Part_Reasons|reason ID]] for the part
+=== Returns ===
+This event does not handle return values.
 == Example ==
-This will say ''<name> left the server'' when a player leaves the server
+This example will say ''<name> left the server'' when a player leaves the server.
 <code lang="squirrel">
 function onPlayerPart( player, reason )
 {
-     Message( player.Name + " left the server" );
+     Message( "* " + player.Name + " left the server" );
      return 1;
@@ Line 26: / Line 30: @@
 === Notes ===
-The function [[Squirrel/Server/Functions/Messages/MessagePlayer|MessagePlayer]] was used in in this example. More info about it in the corresponding page.
+The functions [[Squirrel/Server/Functions/Messages/Message|Message]] and [[Squirrel/Server/Functions/Players/Name|Player.Name]] were used in this example. More info about them can be found in the corresponding pages.
 == Related Functions ==
 {{Squirrel/Server/Events/Player}}