ActorSprite Class Reference

#include <actorsprite.h>

Inheritance diagram for ActorSprite:

Public Member Functions
	ActorSprite (const BeingId id)
	~ActorSprite ()
BeingId	getId () const
void	setId (const BeingId id)
virtual ActorTypeT	getType () const
virtual void	logic ()
void	setMap (Map *const map)
virtual BlockTypeT	getBlockType () const
void	controlAutoParticle (Particle *const particle)
void	controlCustomParticle (Particle *const particle)
virtual TargetCursorSizeT	getTargetCursorSize () const
virtual int	getTargetOffsetX () const
virtual int	getTargetOffsetY () const
void	setTargetType (const TargetCursorTypeT type)
void	untarget ()
void	setStatusEffect (const int32_t index, const Enable active, const IsStart start)
void	setStatusEffectOpitons (const uint32_t option, const uint32_t opt1, const uint32_t opt2, const uint32_t opt3)
void	setStatusEffectOpitons (const uint32_t option, const uint32_t opt1, const uint32_t opt2)
void	setStatusEffectOpiton0 (const uint32_t option)
void	setAlpha (const float alpha)
float	getAlpha () const
int	getWidth () const
int	getHeight () const
void	addActorSpriteListener (ActorSpriteListener *const listener)
void	removeActorSpriteListener (ActorSpriteListener *const listener)
int	getActorX () const
int	getActorY () const
void	setPoison (const bool b)
bool	getPoison () const
void	setHaveCart (const bool b)
bool	getHaveCart () const
virtual void	setRiding (const bool b)
virtual void	setTrickDead (const bool b)
bool	isTrickDead () const
const std::set< int32_t > &	getStatusEffects () const
std::string	getStatusEffectsString () const
virtual void	stopCast (const bool b)
size_t	getParticlesCount () const
void	controlParticleDeleted (const Particle *const particle)
Public Member Functions inherited from CompoundSprite
	CompoundSprite ()
	~CompoundSprite ()
bool	reset ()
bool	play (const std::string &action)
bool	update (const int time)
void	drawSimple (Graphics *const graphics, const int posX, const int posY) const
int	getWidth () const
int	getHeight () const
const Image *	getImage () const
bool	setSpriteDirection (const SpriteDirection::Type direction)
int	getNumberOfLayers () const
unsigned int	getCurrentFrame () const
unsigned int	getFrameCount () const
void	addSprite (Sprite *const sprite)
void	setSprite (const size_t layer, Sprite *const sprite)
void	removeSprite (const int layer)
void	clear ()
void	ensureSize (const size_t layerCount)
void	drawSprites (Graphics *const graphics, const int posX, const int posY) const
virtual void	drawSpritesSDL (Graphics *const graphics, const int posX, const int posY) const
void	setAlpha (float alpha)
bool	updateNumber (const unsigned num)
int	getLastTime () const
int	getStartTime () const
Public Member Functions inherited from Sprite
virtual	~Sprite ()
virtual void	draw (Graphics *const graphics, const int posX, const int posY) const =0
virtual const void *	getHash () const
virtual const void *	getHash2 () const
Public Member Functions inherited from Actor
virtual	~Actor ()
virtual void	draw (Graphics *const graphics, const int offsetX, const int offsetY) const =0
const Vector &	getPixelPositionF () const
virtual void	setPixelPositionF (const Vector &pos)
int	getPixelX () const
virtual int	getPixelY () const
virtual int	getSortPixelY () const
virtual int	getTileX () const
virtual int	getTileY () const
virtual int	getNumberOfLayers () const
const Map *	getMap () const

Static Public Member Functions
static void	load ()
static void	unload ()
Static Public Member Functions inherited from CompoundSprite
static void	setEnableDelay (bool b)

Protected Types
typedef std::list< ActorSpriteListener * >	ActorSpriteListeners
typedef ActorSpriteListeners::iterator	ActorSpriteListenerIterator
Protected Types inherited from CompoundSprite
typedef std::list< CompoundItem * >	ImagesCache

Protected Member Functions
virtual void	updateStatusEffect (const int32_t index, const Enable newStatus, const IsStart start)
virtual void	handleStatusEffect (const StatusEffect *const effect, const int32_t effectId, const Enable newStatus, const IsStart start)
void	setupSpriteDisplay (const SpriteDisplay &display, const ForceDisplay forceDisplay, const DisplayTypeT displayType, const std::string &color)
Protected Member Functions inherited from CompoundSprite
void	redraw () const
void	updateImages () const
bool	updateFromCache () const
void	initCurrentCacheItem () const
Protected Member Functions inherited from Sprite
	Sprite ()
Protected Member Functions inherited from Actor
	Actor ()

Static Protected Member Functions
static void	initTargetCursor ()
static void	cleanupTargetCursors ()

Protected Attributes
std::set< int32_t >	mStatusEffects
ParticleVector	mStatusParticleEffects
ParticleList	mChildParticleEffects
int	mHorseId
BeingId	mId
AnimatedSprite *	mUsedTargetCursor
ActorSpriteListeners	mActorSpriteListeners
int	mCursorPaddingX
int	mCursorPaddingY
bool	mMustResetParticles
bool	mPoison
bool	mHaveCart
bool	mTrickDead
Protected Attributes inherited from CompoundSprite
ImagesCache	imagesCache
CompoundItem *	mCacheItem
Image *	mImage
Image *	mAlphaImage
int	mOffsetX
int	mOffsetY
int	mStartTime
int	mLastTime
int	mNextRedrawTime
bool	mNeedsRedraw
bool	mEnableAlphaFix
bool	mDisableAdvBeingCaching
bool	mDisableBeingCaching
Protected Attributes inherited from Sprite
float	mAlpha
Protected Attributes inherited from Actor
Map *	mMap
Vector	mPos
int	mYDiff

Static Protected Attributes
static AnimatedSprite *	targetCursor [static_cast< size_t >(TargetCursorType::NUM_TCT)][static_cast< size_t >(TargetCursorSize::NUM_TC)]
static bool	loaded = false
Static Protected Attributes inherited from CompoundSprite
static bool	mEnableDelay = true

Additional Inherited Members
Public Types inherited from CompoundSprite
typedef std::vector< Sprite * >::iterator	SpriteIterator
typedef std::vector< Sprite * >::const_iterator	SpriteConstIterator
Data Fields inherited from CompoundSprite
std::vector< Sprite * >	mSprites
Data Fields inherited from Actor
int	mPixelX
int	mPixelY

Detailed Description

Definition at line 55 of file actorsprite.h.

Member Typedef Documentation

ActorSpriteListenerIterator

typedef ActorSpriteListeners::iterator ActorSprite::ActorSpriteListenerIterator

protected

Definition at line 253 of file actorsprite.h.

ActorSpriteListeners

typedef std::list<ActorSpriteListener*> ActorSprite::ActorSpriteListeners

protected

Definition at line 252 of file actorsprite.h.

Constructor & Destructor Documentation

ActorSprite()

ActorSprite::ActorSprite ( const BeingId  id )

explicit

Definition at line 69 of file actorsprite.cpp.

                                         :
    CompoundSprite(),
    Actor(),
    mStatusEffects(),
    mStatusParticleEffects(nullptr, true),
    mChildParticleEffects(&mStatusParticleEffects, false),
    mHorseId(0),
    mId(id),
    mUsedTargetCursor(nullptr),
    mActorSpriteListeners(),
    mCursorPaddingX(0),
    mCursorPaddingY(0),
    mMustResetParticles(false),
    mPoison(false),
    mHaveCart(false),
    mTrickDead(false)
{
}

~ActorSprite()

ActorSprite::~ActorSprite

(

)

Definition at line 88 of file actorsprite.cpp.

{
    mChildParticleEffects.clear();
    mMustResetParticles = true;
 
    mUsedTargetCursor = nullptr;
 
    if (localPlayer != nullptr &&
        localPlayer != this &&
        localPlayer->getTarget() == this)
    {
        localPlayer->setTarget(nullptr);
    }
 
    // Notify listeners of the destruction.
    FOR_EACH (ActorSpriteListenerIterator, iter, mActorSpriteListeners)
    {
        if (reportFalse(*iter))
            (*iter)->actorSpriteDestroyed(*this);
    }
}

References ParticleContainer::clear(), FOR_EACH, LocalPlayer::getTarget(), localPlayer, mActorSpriteListeners, mChildParticleEffects, mMustResetParticles, mUsedTargetCursor, reportFalse, and LocalPlayer::setTarget().

Member Function Documentation

addActorSpriteListener()

void ActorSprite::addActorSpriteListener

(

ActorSpriteListener *const

listener

)

Add an ActorSprite listener.

Definition at line 454 of file actorsprite.cpp.

{
    mActorSpriteListeners.push_front(listener);
}

References anonymous_namespace{itemlinkhandler.cpp}::listener, and mActorSpriteListeners.

Referenced by LocalPlayer::pickUp().

cleanupTargetCursors()

void ActorSprite::cleanupTargetCursors ( )

staticprotected

Remove the target cursors from memory

Definition at line 511 of file actorsprite.cpp.

{
    for_each_cursors()
    {
        delete2(targetCursor[type][size])
    }
    end_foreach
}

References delete2, end_foreach, for_each_cursors, EmoteDB::size(), and targetCursor.

Referenced by unload().

controlAutoParticle()

void ActorSprite::controlAutoParticle

(

Particle *const

particle

)

Take control of a particle. Particle can be auto deleted.

Definition at line 148 of file actorsprite.cpp.

{
    if (particle != nullptr)
    {
        particle->setActor(mId);
        mChildParticleEffects.addLocally(particle);
    }
}

References ParticleList::addLocally(), mChildParticleEffects, mId, and Particle::setActor().

Referenced by setupSpriteDisplay(), and EffectManager::trigger().

controlCustomParticle()

void ActorSprite::controlCustomParticle

(

Particle *const

particle

)

Take control of a particle. Owner must remove particle by self.

Definition at line 157 of file actorsprite.cpp.

{
    if (particle != nullptr)
    {
        // The effect may not die without the beings permission or we segfault
        particle->disableAutoDelete();
        mChildParticleEffects.addLocally(particle);
    }
}

References ParticleList::addLocally(), Particle::disableAutoDelete(), and mChildParticleEffects.

Referenced by Being::recreateItemParticles(), LocalPlayer::setTestParticle(), and EffectManager::triggerReturn().

controlParticleDeleted()

void ActorSprite::controlParticleDeleted

(

const Particle *const

particle

)

Definition at line 167 of file actorsprite.cpp.

{
    if (particle != nullptr)
        mChildParticleEffects.removeLocally(particle);
}

References mChildParticleEffects, and ParticleList::removeLocally().

Referenced by Particle::~Particle().

getActorX()

int ActorSprite::getActorX ( ) const

inline

Definition at line 160 of file actorsprite.h.

        { return getPixelX() - mapTileSize / 2; }

References Actor::getPixelX(), and mapTileSize.

Referenced by FloorItem::draw().

getActorY()

int ActorSprite::getActorY ( ) const

inline

Definition at line 163 of file actorsprite.h.

        { return getPixelY() - mapTileSize; }

References Actor::getPixelY(), and mapTileSize.

Referenced by FloorItem::draw().

getAlpha()

float ActorSprite::getAlpha ( ) const

inlinevirtual

Returns the current alpha value used to draw the actor.

Implements Actor.

Definition at line 137 of file actorsprite.h.

        { return CompoundSprite::getAlpha(); }

References Sprite::getAlpha().

getBlockType()

virtual BlockTypeT ActorSprite::getBlockType ( ) const

inlinevirtual

Gets the way the object blocks pathfinding for other objects

Reimplemented in Being.

Definition at line 83 of file actorsprite.h.

        { return BlockType::NONE; }

References BlockType::NONE.

getHaveCart()

bool ActorSprite::getHaveCart ( ) const

inline

Definition at line 175 of file actorsprite.h.

        { return mHaveCart; }

References mHaveCart.

Referenced by ShopWindow::updateButtonsAndLabels().

getHeight()

int ActorSprite::getHeight ( ) const

inlinevirtual

Returns the vertical size of the actors graphical representation in pixels or 0 when it is undefined.

Reimplemented from Actor.

Reimplemented in Being.

Definition at line 143 of file actorsprite.h.

        { return CompoundSprite::getHeight(); }

References CompoundSprite::getHeight().

getId()

BeingId ActorSprite::getId ( ) const

inline

Definition at line 64 of file actorsprite.h.

        { return mId; }

References mId.

Referenced by CharSelectDialog::action(), Being::addToCache(), EAthena::FamilyHandler::askForChild(), LocalPlayer::attack(), Being::botLogic(), EAthena::NpcHandler::buy(), TmwAthena::NpcHandler::buy(), EAthena::VendingHandler::buy(), EAthena::VendingHandler::buy2(), EAthena::VendingHandler::buyItems(), EAthena::PetHandler::catchPet(), EAthena::PartyHandler::changeLeader(), ActorManager::clear(), ActorManager::cloneBeing(), EAthena::GameHandler::connect(), TmwAthena::GameHandler::connect(), ActorManager::createBeing(), ActorManager::createItem(), EAthena::CharServerHandler::deleteCharacter(), TmwAthena::CharServerHandler::deleteCharacter(), ActorManager::erase(), ActorManager::findActor(), ActorManager::findBeing(), ActorManager::findItem(), PopupMenu::handleLink(), EAthena::GuildHandler::invite(), EAthena::PartyHandler::invite(), TmwAthena::PartyHandler::invite(), TmwAthena::PartyHandler::inviteResponse(), EAthena::PartyHandler::kick(), TmwAthena::PartyHandler::kick(), EAthena::GuildHandler::leave(), ActorManager::logic(), TargetDebugTab::logic(), EAthena::AdminHandler::mute(), EAthena::BuyingStoreHandler::open(), EAthena::VendingHandler::open(), FindBeingEqualFunctor::operator()(), SpellManager::parseCommand(), EAthena::PlayerHandler::pickUp(), TmwAthena::PlayerHandler::pickUp(), LocalPlayer::pingRequest(), ActorManager::printBeingsToChat(), EAthena::BeingRecv::processBeingChangeLookCards(), TmwAthena::BeingRecv::processBeingMove(), TmwAthena::BeingRecv::processBeingVisible(), EAthena::BuyingStoreRecv::processBuyingStoreItemsList(), EAthena::ChatRecv::processChatRoomCreateAck(), EAthena::MercenaryRecv::processMercenaryInfo(), Ea::BeingRecv::processNameResponse(), EAthena::BeingRecv::processNameResponse2(), EAthena::BeingRecv::processNameResponseTitle(), Ea::PartyRecv::processPartyLeave(), EAthena::PlayerRecv::processPlayerGetExp(), EAthena::PlayerRecv::processPlayerGetExp2(), EAthena::BeingRecv::processPlayerGuilPartyInfo(), EAthena::BeingRecv::processPlayerGuilPartyInfo2(), EAthena::PlayerRecv::processPlayerHeal(), EAthena::TradeHandler::request(), TmwAthena::TradeHandler::request(), EAthena::GuildHandler::requestAlliance(), EAthena::AdminHandler::requestLogin(), EAthena::GuildHandler::requestOpposition(), EAthena::BuyingStoreHandler::sell(), CharSelectDialog::setName(), PlayerInfo::setPetBeing(), ActorManager::setPlayer(), EAthena::PlayerHandler::setStat(), TmwAthena::PlayerHandler::setStat(), BeingPopup::show(), PopupMenu::showChatPopup(), PopupMenu::showPopup(), PopupMenu::showUndressPopup(), EAthena::NpcHandler::talk(), TmwAthena::NpcHandler::talk(), EAthena::AdminHandler::unequipAll(), Being::updateFromCache(), SkillDialog::useSkillDefault(), SkillDialog::useSkillPosition(), SkillDialog::useSkillTarget(), and EAthena::BeingHandler::viewPlayerEquipment().

getParticlesCount()

size_t ActorSprite::getParticlesCount ( ) const

inline

Definition at line 195 of file actorsprite.h.

        {
            return mStatusParticleEffects.usedSize() +
                mChildParticleEffects.size();
        }

References mChildParticleEffects, mStatusParticleEffects, ParticleList::size(), and ParticleVector::usedSize().

Referenced by BeingPopup::show().

getPoison()

bool ActorSprite::getPoison ( ) const

inline

Definition at line 169 of file actorsprite.h.

        { return mPoison; }

References mPoison.

Referenced by SocialPlayersTab::updateAvatar().

getStatusEffects()

const std::set<int32_t>& ActorSprite::getStatusEffects ( ) const

inline

Definition at line 187 of file actorsprite.h.

        { return mStatusEffects; }

References mStatusEffects.

getStatusEffectsString()

std::string ActorSprite::getStatusEffectsString

(

)

const

Definition at line 520 of file actorsprite.cpp.

{
    std::string effectsStr;
    if (!mStatusEffects.empty())
    {
        FOR_EACH (std::set<int32_t>::const_iterator, it, mStatusEffects)
        {
            const StatusEffect *const effect =
                StatusEffectDB::getStatusEffect(
                *it,
                Enable_true);
            if (effect == nullptr)
                continue;
            if (!effectsStr.empty())
                effectsStr.append(", ");
            effectsStr.append(effect->mName);
        }
    }
    return effectsStr;
}

References Enable_true, FOR_EACH, StatusEffectDB::getStatusEffect(), StatusEffect::mName, and mStatusEffects.

Referenced by TargetDebugTab::logic(), and BeingPopup::show().

getTargetCursorSize()

virtual TargetCursorSizeT ActorSprite::getTargetCursorSize ( ) const

inlinevirtual

Returns the required size of a target cursor for this being.

Reimplemented in Being.

Definition at line 99 of file actorsprite.h.

        { return TargetCursorSize::MEDIUM; }

References TargetCursorSize::MEDIUM.

Referenced by setTargetType().

getTargetOffsetX()

virtual int ActorSprite::getTargetOffsetX ( ) const

inlinevirtual

Reimplemented in Being.

Definition at line 102 of file actorsprite.h.

        { return 0; }

getTargetOffsetY()

virtual int ActorSprite::getTargetOffsetY ( ) const

inlinevirtual

Reimplemented in Being.

Definition at line 105 of file actorsprite.h.

        { return 0; }

getType()

virtual ActorTypeT ActorSprite::getType ( ) const

inlinevirtual

Returns the type of the ActorSprite.

Reimplemented in FloorItem, and Being.

Definition at line 73 of file actorsprite.h.

        { return ActorType::Unknown; }

References ActorType::Unknown.

Referenced by ActorManager::findBeing(), ActorManager::findBeingsByPixel(), ActorManager::findItem(), ActorManager::logic(), ActorManager::removeRoom(), PopupMenu::showPopup(), ActorManager::updateBadges(), ActorManager::updateRoom(), and updateStatusEffect().

getWidth()

int ActorSprite::getWidth ( ) const

inlinevirtual

Returns the horizontal size of the actors graphical representation in pixels or 0 when it is undefined.

Reimplemented from Actor.

Reimplemented in Being.

Definition at line 140 of file actorsprite.h.

        { return CompoundSprite::getWidth(); }

References CompoundSprite::getWidth().

handleStatusEffect()

void ActorSprite::handleStatusEffect ( const StatusEffect *const  effect, const int32_t  effectId, const Enable  newStatus, const IsStart  start  )

protectedvirtual

Handle an update to a status or stun effect

Parameters

The	StatusEffect to effect
effectId	-1 for stun, otherwise the effect index

Reimplemented in LocalPlayer.

Definition at line 338 of file actorsprite.cpp.

{
    if (effect == nullptr)
        return;
 
    if (newStatus == Enable_true)
    {
        if (effectId >= 0)
        {
            Particle *particle = nullptr;
            if (start == IsStart_true)
                particle = effect->getStartParticle();
            if (particle == nullptr)
                particle = effect->getParticle();
            if (particle != nullptr)
                mStatusParticleEffects.setLocally(effectId, particle);
        }
    }
    else
    {
        mStatusParticleEffects.delLocally(effectId);
    }
}

References ParticleVector::delLocally(), Enable_true, StatusEffect::getParticle(), StatusEffect::getStartParticle(), IsStart_true, mStatusParticleEffects, ParticleVector::setLocally(), and anonymous_namespace{stringutils.cpp}::start.

Referenced by LocalPlayer::handleStatusEffect(), and updateStatusEffect().

initTargetCursor()

void ActorSprite::initTargetCursor ( )

staticprotected

Load the target cursors into memory

Definition at line 494 of file actorsprite.cpp.

{
    static const std::string targetCursorFile("target-cursor-%s-%s.xml");
 
    // Load target cursors
    for_each_cursors()
    {
        targetCursor[type][size] = AnimatedSprite::load(
            Theme::resolveThemePath(strprintf(
            targetCursorFile.c_str(),
            cursorType(static_cast<TargetCursorTypeT>(type)),
            cursorSize(static_cast<TargetCursorSizeT>(size)))),
            0);
    }
    end_foreach
}

References cursorSize(), cursorType(), end_foreach, for_each_cursors, AnimatedSprite::load(), Theme::resolveThemePath(), EmoteDB::size(), strprintf(), and targetCursor.

Referenced by load().

isTrickDead()

bool ActorSprite::isTrickDead ( ) const

inline

Definition at line 184 of file actorsprite.h.

        { return mTrickDead; }

References mTrickDead.

Referenced by InputManager::updateConditionMask().

load()

void ActorSprite::load ( )

static

Definition at line 435 of file actorsprite.cpp.

{
    if (loaded)
        unload();
 
    initTargetCursor();
 
    loaded = true;
}

References initTargetCursor(), loaded, and unload().

Referenced by Client::loadData(), and DbManager::loadDb().

logic()

void ActorSprite::logic ( )

virtual

Reimplemented in LocalPlayer, and Being.

Definition at line 110 of file actorsprite.cpp.

{
    BLOCK_START("ActorSprite::logic")
    // Update sprite animations
    update(tick_time * MILLISECONDS_IN_A_TICK);
 
    // Restart status/particle effects, if needed
    if (mMustResetParticles)
    {
        mMustResetParticles = false;
        FOR_EACH (std::set<int32_t>::const_iterator, it, mStatusEffects)
        {
            const StatusEffect *const effect
                = StatusEffectDB::getStatusEffect(*it, Enable_true);
            if (effect != nullptr &&
                effect->mIsPersistent)
            {
                updateStatusEffect(*it,
                    Enable_true,
                    IsStart_false);
            }
        }
    }
 
    // Update particle effects
    mChildParticleEffects.moveTo(mPos.x, mPos.y);
    BLOCK_END("ActorSprite::logic")
}

References BLOCK_END, BLOCK_START, Enable_true, FOR_EACH, StatusEffectDB::getStatusEffect(), IsStart_false, mChildParticleEffects, MILLISECONDS_IN_A_TICK, StatusEffect::mIsPersistent, mMustResetParticles, ParticleList::moveTo(), Actor::mPos, mStatusEffects, tick_time, CompoundSprite::update(), updateStatusEffect(), Vector::x, and Vector::y.

Referenced by Being::logic().

removeActorSpriteListener()

void ActorSprite::removeActorSpriteListener

(

ActorSpriteListener *const

listener

)

Remove an ActorSprite listener.

Definition at line 459 of file actorsprite.cpp.

{
    mActorSpriteListeners.remove(listener);
}

References anonymous_namespace{itemlinkhandler.cpp}::listener, and mActorSpriteListeners.

setAlpha()

void ActorSprite::setAlpha ( const float  alpha )

inlinevirtual

Sets the alpha value used to draw the actor.

Implements Actor.

Definition at line 134 of file actorsprite.h.

        { CompoundSprite::setAlpha(alpha); }

References CompoundSprite::setAlpha().

setHaveCart()

void ActorSprite::setHaveCart ( const bool  b )

inline

Definition at line 172 of file actorsprite.h.

        { mHaveCart = b; }

References mHaveCart.

Referenced by updateStatusEffect().

setId()

void ActorSprite::setId ( const BeingId  id )

inline

Definition at line 67 of file actorsprite.h.

        { mId = id; }

References mId.

Referenced by EAthena::GameHandler::connect(), and TmwAthena::GameHandler::connect().

setMap()

void ActorSprite::setMap ( Map *const  map )

virtual

Reimplemented from Actor.

Reimplemented in LocalPlayer, and Being.

Definition at line 139 of file actorsprite.cpp.

{
    Actor::setMap(map);
 
    // Clear particle effect list because child particles became invalid
    mChildParticleEffects.clear();
    mMustResetParticles = true;  // Reset status particles on next redraw
}

References ParticleContainer::clear(), mChildParticleEffects, mMustResetParticles, and Actor::setMap().

Referenced by FloorItem::postInit(), and Being::setMap().

setPoison()

void ActorSprite::setPoison ( const bool  b )

inline

Definition at line 166 of file actorsprite.h.

        { mPoison = b; }

References mPoison.

Referenced by updateStatusEffect().

setRiding()

virtual void ActorSprite::setRiding ( const bool  b )

inlinevirtual

Reimplemented in Being.

Definition at line 178 of file actorsprite.h.

        { mHorseId = b ? 1 : 0; }

References mHorseId.

Referenced by updateStatusEffect().

setStatusEffect()

void ActorSprite::setStatusEffect	(	const int32_t	index,
		const Enable	active,
		const IsStart	start
	)

Definition at line 198 of file actorsprite.cpp.

{
    const Enable wasActive = fromBool(
        mStatusEffects.find(index) != mStatusEffects.end(), Enable);
 
    if (active != wasActive)
    {
        updateStatusEffect(index, active, start);
        if (active == Enable_true)
        {
            mStatusEffects.insert(index);
        }
        else
        {
            mStatusEffects.erase(index);
        }
    }
}

References Enable_true, fromBool, mStatusEffects, anonymous_namespace{stringutils.cpp}::start, and updateStatusEffect().

Referenced by applyEffectByOption(), applyEffectByOption1(), EAthena::BeingRecv::processBeingStatusChange(), and TmwAthena::BeingRecv::processBeingStatusChange().

setStatusEffectOpiton0()

void ActorSprite::setStatusEffectOpiton0

(

const uint32_t

option

)

Definition at line 311 of file actorsprite.cpp.

{
    applyEffectByOption(this, option, "option",
        StatusEffectDB::getOptionMap());
}

References applyEffectByOption(), and StatusEffectDB::getOptionMap().

Referenced by EAthena::BeingRecv::processPlayerStatusChange2().

setStatusEffectOpitons() [1/2]

void ActorSprite::setStatusEffectOpitons	(	const uint32_t	option,
		const uint32_t	opt1,
		const uint32_t	opt2
	)

Definition at line 299 of file actorsprite.cpp.

{
    applyEffectByOption(this, option, "option",
        StatusEffectDB::getOptionMap());
    applyEffectByOption1(this, opt1, "opt1",
        StatusEffectDB::getOpt1Map());
    applyEffectByOption(this, opt2, "opt2",
        StatusEffectDB::getOpt2Map());
}

References applyEffectByOption(), applyEffectByOption1(), StatusEffectDB::getOpt1Map(), StatusEffectDB::getOpt2Map(), and StatusEffectDB::getOptionMap().

setStatusEffectOpitons() [2/2]

void ActorSprite::setStatusEffectOpitons	(	const uint32_t	option,
		const uint32_t	opt1,
		const uint32_t	opt2,
		const uint32_t	opt3
	)

Definition at line 284 of file actorsprite.cpp.

{
    applyEffectByOption(this, option, "option",
        StatusEffectDB::getOptionMap());
    applyEffectByOption1(this, opt1, "opt1",
        StatusEffectDB::getOpt1Map());
    applyEffectByOption(this, opt2, "opt2",
        StatusEffectDB::getOpt2Map());
    applyEffectByOption(this, opt3, "opt3",
        StatusEffectDB::getOpt3Map());
}

References applyEffectByOption(), applyEffectByOption1(), StatusEffectDB::getOpt1Map(), StatusEffectDB::getOpt2Map(), StatusEffectDB::getOpt3Map(), and StatusEffectDB::getOptionMap().

Referenced by EAthena::BeingRecv::processBeingMove(), TmwAthena::BeingRecv::processBeingMove(), EAthena::BeingRecv::processBeingSpawn(), EAthena::BeingRecv::processBeingVisible(), TmwAthena::BeingRecv::processBeingVisible(), TmwAthena::BeingRecv::processPlayerMove(), EAthena::BeingRecv::processPlayerStatusChange(), TmwAthena::BeingRecv::processPlayerStatusChange(), TmwAthena::BeingRecv::processPlayerUpdate1(), and TmwAthena::BeingRecv::processPlayerUpdate2().

setTargetType()

void ActorSprite::setTargetType

(

const TargetCursorTypeT

type

)

Sets the target animation for this actor.

Definition at line 173 of file actorsprite.cpp.

{
    if (type == TargetCursorType::NONE)
    {
        untarget();
    }
    else
    {
        const size_t sz = CAST_SIZE(getTargetCursorSize());
        mUsedTargetCursor = targetCursor[CAST_S32(type)][sz];
        if (mUsedTargetCursor != nullptr)
        {
            static const int targetWidths[CAST_SIZE(
                TargetCursorSize::NUM_TC)]
                = {0, 0, 0};
            static const int targetHeights[CAST_SIZE(
                TargetCursorSize::NUM_TC)]
                = {-mapTileSize / 2, -mapTileSize / 2, -mapTileSize};
 
            mCursorPaddingX = CAST_S32(targetWidths[sz]);
            mCursorPaddingY = CAST_S32(targetHeights[sz]);
        }
    }
}

References CAST_S32, CAST_SIZE, getTargetCursorSize(), mapTileSize, mCursorPaddingX, mCursorPaddingY, mUsedTargetCursor, TargetCursorType::NONE, TargetCursorSize::NUM_TC, targetCursor, and untarget().

Referenced by LocalPlayer::logic().

setTrickDead()

virtual void ActorSprite::setTrickDead ( const bool  b )

inlinevirtual

Reimplemented in Being.

Definition at line 181 of file actorsprite.h.

        { mTrickDead = b; }

References mTrickDead.

Referenced by updateStatusEffect().

setupSpriteDisplay()

void ActorSprite::setupSpriteDisplay ( const SpriteDisplay &  display, const ForceDisplay  forceDisplay, const DisplayTypeT  displayType, const std::string &  color  )

protected

Definition at line 365 of file actorsprite.cpp.

{
    clear();
 
    FOR_EACH (SpriteRefs, it, display.sprites)
    {
        if (*it == nullptr)
            continue;
        const std::string file = pathJoin(paths.getStringValue("sprites"),
            combineDye3((*it)->sprite, color));
 
        const int variant = (*it)->variant;
        addSprite(AnimatedSprite::delayedLoad(file, variant));
    }
 
    // Ensure that something is shown, if desired
    if (mSprites.empty() && forceDisplay == ForceDisplay_true)
    {
        if (display.image.empty())
        {
            addSprite(AnimatedSprite::delayedLoad(pathJoin(
                paths.getStringValue("sprites"),
                paths.getStringValue("spriteErrorFile")),
                0));
        }
        else
        {
            std::string imagePath;
            switch (displayType)
            {
                case DisplayType::Item:
                default:
                    imagePath = pathJoin(paths.getStringValue("itemIcons"),
                        display.image);
                    break;
                case DisplayType::Floor:
                    imagePath = pathJoin(paths.getStringValue("itemIcons"),
                        display.floor);
                    break;
            }
            imagePath = combineDye2(imagePath, color);
            Image *img = Loader::getImage(imagePath);
 
            if (img == nullptr)
                img = Theme::getImageFromTheme("unknown-item.png");
 
            addSprite(new ImageSprite(img));
            if (img != nullptr)
                img->decRef();
        }
    }
 
    mChildParticleEffects.clear();
 
    // setup particle effects
    if (ParticleEngine::enabled && (particleEngine != nullptr))
    {
        FOR_EACH (StringVectCIter, itr, display.particles)
        {
            Particle *const p = particleEngine->addEffect(*itr, 0, 0, 0);
            controlAutoParticle(p);
        }
    }
 
    mMustResetParticles = true;
}

References ParticleEngine::addEffect(), CompoundSprite::addSprite(), CompoundSprite::clear(), ParticleContainer::clear(), combineDye2(), combineDye3(), controlAutoParticle(), AnimatedSprite::delayedLoad(), ParticleEngine::enabled, DisplayType::Floor, SpriteDisplay::floor, FOR_EACH, ForceDisplay_true, Loader::getImage(), Theme::getImageFromTheme(), Configuration::getStringValue(), SpriteDisplay::image, DisplayType::Item, mChildParticleEffects, mMustResetParticles, CompoundSprite::mSprites, particleEngine, SpriteDisplay::particles, pathJoin(), paths, and SpriteDisplay::sprites.

Referenced by FloorItem::postInit().

stopCast()

virtual void ActorSprite::stopCast ( const bool  b )

inlinevirtual

Reimplemented in Being.

Definition at line 192 of file actorsprite.h.

        { }

Referenced by updateStatusEffect().

unload()

void ActorSprite::unload ( )

static

Definition at line 445 of file actorsprite.cpp.

{
    if (reportTrue(!loaded))
        return;
 
    cleanupTargetCursors();
    loaded = false;
}

References cleanupTargetCursors(), loaded, and reportTrue.

Referenced by load().

untarget()

void ActorSprite::untarget ( )

inline

Untargets the actor.

Definition at line 116 of file actorsprite.h.

        { mUsedTargetCursor = nullptr; }

References mUsedTargetCursor.

Referenced by LocalPlayer::setTarget(), and setTargetType().

updateStatusEffect()

void ActorSprite::updateStatusEffect ( const int32_t  index, const Enable  newStatus, const IsStart  start  )

protectedvirtual

Notify self that a status effect has flipped. The new flag is passed.

Definition at line 317 of file actorsprite.cpp.

{
    StatusEffect *const effect = StatusEffectDB::getStatusEffect(
        index, newStatus);
    if (effect == nullptr)
        return;
    if (effect->mIsPoison && getType() == ActorType::Player)
        setPoison(newStatus == Enable_true);
    else if (effect->mIsCart && localPlayer == this)
        setHaveCart(newStatus == Enable_true);
    else if (effect->mIsRiding)
        setRiding(newStatus == Enable_true);
    else if (effect->mIsTrickDead)
        setTrickDead(newStatus == Enable_true);
    else if (effect->mIsPostDelay)
        stopCast(newStatus == Enable_true);
    handleStatusEffect(effect, index, newStatus, start);
}

References Enable_true, StatusEffectDB::getStatusEffect(), getType(), handleStatusEffect(), localPlayer, StatusEffect::mIsCart, StatusEffect::mIsPoison, StatusEffect::mIsPostDelay, StatusEffect::mIsRiding, StatusEffect::mIsTrickDead, ActorType::Player, setHaveCart(), setPoison(), setRiding(), setTrickDead(), anonymous_namespace{stringutils.cpp}::start, and stopCast().

Referenced by logic(), and setStatusEffect().

Field Documentation

loaded

bool ActorSprite::loaded = false

staticprotected

set of active status effects

Definition at line 239 of file actorsprite.h.

Referenced by load(), and unload().

mActorSpriteListeners

ActorSpriteListeners ActorSprite::mActorSpriteListeners

protected

Definition at line 254 of file actorsprite.h.

Referenced by addActorSpriteListener(), removeActorSpriteListener(), and ~ActorSprite().

mChildParticleEffects

ParticleList ActorSprite::mChildParticleEffects

protected

Definition at line 245 of file actorsprite.h.

Referenced by controlAutoParticle(), controlCustomParticle(), controlParticleDeleted(), getParticlesCount(), logic(), Being::recreateItemParticles(), Being::removeSpecialEffect(), setMap(), LocalPlayer::setTestParticle(), setupSpriteDisplay(), and ~ActorSprite().

mCursorPaddingX

int ActorSprite::mCursorPaddingX

protected

Definition at line 256 of file actorsprite.h.

Referenced by Being::drawBeingCursor(), and setTargetType().

mCursorPaddingY

int ActorSprite::mCursorPaddingY

protected

Definition at line 257 of file actorsprite.h.

Referenced by Being::drawBeingCursor(), and setTargetType().

mHaveCart

bool ActorSprite::mHaveCart

protected

Definition at line 262 of file actorsprite.h.

Referenced by getHaveCart(), and setHaveCart().

mHorseId

int ActorSprite::mHorseId

protected

Definition at line 246 of file actorsprite.h.

Referenced by Being::getMoveAction(), Being::getSitAction(), and setRiding().

mId

BeingId ActorSprite::mId

protected

Definition at line 247 of file actorsprite.h.

Referenced by Being::clearGuilds(), controlAutoParticle(), getId(), setId(), and Being::talkTo().

mMustResetParticles

bool ActorSprite::mMustResetParticles

protected

Reset particle status effects on next redraw?

Definition at line 260 of file actorsprite.h.

Referenced by logic(), setMap(), setupSpriteDisplay(), and ~ActorSprite().

mPoison

bool ActorSprite::mPoison

protected

Definition at line 261 of file actorsprite.h.

Referenced by getPoison(), and setPoison().

mStatusEffects

std::set<int32_t> ActorSprite::mStatusEffects

protected

Definition at line 242 of file actorsprite.h.

Referenced by getStatusEffects(), getStatusEffectsString(), logic(), and setStatusEffect().

mStatusParticleEffects

ParticleVector ActorSprite::mStatusParticleEffects

protected

Definition at line 244 of file actorsprite.h.

Referenced by getParticlesCount(), and handleStatusEffect().

mTrickDead

bool ActorSprite::mTrickDead

protected

Definition at line 263 of file actorsprite.h.

Referenced by isTrickDead(), Being::serverRemove(), and setTrickDead().

mUsedTargetCursor

AnimatedSprite* ActorSprite::mUsedTargetCursor

protected

Target cursor being used

Definition at line 250 of file actorsprite.h.

Referenced by Being::drawBeingCursor(), setTargetType(), untarget(), and ~ActorSprite().

targetCursor

AnimatedSprite * ActorSprite::targetCursor

staticprotected

Animated target cursors.

Definition at line 235 of file actorsprite.h.

Referenced by cleanupTargetCursors(), initTargetCursor(), and setTargetType().

---

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

• src/being/actorsprite.h (986a3bf)
• src/being/actorsprite.cpp (986a3bf)