summaryrefslogtreecommitdiffstats
path: root/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua
diff options
context:
space:
mode:
Diffstat (limited to 'MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua')
-rw-r--r--MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua23
1 files changed, 23 insertions, 0 deletions
diff --git a/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua b/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua
new file mode 100644
index 000000000..8e503658c
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua
@@ -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
+}
+
+
+
+
+