Load data about homunculuses from homunculuses.xml.

7 files changed, 352 insertions, 3 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 5689a00a0..5adfbaae1 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -605,6 +605,8 @@ SET(SRCS
     resources/emotesprite.h
     resources/db/emotedb.cpp
     resources/db/emotedb.h
+    resources/db/homunculusdb.cpp
+    resources/db/homunculusdb.h
     resources/fboinfo.h
     resources/frame.h
     resources/image.cpp
diff --git a/src/Makefile.am b/src/Makefile.am
index 9d063071e..7db751e22 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -730,6 +730,8 @@ manaplus_SOURCES += gui/widgets/avatarlistbox.cpp \
 	      resources/dyepalette.h \
 	      resources/db/emotedb.cpp \
 	      resources/db/emotedb.h \
+	      resources/db/homunculusdb.cpp \
+	      resources/db/homunculusdb.h \
 	      resources/fboinfo.h \
 	      resources/frame.h \
 	      resources/image.cpp \
diff --git a/src/being/being.cpp b/src/being/being.cpp
index 869d7d8b1..2626ca13a 100644
--- a/src/being/being.cpp
+++ b/src/being/being.cpp
@@ -72,6 +72,7 @@
 
 #include "resources/db/avatardb.h"
 #include "resources/db/emotedb.h"
+#include "resources/db/homunculusdb.h"
 #include "resources/db/itemdb.h"
 #include "resources/db/mercenarydb.h"
 #include "resources/db/monsterdb.h"
@@ -224,7 +225,8 @@ Being::Being(const int id,
 
     if (mType == ActorType::Player
         || mType == ActorType::Mercenary
-        || mType == ActorType::Pet)
+        || mType == ActorType::Pet
+        || mType == ActorType::Homunculus)
     {
         mShowName = config.getBoolValue("visiblenames");
     }
@@ -303,7 +305,7 @@ void Being::setSubtype(const uint16_t subtype, const uint8_t look)
     mSubType = subtype;
     mLook = look;
 
-    if (mType == ActorType::Monster || mType == ActorType::Homunculus)
+    if (mType == ActorType::Monster)
     {
         mInfo = MonsterDB::get(mSubType);
         if (mInfo)
@@ -336,6 +338,17 @@ void Being::setSubtype(const uint16_t subtype, const uint8_t look)
             mYDiff = mInfo->getSortOffsetY();
         }
     }
+    if (mType == ActorType::Homunculus)
+    {
+        mInfo = HomunculusDB::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);
@@ -579,7 +592,8 @@ void Being::takeDamage(Being *const attacker, const int amount,
     }
     else if (mType == ActorType::Monster
              || mType == ActorType::Mercenary
-             || mType == ActorType::Pet)
+             || mType == ActorType::Pet
+             || mType == ActorType::Homunculus)
     {
         if (attacker == localPlayer)
         {
@@ -2945,6 +2959,7 @@ std::string Being::loadComment(const std::string &name,
         case ActorType::LocalPet:
         case ActorType::Avatar:
         case ActorType::Mercenary:
+        case ActorType::Homunculus:
         case ActorType::Pet:
         default:
             return "";
diff --git a/src/client.cpp b/src/client.cpp
index dd9f5f12e..06a8a9db8 100644
--- a/src/client.cpp
+++ b/src/client.cpp
@@ -101,6 +101,7 @@
 #include "resources/db/colordb.h"
 #include "resources/db/deaddb.h"
 #include "resources/db/emotedb.h"
+#include "resources/db/homunculusdb.h"
 #include "resources/db/sounddb.h"
 #include "resources/db/itemdb.h"
 #include "resources/db/mapdb.h"
@@ -610,6 +611,7 @@ void Client::gameClear()
     EmoteDB::unload();
     ItemDB::unload();
     MercenaryDB::unload();
+    HomunculusDB::unload();
     MonsterDB::unload();
     NPCDB::unload();
     AvatarDB::unload();
@@ -1252,6 +1254,7 @@ int Client::gameExec()
                     ItemDB::load();
                     Being::load();
                     MercenaryDB::load();
+                    HomunculusDB::load();
                     MonsterDB::load();
                     AvatarDB::load();
                     WeaponsDB::load();
diff --git a/src/defaults.cpp b/src/defaults.cpp
index 567a58655..4b14192ff 100644
--- a/src/defaults.cpp
+++ b/src/defaults.cpp
@@ -558,6 +558,9 @@ DefaultsData* getPathsDefaults()
     AddDEF("mercenariesFile", "mercenaries.xml");
     AddDEF("mercenariesPatchFile", "mercenaries_patch.xml");
     AddDEF("mercenariesPatchDir", "mercenaries.d");
+    AddDEF("homunculusesFile", "homunculuses.xml");
+    AddDEF("homunculusesPatchFile", "homunculuses_patch.xml");
+    AddDEF("homunculusesPatchDir", "homunculuses.d");
     AddDEF("mapsRemapFile", "maps/remap.xml");
     AddDEF("mapsRemapPatchFile", "maps/remap_patch.xml");
     AddDEF("mapsRemapPatchDir", "maps/remap.d");
diff --git a/src/resources/db/homunculusdb.cpp b/src/resources/db/homunculusdb.cpp
new file mode 100644
index 000000000..76d8189db
--- /dev/null
+++ b/src/resources/db/homunculusdb.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/homunculusdb.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 mHomunculusInfos;
+    bool mLoaded = false;
+}
+
+void HomunculusDB::load()
+{
+    if (mLoaded)
+        unload();
+
+    logger->log1("Initializing homunculus database...");
+    loadXmlFile(paths.getStringValue("homunculusesFile"));
+    loadXmlFile(paths.getStringValue("homunculusesPatchFile"));
+    loadXmlDir("homunculusesPatchDir", loadXmlFile);
+
+    mLoaded = true;
+}
+
+void HomunculusDB::loadXmlFile(const std::string &fileName)
+{
+    XML::Document doc(fileName);
+    const XmlNodePtr rootNode = doc.rootNode();
+
+    if (!rootNode || !xmlNameEqual(rootNode, "homunculuses"))
+    {
+        logger->log("Homunculus Database: Error while loading %s!",
+            paths.getStringValue("homunculusesFile").c_str());
+        mLoaded = true;
+        return;
+    }
+
+    const int offset = XML::getProperty(rootNode, "offset", 0);
+
+    // iterate <homunculus>s
+    for_each_xml_child_node(homunculusNode, rootNode)
+    {
+        if (xmlNameEqual(homunculusNode, "include"))
+        {
+            const std::string name = XML::getProperty(homunculusNode, "name", "");
+            if (!name.empty())
+                loadXmlFile(name);
+            continue;
+        }
+        if (!xmlNameEqual(homunculusNode, "homunculus"))
+            continue;
+
+        const int id = XML::getProperty(homunculusNode, "id", 0);
+        BeingInfo *currentInfo = nullptr;
+        if (mHomunculusInfos.find(id + offset) != mHomunculusInfos.end())
+        {
+            logger->log("HomunculusDB: Redefinition of homunculus ID %d", id);
+            currentInfo = mHomunculusInfos[id + offset];
+        }
+        if (!currentInfo)
+            currentInfo = new BeingInfo;
+
+        currentInfo->setBlockType(BlockType::MONSTER);
+        BeingCommon::readBasicAttributes(currentInfo, homunculusNode, "attack");
+
+        currentInfo->setMaxHP(XML::getProperty(homunculusNode, "maxHP", 0));
+
+        currentInfo->setDeadSortOffsetY(XML::getProperty(
+            homunculusNode, "deadSortOffsetY", 31));
+
+        currentInfo->setColorsList(XML::getProperty(homunculusNode,
+            "colors", ""));
+
+        unsigned char block = 0;
+        std::string walkStr = XML::getProperty(
+            homunculusNode, "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, homunculusNode)
+        {
+            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("HomunculusDB: Warning, sound effect %s for "
+                                "unknown event %s of homunculus %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);
+
+        mHomunculusInfos[id + offset] = currentInfo;
+    }
+}
+
+void HomunculusDB::unload()
+{
+    delete_all(mHomunculusInfos);
+    mHomunculusInfos.clear();
+
+    mLoaded = false;
+}
+
+
+BeingInfo *HomunculusDB::get(const int id)
+{
+    BeingInfoIterator i = mHomunculusInfos.find(id);
+
+    if (i == mHomunculusInfos.end())
+    {
+        i = mHomunculusInfos.find(id);
+        if (i == mHomunculusInfos.end())
+        {
+            logger->log("HomunculusDB: Warning, unknown homunculus ID "
+                "%d requested",
+                id);
+            return BeingInfo::unknown;
+        }
+        else
+        {
+            return i->second;
+        }
+    }
+    else
+    {
+        return i->second;
+    }
+}
diff --git a/src/resources/db/homunculusdb.h b/src/resources/db/homunculusdb.h
new file mode 100644
index 000000000..31e073876
--- /dev/null
+++ b/src/resources/db/homunculusdb.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_HOMUNCULUSDB_H
+#define RESOURCES_DB_HOMUNCULUSDB_H
+
+#include "localconsts.h"
+
+#include <string>
+
+class BeingInfo;
+
+/**
+ * Homunculus information database.
+ */
+namespace HomunculusDB
+{
+    void load();
+
+    void unload();
+
+    void loadXmlFile(const std::string &fileName);
+
+    BeingInfo *get(const int id) A_WARN_UNUSED;
+}  // namespace HomunculusDB
+
+#endif  // RESOURCES_DB_HOMUNCULUSDB_H