From d9dc241e6fe669585d7c0b13d55818a22e1c76bc Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Sat, 23 Nov 2013 21:26:24 +0100
Subject: APIDump: The descriptions are read from multiple files.

All the files in the Classes subfolder are read for class descriptions, and in the Hooks subfolder for the hook descriptions.
---
 MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua | 32 +++++++++++++++++++++++++
 1 file changed, 32 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua

(limited to 'MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua')

diff --git a/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua b/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua
new file mode 100644
index 000000000..496e0d751
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua
@@ -0,0 +1,32 @@
+return
+{
+	HOOK_DISCONNECT =
+	{
+		CalledWhen = "A player has explicitly disconnected.",
+		DefaultFnName = "OnDisconnect",  -- also used as pagename
+		Desc = [[
+			This hook is called when a client sends the disconnect packet and is about to be disconnected from
+			the server.</p>
+			<p>
+			Note that this callback is not called if the client drops the connection or is kicked by the
+			server.</p>
+			<p>
+			FIXME: There is no callback for "client destroying" that would be called in all circumstances.</p>
+		]],
+		Params =
+		{
+			{ Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has disconnected" },
+			{ Name = "Reason", Type = "string", Notes = "The reason that the client has sent in the disconnect packet" },
+		},
+		Returns = [[
+			If the function returns false or no value, MCServer calls other plugins' callbacks for this event
+			and finally broadcasts a disconnect message to the player's world. If the function returns true, no
+			other plugins are called for this event and the disconnect message is not broadcast. In either case,
+			the player is disconnected.
+		]],
+	},  -- HOOK_DISCONNECT
+}
+
+
+
+
-- 
cgit v1.2.3