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 DrawPixelInfo;

    17

struct Group;

    18

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

    19

typedef byte LandscapeID;

    20

typedef uint16 EngineID;

    21

typedef uint16 UnitID;

    22

    23

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

    24

    25

/* IDs used in Pools */

    26

typedef uint16 StationID;

    27

static const StationID INVALID_STATION = 0xFFFF;

    28

typedef uint16 RoadStopID;

    29

typedef uint16 DepotID;

    30

typedef uint16 WaypointID;

    31

typedef uint16 OrderID;

    32

typedef uint16 SignID;

    33

typedef uint16 GroupID;

    34

typedef uint16 EngineRenewID;

    35

typedef uint16 DestinationID;

    36

    37

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

    38

 * be any of them

    39

 */

    40

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

    41

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

    42

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

    43

    44

enum GameModes {

    45

	GM_MENU,

    46

	GM_NORMAL,

    47

	GM_EDITOR

    48

};

    49

    50

enum SwitchModes {

    51

	SM_NONE            =  0,

    52

	SM_NEWGAME         =  1,

    53

	SM_EDITOR          =  2,

    54

	SM_LOAD            =  3,

    55

	SM_MENU            =  4,

    56

	SM_SAVE            =  5,

    57

	SM_GENRANDLAND     =  6,

    58

	SM_LOAD_SCENARIO   =  9,

    59

	SM_START_SCENARIO  = 10,

    60

	SM_START_HEIGHTMAP = 11,

    61

	SM_LOAD_HEIGHTMAP  = 12,

    62

};

    63

    64

    65

/* Modes for GenerateWorld */

    66

enum GenerateWorldModes {

    67

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

    68

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

    69

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

    70

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

    71

};

    72

    73

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

    74

enum InitializeGameModes {

    75

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

    76

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

    77

};

    78

    79

enum TransportType {

    80

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

    81

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

    82

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

    83

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

    84

	 * the values for road and rail.

    85

	 */

    86

	TRANSPORT_BEGIN = 0,

    87

	TRANSPORT_RAIL = 0,

    88

	TRANSPORT_ROAD = 1,

    89

	TRANSPORT_WATER, // = 2

    90

	TRANSPORT_END,

    91

	INVALID_TRANSPORT = 0xff,

    92

};

    93

    94

/* Display Options */

    95

enum {

    96

	DO_SHOW_TOWN_NAMES    = 0,

    97

	DO_SHOW_STATION_NAMES = 1,

    98

	DO_SHOW_SIGNS         = 2,

    99

	DO_FULL_ANIMATION     = 3,

   100

	DO_FULL_DETAIL        = 5,

   101

	DO_WAYPOINTS          = 6,

   102

};

   103

   104

/* Landscape types */

   105

enum {

   106

	LT_TEMPERATE  = 0,

   107

	LT_ARCTIC     = 1,

   108

	LT_TROPIC     = 2,

   109

	LT_TOYLAND    = 3,

   110

   111

	NUM_LANDSCAPE = 4,

   112

};

   113

   114

struct ViewportSign {

   115

	int32 left;

   116

	int32 top;

   117

	byte width_1, width_2;

   118

};

   119

   120

enum {

   121

	SORT_ASCENDING  = 0,

   122

	SORT_DESCENDING = 1,

   123

	SORT_BY_DATE    = 0,

   124

	SORT_BY_NAME    = 2

   125

};

   126

   127

extern byte _savegame_sort_order;

   128

   129

enum {

   130

	MAX_SCREEN_WIDTH  = 2048,

   131

	MAX_SCREEN_HEIGHT = 1200,

   132

};

   133

   134

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

   135

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

   136

 * elements are zero */

   137

enum {

   138

	SCROLL_CON  = 0,

   139

	SCROLL_EDIT = 1,

   140

	SCROLL_SAVE = 2,

   141

	SCROLL_CHAT = 4,

   142

};

   143

extern byte _no_scroll;

   144

   145

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

   146

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

   147

 * in the ProcessSentMessage() function */

   148

enum ThreadMsg {

   149

	MSG_OTTD_NO_MESSAGE,

   150

	MSG_OTTD_SAVETHREAD_DONE,

   151

	MSG_OTTD_SAVETHREAD_ERROR,

   152

};

   153

   154

void OTTD_SendThreadMessage(ThreadMsg msg);

   155

   156

extern byte _game_mode;

   157

extern bool _exit_game;

   158

extern int8 _pause_game;

   159

   160

#endif /* OPENTTD_H */