Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/tutorial/src/modules/questsystem/QuestEffect.h @ 8784

Last change on this file since 8784 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.0 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 QuestEffect.h
31    @brief Definition of the QuestEffect class.
32    @ingroup Questsystem
33*/
34
35#ifndef _QuestEffect_H__
36#define _QuestEffect_H__
37
38#include "questsystem/QuestsystemPrereqs.h"
39
40#include <list>
41#include "core/BaseObject.h"
42
43namespace orxonox
44{
45
46    /**
47    @brief
48        Handles QuestEffects for @ref orxonox::Quest "Quests".
49        QuestEffects are one of the ways for @ref orxonox::Quest "Quests" to have any side effects on the game world and for the game world to influence the @ref orxonox::Quest "Quests".
50
51    @author
52        Damian 'Mozork' Frick
53
54    @ingroup Questsystem
55    */
56    class _QuestsystemExport QuestEffect : public BaseObject
57    {
58        public:
59            QuestEffect(BaseObject* creator);
60            virtual ~QuestEffect();
61
62            virtual bool invoke(PlayerInfo* player) = 0; //!< Invokes the QuestEffect.
63            static bool invokeEffects(PlayerInfo* player, std::list<QuestEffect*> & effects); //!< Invokes all QuestEffects in the list.
64
65    };
66
67}
68
69#endif /* _QuestEffect_H__ */
Note: See TracBrowser for help on using the repository browser.