ItemShortcut Class Reference

#include <itemshortcut.h>

Public Member Functions
	ItemShortcut (const size_t number)
	~ItemShortcut ()
void	load ()
void	save () const
int	getItem (const size_t index) const
ItemColor	getItemColor (const size_t index) const
void	setItemData (const size_t index, const std::string &data)
std::string	getItemData (const size_t index) const
int	getItemSelected () const
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)
void	setItemSelected (const int itemId)
void	setItemSelected (const Item *const item)
int	getSelectedItem () const
bool	isItemSelected () const
void	removeItem (const size_t index)
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

Static Public Member Functions
static int	getItemCount ()

Private Attributes
int	mItems [SHORTCUT_ITEMS]
ItemColor	mItemColors [SHORTCUT_ITEMS]
std::string	mItemData [SHORTCUT_ITEMS]
size_t	mNumber
int	mItemSelected
ItemColor	mItemColorSelected

Detailed Description

The class which keeps track of the item shortcuts.

Definition at line 40 of file itemshortcut.h.

Constructor & Destructor Documentation

ItemShortcut()

ItemShortcut::ItemShortcut ( const size_t  number )

explicit

Constructor.

Definition at line 45 of file itemshortcut.cpp.

                                              :
    mItems(),
    mItemColors(),
    mItemData(),
    mNumber(number),
    mItemSelected(-1),
    mItemColorSelected(ItemColor_one)
{
    load();
}

References load().

~ItemShortcut()

ItemShortcut::~ItemShortcut

(

)

Destructor.

Definition at line 56 of file itemshortcut.cpp.

{
    logger->log1("ItemShortcut::~ItemShortcut");
}

References Logger::log1(), and logger.

Member Function Documentation

clear()

void ItemShortcut::clear

(

)

Definition at line 141 of file itemshortcut.cpp.

{
    for (size_t i = 0; i < SHORTCUT_ITEMS; i++)
    {
        mItems[i] = 0;
        mItemColors[i] = ItemColor_zero;
        mItemData[i].clear();
    }
}

References ItemColor_zero, mItemColors, mItemData, mItems, and SHORTCUT_ITEMS.

Referenced by SkillDialog::update().

equipItem()

void ItemShortcut::equipItem

(

const size_t

index

)

const

Equip a item from the shortcut.

Definition at line 181 of file itemshortcut.cpp.

{
    const Inventory *const inv = PlayerInfo::getInventory();
    if (inv == nullptr)
        return;
 
    const int itemId = mItems[index];
    if (itemId != 0)
    {
        const Item *const item = inv->findItem(itemId, mItemColors[index]);
        if ((item != nullptr) && (item->getQuantity() != 0))
        {
            if (item->isEquipment() == Equipm_true)
            {
                if (item->isEquipped() == Equipped_false)
                    PlayerInfo::equipItem(item, Sfx_true);
            }
        }
    }
}

References PlayerInfo::equipItem(), Equipm_true, Equipped_false, Inventory::findItem(), PlayerInfo::getInventory(), Item::getQuantity(), Item::isEquipment(), Item::isEquipped(), mItemColors, mItems, and Sfx_true.

getFreeIndex()

size_t ItemShortcut::getFreeIndex

(

)

const

Definition at line 282 of file itemshortcut.cpp.

{
    for (size_t i = 0; i < SHORTCUT_ITEMS; i++)
    {
        if (mItems[i] < 0)
            return i;
    }
    return SHORTCUT_ITEMS;
}

References mItems, and SHORTCUT_ITEMS.

getItem()

int ItemShortcut::getItem ( const size_t  index ) const

inline

Returns the shortcut item ID specified by the index.

Parameters

index

Index of the shortcut item.

Definition at line 70 of file itemshortcut.h.

        { return mItems[index]; }

References mItems.

Referenced by ItemShortcutContainer::draw(), ItemShortcutContainer::mouseDragged(), ItemShortcutContainer::mouseMoved(), ItemShortcutContainer::mousePressed(), ItemShortcutContainer::mouseReleased(), and ItemShortcutContainer::safeDraw().

getItemColor()

ItemColor ItemShortcut::getItemColor ( const size_t  index ) const

inline

Definition at line 73 of file itemshortcut.h.

        { return mItemColors[index]; }

References mItemColors.

Referenced by ItemShortcutContainer::draw(), ItemShortcutContainer::mouseDragged(), ItemShortcutContainer::mouseMoved(), ItemShortcutContainer::mousePressed(), and ItemShortcutContainer::safeDraw().

getItemCount()

static int ItemShortcut::getItemCount ( )

inlinestatic

Returns the amount of shortcut items.

Definition at line 86 of file itemshortcut.h.

        { return SHORTCUT_ITEMS; }

References SHORTCUT_ITEMS.

Referenced by ItemShortcutContainer::ItemShortcutContainer().

getItemData()

std::string ItemShortcut::getItemData ( const size_t  index ) const

inline

Definition at line 80 of file itemshortcut.h.

        { return mItemData[index]; }

References mItemData.

Referenced by ItemShortcutContainer::mouseDragged(), and ItemShortcutContainer::mouseMoved().

getItemSelected()

int ItemShortcut::getItemSelected ( ) const

inline

Returns the item ID that is currently selected.

Definition at line 92 of file itemshortcut.h.

        { return mItemSelected; }

References mItemSelected.

getSelectedItem()

int ItemShortcut::getSelectedItem ( ) const

inline

Returns selected shortcut item ID.

Definition at line 134 of file itemshortcut.h.

        { return mItemSelected; }

References mItemSelected.

Referenced by ItemShortcutContainer::mousePressed().

isItemSelected()

bool ItemShortcut::isItemSelected ( ) const

inline

A flag to check if the item is selected.

Definition at line 140 of file itemshortcut.h.

        { return mItemSelected > -1; }

References mItemSelected.

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

load()

void ItemShortcut::load

(

)

Load the configuration information.

Definition at line 61 of file itemshortcut.cpp.

{
    std::string name;
    std::string color;
    std::string data;
    if (mNumber == SHORTCUT_AUTO_TAB)
        return;
 
    const Configuration *cfg = &serverConfig;
    if (mNumber != 0)
    {
        name = std::string("shortcut").append(
            toString(CAST_S32(mNumber))).append("_");
        color = std::string("shortcutColor").append(
            toString(CAST_U32(mNumber))).append("_");
        data = std::string("shortcutData").append(
            toString(CAST_U32(mNumber))).append("_");
    }
    else
    {
        name = "shortcut";
        color = "shortcutColor";
        data = "shortcutData";
    }
    for (unsigned int i = 0; i < SHORTCUT_ITEMS; i++)
    {
        const int itemId = cfg->getValue(name + toString(i), -1);
        const ItemColor itemColor = fromInt(
            cfg->getValue(color + toString(i), 1),
            ItemColor);
 
        mItems[i] = itemId;
        mItemColors[i] = itemColor;
        mItemData[i] = cfg->getValue(data + toString(i), std::string());
    }
}

References CAST_S32, CAST_U32, data, fromInt, ConfigurationObject::getValue(), mItemColors, mItemData, mItems, mNumber, serverConfig, SHORTCUT_AUTO_TAB, SHORTCUT_ITEMS, and Catch::toString().

Referenced by ItemShortcut().

removeItem()

void ItemShortcut::removeItem ( const size_t  index )

inline

Remove a item from the shortcut.

Definition at line 146 of file itemshortcut.h.

        { mItems[index] = -1;  save(); }

References mItems, and save().

Referenced by ItemShortcutContainer::mouseDragged().

save()

void ItemShortcut::save

(

)

const

Save the configuration information.

Definition at line 98 of file itemshortcut.cpp.

{
    std::string name;
    std::string color;
    std::string data;
    if (mNumber == SHORTCUT_AUTO_TAB)
        return;
    if (mNumber != 0)
    {
        name = std::string("shortcut").append(
            toString(CAST_S32(mNumber))).append("_");
        color = std::string("shortcutColor").append(
            toString(CAST_U32(mNumber))).append("_");
        data = std::string("shortcutData").append(
            toString(CAST_U32(mNumber))).append("_");
    }
    else
    {
        name = "shortcut";
        color = "shortcutColor";
        data = "shortcutData";
    }
 
    for (unsigned int i = 0; i < SHORTCUT_ITEMS; i++)
    {
        const int itemId = mItems[i] != 0 ? mItems[i] : -1;
        if (itemId != -1)
        {
            const int itemColor = toInt(mItemColors[i], int);
            const std::string itemData = mItemData[i];
            serverConfig.setValue(name + toString(i), itemId);
            serverConfig.setValue(color + toString(i), itemColor);
            serverConfig.setValue(data + toString(i), itemData);
        }
        else
        {
            serverConfig.deleteKey(name + toString(i));
            serverConfig.deleteKey(color + toString(i));
            serverConfig.deleteKey(data + toString(i));
        }
    }
}

References CAST_S32, CAST_U32, data, ConfigurationObject::deleteKey(), mItemColors, mItemData, mItems, mNumber, serverConfig, Configuration::setValue(), SHORTCUT_AUTO_TAB, SHORTCUT_ITEMS, toInt, and Catch::toString().

Referenced by removeItem(), setItem(), setItems(), and swap().

setItem() [1/2]

void ItemShortcut::setItem

(

const size_t

index

)

Adds the selected item ID to the items specified by the index.

Parameters

index

Index of the items.

Definition at line 236 of file itemshortcut.cpp.

{
    mItems[index] = mItemSelected;
    mItemColors[index] = mItemColorSelected;
    save();
}

References mItemColors, mItemColorSelected, mItems, mItemSelected, and save().

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

setItem() [2/2]

void ItemShortcut::setItem	(	const size_t	index,
		const int	item,
		const ItemColor	color
	)

Definition at line 243 of file itemshortcut.cpp.

{
    mItems[index] = item;
    mItemColors[index] = color;
    save();
}

References mItemColors, mItems, and save().

setItemData()

void ItemShortcut::setItemData ( const size_t  index, const std::string &  data  )

inline

Definition at line 76 of file itemshortcut.h.

        { mItemData[index] = data; }

References data, and mItemData.

Referenced by ItemShortcutContainer::mouseReleased(), and SkillDialog::update().

setItemFast()

void ItemShortcut::setItemFast	(	const size_t	index,
		const int	item,
		const ItemColor	color
	)

Definition at line 252 of file itemshortcut.cpp.

{
    mItems[index] = item;
    mItemColors[index] = color;
}

References mItemColors, and mItems.

Referenced by SkillDialog::update().

setItems()

void ItemShortcut::setItems ( const size_t  index, const int  itemId, const ItemColor  color  )

inline

Adds an item to the items store specified by the index.

Parameters

index	Index of the item.
itemId	ID of the item.

Definition at line 116 of file itemshortcut.h.

        { mItems[index] = itemId; mItemColors[index] = color; save(); }

References mItemColors, mItems, and save().

setItemSelected() [1/2]

void ItemShortcut::setItemSelected ( const int  itemId )

inline

Set the item that is selected.

Parameters

itemId

The ID of the item that is to be assigned.

Definition at line 126 of file itemshortcut.h.

        { mItemSelected = itemId; }

References mItemSelected.

Referenced by SkillDialog::action(), ItemContainer::mousePressed(), ItemShortcutContainer::mousePressed(), ItemShortcutContainer::mouseReleased(), and SpellShortcutContainer::mouseReleased().

setItemSelected() [2/2]

void ItemShortcut::setItemSelected

(

const Item *const

item

)

Definition at line 222 of file itemshortcut.cpp.

{
    if (item != nullptr)
    {
        mItemSelected = item->getId();
        mItemColorSelected = item->getColor();
    }
    else
    {
        mItemSelected = -1;
        mItemColorSelected = ItemColor_one;
    }
}

References Item::getColor(), Item::getId(), ItemColor_one, mItemColorSelected, and mItemSelected.

swap()

void ItemShortcut::swap	(	const size_t	index1,
		const size_t	index2
	)

Definition at line 260 of file itemshortcut.cpp.

{
    if (CAST_U32(index1) >= SHORTCUT_ITEMS ||
        CAST_U32(index2) >= SHORTCUT_ITEMS)
    {
        return;
    }
 
    const int tmpItem = mItems[index1];
    mItems[index1] = mItems[index2];
    mItems[index2] = tmpItem;
    const ItemColor tmpColor = mItemColors[index1];
    mItemColors[index1] = mItemColors[index2];
    mItemColors[index2] = tmpColor;
 
    const std::string tmpData = mItemData[index1];
    mItemData[index1] = mItemData[index2];
    mItemData[index2] = tmpData;
    save();
}

References CAST_U32, mItemColors, mItemData, mItems, save(), and SHORTCUT_ITEMS.

Referenced by ItemShortcutContainer::mouseReleased().

unequipItem()

void ItemShortcut::unequipItem

(

const size_t

index

)

const

UnEquip a item from the shortcut.

Definition at line 201 of file itemshortcut.cpp.

{
    const Inventory *const inv = PlayerInfo::getInventory();
    if (inv == nullptr)
        return;
 
    const int itemId = mItems[index];
    if (itemId != 0)
    {
        const Item *const item = inv->findItem(itemId, mItemColors[index]);
        if ((item != nullptr) && (item->getQuantity() != 0))
        {
            if (item->isEquipment() == Equipm_true)
            {
                if (item->isEquipped() == Equipped_true)
                    PlayerInfo::unequipItem(item, Sfx_true);
            }
        }
    }
}

References Equipm_true, Equipped_true, Inventory::findItem(), PlayerInfo::getInventory(), Item::getQuantity(), Item::isEquipment(), Item::isEquipped(), mItemColors, mItems, Sfx_true, and PlayerInfo::unequipItem().

useItem()

void ItemShortcut::useItem

(

const size_t

index

)

const

Try to use the item specified by the index.

Parameters

index

Index of the item shortcut.

Definition at line 151 of file itemshortcut.cpp.

{
    const Inventory *const inv = PlayerInfo::getInventory();
    if (inv == nullptr)
        return;
 
    const int itemId = mItems[index];
    const ItemColor itemColor = mItemColors[index];
    if (itemId >= 0)
    {
        if (itemId < SPELL_MIN_ID)
        {
            const Item *const item = inv->findItem(itemId, itemColor);
            if (item != nullptr && item->getQuantity() != 0)
                PlayerInfo::useEquipItem(item, 0, Sfx_true);
        }
        else if (itemId < SKILL_MIN_ID && (spellManager != nullptr))
        {
            spellManager->useItem(itemId);
        }
        else if (skillDialog != nullptr)
        {
            skillDialog->useItem(itemId,
                fromBool(config.getBoolValue("skillAutotarget"), AutoTarget),
                toInt(itemColor, int),
                mItemData[index]);
        }
    }
}

References config, Inventory::findItem(), fromBool, Configuration::getBoolValue(), PlayerInfo::getInventory(), Item::getQuantity(), mItemColors, mItemData, mItems, Sfx_true, SKILL_MIN_ID, skillDialog, SPELL_MIN_ID, spellManager, toInt, PlayerInfo::useEquipItem(), SpellManager::useItem(), and SkillDialog::useItem().

Referenced by ItemShortcutContainer::mouseReleased().

Field Documentation

mItemColors

ItemColor ItemShortcut::mItemColors[SHORTCUT_ITEMS]

private

The item colors.

Definition at line 175 of file itemshortcut.h.

Referenced by clear(), equipItem(), getItemColor(), load(), save(), setItem(), setItemFast(), setItems(), swap(), unequipItem(), and useItem().

mItemColorSelected

ItemColor ItemShortcut::mItemColorSelected

private

Definition at line 179 of file itemshortcut.h.

Referenced by setItem(), and setItemSelected().

mItemData

std::string ItemShortcut::mItemData[SHORTCUT_ITEMS]

private

Definition at line 176 of file itemshortcut.h.

Referenced by clear(), getItemData(), load(), save(), setItemData(), swap(), and useItem().

mItems

int ItemShortcut::mItems[SHORTCUT_ITEMS]

private

The items.

Definition at line 174 of file itemshortcut.h.

Referenced by clear(), equipItem(), getFreeIndex(), getItem(), load(), removeItem(), save(), setItem(), setItemFast(), setItems(), swap(), unequipItem(), and useItem().

mItemSelected

int ItemShortcut::mItemSelected

private

Definition at line 178 of file itemshortcut.h.

Referenced by getItemSelected(), getSelectedItem(), isItemSelected(), setItem(), and setItemSelected().

mNumber

size_t ItemShortcut::mNumber

private

Definition at line 177 of file itemshortcut.h.

Referenced by load(), and save().

---

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

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