itemshortcut.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2007-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 GUI_SHORTCUT_ITEMSHORTCUT_H
#define GUI_SHORTCUT_ITEMSHORTCUT_H
 
#include "const/itemshortcut.h"
 
#include "enums/simpletypes/itemcolor.h"
 
#include <string>
 
#include "localconsts.h"
 
class Item;
 
class ItemShortcut final
{
    public:
        explicit ItemShortcut(const size_t number);
 
        A_DELETE_COPY(ItemShortcut)
 
        
        ~ItemShortcut();
 
        void load();
 
        void save() const;
 
        int getItem(const size_t index) const A_WARN_UNUSED
        { return mItems[index]; }
 
        ItemColor getItemColor(const size_t index) const A_WARN_UNUSED
        { return mItemColors[index]; }
 
        void setItemData(const size_t index,
                         const std::string &data)
        { mItemData[index] = data; }
 
        std::string getItemData(const size_t index) const A_WARN_UNUSED
        { return mItemData[index]; }
 
        constexpr static int getItemCount() A_WARN_UNUSED
        { return SHORTCUT_ITEMS; }
 
        int getItemSelected() const noexcept2 A_WARN_UNUSED
        { return mItemSelected; }
 
        void setItem(const size_t index);
 
        void setItem(const size_t index,
                     const int item,
                     const ItemColor color);
 
        void setItemFast(const size_t index,
                         const int item,
                         const ItemColor color);
 
        void setItems(const size_t index,
                      const int itemId,
                      const ItemColor color)
        { mItems[index] = itemId; mItemColors[index] = color; save(); }
 
        void setItemSelected(const int itemId)
        { mItemSelected = itemId; }
 
        void setItemSelected(const Item *const item);
 
        int getSelectedItem() const noexcept2 A_WARN_UNUSED
        { return mItemSelected; }
 
        bool isItemSelected() const noexcept2 A_WARN_UNUSED
        { return mItemSelected > -1; }
 
        void removeItem(const size_t index)
        { mItems[index] = -1;  save(); }
 
        void useItem(const size_t index) const;
 
        void equipItem(const size_t index) const;
 
        void unequipItem(const size_t index) const;
 
        void swap(const size_t index1,
                  const size_t index2);
 
        void clear();
 
        size_t getFreeIndex() const A_WARN_UNUSED;
 
    private:
        int mItems[SHORTCUT_ITEMS];             
        ItemColor mItemColors[SHORTCUT_ITEMS];  
        std::string mItemData[SHORTCUT_ITEMS];
        size_t mNumber;
        int mItemSelected;
        ItemColor mItemColorSelected;
};
 
extern ItemShortcut *itemShortcut[SHORTCUT_TABS];
 
#endif  // GUI_SHORTCUT_ITEMSHORTCUT_H