Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

Last change on this file since 3014 was 2963, checked in by dafrick, 16 years ago

Some Quest stuff, and the rest for the GUIOverlay I failed to commit before.

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