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

#include "strings_type.h"

    12

    13

#include "map.h"

    14

#include "slope_type.h"

    15

    16

// Forward declarations of structs.

    17

struct Depot;

    18

struct Waypoint;

    19

struct Station;

    20

struct ViewPort;

    21

struct Town;

    22

struct NewsItem;

    23

struct Industry;

    24

struct DrawPixelInfo;

    25

struct Group;

    26

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

    27

typedef byte LandscapeID;

    28

typedef uint16 EngineID;

    29

typedef uint16 UnitID;

    30

    31

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

    32

    33

/* IDs used in Pools */

    34

typedef uint16 StationID;

    35

static const StationID INVALID_STATION = 0xFFFF;

    36

typedef uint16 RoadStopID;

    37

typedef uint16 TownID;

    38

typedef uint16 IndustryID;

    39

typedef uint16 DepotID;

    40

typedef uint16 WaypointID;

    41

typedef uint16 OrderID;

    42

typedef uint16 SignID;

    43

typedef uint16 GroupID;

    44

typedef uint16 EngineRenewID;

    45

typedef uint16 DestinationID;

    46

    47

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

    48

 * be any of them

    49

 */

    50

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

    51

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

    52

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

    53

    54

    55

enum {

    56

	INVALID_YEAR = -1,

    57

	INVALID_DATE = -1,

    58

};

    59

    60

typedef int32 Year;

    61

typedef int32 Date;

    62

    63

typedef uint32 PlayerFace; ///< player face bits, info see in player_face.h

    64

    65

enum GameModes {

    66

	GM_MENU,

    67

	GM_NORMAL,

    68

	GM_EDITOR

    69

};

    70

    71

enum SwitchModes {

    72

	SM_NONE            =  0,

    73

	SM_NEWGAME         =  1,

    74

	SM_EDITOR          =  2,

    75

	SM_LOAD            =  3,

    76

	SM_MENU            =  4,

    77

	SM_SAVE            =  5,

    78

	SM_GENRANDLAND     =  6,

    79

	SM_LOAD_SCENARIO   =  9,

    80

	SM_START_SCENARIO  = 10,

    81

	SM_START_HEIGHTMAP = 11,

    82

	SM_LOAD_HEIGHTMAP  = 12,

    83

};

    84

    85

    86

/* Modes for GenerateWorld */

    87

enum GenerateWorldModes {

    88

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

    89

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

    90

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

    91

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

    92

};

    93

    94

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

    95

enum InitializeGameModes {

    96

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

    97

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

    98

};

    99

   100

enum Owner {

   101

	PLAYER_INACTIVE_CLIENT = 253,

   102

	PLAYER_NEW_COMPANY = 254,

   103

	PLAYER_SPECTATOR = 255,

   104

	OWNER_BEGIN     = 0x00,

   105

	PLAYER_FIRST    = 0x00,

   106

	MAX_PLAYERS     = 8,

   107

	OWNER_TOWN      = 0x0F, // a town owns the tile

   108

	OWNER_NONE      = 0x10, // nobody owns the tile

   109

	OWNER_WATER     = 0x11, // "water" owns the tile

   110

	OWNER_END       = 0x12,

   111

	INVALID_OWNER   = 0xFF,

   112

	INVALID_PLAYER  = 0xFF,

   113

	/* Player identifiers All players below MAX_PLAYERS are playable

   114

	* players, above, they are special, computer controlled players */

   115

};

   116

   117

typedef Owner PlayerID;

   118

   119

DECLARE_POSTFIX_INCREMENT(Owner);

   120

   121

/** Define basic enum properties */

   122

template <> struct EnumPropsT<Owner> : MakeEnumPropsT<Owner, byte, OWNER_BEGIN, OWNER_END, INVALID_OWNER> {};

   123

typedef TinyEnumT<Owner> OwnerByte;

   124

typedef OwnerByte PlayerByte;

   125

   126

   127

enum TransportType {

   128

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

   129

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

   130

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

   131

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

   132

	 * the values for road and rail.

   133

	 */

   134

	TRANSPORT_BEGIN = 0,

   135

	TRANSPORT_RAIL = 0,

   136

	TRANSPORT_ROAD = 1,

   137

	TRANSPORT_WATER, // = 2

   138

	TRANSPORT_END,

   139

	INVALID_TRANSPORT = 0xff,

   140

};

   141

   142

/** Define basic enum properties */

   143

template <> struct EnumPropsT<TransportType> : MakeEnumPropsT<TransportType, byte, TRANSPORT_BEGIN, TRANSPORT_END, INVALID_TRANSPORT> {};

   144

typedef TinyEnumT<TransportType> TransportTypeByte;

   145

   146

   147

struct TileInfo {

   148

	uint x;

   149

	uint y;

   150

	Slope tileh;

   151

	TileIndex tile;

   152

	uint z;

   153

};

   154

   155

   156

/* Display Options */

   157

enum {

   158

	DO_SHOW_TOWN_NAMES    = 0,

   159

	DO_SHOW_STATION_NAMES = 1,

   160

	DO_SHOW_SIGNS         = 2,

   161

	DO_FULL_ANIMATION     = 3,

   162

	DO_FULL_DETAIL        = 5,

   163

	DO_WAYPOINTS          = 6,

   164

};

   165

   166

/* Landscape types */

   167

enum {

   168

	LT_TEMPERATE  = 0,

   169

	LT_ARCTIC     = 1,

   170

	LT_TROPIC     = 2,

   171

	LT_TOYLAND    = 3,

   172

   173

	NUM_LANDSCAPE = 4,

   174

};

   175

   176

/**

   177

 * Town Layouts

   178

 */

   179

enum TownLayout {

   180

	TL_NO_ROADS     = 0, ///< Build no more roads, but still build houses

   181

	TL_ORIGINAL,         ///< Original algorithm (min. 1 distance between roads)

   182

	TL_BETTER_ROADS,     ///< Extended original algorithm (min. 2 distance between roads)

   183

	TL_2X2_GRID,         ///< Geometric 2x2 grid algorithm

   184

	TL_3X3_GRID,         ///< Geometric 3x3 grid algorithm

   185

   186

	NUM_TLS,             ///< Number of town layouts

   187

};

   188

   189

/* It needs to be 8bits, because we save and load it as such */

   190

/** Define basic enum properties */

   191

template <> struct EnumPropsT<TownLayout> : MakeEnumPropsT<TownLayout, byte, TL_NO_ROADS, NUM_TLS, NUM_TLS> {};

   192

typedef TinyEnumT<TownLayout> TownLayoutByte; //typedefing-enumification of TownLayout

   193

   194

#define GAME_DIFFICULTY_NUM 18

   195

   196

/** Specific type for Game Difficulty to ease changing the type */

   197

typedef uint16 GDType;

   198

struct GameDifficulty {

   199

	GDType max_no_competitors;

   200

	GDType competitor_start_time;

   201

	GDType number_towns;

   202

	GDType number_industries;

   203

	GDType max_loan;

   204

	GDType initial_interest;

   205

	GDType vehicle_costs;

   206

	GDType competitor_speed;

   207

	GDType competitor_intelligence; // no longer in use

   208

	GDType vehicle_breakdowns;

   209

	GDType subsidy_multiplier;

   210

	GDType construction_cost;

   211

	GDType terrain_type;

   212

	GDType quantity_sea_lakes;

   213

	GDType economy;

   214

	GDType line_reverse_mode;

   215

	GDType disasters;

   216

	GDType town_council_tolerance; // minimum required town ratings to be allowed to demolish stuff

   217

};

   218

   219

struct TileDesc {

   220

	StringID str;

   221

	Owner owner;

   222

	Date build_date;

   223

	uint64 dparam[2];

   224

};

   225

   226

struct ViewportSign {

   227

	int32 left;

   228

	int32 top;

   229

	byte width_1, width_2;

   230

};

   231

   232

typedef void PlaceProc(TileIndex tile);

   233

   234

enum {

   235

	SORT_ASCENDING  = 0,

   236

	SORT_DESCENDING = 1,

   237

	SORT_BY_DATE    = 0,

   238

	SORT_BY_NAME    = 2

   239

};

   240

   241

VARDEF byte _savegame_sort_order;

   242

   243

enum {

   244

	MAX_SCREEN_WIDTH  = 2048,

   245

	MAX_SCREEN_HEIGHT = 1200,

   246

};

   247

   248

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

   249

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

   250

 * elements are zero */

   251

enum {

   252

	SCROLL_CON  = 0,

   253

	SCROLL_EDIT = 1,

   254

	SCROLL_SAVE = 2,

   255

	SCROLL_CHAT = 4,

   256

};

   257

VARDEF byte _no_scroll;

   258

   259

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

   260

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

   261

 * in the ProcessSentMessage() function */

   262

enum ThreadMsg {

   263

	MSG_OTTD_NO_MESSAGE,

   264

	MSG_OTTD_SAVETHREAD_DONE,

   265

	MSG_OTTD_SAVETHREAD_ERROR,

   266

};

   267

   268

void OTTD_SendThreadMessage(ThreadMsg msg);

   269

   270

extern byte _game_mode;

   271

extern bool _exit_game;

   272

extern byte _pause_game;

   273

   274

#endif /* OPENTTD_H */