diff options
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua')
| -rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua | 38 |
1 files changed, 0 insertions, 38 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua b/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua deleted file mode 100644 index ae872a3ad..000000000 --- a/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua +++ /dev/null @@ -1,38 +0,0 @@ -return -{ - HOOK_DISCONNECT = - { - CalledWhen = [[ - A client has disconnected, either by explicitly sending the disconnect packet (in older protocols) or - their connection was terminated - ]], - DefaultFnName = "OnDisconnect", -- also used as pagename - Desc = [[ - This hook is called when a client has disconnected from the server, for whatever reason. It is also - called when the client sends the Disconnect packet (only in pre-1.7 protocols). This hook is not called - for server ping connections.</p> - <p> - Note that the hook is called even for connections to players who failed to auth. In such a case there's - no {{cPlayer}} object associated with the client.</p> - <p> - See also the {{OnHandshake|HOOK_HANDSHAKE}} hook which is called when the client connects (and presents - a handshake message, so that they are not just status-pinging). If you need to store a per-player - object, use the {{OnPlayerJoined|HOOK_PLAYER_JOINED}} and {{OnPlayerDestroyed|HOOK_PLAYER_DESTROYED}} - hooks instead, those are guaranteed to have the {{cPlayer}} object associated. - ]], - Params = - { - { Name = "Client", Type = "{{cClientHandle}}", Notes = "The client 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, Cuberite calls other plugins' callbacks for this event. - If the function returns true, no other plugins are called for this event. In either case, - the client is disconnected. - ]], - }, -- HOOK_DISCONNECT -} - - - - |