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.
22 #include "lua_api/l_base.h"
23 #include "inventory.h" // ItemStack
25 class LuaItemStack : public ModApiBase {
29 static const char className[];
30 static const luaL_Reg methods[];
35 static int gc_object(lua_State *L);
37 // is_empty(self) -> true/false
38 static int l_is_empty(lua_State *L);
40 // get_name(self) -> string
41 static int l_get_name(lua_State *L);
43 // set_name(self, name)
44 static int l_set_name(lua_State *L);
46 // get_count(self) -> number
47 static int l_get_count(lua_State *L);
49 // set_count(self, number)
50 static int l_set_count(lua_State *L);
52 // get_wear(self) -> number
53 static int l_get_wear(lua_State *L);
55 // set_wear(self, number)
56 static int l_set_wear(lua_State *L);
58 // get_meta(self) -> string
59 static int l_get_meta(lua_State *L);
62 // get_metadata(self) -> string
63 static int l_get_metadata(lua_State *L);
66 // set_metadata(self, string)
67 static int l_set_metadata(lua_State *L);
69 // clear(self) -> true
70 static int l_clear(lua_State *L);
72 // replace(self, itemstack or itemstring or table or nil) -> true
73 static int l_replace(lua_State *L);
75 // to_string(self) -> string
76 static int l_to_string(lua_State *L);
78 // to_table(self) -> table or nil
79 static int l_to_table(lua_State *L);
81 // get_stack_max(self) -> number
82 static int l_get_stack_max(lua_State *L);
84 // get_free_space(self) -> number
85 static int l_get_free_space(lua_State *L);
87 // is_known(self) -> true/false
88 // Checks if the item is defined.
89 static int l_is_known(lua_State *L);
91 // get_definition(self) -> table
92 // Returns the item definition table from core.registered_items,
93 // or a fallback one (name="unknown")
94 static int l_get_definition(lua_State *L);
96 // get_tool_capabilities(self) -> table
97 // Returns the effective tool digging properties.
98 // Returns those of the hand ("") if this item has none associated.
99 static int l_get_tool_capabilities(lua_State *L);
101 // add_wear(self, amount) -> true/false
102 // The range for "amount" is [0,65535]. Wear is only added if the item
103 // is a tool. Adding wear might destroy the item.
104 // Returns true if the item is (or was) a tool.
105 static int l_add_wear(lua_State *L);
107 // add_item(self, itemstack or itemstring or table or nil) -> itemstack
108 // Returns leftover item stack
109 static int l_add_item(lua_State *L);
111 // item_fits(self, itemstack or itemstring or table or nil) -> true/false, itemstack
112 // First return value is true iff the new item fits fully into the stack
113 // Second return value is the would-be-left-over item stack
114 static int l_item_fits(lua_State *L);
116 // take_item(self, takecount=1) -> itemstack
117 static int l_take_item(lua_State *L);
119 // peek_item(self, peekcount=1) -> itemstack
120 static int l_peek_item(lua_State *L);
123 LuaItemStack(const ItemStack &item);
124 ~LuaItemStack() = default;
126 const ItemStack& getItem() const;
127 ItemStack& getItem();
129 // LuaItemStack(itemstack or itemstring or table or nil)
130 // Creates an LuaItemStack and leaves it on top of stack
131 static int create_object(lua_State *L);
132 // Not callable from Lua
133 static int create(lua_State *L, const ItemStack &item);
134 static LuaItemStack* checkobject(lua_State *L, int narg);
135 static void Register(lua_State *L);
139 class ModApiItemMod : public ModApiBase {
141 static int l_register_item_raw(lua_State *L);
142 static int l_unregister_item_raw(lua_State *L);
143 static int l_register_alias_raw(lua_State *L);
144 static int l_get_content_id(lua_State *L);
145 static int l_get_name_from_content_id(lua_State *L);
147 static void Initialize(lua_State *L, int top);