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

    13

struct Station;

    14

struct ViewPort;

    15

struct DrawPixelInfo;

    16

struct Group;

    17

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

    18

typedef byte LandscapeID;

    19

typedef uint16 EngineID;

    20

typedef uint16 UnitID;

    21

    22

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

    23

    24

/* IDs used in Pools */

    25

typedef uint16 StationID;

    26

static const StationID INVALID_STATION = 0xFFFF;

    27

typedef uint16 RoadStopID;

    28

typedef uint16 WaypointID;

    29

typedef uint16 OrderID;

    30

typedef uint16 SignID;

    31

typedef uint16 GroupID;

    32

typedef uint16 EngineRenewID;

    33

    34

enum GameModes {

    35

	GM_MENU,

    36

	GM_NORMAL,

    37

	GM_EDITOR

    38

};

    39

    40

enum SwitchModes {

    41

	SM_NONE            =  0,

    42

	SM_NEWGAME         =  1,

    43

	SM_EDITOR          =  2,

    44

	SM_LOAD            =  3,

    45

	SM_MENU            =  4,

    46

	SM_SAVE            =  5,

    47

	SM_GENRANDLAND     =  6,

    48

	SM_LOAD_SCENARIO   =  9,

    49

	SM_START_SCENARIO  = 10,

    50

	SM_START_HEIGHTMAP = 11,

    51

	SM_LOAD_HEIGHTMAP  = 12,

    52

};

    53

    54

    55

/* Modes for GenerateWorld */

    56

enum GenerateWorldModes {

    57

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

    58

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

    59

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

    60

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

    61

};

    62

    63

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

    64

enum InitializeGameModes {

    65

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

    66

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

    67

};

    68

    69

enum TransportType {

    70

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

    71

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

    72

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

    73

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

    74

	 * the values for road and rail.

    75

	 */

    76

	TRANSPORT_BEGIN = 0,

    77

	TRANSPORT_RAIL = 0,

    78

	TRANSPORT_ROAD = 1,

    79

	TRANSPORT_WATER, // = 2

    80

	TRANSPORT_END,

    81

	INVALID_TRANSPORT = 0xff,

    82

};

    83

    84

/* Display Options */

    85

enum {

    86

	DO_SHOW_TOWN_NAMES    = 0,

    87

	DO_SHOW_STATION_NAMES = 1,

    88

	DO_SHOW_SIGNS         = 2,

    89

	DO_FULL_ANIMATION     = 3,

    90

	DO_FULL_DETAIL        = 5,

    91

	DO_WAYPOINTS          = 6,

    92

};

    93

    94

/* Landscape types */

    95

enum {

    96

	LT_TEMPERATE  = 0,

    97

	LT_ARCTIC     = 1,

    98

	LT_TROPIC     = 2,

    99

	LT_TOYLAND    = 3,

   100

   101

	NUM_LANDSCAPE = 4,

   102

};

   103

   104

struct ViewportSign {

   105

	int32 left;

   106

	int32 top;

   107

	byte width_1, width_2;

   108

};

   109

   110

enum {

   111

	SORT_ASCENDING  = 0,

   112

	SORT_DESCENDING = 1,

   113

	SORT_BY_DATE    = 0,

   114

	SORT_BY_NAME    = 2

   115

};

   116

   117

extern byte _savegame_sort_order;

   118

   119

enum {

   120

	MAX_SCREEN_WIDTH  = 2048,

   121

	MAX_SCREEN_HEIGHT = 1200,

   122

};

   123

   124

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

   125

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

   126

 * elements are zero */

   127

enum {

   128

	SCROLL_CON  = 0,

   129

	SCROLL_EDIT = 1,

   130

	SCROLL_SAVE = 2,

   131

	SCROLL_CHAT = 4,

   132

};

   133

extern byte _no_scroll;

   134

   135

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

   136

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

   137

 * in the ProcessSentMessage() function */

   138

enum ThreadMsg {

   139

	MSG_OTTD_NO_MESSAGE,

   140

	MSG_OTTD_SAVETHREAD_DONE,

   141

	MSG_OTTD_SAVETHREAD_ERROR,

   142

};

   143

   144

void OTTD_SendThreadMessage(ThreadMsg msg);

   145

   146

extern byte _game_mode;

   147

extern bool _exit_game;

   148

extern int8 _pause_game;

   149

   150

#endif /* OPENTTD_H */