APIDump: Documented HOOK_PLAYER_JOINED.
This commit is contained in:
parent
b902c0b29e
commit
90dc2c55d8
@ -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[]
|
||||
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user