Added PlayerDestroyedHook Documentation
This commit is contained in:
parent
dbbd47b96d
commit
b34ba6be7b
23
MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua
Normal file
23
MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua
Normal 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
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue
Block a user