GSGame Class Reference

Class that handles some game related functions. More...


Public Types

enum  LandscapeType {
  LT_TEMPERATE,
  LT_ARCTIC,
  LT_TROPIC,
  LT_TOYLAND
}
 Type of landscapes known in the game. More...

Static Public Member Functions

static bool Pause ()
 Pause the server.
static bool Unpause ()
 Unpause the server.
static bool IsPaused ()
 Check if the game is paused.
static LandscapeType GetLandscape ()
 Get the current landscape.
static bool IsMultiplayer ()
 Is this a multiplayer game?


Detailed Description

Class that handles some game related functions.

Member Enumeration Documentation

Type of landscapes known in the game.

Enumerator:
LT_TEMPERATE  Temperate climate.
LT_ARCTIC  Arctic climate.
LT_TROPIC  Tropic climate.
LT_TOYLAND  Toyland climate.


Member Function Documentation

static bool GSGame::Pause (  )  [static]

Pause the server.

Returns:
True if the action succeeded.

static bool GSGame::Unpause (  )  [static]

Unpause the server.

Returns:
True if the action succeeded.

static bool GSGame::IsPaused (  )  [static]

Check if the game is paused.

Returns:
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 GSGame::IsMultiplayer (  )  [static]

Is this a multiplayer game?

Returns:
True if this is a server in a multiplayer game.


Generated on Sun Mar 31 21:37:40 2013 for OpenTTD Game API by  doxygen 1.5.6