EmoteDB Namespace Reference

Typedefs
typedef EmoteInfos::iterator	EmoteInfosIterator

Functions
void	load ()
void	loadXmlFile (const std::string &fileName, const SkipError skipError)
void	loadSpecialXmlFile (const std::string &fileName, const SkipError skipError)
void	unload ()
const EmoteInfo *	get (const int id, const bool allowNull)
const EmoteInfo *	get2 (int id, const bool allowNull)
const EmoteSprite *	getSprite (const int id, const bool allowNull)
const int &	getLast () A_CONST
int	getIdByIndex (const int index)
int	size ()

Detailed Description

Emote information database.

Typedef Documentation

EmoteInfosIterator

typedef EmoteInfos::iterator EmoteDB::EmoteInfosIterator

Definition at line 69 of file emotedb.h.

Function Documentation

get()

const EmoteInfo * EmoteDB::get	(	const int	id,
		const bool	allowNull
	)

Definition at line 258 of file emotedb.cpp.

{
    const EmoteInfos::const_iterator i = mEmoteInfos.find(id);
 
    if (i == mEmoteInfos.end())
    {
        if (allowNull)
            return nullptr;
        reportAlways("EmoteDB: Warning, unknown emote ID %d requested",
            id)
        return &mUnknown;
    }
    return i->second;
}

References anonymous_namespace{emotedb.cpp}::mEmoteInfos, anonymous_namespace{emotedb.cpp}::mUnknown, and reportAlways.

get2()

const EmoteInfo * EmoteDB::get2	(	int	id,
		const bool	allowNull
	)

Definition at line 273 of file emotedb.cpp.

{
    const EmoteToEmote::const_iterator it = mEmotesAlt.find(id);
    if (it != mEmotesAlt.end())
        id = (*it).second;
 
    const EmoteInfos::const_iterator i = mEmoteInfos.find(id);
 
    if (i == mEmoteInfos.end())
    {
        if (allowNull)
            return nullptr;
        reportAlways("EmoteDB: Warning, unknown emote ID %d requested",
            id)
        return &mUnknown;
    }
    return i->second;
}

References anonymous_namespace{emotedb.cpp}::mEmoteInfos, anonymous_namespace{emotedb.cpp}::mEmotesAlt, anonymous_namespace{emotedb.cpp}::mUnknown, and reportAlways.

Referenced by Being::setEmote().

getIdByIndex()

int EmoteDB::getIdByIndex

(

const int

index

)

Definition at line 311 of file emotedb.cpp.

{
    if (index < 0 || index >= static_cast<signed int>(mEmoteInfos.size()))
        return 0;
    EmoteInfos::const_iterator it = mEmoteInfos.begin();
    for (int f = 0; f < index; f ++)
        ++ it;
    return (*it).first;
}

References anonymous_namespace{emotedb.cpp}::mEmoteInfos.

getLast()

const int & EmoteDB::getLast

(

)

Definition at line 301 of file emotedb.cpp.

{
    return mLastEmote;
}

References anonymous_namespace{emotedb.cpp}::mLastEmote.

Referenced by EmoteShortcutContainer::EmoteShortcutContainer(), EmoteShortcut::load(), and Being::setEmote().

getSprite()

const EmoteSprite * EmoteDB::getSprite	(	const int	id,
		const bool	allowNull
	)

Definition at line 292 of file emotedb.cpp.

{
    const EmoteInfo *const info = get(id, allowNull);
    if (info == nullptr)
        return nullptr;
 
    return info->sprites.front();
}

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

Referenced by EmoteShortcutContainer::EmoteShortcutContainer(), EmoteShortcut::load(), and ItemDB::load().

load()

void EmoteDB::load

(

)

Definition at line 48 of file emotedb.cpp.

{
    if (mLoaded)
        unload();
 
    logger->log1("Initializing emote database...");
 
    EmoteSprite *const unknownSprite = new EmoteSprite;
    unknownSprite->sprite = AnimatedSprite::load(pathJoin(paths.getStringValue(
        "sprites"), paths.getStringValue(
        "spriteErrorFile")),
        0);
    unknownSprite->name = "unknown";
    unknownSprite->id = 0;
    mUnknown.sprites.push_back(unknownSprite);
 
    mLastEmote = 0;
    loadXmlFile(paths.getStringValue("emotesFile"), SkipError_false);
    loadXmlFile(paths.getStringValue("emotesPatchFile"), SkipError_true);
    loadXmlDir("emotesPatchDir", loadXmlFile)
    loadSpecialXmlFile("graphics/sprites/manaplus_emotes.xml",
        SkipError_false);
 
    mLoaded = true;
}

References Configuration::getStringValue(), EmoteSprite::id, AnimatedSprite::load(), loadSpecialXmlFile(), loadXmlDir, loadXmlFile(), Logger::log1(), logger, anonymous_namespace{emotedb.cpp}::mLastEmote, anonymous_namespace{emotedb.cpp}::mLoaded, anonymous_namespace{emotedb.cpp}::mUnknown, EmoteSprite::name, pathJoin(), paths, SkipError_false, SkipError_true, EmoteSprite::sprite, EmoteInfo::sprites, and Net::unload().

Referenced by DbManager::loadDb().

loadSpecialXmlFile()

void EmoteDB::loadSpecialXmlFile	(	const std::string &	fileName,
		const SkipError	skipError
	)

Definition at line 151 of file emotedb.cpp.

{
    XML::Document doc(fileName, UseVirtFs_true, skipError);
    XmlNodePtrConst rootNode = doc.rootNode();
 
    if ((rootNode == nullptr) || !xmlNameEqual(rootNode, "emotes"))
    {
        logger->log1("Emote Database: Error while loading"
                     " manaplus_emotes.xml!");
        return;
    }
 
    // iterate <emote>s
    for_each_xml_child_node(emoteNode, rootNode)
    {
        if (xmlNameEqual(emoteNode, "include"))
        {
            const std::string name = XML::getProperty(emoteNode, "name", "");
            if (!name.empty())
                loadSpecialXmlFile(name, skipError);
            continue;
        }
        else if (!xmlNameEqual(emoteNode, "emote"))
        {
            continue;
        }
 
        const int id = XML::getProperty(emoteNode, "id", -1);
        if (id == -1)
        {
            reportAlways("Emote Database: Emote with missing ID in "
                "manaplus_emotes.xml!")
            continue;
        }
        const int altId = XML::getProperty(emoteNode, "altid", -1);
 
        EmoteInfo *currentInfo = nullptr;
        if (mEmoteInfos.find(id) != mEmoteInfos.end())
            currentInfo = mEmoteInfos[id];
        if (currentInfo == nullptr)
            currentInfo = new EmoteInfo;
        currentInfo->time = XML::getProperty(emoteNode, "time", 500);
        currentInfo->effectId = XML::getProperty(emoteNode, "effect", -1);
 
        for_each_xml_child_node(spriteNode, emoteNode)
        {
            if (!XmlHaveChildContent(spriteNode))
                continue;
 
            if (xmlNameEqual(spriteNode, "sprite"))
            {
                EmoteSprite *const currentSprite = new EmoteSprite;
                currentSprite->sprite = AnimatedSprite::load(pathJoin(
                    paths.getStringValue("sprites"),
                    XmlChildContent(spriteNode)),
                    XML::getProperty(spriteNode, "variant", 0));
                currentSprite->name = XML::langProperty(
                    spriteNode, "name", "");
                currentSprite->id = id;
                currentInfo->sprites.push_back(currentSprite);
            }
            else if (xmlNameEqual(spriteNode, "particlefx"))
            {
                currentInfo->particles.push_back(XmlChildContent(spriteNode));
            }
        }
        mEmoteInfos[id] = currentInfo;
        if (altId != -1)
            mEmotesAlt[altId] = id;
 
        if (id > mLastEmote)
            mLastEmote = id;
    }
}

References EmoteInfo::effectId, fileName, for_each_xml_child_node, XML::getProperty(), Configuration::getStringValue(), EmoteSprite::id, XML::langProperty(), AnimatedSprite::load(), Logger::log1(), logger, anonymous_namespace{emotedb.cpp}::mEmoteInfos, anonymous_namespace{emotedb.cpp}::mEmotesAlt, anonymous_namespace{emotedb.cpp}::mLastEmote, EmoteSprite::name, EmoteInfo::particles, pathJoin(), paths, reportAlways, XML::Document::rootNode(), EmoteSprite::sprite, EmoteInfo::sprites, EmoteInfo::time, and UseVirtFs_true.

Referenced by load().

loadXmlFile()

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

Definition at line 74 of file emotedb.cpp.

{
    XML::Document doc(fileName, UseVirtFs_true, skipError);
    XmlNodePtrConst rootNode = doc.rootNode();
 
    if ((rootNode == nullptr) || !xmlNameEqual(rootNode, "emotes"))
    {
        logger->log("Emote Database: Error while loading %s!",
            fileName.c_str());
        return;
    }
 
    // iterate <emote>s
    for_each_xml_child_node(emoteNode, rootNode)
    {
        if (xmlNameEqual(emoteNode, "include"))
        {
            const std::string name = XML::getProperty(emoteNode, "name", "");
            if (!name.empty())
                loadXmlFile(name, skipError);
            continue;
        }
        else if (!xmlNameEqual(emoteNode, "emote"))
        {
            continue;
        }
 
        const int id = XML::getProperty(emoteNode, "id", -1);
        // skip hight images
        if (id > 19 || (Client::isTmw() && id > 13))
            continue;
 
        if (id == -1)
        {
            reportAlways("Emote Database: Emote with missing ID in %s!",
                paths.getStringValue("emotesFile").c_str())
            continue;
        }
        EmoteInfo *currentInfo = nullptr;
        if (mEmoteInfos.find(id) != mEmoteInfos.end())
            currentInfo = mEmoteInfos[id];
        else
            currentInfo = new EmoteInfo;
        if (currentInfo == nullptr)
            continue;
        currentInfo->time = XML::getProperty(emoteNode, "time", 500);
        currentInfo->effectId = XML::getProperty(emoteNode, "effect", -1);
 
        for_each_xml_child_node(spriteNode, emoteNode)
        {
            if (!XmlHaveChildContent(spriteNode))
                continue;
 
            if (xmlNameEqual(spriteNode, "sprite"))
            {
                EmoteSprite *const currentSprite = new EmoteSprite;
                currentSprite->sprite = AnimatedSprite::load(pathJoin(
                    paths.getStringValue("sprites"),
                    XmlChildContent(spriteNode)),
                    XML::getProperty(spriteNode, "variant", 0));
                currentSprite->name = XML::langProperty(
                    spriteNode, "name", "");
                currentSprite->id = id;
                currentInfo->sprites.push_back(currentSprite);
            }
            else if (xmlNameEqual(spriteNode, "particlefx"))
            {
                currentInfo->particles.push_back(XmlChildContent(spriteNode));
            }
        }
        mEmoteInfos[id] = currentInfo;
        if (id > mLastEmote)
            mLastEmote = id;
    }
}

References EmoteInfo::effectId, fileName, for_each_xml_child_node, XML::getProperty(), Configuration::getStringValue(), EmoteSprite::id, Client::isTmw(), XML::langProperty(), AnimatedSprite::load(), loadXmlFile(), Logger::log(), logger, anonymous_namespace{emotedb.cpp}::mEmoteInfos, anonymous_namespace{emotedb.cpp}::mLastEmote, EmoteSprite::name, EmoteInfo::particles, pathJoin(), paths, reportAlways, XML::Document::rootNode(), EmoteSprite::sprite, EmoteInfo::sprites, EmoteInfo::time, and UseVirtFs_true.

size()

int EmoteDB::size

(

)

Definition at line 306 of file emotedb.cpp.

{
    return static_cast<signed int>(mEmoteInfos.size());
}

References anonymous_namespace{emotedb.cpp}::mEmoteInfos.

Referenced by Net::Download::adlerBuffer(), LayoutArray::align(), alloc_mem(), Setup_Theme::apply(), Logger::assertLog(), BrowserBox::calcHeight(), CharCreateDialog::CharCreateDialog(), PlayerRelationsManager::checkName(), Ea::LoginHandler::chooseServer(), ActorSprite::cleanupTargetCursors(), CrazyMoves::crazyMoveAe(), cursorSize(), Font::doClean(), XML::Document::Document(), NormalOpenGLGraphics::drawLineArrayf(), NormalOpenGLGraphics::drawLineArrayi(), MobileOpenGL2Graphics::drawLineArrays(), MobileOpenGLGraphics::drawLineArrays(), ModernOpenGLGraphics::drawLineArrays(), NormalOpenGLGraphics::drawQuadArrayfi(), NormalOpenGLGraphics::drawQuadArrayfiCached(), NormalOpenGLGraphics::drawQuadArrayii(), NormalOpenGLGraphics::drawQuadArrayiiCached(), MobileOpenGL2Graphics::drawTriangleArray(), ModernOpenGLGraphics::drawTriangleArray(), MobileOpenGLGraphics::drawTriangleArrayfs(), MobileOpenGLGraphics::drawTriangleArrayfsCached(), DyePalette::DyePalette(), encodeStr(), EquipmentWindow::EquipmentWindow(), extractNameFromSprite(), Map::findPath(), Font::Font(), TextBox::getCaretPosition(), UpdaterWindow::getFileHash(), IgnoreChoicesListModel::getNumberOfElements(), getSafeUtf8String(), LayoutArray::getSize(), LayoutArray::getSizes(), Map::indexTilesets(), ActorSprite::initTargetCursor(), InventoryWindow::InventoryWindow(), PlayerRelationsManager::isGoodName(), NpcDialog::itemCraftRequest(), NpcDialog::itemIndexRequest(), NpcDialog::itemRequest(), TextBox::keyPressed(), Font::loadFont(), SkinHelper::loadList(), Logger::log(), Logger::log_r(), WhoIsOnline::memoryWrite(), UpdaterWindow::memoryWrite(), PoParser::openFile(), Font::openFont(), operator new(), operator new[](), Catch::CompositeGenerator< T >::operator T(), mse::msevector< _Ty, _A >::mm_const_iterator_type::points_to_an_item(), mse::msevector< _Ty, _A >::mm_iterator_type::points_to_an_item(), EAthena::InventoryRecv::processCartInfo(), Ea::PlayerRecv::processMapMusic(), EAthena::PlayerRecv::processOnlineList(), Ea::InventoryRecv::processPlayerStorageStatus(), readColor(), LayoutArray::reflow(), removeSpriteIndex(), LayoutArray::resizeGrid(), VirtFs::FsDir::rwops_read(), VirtFs::FsZip::rwops_read(), VirtFs::FsDir::rwops_write(), Item::setCards(), Inventory::setCards(), TextBox::setCaretColumn(), TextBox::setCaretPosition(), setConfigDefaults2(), Minimap::setMap(), KeyListModel::setSize(), BeingInfo::setTargetCursorSize(), Setup_Theme::Setup_Theme(), ShopWindow::ShopWindow(), PopupMenu::showAttackMonsterPopup(), AtlasManager::simpleSort(), Particle::update(), StaticBrowserBox::updateHeight(), Net::Download::writeFunction(), xmlErrorLogger(), and ObjectsLayer::~ObjectsLayer().

unload()

void EmoteDB::unload

(

)

Definition at line 227 of file emotedb.cpp.

{
    logger->log1("Unloading emote database...");
    FOR_EACH (EmoteInfos::const_iterator, i, mEmoteInfos)
    {
        if (i->second != nullptr)
        {
            std::list<EmoteSprite*> &sprites = i->second->sprites;
            while (!sprites.empty())
            {
                delete sprites.front()->sprite;
                delete sprites.front();
                sprites.pop_front();
            }
            delete i->second;
        }
    }
 
    mEmoteInfos.clear();
 
    std::list<EmoteSprite*> &sprites = mUnknown.sprites;
    while (!sprites.empty())
    {
        delete sprites.front()->sprite;
        delete sprites.front();
        sprites.pop_front();
    }
 
    mLoaded = false;
}

References FOR_EACH, Logger::log1(), logger, anonymous_namespace{emotedb.cpp}::mEmoteInfos, anonymous_namespace{emotedb.cpp}::mLoaded, anonymous_namespace{emotedb.cpp}::mUnknown, and EmoteInfo::sprites.

Referenced by DbManager::unloadDb().