src/script/lua_api/l_item.h

   1 /*
   2 Minetest
   3 Copyright (C) 2013 celeron55, Perttu Ahola <celeron55@gmail.com>
   4
   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.
   9
  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.
  14
  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.
  18 */
  19
  20 #ifndef L_ITEM_H_
  21 #define L_ITEM_H_
  22
  23 extern "C" {
  24 #include <lua.h>
  25 #include <lauxlib.h>
  26 }
  27
  28 #include <vector>
  29
  30 #include "itemdef.h"
  31 #include "content_sao.h"
  32 #include "util/pointedthing.h"
  33 #include "inventory.h"
  34
  35 #include "lua_api/l_base.h"
  36
  37 class ModApiInventory;
  38
  39 class LuaItemStack
  40 {
  41 private:
  42         ItemStack m_stack;
  43
  44         static const char className[];
  45         static const luaL_reg methods[];
  46
  47         // Exported functions
  48
  49         // garbage collector
  50         static int gc_object(lua_State *L);
  51
  52         // is_empty(self) -> true/false
  53         static int l_is_empty(lua_State *L);
  54
  55         // get_name(self) -> string
  56         static int l_get_name(lua_State *L);
  57
  58         // get_count(self) -> number
  59         static int l_get_count(lua_State *L);
  60
  61         // get_wear(self) -> number
  62         static int l_get_wear(lua_State *L);
  63
  64         // get_metadata(self) -> string
  65         static int l_get_metadata(lua_State *L);
  66
  67         // clear(self) -> true
  68         static int l_clear(lua_State *L);
  69
  70         // replace(self, itemstack or itemstring or table or nil) -> true
  71         static int l_replace(lua_State *L);
  72
  73         // to_string(self) -> string
  74         static int l_to_string(lua_State *L);
  75
  76         // to_table(self) -> table or nil
  77         static int l_to_table(lua_State *L);
  78
  79         // get_stack_max(self) -> number
  80         static int l_get_stack_max(lua_State *L);
  81
  82         // get_free_space(self) -> number
  83         static int l_get_free_space(lua_State *L);
  84
  85         // is_known(self) -> true/false
  86         // Checks if the item is defined.
  87         static int l_is_known(lua_State *L);
  88
  89         // get_definition(self) -> table
  90         // Returns the item definition table from minetest.registered_items,
  91         // or a fallback one (name="unknown")
  92         static int l_get_definition(lua_State *L);
  93
  94         // get_tool_capabilities(self) -> table
  95         // Returns the effective tool digging properties.
  96         // Returns those of the hand ("") if this item has none associated.
  97         static int l_get_tool_capabilities(lua_State *L);
  98
  99         // add_wear(self, amount) -> true/false
 100         // The range for "amount" is [0,65535]. Wear is only added if the item
 101         // is a tool. Adding wear might destroy the item.
 102         // Returns true if the item is (or was) a tool.
 103         static int l_add_wear(lua_State *L);
 104
 105         // add_item(self, itemstack or itemstring or table or nil) -> itemstack
 106         // Returns leftover item stack
 107         static int l_add_item(lua_State *L);
 108
 109         // item_fits(self, itemstack or itemstring or table or nil) -> true/false, itemstack
 110         // First return value is true iff the new item fits fully into the stack
 111         // Second return value is the would-be-left-over item stack
 112         static int l_item_fits(lua_State *L);
 113
 114         // take_item(self, takecount=1) -> itemstack
 115         static int l_take_item(lua_State *L);
 116
 117         // peek_item(self, peekcount=1) -> itemstack
 118         static int l_peek_item(lua_State *L);
 119
 120 public:
 121         LuaItemStack(const ItemStack &item);
 122         ~LuaItemStack();
 123
 124         const ItemStack& getItem() const;
 125         ItemStack& getItem();
 126
 127         // LuaItemStack(itemstack or itemstring or table or nil)
 128         // Creates an LuaItemStack and leaves it on top of stack
 129         static int create_object(lua_State *L);
 130         // Not callable from Lua
 131         static int create(lua_State *L, const ItemStack &item);
 132         static LuaItemStack* checkobject(lua_State *L, int narg);
 133         static void Register(lua_State *L);
 134
 135 };
 136
 137 class ModApiItemMod
 138         :virtual public ModApiBase
 139 {
 140 public:
 141         ModApiItemMod();
 142
 143         bool Initialize(lua_State *L,int top);
 144
 145         static int l_register_item_raw(lua_State *L);
 146         static int l_register_alias_raw(lua_State *L);
 147 };
 148
 149
 150
 151 #endif /* L_ITEM_H_ */