diff options
author | madmaxoft <github@xoft.cz> | 2014-02-09 09:36:42 +0100 |
---|---|---|
committer | madmaxoft <github@xoft.cz> | 2014-02-09 09:36:42 +0100 |
commit | a184d592097c24c8796e8680e2ef7fdfe081305d (patch) | |
tree | 20df62dcde07191f927d9df8916375a25c8ccc87 /MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua | |
parent | Moved a forgotten comment back to its place. (diff) | |
parent | Merge branch 'master' into playerimprovements (diff) | |
download | cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.gz cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.bz2 cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.lz cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.xz cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.zst cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.zip |
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua')
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua | 16 |
1 files changed, 6 insertions, 10 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua b/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua index 496e0d751..a3301a8c6 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua @@ -5,13 +5,10 @@ return 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> + This hook is called when a client is about to be disconnected from the server, for whatever reason. + + <p><b>Note that this hook will be removed after <1.7 protocol support is removed, as it was originally a hook for + the client sending the server a disconnect packet, which no longer happens.</b></p> ]], Params = { @@ -19,9 +16,8 @@ return { 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, + If the function returns false or no value, MCServer calls other plugins' callbacks for this event. + If the function returns true, no other plugins are called for this event. In either case, the player is disconnected. ]], }, -- HOOK_DISCONNECT |