Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/objects/quest/QuestDescription.h @ 3222

Last change on this file since 3222 was 3196, checked in by rgrieder, 15 years ago

Merged pch branch back to trunk.

  • Property svn:eol-style set to native
File size: 5.7 KB
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 QuestDescription class.
32*/
33
34#ifndef _QuestDescription_H__
35#define _QuestDescription_H__
36
37#include "OrxonoxPrereqs.h"
38
39#include <string>
40#include "core/BaseObject.h"
41
42// tolua_begin
43namespace orxonox
44{
45    /**
46    @brief
47        This class is a description of a QuestItem.
48        It holds a title and a description.
49       
50        Creating a QuestDescription through XML goes as follows:
51       
52        <QuestDescription title="Title" description="Description Text" failMessage="You fail." completeMessage="You win!" />
53    @author
54        Damian 'Mozork' Frick
55    */
56    class _OrxonoxExport QuestDescription
57// tolua_end
58        : public BaseObject
59    { // tolua_export
60        public:
61            QuestDescription(BaseObject* creator);
62            virtual ~QuestDescription();
63
64            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestDescription object through XML.
65
66// tolua_begin
67            /**
68            @brief Returns the title.
69            @return Returns a string containing the title of the QuestDescription.
70            */
71            inline const std::string & getTitle(void) const
72                { return this->title_; }
73       
74            /**
75            @brief Returns the description text.
76            @return Returns a string containing the description text of the QuestDescription.
77            */
78            inline const std::string & getDescription(void) const
79                { return this->description_; }
80// tolua_end
81       
82            /**
83            @brief Returns the fail message.
84            @return Returns a string containing the fail message of the QuestDescription.
85            */
86            inline const std::string & getFailMessage(void) const
87                { return this->failMessage_; }
88       
89            /**
90            @brief Returns the complete message.
91            @return Returns a string containing the complete message of the QuestDescription.
92            */
93            inline const std::string & getCompleteMessage(void) const
94                { return this->completeMessage_; }
95       
96            /**
97            @brief Sends a Notification displaying that a QuestHint was added.
98            @return Returns true if successful.
99            */
100            inline bool sendAddHintNotification(void) const
101                { return notificationHelper("hint", ""); }
102       
103            /**
104            @brief Sends a Notification displaying that a Quest was added.
105            @return Returns true if successful.
106            */
107            inline bool sendAddQuestNotification(void) const
108                { return notificationHelper("quest", "start"); }
109       
110            /**
111            @brief Sends a Notification displaying that a Quest was failed.
112            @return Returns true if successful.
113            */
114            inline bool sendFailQuestNotification(void) const
115                { return notificationHelper("quest", "fail"); }
116       
117            /**
118            @brief Sends a Notification displaying that a Quest was completed.
119            @return Returns true if successful.
120            */
121            inline bool sendCompleteQuestNotification(void) const
122                { return notificationHelper("quest", "complete"); }
123
124        private:
125            std::string title_; //!< The title.
126            std::string description_; //!< The description.
127            std::string failMessage_; //!< The message displayed when the Quest is failed.
128            std::string completeMessage_; //!< The message displayed when the Quest is completed.
129
130            bool notificationHelper(const std::string & item, const std::string & status) const; //!< Helper for sending QuestDescriptions as Notifications.
131
132            /**
133            @brief Sets the title.
134            @param title The title to be set.
135            */
136            inline void setTitle(const std::string & title)
137                { this->title_ = title; }
138               
139            /**
140            @brief Sets the description text.
141            @param description The description text to be set.
142            */
143            inline void setDescription(const std::string & description)
144                { this->description_ = description; }
145
146            /**
147            @brief Sets the fail message.
148            @param message The fail message to be set.
149            */
150            inline void setFailMessage(const std::string & message)
151                { this->failMessage_ = message; }
152               
153            /**
154            @brief Sets the complete message.
155            @param message The complete message to be set.
156            */
157            inline void setCompleteMessage(const std::string & message)
158                { this->completeMessage_ = message; }
159
160    }; // tolua_export
161
162} // tolua_export
163
164#endif /* _QuestDescription_H__ */
Note: See TracBrowser for help on using the repository browser.