Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/interfaces/Rewardable.h @ 7163

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

Merged presentation3 branch into trunk.

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