Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutorial2/src/modules/questsystem/QuestItem.cc @ 7441

Last change on this file since 7441 was 7401, checked in by landauf, 14 years ago

merged doc branch back to trunk

  • Property svn:eol-style set 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/**
30    @file
31    @brief Implementation of the QuestItem class.
32*/
33
34#include "QuestItem.h"
35
36#include "core/CoreIncludes.h"
37#include "core/XMLPort.h"
38#include "QuestDescription.h"
39
40namespace orxonox
41{
42
43    CreateUnloadableFactory(QuestItem);
44
45    /**
46    @brief
47        Constructor. Registers and initializes the object.
48    */
49    QuestItem::QuestItem(BaseObject* creator) : BaseObject(creator)
50    {
51        this->registered_ = false;
52
53        RegisterObject(QuestItem);
54    }
55
56    /**
57    @brief
58        Destructor.
59    */
60    QuestItem::~QuestItem()
61    {
62
63    }
64
65    /**
66    @brief
67        Method for creating a QuestItem object through XML.
68    */
69    void QuestItem::XMLPort(Element& xmlelement, XMLPort::Mode mode)
70    {
71        SUPER(QuestItem, XMLPort, xmlelement, mode);
72
73        XMLPortParam(QuestItem, "id", setId, getId, xmlelement, mode);
74        XMLPortObject(QuestItem, QuestDescription, "", setDescription, getDescription, xmlelement, mode);
75    }
76
77    /**
78    @brief
79        Sets the id of the QuestItem.
80        The id can be any string and must be unique in the context it is used (commonly a level file). To ensure uniqueness one could use GUIDs, however they are in general less readable, so make your own choice.
81    @see
82        http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure
83    @param id
84        The id to be set.
85    */
86    void QuestItem::setId(const std::string & id)
87    {
88        if(id.compare(BLANKSTRING) == 0) //!< Checks whether the id is a valid id.
89        {
90            COUT(2) << "Invalid id. QuestItem id {" << id << "} could not be set." << std::endl;
91            return;
92        }
93
94        this->id_ = id;
95    }
96
97}
Note: See TracBrowser for help on using the repository browser.