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