From bfd1a9601add23bc2cbe92299ebda53375b30199 Mon Sep 17 00:00:00 2001 From: Mattes D Date: Wed, 22 Oct 2014 16:04:31 +0200 Subject: APIDump: Added docs for a few projectiles. --- MCServer/Plugins/APIDump/Classes/Projectiles.lua | 26 +++++++++++++++++++----- 1 file changed, 21 insertions(+), 5 deletions(-) (limited to 'MCServer/Plugins/APIDump/Classes') diff --git a/MCServer/Plugins/APIDump/Classes/Projectiles.lua b/MCServer/Plugins/APIDump/Classes/Projectiles.lua index cc6182b6e..aef6a048c 100644 --- a/MCServer/Plugins/APIDump/Classes/Projectiles.lua +++ b/MCServer/Plugins/APIDump/Classes/Projectiles.lua @@ -37,22 +37,38 @@ return cExpBottleEntity = { - Desc = "", - Functions = {}, + Desc = [[ + Represents a thrown ExpBottle. A subclass of the {{cProjectileEntity}}. + ]], + Functions = + { + }, Inherits = "cProjectileEntity", }, -- cExpBottleEntity cFireChargeEntity = { - Desc = "", + Desc = [[ + Represents a fire charge that has been shot by a Blaze or a {{cDispenserEntity|Dispenser}}. A subclass + of the {{cProjectileEntity}}. + ]], Functions = {}, Inherits = "cProjectileEntity", }, -- cFireChargeEntity cFireworkEntity = { - Desc = "", - Functions = {}, + Desc = [[ + Represents a firework rocket. + ]], + Functions = + { + GetItem = { Params = "", Return = "{{cItem}}", Notes = "Returns the item that has been used to create the firework rocket. The item's m_FireworkItem member contains all the firework-related data." }, + GetTicksToExplosion = { Params = "", Return = "number", Notes = "Returns the number of ticks left until the firework explodes." }, + SetItem = { Params = "{{cItem}}", Return = "", Notes = "Sets a new item to be used for the firework." }, + SetTicksToExplosion = { Params = "NumTicks", Return = "", Notes = "Sets the number of ticks left until the firework explodes." }, + }, + Inherits = "cProjectileEntity", }, -- cFireworkEntity -- cgit v1.2.3