From 70f9e1aafa6cd7a2b2d204609cab6cc26539cdb9 Mon Sep 17 00:00:00 2001 From: sfan5 Date: Sun, 22 Sep 2019 22:12:21 +0200 Subject: [PATCH] Punchwear (improved) (#8959) --- builtin/game/register.lua | 12 ++++++++++++ doc/lua_api.txt | 10 +++++++++- src/content_sao.cpp | 4 ++-- src/content_sao.h | 6 +++--- src/network/serverpackethandler.cpp | 6 +++++- src/script/common/c_content.cpp | 10 ++++------ src/script/lua_api/l_object.cpp | 5 +++-- src/serverobject.h | 8 ++++---- src/tool.cpp | 28 ++++++++++++++++++++++------ src/tool.h | 15 +++++++++------ 10 files changed, 73 insertions(+), 31 deletions(-) diff --git a/builtin/game/register.lua b/builtin/game/register.lua index bed269dbb..bfad6845c 100644 --- a/builtin/game/register.lua +++ b/builtin/game/register.lua @@ -256,6 +256,18 @@ function core.register_tool(name, tooldef) end -- END Legacy stuff + -- This isn't just legacy, but more of a convenience feature + local toolcaps = tooldef.tool_capabilities + if toolcaps and toolcaps.punch_attack_uses == nil then + for _, cap in pairs(toolcaps.groupcaps or {}) do + local level = (cap.maxlevel or 0) - 1 + if (cap.uses or 0) ~= 0 and level >= 0 then + toolcaps.punch_attack_uses = cap.uses * (3 ^ level) + break + end + end + end + core.register_item(name, tooldef) end diff --git a/doc/lua_api.txt b/doc/lua_api.txt index 8a5ff78e8..cefc53569 100644 --- a/doc/lua_api.txt +++ b/doc/lua_api.txt @@ -6269,7 +6269,7 @@ Used by `minetest.register_node`, `minetest.register_craftitem`, and liquids_pointable = false, - -- See "Tools" section + -- See "Tools" section for an example including explanation tool_capabilities = { full_punch_interval = 1.0, max_drop_level = 0, @@ -6279,6 +6279,14 @@ Used by `minetest.register_node`, `minetest.register_craftitem`, and uses = 20, maxlevel = 2}, }, damage_groups = {groupname = damage}, + + punch_attack_uses = nil, + -- Amount of uses this tool has for attacking players and entities + -- by punching them (0 = infinite uses). + -- For compatibility, this is automatically set from the first + -- suitable groupcap using the forumla "uses * 3^(maxlevel - 1)". + -- It is recommend to set this explicitly instead of relying on the + -- fallback behavior. }, node_placement_prediction = nil, diff --git a/src/content_sao.cpp b/src/content_sao.cpp index 90240e267..d6baa1580 100644 --- a/src/content_sao.cpp +++ b/src/content_sao.cpp @@ -624,7 +624,7 @@ void LuaEntitySAO::getStaticData(std::string *result) const *result = os.str(); } -int LuaEntitySAO::punch(v3f dir, +u16 LuaEntitySAO::punch(v3f dir, const ToolCapabilities *toolcap, ServerActiveObject *puncher, float time_from_last_punch) @@ -1273,7 +1273,7 @@ void PlayerSAO::setLookPitchAndSend(const float pitch) m_env->getGameDef()->SendMovePlayer(m_peer_id); } -int PlayerSAO::punch(v3f dir, +u16 PlayerSAO::punch(v3f dir, const ToolCapabilities *toolcap, ServerActiveObject *puncher, float time_from_last_punch) diff --git a/src/content_sao.h b/src/content_sao.h index b8ef5382d..e9047daf0 100644 --- a/src/content_sao.h +++ b/src/content_sao.h @@ -122,10 +122,10 @@ public: bool isStaticAllowed() const { return m_prop.static_save; } void getStaticData(std::string *result) const; - int punch(v3f dir, + u16 punch(v3f dir, const ToolCapabilities *toolcap = nullptr, ServerActiveObject *puncher = nullptr, - float time_from_last_punch = 1000000); + float time_from_last_punch = 1000000.0f); void rightClick(ServerActiveObject *clicker); void setPos(const v3f &pos); void moveTo(v3f pos, bool continuous); @@ -258,7 +258,7 @@ public: Interaction interface */ - int punch(v3f dir, + u16 punch(v3f dir, const ToolCapabilities *toolcap, ServerActiveObject *puncher, float time_from_last_punch); diff --git a/src/network/serverpackethandler.cpp b/src/network/serverpackethandler.cpp index 0169a57da..8c2ba823c 100644 --- a/src/network/serverpackethandler.cpp +++ b/src/network/serverpackethandler.cpp @@ -1163,9 +1163,13 @@ void Server::handleCommand_Interact(NetworkPacket *pkt) u16 src_original_hp = pointed_object->getHP(); u16 dst_origin_hp = playersao->getHP(); - pointed_object->punch(dir, &toolcap, playersao, + u16 wear = pointed_object->punch(dir, &toolcap, playersao, time_from_last_punch); + bool changed = punchitem.addWear(wear, m_itemdef); + if (changed) + playersao->setWieldedItem(punchitem); + // If the object is a player and its HP changed if (src_original_hp != pointed_object->getHP() && pointed_object->getType() == ACTIVEOBJECT_TYPE_PLAYER) { diff --git a/src/script/common/c_content.cpp b/src/script/common/c_content.cpp index 9eba4cbf2..cb0253c32 100644 --- a/src/script/common/c_content.cpp +++ b/src/script/common/c_content.cpp @@ -164,11 +164,7 @@ void push_item_definition_full(lua_State *L, const ItemDefinition &i) lua_pushboolean(L, i.liquids_pointable); lua_setfield(L, -2, "liquids_pointable"); if (i.type == ITEM_TOOL) { - push_tool_capabilities(L, ToolCapabilities( - i.tool_capabilities->full_punch_interval, - i.tool_capabilities->max_drop_level, - i.tool_capabilities->groupcaps, - i.tool_capabilities->damageGroups)); + push_tool_capabilities(L, *i.tool_capabilities); lua_setfield(L, -2, "tool_capabilities"); } push_groups(L, i.groups); @@ -1253,7 +1249,8 @@ void push_tool_capabilities(lua_State *L, { lua_newtable(L); setfloatfield(L, -1, "full_punch_interval", toolcap.full_punch_interval); - setintfield(L, -1, "max_drop_level", toolcap.max_drop_level); + setintfield(L, -1, "max_drop_level", toolcap.max_drop_level); + setintfield(L, -1, "punch_attack_uses", toolcap.punch_attack_uses); // Create groupcaps table lua_newtable(L); // For each groupcap @@ -1375,6 +1372,7 @@ ToolCapabilities read_tool_capabilities( ToolCapabilities toolcap; getfloatfield(L, table, "full_punch_interval", toolcap.full_punch_interval); getintfield(L, table, "max_drop_level", toolcap.max_drop_level); + getintfield(L, table, "punch_attack_uses", toolcap.punch_attack_uses); lua_getfield(L, table, "groupcaps"); if(lua_istable(L, -1)){ int table_groupcaps = lua_gettop(L); diff --git a/src/script/lua_api/l_object.cpp b/src/script/lua_api/l_object.cpp index 22445fc9a..efdb345c9 100644 --- a/src/script/lua_api/l_object.cpp +++ b/src/script/lua_api/l_object.cpp @@ -187,7 +187,8 @@ int ObjectRef::l_punch(lua_State *L) u16 dst_origin_hp = puncher->getHP(); // Do it - co->punch(dir, &toolcap, puncher, time_from_last_punch); + u16 wear = co->punch(dir, &toolcap, puncher, time_from_last_punch); + lua_pushnumber(L, wear); // If the punched is a player, and its HP changed if (src_original_hp != co->getHP() && @@ -202,7 +203,7 @@ int ObjectRef::l_punch(lua_State *L) getServer(L)->SendPlayerHPOrDie((PlayerSAO *)puncher, PlayerHPChangeReason(PlayerHPChangeReason::PLAYER_PUNCH, co)); } - return 0; + return 1; } // right_click(self, clicker); clicker = an another ObjectRef diff --git a/src/serverobject.h b/src/serverobject.h index 5ab988571..48689fcb4 100644 --- a/src/serverobject.h +++ b/src/serverobject.h @@ -133,10 +133,10 @@ public: {return true;} // Returns tool wear - virtual int punch(v3f dir, - const ToolCapabilities *toolcap=NULL, - ServerActiveObject *puncher=NULL, - float time_from_last_punch=1000000) + virtual u16 punch(v3f dir, + const ToolCapabilities *toolcap = nullptr, + ServerActiveObject *puncher = nullptr, + float time_from_last_punch = 1000000.0f) { return 0; } virtual void rightClick(ServerActiveObject *clicker) {} diff --git a/src/tool.cpp b/src/tool.cpp index 66bd84a8e..d911c518f 100644 --- a/src/tool.cpp +++ b/src/tool.cpp @@ -56,7 +56,10 @@ void ToolGroupCap::fromJson(const Json::Value &json) void ToolCapabilities::serialize(std::ostream &os, u16 protocol_version) const { - writeU8(os, 4); // protocol_version >= 37 + if (protocol_version >= 38) + writeU8(os, 5); + else + writeU8(os, 4); // proto == 37 writeF32(os, full_punch_interval); writeS16(os, max_drop_level); writeU32(os, groupcaps.size()); @@ -79,6 +82,9 @@ void ToolCapabilities::serialize(std::ostream &os, u16 protocol_version) const os << serializeString(damageGroup.first); writeS16(os, damageGroup.second); } + + if (protocol_version >= 38) + writeU16(os, rangelim(punch_attack_uses, 0, U16_MAX)); } void ToolCapabilities::deSerialize(std::istream &is) @@ -111,6 +117,9 @@ void ToolCapabilities::deSerialize(std::istream &is) s16 rating = readS16(is); damageGroups[name] = rating; } + + if (version >= 5) + punch_attack_uses = readU16(is); } void ToolCapabilities::serializeJson(std::ostream &os) const @@ -118,6 +127,7 @@ void ToolCapabilities::serializeJson(std::ostream &os) const Json::Value root; root["full_punch_interval"] = full_punch_interval; root["max_drop_level"] = max_drop_level; + root["punch_attack_uses"] = punch_attack_uses; Json::Value groupcaps_object; for (auto groupcap : groupcaps) { @@ -144,6 +154,8 @@ void ToolCapabilities::deserializeJson(std::istream &is) full_punch_interval = root["full_punch_interval"].asFloat(); if (root["max_drop_level"].isInt()) max_drop_level = root["max_drop_level"].asInt(); + if (root["punch_attack_uses"].isInt()) + punch_attack_uses = root["punch_attack_uses"].asInt(); Json::Value &groupcaps_object = root["groupcaps"]; if (groupcaps_object.isObject()) { @@ -227,16 +239,20 @@ HitParams getHitParams(const ItemGroupList &armor_groups, const ToolCapabilities *tp, float time_from_last_punch) { s16 damage = 0; - float full_punch_interval = tp->full_punch_interval; + float result_wear = 0.0f; + float punch_interval_multiplier = + rangelim(time_from_last_punch / tp->full_punch_interval, 0.0f, 1.0f); for (const auto &damageGroup : tp->damageGroups) { s16 armor = itemgroup_get(armor_groups, damageGroup.first); - damage += damageGroup.second - * rangelim(time_from_last_punch / full_punch_interval, 0.0, 1.0) - * armor / 100.0; + damage += damageGroup.second * punch_interval_multiplier * armor / 100.0; } - return {damage, 0}; + if (tp->punch_attack_uses > 0) + result_wear = 1.0f / tp->punch_attack_uses * punch_interval_multiplier; + + u16 wear_i = U16_MAX * result_wear; + return {damage, wear_i}; } HitParams getHitParams(const ItemGroupList &armor_groups, diff --git a/src/tool.h b/src/tool.h index d077b54ce..59dd501f5 100644 --- a/src/tool.h +++ b/src/tool.h @@ -60,17 +60,20 @@ struct ToolCapabilities int max_drop_level; ToolGCMap groupcaps; DamageGroup damageGroups; + int punch_attack_uses; ToolCapabilities( - float full_punch_interval_=1.4, - int max_drop_level_=1, + float full_punch_interval_ = 1.4f, + int max_drop_level_ = 1, const ToolGCMap &groupcaps_ = ToolGCMap(), - const DamageGroup &damageGroups_ = DamageGroup() + const DamageGroup &damageGroups_ = DamageGroup(), + int punch_attack_uses_ = 0 ): full_punch_interval(full_punch_interval_), max_drop_level(max_drop_level_), groupcaps(groupcaps_), - damageGroups(damageGroups_) + damageGroups(damageGroups_), + punch_attack_uses(punch_attack_uses_) {} void serialize(std::ostream &os, u16 version) const; @@ -103,9 +106,9 @@ DigParams getDigParams(const ItemGroupList &groups, struct HitParams { s16 hp; - s16 wear; + u16 wear; - HitParams(s16 hp_=0, s16 wear_=0): + HitParams(s16 hp_ = 0, u16 wear_ = 0): hp(hp_), wear(wear_) {}