Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/objects/quest/Rewardable.h @ 2448

Last change on this file since 2448 was 2261, checked in by landauf, 16 years ago

merged questsystem2 back to trunk

File size: 2.1 KB
RevLine 
[1996]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
[2261]29/**
30    @file Rewardable.h
31    @brief
32    Definition of the Rewardable class.
33*/
34
[1996]35#ifndef _Rewardable_H__
36#define _Rewardable_H__
37
[2095]38#include "OrxonoxPrereqs.h"
39
[1996]40#include "core/BaseObject.h"
41
42namespace orxonox {
43
44    /**
45    @brief
[2261]46        Rewardable is an Interface, that can be implemented by any object to enable it to be given as reward to a player through QuestEffects. (With the AddReward effect.)
47       
48        It just needs to inherit form Rewardable, and implement the reward() method.
[1996]49    @author
50        Damian 'Mozork' Frick
51    */
[2095]52    class _OrxonoxExport Rewardable : public BaseObject
[1996]53    {
[2092]54
[2093]55        public:
56            Rewardable(BaseObject* creator);
57            virtual ~Rewardable();
[2092]58
[2261]59            /**
60            @brief
61                Method to transcribe a rewardable object to the player.
62                Must be implemented by every class inheriting from Rewardable.
63        @param player
64                A pointer to the ControllableEntity, do whatever you want with it.
65        @return
66                Return true if successful.
67            */
68            virtual bool reward(PlayerInfo* player) = 0; //!<
[2092]69
[1996]70    };
71
72}
73
74#endif /* _Rewardable_H__ */
Note: See TracBrowser for help on using the repository browser.