Files
cuberite-2a/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua
T

28 lines
930 B
Lua
Raw Normal View History

2014-02-01 13:58:35 +01:00
return
{
HOOK_PLAYER_DESTROYED =
{
2014-02-03 21:12:44 +00:00
CalledWhen = "A player object is about to be destroyed.",
2014-02-01 13:58:35 +01:00
DefaultFnName = "OnPlayerDestroyed", -- also used as pagename
Desc = [[
2014-02-03 21:12:44 +00:00
This function is called before a {{cPlayer|player}} is about to be destroyed.
The player has disconnected for whatever reason and is no longer in the server.
If a plugin returns true, a leave message is not broadcast, and vice versa.
However, whatever the return value, the player object is removed from memory.
2014-02-01 13:58:35 +01:00
]],
Params =
{
{ Name = "Player", Type = "{{cPlayer}}", Notes = "The destroyed player" },
},
Returns = [[
2014-02-03 21:12:44 +00:00
If the function returns false or no value, other plugins' callbacks are called and a leave message is broadcast.
If the function returns true, no other callbacks are called for this event and no leave message appears. Either way the player is removed internally.
2014-02-01 13:58:35 +01:00
]],
}, -- HOOK_PLAYER_DESTROYED
}