add basic client side only support for pets.

now pets cant move and dont have any ai.
pet can be only spawn at player position if equiped item with assigned pet.

13 files changed, 308 insertions, 2 deletions

diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt
index 94bceed81..84388508d 100644
--- a/src/CMakeLists.txt
+++ b/src/CMakeLists.txt
@@ -452,6 +452,8 @@ SET(SRCS
     resources/npcdb.h
     resources/openglimagehelper.cpp
     resources/openglimagehelper.h
+    resources/petdb.cpp
+    resources/petdb.h
     resources/resource.cpp
     resources/resource.h
     resources/resourcemanager.cpp
diff --git a/src/Makefile.am b/src/Makefile.am
index 923fecc15..4c9ccb872 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -453,6 +453,8 @@ manaplus_SOURCES += gui/widgets/avatarlistbox.cpp \
 	      resources/npcdb.h \
 	      resources/openglimagehelper.cpp \
 	      resources/openglimagehelper.h \
+	      resources/petdb.cpp \
+	      resources/petdb.h \
 	      resources/resource.cpp \
 	      resources/resource.h \
 	      resources/resourcemanager.cpp \
diff --git a/src/actorsprite.h b/src/actorsprite.h
index 5a57b91a6..df895f879 100644
--- a/src/actorsprite.h
+++ b/src/actorsprite.h
@@ -49,7 +49,8 @@ public:
         NPC,
         MONSTER,
         FLOOR_ITEM,
-        PORTAL
+        PORTAL,
+        PET
     };
 
     enum TargetCursorSize
diff --git a/src/being.cpp b/src/being.cpp
index 4f1016b79..564cdec34 100644
--- a/src/being.cpp
+++ b/src/being.cpp
@@ -57,6 +57,7 @@
 #include "resources/iteminfo.h"
 #include "resources/monsterdb.h"
 #include "resources/npcdb.h"
+#include "resources/petdb.h"
 #include "resources/resourcemanager.h"
 
 #include "gui/widgets/chattab.h"
@@ -251,6 +252,9 @@ Being::Being(const int id, const Type type, const uint16_t subtype,
     mInactive(false),
     mNumber(100),
     mHairColor(0),
+    mPet(nullptr),
+    mPetId(0),
+    mOwner(nullptr),
     mSpecialParticle(nullptr)
 {
     for (int f = 0; f < 20; f ++)
@@ -301,6 +305,11 @@ Being::~Being()
     mEmotionSprite = nullptr;
     delete mAnimationEffect;
     mAnimationEffect = nullptr;
+
+    if (mOwner)
+        mOwner->setPet(nullptr);
+    if (mPet)
+        mPet->setOwner(nullptr);
 }
 
 void Being::setSubtype(const uint16_t subtype)
@@ -332,6 +341,15 @@ void Being::setSubtype(const uint16_t subtype)
             mYDiff = mInfo->getSortOffsetY();
         }
     }
+    else if (mType == PET)
+    {
+        mInfo = PETDB::get(mId);
+        if (mInfo)
+        {
+            setupSpriteDisplay(mInfo->getDisplay(), false);
+            mYDiff = mInfo->getSortOffsetY();
+        }
+    }
     else if (mType == PLAYER)
     {
         int id = -100 - subtype;
@@ -1826,6 +1844,13 @@ void Being::setSprite(const unsigned int slot, const int id,
 
         if (isWeapon)
             mEquippedWeapon = nullptr;
+        const ItemInfo &info = ItemDB::get(mSpriteIDs[slot]);
+        if (mMap)
+        {
+            const int pet = info.getPet();
+            if (pet)
+                removePet();
+        }
     }
     else
     {
@@ -1833,6 +1858,13 @@ void Being::setSprite(const unsigned int slot, const int id,
         const std::string filename = info.getSprite(mGender, mSubType);
         AnimatedSprite *equipmentSprite = nullptr;
 
+        if (mType == PLAYER)
+        {
+            const int pet = info.getPet();
+            if (pet)
+                addPet(pet);
+        }
+
         if (!filename.empty())
         {
             if (color.empty())
@@ -2855,6 +2887,52 @@ void Being::addEffect(const std::string &name)
         paths.getStringValue("sprites") + name);
 }
 
+void Being::addPet(const int id)
+{
+    if (!actorSpriteManager)
+        return;
+
+    removePet();
+    Being *const being = actorSpriteManager->createBeing(
+        id, ActorSprite::PET, 0);
+    if (being)
+    {
+        being->setTileCoords(getTileX(), getTileY());
+        being->setOwner(this);
+        mPetId = id;
+        mPet = being;
+    }
+}
+
+void Being::removePet()
+{
+    if (!actorSpriteManager)
+        return;
+
+    mPetId = 0;
+    if (mPet)
+    {
+        mPet->setOwner(nullptr);
+        actorSpriteManager->destroy(mPet);
+        mPet = nullptr;
+    }
+}
+
+void Being::updatePets()
+{
+    removePet();
+    FOR_EACH (std::vector<int>::const_iterator, it, mSpriteIDs)
+    {
+        const ItemInfo &info = ItemDB::get(*it);
+        const int pet = info.getPet();
+        if (pet)
+        {
+            addPet(pet);
+            return;
+        }
+    }
+}
+
 BeingEquipBackend::BeingEquipBackend(Being *const being):
     mBeing(being)
 {
diff --git a/src/being.h b/src/being.h
index 2f8b21cd4..d54c4fad1 100644
--- a/src/being.h
+++ b/src/being.h
@@ -863,6 +863,21 @@ class Being : public ActorSprite, public ConfigListener
 
         void addEffect(const std::string &name);
 
+        void addPet(const int id);
+
+        void removePet();
+
+        void updatePets();
+
+        Being *getPet()
+        { return mPet; }
+
+        void setPet(Being *const pet)
+        { mPet = pet; }
+
+        void setOwner(Being *const owner)
+        { mOwner = owner; }
+
         static uint8_t genderToInt(const Gender sex) A_WARN_UNUSED;
 
         static Gender intToGender(uint8_t sex) A_WARN_UNUSED;
@@ -1023,6 +1038,9 @@ class Being : public ActorSprite, public ConfigListener
         bool mInactive;
         unsigned mNumber;
         unsigned char mHairColor;
+        Being *mPet;
+        int mPetId;
+        Being *mOwner;
         Particle *mSpecialParticle;
 };
 
diff --git a/src/client.cpp b/src/client.cpp
index 0562094c5..9431c5c55 100644
--- a/src/client.cpp
+++ b/src/client.cpp
@@ -91,6 +91,7 @@
 #include "resources/specialdb.h"
 #endif
 #include "resources/npcdb.h"
+#include "resources/petdb.h"
 #include "resources/resourcemanager.h"
 
 #include "utils/gettext.h"
@@ -743,6 +744,7 @@ void Client::gameClear()
     ItemDB::unload();
     MonsterDB::unload();
     NPCDB::unload();
+    PETDB::unload();
     StatusEffect::unload();
 
     if (Net::getLoginHandler())
@@ -1378,6 +1380,7 @@ int Client::gameExec()
                     SpecialDB::load();
 #endif
                     NPCDB::load();
+                    PETDB::load();
                     EmoteDB::load();
                     StatusEffect::load();
                     Units::loadUnits();
diff --git a/src/game.cpp b/src/game.cpp
index 9a6f3b006..758e26064 100644
--- a/src/game.cpp
+++ b/src/game.cpp
@@ -435,6 +435,9 @@ Game::Game():
 
     if (guildManager && GuildManager::getEnableGuildBot())
         guildManager->requestGuildInfo();
+
+    if (player_node)
+        player_node->updatePets();
 }
 
 Game::~Game()
diff --git a/src/net/ea/playerhandler.cpp b/src/net/ea/playerhandler.cpp
index ed49b7ae5..e7b6c69b2 100644
--- a/src/net/ea/playerhandler.cpp
+++ b/src/net/ea/playerhandler.cpp
@@ -242,6 +242,7 @@ void PlayerHandler::processPlayerWarp(Net::MessageIn &msg) const
 
         player_node->setAction(Being::STAND);
         player_node->setTileCoords(x, y);
+        player_node->updatePets();
         player_node->navigateClean();
     }
 
diff --git a/src/resources/itemdb.cpp b/src/resources/itemdb.cpp
index befcd621e..973e5c71d 100644
--- a/src/resources/itemdb.cpp
+++ b/src/resources/itemdb.cpp
@@ -210,6 +210,7 @@ void ItemDB::load()
         std::string attackAction = XML::getProperty(node, "attack-action", "");
         std::string drawBefore = XML::getProperty(node, "drawBefore", "");
         std::string drawAfter = XML::getProperty(node, "drawAfter", "");
+        const int pet = XML::getProperty(node, "pet", 0);
         const int maxFloorOffset = XML::getIntProperty(
             node, "maxFloorOffset", 32, 0, 32);
         std::string colors;
@@ -261,6 +262,7 @@ void ItemDB::load()
         itemInfo->setDescription(description);
         itemInfo->setType(itemTypeFromString(typeStr));
         itemInfo->addTag(mTags["All"]);
+        itemInfo->setPet(pet);
         switch (itemInfo->getType())
         {
             case ITEM_USABLE:
diff --git a/src/resources/iteminfo.cpp b/src/resources/iteminfo.cpp
index 325528d60..92df520ea 100644
--- a/src/resources/iteminfo.cpp
+++ b/src/resources/iteminfo.cpp
@@ -54,7 +54,8 @@ ItemInfo::ItemInfo() :
     mCriticalHitEffectId(-1),
     mMissEffectId(-1),
     maxFloorOffset(32),
-    mPickupCursor(Cursor::CURSOR_POINTER)
+    mPickupCursor(Cursor::CURSOR_POINTER),
+    mPet(0)
 {
     for (int f = 0; f < 10; f ++)
     {
diff --git a/src/resources/iteminfo.h b/src/resources/iteminfo.h
index 0a3b20c61..afea431ee 100644
--- a/src/resources/iteminfo.h
+++ b/src/resources/iteminfo.h
@@ -256,6 +256,12 @@ class ItemInfo final
 
         bool isRemoveItemId(int id) const A_WARN_UNUSED;
 
+        void setPet(const int pet)
+        { mPet = pet; }
+
+        int getPet() const
+        { return mPet; }
+
         /** Effects to be shown when weapon attacks - see also effects.xml */
         std::string mMissileParticleFile;
 
@@ -331,6 +337,7 @@ class ItemInfo final
         int mMissEffectId;
         int maxFloorOffset;
         Cursor::Cursor mPickupCursor;
+        int mPet;
 };
 
 #endif
diff --git a/src/resources/petdb.cpp b/src/resources/petdb.cpp
new file mode 100644
index 000000000..1ca67db8d
--- /dev/null
+++ b/src/resources/petdb.cpp
@@ -0,0 +1,147 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2008-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2013  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/petdb.h"
+
+#include "logger.h"
+
+#include "resources/beinginfo.h"
+
+#include "utils/dtor.h"
+#include "configuration.h"
+
+#include "debug.h"
+
+namespace
+{
+    BeingInfos mPETInfos;
+    bool mLoaded = false;
+}
+
+extern int serverVersion;
+
+void PETDB::load()
+{
+    if (mLoaded)
+        unload();
+
+    logger->log1("Initializing PET database...");
+
+    XML::Document doc("pets.xml");
+    const XmlNodePtr rootNode = doc.rootNode();
+
+    if (!rootNode || !xmlNameEqual(rootNode, "pets"))
+    {
+        logger->log("PET Database: Error while loading pets.xml!");
+        mLoaded = true;
+        return;
+    }
+
+    // iterate <pet>s
+    for_each_xml_child_node(petNode, rootNode)
+    {
+        if (!xmlNameEqual(petNode, "pet"))
+            continue;
+
+        const int id = XML::getProperty(petNode, "id", 0);
+        if (id == 0)
+        {
+            logger->log1("PET Database: PET with missing ID in pets.xml!");
+            continue;
+        }
+
+        BeingInfo *const currentInfo = new BeingInfo;
+
+        currentInfo->setTargetSelection(XML::getBoolProperty(petNode,
+            "targetSelection", false));
+
+        currentInfo->setTargetCursorSize(XML::getProperty(petNode,
+            "targetCursor", "medium"));
+
+        currentInfo->setHoverCursor(XML::getProperty(petNode,
+            "hoverCursor", "talk"));
+
+        currentInfo->setTargetOffsetX(XML::getProperty(petNode,
+            "targetOffsetX", 0));
+
+        currentInfo->setTargetOffsetY(XML::getProperty(petNode,
+            "targetOffsetY", 0));
+
+        currentInfo->setSortOffsetY(XML::getProperty(petNode,
+            "sortOffsetY", 0));
+
+        currentInfo->setDeadSortOffsetY(XML::getProperty(petNode,
+            "deadSortOffsetY", 31));
+
+        SpriteDisplay display;
+        for_each_xml_child_node(spriteNode, petNode)
+        {
+            if (!spriteNode->xmlChildrenNode)
+                continue;
+
+            if (xmlNameEqual(spriteNode, "sprite"))
+            {
+                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, "particlefx"))
+            {
+                std::string particlefx = reinterpret_cast<const char*>(
+                    spriteNode->xmlChildrenNode->content);
+                display.particles.push_back(particlefx);
+            }
+        }
+
+        currentInfo->setDisplay(display);
+
+        mPETInfos[id] = currentInfo;
+    }
+
+    mLoaded = true;
+}
+
+void PETDB::unload()
+{
+    delete_all(mPETInfos);
+    mPETInfos.clear();
+
+    mLoaded = false;
+}
+
+BeingInfo *PETDB::get(const int id)
+{
+    const BeingInfoIterator i = mPETInfos.find(id);
+
+    if (i == mPETInfos.end())
+    {
+        logger->log("PETDB: Warning, unknown PET ID %d requested", id);
+        return BeingInfo::unknown;
+    }
+    else
+    {
+        return i->second;
+    }
+}
diff --git a/src/resources/petdb.h b/src/resources/petdb.h
new file mode 100644
index 000000000..755937902
--- /dev/null
+++ b/src/resources/petdb.h
@@ -0,0 +1,41 @@
+/*
+ *  The ManaPlus Client
+ *  Copyright (C) 2008-2009  The Mana World Development Team
+ *  Copyright (C) 2009-2010  The Mana Developers
+ *  Copyright (C) 2011-2013  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 PET_DB_H
+#define PET_DB_H
+
+#include <stdint.h>
+
+#include "localconsts.h"
+
+class BeingInfo;
+
+namespace PETDB
+{
+    void load();
+
+    void unload();
+
+    BeingInfo *get(const int id) A_WARN_UNUSED;
+}
+
+#endif