Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/questsystem2/src/orxonox/objects/quest/LocalQuest.cc @ 2275

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

Finalizing, found an error…

File size: 6.1 KB
RevLine 
[1992]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
[2146]29/**
30    @file LocalQuest.cc
31    @brief
[2251]32    Implementation of the LocalQuest class.
[2146]33*/
34
[2105]35#include "OrxonoxStableHeaders.h"
36#include "LocalQuest.h"
37
[1992]38#include "core/CoreIncludes.h"
[2068]39#include "util/Exception.h"
[1992]40
[2205]41#include "orxonox/objects/infos/PlayerInfo.h"
[2146]42#include "QuestEffect.h"
43
[1992]44namespace orxonox {
45
46    CreateFactory(LocalQuest);
47
[2146]48    /**
49    @brief
[2159]50        Constructor. Registers and initializes the object.
[2146]51    */
[2092]52    LocalQuest::LocalQuest(BaseObject* creator) : Quest(creator)
[2021]53    {
[2146]54        RegisterObject(LocalQuest);
55    }
[2092]56
[1992]57    /**
58    @brief
59        Destructor.
60    */
61    LocalQuest::~LocalQuest()
62    {
[2092]63
[1992]64    }
[2092]65
[2146]66    /**
67    @brief
68        Method for creating a LocalQuest object through XML.
69    */
[2076]70    void LocalQuest::XMLPort(Element& xmlelement, XMLPort::Mode mode)
71    {
72        SUPER(LocalQuest, XMLPort, xmlelement, mode);
73
[2081]74        COUT(3) << "New LocalQuest {" << this->getId() << "} created." << std::endl;
[2076]75    }
[2092]76
[2146]77    /**
78    @brief
[2191]79        Fails the Quest for a given player.
[2146]80        Invokes all the failEffects on the player.
81    @param player
82        The player.
83    @return
[2191]84        Returns true if the Quest could be failed, false if not.
[2146]85    */
[2205]86    bool LocalQuest::fail(PlayerInfo* player)
[2068]87    {
[2146]88        if(this->isFailable(player)) //!< Checks whether the quest can be failed.
89        {
90            this->setStatus(player, questStatus::failed);
[2159]91            QuestEffect::invokeEffects(player, this->getFailEffectList()); //!< Invoke the failEffects.
[2146]92            return true;
93        }
94       
[2251]95        COUT(4) << "A non-failable quest was trying to be failed." << std::endl;
[2146]96        return false;
[2068]97    }
[2092]98
[1992]99    /**
100    @brief
[2191]101        Completes the Quest for a given player.
[2251]102    Invokes all the complete QuestEffects on the player.
[2146]103    @param player
104        The player.
105    @return
[2191]106        Returns true if the Quest could be completed, false if not.
[2146]107    */
[2205]108    bool LocalQuest::complete(PlayerInfo* player)
[2146]109    {
[2191]110        if(this->isCompletable(player)) //!< Checks whether the Quest can be completed.
[2146]111        {
112            this->setStatus(player, questStatus::completed);
[2191]113            QuestEffect::invokeEffects(player, this->getCompleteEffectList()); //!< Invoke the complete QuestEffects.
[2146]114            return true;
115        }
116       
[2251]117        COUT(4) << "A non-completable quest was trying to be completed." << std::endl;
[2146]118        return false;
119    }
120
121    /**
122    @brief
[2191]123        Checks whether the Quest can be started.
[1996]124    @param player
125        The player for whom is to be checked.
126    @return
[2191]127        Returns true if the Quest can be started, false if not.
[2068]128    @throws
[2205]129        Throws an exception if isInactive(PlayerInfo*) throws one.
[1996]130    */
[2205]131    bool LocalQuest::isStartable(const PlayerInfo* player) const
[1996]132    {
[2258]133        if(!(this->getParentQuest() == NULL || this->getParentQuest()->isActive(player)))
134        {
135            return false;
136        }
[1996]137        return this->isInactive(player);
138    }
[2092]139
[1996]140    /**
141    @brief
[2191]142        Checks whether the Quest can be failed.
[1996]143    @param player
144        The player for whom is to be checked.
145    @return
[2191]146        Returns true if the Quest can be failed, false if not.
[2068]147    @throws
[2205]148        Throws an exception if isActive(PlayerInfo*) throws one.
[1996]149    */
[2205]150    bool LocalQuest::isFailable(const PlayerInfo* player) const
[1996]151    {
152        return this->isActive(player);
153    }
[2092]154
[1996]155    /**
156    @brief
[2191]157        Checks whether the Quest can be completed.
[1996]158    @param player
159        The player for whom is to be checked.
160    @return
[2191]161        Returns true if the Quest can be completed, false if not.
[2068]162    @throws
[2205]163        Throws an exception if isInactive(PlayerInfo*) throws one.
[1996]164    */
[2205]165    bool LocalQuest::isCompletable(const PlayerInfo* player) const
[1996]166    {
167        return this->isActive(player);
168    }
[2092]169
[1996]170    /**
171    @brief
[2191]172        Returns the status of the Quest for a specific player.
[1992]173    @param player
[1996]174        The player.
175    @return
[2191]176        Returns the status of the Quest for the input player.
[2068]177    @throws
178        Throws an Exception if player is NULL.
[1992]179    */
[2205]180    questStatus::Enum LocalQuest::getStatus(const PlayerInfo* player) const
[1992]181    {
[2146]182        if(player == NULL) //!< No player has no defined status.
[2068]183        {
[2205]184            ThrowException(Argument, "The input PlayerInfo* is NULL.");
[2068]185        }
[2092]186
[2205]187        std::map<const PlayerInfo*, questStatus::Enum>::const_iterator it = this->playerStatus_.find(player);
[2146]188        if (it != this->playerStatus_.end()) //!< If there is a player in the map.
[2093]189        {
190            return it->second;
191        }
[2146]192       
193        return questStatus::inactive; //!< If the player is not yet in the map, that means the status of the quest form him is 'inactive'.
[1992]194    }
[2092]195
[1992]196    /**
197    @brief
198        Sets the status for a specific player.
[2146]199        But be careful wit this one, the status will just be set without checking for its validity. You have to know what you're doing. Really!
[1992]200    @param player
[2146]201        The player the status should be set for.
[1992]202    @param status
[2146]203        The status to be set.
[2068]204    @return
205        Returns false if player is NULL.
[1992]206    */
[2205]207    bool LocalQuest::setStatus(PlayerInfo* player, const questStatus::Enum & status)
[1992]208    {
[2146]209        if(player == NULL) //!< We can't set a status for no player.
[2068]210        {
211            return false;
[2093]212        }
[2146]213       
[2021]214        this->playerStatus_[player] = status;
215        return true;
[1992]216    }
217
218}
Note: See TracBrowser for help on using the repository browser.