summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/APIDesc.lua
diff options
context:
space:
mode:
authormadmaxoft <github@xoft.cz>2013-10-15 08:24:44 +0200
committermadmaxoft <github@xoft.cz>2013-10-15 08:24:44 +0200
commit90dc2c55d8273c4a9d4429f7f4473cbf3302f1a4 (patch)
treea5c8112b29d8eee2337fc74b2967a348bab424aa /MCServer/Plugins/APIDump/APIDesc.lua
parentAPIDump: Documented HOOK_PLAYER_EATING. (diff)
downloadcuberite-90dc2c55d8273c4a9d4429f7f4473cbf3302f1a4.tar
cuberite-90dc2c55d8273c4a9d4429f7f4473cbf3302f1a4.tar.gz
cuberite-90dc2c55d8273c4a9d4429f7f4473cbf3302f1a4.tar.bz2
cuberite-90dc2c55d8273c4a9d4429f7f4473cbf3302f1a4.tar.lz
cuberite-90dc2c55d8273c4a9d4429f7f4473cbf3302f1a4.tar.xz
cuberite-90dc2c55d8273c4a9d4429f7f4473cbf3302f1a4.tar.zst
cuberite-90dc2c55d8273c4a9d4429f7f4473cbf3302f1a4.zip
Diffstat (limited to '')
-rw-r--r--MCServer/Plugins/APIDump/APIDesc.lua22
1 files changed, 22 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index 84e7588db..b464a10e6 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -2711,6 +2711,28 @@ end;
]],
}, -- HOOK_PLAYER_EATING
+ HOOK_PLAYER_JOINED =
+ {
+ CalledWhen = "After Login and before Spawned, before being added to world. ",
+ DefaultFnName = "OnPlayerJoined", -- also used as pagename
+ Desc = [[
+ This hook is called whenever a {{cPlayer|player}} has completely logged in. If authentication is
+ 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.
+ ]],
+ 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.
+ ]],
+ }, -- HOOK_PLAYER_JOINED
+
}, -- Hooks[]