item.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_ITEM_ITEM_H
#define RESOURCES_ITEM_ITEM_H
 
#include "const/resources/item/cards.h"
 
#include "enums/resources/item/itemtype.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 "resources/db/itemdb.h"
 
#include "localconsts.h"
 
class Image;
 
struct ItemOptionsList;
 
class Item notfinal
{
    public:
        Item(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);
 
        A_DELETE_COPY(Item)
 
        
        virtual ~Item();
 
        void setId(const int id, const ItemColor color);
 
        int getId() const noexcept2 A_WARN_UNUSED
        { return mId; }
 
        Image *getImage() const noexcept2 A_WARN_UNUSED
        { return mImage; }
 
        void setQuantity(const int quantity) noexcept2
        { mQuantity = quantity; }
 
        void increaseQuantity(const int amount) noexcept2
        { mQuantity += amount; }
 
        int getQuantity() const noexcept2 A_WARN_UNUSED
        { return mQuantity; }
 
        void setEquipment(const Equipm equipment) noexcept2
        { mEquipment = equipment; }
 
        Equipm isEquipment() const noexcept2 A_WARN_UNUSED
        { return mEquipment; }
 
        void setEquipped(const Equipped equipped) noexcept2
        { mEquipped = equipped; }
 
        Equipped isEquipped() const noexcept2 A_WARN_UNUSED
        { return mEquipped; }
 
        void setRefine(const uint8_t refine) noexcept2
        { mRefine = refine; }
 
        uint8_t getRefine() const noexcept2 A_WARN_UNUSED
        { return mRefine; }
 
        void setInEquipment(const bool inEquipment) noexcept2
        { mInEquipment = inEquipment; }
 
        bool isInEquipment() const noexcept2 A_WARN_UNUSED
        { return mInEquipment; }
 
        void setInvIndex(const int index) noexcept2
        { mInvIndex = index; }
 
        int getInvIndex() const noexcept2 A_WARN_UNUSED
        { return mInvIndex; }
 
        const ItemInfo &getInfo() const A_WARN_UNUSED
        { return ItemDB::get(mId); }
 
        std::string getName() const A_WARN_UNUSED;
 
        static Image *getImage(const int id,
                               const ItemColor color) A_WARN_UNUSED;
 
        bool isHaveTag(const int tagId) const A_WARN_UNUSED;
 
        ItemColor getColor() const noexcept2 A_WARN_UNUSED
        { return mColor; }
 
        void setColor(const ItemColor color) noexcept2
        { mColor = color; }
 
        const std::string &getDescription() const noexcept2 A_WARN_UNUSED
        { return mDescription; }
 
        void setIdentified(const Identified b) noexcept2
        { mIdentified = b; }
 
        Identified getIdentified() const noexcept2 A_WARN_UNUSED
        { return mIdentified; }
 
        void setDamaged(const Damaged b) noexcept2
        { mDamaged = b; }
 
        Damaged getDamaged() const noexcept2 A_WARN_UNUSED
        { return mDamaged; }
 
        void setFavorite(const Favorite b) noexcept2
        { mFavorite = b; }
 
        Favorite getFavorite() const noexcept2 A_WARN_UNUSED
        { return mFavorite; }
 
        void setCard(const int index, const int id);
 
        int getCard(const int index) const;
 
        void setCards(const int *const cards, const int size);
 
        const int *getCards() const noexcept2 A_WARN_UNUSED
        { return mCards; }
 
        void setOptions(const ItemOptionsList *const options);
 
        const ItemOptionsList *getOptions() const noexcept2 A_WARN_UNUSED
        { return mOptions; }
 
        void setType(const ItemTypeT type) noexcept2
        { mType = type; }
 
        ItemTypeT getType() const noexcept2 A_WARN_UNUSED
        { return mType; }
 
        void setTag(const int tag) noexcept2
        { mTag = tag; }
 
        int getTag() const noexcept2 A_WARN_UNUSED
        { return mTag; }
 
        void addCard(const int card);
 
        void updateColor();
 
        static constexpr bool isItem(const int id) noexcept2 A_WARN_UNUSED
        {
            return id != 0 &&
                id != CARD0_FORGE &&
                id != CARD0_CREATE &&
                id != CARD0_PET;
        }
 
        int mId;              
        ItemColor mColor;
        int mQuantity;        
        int mTag;
 
    protected:
        Image *mImage;        
        std::string mDescription;
        std::map <int, int> mTags;
        int mCards[maxCards];
        const ItemOptionsList *mOptions;
        uint8_t mRefine;      
        int mInvIndex;        
        ItemTypeT mType;      
        Equipm mEquipment;    
        Equipped mEquipped;   
        bool mInEquipment;    
        Identified mIdentified;
        Damaged mDamaged;
        Favorite mFavorite;
};
 
#endif  // RESOURCES_ITEM_ITEM_H