From b34ba6be7b35c75bf5272e366ea42f513b0cf501 Mon Sep 17 00:00:00 2001
From: daniel0916 <theschokolps@gmail.com>
Date: Sat, 1 Feb 2014 13:58:35 +0100
Subject: Added PlayerDestroyedHook Documentation

---
 .../Plugins/APIDump/Hooks/OnPlayerDestroyed.lua    | 23 ++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnPlayerDestroyed.lua

(limited to 'MCServer/Plugins/APIDump/Hooks')

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
+}
+
+
+
+
+
-- 
cgit v1.2.3