Add mercenary db.

7 files changed, 347 insertions, 1 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index a38612688..94fd562c2 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -621,6 +621,8 @@ SET(SRCS
     resources/itemtypemapdata.h
     resources/db/mapdb.cpp
     resources/db/mapdb.h
+    resources/db/mercenarydb.cpp
+    resources/db/mercenarydb.h
     resources/db/moddb.cpp
     resources/db/moddb.h
     resources/mapinfo.h
diff --git a/src/Makefile.am b/src/Makefile.am
index fdb58fb72..9a3c10cd1 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -744,6 +744,8 @@ manaplus_SOURCES += gui/widgets/avatarlistbox.cpp \
 	      resources/itemtypemapdata.h \
 	      resources/db/mapdb.cpp \
 	      resources/db/mapdb.h \
+	      resources/db/mercenarydb.cpp \
+	      resources/db/mercenarydb.h \
 	      resources/db/moddb.cpp \
 	      resources/db/moddb.h \
 	      resources/mapinfo.h \
diff --git a/src/being/being.cpp b/src/being/being.cpp
index 047d351fc..79b976049 100644
--- a/src/being/being.cpp
+++ b/src/being/being.cpp
@@ -73,6 +73,7 @@
 #include "resources/db/avatardb.h"
 #include "resources/db/emotedb.h"
 #include "resources/db/itemdb.h"
+#include "resources/db/mercenarydb.h"
 #include "resources/db/monsterdb.h"
 #include "resources/db/npcdb.h"
 #include "resources/db/petdb.h"
@@ -296,7 +297,7 @@ void Being::setSubtype(const uint16_t subtype, const uint8_t look)
     mSubType = subtype;
     mLook = look;
 
-    if (mType == ActorType::Monster || mType == ActorType::Mercenary)
+    if (mType == ActorType::Monster)
     {
         mInfo = MonsterDB::get(mSubType);
         if (mInfo)
@@ -307,6 +308,17 @@ void Being::setSubtype(const uint16_t subtype, const uint8_t look)
             mYDiff = mInfo->getSortOffsetY();
         }
     }
+    else if (mType == ActorType::Mercenary)
+    {
+        mInfo = MercenaryDB::get(mSubType);
+        if (mInfo)
+        {
+            setName(mInfo->getName());
+            setupSpriteDisplay(mInfo->getDisplay(), true, 0,
+                mInfo->getColor(mLook));
+            mYDiff = mInfo->getSortOffsetY();
+        }
+    }
     else if (mType == ActorType::Npc)
     {
         mInfo = NPCDB::get(mSubType);
diff --git a/src/client.cpp b/src/client.cpp
index 4c1820513..dd9f5f12e 100644
--- a/src/client.cpp
+++ b/src/client.cpp
@@ -104,6 +104,7 @@
 #include "resources/db/sounddb.h"
 #include "resources/db/itemdb.h"
 #include "resources/db/mapdb.h"
+#include "resources/db/mercenarydb.h"
 #include "resources/db/moddb.h"
 #include "resources/db/monsterdb.h"
 #include "resources/db/npcdb.h"
@@ -608,6 +609,7 @@ void Client::gameClear()
     SoundDB::unload();
     EmoteDB::unload();
     ItemDB::unload();
+    MercenaryDB::unload();
     MonsterDB::unload();
     NPCDB::unload();
     AvatarDB::unload();
@@ -1249,6 +1251,7 @@ int Client::gameExec()
                     MapDB::load();
                     ItemDB::load();
                     Being::load();
+                    MercenaryDB::load();
                     MonsterDB::load();
                     AvatarDB::load();
                     WeaponsDB::load();
diff --git a/src/defaults.cpp b/src/defaults.cpp
index 44221309a..567a58655 100644
--- a/src/defaults.cpp
+++ b/src/defaults.cpp
@@ -555,6 +555,9 @@ DefaultsData* getPathsDefaults()
     AddDEF("monstersFile", "monsters.xml");
     AddDEF("monstersPatchFile", "monsters_patch.xml");
     AddDEF("monstersPatchDir", "monsters.d");
+    AddDEF("mercenariesFile", "mercenaries.xml");
+    AddDEF("mercenariesPatchFile", "mercenaries_patch.xml");
+    AddDEF("mercenariesPatchDir", "mercenaries.d");
     AddDEF("mapsRemapFile", "maps/remap.xml");
     AddDEF("mapsRemapPatchFile", "maps/remap_patch.xml");
     AddDEF("mapsRemapPatchDir", "maps/remap.d");
diff --git a/src/resources/db/mercenarydb.cpp b/src/resources/db/mercenarydb.cpp
new file mode 100644
index 000000000..ed8be1ffe
--- /dev/null
+++ b/src/resources/db/mercenarydb.cpp
@@ -0,0 +1,278 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2004-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2014  The ManaPlus Developers
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#include "resources/db/mercenarydb.h"
+
+#include "logger.h"
+
+#include "resources/beingcommon.h"
+#include "resources/beinginfo.h"
+#include "resources/spritereference.h"
+
+#include "resources/map/blockmask.h"
+
+#include "utils/dtor.h"
+#include "utils/gettext.h"
+
+#include "configuration.h"
+
+#include "debug.h"
+
+namespace
+{
+    BeingInfos mMercenaryInfos;
+    bool mLoaded = false;
+}
+
+void MercenaryDB::load()
+{
+    if (mLoaded)
+        unload();
+
+    logger->log1("Initializing mercenary database...");
+    loadXmlFile(paths.getStringValue("mercenariesFile"));
+    loadXmlFile(paths.getStringValue("mercenariesPatchFile"));
+    loadXmlDir("mercenariesPatchDir", loadXmlFile);
+
+    mLoaded = true;
+}
+
+void MercenaryDB::loadXmlFile(const std::string &fileName)
+{
+    XML::Document doc(fileName);
+    const XmlNodePtr rootNode = doc.rootNode();
+
+    if (!rootNode || !xmlNameEqual(rootNode, "mercenaries"))
+    {
+        logger->log("Monster Database: Error while loading %s!",
+            paths.getStringValue("mercenariesFile").c_str());
+        mLoaded = true;
+        return;
+    }
+
+    const int offset = XML::getProperty(rootNode, "offset", 0);
+
+    // iterate <mercenary>s
+    for_each_xml_child_node(mercenaryNode, rootNode)
+    {
+        if (xmlNameEqual(mercenaryNode, "include"))
+        {
+            const std::string name = XML::getProperty(mercenaryNode, "name", "");
+            if (!name.empty())
+                loadXmlFile(name);
+            continue;
+        }
+        if (!xmlNameEqual(mercenaryNode, "mercenary"))
+            continue;
+
+        const int id = XML::getProperty(mercenaryNode, "id", 0);
+        BeingInfo *currentInfo = nullptr;
+        if (mMercenaryInfos.find(id + offset) != mMercenaryInfos.end())
+        {
+            logger->log("MercenaryDB: Redefinition of mercenary ID %d", id);
+            currentInfo = mMercenaryInfos[id + offset];
+        }
+        if (!currentInfo)
+            currentInfo = new BeingInfo;
+
+        currentInfo->setBlockType(BlockType::MONSTER);
+        BeingCommon::readBasicAttributes(currentInfo, mercenaryNode, "attack");
+
+        currentInfo->setMaxHP(XML::getProperty(mercenaryNode, "maxHP", 0));
+
+        currentInfo->setDeadSortOffsetY(XML::getProperty(
+            mercenaryNode, "deadSortOffsetY", 31));
+
+        currentInfo->setColorsList(XML::getProperty(mercenaryNode,
+            "colors", ""));
+
+        unsigned char block = 0;
+        std::string walkStr = XML::getProperty(
+            mercenaryNode, "walkType", "walk");
+        if (walkStr == "walk")
+            block = BlockMask::WATER | BlockMask::AIR;
+        else if (walkStr == "fly")
+            block = 0;
+        else if (walkStr == "swim")
+            block = BlockMask::GROUND | BlockMask::AIR;
+        else if (walkStr == "walkswim" || walkStr == "swimwalk")
+            block = BlockMask::AIR;
+
+        currentInfo->setBlockWalkMask(static_cast<unsigned char>(
+            BlockMask::WALL | block));
+
+        if (currentInfo->getMaxHP())
+            currentInfo->setStaticMaxHP(true);
+
+        SpriteDisplay display;
+
+        // iterate <sprite>s and <sound>s
+        for_each_xml_child_node(spriteNode, mercenaryNode)
+        {
+            if (xmlNameEqual(spriteNode, "sprite"))
+            {
+                if (!spriteNode->xmlChildrenNode)
+                    continue;
+
+                SpriteReference *const currentSprite = new SpriteReference;
+                currentSprite->sprite = reinterpret_cast<const char*>(
+                    spriteNode->xmlChildrenNode->content);
+
+                currentSprite->variant = XML::getProperty(
+                    spriteNode, "variant", 0);
+                display.sprites.push_back(currentSprite);
+            }
+            else if (xmlNameEqual(spriteNode, "sound"))
+            {
+                if (!spriteNode->xmlChildrenNode)
+                    continue;
+
+                const std::string event = XML::getProperty(
+                    spriteNode, "event", "");
+                const int delay = XML::getProperty(
+                    spriteNode, "delay", 0);
+                const char *const filename = reinterpret_cast<const char*>(
+                    spriteNode->xmlChildrenNode->content);
+
+                if (event == "hit")
+                {
+                    currentInfo->addSound(ItemSoundEvent::HIT,
+                        filename, delay);
+                }
+                else if (event == "miss")
+                {
+                    currentInfo->addSound(ItemSoundEvent::MISS,
+                        filename, delay);
+                }
+                else if (event == "hurt")
+                {
+                    currentInfo->addSound(ItemSoundEvent::HURT,
+                        filename, delay);
+                }
+                else if (event == "die")
+                {
+                    currentInfo->addSound(ItemSoundEvent::DIE,
+                        filename, delay);
+                }
+                else if (event == "move")
+                {
+                    currentInfo->addSound(ItemSoundEvent::MOVE,
+                        filename, delay);
+                }
+                else if (event == "sit")
+                {
+                    currentInfo->addSound(ItemSoundEvent::SIT,
+                        filename, delay);
+                }
+                else if (event == "sittop")
+                {
+                    currentInfo->addSound(ItemSoundEvent::SITTOP,
+                        filename, delay);
+                }
+                else if (event == "spawn")
+                {
+                    currentInfo->addSound(ItemSoundEvent::SPAWN,
+                        filename, delay);
+                }
+                else
+                {
+                    logger->log("MercenaryDB: Warning, sound effect %s for "
+                                "unknown event %s of mercenary %s",
+                                filename, event.c_str(),
+                                currentInfo->getName().c_str());
+                }
+            }
+            else if (xmlNameEqual(spriteNode, "attack"))
+            {
+                const int attackId = XML::getProperty(spriteNode, "id", 0);
+                const int effectId = XML::getProperty(
+                    spriteNode, "effect-id", paths.getIntValue("effectId"));
+                const int hitEffectId = XML::getProperty(spriteNode,
+                    "hit-effect-id", paths.getIntValue("hitEffectId"));
+                const int criticalHitEffectId = XML::getProperty(spriteNode,
+                    "critical-hit-effect-id",
+                    paths.getIntValue("criticalHitEffectId"));
+                const int missEffectId = XML::getProperty(spriteNode,
+                    "miss-effect-id", paths.getIntValue("missEffectId"));
+
+                const std::string spriteAction = XML::getProperty(
+                    spriteNode, "action", "attack");
+                const std::string skySpriteAction = XML::getProperty(
+                    spriteNode, "skyaction", "skyattack");
+                const std::string waterSpriteAction = XML::getProperty(
+                    spriteNode, "wateraction", "waterattack");
+
+                const std::string missileParticle = XML::getProperty(
+                        spriteNode, "missile-particle", "");
+
+                currentInfo->addAttack(attackId, spriteAction, skySpriteAction,
+                    waterSpriteAction, effectId, hitEffectId,
+                    criticalHitEffectId, missEffectId, missileParticle);
+            }
+            else if (xmlNameEqual(spriteNode, "particlefx"))
+            {
+                if (!spriteNode->xmlChildrenNode)
+                    continue;
+
+                display.particles.push_back(reinterpret_cast<const char*>(
+                    spriteNode->xmlChildrenNode->content));
+            }
+        }
+        currentInfo->setDisplay(display);
+
+        mMercenaryInfos[id + offset] = currentInfo;
+    }
+}
+
+void MercenaryDB::unload()
+{
+    delete_all(mMercenaryInfos);
+    mMercenaryInfos.clear();
+
+    mLoaded = false;
+}
+
+
+BeingInfo *MercenaryDB::get(const int id)
+{
+    BeingInfoIterator i = mMercenaryInfos.find(id);
+
+    if (i == mMercenaryInfos.end())
+    {
+        i = mMercenaryInfos.find(id);
+        if (i == mMercenaryInfos.end())
+        {
+            logger->log("MercenaryDB: Warning, unknown mercenary ID "
+                "%d requested",
+                id);
+            return BeingInfo::unknown;
+        }
+        else
+        {
+            return i->second;
+        }
+    }
+    else
+    {
+        return i->second;
+    }
+}
diff --git a/src/resources/db/mercenarydb.h b/src/resources/db/mercenarydb.h
new file mode 100644
index 000000000..05b449a70
--- /dev/null
+++ b/src/resources/db/mercenarydb.h
@@ -0,0 +1,46 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2004-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2014  The ManaPlus Developers
+ *
+ *  This file is part of The ManaPlus Client.
+ *
+ *  This program is free software; you can redistribute it and/or modify
+ *  it under the terms of the GNU General Public License as published by
+ *  the Free Software Foundation; either version 2 of the License, or
+ *  any later version.
+ *
+ *  This program is distributed in the hope that it will be useful,
+ *  but WITHOUT ANY WARRANTY; without even the implied warranty of
+ *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ *  GNU General Public License for more details.
+ *
+ *  You should have received a copy of the GNU General Public License
+ *  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+#ifndef RESOURCES_DB_MERCENARYDB_H
+#define RESOURCES_DB_MERCENARYDB_H
+
+#include "localconsts.h"
+
+#include <string>
+
+class BeingInfo;
+
+/**
+ * Mercenary information database.
+ */
+namespace MercenaryDB
+{
+    void load();
+
+    void unload();
+
+    void loadXmlFile(const std::string &fileName);
+
+    BeingInfo *get(const int id) A_WARN_UNUSED;
+}  // namespace MercenaryDB
+
+#endif  // RESOURCES_DB_MERCENARYDB_H