EmoteShortcut Class Reference

#include <emoteshortcut.h>

Public Member Functions
	EmoteShortcut ()
	~EmoteShortcut ()
void	load ()
unsigned char	getEmote (const size_t index) const
unsigned char	getEmoteSelected () const
void	setEmote (const size_t index)
void	setEmotes (const size_t index, const unsigned char emoteId)
void	setEmoteSelected (const unsigned char emoteId)
bool	isEmoteSelected () const
void	removeEmote (const size_t index)
void	useEmote (const size_t index) const
void	useEmotePlayer (const size_t index) const

Static Public Member Functions
static unsigned int	getEmoteCount ()

Private Member Functions
void	save () const

Private Attributes
unsigned char	mEmotes [SHORTCUT_EMOTES]
unsigned char	mEmoteSelected

Detailed Description

The class which keeps track of the emote shortcuts.

Definition at line 35 of file emoteshortcut.h.

Constructor & Destructor Documentation

EmoteShortcut()

EmoteShortcut::EmoteShortcut

(

)

Constructor.

Definition at line 40 of file emoteshortcut.cpp.

                             :
    mEmoteSelected(0)
{
    for (int i = 0; i < SHORTCUT_EMOTES; i++)
        mEmotes[i] = 0;
}

References mEmotes, and SHORTCUT_EMOTES.

~EmoteShortcut()

EmoteShortcut::~EmoteShortcut

(

)

Destructor.

Definition at line 47 of file emoteshortcut.cpp.

{
    save();
}

References save().

Member Function Documentation

getEmote()

unsigned char EmoteShortcut::getEmote ( const size_t  index ) const

inline

Returns the shortcut Emote ID specified by the index.

Parameters

index

Index of the shortcut Emote.

Definition at line 60 of file emoteshortcut.h.

        { return mEmotes[index]; }

References mEmotes.

Referenced by EmoteShortcutContainer::mousePressed(), and EmoteShortcutContainer::mouseReleased().

getEmoteCount()

static unsigned int EmoteShortcut::getEmoteCount ( )

inlinestatic

Returns the amount of shortcut Emotes.

Definition at line 66 of file emoteshortcut.h.

        { return SHORTCUT_EMOTES; }

References SHORTCUT_EMOTES.

getEmoteSelected()

unsigned char EmoteShortcut::getEmoteSelected ( ) const

inline

Returns the emote ID that is currently selected.

Definition at line 72 of file emoteshortcut.h.

        { return mEmoteSelected; }

References mEmoteSelected.

isEmoteSelected()

bool EmoteShortcut::isEmoteSelected ( ) const

inline

A flag to check if the Emote is selected.

Definition at line 104 of file emoteshortcut.h.

        { return mEmoteSelected != 0U; }

References mEmoteSelected.

Referenced by EmoteShortcutContainer::mousePressed(), and EmoteShortcutContainer::mouseReleased().

load()

void EmoteShortcut::load

(

)

Load the configuration information.

Definition at line 52 of file emoteshortcut.cpp.

{
    for (unsigned char i = 0, j = 0,
         fsz = CAST_U8(EmoteDB::getLast());
         i <= fsz && j < SHORTCUT_EMOTES;
         i++)
    {
        const EmoteSprite *const sprite = EmoteDB::getSprite(i, true);
        if (sprite != nullptr)
        {
            mEmotes[j] = CAST_U8(i + 1);
            j ++;
        }
    }
}

References CAST_U8, EmoteDB::getLast(), EmoteDB::getSprite(), mEmotes, and SHORTCUT_EMOTES.

Referenced by createGuiWindows().

removeEmote()

void EmoteShortcut::removeEmote ( const size_t  index )

inline

Remove a Emote from the shortcut.

Definition at line 110 of file emoteshortcut.h.

        { if (index < CAST_SIZE(SHORTCUT_EMOTES)) mEmotes[index] = 0; }

References CAST_SIZE, mEmotes, and SHORTCUT_EMOTES.

save()

void EmoteShortcut::save ( ) const

private

Save the configuration information.

Definition at line 68 of file emoteshortcut.cpp.

{
    for (int i = 0; i < SHORTCUT_EMOTES; i++)
    {
        const unsigned char emoteId = mEmotes[i] != 0U ? mEmotes[i]
            : CAST_U8(0);
        serverConfig.setValue("emoteshortcut" + toString(i),
            CAST_U32(emoteId));
    }
}

References CAST_U32, CAST_U8, mEmotes, serverConfig, Configuration::setValue(), SHORTCUT_EMOTES, and Catch::toString().

Referenced by ~EmoteShortcut().

setEmote()

void EmoteShortcut::setEmote ( const size_t  index )

inline

Adds the selected emote ID to the emotes specified by the index.

Parameters

index

Index of the emotes.

Definition at line 80 of file emoteshortcut.h.

        { mEmotes[index] = mEmoteSelected; }

References mEmotes, and mEmoteSelected.

Referenced by EmoteShortcutContainer::mousePressed().

setEmotes()

void EmoteShortcut::setEmotes ( const size_t  index, const unsigned char  emoteId  )

inline

Adds a emoticon to the emotes store specified by the index.

Parameters

index	Index of the emote.
emoteId	ID of the emote.

Definition at line 89 of file emoteshortcut.h.

        { mEmotes[index] = emoteId; }

References mEmotes.

Referenced by EmoteShortcutContainer::mouseReleased().

setEmoteSelected()

void EmoteShortcut::setEmoteSelected ( const unsigned char  emoteId )

inline

Set the Emote that is selected.

Parameters

emoteId

The ID of the emote that is to be assigned.

Definition at line 98 of file emoteshortcut.h.

        { mEmoteSelected = emoteId; }

References mEmoteSelected.

Referenced by EmoteShortcutContainer::mousePressed(), and EmoteShortcutContainer::mouseReleased().

useEmote()

void EmoteShortcut::useEmote

(

const size_t

index

)

const

Try to use the Emote specified by the index.

Parameters

index

Index of the emote shortcut.

Definition at line 88 of file emoteshortcut.cpp.

{
    if (localPlayer == nullptr)
        return;
 
    if (index <= CAST_SIZE(SHORTCUT_EMOTES))
    {
        if (mEmotes[index - 1] > 0)
        {
            const uint8_t emote = mEmotes[index - 1];
            switch (settings.emoteType)
            {
                case EmoteType::Player:
                default:
                    LocalPlayer::emote(emote);
                    break;
                case EmoteType::Pet:
                    petHandler->emote(emote);
                    break;
                case EmoteType::Homunculus:
                    homunculusHandler->emote(emote);
                    break;
                case EmoteType::Mercenary:
                    mercenaryHandler->emote(emote);
                    break;
            }
        }
    }
}

References CAST_SIZE, Net::HomunculusHandler::emote(), Net::MercenaryHandler::emote(), Net::PetHandler::emote(), LocalPlayer::emote(), Actions::emote(), Settings::emoteType, EmoteType::Homunculus, homunculusHandler, localPlayer, mEmotes, EmoteType::Mercenary, mercenaryHandler, EmoteType::Pet, petHandler, EmoteType::Player, settings, and SHORTCUT_EMOTES.

Referenced by EmoteShortcutContainer::mouseReleased().

useEmotePlayer()

void EmoteShortcut::useEmotePlayer

(

const size_t

index

)

const

Definition at line 79 of file emoteshortcut.cpp.

{
    if (index <= CAST_SIZE(SHORTCUT_EMOTES))
    {
        if (mEmotes[index - 1] > 0)
            LocalPlayer::emote(mEmotes[index - 1]);
    }
}

References CAST_SIZE, LocalPlayer::emote(), mEmotes, and SHORTCUT_EMOTES.

Field Documentation

mEmotes

unsigned char EmoteShortcut::mEmotes[SHORTCUT_EMOTES]

private

Definition at line 128 of file emoteshortcut.h.

Referenced by EmoteShortcut(), getEmote(), load(), removeEmote(), save(), setEmote(), setEmotes(), useEmote(), and useEmotePlayer().

mEmoteSelected

unsigned char EmoteShortcut::mEmoteSelected

private

Definition at line 129 of file emoteshortcut.h.

Referenced by getEmoteSelected(), isEmoteSelected(), setEmote(), and setEmoteSelected().

---

The documentation for this class was generated from the following files:

• src/gui/shortcut/emoteshortcut.h (986a3bf)
• src/gui/shortcut/emoteshortcut.cpp (986a3bf)