Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/branches/core7/src/orxonox/interfaces/PlayerTrigger.h @ 10558

Last change on this file since 10558 was 10558, checked in by landauf, 5 years ago

no need to call get() on Weak or StrongPtr. they are automatically converted to normal pointers.

  • Property svn:eol-style set to native
File size: 3.3 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 PlayerTrigger.h
31    @brief Definition of the PlayerTrigger class.
32    @ingroup Triggers
33*/
34
35#ifndef _PlayerTrigger_H__
36#define _PlayerTrigger_H__
37
38#include "OrxonoxPrereqs.h"
39
40#include "core/class/OrxonoxInterface.h"
41#include "core/object/WeakPtr.h"
42
43namespace orxonox
44{
45    /**
46    @brief
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.
48
49    @author
50        Damian 'Mozork' Frick
51
52    @ingroup Triggers
53    */
54    class _OrxonoxExport PlayerTrigger : virtual public OrxonoxInterface
55    {
56    public:
57        PlayerTrigger();
58        virtual ~PlayerTrigger() {}
59
60        /**
61        @brief Returns the Pawn that triggered the PlayerTrigger.
62        @return Returns a pointer to the Pawn that triggered the PlayerTrigger.
63        */
64        inline Pawn* getTriggeringPawn(void) const
65            { return this->pawn_; }
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
72            { return this->player_; }
73
74        /**
75        @brief Checks whether the PlayerTrigger normally returns a Pawn/PlayerInfo.
76        @return Returns true if the PlayerTrigger normally returns a Pawn/PlayerInfo.
77        */
78        inline bool isForPlayer(void) const
79           { return this->isForPlayer_; }
80
81    protected:
82        /**
83        @brief Set the player that triggered the PlayerTrigger. This is normally done by classes inheriting vom PlayerTrigger.
84        @param player A pointer to the Pawn that triggered the PlayerTrigger.
85        */
86        void setTriggeringPawn(Pawn* pawn);
87
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        */
92        inline void setForPlayer(bool isForPlayer)
93           { this->isForPlayer_ = isForPlayer; }
94
95    private:
96        WeakPtr<PlayerInfo> player_; //!< The player that triggered the PlayerTrigger.
97        WeakPtr<Pawn> pawn_; //!< The Pawn that triggered the PlayerTrigger.
98        bool isForPlayer_; //!< Is true when the PlayerTrigger should be set to normally be triggered by Pawns.
99
100    };
101
102}
103
104#endif /* _PlayerTrigger_H__ */
Note: See TracBrowser for help on using the repository browser.