Server now handles join messages also

* Revised as well hook documentation
2014-02-03 21:12:44 +00:00
parent c1c7936c68
commit b5e898a608
5 changed files with 35 additions and 27 deletions
@@ -2,17 +2,21 @@ return
 {
 	HOOK_PLAYER_DESTROYED =
 	{
-		CalledWhen = "A player is about to get destroyed.",
+		CalledWhen = "A player object is about to be destroyed.",
 		DefaultFnName = "OnPlayerDestroyed",  -- also used as pagename
 		Desc = [[
-			This function is called when a {{cPlayer|player}} is about to get destroyed. But the player isn't already destroyed.
+			This function is called before a {{cPlayer|player}} is about to be destroyed.
+			The player has disconnected for whatever reason and is no longer in the server.
+			If a plugin returns true, a leave message is not broadcast, and vice versa.
+			However, whatever the return value, the player object is removed from memory.
 		]],
 		Params =
 		{
 			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The destroyed player" },
 		},
 		Returns = [[
-			It's only for notification. Can't be returned.
+			If the function returns false or no value, other plugins' callbacks are called and a leave message is broadcast.
+			If the function returns true, no other callbacks are called for this event and no leave message appears. Either way the player is removed internally. 
 		]],
 	},  -- HOOK_PLAYER_DESTROYED
 }