[6800] | 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: |
---|
[6856] | 23 | * Damian 'Mozork' Frick |
---|
[6800] | 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
[6856] | 29 | /** |
---|
| 30 | @file MultiTriggerContainer.h |
---|
| 31 | @brief Definition of the MultiTriggerContainer class. |
---|
| 32 | */ |
---|
| 33 | |
---|
[6800] | 34 | #ifndef _MultiTriggerContainer_H__ |
---|
| 35 | #define _MultiTriggerContainer_H__ |
---|
| 36 | |
---|
| 37 | #include "objects/ObjectsPrereqs.h" |
---|
| 38 | |
---|
| 39 | #include "core/BaseObject.h" |
---|
| 40 | |
---|
| 41 | namespace orxonox |
---|
| 42 | { |
---|
| 43 | |
---|
[6856] | 44 | /** |
---|
| 45 | @brief |
---|
| 46 | This class is used by the MultiTrigger class to transport additional data via Events. |
---|
| 47 | @author |
---|
| 48 | Damian 'Mozork' Frick |
---|
| 49 | */ |
---|
[6800] | 50 | class _ObjectsExport MultiTriggerContainer : public BaseObject |
---|
| 51 | { |
---|
[7163] | 52 | |
---|
[6800] | 53 | public: |
---|
[6856] | 54 | MultiTriggerContainer(BaseObject* creator); //!< Default constructor. Registers the object and creates an empty container. |
---|
| 55 | MultiTriggerContainer(BaseObject* creator, MultiTrigger* originator, BaseObject* data); //!< Constructor. Registers the object and sets the input values. |
---|
| 56 | ~MultiTriggerContainer(); //!< Destructor. |
---|
| 57 | |
---|
| 58 | /** |
---|
| 59 | @brief Get the originator of the Event. (The MultiTrigger that fired the Event) |
---|
| 60 | @return Returns a pointer to the originator. |
---|
| 61 | */ |
---|
[6800] | 62 | inline MultiTrigger* getOriginator(void) |
---|
| 63 | { return this->originator_; } |
---|
[6856] | 64 | /** |
---|
| 65 | @brief Get the data of this container. |
---|
| 66 | @return Returns a pointer ot the data. |
---|
| 67 | */ |
---|
[6800] | 68 | inline BaseObject* getData(void) |
---|
| 69 | { return this->data_; } |
---|
[7163] | 70 | |
---|
[6800] | 71 | private: |
---|
[6856] | 72 | MultiTrigger* originator_; //!< The originator. |
---|
| 73 | BaseObject* data_; //!< The data. |
---|
[6800] | 74 | }; |
---|
[7163] | 75 | |
---|
[6800] | 76 | } |
---|
| 77 | |
---|
| 78 | #endif // _MultiTriggerContainer_H__ |
---|