StatusEffect Class Reference

#include <statuseffect.h>

Public Member Functions
	StatusEffect ()
	~StatusEffect ()
void	playSFX () const
void	deliverMessage () const
Particle *	getStartParticle () const
Particle *	getParticle () const
AnimatedSprite *	getIcon () const
std::string	getAction () const

Data Fields
std::string	mMessage
std::string	mSFXEffect
std::string	mStartParticleEffect
std::string	mParticleEffect
std::string	mIcon
std::string	mAction
std::string	mName
bool	mIsPersistent
bool	mIsPoison
bool	mIsCart
bool	mIsRiding
bool	mIsTrickDead
bool	mIsPostDelay

Detailed Description

Definition at line 34 of file statuseffect.h.

Constructor & Destructor Documentation

StatusEffect()

StatusEffect::StatusEffect

(

)

Definition at line 39 of file statuseffect.cpp.

                           :
    mMessage(),
    mSFXEffect(),
    mStartParticleEffect(),
    mParticleEffect(),
    mIcon(),
    mAction(),
    mName(),
    mIsPersistent(false),
    mIsPoison(false),
    mIsCart(false),
    mIsRiding(false),
    mIsTrickDead(false),
    mIsPostDelay(false)
{
}

~StatusEffect()

StatusEffect::~StatusEffect

(

)

Definition at line 56 of file statuseffect.cpp.

{
}

Member Function Documentation

deliverMessage()

void StatusEffect::deliverMessage

(

)

const

Delivers the chat message associated with this status effect, if possible.

Definition at line 66 of file statuseffect.cpp.

{
    if (!mMessage.empty() &&
        localChatTab != nullptr)
    {
        localChatTab->chatLog(mMessage,
            ChatMsgType::BY_SERVER,
            IgnoreRecord_false,
            TryRemoveColors_true);
    }
}

References ChatMsgType::BY_SERVER, ChatTab::chatLog(), IgnoreRecord_false, localChatTab, mMessage, and TryRemoveColors_true.

Referenced by LocalPlayer::handleStatusEffect().

getAction()

std::string StatusEffect::getAction

(

)

const

Retrieves an action to perform, or SpriteAction::INVALID

Definition at line 103 of file statuseffect.cpp.

{
    if (mAction.empty())
        return SpriteAction::INVALID;
    return mAction;
}

References SpriteAction::INVALID, and mAction.

getIcon()

AnimatedSprite * StatusEffect::getIcon

(

)

const

Retrieves the status icon for this effect, if applicable

Definition at line 92 of file statuseffect.cpp.

{
    if (mIcon.empty())
    {
        return nullptr;
    }
    return AnimatedSprite::load(
        pathJoin(paths.getStringValue("sprites"), mIcon),
        0);
}

References Configuration::getStringValue(), AnimatedSprite::load(), mIcon, pathJoin(), and paths.

Referenced by LocalPlayer::handleStatusEffect().

getParticle()

Particle * StatusEffect::getParticle

(

)

const

Creates the particle effect associated with this status effect, if possible.

Definition at line 85 of file statuseffect.cpp.

{
    if (particleEngine == nullptr || mParticleEffect.empty())
        return nullptr;
    return particleEngine->addEffect(mParticleEffect, 0, 0, 0);
}

References ParticleEngine::addEffect(), mParticleEffect, and particleEngine.

Referenced by ActorSprite::handleStatusEffect().

getStartParticle()

Particle * StatusEffect::getStartParticle

(

)

const

Creates the particle effect associated with this status effect, if possible.

Definition at line 78 of file statuseffect.cpp.

{
    if (particleEngine == nullptr || mStartParticleEffect.empty())
        return nullptr;
    return particleEngine->addEffect(mStartParticleEffect, 0, 0, 0);
}

References ParticleEngine::addEffect(), mStartParticleEffect, and particleEngine.

Referenced by ActorSprite::handleStatusEffect().

playSFX()

void StatusEffect::playSFX

(

)

const

Plays the sound effect associated with this status effect, if possible.

Definition at line 60 of file statuseffect.cpp.

{
    if (!mSFXEffect.empty())
        soundManager.playSfx(mSFXEffect, 0, 0);
}

References mSFXEffect, SoundManager::playSfx(), and soundManager.

Referenced by LocalPlayer::handleStatusEffect().

Field Documentation

mAction

std::string StatusEffect::mAction

Definition at line 82 of file statuseffect.h.

Referenced by getAction(), and StatusEffectDB::loadXmlFile().

mIcon

std::string StatusEffect::mIcon

Definition at line 81 of file statuseffect.h.

Referenced by getIcon(), and StatusEffectDB::loadXmlFile().

mIsCart

bool StatusEffect::mIsCart

Definition at line 86 of file statuseffect.h.

Referenced by StatusEffectDB::loadXmlFile(), and ActorSprite::updateStatusEffect().

mIsPersistent

bool StatusEffect::mIsPersistent

Definition at line 84 of file statuseffect.h.

Referenced by StatusEffectDB::loadXmlFile(), and ActorSprite::logic().

mIsPoison

bool StatusEffect::mIsPoison

Definition at line 85 of file statuseffect.h.

Referenced by StatusEffectDB::loadXmlFile(), and ActorSprite::updateStatusEffect().

mIsPostDelay

bool StatusEffect::mIsPostDelay

Definition at line 89 of file statuseffect.h.

Referenced by StatusEffectDB::loadXmlFile(), and ActorSprite::updateStatusEffect().

mIsRiding

bool StatusEffect::mIsRiding

Definition at line 87 of file statuseffect.h.

Referenced by StatusEffectDB::loadXmlFile(), and ActorSprite::updateStatusEffect().

mIsTrickDead

bool StatusEffect::mIsTrickDead

Definition at line 88 of file statuseffect.h.

Referenced by StatusEffectDB::loadXmlFile(), and ActorSprite::updateStatusEffect().

mMessage

std::string StatusEffect::mMessage

Definition at line 77 of file statuseffect.h.

Referenced by deliverMessage(), and StatusEffectDB::loadXmlFile().

mName

std::string StatusEffect::mName

Definition at line 83 of file statuseffect.h.

Referenced by ActorSprite::getStatusEffectsString(), and StatusEffectDB::loadXmlFile().

mParticleEffect

std::string StatusEffect::mParticleEffect

Definition at line 80 of file statuseffect.h.

Referenced by getParticle(), and StatusEffectDB::loadXmlFile().

mSFXEffect

std::string StatusEffect::mSFXEffect

Definition at line 78 of file statuseffect.h.

Referenced by StatusEffectDB::loadXmlFile(), and playSFX().

mStartParticleEffect

std::string StatusEffect::mStartParticleEffect

Definition at line 79 of file statuseffect.h.

Referenced by getStartParticle(), and StatusEffectDB::loadXmlFile().

---

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

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