summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-14 16:59:45 +0200
committermadmaxoft <github@xoft.cz>2013-10-14 16:59:45 +0200
commit5c24d5acd7adcfa5a0bd121275f54b7d67505afb (patch)
tree10b18bb1735255aa0c4cdb9414fd40530bf5cb64 /MCServer/Plugins/APIDump/APIDesc.lua
parentAPIDump: Documented HOOK_EXPLODING. (diff)
downloadcuberite-5c24d5acd7adcfa5a0bd121275f54b7d67505afb.tar
cuberite-5c24d5acd7adcfa5a0bd121275f54b7d67505afb.tar.gz
cuberite-5c24d5acd7adcfa5a0bd121275f54b7d67505afb.tar.bz2
cuberite-5c24d5acd7adcfa5a0bd121275f54b7d67505afb.tar.lz
cuberite-5c24d5acd7adcfa5a0bd121275f54b7d67505afb.tar.xz
cuberite-5c24d5acd7adcfa5a0bd121275f54b7d67505afb.tar.zst
cuberite-5c24d5acd7adcfa5a0bd121275f54b7d67505afb.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua23
1 files changed, 23 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 871b04543..12665888b 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2488,6 +2488,29 @@ end;
]],
}, -- HOOK_EXPLODING
+ 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
+
}, -- Hooks[]