Orxonox  0.0.5 Codename: Arcturus
PlayerTrigger.h
Go to the documentation of this file.
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 
35 #ifndef _PlayerTrigger_H__
36 #define _PlayerTrigger_H__
37 
38 #include "OrxonoxPrereqs.h"
39 
41 #include "core/object/WeakPtr.h"
42 
43 namespace orxonox
44 {
55  {
56  public:
57  PlayerTrigger();
58  virtual ~PlayerTrigger() {}
59 
64  inline Pawn* getTriggeringPawn(void) const
65  { return this->pawn_; }
66 
71  inline PlayerInfo* getTriggeringPlayer(void) const
72  { return this->player_; }
73 
78  inline bool isForPlayer(void) const
79  { return this->isForPlayer_; }
80 
81  protected:
86  void setTriggeringPawn(Pawn* pawn);
87 
92  inline void setForPlayer(bool isForPlayer)
93  { this->isForPlayer_ = isForPlayer; }
94 
95  private:
98  bool isForPlayer_;
99 
100  };
101 
102 }
103 
104 #endif /* _PlayerTrigger_H__ */
Everything in Orxonox that has a health attribute is a Pawn.
Definition: Pawn.h:56
Definition of WeakPtr<T>, wraps a pointer to an object.
This is the class from which all interfaces of the game-logic (not the engine) are derived from...
Definition: OrxonoxInterface.h:50
PlayerInfo * getTriggeringPlayer(void) const
Returns the player that triggered the PlayerTrigger.
Definition: PlayerTrigger.h:71
WeakPtr wraps a pointer to an object, which becomes nullptr if the object is deleted.
Definition: CorePrereqs.h:236
void setForPlayer(bool isForPlayer)
Set whether the PlayerTrigger normally is triggered by Pawns.
Definition: PlayerTrigger.h:92
WeakPtr< PlayerInfo > player_
The player that triggered the PlayerTrigger.
Definition: PlayerTrigger.h:96
PlayerTrigger is an interface if implemented by a specific trigger can be used to recover the Player ...
Definition: PlayerTrigger.h:54
Pawn * getTriggeringPawn(void) const
Returns the Pawn that triggered the PlayerTrigger.
Definition: PlayerTrigger.h:64
Die Wagnis Klasse hat die folgenden Aufgaben:
Definition: ApplicationPaths.cc:66
Declaration of OrxonoxInterface, the base class of all interfaces in Orxonox.
bool isForPlayer(void) const
Checks whether the PlayerTrigger normally returns a Pawn/PlayerInfo.
Definition: PlayerTrigger.h:78
Shared library macros, enums, constants and forward declarations for the orxonox library ...
bool isForPlayer_
Is true when the PlayerTrigger should be set to normally be triggered by Pawns.
Definition: PlayerTrigger.h:98
#define _OrxonoxExport
Definition: OrxonoxPrereqs.h:60
WeakPtr< Pawn > pawn_
The Pawn that triggered the PlayerTrigger.
Definition: PlayerTrigger.h:97
Definition: PlayerInfo.h:39
virtual ~PlayerTrigger()
Definition: PlayerTrigger.h:58