blob: a9e5b7a258fba18a9cb6df2ac0dab95146a045cc (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
|
/*
* This file is part of OpenTTD.
* OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
* OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
* See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
*/
/** @file script_game.hpp Everything to manipulate the current running game. */
#ifndef SCRIPT_GAME_HPP
#define SCRIPT_GAME_HPP
#include "script_object.hpp"
#include "../../landscape_type.h"
/**
* Class that handles some game related functions.
* @api game
*/
class ScriptGame : public ScriptObject {
public:
/**
* Type of landscapes known in the game.
*/
enum LandscapeType {
/* Note: these values represent part of the in-game LandscapeType enum */
LT_TEMPERATE = ::LT_TEMPERATE, ///< Temperate climate.
LT_ARCTIC = ::LT_ARCTIC, ///< Arctic climate.
LT_TROPIC = ::LT_TROPIC, ///< Tropic climate.
LT_TOYLAND = ::LT_TOYLAND, ///< Toyland climate.
};
/**
* Pause the server.
* @return True if the action succeeded.
*/
static bool Pause();
/**
* Unpause the server.
* @return True if the action succeeded.
*/
static bool Unpause();
/**
* Check if the game is paused.
* @return True if and only if the game is paused (by which-ever means).
* @note That a game is paused, doesn't always means you can unpause it. If
* the game has been manually paused, or because of the pause_on_join in
* Multiplayer for example, you cannot unpause the game.
*/
static bool IsPaused();
/**
* Get the current landscape.
*/
static LandscapeType GetLandscape();
/**
* Is this a multiplayer game?
* @return True if this is a server in a multiplayer game.
*/
static bool IsMultiplayer();
};
#endif /* SCRIPT_GAME_HPP */
|
