diff options
author | Tiger Wang <ziwei.tiger@hotmail.co.uk> | 2014-02-03 22:12:44 +0100 |
---|---|---|
committer | Tiger Wang <ziwei.tiger@hotmail.co.uk> | 2014-02-03 22:12:44 +0100 |
commit | b5e898a608cfa0b872828db842e31ec2d624e598 (patch) | |
tree | 2dad88b344187b4d82a215932ae2a81cee1f45db /MCServer/Plugins/APIDump/Hooks/OnPlayerJoined.lua | |
parent | Fixed multiple invalid permission nodes (diff) | |
download | cuberite-b5e898a608cfa0b872828db842e31ec2d624e598.tar cuberite-b5e898a608cfa0b872828db842e31ec2d624e598.tar.gz cuberite-b5e898a608cfa0b872828db842e31ec2d624e598.tar.bz2 cuberite-b5e898a608cfa0b872828db842e31ec2d624e598.tar.lz cuberite-b5e898a608cfa0b872828db842e31ec2d624e598.tar.xz cuberite-b5e898a608cfa0b872828db842e31ec2d624e598.tar.zst cuberite-b5e898a608cfa0b872828db842e31ec2d624e598.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 } |