Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/questsystem/effects/ChangeQuestStatus.h @ 9223

Last change on this file since 9223 was 7552, checked in by dafrick, 14 years ago

Resolving some TODOs and doing some additional cleanup. Almost done now…

  • Property svn:eol-style set to native
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.h
31    @brief Definition of the ChangeQuestStatus class.
32    @ingroup QuestEffects
33*/
34
35#ifndef _ChangeQuestStatus_H__
36#define _ChangeQuestStatus_H__
37
38#include "questsystem/QuestsystemPrereqs.h"
39
40#include <string>
41#include "questsystem/QuestEffect.h"
42
43namespace orxonox
44{
45
46    /**
47    @brief
48        A QuestEffect which changes the status of a specified @ref orxonox::Quest "Quest" for the player invoking the QuestEffect.
49
50    @author
51        Damian 'Mozork' Frick
52
53    @ingroup QuestEffects
54    */
55    class _QuestsystemExport ChangeQuestStatus : public QuestEffect
56    {
57        public:
58            ChangeQuestStatus(BaseObject* creator);
59            virtual ~ChangeQuestStatus();
60
61            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a ChangeQuestStatus object through XML.
62
63            virtual bool invoke(PlayerInfo* player) = 0; //!< Invokes the QuestEffect.
64
65        protected:
66            /**
67            @brief Returns the id of the Quest.
68            @return Returns the id of the Quest.
69            */
70            inline const std::string & getQuestId(void) const
71                { return this->questId_; }
72
73        private:
74            std::string questId_; //!< The id of the Quest the status should be changed of.
75
76            bool setQuestId(const std::string & id); //!< Sets the id of the Quest.
77
78    };
79
80}
81
82#endif /* _ChangeQuestStatus_H__ */
Note: See TracBrowser for help on using the repository browser.