source:
code/branches/buildsystem3/src/orxonox/objects/quest/FailQuest.h
@
2736
Rev | Line | |
---|---|---|
[1992] | 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 | ||
[2261] | 29 | /** |
[2662] | 30 | @file |
31 | @brief Definition of the FailQuest class. | |
[2261] | 32 | */ |
33 | ||
[1992] | 34 | #ifndef _FailQuest_H__ |
35 | #define _FailQuest_H__ | |
36 | ||
[2095] | 37 | #include "OrxonoxPrereqs.h" |
38 | ||
[1992] | 39 | #include <string> |
40 | ||
[2076] | 41 | #include "core/XMLPort.h" |
[1992] | 42 | #include "ChangeQuestStatus.h" |
43 | ||
[2662] | 44 | namespace orxonox |
45 | { | |
[1992] | 46 | /** |
47 | @brief | |
[2261] | 48 | Fails a quest (with a specified id) for the player invoking the QuestEffect. |
49 | ||
50 | Creating a FailQuest through XML goes as follows: | |
51 | ||
52 | <FailQuest questId="id" /> //Where id is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and identifies the Quest that should be failed. | |
[1992] | 53 | @author |
[2093] | 54 | Damian 'Mozork' Frick |
[1992] | 55 | */ |
[2095] | 56 | class _OrxonoxExport FailQuest : public ChangeQuestStatus |
[1992] | 57 | { |
[2093] | 58 | public: |
[2092] | 59 | FailQuest(BaseObject* creator); |
[2093] | 60 | virtual ~FailQuest(); |
[2092] | 61 | |
[2261] | 62 | virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a FailQuest object through XML. |
[2092] | 63 | |
[2261] | 64 | virtual bool invoke(PlayerInfo* player); //!< Invokes the QuestEffect. |
[2092] | 65 | |
[1992] | 66 | }; |
67 | ||
68 | } | |
69 | ||
70 | #endif /* _FailQuest_H__ */ |
Note: See TracBrowser
for help on using the repository browser.