Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: code/trunk/src/libraries/core/GameMode.h @ 9189

Last change on this file since 9189 was 7401, checked in by landauf, 14 years ago

merged doc branch back to trunk

  • Property svn:eol-style set to native
File size: 3.9 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 *      Reto Grieder
24 *   Co-authors:
25 *      ...
26 *
27 */
28
29/**
30    @file
31    @ingroup Management CoreGame
32    @brief Declaration of the GameMode class which stores and returns the current mode of the game.
33*/
34
35#ifndef _GameMode_H__
36#define _GameMode_H__
37
38#include "CorePrereqs.h"
39
40// tolua_begin
41namespace orxonox
42{
43    /// Helper class, stores and returns the current mode of the game.
44    class _CoreExport GameMode
45    {
46// tolua_end
47        friend class Core;
48
49        public:
50// tolua_begin
51            static bool showsGraphics() { return bShowsGraphics_s; }    ///< Returns true if the game shows graphics, false if it is in text-console mode
52            static bool playsSound()    { return bPlaysSound_s; }       ///< Returns true if the game is able to play sounds
53            static bool isServer()      { return bIsServer_s; }         ///< Returns true if we're currently a server (online)
54            static bool isClient()      { return bIsClient_s; }         ///< Returns true if we're currently a client (online)
55            static bool isStandalone()  { return bIsStandalone_s; }     ///< Returns true if we're in standalone mode (offline)
56            static bool isMaster()      { return bIsMaster_s; }         ///< Returns true if we're in control of the game (either standalone or server)
57// tolua_end
58
59            static void setPlaysSound   (bool val) { bPlaysSound_s    = val; }                      ///< Defines if the game can play sounds
60            static void setIsServer     (bool val) { bIsServer_s      = val; updateIsMaster(); }    ///< Defines if the program is in server mode (online)
61            static void setIsClient     (bool val) { bIsClient_s      = val; updateIsMaster(); }    ///< Defines if the program is in client mode (online)
62            static void setIsStandalone (bool val) { bIsStandalone_s  = val; updateIsMaster(); }    ///< Defines if the program is in standalone mode (offline)
63
64        private:
65            GameMode();
66            GameMode(const GameMode& inst);
67            ~GameMode();
68
69            /// Checks if we're in control of the game (either standalone or server).
70            static void updateIsMaster()
71            {
72                bIsMaster_s = (bIsServer_s || bIsStandalone_s);
73            }
74
75            static bool bShowsGraphics_s;                   //!< global variable that tells whether to show graphics
76            static bool bPlaysSound_s;                      //!< global variable that tells whether to sound works
77            static bool bIsServer_s;                        //!< global variable that tells whether this is a server (online)
78            static bool bIsClient_s;                        //!< global variable that tells whether this is a client (online)
79            static bool bIsStandalone_s;                    //!< global variable that tells whether the game is running in standalone mode (offline)
80            static bool bIsMaster_s;                        //!< global variable that tells whether we're in control of the game (standalone or server)
81    }; // tolua_export
82} // tolua_export
83
84#endif /* _GameMode_H__ */
Note: See TracBrowser for help on using the repository browser.