flewkey/cuberite-2a
1
0
Fork 0
Code Releases Activity

Added PlayerDestroyedHook Documentation

Browse Source
This commit is contained in:
daniel0916 2014-02-01 13:58:35 +01:00
parent dbbd47b96d
commit b34ba6be7b
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua Normal file
View File

@ -0,0 +1,23 @@
return
{
HOOK_PLAYER_DESTROYED =
{
CalledWhen = "A player is about to get 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.
]],
Params =
{
{ Name = "Player", Type = "{{cPlayer}}", Notes = "The destroyed player" },
},
Returns = [[
It's only for notification. Can't be returned.
]],
}, -- HOOK_PLAYER_DESTROYED
}