From b91c4a09861a49d531b5df5806f86edc58dcfb94 Mon Sep 17 00:00:00 2001 From: madmaxoft Date: Fri, 13 Sep 2013 11:22:52 +0200 Subject: APIDump: Fixed cItem's description. --- MCServer/Plugins/APIDump/APIDesc.lua | 29 +++++++++++++++++------------ 1 file changed, 17 insertions(+), 12 deletions(-) (limited to 'MCServer/Plugins/APIDump') diff --git a/MCServer/Plugins/APIDump/APIDesc.lua b/MCServer/Plugins/APIDump/APIDesc.lua index 4e887a47b..d2f6f3437 100644 --- a/MCServer/Plugins/APIDump/APIDesc.lua +++ b/MCServer/Plugins/APIDump/APIDesc.lua @@ -621,25 +621,30 @@ These ItemGrids are available in the API and can be manipulated by the plugins, }, Constants = { - invArmorCount = { Notes = "4" }, - invArmorOffset = { Notes = "0" }, - invInventoryCount = { Notes = "" }, - invInventoryOffset = { Notes = "4" }, - invHotbarCount = { Notes = "9" }, - invHotbarOffset = { Notes = "" }, - invNumSlots = { Notes = "" }, + invArmorCount = { Notes = "Number of slots in the Armor part" }, + invArmorOffset = { Notes = "Starting slot number of the Armor part" }, + invInventoryCount = { Notes = "Number of slots in the main inventory part" }, + invInventoryOffset = { Notes = "Starting slot number of the main inventory part" }, + invHotbarCount = { Notes = "Number of slots in the Hotbar part" }, + invHotbarOffset = { Notes = "Starting slot number of the Hotbar part" }, + invNumSlots = { Notes = "Total number of slots in a cInventory" }, }, }, cItem = { - Desc = [[cItem is what defines an item or stack of items in the game, it contains the item ID, damage, quantity and enchantments. Each slot in a {{cEnchantments|cEnchantments}} class -]], + Desc = [[ + cItem is what defines an item or stack of items in the game, it contains the item ID, damage, + quantity and enchantments. Each slot in a {{cInventory|cInventory}} class or a + {{cItemGrid|cItemGrid}} class is a cItem and each cPickup contains a cItem. The enchantments + are contained in a {{cEnchantments|cEnchantments}} class + ]], + Functions = { - constructor = { Params = "", Return = "cItem", Notes = "Creates a new empty cItem obje" }, - constructor = { Params = "ItemType, Count, Damage, EnchantmentString", Return = "cItem", Notes = "Creates a new cItem object of the specified type, count (1 by default), damage (0 by default) and enchantments (non-enchanted by default)" }, - constructor = { Params = "cItem", Return = "cItem", Notes = "Creates an exact copy of the cItem object in the parameter" }, + constructor1 = { Params = "", Return = "cItem", Notes = "Creates a new empty cItem obje" }, + constructor2 = { Params = "ItemType, Count, Damage, EnchantmentString", Return = "cItem", Notes = "Creates a new cItem object of the specified type, count (1 by default), damage (0 by default) and enchantments (non-enchanted by default)" }, + constructor3 = { Params = "cItem", Return = "cItem", Notes = "Creates an exact copy of the cItem object in the parameter" }, Clear = { Params = "", Return = "", Notes = "Resets the instance to an empty item" }, CopyOne = { Params = "", Return = "cItem", Notes = "Creates a copy of this object, with its count set to 1" }, DamageItem = { Params = "[Amount]", Return = "bool", Notes = "Adds the specified damage. Returns true when damage reaches max value and the item should be destroyed (but doesn't destroy the item)" }, -- cgit v1.2.3