Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/modules/pong/PongScore.h @ 8450

Last change on this file since 8450 was 8108, checked in by dafrick, 14 years ago

Merging changes from tetris branch into trunk, since they are also useful, there.

  • Property svn:eol-style set to native
File size: 4.4 KB
RevLine 
[3078]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 *      Fabian 'x3n' Landau
24 *   Co-authors:
25 *      ...
26 *
27 */
28
[8108]29/**
30    @file PongScore.h
31    @brief Declaration of the PongScore class.
32    @ingroup Pong
33*/
34
[3078]35#ifndef _PongScore_H__
36#define _PongScore_H__
37
[5725]38#include "pong/PongPrereqs.h"
[3078]39
[5693]40#include "tools/interfaces/Tickable.h"
[8108]41
[3078]42#include "overlays/OverlayText.h"
43
44namespace orxonox
45{
[8108]46
47    /**
48    @brief
49        The PongScore class displays the score for a game of @ref orxonox::Pong "Pong".
50
51    @author
52        Fabian 'x3n' Landau
53
54    @ingroup Pong
55    */
[5725]56    class _PongExport PongScore : public OverlayText, public Tickable
[3078]57    {
58        public:
59            PongScore(BaseObject* creator);
[3196]60            virtual ~PongScore();
[3078]61
[8108]62            virtual void tick(float dt); //!< Creates and sets the caption to be displayed by the PongScore.
[3078]63            virtual void XMLPort(Element& xmlelement, XMLPort::Mode mode);
[8108]64            virtual void changedOwner(); //!< Is called when the owner changes.
[3078]65
[8108]66            /**
67            @brief Set whether the PongScore displays the players' names.
68            @param value If true the players' names are displayed.
69            */
[3078]70            inline void setShowName(bool value)
71                { this->bShowName_ = value; }
[8108]72            /**
73            @brief Get whether the PongScore displays the players' names.
74            @return Returns true if the players' names are displayed, false otherwise.
75            */
[3078]76            inline bool getShowName() const
77                { return this->bShowName_; }
78
[8108]79            /**
80            @brief Set whether the PongScore displays the players' scores.
81            @param value If true the players' scores are displayed.
82            */
[3078]83            inline void setShowScore(bool value)
84                { this->bShowScore_ = value; }
[8108]85            /**
86            @brief Get whether the PongScore displays the players' scores.
87            @return Returns true if the players' scores are displayed, false otherwise.
88            */
[3078]89            inline bool getShowScore() const
90                { return this->bShowScore_; }
91
[8108]92            /**
93            @brief Set whether the PongScore displays the left player.
94            @param value If true the left player is displayed.
95            */
[3078]96            inline void setShowLeftPlayer(bool value)
97                { this->bShowLeftPlayer_ = value; }
[8108]98            /**
99            @brief Get whether the PongScore displays the left player.
100            @return Returns true if the left player is displayed, false otherwise.
101            */
[3078]102            inline bool getShowLeftPlayer() const
103                { return this->bShowLeftPlayer_; }
104
[8108]105            /**
106            @brief Set whether the PongScore displays the right player.
107            @param value If true the right player is displayed.
108            */
[3078]109            inline void setShowRightPlayer(bool value)
110                { this->bShowRightPlayer_ = value; }
[8108]111            /**
112            @brief Get whether the PongScore displays the right player.
113            @return Returns true if the right player is displayed, false otherwise.
114            */
[3078]115            inline bool getShowRightPlayer() const
116                { return this->bShowRightPlayer_; }
117
118        private:
[8108]119            Pong* owner_; //!< The Pong game that owns this PongScore.
120            bool bShowName_; //!< Whether the names of the players are shown.
121            bool bShowScore_; //!< Whether the score of the players is shown.
122            bool bShowLeftPlayer_; //!< Whether the left player is shown.
123            bool bShowRightPlayer_; //!< Whether the right player is shown.
[3078]124    };
125}
126#endif /* _PongScore_H__ */
Note: See TracBrowser for help on using the repository browser.