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/OnPlayerDestroyed.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/OnPlayerDestroyed.lua')
-rw-r--r-- | MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua index 8e503658c..dc033197a 100644 --- a/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua +++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua @@ -2,17 +2,21 @@ return { HOOK_PLAYER_DESTROYED = { - CalledWhen = "A player is about to get destroyed.", + CalledWhen = "A player object is about to be destroyed.", DefaultFnName = "OnPlayerDestroyed", -- also used as pagename Desc = [[ - This function is called when a {{cPlayer|player}} is about to get destroyed. But the player isn't already destroyed. + 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. ]], Params = { { Name = "Player", Type = "{{cPlayer}}", Notes = "The destroyed player" }, }, Returns = [[ - It's only for notification. Can't be returned. + 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. ]], }, -- HOOK_PLAYER_DESTROYED } |