emoteshortcut.h

Go to the documentation of this file.

/*
 *  The ManaPlus Client
 *  Copyright (C) 2009  Aethyra Development Team
 *  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_EMOTESHORTCUT_H
#define GUI_SHORTCUT_EMOTESHORTCUT_H
 
#include "const/emoteshortcut.h"
 
#include "utils/cast.h"
 
#include "localconsts.h"
 
class EmoteShortcut final
{
    public:
        EmoteShortcut();
 
        A_DELETE_COPY(EmoteShortcut)
 
        
        ~EmoteShortcut();
 
        void load();
 
        unsigned char getEmote(const size_t index) const A_WARN_UNUSED
        { return mEmotes[index]; }
 
        static unsigned int getEmoteCount() A_WARN_UNUSED
        { return SHORTCUT_EMOTES; }
 
        unsigned char getEmoteSelected() const noexcept2 A_WARN_UNUSED
        { return mEmoteSelected; }
 
        void setEmote(const size_t index)
        { mEmotes[index] = mEmoteSelected; }
 
        void setEmotes(const size_t index,
                       const unsigned char emoteId)
        { mEmotes[index] = emoteId; }
 
        void setEmoteSelected(const unsigned char emoteId)
        { mEmoteSelected = emoteId; }
 
        bool isEmoteSelected() const noexcept2 A_WARN_UNUSED
        { return mEmoteSelected != 0U; }
 
        void removeEmote(const size_t index)
        { if (index < CAST_SIZE(SHORTCUT_EMOTES)) mEmotes[index] = 0; }
 
        void useEmote(const size_t index) const;
 
        void useEmotePlayer(const size_t index) const;
 
    private:
        void save() const;
 
        unsigned char mEmotes[SHORTCUT_EMOTES];  // The emote stored.
        unsigned char mEmoteSelected;            // The emote held by cursor.
};
 
extern EmoteShortcut *emoteShortcut;
 
#endif  // GUI_SHORTCUT_EMOTESHORTCUT_H