[2194] | 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 | */ |
---|
[2221] | 28 | |
---|
| 29 | /** |
---|
[7601] | 30 | @file PlayerTrigger.h |
---|
| 31 | @brief Definition of the PlayerTrigger class. |
---|
| 32 | @ingroup Triggers |
---|
[2221] | 33 | */ |
---|
| 34 | |
---|
[2194] | 35 | #ifndef _PlayerTrigger_H__ |
---|
| 36 | #define _PlayerTrigger_H__ |
---|
| 37 | |
---|
[2221] | 38 | #include "OrxonoxPrereqs.h" |
---|
[7601] | 39 | |
---|
[9667] | 40 | #include "core/class/OrxonoxInterface.h" |
---|
| 41 | #include "core/object/WeakPtr.h" |
---|
[2194] | 42 | |
---|
[2662] | 43 | namespace orxonox |
---|
| 44 | { |
---|
[2194] | 45 | /** |
---|
| 46 | @brief |
---|
[8706] | 47 | PlayerTrigger is an interface if implemented by a specific trigger can be used to recover the Player (or the @ref orxonox::Pawn "Pawn") that triggered it. |
---|
[7601] | 48 | |
---|
[2194] | 49 | @author |
---|
| 50 | Damian 'Mozork' Frick |
---|
[7601] | 51 | |
---|
| 52 | @ingroup Triggers |
---|
[2194] | 53 | */ |
---|
[9667] | 54 | class _OrxonoxExport PlayerTrigger : virtual public OrxonoxInterface |
---|
[2194] | 55 | { |
---|
[2662] | 56 | public: |
---|
[5727] | 57 | PlayerTrigger(); |
---|
| 58 | virtual ~PlayerTrigger() {} |
---|
[5693] | 59 | |
---|
[2662] | 60 | /** |
---|
[8706] | 61 | @brief Returns the Pawn that triggered the PlayerTrigger. |
---|
[5936] | 62 | @return Returns a pointer to the Pawn that triggered the PlayerTrigger. |
---|
[2662] | 63 | */ |
---|
[8706] | 64 | inline Pawn* getTriggeringPawn(void) const |
---|
[10624] | 65 | { return this->pawn_; } |
---|
[8706] | 66 | |
---|
| 67 | /** |
---|
| 68 | @brief Returns the player that triggered the PlayerTrigger. |
---|
| 69 | @return Returns a pointer to the PlayerInfo that triggered the PlayerTrigger. |
---|
| 70 | */ |
---|
| 71 | inline PlayerInfo* getTriggeringPlayer(void) const |
---|
[2662] | 72 | { return this->player_; } |
---|
[5693] | 73 | |
---|
[2662] | 74 | /** |
---|
[8706] | 75 | @brief Checks whether the PlayerTrigger normally returns a Pawn/PlayerInfo. |
---|
| 76 | @return Returns true if the PlayerTrigger normally returns a Pawn/PlayerInfo. |
---|
[2662] | 77 | */ |
---|
| 78 | inline bool isForPlayer(void) const |
---|
| 79 | { return this->isForPlayer_; } |
---|
[5693] | 80 | |
---|
[2662] | 81 | protected: |
---|
| 82 | /** |
---|
| 83 | @brief Set the player that triggered the PlayerTrigger. This is normally done by classes inheriting vom PlayerTrigger. |
---|
[11099] | 84 | @param pawn A pointer to the Pawn that triggered the PlayerTrigger. |
---|
[2662] | 85 | */ |
---|
[8706] | 86 | void setTriggeringPawn(Pawn* pawn); |
---|
[2221] | 87 | |
---|
[7601] | 88 | /** |
---|
| 89 | @brief Set whether the PlayerTrigger normally is triggered by Pawns. |
---|
| 90 | @param isForPlayer Should be true when the PlayerTrigger should be set to normally be triggered by Pawns, false if not. |
---|
| 91 | */ |
---|
[2662] | 92 | inline void setForPlayer(bool isForPlayer) |
---|
| 93 | { this->isForPlayer_ = isForPlayer; } |
---|
[5693] | 94 | |
---|
[2662] | 95 | private: |
---|
[8706] | 96 | WeakPtr<PlayerInfo> player_; //!< The player that triggered the PlayerTrigger. |
---|
| 97 | WeakPtr<Pawn> pawn_; //!< The Pawn that triggered the PlayerTrigger. |
---|
[5936] | 98 | bool isForPlayer_; //!< Is true when the PlayerTrigger should be set to normally be triggered by Pawns. |
---|
[5693] | 99 | |
---|
[2194] | 100 | }; |
---|
| 101 | |
---|
| 102 | } |
---|
| 103 | |
---|
| 104 | #endif /* _PlayerTrigger_H__ */ |
---|