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 "hal.h"

    12

#include "helpers.hpp"

    13

    14

struct Oblong {

    15

	int x, y;

    16

	int width, height;

    17

};

    18

    19

struct BoundingRect {

    20

	int width;

    21

	int height;

    22

};

    23

    24

struct Pair {

    25

	int a;

    26

	int b;

    27

};

    28

    29

#include "map.h"

    30

#include "slope.h"

    31

    32

// Forward declarations of structs.

    33

struct Vehicle;

    34

struct Depot;

    35

struct Waypoint;

    36

struct Window;

    37

struct Station;

    38

struct ViewPort;

    39

struct Town;

    40

struct NewsItem;

    41

struct Industry;

    42

struct DrawPixelInfo;

    43

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

    44

typedef byte CargoID;

    45

typedef byte LandscapeID;

    46

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

    47

struct PalSpriteID {

    48

	SpriteID sprite;

    49

	SpriteID pal;

    50

};

    51

typedef uint16 EngineID;

    52

typedef uint16 UnitID;

    53

typedef uint16 StringID;

    54

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

    55

    56

/* IDs used in Pools */

    57

typedef uint16 VehicleID;

    58

typedef uint16 StationID;

    59

typedef uint16 RoadStopID;

    60

typedef uint16 TownID;

    61

typedef uint16 IndustryID;

    62

typedef uint16 DepotID;

    63

typedef uint16 WaypointID;

    64

typedef uint16 OrderID;

    65

typedef uint16 SignID;

    66

typedef uint16 EngineRenewID;

    67

typedef uint16 DestinationID;

    68

    69

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

    70

 * be any of them

    71

 */

    72

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

    73

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

    74

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

    75

    76

typedef int32 WindowNumber;

    77

    78

enum {

    79

	INVALID_YEAR = -1,

    80

	INVALID_DATE = -1,

    81

};

    82

    83

typedef int32 Year;

    84

typedef int32 Date;

    85

    86

    87

enum SwitchModes {

    88

	SM_NONE            =  0,

    89

	SM_NEWGAME         =  1,

    90

	SM_EDITOR          =  2,

    91

	SM_LOAD            =  3,

    92

	SM_MENU            =  4,

    93

	SM_SAVE            =  5,

    94

	SM_GENRANDLAND     =  6,

    95

	SM_LOAD_SCENARIO   =  9,

    96

	SM_START_SCENARIO  = 10,

    97

	SM_START_HEIGHTMAP = 11,

    98

	SM_LOAD_HEIGHTMAP  = 12,

    99

};

   100

   101

   102

/* Modes for GenerateWorld */

   103

enum GenerateWorldModes {

   104

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

   105

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

   106

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

   107

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

   108

};

   109

   110

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

   111

enum InitializeGameModes {

   112

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

   113

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

   114

};

   115

   116

enum Owner {

   117

	PLAYER_INACTIVE_CLIENT = 253,

   118

	PLAYER_NEW_COMPANY = 254,

   119

	PLAYER_SPECTATOR = 255,

   120

	OWNER_BEGIN     = 0x00,

   121

	PLAYER_FIRST    = 0x00,

   122

	MAX_PLAYERS     = 8,

   123

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

   124

	OWNER_NONE      = 0x10, // nobody owns the tile

   125

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

   126

	OWNER_END       = 0x12,

   127

	INVALID_OWNER   = 0xFF,

   128

	INVALID_PLAYER  = 0xFF,

   129

	/* Player identifiers All players below MAX_PLAYERS are playable

   130

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

   131

};

   132

   133

typedef Owner PlayerID;

   134

   135

DECLARE_POSTFIX_INCREMENT(Owner);

   136

   137

/** Define basic enum properties */

   138

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

   139

typedef TinyEnumT<Owner> OwnerByte;

   140

typedef OwnerByte PlayerByte;

   141

   142

   143

enum TransportType {

   144

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

   145

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

   146

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

   147

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

   148

	 * the values for road and rail.

   149

	 */

   150

	TRANSPORT_BEGIN = 0,

   151

	TRANSPORT_RAIL = 0,

   152

	TRANSPORT_ROAD = 1,

   153

	TRANSPORT_WATER, // = 2

   154

	TRANSPORT_END,

   155

	INVALID_TRANSPORT = 0xff,

   156

};

   157

   158

/** Define basic enum properties */

   159

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

   160

typedef TinyEnumT<TransportType> TransportTypeByte;

   161

   162

   163

struct TileInfo {

   164

	uint x;

   165

	uint y;

   166

	Slope tileh;

   167

	TileIndex tile;

   168

	uint z;

   169

};

   170

   171

   172

/* Display Options */

   173

enum {

   174

	DO_SHOW_TOWN_NAMES    = 1 << 0,

   175

	DO_SHOW_STATION_NAMES = 1 << 1,

   176

	DO_SHOW_SIGNS         = 1 << 2,

   177

	DO_FULL_ANIMATION     = 1 << 3,

   178

	DO_FULL_DETAIL        = 1 << 5,

   179

	DO_WAYPOINTS          = 1 << 6,

   180

};

   181

   182

enum {

   183

	TO_SIGNS,

   184

	TO_TREES,

   185

	TO_HOUSES,

   186

	TO_INDUSTRIES,

   187

	TO_BUILDINGS,

   188

	TO_BRIDGES,

   189

	TO_STRUCTURES,

   190

};

   191

   192

/* Landscape types */

   193

enum {

   194

	LT_TEMPERATE  = 0,

   195

	LT_ARCTIC     = 1,

   196

	LT_TROPIC     = 2,

   197

	LT_TOYLAND    = 3,

   198

   199

	NUM_LANDSCAPE = 4,

   200

};

   201

   202

enum {

   203

	NUM_PRICES = 49,

   204

};

   205

   206

struct Prices {

   207

	int32 station_value;

   208

	int32 build_rail;

   209

	int32 build_road;

   210

	int32 build_signals;

   211

	int32 build_bridge;

   212

	int32 build_train_depot;

   213

	int32 build_road_depot;

   214

	int32 build_ship_depot;

   215

	int32 build_tunnel;

   216

	int32 train_station_track;

   217

	int32 train_station_length;

   218

	int32 build_airport;

   219

	int32 build_bus_station;

   220

	int32 build_truck_station;

   221

	int32 build_dock;

   222

	int32 build_railvehicle;

   223

	int32 build_railwagon;

   224

	int32 aircraft_base;

   225

	int32 roadveh_base;

   226

	int32 ship_base;

   227

	int32 build_trees;

   228

	int32 terraform;

   229

	int32 clear_1;

   230

	int32 purchase_land;

   231

	int32 clear_2;

   232

	int32 clear_3;

   233

	int32 remove_trees;

   234

	int32 remove_rail;

   235

	int32 remove_signals;

   236

	int32 clear_bridge;

   237

	int32 remove_train_depot;

   238

	int32 remove_road_depot;

   239

	int32 remove_ship_depot;

   240

	int32 clear_tunnel;

   241

	int32 clear_water;

   242

	int32 remove_rail_station;

   243

	int32 remove_airport;

   244

	int32 remove_bus_station;

   245

	int32 remove_truck_station;

   246

	int32 remove_dock;

   247

	int32 remove_house;

   248

	int32 remove_road;

   249

	int32 running_rail[3];

   250

	int32 aircraft_running;

   251

	int32 roadveh_running;

   252

	int32 ship_running;

   253

	int32 build_industry;

   254

};

   255

   256

#define GAME_DIFFICULTY_NUM 18

   257

   258

struct GameDifficulty {

   259

	int max_no_competitors;

   260

	int competitor_start_time;

   261

	int number_towns;

   262

	int number_industries;

   263

	int max_loan;

   264

	int initial_interest;

   265

	int vehicle_costs;

   266

	int competitor_speed;

   267

	int competitor_intelligence; // no longer in use

   268

	int vehicle_breakdowns;

   269

	int subsidy_multiplier;

   270

	int construction_cost;

   271

	int terrain_type;

   272

	int quantity_sea_lakes;

   273

	int economy;

   274

	int line_reverse_mode;

   275

	int disasters;

   276

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

   277

};

   278

   279

enum {

   280

	// Temperate

   281

	CT_PASSENGERS   =  0,

   282

	CT_COAL         =  1,

   283

	CT_MAIL         =  2,

   284

	CT_OIL          =  3,

   285

	CT_LIVESTOCK    =  4,

   286

	CT_GOODS        =  5,

   287

	CT_GRAIN        =  6,

   288

	CT_WOOD         =  7,

   289

	CT_IRON_ORE     =  8,

   290

	CT_STEEL        =  9,

   291

	CT_VALUABLES    = 10,

   292

   293

	// Arctic

   294

	CT_WHEAT        =  6,

   295

	CT_HILLY_UNUSED =  8,

   296

	CT_PAPER        =  9,

   297

	CT_GOLD         = 10,

   299

   300

	// Tropic

   301

	CT_RUBBER       =  1,

   302

	CT_FRUIT        =  4,

   303

	CT_MAIZE        =  6,

   304

	CT_COPPER_ORE   =  8,

   305

	CT_WATER        =  9,

   306

	CT_DIAMONDS     = 10,

   307

   308

	// Toyland

   309

	CT_SUGAR        =  1,

   310

	CT_TOYS         =  3,

   311

	CT_BATTERIES    =  4,

   312

	CT_CANDY        =  5,

   313

	CT_TOFFEE       =  6,

   314

	CT_COLA         =  7,

   315

	CT_COTTON_CANDY =  8,

   316

	CT_BUBBLES      =  9,

   317

	CT_PLASTIC      = 10,

   318

	CT_FIZZY_DRINKS = 11,

   319

   321

   322

	CT_NO_REFIT     = 0xFE,

   323

	CT_INVALID      = 0xFF

   324

};

   325

   326

typedef uint AcceptedCargo[NUM_CARGO];

   327

   328

struct TileDesc {

   329

	StringID str;

   330

	Owner owner;

   331

	Date build_date;

   332

	uint32 dparam[2];

   333

};

   334

   335

struct ViewportSign {

   336

	int32 left;

   337

	int32 top;

   338

	byte width_1, width_2;

   339

};

   340

   341

   342

typedef void DrawTileProc(TileInfo *ti);

   343

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

   344

typedef int32 ClearTileProc(TileIndex tile, byte flags);

   345

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

   346

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

   347

/* GetTileTrackStatusProcs return a value that contains the possible tracks

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

 *

   355

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

   356

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

   357

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

   358

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

   359

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

   360

 *

   361

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

   362

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

   363

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

   364

 * above.

   365

 */

   366

typedef uint32 GetTileTrackStatusProc(TileIndex tile, TransportType mode);

   367

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

   368

typedef void ClickTileProc(TileIndex tile);

   369

typedef void AnimateTileProc(TileIndex tile);

   370

typedef void TileLoopProc(TileIndex tile);

   371

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

   372

/** @see VehicleEnterTileStatus to see what the return values mean */

   373

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

   374

typedef Slope GetSlopeTilehProc(TileIndex, Slope tileh);

   375

   376

struct TileTypeProcs {

   377

	DrawTileProc *draw_tile_proc;

   378

	GetSlopeZProc *get_slope_z_proc;

   379

	ClearTileProc *clear_tile_proc;

   380

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   381

	GetTileDescProc *get_tile_desc_proc;

   382

	GetTileTrackStatusProc *get_tile_track_status_proc;

   383

	ClickTileProc *click_tile_proc;

   384

	AnimateTileProc *animate_tile_proc;

   385

	TileLoopProc *tile_loop_proc;

   386

	ChangeTileOwnerProc *change_tile_owner_proc;

   387

	GetProducedCargoProc *get_produced_cargo_proc;

   388

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   389

	GetSlopeTilehProc *get_slope_tileh_proc;

   390

};

   391

   392

   393

enum WindowClass {

   394

	WC_UNKNOWN = -1,

   395

	WC_NONE = 0,

   396

	WC_MAIN_WINDOW = WC_NONE,

   397

	WC_MAIN_TOOLBAR,

   398

	WC_STATUS_BAR,

   399

	WC_BUILD_TOOLBAR,

   400

	WC_NEWS_WINDOW,

   401

	WC_TOWN_DIRECTORY,

   402

	WC_STATION_LIST,

   403

	WC_TOWN_VIEW,

   404

	WC_SMALLMAP,

   405

	WC_TRAINS_LIST,

   406

	WC_ROADVEH_LIST,

   407

	WC_SHIPS_LIST,

   408

	WC_AIRCRAFT_LIST,

   409

	WC_VEHICLE_VIEW,

   410

	WC_VEHICLE_DETAILS,

   411

	WC_VEHICLE_REFIT,

   412

	WC_VEHICLE_ORDERS,

   413

	WC_STATION_VIEW,

   414

	WC_VEHICLE_DEPOT,

   415

	WC_BUILD_VEHICLE,

   416

	WC_BUILD_BRIDGE,

   417

	WC_ERRMSG,

   418

	WC_BUILD_STATION,

   419

	WC_BUS_STATION,

   420

	WC_TRUCK_STATION,

   421

	WC_BUILD_DEPOT,

   422

	WC_COMPANY,

   423

	WC_FINANCES,

   424

	WC_PLAYER_COLOR,

   425

	WC_QUERY_STRING,

   426

	WC_SAVELOAD,

   427

	WC_SELECT_GAME,

   428

	WC_TOOLBAR_MENU,

   429

	WC_INCOME_GRAPH,

   430

	WC_OPERATING_PROFIT,

   431

	WC_TOOLTIPS,

   432

	WC_INDUSTRY_VIEW,

   433

	WC_PLAYER_FACE,

   434

	WC_LAND_INFO,

   435

	WC_TOWN_AUTHORITY,

   436

	WC_SUBSIDIES_LIST,

   437

	WC_GRAPH_LEGEND,

   438

	WC_DELIVERED_CARGO,

   439

	WC_PERFORMANCE_HISTORY,

   440

	WC_COMPANY_VALUE,

   441

	WC_COMPANY_LEAGUE,

   442

	WC_BUY_COMPANY,

   443

	WC_PAYMENT_RATES,

   444

	WC_ENGINE_PREVIEW,

   445

	WC_MUSIC_WINDOW,

   446

	WC_MUSIC_TRACK_SELECTION,

   447

	WC_SCEN_LAND_GEN,

   448

	WC_SCEN_TOWN_GEN,

   449

	WC_SCEN_INDUSTRY,

   450

	WC_SCEN_BUILD_ROAD,

   451

	WC_BUILD_TREES,

   452

	WC_SEND_NETWORK_MSG,

   453

	WC_DROPDOWN_MENU,

   454

	WC_BUILD_INDUSTRY,

   455

	WC_GAME_OPTIONS,

   456

	WC_NETWORK_WINDOW,

   457

	WC_INDUSTRY_DIRECTORY,

   458

	WC_MESSAGE_HISTORY,

   459

	WC_CHEATS,

   460

	WC_PERFORMANCE_DETAIL,

   461

	WC_CONSOLE,

   462

	WC_EXTRA_VIEW_PORT,

   463

	WC_CLIENT_LIST,

   464

	WC_NETWORK_STATUS_WINDOW,

   465

	WC_CUSTOM_CURRENCY,

   466

	WC_REPLACE_VEHICLE,

   467

	WC_HIGHSCORE,

   468

	WC_ENDSCREEN,

   469

	WC_SIGN_LIST,

   470

	WC_GENERATE_LANDSCAPE,

   471

	WC_GENERATE_PROGRESS_WINDOW,

   472

	WC_CONFIRM_POPUP_QUERY,

   473

	WC_TRANSPARENCY_TOOLBAR,

   474

	WC_TEST1

   475

};

   476

   477

   478

enum {

   479

	EXPENSES_CONSTRUCTION =  0,

   480

	EXPENSES_NEW_VEHICLES =  1,

   481

	EXPENSES_TRAIN_RUN    =  2,

   482

	EXPENSES_ROADVEH_RUN  =  3,

   483

	EXPENSES_AIRCRAFT_RUN =  4,

   484

	EXPENSES_SHIP_RUN     =  5,

   485

	EXPENSES_PROPERTY     =  6,

   486

	EXPENSES_TRAIN_INC    =  7,

   487

	EXPENSES_ROADVEH_INC  =  8,

   488

	EXPENSES_AIRCRAFT_INC =  9,

   489

	EXPENSES_SHIP_INC     = 10,

   490

	EXPENSES_LOAN_INT     = 11,

   491

	EXPENSES_OTHER        = 12,

   492

};

   493

   494

enum {

   495

	MAX_LANG = 64,