Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/QuestItem.cc @ 7915

Last change on this file since 7915 was 7456, checked in by dafrick, 14 years ago

Reviewing documentation fo Questsystem, moving documentation fully into doxygen.
Added some files to modules they belong to.

  • Property svn:eol-style set to native
File size: 2.6 KB
RevLine 
[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 */
[6417]28
[2261]29/**
[7456]30    @file QuestItem.cc
[2662]31    @brief Implementation of the QuestItem class.
[2261]32*/
[1992]33
[2105]34#include "QuestItem.h"
35
[1992]36#include "core/CoreIncludes.h"
[3196]37#include "core/XMLPort.h"
[7456]38
[2095]39#include "QuestDescription.h"
[1992]40
[2662]41namespace orxonox
42{
[7163]43
44    CreateUnloadableFactory(QuestItem);
45
[2261]46    /**
47    @brief
48        Constructor. Registers and initializes the object.
49    */
[2092]50    QuestItem::QuestItem(BaseObject* creator) : BaseObject(creator)
[2021]51    {
[7163]52        this->registered_ = false;
53
[2092]54        RegisterObject(QuestItem);
[2021]55    }
[2092]56
[1992]57    /**
58    @brief
59        Destructor.
60    */
61    QuestItem::~QuestItem()
62    {
[2092]63
[1992]64    }
[2092]65
[2261]66    /**
67    @brief
68        Method for creating a QuestItem object through XML.
69    */
[2068]70    void QuestItem::XMLPort(Element& xmlelement, XMLPort::Mode mode)
71    {
72        SUPER(QuestItem, XMLPort, xmlelement, mode);
[2092]73
[2068]74        XMLPortParam(QuestItem, "id", setId, getId, xmlelement, mode);
75        XMLPortObject(QuestItem, QuestDescription, "", setDescription, getDescription, xmlelement, mode);
76    }
77
[1992]78    /**
79    @brief
[2261]80        Sets the id of the QuestItem.
[7401]81        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.
82    @see
83        http://en.wikipedia.org/wiki/Globally_Unique_Identifier#Basic_structure
[2261]84    @param id
85        The id to be set.
[1992]86    */
[2081]87    void QuestItem::setId(const std::string & id)
88    {
[7456]89        if(id.compare(BLANKSTRING) == 0) // Checks whether the id is a valid id.
[2081]90        {
91            COUT(2) << "Invalid id. QuestItem id {" << id << "} could not be set." << std::endl;
92            return;
93        }
[6417]94
[2081]95        this->id_ = id;
96    }
[2092]97
[1992]98}
Note: See TracBrowser for help on using the repository browser.