3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #include "lua_api/l_base.h"
24 #include "inventory.h" // ItemStack
26 class LuaItemStack : public ModApiBase {
30 static const char className[];
31 static const luaL_reg methods[];
36 static int gc_object(lua_State *L);
38 // is_empty(self) -> true/false
39 static int l_is_empty(lua_State *L);
41 // get_name(self) -> string
42 static int l_get_name(lua_State *L);
44 // set_name(self, name)
45 static int l_set_name(lua_State *L);
47 // get_count(self) -> number
48 static int l_get_count(lua_State *L);
50 // set_count(self, number)
51 static int l_set_count(lua_State *L);
53 // get_wear(self) -> number
54 static int l_get_wear(lua_State *L);
56 // set_wear(self, number)
57 static int l_set_wear(lua_State *L);
59 // get_metadata(self) -> string
60 static int l_get_metadata(lua_State *L);
62 // set_metadata(self, string)
63 static int l_set_metadata(lua_State *L);
65 // clear(self) -> true
66 static int l_clear(lua_State *L);
68 // replace(self, itemstack or itemstring or table or nil) -> true
69 static int l_replace(lua_State *L);
71 // to_string(self) -> string
72 static int l_to_string(lua_State *L);
74 // to_table(self) -> table or nil
75 static int l_to_table(lua_State *L);
77 // get_stack_max(self) -> number
78 static int l_get_stack_max(lua_State *L);
80 // get_free_space(self) -> number
81 static int l_get_free_space(lua_State *L);
83 // is_known(self) -> true/false
84 // Checks if the item is defined.
85 static int l_is_known(lua_State *L);
87 // get_definition(self) -> table
88 // Returns the item definition table from core.registered_items,
89 // or a fallback one (name="unknown")
90 static int l_get_definition(lua_State *L);
92 // get_tool_capabilities(self) -> table
93 // Returns the effective tool digging properties.
94 // Returns those of the hand ("") if this item has none associated.
95 static int l_get_tool_capabilities(lua_State *L);
97 // add_wear(self, amount) -> true/false
98 // The range for "amount" is [0,65535]. Wear is only added if the item
99 // is a tool. Adding wear might destroy the item.
100 // Returns true if the item is (or was) a tool.
101 static int l_add_wear(lua_State *L);
103 // add_item(self, itemstack or itemstring or table or nil) -> itemstack
104 // Returns leftover item stack
105 static int l_add_item(lua_State *L);
107 // item_fits(self, itemstack or itemstring or table or nil) -> true/false, itemstack
108 // First return value is true iff the new item fits fully into the stack
109 // Second return value is the would-be-left-over item stack
110 static int l_item_fits(lua_State *L);
112 // take_item(self, takecount=1) -> itemstack
113 static int l_take_item(lua_State *L);
115 // peek_item(self, peekcount=1) -> itemstack
116 static int l_peek_item(lua_State *L);
119 LuaItemStack(const ItemStack &item);
122 const ItemStack& getItem() const;
123 ItemStack& getItem();
125 // LuaItemStack(itemstack or itemstring or table or nil)
126 // Creates an LuaItemStack and leaves it on top of stack
127 static int create_object(lua_State *L);
128 // Not callable from Lua
129 static int create(lua_State *L, const ItemStack &item);
130 static LuaItemStack* checkobject(lua_State *L, int narg);
131 static void Register(lua_State *L);
135 class ModApiItemMod : public ModApiBase {
137 static int l_register_item_raw(lua_State *L);
138 static int l_register_alias_raw(lua_State *L);
139 static int l_get_content_id(lua_State *L);
140 static int l_get_name_from_content_id(lua_State *L);
142 static void Initialize(lua_State *L, int top);
147 #endif /* L_ITEM_H_ */