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 PickupListener.h |
---|
31 | @brief Definition of the PickupListener class. |
---|
32 | @ingroup Pickup |
---|
33 | */ |
---|
34 | |
---|
35 | |
---|
36 | #ifndef _PickupListener_H__ |
---|
37 | #define _PickupListener_H__ |
---|
38 | |
---|
39 | #include "Pickupable.h" |
---|
40 | |
---|
41 | #include "core/class/OrxonoxInterface.h" |
---|
42 | |
---|
43 | namespace orxonox |
---|
44 | { |
---|
45 | |
---|
46 | /** |
---|
47 | @brief |
---|
48 | The PickupListener class facilitates the flow of information regarding the picking up, dropping, using and unusing of @ref orxonox::Pickupable "Pickupables" to interested parties (such as the @ref orxonox::PickupManager "PickupManager"). |
---|
49 | |
---|
50 | All you need to to do be notified is to inherit from PickupListener and implement the two methods <code>pickupChangedUsed()</code> and <code>pickupChangedPickedUp()</code>. |
---|
51 | |
---|
52 | @author |
---|
53 | Damian 'Mozork' Frick |
---|
54 | |
---|
55 | @ingroup Pickup |
---|
56 | */ |
---|
57 | class _OrxonoxExport PickupListener : virtual public OrxonoxInterface |
---|
58 | { |
---|
59 | public: |
---|
60 | PickupListener(); |
---|
61 | virtual ~PickupListener(); |
---|
62 | |
---|
63 | static void broadcastPickupChangedUsed(Pickupable* pickup, bool used); //!< Static method that is used to notify the PickupListener itself of the change in the used status of a Pickupable. |
---|
64 | static void broadcastPickupChangedPickedUp(Pickupable* pickup, bool pickedUp); //!< Static method that is used to notify the PickupListener itself of the change in the pickedUp status of a Pickupable. |
---|
65 | |
---|
66 | /** |
---|
67 | @brief Method that can be overloaded by any PickupListener to be notified of a change in the used status of a Pickupable. |
---|
68 | @param pickup The Pickupable, whose used status has changed. |
---|
69 | @param used The value the used status has changed to. |
---|
70 | */ |
---|
71 | virtual void pickupChangedUsed(Pickupable* pickup, bool used) {} |
---|
72 | /** |
---|
73 | @brief Method that can be overloaded by any PickupListener to be notified of a change in the pickedUp status of a Pickupable. |
---|
74 | @param pickup The Pickupable, whose pickedUp status has changed. |
---|
75 | @param pickedUp The value the pickedUp status has changed to. |
---|
76 | */ |
---|
77 | virtual void pickupChangedPickedUp(Pickupable* pickup, bool pickedUp) {} |
---|
78 | }; |
---|
79 | |
---|
80 | } |
---|
81 | |
---|
82 | #endif // _PickupListener_H__ |
---|