Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem2/src/orxonox/objects/quest/QuestDescription.h @ 2159

Last change on this file since 2159 was 2159, checked in by dafrick, 15 years ago

Completed documentation of finished classes.

File size: 2.4 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
32        Definition of the QuestDescription class.
33*/
34
35#ifndef _QuestDescription_H__
36#define _QuestDescription_H__
37
38#include "OrxonoxPrereqs.h"
39
40#include <string>
41
42#include "core/BaseObject.h"
43#include "core/XMLPort.h"
44
45namespace orxonox {
46
47    /**
48    @brief
49        This class is a description of a QuestItem.
50        It holds a title and a description.
51    @author
52        Damian 'Mozork' Frick
53    */
54    class _OrxonoxExport QuestDescription : public BaseObject {
55
56        public:
57            QuestDescription(BaseObject* creator);
58            virtual ~QuestDescription();
59
60            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a QuestDescription object through XML.
61
62            inline const std::string & getTitle(void) const //!< Returns the title.
63                { return this->title_; }
64            inline const std::string & getDescription(void) const //!< Returns the description text.
65                { return this->description_; }
66
67        private:
68            std::string title_; //!< The title.
69            std::string description_; //!< The description.
70
71            inline void setTitle(const std::string & title) //!< Sets the title.
72                { this->title_ = title; }
73            inline void setDescription(const std::string & description) //!< Sets the description text.
74                { this->description_ = description; }
75
76    };
77
78}
79
80#endif /* _QuestDescription_H__ */
Note: See TracBrowser for help on using the repository browser.