Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/environment/src/modules/questsystem/effects/ChangeQuestStatus.h @ 8236

Last change on this file since 8236 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.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    @brief
47        A QuestEffect which changes the status of a specified @ref orxonox::Quest "Quest" for the player invoking the QuestEffect.
48    @author
49        Damian 'Mozork' Frick
50    */
51    class _QuestsystemExport ChangeQuestStatus : public QuestEffect
52    {
53        public:
54            ChangeQuestStatus(BaseObject* creator);
55            virtual ~ChangeQuestStatus();
56
57            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a ChangeQuestStatus object through XML.
58
59            virtual bool invoke(PlayerInfo* player) = 0; //!< Invokes the QuestEffect.
60
61        protected:
62            /**
63            @brief Returns the id of the Quest.
64            @return Returns the id of the Quest.
65            */
66            inline const std::string & getQuestId(void) const
67                { return this->questId_; }
68
69        private:
70            std::string questId_; //!< The id of the Quest the status should be changed of.
71
72            bool setQuestId(const std::string & id); //!< Sets the id of the Quest.
73
74    };
75
76}
77
78#endif /* _ChangeQuestStatus_H__ */
Note: See TracBrowser for help on using the repository browser.