EffectManager Class Reference

#include <effectmanager.h>

Public Member Functions
	EffectManager ()
	~EffectManager ()
void	loadXmlFile (const std::string &fileName, const SkipError skipError)
bool	trigger (const int id, Being *const being, const int rotation)
bool	triggerDirection (const int id, Being *const being, const SpriteDirection::Type &direction)
Particle *	triggerReturn (const int id, Being *const being, const int rotation)
bool	trigger (const int id, const int x, const int y, const time_t endTime, const int rotation)
void	triggerDefault (int effectId, Being *const being, const int defaultEffectId)
void	triggerDefault (int effectId, const int x, const int y, const time_t endTime, const int defaultEffectId)
void	logic ()
void	clear ()

Private Attributes
std::vector< EffectDescription >	mEffects
std::list< ParticleTimer >	mTimers

Detailed Description

Definition at line 44 of file effectmanager.h.

Constructor & Destructor Documentation

EffectManager()

EffectManager::EffectManager

(

)

Definition at line 41 of file effectmanager.cpp.

                             :
    mEffects(),
    mTimers()
{
    logger->log1("Effects are now loading");
    loadXmlFile(paths.getStringValue("effectsFile"), SkipError_false);
    loadXmlFile(paths.getStringValue("effectsPatchFile"), SkipError_true);
    loadXmlDir("effectsPatchDir", loadXmlFile)
}

References Configuration::getStringValue(), loadXmlDir, loadXmlFile(), Logger::log1(), logger, paths, SkipError_false, and SkipError_true.

~EffectManager()

EffectManager::~EffectManager

(

)

Definition at line 84 of file effectmanager.cpp.

{
}

Member Function Documentation

clear()

void EffectManager::clear

(

)

Definition at line 262 of file effectmanager.cpp.

{
    FOR_EACH (std::list<ParticleTimer>::iterator, it, mTimers)
    {
        Particle *const particle = (*it).particle;
        if (particle != nullptr)
            particle->kill();
    }
    mTimers.clear();
}

References FOR_EACH, Particle::kill(), and mTimers.

Referenced by Game::~Game().

loadXmlFile()

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

Definition at line 51 of file effectmanager.cpp.

{
    XML::Document doc(fileName, UseVirtFs_true, skipError);
    XmlNodeConstPtrConst root = doc.rootNode();
 
    if ((root == nullptr) ||
        !xmlNameEqual(root, "being-effects"))
    {
        logger->log("Error loading being effects file: " + fileName);
        return;
    }
 
    for_each_xml_child_node(node, root)
    {
        if (xmlNameEqual(node, "include"))
        {
            const std::string name = XML::getProperty(node, "name", "");
            if (!name.empty())
                loadXmlFile(name, skipError);
            continue;
        }
        else if (xmlNameEqual(node, "effect"))
        {
            mEffects.push_back(EffectDescription(
                XML::getProperty(node, "id", -1),
                XML::getProperty(node, "particle", ""),
                XML::getProperty(node, "audio", ""),
                XML::getProperty(node, "sprite", "")));
        }
    }
}

References fileName, for_each_xml_child_node, XML::getProperty(), Logger::log(), logger, mEffects, XML::Document::rootNode(), and UseVirtFs_true.

Referenced by EffectManager().

logic()

void EffectManager::logic

(

)

Definition at line 239 of file effectmanager.cpp.

{
    const time_t time = cur_time;
    bool found(true);
    while (found)
    {
        found = false;
        FOR_EACH (std::list<ParticleTimer>::iterator, it, mTimers)
        {
            const ParticleTimer &timer = *it;
            if (timer.endTime < time)
            {
                found = true;
                Particle *const particle = timer.particle;
                if (particle != nullptr)
                    particle->kill();
                mTimers.erase(it);
                break;
            }
        }
    }
}

References cur_time, ParticleTimer::endTime, FOR_EACH, Particle::kill(), mTimers, and ParticleTimer::particle.

Referenced by Game::slowLogic().

trigger() [1/2]

bool EffectManager::trigger	(	const int	id,
		Being *const	being,
		const int	rotation
	)

Triggers a effect with the id, at the specified being.

Definition at line 119 of file effectmanager.cpp.

{
    if ((being == nullptr) || (particleEngine == nullptr) || id == -1)
        return false;
 
    BLOCK_START("EffectManager::trigger")
    bool rValue = false;
    FOR_EACH (STD_VECTOR<EffectDescription>::const_iterator, i, mEffects)
    {
        const EffectDescription &effect = *i;
        if (effect.id == id)
        {
            rValue = true;
            if (!effect.gfx.empty())
            {
                Particle *const selfFX = particleEngine->addEffect(
                    effect.gfx, 0, 0, rotation);
                being->controlAutoParticle(selfFX);
            }
            if (!effect.sfx.empty())
                soundManager.playSfx(effect.sfx, 0, 0);
            if (!effect.sprite.empty())
                being->addEffect(effect.sprite);
            return rValue;
        }
    }
    reportAlways("Missing effect %d", id)
    BLOCK_END("EffectManager::trigger")
    return rValue;
}

References Being::addEffect(), ParticleEngine::addEffect(), BLOCK_END, BLOCK_START, ActorSprite::controlAutoParticle(), FOR_EACH, EffectDescription::gfx, EffectDescription::id, mEffects, particleEngine, SoundManager::playSfx(), reportAlways, EffectDescription::sfx, soundManager, and EffectDescription::sprite.

Referenced by EAthena::BeingRecv::processBeingSelfEffect(), TmwAthena::BeingRecv::processBeingSelfEffect(), EAthena::BeingRecv::processBeingSpecialEffect(), QuestsWindow::rebuild(), Being::setEmote(), Being::takeDamage(), triggerDefault(), and triggerDirection().

trigger() [2/2]

bool EffectManager::trigger	(	const int	id,
		const int	x,
		const int	y,
		const time_t	endTime,
		const int	rotation
	)

Triggers a effect with the id, at the specified x and y coordinate.

Definition at line 182 of file effectmanager.cpp.

{
    if ((particleEngine == nullptr) || id == -1)
        return false;
 
    bool rValue = false;
    FOR_EACH (STD_VECTOR<EffectDescription>::const_iterator, i, mEffects)
    {
        const EffectDescription &effect = *i;
        if (effect.id == id)
        {
            rValue = true;
            if (!effect.gfx.empty())
            {
                Particle *const particle = particleEngine->addEffect(
                    effect.gfx,
                    x, y,
                    rotation);
                if (particle != nullptr)
                    mTimers.push_back(ParticleTimer(particle, endTime));
            }
            if (!effect.sfx.empty())
                soundManager.playSfx(effect.sfx, 0, 0);
            return rValue;
        }
    }
    reportAlways("Missing effect %d", id)
    return rValue;
}

References ParticleEngine::addEffect(), FOR_EACH, EffectDescription::gfx, EffectDescription::id, mEffects, mTimers, particleEngine, SoundManager::playSfx(), reportAlways, EffectDescription::sfx, soundManager, x, and y.

triggerDefault() [1/2]

void EffectManager::triggerDefault	(	int	effectId,
		Being *const	being,
		const int	defaultEffectId
	)

Definition at line 215 of file effectmanager.cpp.

{
    if (effectId == -1)
        effectId = defaultEffectId;
    if (effectId == -1)
        return;
    trigger(effectId, being, 0);
}

References trigger().

Referenced by Being::handleSkill(), Being::handleSkillCasting(), SkillDialog::playCastingDstTileEffect(), SkillDialog::playRemoveEffect(), and SkillDialog::playUpdateEffect().

triggerDefault() [2/2]

void EffectManager::triggerDefault	(	int	effectId,
		const int	x,
		const int	y,
		const time_t	endTime,
		const int	defaultEffectId
	)

Definition at line 226 of file effectmanager.cpp.

{
    if (effectId == -1)
        effectId = defaultEffectId;
    if (effectId == -1)
        return;
    trigger(effectId, x, y, endTime, 0);
}

References trigger(), x, and y.

triggerDirection()

bool EffectManager::triggerDirection	(	const int	id,
		Being *const	being,
		const SpriteDirection::Type &	direction
	)

Definition at line 88 of file effectmanager.cpp.

{
    int rotation;
    switch (direction)
    {
        case SpriteDirection::DOWN:
        case SpriteDirection::DOWNRIGHT:
        case SpriteDirection::DOWNLEFT:
        case SpriteDirection::DEFAULT:
        case SpriteDirection::INVALID:
        default:
            rotation = 0;
            break;
        case SpriteDirection::LEFT:
            rotation = 90;
            break;
        case SpriteDirection::UP:
        case SpriteDirection::UPRIGHT:
        case SpriteDirection::UPLEFT:
            rotation = 180;
            break;
        case SpriteDirection::RIGHT:
            rotation = 270;
            break;
    }
 
    return trigger(id, being, rotation);
}

References SpriteDirection::DEFAULT, SpriteDirection::DOWN, SpriteDirection::DOWNLEFT, SpriteDirection::DOWNRIGHT, SpriteDirection::INVALID, SpriteDirection::LEFT, SpriteDirection::RIGHT, trigger(), SpriteDirection::UP, SpriteDirection::UPLEFT, and SpriteDirection::UPRIGHT.

Referenced by Being::setAction().

triggerReturn()

Particle * EffectManager::triggerReturn	(	const int	id,
		Being *const	being,
		const int	rotation
	)

Definition at line 152 of file effectmanager.cpp.

{
    if ((being == nullptr) || (particleEngine == nullptr) || id == -1)
        return nullptr;
 
    Particle *rValue = nullptr;
    FOR_EACH (STD_VECTOR<EffectDescription>::const_iterator, i, mEffects)
    {
        const EffectDescription &effect = *i;
        if (effect.id == id)
        {
            if (!effect.gfx.empty())
            {
                rValue = particleEngine->addEffect(
                    effect.gfx, 0, 0, rotation);
                being->controlCustomParticle(rValue);
            }
            if (!effect.sfx.empty())
                soundManager.playSfx(effect.sfx, 0, 0);
            if (!effect.sprite.empty())
                being->addEffect(effect.sprite);
            return rValue;
        }
    }
    reportAlways("Missing effect %d", id)
    return rValue;
}

References Being::addEffect(), ParticleEngine::addEffect(), ActorSprite::controlCustomParticle(), FOR_EACH, EffectDescription::gfx, EffectDescription::id, mEffects, particleEngine, SoundManager::playSfx(), reportAlways, EffectDescription::sfx, soundManager, and EffectDescription::sprite.

Referenced by Being::addSpecialEffect(), and Being::addSpiritBalls().

Field Documentation

mEffects

std::vector<EffectDescription> EffectManager::mEffects

private

Definition at line 96 of file effectmanager.h.

Referenced by loadXmlFile(), trigger(), and triggerReturn().

mTimers

std::list<ParticleTimer> EffectManager::mTimers

private

Definition at line 97 of file effectmanager.h.

Referenced by clear(), logic(), and trigger().

---

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

• src/effectmanager.h (986a3bf)
• src/effectmanager.cpp (986a3bf)