summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua
diff options
context:
space:
mode:
authorMattes D <github@xoft.cz>2015-08-26 10:58:51 +0200
committerMattes D <github@xoft.cz>2015-09-05 22:01:21 +0200
commitdac97826f7d0c9b9135c1a08c4d5f16b61494bd1 (patch)
treeec17a9703fe734956e4f151cb5306befc4fd7571 /MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua
parentMerge pull request #2459 from cuberite/fixes (diff)
downloadcuberite-dac97826f7d0c9b9135c1a08c4d5f16b61494bd1.tar
cuberite-dac97826f7d0c9b9135c1a08c4d5f16b61494bd1.tar.gz
cuberite-dac97826f7d0c9b9135c1a08c4d5f16b61494bd1.tar.bz2
cuberite-dac97826f7d0c9b9135c1a08c4d5f16b61494bd1.tar.lz
cuberite-dac97826f7d0c9b9135c1a08c4d5f16b61494bd1.tar.xz
cuberite-dac97826f7d0c9b9135c1a08c4d5f16b61494bd1.tar.zst
cuberite-dac97826f7d0c9b9135c1a08c4d5f16b61494bd1.zip
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnDisconnect.lua38
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
-}
-
-
-
-