From c875b887589144b19109f4d9f2cb2815c1a79411 Mon Sep 17 00:00:00 2001
From: madmaxoft <github@xoft.cz>
Date: Thu, 24 Oct 2013 17:20:52 +0200
Subject: APIDump: Documented cMonster.

---
 MCServer/Plugins/APIDump/APIDesc.lua | 55 ++++++++++++++++++++++++++++++++++--
 1 file changed, 52 insertions(+), 3 deletions(-)

(limited to 'MCServer')

diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua
index e273924be..0de6afbb8 100644
--- a/MCServer/Plugins/APIDump/APIDesc.lua
+++ b/MCServer/Plugins/APIDump/APIDesc.lua
@@ -1574,9 +1574,58 @@ a_Player:OpenWindow(Window);
 
 		cMonster =
 		{
-			Desc = "",
-			Functions = {},
-			Constants = {},
+			Desc = [[
+				This class is the base class for all computer-controlled mobs in the game.</p>
+				<p>
+				To spawn a mob in a world, use the {{cWorld}}:SpawnMob() function.
+			]],
+			Functions =
+			{
+				FamilyFromType = { Params = "MobType", Return = "MobFamily", Notes = "(STATIC) Returns the mob family (mfXXX constants) based on the mob type (mtXXX constants)" },
+				GetMobFamily = { Params = "", Return = "MobFamily", Notes = "Returns this mob's family (mfXXX constant)" },
+				GetMobType = { Params = "", Return = "MobType", Notes = "Returns the type of this mob (mtXXX constant)" },
+				GetSpawnDelay = { Params = "MobFamily", Return = "number", Notes = "(STATIC) Returns the spawn delay  - the number of game ticks between spawn attempts - for the specified mob family." },
+				MobTypeToString = { Params = "MobType", Return = "string", Notes = "(STATIC) Returns the string representing the given mob type (mtXXX constant), or empty string if unknown type." },
+				StringToMobType = { Params = "string", Return = "MobType", Notes = "(STATIC) Returns the mob type (mtXXX constant) parsed from the string type (\"creeper\"), or mtInvalidType if unrecognized." },
+			},
+			Constants =
+			{
+				mfAmbient = { Notes = "Family: ambient (bat)" },
+				mfHostile = { Notes = "Family: hostile (blaze, cavespider, creeper, enderdragon, enderman, ghast, giant, magmacube, silverfish, skeleton, slime, spider, witch, wither, zombie, zombiepigman)" },
+				mfMaxplusone = { Notes = "The maximum family value, plus one. Returned when monster family not recognized." },
+				mfPassive = { Notes = "Family: passive (chicken, cow, horse, irongolem, mooshroom, ocelot, pig, sheep, snowgolem, villager, wolf)" },
+				mfWater = { Notes = "Family: water (squid)" },
+				mtBat = { Notes = "" },
+				mtBlaze = { Notes = "" },
+				mtCaveSpider = { Notes = "" },
+				mtChicken = { Notes = "" },
+				mtCow = { Notes = "" },
+				mtCreeper = { Notes = "" },
+				mtEnderDragon = { Notes = "" },
+				mtEnderman = { Notes = "" },
+				mtGhast = { Notes = "" },
+				mtGiant = { Notes = "" },
+				mtHorse = { Notes = "" },
+				mtInvalidType = { Notes = "Invalid monster type. Returned when monster type not recognized" },
+				mtIronGolem = { Notes = "" },
+				mtMagmaCube = { Notes = "" },
+				mtMooshroom = { Notes = "" },
+				mtOcelot = { Notes = "" },
+				mtPig = { Notes = "" },
+				mtSheep = { Notes = "" },
+				mtSilverfish = { Notes = "" },
+				mtSkeleton = { Notes = "" },
+				mtSlime = { Notes = "" },
+				mtSnowGolem = { Notes = "" },
+				mtSpider = { Notes = "" },
+				mtSquid = { Notes = "" },
+				mtVillager = { Notes = "" },
+				mtWitch = { Notes = "" },
+				mtWither = { Notes = "" },
+				mtWolf = { Notes = "" },
+				mtZombie = { Notes = "" },
+				mtZombiePigman = { Notes = "" },
+			},
 			Inherits = "cPawn",
 		},
 
-- 
cgit v1.2.3