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

typedef byte LandscapeID;

    13

typedef uint16 UnitID;

    14

    15

enum GameModes {

    16

	GM_MENU,

    17

	GM_NORMAL,

    18

	GM_EDITOR

    19

};

    20

    21

enum SwitchModes {

    22

	SM_NONE            =  0,

    23

	SM_NEWGAME         =  1,

    24

	SM_EDITOR          =  2,

    25

	SM_LOAD            =  3,

    26

	SM_MENU            =  4,

    27

	SM_SAVE            =  5,

    28

	SM_GENRANDLAND     =  6,

    29

	SM_LOAD_SCENARIO   =  9,

    30

	SM_START_SCENARIO  = 10,

    31

	SM_START_HEIGHTMAP = 11,

    32

	SM_LOAD_HEIGHTMAP  = 12,

    33

};

    34

    35

    36

/* Modes for GenerateWorld */

    37

enum GenerateWorldModes {

    38

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

    39

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

    40

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

    41

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

    42

};

    43

    44

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

    45

enum InitializeGameModes {

    46

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

    47

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

    48

};

    49

    50

enum TransportType {

    51

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

    52

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

    53

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

    54

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

    55

	 * the values for road and rail.

    56

	 */

    57

	TRANSPORT_BEGIN = 0,

    58

	TRANSPORT_RAIL = 0,

    59

	TRANSPORT_ROAD = 1,

    60

	TRANSPORT_WATER, // = 2

    61

	TRANSPORT_END,

    62

	INVALID_TRANSPORT = 0xff,

    63

};

    64

    65

/* Display Options */

    66

enum {

    67

	DO_SHOW_TOWN_NAMES    = 0,

    68

	DO_SHOW_STATION_NAMES = 1,

    69

	DO_SHOW_SIGNS         = 2,

    70

	DO_FULL_ANIMATION     = 3,

    71

	DO_FULL_DETAIL        = 5,

    72

	DO_WAYPOINTS          = 6,

    73

};

    74

    75

/* Landscape types */

    76

enum {

    77

	LT_TEMPERATE  = 0,

    78

	LT_ARCTIC     = 1,

    79

	LT_TROPIC     = 2,

    80

	LT_TOYLAND    = 3,

    81

    82

	NUM_LANDSCAPE = 4,

    83

};

    84

    85

struct ViewportSign {

    86

	int32 left;

    87

	int32 top;

    88

	byte width_1, width_2;

    89

};

    90

    91

enum {

    92

	SORT_ASCENDING  = 0,

    93

	SORT_DESCENDING = 1,

    94

	SORT_BY_DATE    = 0,

    95

	SORT_BY_NAME    = 2

    96

};

    97

    98

extern byte _savegame_sort_order;

    99

   100

enum {

   101

	MAX_SCREEN_WIDTH  = 2048,

   102

	MAX_SCREEN_HEIGHT = 1200,

   103

};

   104

   105

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

   106

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

   107

 * elements are zero */

   108

enum {

   109

	SCROLL_CON  = 0,

   110

	SCROLL_EDIT = 1,

   111

	SCROLL_SAVE = 2,

   112

	SCROLL_CHAT = 4,

   113

};

   114

extern byte _no_scroll;

   115

   116

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

   117

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

   118

 * in the ProcessSentMessage() function */

   119

enum ThreadMsg {

   120

	MSG_OTTD_NO_MESSAGE,

   121

	MSG_OTTD_SAVETHREAD_DONE,

   122

	MSG_OTTD_SAVETHREAD_ERROR,

   123

};

   124

   125

void OTTD_SendThreadMessage(ThreadMsg msg);

   126

   127

extern byte _game_mode;

   128

extern bool _exit_game;

   129

extern int8 _pause_game;

   130

   131

#endif /* OPENTTD_H */