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 Point {

    16

	int x,y;

    17

} Point;

    18

    19

typedef struct Pair {

    20

	int a;

    21

	int b;

    22

} Pair;

    23

    24

/**

    25

 * Is used as a general sortable struct (using qsort and friends). Is used for

    26

 * sorting vehicles and stations at the moment

    27

 */

    28

typedef struct SortStruct {

    29

	uint32	index;

    30

	byte		owner;

    31

} SortStruct;

    32

    33

typedef struct YearMonthDay {

    34

	int year, month, day;

    35

} YearMonthDay;

    36

    37

/* --- 1 Day is 74 ticks ---

    38

* The game's internal structure is dictated by ticks. The date counter (date_fract) is an integer of

    39

* uint16 type, so it can have a max value of 65536. Every tick this variable (date_fract) is

    40

* increased by 885. When it overflows, the new day loop is called.

    41

* * this that means 1 day is : 65536 / 885 = 74 ticks

    42

* * 1 tick is approximately 27ms.

    43

* * 1 day is thus about 2 seconds (74*27 = 1998) on a machine that can run OpenTTD normally

    44

*/

    45

#define DAY_TICKS 74

    46

#define MAX_YEAR_BEGIN_REAL 1920

    47

#define MAX_YEAR_END_REAL 2090

    48

#define MAX_YEAR_END 170

    49

    50

#include "map.h"

    51

    52

// Forward declarations of structs.

    53

typedef struct Vehicle Vehicle;

    54

typedef struct Depot Depot;

    55

typedef struct Waypoint Waypoint;

    56

typedef struct Window Window;

    57

typedef struct Station Station;

    58

typedef struct ViewPort ViewPort;

    59

typedef struct Town Town;

    60

typedef struct NewsItem NewsItem;

    61

typedef struct Industry Industry;

    62

typedef struct DrawPixelInfo DrawPixelInfo;

    63

typedef uint16 VehicleID;

    64

typedef byte PlayerID;

    65

typedef byte OrderID;

    66

typedef byte CargoID;

    67

typedef uint16 StringID;

    68

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

    69

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

    70

typedef uint32 CursorID;

    71

typedef uint16 EngineID; //! All enginenumbers should be of this type

    72

typedef uint16 UnitID;   //! All unitnumber stuff is of this type (or anyway, should be)

    73

    74

typedef uint32 WindowNumber;

    75

typedef byte WindowClass;

    76

    77

    78

enum GameModes {

    79

	GM_MENU,

    80

	GM_NORMAL,

    81

	GM_EDITOR

    82

};

    83

    84

enum SwitchModes {

    85

	SM_NONE = 0,

    86

	SM_NEWGAME = 1,

    87

	SM_EDITOR = 2,

    88

	SM_LOAD = 3,

    89

	SM_MENU = 4,

    90

	SM_SAVE = 5,

    91

	SM_GENRANDLAND = 6,

    92

	SM_LOAD_SCENARIO = 9,

    93

	SM_START_SCENARIO = 10,

    94

};

    95

    96

    97

/* Modes for GenerateWorld */

    98

enum GenerateWorldModes {

    99

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

   100

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

   101

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

   102

};

   103

   104

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

   105

enum InitializeGameModes {

   106

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

   107

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

   108

};

   109

   110

   111

typedef enum TransportTypes {

   112

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

   113

	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge

   114

	 * to compare against the map5 array. In an ideal world, these

   115

	 * constants would be used everywhere when accessing tunnels and

   116

	 * bridges. For now, you should just not change the values for road

   117

	 * and rail.

   118

	 */

   119

  TRANSPORT_RAIL = 0,

   120

	TRANSPORT_ROAD = 1,

   121

	TRANSPORT_WATER,	// = 2

   122

	TRANSPORT_END,

   123

	INVALID_TRANSPORT = 0xff,

   124

} TransportType;

   125

   126

typedef struct TileInfo {

   127

	uint x;

   128

	uint y;

   129

	uint tileh;

   130

	uint type;

   131

	uint map5;

   132

	TileIndex tile;

   133

	uint z;

   134

} TileInfo;

   135

   136

   137

/* Display Options */

   138

enum {

   139

	DO_SHOW_TOWN_NAMES =    1 << 0,

   140

	DO_SHOW_STATION_NAMES = 1 << 1,

   141

	DO_SHOW_SIGNS =         1 << 2,

   142

	DO_FULL_ANIMATION =     1 << 3,

   143

	DO_TRANS_BUILDINGS =    1 << 4,

   144

	DO_FULL_DETAIL =        1 << 5,

   145

	DO_WAYPOINTS =          1 << 6,

   146

	DO_TRANS_SIGNS =        1 << 7,

   147

};

   148

   149

/* Landscape types */

   150

enum {

   151

	LT_NORMAL = 0,

   152

	LT_HILLY = 1,

   153

	LT_DESERT = 2,

   154

	LT_CANDY = 3,

   155

   156

	NUM_LANDSCAPE = 4,

   157

};

   158

   159

enum {

   160

	NUM_PRICES = 49,

   161

};

   162

   163

typedef struct Prices {

   164

	int32 station_value;

   165

	int32 build_rail;

   166

	int32 build_road;

   167

	int32 build_signals;

   168

	int32 build_bridge;

   169

	int32 build_train_depot;

   170

	int32 build_road_depot;

   171

	int32 build_ship_depot;

   172

	int32 build_tunnel;

   173

	int32 train_station_track;

   174

	int32 train_station_length;

   175

	int32 build_airport;

   176

	int32 build_bus_station;

   177

	int32 build_truck_station;

   178

	int32 build_dock;

   179

	int32 build_railvehicle;

   180

	int32 build_railwagon;

   181

	int32 aircraft_base;

   182

	int32 roadveh_base;

   183

	int32 ship_base;

   184

	int32 build_trees;

   185

	int32 terraform;

   186

	int32 clear_1;

   187

	int32 purchase_land;

   188

	int32 clear_2;

   189

	int32 clear_3;

   190

	int32 remove_trees;

   191

	int32 remove_rail;

   192

	int32 remove_signals;

   193

	int32 clear_bridge;

   194

	int32 remove_train_depot;

   195

	int32 remove_road_depot;

   196

	int32 remove_ship_depot;

   197

	int32 clear_tunnel;

   198

	int32 clear_water;

   199

	int32 remove_rail_station;

   200

	int32 remove_airport;

   201

	int32 remove_bus_station;

   202

	int32 remove_truck_station;

   203

	int32 remove_dock;

   204

	int32 remove_house;

   205

	int32 remove_road;

   206

	int32 running_rail[3];

   207

	int32 aircraft_running;

   208

	int32 roadveh_running;

   209

	int32 ship_running;

   210

	int32 build_industry;

   211

} Prices;

   212

   213

#define GAME_DIFFICULTY_NUM 18

   214

   215

typedef struct GameDifficulty {

   216

	int max_no_competitors;

   217

	int competitor_start_time;

   218

	int number_towns;

   219

	int number_industries;

   220

	int max_loan;

   221

	int initial_interest;

   222

	int vehicle_costs;

   223

	int competitor_speed;

   224

	int competitor_intelligence; // no longer in use

   225

	int vehicle_breakdowns;

   226

	int subsidy_multiplier;

   227

	int construction_cost;

   228

	int terrain_type;

   229

	int quantity_sea_lakes;

   230

	int economy;

   231

	int line_reverse_mode;

   232

	int disasters;

   233

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

   234

} GameDifficulty;

   235

   236

enum {

   237

	// Temperate

   238

	CT_PASSENGERS = 0,

   239

	CT_COAL = 1,

   240

	CT_MAIL = 2,

   241

	CT_OIL = 3,

   242

	CT_LIVESTOCK = 4,

   243

	CT_GOODS = 5,

   244

	CT_GRAIN = 6,

   245

	CT_WOOD = 7,

   246

	CT_IRON_ORE = 8,

   247

	CT_STEEL = 9,

   248

	CT_VALUABLES = 10,

   249

	CT_FOOD = 11,

   250

   251

	// Arctic

   252

	CT_WHEAT = 6,

   253

	CT_HILLY_UNUSED = 8,

   254

	CT_PAPER = 9,

   255

	CT_GOLD = 10,

   256

   257

	// Tropic

   258

	CT_RUBBER = 1,

   259

	CT_FRUIT = 4,

   260

	CT_MAIZE = 6,

   261

	CT_COPPER_ORE = 8,

   262

	CT_WATER = 9,

   263

	CT_DIAMONDS = 10,

   264

   265

	// Toyland

   266

	CT_SUGAR = 1,

   267

	CT_TOYS = 3,

   268

	CT_BATTERIES = 4,

   269

	CT_CANDY = 5,

   270

	CT_TOFFEE = 6,

   271

	CT_COLA = 7,

   272

	CT_COTTON_CANDY = 8,

   273

	CT_BUBBLES = 9,

   274

	CT_PLASTIC = 10,

   275

	CT_FIZZY_DRINKS = 11,

   276

   277

	NUM_CARGO = 12,

   278

   279

	CT_INVALID = 0xFF

   280

};

   281

   282

typedef uint AcceptedCargo[NUM_CARGO];

   283

   284

typedef struct TileDesc {

   285

	StringID str;

   286

	byte owner;

   287

	uint16 build_date;

   288

	uint32 dparam[2];

   289

} TileDesc;

   290

   291

typedef struct {

   292

	int32 left;

   293

	int32 top;

   294

	byte width_1, width_2;

   295

} ViewportSign;

   296

   297

typedef int32 CommandProc(int x, int y, uint32 flags, uint32 p1, uint32 p2);

   298

   299

typedef void DrawTileProc(TileInfo *ti);

   300

typedef uint GetSlopeZProc(const TileInfo* ti);

   301

typedef int32 ClearTileProc(TileIndex tile, byte flags);

   302

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

   303

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

   304

/* GetTileTrackStatusProcs return a value that contains the possible tracks

   305

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

   306

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

   307

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

   308

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

   309

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

   310

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

   311

 *

   312

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

   313

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

   314

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

   315

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

   316

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

   317

 *

   318

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

   319

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

   320

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

   321

 * above.

   322

 */

   323

typedef uint32 GetTileTrackStatusProc(TileIndex tile, TransportType mode);

   324

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

   325

typedef void ClickTileProc(TileIndex tile);

   326

typedef void AnimateTileProc(TileIndex tile);

   327

typedef void TileLoopProc(TileIndex tile);

   328

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

   329

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

   330

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

   331

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

   332

 * other bits that can be set? */

   333

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

   334

typedef void VehicleLeaveTileProc(Vehicle *v, TileIndex tile, int x, int y);

   335

typedef uint GetSlopeTilehProc(const TileInfo *ti);

   336

   337

typedef struct {

   338

	DrawTileProc *draw_tile_proc;

   339

	GetSlopeZProc *get_slope_z_proc;

   340

	ClearTileProc *clear_tile_proc;

   341

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   342

	GetTileDescProc *get_tile_desc_proc;

   343

	GetTileTrackStatusProc *get_tile_track_status_proc;

   344

	ClickTileProc *click_tile_proc;

   345

	AnimateTileProc *animate_tile_proc;

   346

	TileLoopProc *tile_loop_proc;

   347

	ChangeTileOwnerProc *change_tile_owner_proc;

   348

	GetProducedCargoProc *get_produced_cargo_proc;

   349

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   350

	VehicleLeaveTileProc *vehicle_leave_tile_proc;

   351

	GetSlopeTilehProc *get_slope_tileh_proc;

   352

} TileTypeProcs;

   353

   354

   355

   356

#define MP_SETTYPE(x) ((x+1) << 8)

   357

   358

enum {

   359

	MP_MAP2 = 1<<0,

   360

	MP_MAP3LO = 1<<1,

   361

	MP_MAP3HI = 1<<2,

   362

	MP_MAP5 = 1<<3,

   363

	MP_MAPOWNER_CURRENT = 1<<4,

   364

	MP_MAPOWNER = 1<<5,

   365

   366

	MP_TYPE_MASK = 0xF << 8,

   367

   368

	MP_MAP2_CLEAR = 1 << 12,

   369

	MP_MAP3LO_CLEAR = 1 << 13,

   370

	MP_MAP3HI_CLEAR = 1 << 14,

   371

   372

	MP_NODIRTY = 1<<15,

   373

};

   374

   375

enum {

   376

	WC_MAIN_WINDOW = 0x0,

   377

	WC_MAIN_TOOLBAR = 0x1,

   378

	WC_STATUS_BAR = 0x2,

   379

	WC_BUILD_TOOLBAR = 0x3,

   380

	WC_NEWS_WINDOW = 0x4,

   381

	WC_TOWN_DIRECTORY = 0x5,

   382

	WC_STATION_LIST = 0x6,

   383

	WC_TOWN_VIEW = 0x7,

   384

	WC_SMALLMAP = 0x8,

   385

	WC_TRAINS_LIST = 0x9,

   386

	WC_ROADVEH_LIST = 0xA,

   387

	WC_SHIPS_LIST = 0xB,

   388

	WC_AIRCRAFT_LIST = 0xC,

   389

	WC_VEHICLE_VIEW = 0xD,

   390

	WC_VEHICLE_DETAILS = 0xE,

   391

	WC_VEHICLE_REFIT = 0xF,

   392

	WC_VEHICLE_ORDERS = 0x10,

   393

	WC_STATION_VIEW = 0x11,

   394

	WC_VEHICLE_DEPOT = 0x12,

   395

	WC_BUILD_VEHICLE = 0x13,

   396

	WC_BUILD_BRIDGE = 0x14,

   397

	WC_ERRMSG = 0x15,

   398

	WC_ASK_ABANDON_GAME = 0x16,

   399

	WC_QUIT_GAME = 0x17,

   400

	WC_BUILD_STATION = 0x18,

   401

	WC_BUS_STATION = 0x19,

   402

	WC_TRUCK_STATION = 0x1A,

   403

	WC_BUILD_DEPOT = 0x1B,

   404

	WC_COMPANY = 0x1D,

   405

	WC_FINANCES = 0x1E,

   406

	WC_PLAYER_COLOR = 0x1F,

   407

	WC_QUERY_STRING = 0x20,

   408

	WC_SAVELOAD = 0x21,

   409

	WC_SELECT_GAME = 0x22,

   410

	WC_TOOLBAR_MENU = 0x24,

   411

	WC_INCOME_GRAPH = 0x25,

   412

	WC_OPERATING_PROFIT = 0x26,

   413

	WC_TOOLTIPS = 0x27,

   414

	WC_INDUSTRY_VIEW = 0x28,

   415

	WC_PLAYER_FACE = 0x29,

   416

	WC_LAND_INFO = 0x2A,

   417

	WC_TOWN_AUTHORITY = 0x2B,

   418

	WC_SUBSIDIES_LIST = 0x2C,

   419

	WC_GRAPH_LEGEND = 0x2D,

   420

	WC_DELIVERED_CARGO = 0x2E,

   421

	WC_PERFORMANCE_HISTORY = 0x2F,

   422

	WC_COMPANY_VALUE = 0x30,

   423

	WC_COMPANY_LEAGUE = 0x31,

   424

	WC_BUY_COMPANY = 0x32,

   425

	WC_PAYMENT_RATES = 0x33,

   426

	WC_ENGINE_PREVIEW = 0x35,

   427

	WC_MUSIC_WINDOW = 0x36,

   428

	WC_MUSIC_TRACK_SELECTION = 0x37,

   429

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

   430

	WC_ASK_RESET_LANDSCAPE = 0x39,

   431

	WC_SCEN_TOWN_GEN = 0x3A,

   432

	WC_SCEN_INDUSTRY = 0x3B,

   433

	WC_SCEN_BUILD_ROAD = 0x3C,

   434

	WC_BUILD_TREES = 0x3D,

   435

	WC_SEND_NETWORK_MSG = 0x3E,

   436

	WC_DROPDOWN_MENU = 0x3F,

   437

	WC_BUILD_INDUSTRY = 0x40,

   438

	WC_GAME_OPTIONS = 0x41,

   439

	WC_NETWORK_WINDOW = 0x42,

   440

	WC_INDUSTRY_DIRECTORY = 0x43,

   441

	WC_MESSAGE_HISTORY = 0x44,

   442

	WC_CHEATS = 0x45,

   443

	WC_PERFORMANCE_DETAIL = 0x46,

   444

	WC_CONSOLE = 0x47,

   445

	WC_EXTRA_VIEW_PORT = 0x48,

   446

	WC_CLIENT_LIST = 0x49,

   447

	WC_NETWORK_STATUS_WINDOW = 0x4A,

   448

	WC_CUSTOM_CURRENCY = 0x4B,

   449

	WC_REPLACE_VEHICLE = 0x4C,

   450

	WC_HIGHSCORE = 0x4D,

   451

	WC_ENDSCREEN = 0x4E,

   452

	WC_SIGN_LIST = 0x4F,

   453

};

   454

   455

   456

enum {

   457

	EXPENSES_CONSTRUCTION = 0,

   458

	EXPENSES_NEW_VEHICLES = 1,

   459

	EXPENSES_TRAIN_RUN = 2,

   460

	EXPENSES_ROADVEH_RUN = 3,

   461

	EXPENSES_AIRCRAFT_RUN = 4,

   462

	EXPENSES_SHIP_RUN = 5,

   463

	EXPENSES_PROPERTY = 6,

   464

	EXPENSES_TRAIN_INC = 7,

   465

	EXPENSES_ROADVEH_INC = 8,

   466

	EXPENSES_AIRCRAFT_INC = 9,

   467

	EXPENSES_SHIP_INC = 10,

   468

	EXPENSES_LOAN_INT = 11,

   469

	EXPENSES_OTHER = 12,

   470

};

   471

   472

// special string constants

   473

enum SpecialStrings {

   474

   475

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

   476

	SPECSTR_TOWNNAME_START = 0x20C0,

   477

	SPECSTR_TOWNNAME_ENGLISH = SPECSTR_TOWNNAME_START,

   478

	SPECSTR_TOWNNAME_FRENCH,

   479

	SPECSTR_TOWNNAME_GERMAN,

   480

	SPECSTR_TOWNNAME_AMERICAN,

   481

	SPECSTR_TOWNNAME_LATIN,

   482

	SPECSTR_TOWNNAME_SILLY,

   483

	SPECSTR_TOWNNAME_SWEDISH,

   484

	SPECSTR_TOWNNAME_DUTCH,

   485

	SPECSTR_TOWNNAME_FINNISH,

   486

	SPECSTR_TOWNNAME_POLISH,

   487

	SPECSTR_TOWNNAME_SLOVAKISH,

   488

	SPECSTR_TOWNNAME_NORWEGIAN,

   489

	SPECSTR_TOWNNAME_HUNGARIAN,

   490

	SPECSTR_TOWNNAME_AUSTRIAN,

   491

	SPECSTR_TOWNNAME_ROMANIAN,

   492

	SPECSTR_TOWNNAME_CZECH,

   493

	SPECSTR_TOWNNAME_SWISS,

   494

	SPECSTR_TOWNNAME_DANISH,

   495

	SPECSTR_TOWNNAME_LAST = SPECSTR_TOWNNAME_DANISH,

   496

   497

	// special strings for player names on the form "TownName transport".

   498

	SPECSTR_PLAYERNAME_START = 0x70EA,

   499

	SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,

   500

	SPECSTR_PLAYERNAME_FRENCH,

   501

	SPECSTR_PLAYERNAME_GERMAN,

   502

	SPECSTR_PLAYERNAME_AMERICAN,

   503

	SPECSTR_PLAYERNAME_LATIN,

   504

	SPECSTR_PLAYERNAME_SILLY,

   505

	SPECSTR_PLAYERNAME_LAST = SPECSTR_PLAYERNAME_SILLY,

   506

   507

	SPECSTR_ANDCO_NAME = 0x70E6,

   508

	SPECSTR_PRESIDENT_NAME = 0x70E7,

   509

	SPECSTR_SONGNAME = 0x70E8,

   510