From 1cd45e770dcc5912d3ab68eb2681b80d55eea905 Mon Sep 17 00:00:00 2001 From: Mattes D Date: Tue, 21 Oct 2014 23:11:45 +0200 Subject: Added inheritance information to Lua docs for projectiles. --- MCServer/Plugins/APIDump/Classes/Projectiles.lua | 47 +++++++++++++++++++++--- 1 file changed, 41 insertions(+), 6 deletions(-) (limited to 'MCServer/Plugins/APIDump/Classes/Projectiles.lua') diff --git a/MCServer/Plugins/APIDump/Classes/Projectiles.lua b/MCServer/Plugins/APIDump/Classes/Projectiles.lua index 08c981e5d..cc6182b6e 100644 --- a/MCServer/Plugins/APIDump/Classes/Projectiles.lua +++ b/MCServer/Plugins/APIDump/Classes/Projectiles.lua @@ -35,12 +35,33 @@ return Inherits = "cProjectileEntity", }, -- cArrowEntity + cExpBottleEntity = + { + Desc = "", + Functions = {}, + Inherits = "cProjectileEntity", + }, -- cExpBottleEntity + cFireChargeEntity = { Desc = "", Functions = {}, Inherits = "cProjectileEntity", }, -- cFireChargeEntity + + cFireworkEntity = + { + Desc = "", + Functions = {}, + Inherits = "cProjectileEntity", + }, -- cFireworkEntity + + cFloater = + { + Desc = "", + Functions = {}, + Inherits = "cProjectileEntity", + }, -- cFloater cGhastFireballEntity = { @@ -64,14 +85,14 @@ return pkArrow = { Notes = "The projectile is an {{cArrowEntity|arrow}}" }, pkEgg = { Notes = "The projectile is a {{cThrownEggEntity|thrown egg}}" }, pkEnderPearl = { Notes = "The projectile is a {{cThrownEnderPearlEntity|thrown enderpearl}}" }, - pkExpBottle = { Notes = "The projectile is a thrown exp bottle (NYI)" }, + pkExpBottle = { Notes = "The projectile is a {{cExpBottleEntity|thrown exp bottle}}" }, pkFireCharge = { Notes = "The projectile is a {{cFireChargeEntity|fire charge}}" }, - pkFirework = { Notes = "The projectile is a (flying) firework (NYI)" }, - pkFishingFloat = { Notes = "The projectile is a fishing float (NYI)" }, + pkFirework = { Notes = "The projectile is a (flying) {{cFireworkEntity|firework}}" }, + pkFishingFloat = { Notes = "The projectile is a {{cFloater|fishing float}}" }, pkGhastFireball = { Notes = "The projectile is a {{cGhastFireballEntity|ghast fireball}}" }, pkSnowball = { Notes = "The projectile is a {{cThrownSnowballEntity|thrown snowball}}" }, - pkSplashPotion = { Notes = "The projectile is a thrown splash potion (NYI)" }, - pkWitherSkull = { Notes = "The projectile is a wither skull (NYI)" }, + pkSplashPotion = { Notes = "The projectile is a {{cSplashPotionEntity|thrown splash potion}}" }, + pkWitherSkull = { Notes = "The projectile is a {{cWitherSkullEntity|wither skull}}" }, }, ConstantGroups = { @@ -84,6 +105,13 @@ return Inherits = "cEntity", }, -- cProjectileEntity + cSplashPotionEntity = + { + Desc = "", + Functions = {}, + Inherits = "cProjectileEntity", + }, -- cSplashPotionEntity + cThrownEggEntity = { Desc = "", @@ -97,13 +125,20 @@ return Functions = {}, Inherits = "cProjectileEntity", }, -- cThrownEnderPearlEntity - + cThrownSnowballEntity = { Desc = "", Functions = {}, Inherits = "cProjectileEntity", }, -- cThrownSnowballEntity + + cWitherSkullEntity = + { + Desc = "", + Functions = {}, + Inherits = "cProjectileEntity", + }, -- cWitherSkullEntity } -- cgit v1.2.3 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/Projectiles.lua') 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