1 | /* |
---|
2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
3 | * > www.orxonox.net < |
---|
4 | * |
---|
5 | * |
---|
6 | * License notice: |
---|
7 | * |
---|
8 | * This program is free software; you can redistribute it and/or |
---|
9 | * modify it under the terms of the GNU General Public License |
---|
10 | * as published by the Free Software Foundation; either version 2 |
---|
11 | * of the License, or (at your option) any later version. |
---|
12 | * |
---|
13 | * This program is distributed in the hope that it will be useful, |
---|
14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
16 | * GNU General Public License for more details. |
---|
17 | * |
---|
18 | * You should have received a copy of the GNU General Public License |
---|
19 | * along with this program; if not, write to the Free Software |
---|
20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
21 | * |
---|
22 | * Author: |
---|
23 | * Damian 'Mozork' Frick |
---|
24 | * Co-authors: |
---|
25 | * ... |
---|
26 | * |
---|
27 | */ |
---|
28 | |
---|
29 | #ifndef _QuestEffectBeacon_H__ |
---|
30 | #define _QuestEffectBeacon_H__ |
---|
31 | |
---|
32 | #include "OrxonoxPrereqs.h" |
---|
33 | |
---|
34 | #include "orxonox/objects/worldentities/PositionableEntity.h" |
---|
35 | |
---|
36 | namespace QuestEffectBeaconStatus |
---|
37 | { |
---|
38 | |
---|
39 | enum Enum |
---|
40 | { |
---|
41 | inactive, |
---|
42 | active |
---|
43 | }; |
---|
44 | |
---|
45 | } |
---|
46 | |
---|
47 | namespace orxonox { |
---|
48 | |
---|
49 | /** |
---|
50 | @brief |
---|
51 | A QuestEffectBeacon is an entity which can (under some condition(s)) invoke a number QuestEffects on players meeting the condition(s). |
---|
52 | The conditions under which the QuestEffects are invoked on the player are defined by Triggers. |
---|
53 | A QuestEffectBeacon can be executed a defined number of times. |
---|
54 | @author |
---|
55 | Damian 'Mozork' Frick |
---|
56 | */ |
---|
57 | class _OrxonoxExport QuestEffectBeacon : public PositionableEntity |
---|
58 | { |
---|
59 | public: |
---|
60 | QuestEffectBeacon(BaseObject* creator); |
---|
61 | virtual ~QuestEffectBeacon(); |
---|
62 | |
---|
63 | virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); |
---|
64 | |
---|
65 | virtual void processEvent(Event& event); |
---|
66 | |
---|
67 | bool execute(bool b, PlayerTrigger* trigger); //!< Executes the QuestEffects of the QuestEffectBeacon. |
---|
68 | |
---|
69 | bool isActive(void); //!< Test whether the QuestEffectBeacon is active. |
---|
70 | |
---|
71 | protected: |
---|
72 | bool decrementTimes(void); //!< Decrement the number of times the QuestEffectBeacon can still be executed. |
---|
73 | |
---|
74 | inline const int & getTimes(void) const //!< Return the number of times the QUestEffectBeacon can still be executed. |
---|
75 | { return this->times_; } |
---|
76 | |
---|
77 | private: |
---|
78 | std::list<QuestEffect*> effects_; //!< The list of QuestEffects to be invoked on the executing player. |
---|
79 | int times_; //!< Number of times the beacon can be exectued. |
---|
80 | QuestEffectBeaconStatus::Enum status_; //!< The status of the QUestEffectBeacon, Can be eighter active or inactive. |
---|
81 | PlayerTrigger* trigger_; |
---|
82 | |
---|
83 | bool setTimes(const int & n); //!< Set the number of times the QuestEffectBeacon can be executed. |
---|
84 | bool addEffect(QuestEffect* effect); |
---|
85 | bool addTrigger(PlayerTrigger* trigger); |
---|
86 | |
---|
87 | const QuestEffect* getEffect(unsigned int index) const; |
---|
88 | const PlayerTrigger* getTrigger(unsigned int index) const; |
---|
89 | |
---|
90 | }; |
---|
91 | |
---|
92 | } |
---|
93 | |
---|
94 | #endif /* _QuestEffectBeacon_H__ */ |
---|