Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/masterserver/src/modules/questsystem/effects/AddQuest.cc @ 7501

Last change on this file since 7501 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.8 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 AddQuest.cc
31    @brief Implementation of the AddQuest class.
32*/
33
34#include "AddQuest.h"
35
36#include "core/CoreIncludes.h"
37#include "core/XMLPort.h"
38#include "util/Exception.h"
39
40#include "questsystem/Quest.h"
41#include "questsystem/QuestManager.h"
42
43namespace orxonox
44{
45    CreateFactory(AddQuest);
46
47    /**
48    @brief
49        Constructor. Registers the object.
50    */
51    AddQuest::AddQuest(BaseObject* creator) : ChangeQuestStatus(creator)
52    {
53        RegisterObject(AddQuest);
54    }
55
56    /**
57    @brief
58        Destructor.
59    */
60    AddQuest::~AddQuest()
61    {
62    }
63
64    /**
65    @brief
66        Method for creating a AddQuest object through XML.
67    */
68    void AddQuest::XMLPort(Element& xmlelement, XMLPort::Mode mode)
69    {
70        SUPER(AddQuest, XMLPort, xmlelement, mode);
71
72        COUT(4) << "New AddQuest, with target Quest {" << this->getQuestId() << "}, created." << std::endl;
73    }
74
75    /**
76    @brief
77        Invokes the QuestEffect.
78    @param player
79        The player the QuestEffect is invoked on.
80    @return
81        Returns true if the QuestEffect was successfully invoked.
82    */
83    bool AddQuest::invoke(PlayerInfo* player)
84    {
85        //TODO: Replace with assert?
86        if(player == NULL) // Null-pointers are badass.
87        {
88            COUT(2) << "Input player is NULL." << std::endl;
89            return false;
90        }
91
92        COUT(5) << "AddQuest on player: " << player << " ." << std::endl;
93
94        try
95        {
96            Quest* quest = QuestManager::getInstance().findQuest(this->getQuestId());
97            if(quest == NULL || !quest->start(player))
98               return false;
99        }
100        catch(const orxonox::Exception& ex)
101        {
102            COUT(2) << ex.getFullDescription() << std::endl;
103            return false;
104        }
105
106        COUT(4) << "Quest {" << this->getQuestId() << "} successfully added to player: " << player << " ." << std::endl;
107        return true;
108    }
109
110
111}
Note: See TracBrowser for help on using the repository browser.