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

    14

struct DrawPixelInfo;

    15

typedef byte LandscapeID;

    16

typedef uint16 EngineID;

    17

typedef uint16 UnitID;

    18

    19

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

    20

    21

/* IDs used in Pools */

    22

typedef uint16 WaypointID;

    23

typedef uint16 EngineRenewID;

    24

    25

enum GameModes {

    26

	GM_MENU,

    27

	GM_NORMAL,

    28

	GM_EDITOR

    29

};

    30

    31

enum SwitchModes {

    32

	SM_NONE            =  0,

    33

	SM_NEWGAME         =  1,

    34

	SM_EDITOR          =  2,

    35

	SM_LOAD            =  3,

    36

	SM_MENU            =  4,

    37

	SM_SAVE            =  5,

    38

	SM_GENRANDLAND     =  6,

    39

	SM_LOAD_SCENARIO   =  9,

    40

	SM_START_SCENARIO  = 10,

    41

	SM_START_HEIGHTMAP = 11,

    42

	SM_LOAD_HEIGHTMAP  = 12,

    43

};

    44

    45

    46

/* Modes for GenerateWorld */

    47

enum GenerateWorldModes {

    48

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

    49

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

    50

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

    51

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

    52

};

    53

    54

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

    55

enum InitializeGameModes {

    56

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

    57

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

    58

};

    59

    60

enum TransportType {

    61

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

    62

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

    63

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

    64

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

    65

	 * the values for road and rail.

    66

	 */

    67

	TRANSPORT_BEGIN = 0,

    68

	TRANSPORT_RAIL = 0,

    69

	TRANSPORT_ROAD = 1,

    70

	TRANSPORT_WATER, // = 2

    71

	TRANSPORT_END,

    72

	INVALID_TRANSPORT = 0xff,

    73

};

    74

    75

/* Display Options */

    76

enum {

    77

	DO_SHOW_TOWN_NAMES    = 0,

    78

	DO_SHOW_STATION_NAMES = 1,

    79

	DO_SHOW_SIGNS         = 2,

    80

	DO_FULL_ANIMATION     = 3,

    81

	DO_FULL_DETAIL        = 5,

    82

	DO_WAYPOINTS          = 6,

    83

};

    84

    85

/* Landscape types */

    86

enum {

    87

	LT_TEMPERATE  = 0,

    88

	LT_ARCTIC     = 1,

    89

	LT_TROPIC     = 2,

    90

	LT_TOYLAND    = 3,

    91

    92

	NUM_LANDSCAPE = 4,

    93

};

    94

    95

struct ViewportSign {

    96

	int32 left;

    97

	int32 top;

    98

	byte width_1, width_2;

    99

};

   100

   101

enum {

   102

	SORT_ASCENDING  = 0,

   103

	SORT_DESCENDING = 1,

   104

	SORT_BY_DATE    = 0,

   105

	SORT_BY_NAME    = 2

   106

};

   107

   108

extern byte _savegame_sort_order;

   109

   110

enum {

   111

	MAX_SCREEN_WIDTH  = 2048,

   112

	MAX_SCREEN_HEIGHT = 1200,

   113

};

   114

   115

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

   116

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

   117

 * elements are zero */

   118

enum {

   119

	SCROLL_CON  = 0,

   120

	SCROLL_EDIT = 1,

   121

	SCROLL_SAVE = 2,

   122

	SCROLL_CHAT = 4,

   123

};

   124

extern byte _no_scroll;

   125

   126

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

   127

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

   128

 * in the ProcessSentMessage() function */

   129

enum ThreadMsg {

   130

	MSG_OTTD_NO_MESSAGE,

   131

	MSG_OTTD_SAVETHREAD_DONE,

   132

	MSG_OTTD_SAVETHREAD_ERROR,

   133

};

   134

   135

void OTTD_SendThreadMessage(ThreadMsg msg);

   136

   137

extern byte _game_mode;

   138

extern bool _exit_game;

   139

extern int8 _pause_game;

   140

   141

#endif /* OPENTTD_H */