#include <statuseffect.h>

Classes
struct	Event

Public Member Functions
	StatusEffect ()=default

void	playSfx (bool enabled) const
	Plays the sound effect associated with this status effect, if possible.

void	deliverMessage (bool enabled) const
	Delivers the chat message associated with this status effect, if possible.

Particle *	getParticle (bool enabled) const
	Creates the particle effect associated with this status effect, if possible.

Sprite *	getIconSprite () const
	Retrieves the status icon for this effect, if applicable.

Public Attributes
std::string	name

Event	start

Event	end

std::string	icon

bool	persistentParticleEffect = false
	Determines whether the particle effect should be restarted when the being changes maps.

Detailed Description

Definition at line 29 of file statuseffect.h.

Constructor & Destructor Documentation

◆ StatusEffect()

StatusEffect::StatusEffect ( )

default

Member Function Documentation

◆ deliverMessage()

void StatusEffect::deliverMessage ( bool enabled ) const

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

Definition at line 44 of file statuseffect.cpp.

◆ getIconSprite()

Sprite * StatusEffect::getIconSprite ( ) const

Retrieves the status icon for this effect, if applicable.

Definition at line 66 of file statuseffect.cpp.

◆ getParticle()

Particle * StatusEffect::getParticle ( bool enabled ) const

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

Definition at line 55 of file statuseffect.cpp.

◆ playSfx()

void StatusEffect::playSfx ( bool enabled ) const

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

Definition at line 33 of file statuseffect.cpp.

Member Data Documentation

◆ end

Event StatusEffect::end

Definition at line 41 of file statuseffect.h.

◆ icon

std::string StatusEffect::icon

Definition at line 42 of file statuseffect.h.

◆ name

std::string StatusEffect::name

Definition at line 39 of file statuseffect.h.

◆ persistentParticleEffect

bool StatusEffect::persistentParticleEffect = false

Determines whether the particle effect should be restarted when the being changes maps.

Definition at line 48 of file statuseffect.h.

◆ start

Event StatusEffect::start

Definition at line 40 of file statuseffect.h.

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

src/statuseffect.h
src/statuseffect.cpp

Classes

Public Member Functions

Public Attributes