Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/effects/ChangeQuestStatus.cc @ 7456

Last change on this file since 7456 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.3 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 ChangeQuestStatus.cc
31    @brief Implementation of the ChangeQuestStatus class.
32    @ingroup QuestEffects
33*/
34
35#include "ChangeQuestStatus.h"
36
37#include "core/CoreIncludes.h"
38#include "core/XMLPort.h"
39
40#include "questsystem/QuestItem.h"
41
42namespace orxonox
43{
44    /**
45    @brief
46        Constructor. Registers the object.
47    */
48    ChangeQuestStatus::ChangeQuestStatus(BaseObject* creator) : QuestEffect(creator)
49    {
50        RegisterObject(ChangeQuestStatus);
51    }
52
53    /**
54    @brief
55        Destructor.
56    */
57    ChangeQuestStatus::~ChangeQuestStatus()
58    {
59
60    }
61
62    /**
63    @brief
64        Method for creating a ChangeQuestStatus object through XML.
65    */
66    void ChangeQuestStatus::XMLPort(Element& xmlelement, XMLPort::Mode mode)
67    {
68        SUPER(ChangeQuestStatus, XMLPort, xmlelement, mode);
69
70        XMLPortParam(ChangeQuestStatus, "questId", setQuestId, getQuestId, xmlelement, mode);
71    }
72
73    /**
74    @brief
75        Sets the id of the Quest the Questffect changes the status of.
76    @param id
77        The id of the Quest.
78    @return
79        Returns true if successful.
80    */
81    bool ChangeQuestStatus::setQuestId(const std::string & id)
82    {
83        if(id.compare(BLANKSTRING) == 0)
84        {
85            COUT(2) << "Invalid id. QuestItem id {" << id << "} could not be set." << std::endl;
86            return false;
87        }
88
89        this->questId_ = id;
90        return true;
91    }
92
93}
Note: See TracBrowser for help on using the repository browser.