From d9dc241e6fe669585d7c0b13d55818a22e1c76bc Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Sat, 23 Nov 2013 21:26:24 +0100
Subject: APIDump: The descriptions are read from multiple files.

All the files in the Classes subfolder are read for class descriptions, and in the Hooks subfolder for the hook descriptions.
---
 .../Plugins/APIDump/Hooks/OnSpawningMonster.lua    | 33 ++++++++++++++++++++++
 1 file changed, 33 insertions(+)
 create mode 100644 MCServer/Plugins/APIDump/Hooks/OnSpawningMonster.lua

(limited to 'MCServer/Plugins/APIDump/Hooks/OnSpawningMonster.lua')

diff --git a/MCServer/Plugins/APIDump/Hooks/OnSpawningMonster.lua b/MCServer/Plugins/APIDump/Hooks/OnSpawningMonster.lua
new file mode 100644
index 000000000..4c0519e27
--- /dev/null
+++ b/MCServer/Plugins/APIDump/Hooks/OnSpawningMonster.lua
@@ -0,0 +1,33 @@
+return
+{
+	HOOK_SPAWNING_MONSTER =
+	{
+		CalledWhen = "Before a monster is spawned in the world.",
+		DefaultFnName = "OnSpawningMonster",  -- also used as pagename
+		Desc = [[
+			This hook is called before the server spawns a {{cMonster|monster}}. The plugins may modify the
+			monster's parameters in the {{cMonster}} class, or disallow the spawning altogether. This hook is
+			called before the {{OnSpawningEntity|HOOK_SPAWNING_ENTITY}} is called for the monster entity.</p>
+			<p>
+			See also the {{OnSpawnedMonster|HOOK_SPAWNED_MONSTER}} hook for a similar hook called after the
+			monster is spawned.
+		]],
+		Params =
+		{
+			{ Name = "World", Type = "{{cWorld}}", Notes = "The world in which the entity will spawn" },
+			{ Name = "Monster", Type = "{{cMonster}} descentant", Notes = "The monster that will spawn" },
+		},
+		Returns = [[
+			If the function returns false or no value, the next plugin's callback is called. Finally, the server
+			spawns the monster with whatever parameters the plugins set in the cMonster parameter.</p>
+			<p>
+			If the function returns true, no other callback is called for this event and the monster won't
+			spawn.
+		]],
+	},  -- HOOK_SPAWNING_MONSTER
+}
+
+
+
+
+
-- 
cgit v1.2.3