NPCDB Namespace Reference

Functions
void	load ()
void	unload ()
BeingInfo *	get (const BeingTypeId id)
BeingTypeId	getAvatarFor (const BeingTypeId id)
void	loadXmlFile (const std::string &fileName, const SkipError skipError)

Detailed Description

NPC information database.

Function Documentation

get()

BeingInfo * NPCDB::get

(

const BeingTypeId

id

)

Definition at line 188 of file npcdb.cpp.

{
    const BeingInfoIterator i = mNPCInfos.find(id);
 
    if (i == mNPCInfos.end())
    {
        reportAlways("NPCDB: Warning, unknown NPC ID %d requested",
            toInt(id, int))
        return BeingInfo::unknown;
    }
    return i->second;
}

References anonymous_namespace{npcdb.cpp}::mNPCInfos, reportAlways, toInt, and BeingInfo::unknown.

Referenced by PopupMenu::addBeingMenu(), EAthena::CashShopRecv::processCashShopOpen(), EAthena::MarketRecv::processMarketOpen(), EAthena::BuySellRecv::processNpcBuy(), and Being::setSubtype().

getAvatarFor()

BeingTypeId NPCDB::getAvatarFor

(

const BeingTypeId

id

)

Definition at line 201 of file npcdb.cpp.

{
    const BeingInfo *const info = get(id);
    if (info == nullptr)
        return BeingTypeId_zero;
    return info->getAvatarId();
}

References BeingTypeId_zero, AttributesEnum::get(), and Actions::info().

Referenced by NpcDialog::postInit().

load()

void NPCDB::load

(

)

Definition at line 48 of file npcdb.cpp.

{
    if (mLoaded)
        unload();
 
    logger->log1("Initializing NPC database...");
 
    loadXmlFile(paths.getStringValue("npcsFile"), SkipError_false);
    loadXmlFile(paths.getStringValue("npcsPatchFile"), SkipError_true);
    loadXmlDir("npcsPatchDir", loadXmlFile)
 
    mLoaded = true;
}

References Configuration::getStringValue(), loadXmlDir, loadXmlFile(), Logger::log1(), logger, anonymous_namespace{npcdb.cpp}::mLoaded, paths, SkipError_false, SkipError_true, and Net::unload().

Referenced by DbManager::loadDb().

loadXmlFile()

void NPCDB::loadXmlFile	(	const std::string &	fileName,
		const SkipError	skipError
	)

Definition at line 62 of file npcdb.cpp.

{
    XML::Document doc(fileName, UseVirtFs_true, skipError);
    XmlNodeConstPtrConst rootNode = doc.rootNode();
 
    if ((rootNode == nullptr) || !xmlNameEqual(rootNode, "npcs"))
    {
        logger->log("NPC Database: Error while loading %s!",
            paths.getStringValue("npcsFile").c_str());
        mLoaded = true;
        return;
    }
 
    // iterate <npc>s
    for_each_xml_child_node(npcNode, rootNode)
    {
        if (xmlNameEqual(npcNode, "include"))
        {
            const std::string name = XML::getProperty(npcNode, "name", "");
            if (!name.empty())
                loadXmlFile(name, skipError);
            continue;
        }
 
        if (!xmlNameEqual(npcNode, "npc"))
            continue;
 
        const BeingTypeId id = fromInt(XML::getProperty(
            npcNode, "id", 0), BeingTypeId);
        BeingInfo *currentInfo = nullptr;
        if (id == BeingTypeId_zero)
        {
            reportAlways("NPC Database: NPC with missing ID in %s!",
                paths.getStringValue("npcsFile").c_str())
            continue;
        }
        else if (mNPCInfos.find(id) != mNPCInfos.end())
        {
            logger->log("NpcDB: Redefinition of npc ID %d", toInt(id, int));
            currentInfo = mNPCInfos[id];
        }
        if (currentInfo == nullptr)
            currentInfo = new BeingInfo;
 
        currentInfo->setTargetSelection(XML::getBoolProperty(npcNode,
            "targetSelection", true));
 
        BeingCommon::readBasicAttributes(currentInfo, npcNode, "talk");
        BeingCommon::readWalkingAttributes(currentInfo, npcNode, 0);
 
        currentInfo->setDeadSortOffsetY(XML::getProperty(npcNode,
            "deadSortOffsetY", 31));
 
        currentInfo->setAvatarId(fromInt(XML::getProperty(
            npcNode, "avatar", 0), BeingTypeId));
 
        currentInfo->setAllowDelete(XML::getBoolProperty(npcNode,
            "allowDelete", true));
 
        currentInfo->setAllowEquipment(XML::getBoolProperty(npcNode,
            "allowEquipment", false));
 
        const std::string currency = XML::getProperty(npcNode,
            "currency", "default");
        if (UnitsDb::existsCurrency(currency) == false)
        {
            reportAlways("Not found currency '%s' for npc %d",
                currency.c_str(),
                CAST_S32(id))
        }
        currentInfo->setCurrency(currency);
 
        SpriteDisplay display;
        for_each_xml_child_node(spriteNode, npcNode)
        {
            if (xmlNameEqual(spriteNode, "sprite"))
            {
                if (!XmlHaveChildContent(spriteNode))
                    continue;
 
                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"))
            {
                if (!XmlHaveChildContent(spriteNode))
                    continue;
 
                display.particles.push_back(XmlChildContent(spriteNode));
            }
            else if (xmlNameEqual(spriteNode, "menu"))
            {
                std::string name = XML::langProperty(spriteNode, "name", "");
                std::string command = XML::getProperty(spriteNode,
                    "command", "");
                currentInfo->addMenu(name, command);
            }
        }
 
        currentInfo->setDisplay(display);
        if (currentInfo->getMenu().empty())
        {
            // TRANSLATORS: npc context menu item
            currentInfo->addMenu(_("Talk"), "talk 'NAME'");
            // TRANSLATORS: npc context menu item
            currentInfo->addMenu(_("Buy"), "buy 'NAME'");
            // TRANSLATORS: npc context menu item
            currentInfo->addMenu(_("Sell"), "sell 'NAME'");
        }
        mNPCInfos[id] = currentInfo;
    }
}

References _, BeingInfo::addMenu(), BeingTypeId_zero, CAST_S32, UnitsDb::existsCurrency(), fileName, for_each_xml_child_node, fromInt, XML::getBoolProperty(), BeingInfo::getMenu(), XML::getProperty(), Configuration::getStringValue(), XML::langProperty(), loadXmlFile(), Logger::log(), logger, anonymous_namespace{npcdb.cpp}::mLoaded, anonymous_namespace{npcdb.cpp}::mNPCInfos, SpriteDisplay::particles, paths, BeingCommon::readBasicAttributes(), BeingCommon::readWalkingAttributes(), reportAlways, XML::Document::rootNode(), BeingInfo::setAllowDelete(), BeingInfo::setAllowEquipment(), BeingInfo::setAvatarId(), BeingInfo::setCurrency(), BeingInfo::setDeadSortOffsetY(), BeingInfo::setDisplay(), BeingInfo::setTargetSelection(), SpriteReference::sprite, SpriteDisplay::sprites, toInt, UseVirtFs_true, and SpriteReference::variant.

unload()

void NPCDB::unload

(

)

Definition at line 179 of file npcdb.cpp.

{
    logger->log1("Unloading NPC database...");
    delete_all(mNPCInfos);
    mNPCInfos.clear();
 
    mLoaded = false;
}

References delete_all(), Logger::log1(), logger, anonymous_namespace{npcdb.cpp}::mLoaded, and anonymous_namespace{npcdb.cpp}::mNPCInfos.

Referenced by DbManager::unloadDb().