Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/objects/quest/AddQuestHint.cc @ 2327

Last change on this file since 2327 was 2261, checked in by landauf, 16 years ago

merged questsystem2 back to trunk

File size: 3.5 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 AddQuestHint.cc
31    @brief
32    Implementation of the AddQuestHint class.
33*/
34
35#include "OrxonoxStableHeaders.h"
36#include "AddQuestHint.h"
37
38#include "core/CoreIncludes.h"
39#include "util/Exception.h"
40
41#include "orxonox/objects/infos/PlayerInfo.h"
42#include "QuestManager.h"
43#include "QuestItem.h"
44#include "QuestHint.h"
45
46namespace orxonox {
47
48    CreateFactory(AddQuestHint);
49
50    /**
51    @brief
52        Constructor. Registers the object.
53    */
54    AddQuestHint::AddQuestHint(BaseObject* creator) : QuestEffect(creator)
55    {
56        RegisterObject(AddQuestHint);
57    }
58
59    /**
60    @brief
61        Destructor.
62    */
63    AddQuestHint::~AddQuestHint()
64    {
65    }
66
67    /**
68    @brief
69        Method for creating a AddQuestHint object through XML.
70    */
71    void AddQuestHint::XMLPort(Element& xmlelement, XMLPort::Mode mode)
72    {
73        SUPER(AddQuestHint, XMLPort, xmlelement, mode);
74
75        XMLPortParam(AddQuestHint, "hintId", setHintId, getHintId, xmlelement, mode);
76       
77        COUT(3) << "New AddQuestHint, with target QuestHint {" << this->getHintId() << "}, created." << std::endl;
78    }
79
80    /**
81    @brief
82        Sets the id of the QuestHint to be added to the player the QuestEffect is invoked on.
83    @param id
84        The QuestHint id.
85    @param
86        Returns true if successful.
87    */
88    bool AddQuestHint::setHintId(const std::string & id)
89    {
90        if(!QuestItem::isId(id))
91        {
92            COUT(2) << "Invalid id. QuestItem id {" << id << "} could not be set." << std::endl;
93            return false;
94        }
95       
96        this->hintId_ = id;
97        return true;
98    }
99
100    /**
101    @brief
102        Invokes the QuestEffect.
103    @param player
104        The player.
105    @return
106        Returns true if the QuestEffect was successfully invoked.
107    */
108    bool AddQuestHint::invoke(PlayerInfo* player)
109    {
110        if(player == NULL) //!< NULL-pointers are evil!
111        {
112            COUT(2) << "The input player is NULL." << std::endl;
113            return false;
114        }
115
116        COUT(3) << "AddQuestHint on player: " << player << " ." << std::endl;
117
118        try
119        {
120            QuestHint* hint = QuestManager::findHint(this->hintId_);
121            if(hint == NULL || !hint->setActive(player))
122            {
123                return false;
124            }
125        }
126        catch(const Exception& e)
127        {
128           COUT(2) << e.getFullDescription() << std::endl;
129           return false;
130        }
131
132        COUT(3) << "QuestHint {" << this->getHintId() << "} successfully added to player." << std::endl;
133        return true;
134
135    }
136}
Note: See TracBrowser for help on using the repository browser.