1 /* 2 * The ManaPlus Client 3 * Copyright (C) 2008-2009 The Mana World Development Team 4 * Copyright (C) 2009-2010 The Mana Developers 5 * Copyright (C) 2011-2019 The ManaPlus Developers 6 * Copyright (C) 2019-2021 Andrei Karas 7 * 8 * This file is part of The ManaPlus Client. 9 * 10 * This program is free software; you can redistribute it and/or modify 11 * it under the terms of the GNU General Public License as published by 12 * the Free Software Foundation; either version 2 of the License, or 13 * any later version. 14 * 15 * This program is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU General Public License for more details. 19 * 20 * You should have received a copy of the GNU General Public License 21 * along with this program. If not, see <http://www.gnu.org/licenses/>. 22 */ 23 24 #ifndef STATUSEFFECT_H 25 #define STATUSEFFECT_H 26 27 #include <string> 28 29 #include "localconsts.h" 30 31 class AnimatedSprite; 32 class Particle; 33 34 class StatusEffect final 35 { 36 public: 37 StatusEffect(); 38 39 A_DELETE_COPY(StatusEffect) 40 41 ~StatusEffect(); 42 43 /** 44 * Plays the sound effect associated with this status effect, if 45 * possible. 46 */ 47 void playSFX() const; 48 49 /** 50 * Delivers the chat message associated with this status effect, if 51 * possible. 52 */ 53 void deliverMessage() const; 54 55 /** 56 * Creates the particle effect associated with this status effect, if 57 * possible. 58 */ 59 Particle *getStartParticle() const A_WARN_UNUSED; 60 61 /** 62 * Creates the particle effect associated with this status effect, if 63 * possible. 64 */ 65 Particle *getParticle() const A_WARN_UNUSED; 66 67 /** 68 * Retrieves the status icon for this effect, if applicable 69 */ 70 AnimatedSprite *getIcon() const A_WARN_UNUSED; 71 72 /** 73 * Retrieves an action to perform, or SpriteAction::INVALID 74 */ 75 std::string getAction() const A_WARN_UNUSED; 76 77 std::string mMessage; 78 std::string mSFXEffect; 79 std::string mStartParticleEffect; 80 std::string mParticleEffect; 81 std::string mIcon; 82 std::string mAction; 83 std::string mName; 84 bool mIsPersistent; 85 bool mIsPoison; 86 bool mIsCart; 87 bool mIsRiding; 88 bool mIsTrickDead; 89 bool mIsPostDelay; 90 }; 91 92 #endif // STATUSEFFECT_H 93