1

/* $Id$ */

     2

/** @file openttd.h */

     3

     4

#ifndef OPENTTD_H

     5

#define OPENTTD_H

     6

     7

#ifndef VARDEF

     8

#define VARDEF extern

     9

#endif

    10

    11

// Forward declarations of structs.

    12

struct Depot;

    13

struct Waypoint;

    14

struct Station;

    15

struct ViewPort;

    16

struct NewsItem;

    17

struct DrawPixelInfo;

    18

struct Group;

    19

typedef byte VehicleOrderID;  ///< The index of an order within its current vehicle (not pool related)

    20

typedef byte LandscapeID;

    21

typedef uint16 EngineID;

    22

typedef uint16 UnitID;

    23

    24

typedef EngineID *EngineList; ///< engine list type placeholder acceptable for C code (see helpers.cpp)

    25

    26

/* IDs used in Pools */

    27

typedef uint16 StationID;

    28

static const StationID INVALID_STATION = 0xFFFF;

    29

typedef uint16 RoadStopID;

    30

typedef uint16 DepotID;

    31

typedef uint16 WaypointID;

    32

typedef uint16 OrderID;

    33

typedef uint16 SignID;

    34

typedef uint16 GroupID;

    35

typedef uint16 EngineRenewID;

    36

typedef uint16 DestinationID;

    37

    38

/* DestinationID must be at least as large as every these below, because it can

    39

 * be any of them

    40

 */

    41

assert_compile(sizeof(DestinationID) >= sizeof(DepotID));

    42

assert_compile(sizeof(DestinationID) >= sizeof(WaypointID));

    43

assert_compile(sizeof(DestinationID) >= sizeof(StationID));

    44

    45

enum GameModes {

    46

	GM_MENU,

    47

	GM_NORMAL,

    48

	GM_EDITOR

    49

};

    50

    51

enum SwitchModes {

    52

	SM_NONE            =  0,

    53

	SM_NEWGAME         =  1,

    54

	SM_EDITOR          =  2,

    55

	SM_LOAD            =  3,

    56

	SM_MENU            =  4,

    57

	SM_SAVE            =  5,

    58

	SM_GENRANDLAND     =  6,

    59

	SM_LOAD_SCENARIO   =  9,

    60

	SM_START_SCENARIO  = 10,

    61

	SM_START_HEIGHTMAP = 11,

    62

	SM_LOAD_HEIGHTMAP  = 12,

    63

};

    64

    65

    66

/* Modes for GenerateWorld */

    67

enum GenerateWorldModes {

    68

	GW_NEWGAME   = 0,    /* Generate a map for a new game */

    69

	GW_EMPTY     = 1,    /* Generate an empty map (sea-level) */

    70

	GW_RANDOM    = 2,    /* Generate a random map for SE */

    71

	GW_HEIGHTMAP = 3,    /* Generate a newgame from a heightmap */

    72

};

    73

    74

/* Modes for InitializeGame, those are _bits_! */

    75

enum InitializeGameModes {

    76

	IG_NONE       = 0,  /* Don't do anything special */

    77

	IG_DATE_RESET = 1,  /* Reset the date when initializing a game */

    78

};

    79

    80

enum TransportType {

    81

	/* These constants are for now linked to the representation of bridges

    82

	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge.

    83

	 * In an ideal world, these constants would be used everywhere when

    84

	 * accessing tunnels and bridges. For now, you should just not change

    85

	 * the values for road and rail.

    86

	 */

    87

	TRANSPORT_BEGIN = 0,

    88

	TRANSPORT_RAIL = 0,

    89

	TRANSPORT_ROAD = 1,

    90

	TRANSPORT_WATER, // = 2

    91

	TRANSPORT_END,

    92

	INVALID_TRANSPORT = 0xff,

    93

};

    94

    95

/* Display Options */

    96

enum {

    97

	DO_SHOW_TOWN_NAMES    = 0,

    98

	DO_SHOW_STATION_NAMES = 1,

    99

	DO_SHOW_SIGNS         = 2,

   100

	DO_FULL_ANIMATION     = 3,

   101

	DO_FULL_DETAIL        = 5,

   102

	DO_WAYPOINTS          = 6,

   103

};

   104

   105

/* Landscape types */

   106

enum {

   107

	LT_TEMPERATE  = 0,

   108

	LT_ARCTIC     = 1,

   109

	LT_TROPIC     = 2,

   110

	LT_TOYLAND    = 3,

   111

   112

	NUM_LANDSCAPE = 4,

   113

};

   114

   115

struct ViewportSign {

   116

	int32 left;

   117

	int32 top;

   118

	byte width_1, width_2;

   119

};

   120

   121

enum {

   122

	SORT_ASCENDING  = 0,

   123

	SORT_DESCENDING = 1,

   124

	SORT_BY_DATE    = 0,

   125

	SORT_BY_NAME    = 2

   126

};

   127

   128

extern byte _savegame_sort_order;

   129

   130

enum {

   131

	MAX_SCREEN_WIDTH  = 2048,

   132

	MAX_SCREEN_HEIGHT = 1200,

   133

};

   134

   135

/* In certain windows you navigate with the arrow keys. Do not scroll the

   136

 * gameview when here. Bitencoded variable that only allows scrolling if all

   137

 * elements are zero */

   138

enum {

   139

	SCROLL_CON  = 0,

   140

	SCROLL_EDIT = 1,

   141

	SCROLL_SAVE = 2,

   142

	SCROLL_CHAT = 4,

   143

};

   144

extern byte _no_scroll;

   145

   146

/** To have a concurrently running thread interface with the main program, use

   147

 * the OTTD_SendThreadMessage() function. Actions to perform upon the message are handled

   148

 * in the ProcessSentMessage() function */

   149

enum ThreadMsg {

   150

	MSG_OTTD_NO_MESSAGE,

   151

	MSG_OTTD_SAVETHREAD_DONE,

   152

	MSG_OTTD_SAVETHREAD_ERROR,

   153

};

   154

   155

void OTTD_SendThreadMessage(ThreadMsg msg);

   156

   157

extern byte _game_mode;

   158

extern bool _exit_game;

   159

extern byte _pause_game;

   160

   161

#endif /* OPENTTD_H */