Add helper functions to make tool usable n times (#12047)

[dragonfireclient.git] / src / script / lua_api / l_item.cpp

diff --git a/src/script/lua_api/l_item.cpp b/src/script/lua_api/l_item.cpp
index 27c1b887592c48cb02ebf11b5ddabc064c5d83cd..13d046d00f14474d1e9e7427cb4c71dcd34873cd 100644 (file)
--- a/src/script/lua_api/l_item.cpp
+++ b/src/script/lua_api/l_item.cpp
@@ -343,7 +343,7 @@ int LuaItemStack::l_get_tool_capabilities(lua_State *L)
 }
 
 // add_wear(self, amount) -> true/false
-// The range for "amount" is [0,65535]. Wear is only added if the item
+// The range for "amount" is [0,65536]. Wear is only added if the item
 // is a tool. Adding wear might destroy the item.
 // Returns true if the item is (or was) a tool.
 int LuaItemStack::l_add_wear(lua_State *L)
@@ -357,6 +357,25 @@ int LuaItemStack::l_add_wear(lua_State *L)
        return 1;
 }
 
+// add_wear_by_uses(self, max_uses) -> true/false
+// The range for "max_uses" is [0,65536].
+// Adds wear to the item in such a way that, if
+// only this function is called to add wear, the item
+// will be destroyed exactly after `max_uses` times of calling it.
+// No-op if `max_uses` is 0 or item is not a tool.
+// Returns true if the item is (or was) a tool.
+int LuaItemStack::l_add_wear_by_uses(lua_State *L)
+{
+       NO_MAP_LOCK_REQUIRED;
+       LuaItemStack *o = checkobject(L, 1);
+       ItemStack &item = o->m_stack;
+       u32 max_uses = readParam<int>(L, 2);
+       u32 add_wear = calculateResultWear(max_uses, item.wear);
+       bool result = item.addWear(add_wear, getGameDef(L)->idef());
+       lua_pushboolean(L, result);
+       return 1;
+}
+
 // add_item(self, itemstack or itemstring or table or nil) -> itemstack
 // Returns leftover item stack
 int LuaItemStack::l_add_item(lua_State *L)
@@ -532,6 +551,7 @@ const luaL_Reg LuaItemStack::methods[] = {
        luamethod(LuaItemStack, get_definition),
        luamethod(LuaItemStack, get_tool_capabilities),
        luamethod(LuaItemStack, add_wear),
+       luamethod(LuaItemStack, add_wear_by_uses),
        luamethod(LuaItemStack, add_item),
        luamethod(LuaItemStack, item_fits),
        luamethod(LuaItemStack, take_item),