src/tool.cpp

   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 #include "tool.h"
  21 #include "itemdef.h"
  22 #include "itemgroup.h"
  23 #include "log.h"
  24 #include "inventory.h"
  25 #include "exceptions.h"
  26 #include "convert_json.h"
  27 #include "util/serialize.h"
  28 #include "util/numeric.h"
  29
  30 void ToolGroupCap::toJson(Json::Value &object) const
  31 {
  32         object["maxlevel"] = maxlevel;
  33         object["uses"] = uses;
  34
  35         Json::Value times_object;
  36         for (auto time : times)
  37                 times_object[time.first] = time.second;
  38         object["times"] = times_object;
  39 }
  40
  41 void ToolGroupCap::fromJson(const Json::Value &json)
  42 {
  43         if (json.isObject()) {
  44                 if (json["maxlevel"].isInt())
  45                         maxlevel = json["maxlevel"].asInt();
  46                 if (json["uses"].isInt())
  47                         uses = json["uses"].asInt();
  48                 const Json::Value &times_object = json["times"];
  49                 if (times_object.isArray()) {
  50                         Json::ArrayIndex size = times_object.size();
  51                         for (Json::ArrayIndex i = 0; i < size; ++i)
  52                                 if (times_object[i].isDouble())
  53                                         times[i] = times_object[i].asFloat();
  54                 }
  55         }
  56 }
  57
  58 void ToolCapabilities::serialize(std::ostream &os, u16 protocol_version) const
  59 {
  60         if (protocol_version >= 38)
  61                 writeU8(os, 5);
  62         else
  63                 writeU8(os, 4); // proto == 37
  64         writeF32(os, full_punch_interval);
  65         writeS16(os, max_drop_level);
  66         writeU32(os, groupcaps.size());
  67         for (const auto &groupcap : groupcaps) {
  68                 const std::string *name = &groupcap.first;
  69                 const ToolGroupCap *cap = &groupcap.second;
  70                 os << serializeString16(*name);
  71                 writeS16(os, cap->uses);
  72                 writeS16(os, cap->maxlevel);
  73                 writeU32(os, cap->times.size());
  74                 for (const auto &time : cap->times) {
  75                         writeS16(os, time.first);
  76                         writeF32(os, time.second);
  77                 }
  78         }
  79
  80         writeU32(os, damageGroups.size());
  81
  82         for (const auto &damageGroup : damageGroups) {
  83                 os << serializeString16(damageGroup.first);
  84                 writeS16(os, damageGroup.second);
  85         }
  86
  87         if (protocol_version >= 38)
  88                 writeU16(os, rangelim(punch_attack_uses, 0, U16_MAX));
  89 }
  90
  91 void ToolCapabilities::deSerialize(std::istream &is)
  92 {
  93         int version = readU8(is);
  94         if (version < 4)
  95                 throw SerializationError("unsupported ToolCapabilities version");
  96
  97         full_punch_interval = readF32(is);
  98         max_drop_level = readS16(is);
  99         groupcaps.clear();
 100         u32 groupcaps_size = readU32(is);
 101         for (u32 i = 0; i < groupcaps_size; i++) {
 102                 std::string name = deSerializeString16(is);
 103                 ToolGroupCap cap;
 104                 cap.uses = readS16(is);
 105                 cap.maxlevel = readS16(is);
 106                 u32 times_size = readU32(is);
 107                 for(u32 i = 0; i < times_size; i++) {
 108                         int level = readS16(is);
 109                         float time = readF32(is);
 110                         cap.times[level] = time;
 111                 }
 112                 groupcaps[name] = cap;
 113         }
 114
 115         u32 damage_groups_size = readU32(is);
 116         for (u32 i = 0; i < damage_groups_size; i++) {
 117                 std::string name = deSerializeString16(is);
 118                 s16 rating = readS16(is);
 119                 damageGroups[name] = rating;
 120         }
 121
 122         if (version >= 5)
 123                 punch_attack_uses = readU16(is);
 124 }
 125
 126 void ToolCapabilities::serializeJson(std::ostream &os) const
 127 {
 128         Json::Value root;
 129         root["full_punch_interval"] = full_punch_interval;
 130         root["max_drop_level"] = max_drop_level;
 131         root["punch_attack_uses"] = punch_attack_uses;
 132
 133         Json::Value groupcaps_object;
 134         for (const auto &groupcap : groupcaps) {
 135                 groupcap.second.toJson(groupcaps_object[groupcap.first]);
 136         }
 137         root["groupcaps"] = groupcaps_object;
 138
 139         Json::Value damage_groups_object;
 140         DamageGroup::const_iterator dgiter;
 141         for (dgiter = damageGroups.begin(); dgiter != damageGroups.end(); ++dgiter) {
 142                 damage_groups_object[dgiter->first] = dgiter->second;
 143         }
 144         root["damage_groups"] = damage_groups_object;
 145
 146         fastWriteJson(root, os);
 147 }
 148
 149 void ToolCapabilities::deserializeJson(std::istream &is)
 150 {
 151         Json::Value root;
 152         is >> root;
 153         if (root.isObject()) {
 154                 if (root["full_punch_interval"].isDouble())
 155                         full_punch_interval = root["full_punch_interval"].asFloat();
 156                 if (root["max_drop_level"].isInt())
 157                         max_drop_level = root["max_drop_level"].asInt();
 158                 if (root["punch_attack_uses"].isInt())
 159                         punch_attack_uses = root["punch_attack_uses"].asInt();
 160
 161                 Json::Value &groupcaps_object = root["groupcaps"];
 162                 if (groupcaps_object.isObject()) {
 163                         Json::ValueIterator gciter;
 164                         for (gciter = groupcaps_object.begin();
 165                                         gciter != groupcaps_object.end(); ++gciter) {
 166                                 ToolGroupCap groupcap;
 167                                 groupcap.fromJson(*gciter);
 168                                 groupcaps[gciter.key().asString()] = groupcap;
 169                         }
 170                 }
 171
 172                 Json::Value &damage_groups_object = root["damage_groups"];
 173                 if (damage_groups_object.isObject()) {
 174                         Json::ValueIterator dgiter;
 175                         for (dgiter = damage_groups_object.begin();
 176                                         dgiter != damage_groups_object.end(); ++dgiter) {
 177                                 Json::Value &value = *dgiter;
 178                                 if (value.isInt())
 179                                         damageGroups[dgiter.key().asString()] =
 180                                                 value.asInt();
 181                         }
 182                 }
 183         }
 184 }
 185
 186 DigParams getDigParams(const ItemGroupList &groups,
 187                 const ToolCapabilities *tp)
 188 {
 189         // Group dig_immediate defaults to fixed time and no wear
 190         if (tp->groupcaps.find("dig_immediate") == tp->groupcaps.cend()) {
 191                 switch (itemgroup_get(groups, "dig_immediate")) {
 192                 case 2:
 193                         return DigParams(true, 0.5, 0, "dig_immediate");
 194                 case 3:
 195                         return DigParams(true, 0, 0, "dig_immediate");
 196                 default:
 197                         break;
 198                 }
 199         }
 200
 201         // Values to be returned (with a bit of conversion)
 202         bool result_diggable = false;
 203         float result_time = 0.0;
 204         float result_wear = 0.0;
 205         std::string result_main_group;
 206
 207         int level = itemgroup_get(groups, "level");
 208         for (const auto &groupcap : tp->groupcaps) {
 209                 const ToolGroupCap &cap = groupcap.second;
 210
 211                 int leveldiff = cap.maxlevel - level;
 212                 if (leveldiff < 0)
 213                         continue;
 214
 215                 const std::string &groupname = groupcap.first;
 216                 float time = 0;
 217                 int rating = itemgroup_get(groups, groupname);
 218                 bool time_exists = cap.getTime(rating, &time);
 219                 if (!time_exists)
 220                         continue;
 221
 222                 if (leveldiff > 1)
 223                         time /= leveldiff;
 224                 if (!result_diggable || time < result_time) {
 225                         result_time = time;
 226                         result_diggable = true;
 227                         if (cap.uses != 0)
 228                                 result_wear = 1.0 / cap.uses / pow(3.0, leveldiff);
 229                         else
 230                                 result_wear = 0;
 231                         result_main_group = groupname;
 232                 }
 233         }
 234
 235         u16 wear_i = U16_MAX * result_wear;
 236         return DigParams(result_diggable, result_time, wear_i, result_main_group);
 237 }
 238
 239 HitParams getHitParams(const ItemGroupList &armor_groups,
 240                 const ToolCapabilities *tp, float time_from_last_punch)
 241 {
 242         s16 damage = 0;
 243         float result_wear = 0.0f;
 244         float punch_interval_multiplier =
 245                         rangelim(time_from_last_punch / tp->full_punch_interval, 0.0f, 1.0f);
 246
 247         for (const auto &damageGroup : tp->damageGroups) {
 248                 s16 armor = itemgroup_get(armor_groups, damageGroup.first);
 249                 damage += damageGroup.second * punch_interval_multiplier * armor / 100.0;
 250         }
 251
 252         if (tp->punch_attack_uses > 0)
 253                 result_wear = 1.0f / tp->punch_attack_uses * punch_interval_multiplier;
 254
 255         u16 wear_i = U16_MAX * result_wear;
 256         return {damage, wear_i};
 257 }
 258
 259 HitParams getHitParams(const ItemGroupList &armor_groups,
 260                 const ToolCapabilities *tp)
 261 {
 262         return getHitParams(armor_groups, tp, 1000000);
 263 }
 264
 265 PunchDamageResult getPunchDamage(
 266                 const ItemGroupList &armor_groups,
 267                 const ToolCapabilities *toolcap,
 268                 const ItemStack *punchitem,
 269                 float time_from_last_punch
 270 ){
 271         bool do_hit = true;
 272         {
 273                 if (do_hit && punchitem) {
 274                         if (itemgroup_get(armor_groups, "punch_operable") &&
 275                                         (toolcap == NULL || punchitem->name.empty()))
 276                                 do_hit = false;
 277                 }
 278
 279                 if (do_hit) {
 280                         if(itemgroup_get(armor_groups, "immortal"))
 281                                 do_hit = false;
 282                 }
 283         }
 284
 285         PunchDamageResult result;
 286         if(do_hit)
 287         {
 288                 HitParams hitparams = getHitParams(armor_groups, toolcap,
 289                                 time_from_last_punch);
 290                 result.did_punch = true;
 291                 result.wear = hitparams.wear;
 292                 result.damage = hitparams.hp;
 293         }
 294
 295         return result;
 296 }
 297
 298 f32 getToolRange(const ItemDefinition &def_selected, const ItemDefinition &def_hand)
 299 {
 300         float max_d = def_selected.range;
 301         float max_d_hand = def_hand.range;
 302
 303         if (max_d < 0 && max_d_hand >= 0)
 304                 max_d = max_d_hand;
 305         else if (max_d < 0)
 306                 max_d = 4.0f;
 307
 308         return max_d;
 309 }
 310