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

typedef struct Rect {

    12

	int left,top,right,bottom;

    13

} Rect;

    14

    15

typedef struct Oblong {

    16

	int x, y;

    17

	int width, height;

    18

} Oblong;

    19

    20

typedef struct BoundingRect {

    21

	int width;

    22

	int height;

    23

} BoundingRect;

    24

    25

typedef struct Point {

    26

	int x,y;

    27

} Point;

    28

    29

typedef struct Pair {

    30

	int a;

    31

	int b;

    32

} Pair;

    33

    34

#include "map.h"

    35

#include "slope.h"

    36

    37

// Forward declarations of structs.

    38

typedef struct Vehicle Vehicle;

    39

typedef struct Depot Depot;

    40

typedef struct Waypoint Waypoint;

    41

typedef struct Window Window;

    42

typedef struct Station Station;

    43

typedef struct ViewPort ViewPort;

    44

typedef struct Town Town;

    45

typedef struct NewsItem NewsItem;

    46

typedef struct Industry Industry;

    47

typedef struct DrawPixelInfo DrawPixelInfo;

    48

typedef byte PlayerID;

    49

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

    50

typedef byte CargoID;

    51

typedef byte LandscapeID;

    52

typedef uint32 SpriteID;      ///< The number of a sprite, without mapping bits and colortables

    53

typedef uint32 PalSpriteID;   ///< The number of a sprite plus all the mapping bits and colortables

    54

typedef uint32 CursorID;

    55

typedef uint16 EngineID;

    56

typedef uint16 UnitID;

    57

typedef uint16 StringID;

    58

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

    59

    60

/* IDs used in Pools */

    61

typedef uint16 VehicleID;

    62

typedef uint16 StationID;

    63

typedef uint16 RoadStopID;

    64

typedef uint16 TownID;

    65

typedef uint16 IndustryID;

    66

typedef uint16 DepotID;

    67

typedef uint16 WaypointID;

    68

typedef uint16 OrderID;

    69

typedef uint16 SignID;

    70

typedef uint16 EngineRenewID;

    71

typedef uint16 DestinationID;

    72

    73

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

    74

 * be any of them

    75

 */

    76

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

    77

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

    78

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

    79

    80

typedef uint32 WindowNumber;

    81

typedef byte WindowClass;

    82

    83

enum {

    84

	INVALID_YEAR = -1,

    85

	INVALID_DATE = -1,

    86

    87

	PLAYER_FIRST    = 0x00,

    88

	INVALID_PLAYER  = 0xFF,

    89

};

    90

    91

typedef int32 Year;

    92

typedef int32 Date;

    93

    94

    95

enum GameModes {

    96

	GM_MENU,

    97

	GM_NORMAL,

    98

	GM_EDITOR

    99

};

   100

   101

enum SwitchModes {

   102

	SM_NONE            =  0,

   103

	SM_NEWGAME         =  1,

   104

	SM_EDITOR          =  2,

   105

	SM_LOAD            =  3,

   106

	SM_MENU            =  4,

   107

	SM_SAVE            =  5,

   108

	SM_GENRANDLAND     =  6,

   109

	SM_LOAD_SCENARIO   =  9,

   110

	SM_START_SCENARIO  = 10,

   111

	SM_START_HEIGHTMAP = 11,

   112

	SM_LOAD_HEIGHTMAP  = 12,

   113

};

   114

   115

   116

/* Modes for GenerateWorld */

   117

enum GenerateWorldModes {

   118

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

   119

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

   120

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

   121

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

   122

};

   123

   124

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

   125

enum InitializeGameModes {

   126

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

   127

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

   128

};

   129

   130

   131

typedef enum TransportTypes {

   132

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

   133

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

   134

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

   135

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

   136

	 * the values for road and rail.

   137

	 */

   138

	TRANSPORT_RAIL = 0,

   139

	TRANSPORT_ROAD = 1,

   140

	TRANSPORT_WATER, // = 2

   141

	TRANSPORT_END,

   142

	INVALID_TRANSPORT = 0xff,

   143

} TransportType;

   144

   145

typedef struct TileInfo {

   146

	uint x;

   147

	uint y;

   148

	Slope tileh;

   149

	TileIndex tile;

   150

	uint z;

   151

} TileInfo;

   152

   153

   154

/* Display Options */

   155

enum {

   156

	DO_SHOW_TOWN_NAMES    = 1 << 0,

   157

	DO_SHOW_STATION_NAMES = 1 << 1,

   158

	DO_SHOW_SIGNS         = 1 << 2,

   159

	DO_FULL_ANIMATION     = 1 << 3,

   160

	DO_TRANS_BUILDINGS    = 1 << 4,

   161

	DO_FULL_DETAIL        = 1 << 5,

   162

	DO_WAYPOINTS          = 1 << 6,

   163

	DO_TRANS_SIGNS        = 1 << 7,

   164

};

   165

   166

/* Landscape types */

   167

enum {

   168

	LT_NORMAL     = 0,

   169

	LT_HILLY      = 1,

   170

	LT_DESERT     = 2,

   171

	LT_CANDY      = 3,

   172

   173

	NUM_LANDSCAPE = 4,

   174

};

   175

   176

enum {

   177

	NUM_PRICES = 49,

   178

};

   179

   180

typedef struct Prices {

   181

	int32 station_value;

   182

	int32 build_rail;

   183

	int32 build_road;

   184

	int32 build_signals;

   185

	int32 build_bridge;

   186

	int32 build_train_depot;

   187

	int32 build_road_depot;

   188

	int32 build_ship_depot;

   189

	int32 build_tunnel;

   190

	int32 train_station_track;

   191

	int32 train_station_length;

   192

	int32 build_airport;

   193

	int32 build_bus_station;

   194

	int32 build_truck_station;

   195

	int32 build_dock;

   196

	int32 build_railvehicle;

   197

	int32 build_railwagon;

   198

	int32 aircraft_base;

   199

	int32 roadveh_base;

   200

	int32 ship_base;

   201

	int32 build_trees;

   202

	int32 terraform;

   203

	int32 clear_1;

   204

	int32 purchase_land;

   205

	int32 clear_2;

   206

	int32 clear_3;

   207

	int32 remove_trees;

   208

	int32 remove_rail;

   209

	int32 remove_signals;

   210

	int32 clear_bridge;

   211

	int32 remove_train_depot;

   212

	int32 remove_road_depot;

   213

	int32 remove_ship_depot;

   214

	int32 clear_tunnel;

   215

	int32 clear_water;

   216

	int32 remove_rail_station;

   217

	int32 remove_airport;

   218

	int32 remove_bus_station;

   219

	int32 remove_truck_station;

   220

	int32 remove_dock;

   221

	int32 remove_house;

   222

	int32 remove_road;

   223

	int32 running_rail[3];

   224

	int32 aircraft_running;

   225

	int32 roadveh_running;

   226

	int32 ship_running;

   227

	int32 build_industry;

   228

} Prices;

   229

   230

#define GAME_DIFFICULTY_NUM 18

   231

   232

typedef struct GameDifficulty {

   233

	int max_no_competitors;

   234

	int competitor_start_time;

   235

	int number_towns;

   236

	int number_industries;

   237

	int max_loan;

   238

	int initial_interest;

   239

	int vehicle_costs;

   240

	int competitor_speed;

   241

	int competitor_intelligence; // no longer in use

   242

	int vehicle_breakdowns;

   243

	int subsidy_multiplier;

   244

	int construction_cost;

   245

	int terrain_type;

   246

	int quantity_sea_lakes;

   247

	int economy;

   248

	int line_reverse_mode;

   249

	int disasters;

   250

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

   251

} GameDifficulty;

   252

   253

enum {

   254

	// Temperate

   255

	CT_PASSENGERS   =  0,

   256

	CT_COAL         =  1,

   257

	CT_MAIL         =  2,

   258

	CT_OIL          =  3,

   259

	CT_LIVESTOCK    =  4,

   260

	CT_GOODS        =  5,

   261

	CT_GRAIN        =  6,

   262

	CT_WOOD         =  7,

   263

	CT_IRON_ORE     =  8,

   264

	CT_STEEL        =  9,

   265

	CT_VALUABLES    = 10,

   266

	CT_FOOD         = 11,

   267

   268

	// Arctic

   269

	CT_WHEAT        =  6,

   270

	CT_HILLY_UNUSED =  8,

   271

	CT_PAPER        =  9,

   272

	CT_GOLD         = 10,

   273

   274

	// Tropic

   275

	CT_RUBBER       =  1,

   276

	CT_FRUIT        =  4,

   277

	CT_MAIZE        =  6,

   278

	CT_COPPER_ORE   =  8,

   279

	CT_WATER        =  9,

   280

	CT_DIAMONDS     = 10,

   281

   282

	// Toyland

   283

	CT_SUGAR        =  1,

   284

	CT_TOYS         =  3,

   285

	CT_BATTERIES    =  4,

   286

	CT_CANDY        =  5,

   287

	CT_TOFFEE       =  6,

   288

	CT_COLA         =  7,

   289

	CT_COTTON_CANDY =  8,

   290

	CT_BUBBLES      =  9,

   291

	CT_PLASTIC      = 10,

   292

	CT_FIZZY_DRINKS = 11,

   293

   294

	NUM_CARGO       = 12,

   295

   296

	CT_NO_REFIT     = 0xFE,

   297

	CT_INVALID      = 0xFF

   298

};

   299

   300

typedef uint AcceptedCargo[NUM_CARGO];

   301

   302

typedef struct TileDesc {

   303

	StringID str;

   304

	Owner owner;

   305

	Date build_date;

   306

	uint32 dparam[2];

   307

} TileDesc;

   308

   309

typedef struct {

   310

	int32 left;

   311

	int32 top;

   312

	byte width_1, width_2;

   313

} ViewportSign;

   314

   315

   316

typedef void DrawTileProc(TileInfo *ti);

   317

typedef uint GetSlopeZProc(TileIndex tile, uint x, uint y);

   318

typedef int32 ClearTileProc(TileIndex tile, byte flags);

   319

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

   320

typedef void GetTileDescProc(TileIndex tile, TileDesc *td);

   321

/* GetTileTrackStatusProcs return a value that contains the possible tracks

   322

 * that can be taken on a given tile by a given transport. The return value is

   323

 * composed as follows: 0xaabbccdd. ccdd and aabb are bitmasks of trackdirs,

   324

 * where bit n corresponds to trackdir n. ccdd are the trackdirs that are

   325

 * present in the tile (1==present, 0==not present), aabb is the signal

   326

 * status, if applicable (0==green/no signal, 1==red, note that this is

   327

 * reversed from map3/2[tile] for railway signals).

   328

 *

   329

 * The result (let's call it ts) is often used as follows:

   330

 * tracks = (byte)(ts | ts >>8)

   331

 * This effectively converts the present part of the result (ccdd) to a

   332

 * track bitmask, which disregards directions. Normally, this is the same as just

   333

 * doing (byte)ts I think, although I am not really sure

   334

 *

   335

 * A trackdir is combination of a track and a dir, where the lower three bits

   336

 * are a track, the fourth bit is the direction. these give 12 (or 14)

   337

 * possible options: 0-5 and 8-13, so we need 14 bits for a trackdir bitmask

   338

 * above.

   339

 */

   340

typedef uint32 GetTileTrackStatusProc(TileIndex tile, TransportType mode);

   341

typedef void GetProducedCargoProc(TileIndex tile, CargoID *b);

   342

typedef void ClickTileProc(TileIndex tile);

   343

typedef void AnimateTileProc(TileIndex tile);

   344

typedef void TileLoopProc(TileIndex tile);

   345

typedef void ChangeTileOwnerProc(TileIndex tile, PlayerID old_player, PlayerID new_player);

   346

/* Return value has bit 0x2 set, when the vehicle enters a station. Then,

   347

 * result << 8 contains the id of the station entered. If the return value has

   348

 * bit 0x8 set, the vehicle could not and did not enter the tile. Are there

   349

 * other bits that can be set? */

   350

typedef uint32 VehicleEnterTileProc(Vehicle *v, TileIndex tile, int x, int y);

   351

typedef Slope GetSlopeTilehProc(TileIndex, Slope tileh);

   352

   353

typedef struct {

   354

	DrawTileProc *draw_tile_proc;

   355

	GetSlopeZProc *get_slope_z_proc;

   356

	ClearTileProc *clear_tile_proc;

   357

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   358

	GetTileDescProc *get_tile_desc_proc;

   359

	GetTileTrackStatusProc *get_tile_track_status_proc;

   360

	ClickTileProc *click_tile_proc;

   361

	AnimateTileProc *animate_tile_proc;

   362

	TileLoopProc *tile_loop_proc;

   363

	ChangeTileOwnerProc *change_tile_owner_proc;

   364

	GetProducedCargoProc *get_produced_cargo_proc;

   365

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   366

	GetSlopeTilehProc *get_slope_tileh_proc;

   367

} TileTypeProcs;

   368

   369

   370

enum {

   371

	WC_MAIN_WINDOW              = 0x00,

   372

	WC_MAIN_TOOLBAR             = 0x01,

   373

	WC_STATUS_BAR               = 0x02,

   374

	WC_BUILD_TOOLBAR            = 0x03,

   375

	WC_NEWS_WINDOW              = 0x04,

   376

	WC_TOWN_DIRECTORY           = 0x05,

   377

	WC_STATION_LIST             = 0x06,

   378

	WC_TOWN_VIEW                = 0x07,

   379

	WC_SMALLMAP                 = 0x08,

   380

	WC_TRAINS_LIST              = 0x09,

   381

	WC_ROADVEH_LIST             = 0x0A,

   382

	WC_SHIPS_LIST               = 0x0B,

   383

	WC_AIRCRAFT_LIST            = 0x0C,

   384

	WC_VEHICLE_VIEW             = 0x0D,

   385

	WC_VEHICLE_DETAILS          = 0x0E,

   386

	WC_VEHICLE_REFIT            = 0x0F,

   387

	WC_VEHICLE_ORDERS           = 0x10,

   388

	WC_STATION_VIEW             = 0x11,

   389

	WC_VEHICLE_DEPOT            = 0x12,

   390

	WC_BUILD_VEHICLE            = 0x13,

   391

	WC_BUILD_BRIDGE             = 0x14,

   392

	WC_ERRMSG                   = 0x15,

   393

	WC_ASK_ABANDON_GAME         = 0x16,

   394

	WC_QUIT_GAME                = 0x17,

   395

	WC_BUILD_STATION            = 0x18,

   396

	WC_BUS_STATION              = 0x19,

   397

	WC_TRUCK_STATION            = 0x1A,

   398

	WC_BUILD_DEPOT              = 0x1B,

   399

	WC_COMPANY                  = 0x1D,

   400

	WC_FINANCES                 = 0x1E,

   401

	WC_PLAYER_COLOR             = 0x1F,

   402

	WC_QUERY_STRING             = 0x20,

   403

	WC_SAVELOAD                 = 0x21,

   404

	WC_SELECT_GAME              = 0x22,

   405

	WC_TOOLBAR_MENU             = 0x24,

   406

	WC_INCOME_GRAPH             = 0x25,

   407

	WC_OPERATING_PROFIT         = 0x26,

   408

	WC_TOOLTIPS                 = 0x27,

   409

	WC_INDUSTRY_VIEW            = 0x28,

   410

	WC_PLAYER_FACE              = 0x29,

   411

	WC_LAND_INFO                = 0x2A,

   412

	WC_TOWN_AUTHORITY           = 0x2B,

   413

	WC_SUBSIDIES_LIST           = 0x2C,

   414

	WC_GRAPH_LEGEND             = 0x2D,

   415

	WC_DELIVERED_CARGO          = 0x2E,

   416

	WC_PERFORMANCE_HISTORY      = 0x2F,

   417

	WC_COMPANY_VALUE            = 0x30,

   418

	WC_COMPANY_LEAGUE           = 0x31,

   419

	WC_BUY_COMPANY              = 0x32,

   420

	WC_PAYMENT_RATES            = 0x33,

   421

	WC_ENGINE_PREVIEW           = 0x35,

   422

	WC_MUSIC_WINDOW             = 0x36,

   423

	WC_MUSIC_TRACK_SELECTION    = 0x37,

   424

	WC_SCEN_LAND_GEN            = 0x38, // also used for landscaping toolbar

   425

	WC_ASK_RESET_LANDSCAPE      = 0x39,

   426

	WC_SCEN_TOWN_GEN            = 0x3A,

   427

	WC_SCEN_INDUSTRY            = 0x3B,

   428

	WC_SCEN_BUILD_ROAD          = 0x3C,

   429

	WC_BUILD_TREES              = 0x3D,

   430

	WC_SEND_NETWORK_MSG         = 0x3E,

   431

	WC_DROPDOWN_MENU            = 0x3F,

   432

	WC_BUILD_INDUSTRY           = 0x40,

   433

	WC_GAME_OPTIONS             = 0x41,

   434

	WC_NETWORK_WINDOW           = 0x42,

   435

	WC_INDUSTRY_DIRECTORY       = 0x43,

   436

	WC_MESSAGE_HISTORY          = 0x44,

   437

	WC_CHEATS                   = 0x45,

   438

	WC_PERFORMANCE_DETAIL       = 0x46,

   439

	WC_CONSOLE                  = 0x47,

   440

	WC_EXTRA_VIEW_PORT          = 0x48,

   441

	WC_CLIENT_LIST              = 0x49,

   442

	WC_NETWORK_STATUS_WINDOW    = 0x4A,

   443

	WC_CUSTOM_CURRENCY          = 0x4B,

   444

	WC_REPLACE_VEHICLE          = 0x4C,

   445

	WC_HIGHSCORE                = 0x4D,

   446

	WC_ENDSCREEN                = 0x4E,

   447

	WC_SIGN_LIST                = 0x4F,

   448

	WC_GENERATE_LANDSCAPE       = 0x50,

   449

	WC_GENERATE_PROGRESS_WINDOW = 0x51,

   450

	WC_OK_CANCEL_QUERY          = 0x52,

   451

	WC_DEPOT_SELL_ALL           = 0x53,

   452

};

   453

   454

   455

enum {

   456

	EXPENSES_CONSTRUCTION =  0,

   457

	EXPENSES_NEW_VEHICLES =  1,

   458

	EXPENSES_TRAIN_RUN    =  2,

   459

	EXPENSES_ROADVEH_RUN  =  3,

   460

	EXPENSES_AIRCRAFT_RUN =  4,

   461

	EXPENSES_SHIP_RUN     =  5,

   462

	EXPENSES_PROPERTY     =  6,

   463

	EXPENSES_TRAIN_INC    =  7,

   464

	EXPENSES_ROADVEH_INC  =  8,

   465

	EXPENSES_AIRCRAFT_INC =  9,

   466

	EXPENSES_SHIP_INC     = 10,

   467

	EXPENSES_LOAN_INT     = 11,

   468

	EXPENSES_OTHER        = 12,

   469

};

   470

   471

enum {

   472

	MAX_LANG = 64,

   473

};

   474

   475

// special string constants

   476

enum SpecialStrings {

   477

   478

	// special strings for town names. the town name is generated dynamically on request.

   479

	SPECSTR_TOWNNAME_START     = 0x20C0,

   480

	SPECSTR_TOWNNAME_ENGLISH   = SPECSTR_TOWNNAME_START,

   481

	SPECSTR_TOWNNAME_FRENCH,

   482

	SPECSTR_TOWNNAME_GERMAN,

   483

	SPECSTR_TOWNNAME_AMERICAN,

   484

	SPECSTR_TOWNNAME_LATIN,

   485

	SPECSTR_TOWNNAME_SILLY,

   486

	SPECSTR_TOWNNAME_SWEDISH,

   487

	SPECSTR_TOWNNAME_DUTCH,

   488

	SPECSTR_TOWNNAME_FINNISH,

   489

	SPECSTR_TOWNNAME_POLISH,

   490

	SPECSTR_TOWNNAME_SLOVAKISH,

   491

	SPECSTR_TOWNNAME_NORWEGIAN,

   492

	SPECSTR_TOWNNAME_HUNGARIAN,

   493

	SPECSTR_TOWNNAME_AUSTRIAN,

   494

	SPECSTR_TOWNNAME_ROMANIAN,

   495

	SPECSTR_TOWNNAME_CZECH,

   496

	SPECSTR_TOWNNAME_SWISS,

   497

	SPECSTR_TOWNNAME_DANISH,

   498

	SPECSTR_TOWNNAME_TURKISH,

   499

	SPECSTR_TOWNNAME_ITALIAN,

   500

	SPECSTR_TOWNNAME_CATALAN,