Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

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

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

Completed documentation of finished classes.

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