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/OnHandshake.lua | 29 ++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnHandshake.lua

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

diff --git a/MCServer/Plugins/APIDump/Hooks/OnHandshake.lua b/MCServer/Plugins/APIDump/Hooks/OnHandshake.lua
new file mode 100644
index 000000000..6183cc506
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnHandshake.lua
@@ -0,0 +1,29 @@
+return
+{
+	HOOK_HANDSHAKE =
+	{
+		CalledWhen = "A client is connecting.",
+		DefaultFnName = "OnHandshake",  -- also used as pagename
+		Desc = [[
+			This hook is called when a client sends the Handshake packet. At this stage, only the client IP and
+			(unverified) username are known. Plugins may refuse access to the server based on this
+			information.</p>
+			<p>
+			Note that the username is not authenticated - the authentication takes place only after this hook is
+			processed.
+		]],
+		Params =
+		{
+			{ Name = "Client", Type = "{{cClientHandle}}", Notes = "The client handle representing the connection. Note that there's no {{cPlayer}} object for this client yet." },
+			{ Name = "UserName", Type = "string", Notes = "The username presented in the packet. Note that this username is unverified." },
+		},
+		Returns = [[
+			If the function returns false, the user is let in to the server. If the function returns true, no
+			other plugin's callback is called, the user is kicked and the connection is closed.
+		]],
+	},  -- HOOK_HANDSHAKE
+}
+
+
+
+
-- 
cgit v1.2.3