Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/doc/src/modules/questsystem/effects/CompleteQuest.h @ 7311

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

Moving the QuestEffects to subfolder effects.

  • Property svn:eol-style set to native
File size: 1.9 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
31    @brief Definition of the CompleteQuest class.
32*/
33
34#ifndef _CompleteQuest_H__
35#define _CompleteQuest_H__
36
37#include "questsystem/QuestsystemPrereqs.h"
38#include "ChangeQuestStatus.h"
39
40namespace orxonox
41{
42    /**
43    @brief
44        Completes a Quest (with a specified id) for the player invoking the QuestEffect.
45
46        Creating a CompleteQuest through XML goes as follows:
47
48        @code
49        <CompleteQuest questId="id" />  //Where id identifies the Quest that should be completed.
50        @endcode
51    @author
52        Damian 'Mozork' Frick
53    */
54    class _QuestsystemExport CompleteQuest : public ChangeQuestStatus
55    {
56        public:
57            CompleteQuest(BaseObject* creator);
58            virtual ~CompleteQuest();
59
60            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode); //!< Method for creating a CompleteQuest object through XML.
61
62            virtual bool invoke(PlayerInfo* player); //!< Invokes the QuestEffect.
63
64    };
65
66}
67
68#endif /* _CompleteQuest_H__ */
Note: See TracBrowser for help on using the repository browser.