HOOK_DISCONNECT


Index:
Articles
Classes
Hooks

Quick navigation:
BLOCK_SPREAD
BLOCK_TO_PICKUPS
BREWING_COMPLETED
BREWING_COMPLETING
CHAT
CHUNK_AVAILABLE
CHUNK_GENERATED
CHUNK_GENERATING
CHUNK_UNLOADED
CHUNK_UNLOADING
COLLECTING_PICKUP
CRAFTING_NO_RECIPE
DISCONNECT
DROPSPENSE
ENTITY_ADD_EFFECT
ENTITY_CHANGED_WORLD
ENTITY_CHANGING_WORLD
ENTITY_TELEPORT
EXECUTE_COMMAND
EXPLODED
EXPLODING
HANDSHAKE
HOPPER_PULLING_ITEM
HOPPER_PUSHING_ITEM
KILLED
KILLING
LOGIN
LOGIN_FORGE
PLAYER_ANIMATION
PLAYER_BREAKING_BLOCK
PLAYER_BROKEN_BLOCK
PLAYER_CROUCHED
PLAYER_DESTROYED
PLAYER_EATING
PLAYER_FISHED
PLAYER_FISHING
PLAYER_FOOD_LEVEL_CHANGE
PLAYER_JOINED
PLAYER_LEFT_CLICK
PLAYER_MOVING
PLAYER_OPENING_WINDOW
PLAYER_PLACED_BLOCK
PLAYER_PLACING_BLOCK
PLAYER_RIGHT_CLICK
PLAYER_RIGHT_CLICKING_ENTITY
PLAYER_SHOOTING
PLAYER_SPAWNED
PLAYER_TOSSING_ITEM
PLAYER_USED_BLOCK
PLAYER_USED_ITEM
PLAYER_USING_BLOCK
PLAYER_USING_ITEM
PLUGINS_LOADED
PLUGIN_MESSAGE
POST_CRAFTING
PRE_CRAFTING
PROJECTILE_HIT_BLOCK
PROJECTILE_HIT_ENTITY
SERVER_PING
SPAWNED_ENTITY
SPAWNED_MONSTER
SPAWNING_ENTITY
SPAWNING_MONSTER
TAKE_DAMAGE
TICK
UPDATED_SIGN
UPDATING_SIGN
WEATHER_CHANGED
WEATHER_CHANGING
WORLD_STARTED
WORLD_TICK

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.

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.

See also the 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 HOOK_PLAYER_JOINED and HOOK_PLAYER_DESTROYED hooks instead, those are guaranteed to have the cPlayer object associated.


Callback function

The default name for the callback function is OnDisconnect. It has the following signature:

function MyOnDisconnect(Client, Reason)

Parameters:

NameTypeNotes
ClientcClientHandleThe client who has disconnected
ReasonstringThe reason that the client has sent in the disconnect packet

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.


Code examples

Registering the callback

cPluginManager:AddHook(cPluginManager.HOOK_DISCONNECT, MyOnDisconnect);
Generated by APIDump on 2022-10-28 17:00:47, Build ID Unknown, Commit approx: 21ec3ebe26bff24b5fc6d96f86a441c9c9628247