source:
code/branches/presentation/src/orxonox/objects/quest/ChangeQuestStatus.h
@
2677
Line | |
---|---|
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 | /** |
30 | @file |
31 | @brief Definition of the ChangeQuestStatus class. |
32 | */ |
33 | |
34 | #ifndef _ChangeQuestStatus_H__ |
35 | #define _ChangeQuestStatus_H__ |
36 | |
37 | #include "OrxonoxPrereqs.h" |
38 | |
39 | #include <string> |
40 | |
41 | #include "core/XMLPort.h" |
42 | #include "QuestEffect.h" |
43 | |
44 | namespace orxonox |
45 | { |
46 | /** |
47 | @brief |
48 | A QuestEffect which changes the status of a specified Quest for the player invoking the QuestEffect. |
49 | @author |
50 | Damian 'Mozork' Frick |
51 | */ |
52 | class _OrxonoxExport ChangeQuestStatus : public QuestEffect |
53 | { |
54 | public: |
55 | ChangeQuestStatus(BaseObject* creator); |
56 | virtual ~ChangeQuestStatus(); |
57 | |
58 | virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a ChangeQuestStatus object through XML. |
59 | |
60 | virtual bool invoke(PlayerInfo* player) = 0; //!< Invokes the QuestEffect. |
61 | |
62 | protected: |
63 | /** |
64 | @brief Returns the id of the Quest. |
65 | @return Returns the id of the Quest. |
66 | */ |
67 | inline const std::string & getQuestId(void) const |
68 | { return this->questId_; } |
69 | |
70 | private: |
71 | std::string questId_; //!< The id of the Quest the status should be changed of. |
72 | |
73 | bool setQuestId(const std::string & id); //!< Sets the id of the Quest. |
74 | |
75 | }; |
76 | |
77 | } |
78 | |
79 | #endif /* _ChangeQuestStatus_H__ */ |
Note: See TracBrowser
for help on using the repository browser.