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/OnPlayerJoined.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/OnPlayerJoined.lua')
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerJoined.lua | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerJoined.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerJoined.lua index 00805af7e..dcd16ed00 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerJoined.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerJoined.lua @@ -9,16 +9,16 @@ return enabled, this function is called after their name has been authenticated. It is called after {{OnLogin|HOOK_LOGIN}} and before {{OnPlayerSpawned|HOOK_PLAYER_SPAWNED}}, right after the player's entity is created, but not added to the world yet. The player is not yet visible to other players. - This is a notification-only event, plugins wishing to refuse player's entry should kick the player - using the {{cPlayer}}:Kick() function. + Returning true will block a join message from being broadcast, but otherwise, the player is still allowed to join. + Plugins wishing to refuse player's entry should kick the player using the {{cPlayer}}:Kick() function. ]], Params = { { Name = "Player", Type = "{{cPlayer}}", Notes = "The player who has joined the game" }, }, Returns = [[ - If the function returns false or no value, other plugins' callbacks are called. If the function - returns true, no other callbacks are called for this event. Either way the player is let in. + If the function returns false or no value, other plugins' callbacks are called and a join message is broadcast. If the function + returns true, no other callbacks are called for this event and a join message is not sent. Either way the player is let in. ]], }, -- HOOK_PLAYER_JOINED } |