source:
code/branches/buildsystem3/src/orxonox/objects/quest/AddQuestHint.h
@
2736
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 AddQuestHint class. |
32 | */ |
33 | |
34 | #ifndef _AddQuestHint_H__ |
35 | #define _AddQuestHint_H__ |
36 | |
37 | #include "OrxonoxPrereqs.h" |
38 | |
39 | #include <string> |
40 | |
41 | #include "QuestEffect.h" |
42 | |
43 | namespace orxonox |
44 | { |
45 | /** |
46 | @brief |
47 | Adds a QuestHint, resp. activates the QuestHint of the given id for the player the QuestEffect is invoked on. |
48 | |
49 | Creating a AddQuestHint through XML goes as follows: |
50 | |
51 | <AddQuestHint hintId="id" /> //Where id is a GUID, see http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure for more information, and identifies the QuestHint that should be added. |
52 | @author |
53 | Damian 'Mozork' Frick |
54 | */ |
55 | class _OrxonoxExport AddQuestHint : public QuestEffect |
56 | { |
57 | public: |
58 | AddQuestHint(BaseObject* creator); |
59 | virtual ~AddQuestHint(); |
60 | |
61 | virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a AddQuestHint object through XML. |
62 | |
63 | virtual bool invoke(PlayerInfo* player); //!< Invokes the QuestEffect. |
64 | |
65 | private: |
66 | std::string hintId_; //!< The id of the QuestHint. |
67 | |
68 | /** |
69 | @brief Returns the id of the QuestHint. |
70 | @return Returns the id of the QuestHint. |
71 | */ |
72 | inline const std::string & getHintId(void) const |
73 | { return this->hintId_; } |
74 | |
75 | bool setHintId(const std::string & id); //!< Sets the id of the QuestHint. |
76 | |
77 | }; |
78 | |
79 | } |
80 | |
81 | #endif /* _AddQuestHint_H__ */ |
Note: See TracBrowser
for help on using the repository browser.