HOOK_LOGIN
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 whenever a client logs in. It is called right before the client's name is sent to be authenticated. Plugins may refuse the client from accessing the server. Note that when this callback is called, the cPlayer object for this client doesn't exist yet - the client has no representation in any world. To process new players when their world is known, use a later callback, such as HOOK_PLAYER_JOINED or HOOK_PLAYER_SPAWNED. Callback functionThe default name for the callback function is OnLogin. It has the following signature: function MyOnLogin(Client, ProtocolVersion, UserName) Parameters:
If the function returns true, no other plugins are called for this event and the client is kicked. If the function returns false or no value, Cuberite calls other plugins' callbacks and finally sends an authentication request for the client's username to the auth server. If the auth server is disabled in the server settings, the player object is immediately created. Code examplesRegistering the callbackcPluginManager:AddHook(cPluginManager.HOOK_LOGIN, MyOnLogin); |