Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/weapon2/src/orxonox/objects/quest/QuestItem.h @ 2357

Last change on this file since 2357 was 2096, checked in by landauf, 16 years ago

merged weapon branch back to trunk
changed eol-style of all new files to native

File size: 2.6 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#ifndef _QuestItem_H__
30#define _QuestItem_H__
31
32#include "OrxonoxPrereqs.h"
33
34#include <string>
35
36#include "core/BaseObject.h"
37#include "core/XMLPort.h"
38
39namespace orxonox {
40
41
42    /**
43    @brief
44        Functions as a base class for Quest classes such as Quest or QuestHint.
45        Has a unique identifier and a description.
46    @author
47        Damian 'Mozork' Frick
48    */
49    class _OrxonoxExport QuestItem : public BaseObject
50    {
51
52        public:
53            QuestItem(BaseObject* creator);
54            virtual ~QuestItem();
55
56            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
57
58            inline const std::string & getId(void) const //!< Returns the id of this quest.
59                { return this->id_; }
60            inline const QuestDescription* getDescription(void) const //!< Returns the description of the QuestItem.
61                { return this->description_; }
62            //const QuestDescription* getDescription(unsigned int index) const; //!< Returns the description of the QuestItem.
63
64            static bool isId(const std::string & id); //!< Checks whether a given id is valid.
65
66        protected:
67            void setId(const std::string & id);
68            inline void setDescription(QuestDescription* description)
69                { this->description_ = description; }
70
71        private:
72            std::string id_; //!< Identifier. Should be of GUID form: http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure
73            QuestDescription* description_; //!< The description of the QuestItem.
74
75            void initialize(void); //!< Initializes the object.
76
77    };
78
79}
80
81#endif /* _QuestItem_H__ */
Note: See TracBrowser for help on using the repository browser.