Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/orxonox/interfaces/PlayerTrigger.h @ 7144

Last change on this file since 7144 was 5936, checked in by dafrick, 15 years ago

Updated documentation in PlayerTrigger.

  • Property svn:eol-style set to native
File size: 2.9 KB
RevLine 
[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/**
[2662]30    @file
[2221]31    @brief
[2662]32    Definition of the PlayerTrigger class.
[2221]33*/
34
[2194]35#ifndef _PlayerTrigger_H__
36#define _PlayerTrigger_H__
37
[2221]38#include "OrxonoxPrereqs.h"
[5727]39#include "core/OrxonoxClass.h"
[2194]40
[2662]41namespace orxonox
42{
[2194]43    /**
44    @brief
[5936]45        A PlayerTrigger is a trigger which is normally triggered by Pawns and can as such return a pointer to the Pawn which triggered it.
[2194]46    @author
47        Damian 'Mozork' Frick
48    */
[5727]49    class _OrxonoxExport PlayerTrigger : virtual public OrxonoxClass
[2194]50    {
[2662]51    public:
[5727]52        PlayerTrigger();
53        virtual ~PlayerTrigger() {}
[5693]54
[2662]55        /**
56        @brief Returns the player that triggered the PlayerTrigger.
[5936]57        @return Returns a pointer to the Pawn that triggered the PlayerTrigger.
[2662]58        */
[3033]59        inline Pawn* getTriggeringPlayer(void) const
[2662]60            { return this->player_; }
[5693]61
[2662]62        /**
[5936]63        @brief Checks whether the PlayerTrigger normally returns a Pawn.
64        @return Returns true if the PlayerTrigger normally returns a Pawn.
[2662]65        */
66        inline bool isForPlayer(void) const
67           { return this->isForPlayer_; }
[5693]68
[2662]69    protected:
70        /**
71        @brief Set the player that triggered the PlayerTrigger. This is normally done by classes inheriting vom PlayerTrigger.
[5936]72        @param player A pointer to the Pawn that triggered the PlayerTrigger.
[2662]73        */
[3033]74        inline void setTriggeringPlayer(Pawn* player)
[2662]75           { this->player_ = player; }
[2221]76
77            /**
[5936]78            @brief Set whether the PlayerTrigger normally is triggered by Pawns.
79            @param isForPlayer Should be true when the PlayerTrigger should be set to normally be triggered by Pawns, false if not.
[2221]80            */
[2662]81        inline void setForPlayer(bool isForPlayer)
82           { this->isForPlayer_ = isForPlayer; }
[5693]83
[2662]84    private:
[3033]85        Pawn* player_; //!< The player that triggered the PlayerTrigger.
[5936]86        bool isForPlayer_; //!< Is true when the PlayerTrigger should be set to normally be triggered by Pawns.
[5693]87
[2194]88    };
89
90}
91
92#endif /* _PlayerTrigger_H__ */
Note: See TracBrowser for help on using the repository browser.