inventory.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2004-2009  The Mana World Development Team
 *  Copyright (C) 2009-2010  The Mana Developers
 *  Copyright (C) 2011-2019  The ManaPlus Developers
 *  Copyright (C) 2019-2021  Andrei Karas
 *
 *  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_INVENTORY_INVENTORY_H
#define RESOURCES_INVENTORY_INVENTORY_H
 
#include "enums/inventorytype.h"
 
#include "enums/resources/item/itemtype.h"
 
#include "enums/simpletypes/beingtypeid.h"
#include "enums/simpletypes/damaged.h"
#include "enums/simpletypes/equipm.h"
#include "enums/simpletypes/equipped.h"
#include "enums/simpletypes/favorite.h"
#include "enums/simpletypes/identified.h"
#include "enums/simpletypes/itemcolor.h"
 
#include "enums/being/gender.h"
 
#include "utils/intmap.h"
 
#include <list>
#include <string>
 
#include "localconsts.h"
 
class InventoryListener;
class Item;
 
struct ItemOptionsList;
 
class Inventory notfinal
{
    public:
        A_DELETE_COPY(Inventory)
 
        static const int NO_SLOT_INDEX = -1; 
        Inventory(const InventoryTypeT type,
                  const int size);
 
        virtual ~Inventory();
 
        unsigned getSize() const noexcept2 A_WARN_UNUSED
        { return mSize; }
 
        Item *getItem(const int index) const A_WARN_UNUSED;
 
        Item *findItem(const int itemId,
                       const ItemColor color) const A_WARN_UNUSED;
 
        int addItem(const int id,
                    const ItemTypeT type,
                    const int quantity,
                    const uint8_t refine,
                    const ItemColor color,
                    const Identified identified,
                    const Damaged damaged,
                    const Favorite favorite,
                    const Equipm equipment,
                    const Equipped equipped);
 
        virtual void setItem(const int index,
                             const int id,
                             const ItemTypeT type,
                             const int quantity,
                             const uint8_t refine,
                             const ItemColor color,
                             const Identified identified,
                             const Damaged damaged,
                             const Favorite favorite,
                             const Equipm equipment,
                             const Equipped equipped);
 
        void setCards(const int index,
                      const int *const cards,
                      const int size) const;
 
        void setOptions(const int index,
                        const ItemOptionsList *const options);
 
        void setTag(const int index,
                    const int tag);
 
        void moveItem(const int index1,
                      const int index2);
 
        void removeItem(const int id);
 
        void removeItemAt(const int index);
 
        bool contains(const Item *const item) const A_WARN_UNUSED;
 
        int getFreeSlot() const A_WARN_UNUSED;
 
        void clear();
 
        int getNumberOfSlotsUsed() const noexcept2 A_WARN_UNUSED
        { return mUsed; }
 
        int getLastUsedSlot() const A_WARN_UNUSED;
 
        void addInventoyListener(InventoryListener *const listener);
 
        void removeInventoyListener(InventoryListener *const listener);
 
        InventoryTypeT getType() const noexcept2 A_WARN_UNUSED
        { return mType; }
 
        bool isMainInventory() const noexcept2 A_WARN_UNUSED
        { return mType == InventoryType::Inventory; }
 
        const Item *findItemBySprite(std::string spritePath,
                                     const GenderT gender,
                                     const BeingTypeId race)
                                     const A_WARN_UNUSED;
 
        std::string getName() const A_WARN_UNUSED;
 
        void resize(const unsigned int newSize);
 
        int findIndexByTag(const int tag) const;
 
        Item *findItemByTag(const int tag) const;
 
        virtual bool addVirtualItem(const Item *const item,
                                    int index,
                                    const int amount);
 
        void virtualRemove(Item *const item,
                           const int amount);
 
        void virtualRestore(const Item *const item,
                            const int amount);
 
        void restoreVirtuals();
 
    protected:
        typedef std::list<InventoryListener*> InventoryListenerList;
        InventoryListenerList mInventoryListeners;
 
        void distributeSlotsChangedEvent();
 
        IntMap mVirtualRemove;
        InventoryTypeT mType;
        unsigned mSize; 
        Item **mItems;  
        int mUsed;      
};
 
#endif  // RESOURCES_INVENTORY_INVENTORY_H