source:
code/branches/presentation/src/orxonox/objects/quest/Rewardable.h
@
2662
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 Rewardable class. |
32 | */ |
33 | |
34 | #ifndef _Rewardable_H__ |
35 | #define _Rewardable_H__ |
36 | |
37 | #include "OrxonoxPrereqs.h" |
38 | |
39 | #include "core/BaseObject.h" |
40 | |
41 | namespace orxonox |
42 | { |
43 | /** |
44 | @brief |
45 | 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.) |
46 | |
47 | It just needs to inherit form Rewardable, and implement the reward() method. |
48 | @author |
49 | Damian 'Mozork' Frick |
50 | */ |
51 | class _OrxonoxExport Rewardable : public BaseObject |
52 | { |
53 | public: |
54 | Rewardable(BaseObject* creator); |
55 | virtual ~Rewardable(); |
56 | |
57 | /** |
58 | @brief |
59 | Method to transcribe a rewardable object to the player. |
60 | Must be implemented by every class inheriting from Rewardable. |
61 | @param player |
62 | A pointer to the ControllableEntity, do whatever you want with it. |
63 | @return |
64 | Return true if successful. |
65 | */ |
66 | virtual bool reward(PlayerInfo* player) = 0; |
67 | |
68 | }; |
69 | |
70 | } |
71 | |
72 | #endif /* _Rewardable_H__ */ |
Note: See TracBrowser
for help on using the repository browser.