diff options
author | madmaxoft <github@xoft.cz> | 2014-02-09 09:36:42 +0100 |
---|---|---|
committer | madmaxoft <github@xoft.cz> | 2014-02-09 09:36:42 +0100 |
commit | a184d592097c24c8796e8680e2ef7fdfe081305d (patch) | |
tree | 20df62dcde07191f927d9df8916375a25c8ccc87 /MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua | |
parent | Moved a forgotten comment back to its place. (diff) | |
parent | Merge branch 'master' into playerimprovements (diff) | |
download | cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.gz cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.bz2 cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.lz cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.xz cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.tar.zst cuberite-a184d592097c24c8796e8680e2ef7fdfe081305d.zip |
Diffstat (limited to '')
-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 } |