itemdb.cpp File Reference

(986a3bf)

#include "resources/db/itemdb.h"
#include "const/resources/map/map.h"
#include "configuration.h"
#include "enums/resources/spritedirection.h"
#include "fs/virtfs/tools.h"
#include "resources/iteminfo.h"
#include "resources/itemmenuitem.h"
#include "resources/itemtypemapdata.h"
#include "resources/db/itemfielddb.h"
#include "resources/sprite/spritereference.h"
#include "net/net.h"
#include "utils/checkutils.h"
#include "utils/delete2.h"
#include "utils/dtor.h"
#include "utils/foreach.h"
#include "utils/itemxmlutils.h"
#include "utils/stdmove.h"
#include "utils/stringmap.h"
#include "debug.h"

Go to the source code of this file.

Namespaces
	anonymous_namespace{itemdb.cpp}

Macros
#define	CHECK_PARAM(param)

Functions
static void	loadSpriteRef (ItemInfo *const itemInfo, const xmlNodePtr node)
static void	loadSoundRef (ItemInfo *const itemInfo, const xmlNodePtr node)
static void	loadFloorSprite (SpriteDisplay &display, const xmlNode *const node)
static void	loadReplaceSprite (ItemInfo *const itemInfo, const xmlNodePtr replaceNode)
static void	loadOrderSprite (ItemInfo *const itemInfo, const xmlNodePtr node, const bool drawAfter)
static int	parseSpriteName (const std::string &name)
static int	parseDirectionName (const std::string &name)
static ItemDbTypeT	itemTypeFromString (const std::string &name)
static std::string	useButtonFromItemType (const ItemDbTypeT &type)
static std::string	useButton2FromItemType (const ItemDbTypeT &type)
static void	initStatic ()
static void	loadMenu (xmlNode *const parentNode, std::vector< ItemMenuItem > &menu)
static bool	getIsEquipment (const ItemDbTypeT type)

Variables
ItemDB::ItemInfos	anonymous_namespace{itemdb.cpp}::mItemInfos
ItemDB::NamedItemInfos	anonymous_namespace{itemdb.cpp}::mNamedItemInfos
ItemInfo *	anonymous_namespace{itemdb.cpp}::mUnknown = 0
bool	anonymous_namespace{itemdb.cpp}::mLoaded = false
bool	anonymous_namespace{itemdb.cpp}::mConstructed = false
StringVect	anonymous_namespace{itemdb.cpp}::mTagNames
StringIntMap	anonymous_namespace{itemdb.cpp}::mTags
std::map< std::string, ItemSoundEvent::Type >	anonymous_namespace{itemdb.cpp}::mSoundNames
int	anonymous_namespace{itemdb.cpp}::mNumberOfHairstyles = 1

Macro Definition Documentation

CHECK_PARAM

#define CHECK_PARAM

(

param

)

Value:

        if (param.empty()) \
        { \
            logger->log("ItemDB: Missing " #param " attribute for item %i!", \
                id); \
        }

Function Documentation

getIsEquipment()

static bool getIsEquipment ( const ItemDbTypeT  type )

static

Definition at line 235 of file itemdb.cpp.

{
    switch (type)
    {
        case ItemDbType::EQUIPMENT_ONE_HAND_WEAPON:
        case ItemDbType::EQUIPMENT_TWO_HANDS_WEAPON:
        case ItemDbType::EQUIPMENT_TORSO:
        case ItemDbType::EQUIPMENT_ARMS:
        case ItemDbType::EQUIPMENT_HEAD:
        case ItemDbType::EQUIPMENT_LEGS:
        case ItemDbType::EQUIPMENT_SHIELD:
        case ItemDbType::EQUIPMENT_RING:
        case ItemDbType::EQUIPMENT_NECKLACE:
        case ItemDbType::EQUIPMENT_FEET:
        case ItemDbType::EQUIPMENT_AMMO:
        case ItemDbType::EQUIPMENT_CHARM:
            return true;
        case ItemDbType::UNUSABLE:
        case ItemDbType::USABLE:
        case ItemDbType::CARD:
        case ItemDbType::SPRITE_RACE:
        case ItemDbType::SPRITE_HAIR:
        default:
            return false;
    }
}

References ItemDbType::CARD, ItemDbType::EQUIPMENT_AMMO, ItemDbType::EQUIPMENT_ARMS, ItemDbType::EQUIPMENT_CHARM, ItemDbType::EQUIPMENT_FEET, ItemDbType::EQUIPMENT_HEAD, ItemDbType::EQUIPMENT_LEGS, ItemDbType::EQUIPMENT_NECKLACE, ItemDbType::EQUIPMENT_ONE_HAND_WEAPON, ItemDbType::EQUIPMENT_RING, ItemDbType::EQUIPMENT_SHIELD, ItemDbType::EQUIPMENT_TORSO, ItemDbType::EQUIPMENT_TWO_HANDS_WEAPON, ItemDbType::SPRITE_HAIR, ItemDbType::SPRITE_RACE, ItemDbType::UNUSABLE, and ItemDbType::USABLE.

Referenced by ItemDB::loadXmlFile().

initStatic()

static void initStatic ( )

static

Definition at line 131 of file itemdb.cpp.

{
    mConstructed = true;
    mSoundNames["hit"] = ItemSoundEvent::HIT;
    mSoundNames["strike"] = ItemSoundEvent::MISS;
    mSoundNames["miss"] = ItemSoundEvent::MISS;
    mSoundNames["use"] = ItemSoundEvent::USE;
    mSoundNames["equip"] = ItemSoundEvent::EQUIP;
    mSoundNames["unequip"] = ItemSoundEvent::UNEQUIP;
    mSoundNames["drop"] = ItemSoundEvent::DROP;
    mSoundNames["pickup"] = ItemSoundEvent::PICKUP;
    mSoundNames["take"] = ItemSoundEvent::TAKE;
    mSoundNames["put"] = ItemSoundEvent::PUT;
    mSoundNames["usecard"] = ItemSoundEvent::USECARD;
}

References ItemSoundEvent::DROP, ItemSoundEvent::EQUIP, ItemSoundEvent::HIT, anonymous_namespace{itemdb.cpp}::mConstructed, ItemSoundEvent::MISS, anonymous_namespace{itemdb.cpp}::mSoundNames, ItemSoundEvent::PICKUP, ItemSoundEvent::PUT, ItemSoundEvent::TAKE, ItemSoundEvent::UNEQUIP, ItemSoundEvent::USE, and ItemSoundEvent::USECARD.

Referenced by ItemDB::load().

itemTypeFromString()

static ItemDbTypeT itemTypeFromString ( const std::string &  name )

static

Definition at line 84 of file itemdb.cpp.

{
    const size_t sz = sizeof(itemTypeMap) / sizeof(itemTypeMap[0]);
    for (size_t f = 0; f < sz; f ++)
    {
        const ItemTypeMap &type = itemTypeMap[f];
        if (type.name == name)
            return type.type;
    }
    logger->log("Unknown item type: " + name);
    return ItemDbType::UNUSABLE;
}

References itemTypeMap, Logger::log(), logger, ItemTypeMap::name, ItemTypeMap::type, and ItemDbType::UNUSABLE.

Referenced by ItemDB::loadXmlFile().

loadFloorSprite()

static void loadFloorSprite ( SpriteDisplay &  display, const xmlNode *const  node  )

static

Definition at line 1003 of file itemdb.cpp.

{
    if (floorNode == nullptr)
        return;
    for_each_xml_child_node(spriteNode, floorNode)
    {
        if (!XmlHaveChildContent(spriteNode))
            continue;
        if (xmlNameEqual(spriteNode, "sprite"))
        {
            SpriteReference *const currentSprite = new SpriteReference;
            currentSprite->sprite = XmlChildContent(spriteNode);
            currentSprite->variant
                = XML::getProperty(spriteNode, "variant", 0);
            display.sprites.push_back(currentSprite);
        }
        else if (xmlNameEqual(spriteNode, "particlefx"))
        {
            display.particles.push_back(XmlChildContent(spriteNode));
        }
    }
}

References for_each_xml_child_node, XML::getProperty(), SpriteDisplay::particles, SpriteReference::sprite, SpriteDisplay::sprites, and SpriteReference::variant.

Referenced by ItemDB::loadXmlFile().

loadMenu()

static void loadMenu ( xmlNode *const  parentNode, std::vector< ItemMenuItem > &  menu  )

static

Definition at line 212 of file itemdb.cpp.

{
    for_each_xml_child_node(node, parentNode)
    {
        if (xmlNameEqual(node, "menu"))
        {
            const std::string name1 = XML::langProperty(node,
                "name1", "");
            const std::string name2 = XML::langProperty(node,
                "name2", "");
            const std::string command1 = XML::getProperty(node,
                "command1", "");
            const std::string command2 = XML::getProperty(node,
                "command2", command1);
            menu.push_back(ItemMenuItem(name1,
                name2,
                command1,
                command2));
        }
    }
}

References for_each_xml_child_node, XML::getProperty(), XML::langProperty(), and EAthena::menu.

Referenced by ItemDB::loadXmlFile().

loadOrderSprite()

static void loadOrderSprite ( ItemInfo *const  itemInfo, const xmlNodePtr  node, const bool  drawAfter  )

static

Definition at line 1160 of file itemdb.cpp.

{
    const int sprite = parseSpriteName(XML::getProperty(node, "name", ""));
    const int priority = XML::getProperty(node, "priority", 0);
 
    const int direction = parseDirectionName(XML::getProperty(
        node, "direction", "all"));
    if (drawAfter)
        itemInfo->setDrawAfter(direction, sprite);
    else
        itemInfo->setDrawBefore(direction, sprite);
    itemInfo->setDrawPriority(direction, priority);
}

References XML::getProperty(), Actions::itemInfo(), parseDirectionName(), and parseSpriteName().

Referenced by ItemDB::loadXmlFile().

loadReplaceSprite()

static void loadReplaceSprite ( ItemInfo *const  itemInfo, const xmlNodePtr  replaceNode  )

static

Definition at line 1027 of file itemdb.cpp.

{
    if (replaceNode == nullptr)
        return;
    const std::string removeSprite = XML::getProperty(
        replaceNode, "sprite", "");
    const int direction = parseDirectionName(XML::getProperty(
        replaceNode, "direction", "all"));
 
    itemInfo->setRemoveSprites();
 
    switch (direction)
    {
        case -1:
        {
            if (removeSprite.empty())
            {  // remove all sprites
                for (int f = 0; f < 10; f ++)
                {
                    for (int sprite = 0; sprite < 13; sprite ++)
                        itemInfo->addReplaceSprite(sprite, f);
                }
            }
            else
            {  // replace only given sprites
                for (int f = 0; f < 10; f ++)
                {
                    IntMap *const mapList = itemInfo->addReplaceSprite(
                        parseSpriteName(removeSprite), f);
                    if (mapList == nullptr)
                        continue;
                    for_each_xml_child_node(itemNode, replaceNode)
                    {
                        if (xmlNameEqual(itemNode, "item"))
                        {
                            const int from = XML::getProperty(
                                itemNode, "from", 0);
                            const int to = XML::getProperty(
                                itemNode, "to", 1);
                            (*mapList)[from] = to;
                        }
                    }
                }
            }
            break;
        }
        case -2:
        {
            itemInfo->addReplaceSprite(parseSpriteName(
                removeSprite), SpriteDirection::DOWN);
            itemInfo->addReplaceSprite(parseSpriteName(
                removeSprite), SpriteDirection::DOWNLEFT);
            itemInfo->addReplaceSprite(parseSpriteName(
                removeSprite), SpriteDirection::DOWNRIGHT);
 
            for_each_xml_child_node(itemNode, replaceNode)
            {
                if (xmlNameEqual(itemNode, "item"))
                {
                    const int from = XML::getProperty(itemNode, "from", 0);
                    const int to = XML::getProperty(itemNode, "to", 1);
                    IntMap *mapList = itemInfo->addReplaceSprite(
                        parseSpriteName(removeSprite), SpriteDirection::DOWN);
                    if (mapList != nullptr)
                        (*mapList)[from] = to;
 
                    mapList = itemInfo->addReplaceSprite(parseSpriteName(
                        removeSprite), SpriteDirection::DOWNLEFT);
                    if (mapList != nullptr)
                        (*mapList)[from] = to;
 
                    mapList = itemInfo->addReplaceSprite(parseSpriteName(
                        removeSprite), SpriteDirection::DOWNRIGHT);
                    if (mapList != nullptr)
                        (*mapList)[from] = to;
                }
            }
            break;
        }
        case -3:
        {
            itemInfo->addReplaceSprite(parseSpriteName(
                removeSprite), SpriteDirection::UP);
            itemInfo->addReplaceSprite(parseSpriteName(
                removeSprite), SpriteDirection::UPLEFT);
            itemInfo->addReplaceSprite(parseSpriteName(
                removeSprite), SpriteDirection::UPRIGHT);
 
            for_each_xml_child_node(itemNode, replaceNode)
            {
                if (xmlNameEqual(itemNode, "item"))
                {
                    const int from = XML::getProperty(itemNode, "from", 0);
                    const int to = XML::getProperty(itemNode, "to", 1);
                    IntMap *mapList = itemInfo->addReplaceSprite(
                        parseSpriteName(removeSprite), SpriteDirection::UP);
                    if (mapList != nullptr)
                        (*mapList)[from] = to;
 
                    mapList = itemInfo->addReplaceSprite(parseSpriteName(
                        removeSprite), SpriteDirection::UPLEFT);
                    if (mapList != nullptr)
                        (*mapList)[from] = to;
 
                    mapList = itemInfo->addReplaceSprite(parseSpriteName(
                        removeSprite), SpriteDirection::UPRIGHT);
                    if (mapList != nullptr)
                        (*mapList)[from] = to;
                }
            }
            break;
        }
        default:
        {
            IntMap *const mapList = itemInfo->addReplaceSprite(
                parseSpriteName(removeSprite), direction);
            if (mapList == nullptr)
                return;
            for_each_xml_child_node(itemNode, replaceNode)
            {
                if (xmlNameEqual(itemNode, "item"))
                {
                    const int from = XML::getProperty(itemNode, "from", 0);
                    const int to = XML::getProperty(itemNode, "to", 1);
                    (*mapList)[from] = to;
                }
            }
            break;
        }
    }
}

References SpriteDirection::DOWN, SpriteDirection::DOWNLEFT, SpriteDirection::DOWNRIGHT, for_each_xml_child_node, XML::getProperty(), Actions::itemInfo(), parseDirectionName(), parseSpriteName(), SpriteDirection::UP, SpriteDirection::UPLEFT, and SpriteDirection::UPRIGHT.

Referenced by ItemDB::loadXmlFile().

loadSoundRef()

static void loadSoundRef ( ItemInfo *const  itemInfo, const xmlNodePtr  node  )

static

Definition at line 980 of file itemdb.cpp.

{
    if (node == nullptr ||
        !XmlHaveChildContent(node))
    {
        return;
    }
    const std::string event = XML::getProperty(node, "event", "");
    const std::map<std::string, ItemSoundEvent::Type>::const_iterator
        it = mSoundNames.find(event);
    if (it != mSoundNames.end())
    {
        const int delay = XML::getProperty(node, "delay", 0);
        const std::string filename = XmlChildContent(node);
        itemInfo->addSound((*it).second, filename, delay);
    }
    else
    {
        reportAlways("ItemDB: Ignoring unknown sound event '%s'",
            event.c_str())
    }
}

References XML::getProperty(), Actions::itemInfo(), anonymous_namespace{itemdb.cpp}::mSoundNames, and reportAlways.

Referenced by ItemDB::loadXmlFile().

loadSpriteRef()

static void loadSpriteRef ( ItemInfo *const  itemInfo, const xmlNodePtr  node  )

static

Definition at line 965 of file itemdb.cpp.

{
    const std::string gender = XML::getProperty(node, "gender", "unisex");
    if ((node == nullptr) || !XmlHaveChildContent(node))
        return;
 
    const std::string filename = XmlChildContent(node);
 
    const int race = XML::getProperty(node, "race", 0);
    if (gender == "male" || gender == "unisex")
        itemInfo->setSprite(filename, Gender::MALE, race);
    if (gender == "female" || gender == "unisex")
        itemInfo->setSprite(filename, Gender::FEMALE, race);
}

References Gender::FEMALE, XML::getProperty(), Actions::itemInfo(), and Gender::MALE.

Referenced by ItemDB::loadXmlFile().

parseDirectionName()

static int parseDirectionName ( const std::string &  name )

static

Definition at line 903 of file itemdb.cpp.

{
    int id = -1;
    if (name == "down")
    {
#ifdef TMWA_SUPPORT
        if (Net::getNetworkType() == ServerType::TMWATHENA)
            id = -2;
        else
#endif
            id = SpriteDirection::DOWN;
    }
    else if (name == "downleft" || name == "leftdown")
    {
        id = SpriteDirection::DOWNLEFT;
    }
    else if (name == "left")
    {
        id = SpriteDirection::LEFT;
    }
    else if (name == "upleft" || name == "leftup")
    {
        id = SpriteDirection::UPLEFT;
    }
    else if (name == "up")
    {
#ifdef TMWA_SUPPORT
        if (Net::getNetworkType() == ServerType::TMWATHENA)
            id = -3;
        else
#endif
            id = SpriteDirection::UP;
    }
    else if (name == "upright" || name == "rightup")
    {
        id = SpriteDirection::UPRIGHT;
    }
    else if (name == "right")
    {
        id = SpriteDirection::RIGHT;
    }
    else if (name == "downright" || name == "rightdown")
    {
        id = SpriteDirection::DOWNRIGHT;
    }
    else if (name == "downall")
    {
        id = -2;
    }
    else if (name == "upall")
    {
        id = -3;
    }
    // hack for died action.
    else if (name == "died")
    {
        id = 9;
    }
 
    return id;
}

References SpriteDirection::DOWN, SpriteDirection::DOWNLEFT, SpriteDirection::DOWNRIGHT, Net::getNetworkType(), SpriteDirection::LEFT, SpriteDirection::RIGHT, ServerType::TMWATHENA, SpriteDirection::UP, SpriteDirection::UPLEFT, and SpriteDirection::UPRIGHT.

Referenced by loadOrderSprite(), and loadReplaceSprite().

parseSpriteName()

static int parseSpriteName ( const std::string &  name )

static

Definition at line 839 of file itemdb.cpp.

{
    int id = -1;
    if (name == "race" || name == "type")
    {
        id = 0;
    }
    else if (name == "shoes" || name == "boot" || name == "boots")
    {
        id = 1;
    }
    else if (name == "bottomclothes" || name == "bottom" || name == "pants")
    {
        id = 2;
    }
    else if (name == "topclothes" || name == "top"
             || name == "torso" || name == "body")
    {
        id = 3;
    }
    else if (name == "misc1")
    {
        id = 4;
    }
    else if (name == "misc2" || name == "scarf" || name == "scarfs")
    {
        id = 5;
    }
    else if (name == "hair")
    {
        id = 6;
    }
    else if (name == "hat" || name == "hats")
    {
        id = 7;
    }
    else if (name == "wings")
    {
        id = 8;
    }
    else if (name == "glove" || name == "gloves")
    {
        id = 9;
    }
    else if (name == "weapon" || name == "weapons")
    {
        id = 10;
    }
    else if (name == "shield" || name == "shields")
    {
        id = 11;
    }
    else if (name == "amulet" || name == "amulets")
    {
        id = 12;
    }
    else if (name == "ring" || name == "rings")
    {
        id = 13;
    }
 
    return id;
}

Referenced by loadOrderSprite(), loadReplaceSprite(), and ItemDB::loadXmlFile().

useButton2FromItemType()

static std::string useButton2FromItemType ( const ItemDbTypeT &  type )

static

Definition at line 114 of file itemdb.cpp.

{
    const size_t sz = sizeof(itemTypeMap) / sizeof(itemTypeMap[0]);
    for (size_t f = 0; f < sz; f ++)
    {
        const ItemTypeMap &item = itemTypeMap[f];
        if (item.type == type)
        {
            if (item.useButton2.empty())
                return std::string();
            return gettext(item.useButton2.c_str());
        }
    }
    logger->log("Unknown item type");
    return std::string();
}

References itemTypeMap, Logger::log(), logger, ItemTypeMap::type, and ItemTypeMap::useButton2.

Referenced by ItemDB::loadXmlFile().

useButtonFromItemType()

static std::string useButtonFromItemType ( const ItemDbTypeT &  type )

static

Definition at line 97 of file itemdb.cpp.

{
    const size_t sz = sizeof(itemTypeMap) / sizeof(itemTypeMap[0]);
    for (size_t f = 0; f < sz; f ++)
    {
        const ItemTypeMap &item = itemTypeMap[f];
        if (item.type == type)
        {
            if (item.useButton.empty())
                return std::string();
            return gettext(item.useButton.c_str());
        }
    }
    logger->log("Unknown item type");
    return std::string();
}

References itemTypeMap, Logger::log(), logger, ItemTypeMap::type, and ItemTypeMap::useButton.

Referenced by ItemDB::loadXmlFile().