Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem2/src/orxonox/objects/quest/ChangeQuestStatus.cc @ 2159

Last change on this file since 2159 was 2159, checked in by dafrick, 15 years ago

Completed documentation of finished classes.

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
32        Implementation of the ChangeQuestStatus class.
33*/
34
35#include "OrxonoxStableHeaders.h"
36#include "ChangeQuestStatus.h"
37
38#include "core/CoreIncludes.h"
39
40#include "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    @brief
63        Sets the id of the quest the effect chagnes the status of.
64    @param id
65        The id of the quest.
66    @return
67        Returns true if successful.
68    */
69    bool ChangeQuestStatus::setQuestId(const std::string & id)
70    {
71        if(!QuestItem::isId(id))
72        {
73            COUT(2) << "Invalid id. QuestItem id {" << id << "} could not be set." << std::endl;
74            return false;
75        }
76       
77        this->questId_ = id;
78        return true;
79    }
80
81    /**
82    @brief
83        Method for creating a ChangeQuestStatus object through XML.
84    */
85    void ChangeQuestStatus::XMLPort(Element& xmlelement, XMLPort::Mode mode)
86    {
87        SUPER(ChangeQuestStatus, XMLPort, xmlelement, mode);
88
89        XMLPortParam(ChangeQuestStatus, "questId", setQuestId, getQuestId, xmlelement, mode);
90    }
91
92}
Note: See TracBrowser for help on using the repository browser.