1

/* $Id$ */

     3

     4

#ifndef OPENTTD_H

     5

#define OPENTTD_H

     6

     7

#ifndef VARDEF

     8

#define VARDEF extern

     9

#endif

    10

    11

// use this on non static functions

    12

#define PUBLIC

    13

    14

typedef struct Rect {

    15

	int left,top,right,bottom;

    16

} Rect;

    17

    18

typedef struct SmallPoint {

    19

	int16 x,y;

    20

} SmallPoint;

    21

    22

typedef struct Point {

    23

	int x,y;

    24

} Point;

    25

    26

typedef struct Pair {

    27

	int a;

    28

	int b;

    29

} Pair;

    30

    31

/**

    32

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

    33

 * sorting vehicles and stations at the moment

    34

 */

    35

typedef struct SortStruct {

    36

	uint32	index;

    37

	byte		owner;

    38

} SortStruct;

    39

    40

typedef struct YearMonthDay {

    41

	int year, month, day;

    42

} YearMonthDay;

    43

    44

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

    45

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

    46

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

    47

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

    48

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

    49

* * 1 tick is approximately 27ms.

    50

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

    51

*/

    52

#define DAY_TICKS 74

    53

#define MAX_YEAR_BEGIN_REAL 1920

    54

#define MAX_YEAR_END_REAL 2090

    55

#define MAX_YEAR_END 170

    56

    57

#include "map.h"

    58

    59

// Forward declarations of structs.

    60

typedef struct Vehicle Vehicle;

    61

typedef struct Depot Depot;

    62

typedef struct Waypoint Waypoint;

    63

typedef struct Window Window;

    64

typedef struct Station Station;

    65

typedef struct ViewPort ViewPort;

    66

typedef struct Town Town;

    67

typedef struct NewsItem NewsItem;

    68

typedef struct Industry Industry;

    69

typedef struct DrawPixelInfo DrawPixelInfo;

    70

typedef uint16 VehicleID;

    71

typedef byte PlayerID;

    72

typedef byte OrderID;

    73

typedef byte CargoID;

    74

typedef uint16 StringID;

    77

typedef uint32 CursorID;

    78

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

    79

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

    80

    81

typedef uint32 WindowNumber;

    82

typedef byte WindowClass;

    83

    84

    85

enum GameModes {

    86

	GM_MENU,

    87

	GM_NORMAL,

    88

	GM_EDITOR

    89

};

    90

    91

enum SwitchModes {

    92

	SM_NONE = 0,

    93

	SM_NEWGAME = 1,

    94

	SM_EDITOR = 2,

    95

	SM_LOAD = 3,

    96

	SM_MENU = 4,

    97

	SM_SAVE = 5,

    98

	SM_GENRANDLAND = 6,

    99

	SM_LOAD_SCENARIO = 9,

   100

	SM_START_SCENARIO = 10,

   101

};

   102

   103

typedef enum TransportTypes {

   104

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

   105

	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge

   106

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

   107

	 * constants would be used everywhere when accessing tunnels and

   108

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

   109

	 * and rail.

   110

	 */

   111

  TRANSPORT_RAIL = 0,

   112

	TRANSPORT_ROAD = 1,

   113

	TRANSPORT_WATER,	// = 2

   114

	TRANSPORT_END,

   115

	INVALID_TRANSPORT = 0xff,

   116

} TransportType;

   117

   118

typedef struct TileInfo {

   119

	uint x;

   120

	uint y;

   121

	uint tileh;

   122

	uint type;

   123

	uint map5;

   124

	TileIndex tile;

   125

	uint z;

   126

} TileInfo;

   127

   128

enum {

   129

	NG_EDGE = 1,

   130

};

   131

   132

/* Display Options */

   133

enum {

   134

	DO_SHOW_TOWN_NAMES =    1 << 0,

   135

	DO_SHOW_STATION_NAMES = 1 << 1,

   136

	DO_SHOW_SIGNS =         1 << 2,

   137

	DO_FULL_ANIMATION =     1 << 3,

   138

	DO_TRANS_BUILDINGS =    1 << 4,

   139

	DO_FULL_DETAIL =        1 << 5,

   140

	DO_WAYPOINTS =          1 << 6,

   141

	DO_TRANS_SIGNS =        1 << 7,

   142

};

   143

   144

/* Landscape types */

   145

enum {

   146

	LT_NORMAL = 0,

   147

	LT_HILLY = 1,

   148

	LT_DESERT = 2,

   149

	LT_CANDY = 3,

   150

   151

	NUM_LANDSCAPE = 4,

   152

};

   153

   154

enum {

   155

	NUM_PRICES = 49,

   156

};

   157

   158

typedef struct Prices {

   159

	int32 station_value;

   160

	int32 build_rail;

   161

	int32 build_road;

   162

	int32 build_signals;

   163

	int32 build_bridge;

   164

	int32 build_train_depot;

   165

	int32 build_road_depot;

   166

	int32 build_ship_depot;

   167

	int32 build_tunnel;

   168

	int32 train_station_track;

   169

	int32 train_station_length;

   170

	int32 build_airport;

   171

	int32 build_bus_station;

   172

	int32 build_truck_station;

   173

	int32 build_dock;

   174

	int32 build_railvehicle;

   175

	int32 build_railwagon;

   176

	int32 aircraft_base;

   177

	int32 roadveh_base;

   178

	int32 ship_base;

   179

	int32 build_trees;

   180

	int32 terraform;

   181

	int32 clear_1;

   182

	int32 purchase_land;

   183

	int32 clear_2;

   184

	int32 clear_3;

   185

	int32 remove_trees;

   186

	int32 remove_rail;

   187

	int32 remove_signals;

   188

	int32 clear_bridge;

   189

	int32 remove_train_depot;

   190

	int32 remove_road_depot;

   191

	int32 remove_ship_depot;

   192

	int32 clear_tunnel;

   193

	int32 clear_water;

   194

	int32 remove_rail_station;

   195

	int32 remove_airport;

   196

	int32 remove_bus_station;

   197

	int32 remove_truck_station;

   198

	int32 remove_dock;

   199

	int32 remove_house;

   200

	int32 remove_road;

   201

	int32 running_rail[3];

   202

	int32 aircraft_running;

   203

	int32 roadveh_running;

   204

	int32 ship_running;

   205

	int32 build_industry;

   206

} Prices;

   207

   208

#define GAME_DIFFICULTY_NUM 18

   209

   210

typedef struct GameDifficulty {

   211

	int max_no_competitors;

   212

	int competitor_start_time;

   213

	int number_towns;

   214

	int number_industries;

   215

	int max_loan;

   216

	int initial_interest;

   217

	int vehicle_costs;

   218

	int competitor_speed;

   219

	int competitor_intelligence; // no longer in use

   220

	int vehicle_breakdowns;

   221

	int subsidy_multiplier;

   222

	int construction_cost;

   223

	int terrain_type;

   224

	int quantity_sea_lakes;

   225

	int economy;

   226

	int line_reverse_mode;

   227

	int disasters;

   228

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

   229

} GameDifficulty;

   230

   231

enum {

   232

	// Temperate

   233

	CT_PASSENGERS = 0,

   234

	CT_COAL = 1,

   235

	CT_MAIL = 2,

   236

	CT_OIL = 3,

   237

	CT_LIVESTOCK = 4,

   238

	CT_GOODS = 5,

   239

	CT_GRAIN = 6,

   240

	CT_WOOD = 7,

   241

	CT_IRON_ORE = 8,

   242

	CT_STEEL = 9,

   243

	CT_VALUABLES = 10,

   244

	CT_FOOD = 11,

   245

   246

	// Arctic

   247

	CT_WHEAT = 6,

   248

	CT_HILLY_UNUSED = 8,

   249

	CT_PAPER = 9,

   250

	CT_GOLD = 10,

   251

   252

	// Tropic

   253

	CT_RUBBER = 1,

   254

	CT_FRUIT = 4,

   255

	CT_MAIZE = 6,

   256

	CT_COPPER_ORE = 8,

   257

	CT_WATER = 9,

   258

	CT_DIAMONDS = 10,

   259

   260

	// Toyland

   261

	CT_SUGAR = 1,

   262

	CT_TOYS = 3,

   263

	CT_BATTERIES = 4,

   264

	CT_CANDY = 5,

   265

	CT_TOFFEE = 6,

   266

	CT_COLA = 7,

   267

	CT_COTTON_CANDY = 8,

   268

	CT_BUBBLES = 9,

   269

	CT_PLASTIC = 10,

   270

	CT_FIZZY_DRINKS = 11,

   271

   272

	NUM_CARGO = 12,

   273

   274

	CT_INVALID = 0xFF

   275

};

   276

   277

typedef uint AcceptedCargo[NUM_CARGO];

   278

   279

typedef struct TileDesc {

   280

	StringID str;

   281

	byte owner;

   282

	uint16 build_date;

   283

	uint32 dparam[2];

   284

} TileDesc;

   285

   286

typedef struct {

   287

	int32 left;

   288

	int32 top;

   289

	byte width_1, width_2;

   290

} ViewportSign;

   291

   292

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

   293

   294

typedef void DrawTileProc(TileInfo *ti);

   295

typedef uint GetSlopeZProc(TileInfo *ti);

   296

typedef int32 ClearTileProc(TileIndex tile, byte flags);

   297

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

   298

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

   299

/* GetTileTrackStatusProcs return a value that contains the possible tracks

   300

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

   301

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

   302

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

   303

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

   304

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

   305

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

   306

 *

   307

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

   308

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

   309

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

   310

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

   311

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

   312

 *

   313

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

   314

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

   315

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

   316

 * above.

   317

 */

   318

typedef uint32 GetTileTrackStatusProc(TileIndex tile, TransportType mode);

   319

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

   320

typedef void ClickTileProc(TileIndex tile);

   321

typedef void AnimateTileProc(TileIndex tile);

   322

typedef void TileLoopProc(TileIndex tile);

   323

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

   324

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

   325

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

   326

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

   327

 * other bits that can be set? */

   328

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

   329

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

   330

typedef uint GetSlopeTilehProc(const TileInfo *ti);

   331

   332

typedef struct {

   333

	DrawTileProc *draw_tile_proc;

   334

	GetSlopeZProc *get_slope_z_proc;

   335

	ClearTileProc *clear_tile_proc;

   336

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   337

	GetTileDescProc *get_tile_desc_proc;

   338

	GetTileTrackStatusProc *get_tile_track_status_proc;

   339

	ClickTileProc *click_tile_proc;

   340

	AnimateTileProc *animate_tile_proc;

   341

	TileLoopProc *tile_loop_proc;

   342

	ChangeTileOwnerProc *change_tile_owner_proc;

   343

	GetProducedCargoProc *get_produced_cargo_proc;

   344

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   345

	VehicleLeaveTileProc *vehicle_leave_tile_proc;

   346

	GetSlopeTilehProc *get_slope_tileh_proc;

   347

} TileTypeProcs;

   348

   349

   350

   351

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

   352

   353

enum {

   354

	MP_MAP2 = 1<<0,

   355

	MP_MAP3LO = 1<<1,

   356

	MP_MAP3HI = 1<<2,

   357

	MP_MAP5 = 1<<3,

   358

	MP_MAPOWNER_CURRENT = 1<<4,

   359

	MP_MAPOWNER = 1<<5,

   360

   361

	MP_TYPE_MASK = 0xF << 8,

   362

   363

	MP_MAP2_CLEAR = 1 << 12,

   364

	MP_MAP3LO_CLEAR = 1 << 13,

   365

	MP_MAP3HI_CLEAR = 1 << 14,

   366

   367

	MP_NODIRTY = 1<<15,

   368

};

   369

   370

enum {

   371

	WC_MAIN_WINDOW = 0x0,

   372

	WC_MAIN_TOOLBAR = 0x1,

   373

	WC_STATUS_BAR = 0x2,

   374

	WC_BUILD_TOOLBAR = 0x3,

   375

	WC_NEWS_WINDOW = 0x4,

   376

	WC_TOWN_DIRECTORY = 0x5,

   377

	WC_STATION_LIST = 0x6,

   378

	WC_TOWN_VIEW = 0x7,

   379

	WC_SMALLMAP = 0x8,

   380

	WC_TRAINS_LIST = 0x9,

   381

	WC_ROADVEH_LIST = 0xA,

   382

	WC_SHIPS_LIST = 0xB,

   383

	WC_AIRCRAFT_LIST = 0xC,

   384

	WC_VEHICLE_VIEW = 0xD,

   385

	WC_VEHICLE_DETAILS = 0xE,

   386

	WC_VEHICLE_REFIT = 0xF,

   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_DEBUGGER = 0x1C,

   400

	WC_COMPANY = 0x1D,

   401

	WC_FINANCES = 0x1E,

   402

	WC_PLAYER_COLOR = 0x1F,

   403

	WC_QUERY_STRING = 0x20,

   404

	WC_SAVELOAD = 0x21,

   405

	WC_SELECT_GAME = 0x22,

   406

	WC_TOOLBAR_MENU = 0x24,

   407

	WC_INCOME_GRAPH = 0x25,

   408

	WC_OPERATING_PROFIT = 0x26,

   409

	WC_TOOLTIPS = 0x27,

   410

	WC_INDUSTRY_VIEW = 0x28,

   411

	WC_PLAYER_FACE = 0x29,

   412

	WC_LAND_INFO = 0x2A,

   413

	WC_TOWN_AUTHORITY = 0x2B,

   414

	WC_SUBSIDIES_LIST = 0x2C,

   415

	WC_GRAPH_LEGEND = 0x2D,

   416

	WC_DELIVERED_CARGO = 0x2E,

   417

	WC_PERFORMANCE_HISTORY = 0x2F,

   418

	WC_COMPANY_VALUE = 0x30,

   419

	WC_COMPANY_LEAGUE = 0x31,

   420

	WC_BUY_COMPANY = 0x32,

   421

	WC_PAYMENT_RATES = 0x33,

   422

	WC_SELECT_TUTORIAL = 0x34,

   423

	WC_ENGINE_PREVIEW = 0x35,

   424

	WC_MUSIC_WINDOW = 0x36,

   425

	WC_MUSIC_TRACK_SELECTION = 0x37,

   426

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

   427

	WC_ASK_RESET_LANDSCAPE = 0x39,

   428

	WC_SCEN_TOWN_GEN = 0x3A,

   429

	WC_SCEN_INDUSTRY = 0x3B,

   430

	WC_SCEN_BUILD_ROAD = 0x3C,

   431

	WC_BUILD_TREES = 0x3D,

   432

	WC_SEND_NETWORK_MSG = 0x3E,

   433

	WC_DROPDOWN_MENU = 0x3F,

   434

	WC_BUILD_INDUSTRY = 0x40,

   435

	WC_GAME_OPTIONS = 0x41,

   436

	WC_NETWORK_WINDOW = 0x42,

   437

	WC_INDUSTRY_DIRECTORY = 0x43,

   438

	WC_MESSAGE_HISTORY = 0x44,

   439

	WC_CHEATS = 0x45,

   440

	WC_PERFORMANCE_DETAIL = 0x46,

   441

	WC_CONSOLE = 0x47,

   442

	WC_EXTRA_VIEW_PORT = 0x48,

   443

	WC_CLIENT_LIST = 0x49,

   444

	WC_NETWORK_STATUS_WINDOW = 0x4A,

   445

	WC_CUSTOM_CURRENCY = 0x4B,

   446

	WC_REPLACE_VEHICLE = 0x4C,

   447

	WC_HIGHSCORE = 0x4D,

   448

	WC_ENDSCREEN = 0x4E,

   449

	WC_SIGN_LIST = 0x4F,

   450

};

   451

   452

   453

enum {

   454

	EXPENSES_CONSTRUCTION = 0,

   455

	EXPENSES_NEW_VEHICLES = 1,

   456

	EXPENSES_TRAIN_RUN = 2,

   457

	EXPENSES_ROADVEH_RUN = 3,

   458

	EXPENSES_AIRCRAFT_RUN = 4,

   459

	EXPENSES_SHIP_RUN = 5,

   460

	EXPENSES_PROPERTY = 6,

   461

	EXPENSES_TRAIN_INC = 7,

   462

	EXPENSES_ROADVEH_INC = 8,

   463

	EXPENSES_AIRCRAFT_INC = 9,

   464

	EXPENSES_SHIP_INC = 10,

   465

	EXPENSES_LOAN_INT = 11,

   466

	EXPENSES_OTHER = 12,

   467

};

   468

   469

// special string constants

   470

enum SpecialStrings {

   471

   472

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

   473

	SPECSTR_TOWNNAME_START = 0x20C0,

   474

	SPECSTR_TOWNNAME_ENGLISH = SPECSTR_TOWNNAME_START,

   475

	SPECSTR_TOWNNAME_FRENCH,

   476

	SPECSTR_TOWNNAME_GERMAN,

   477

	SPECSTR_TOWNNAME_AMERICAN,

   478

	SPECSTR_TOWNNAME_LATIN,

   479

	SPECSTR_TOWNNAME_SILLY,

   480

	SPECSTR_TOWNNAME_SWEDISH,

   481

	SPECSTR_TOWNNAME_DUTCH,

   482

	SPECSTR_TOWNNAME_FINNISH,

   483

	SPECSTR_TOWNNAME_POLISH,

   484

	SPECSTR_TOWNNAME_SLOVAKISH,

   485

	SPECSTR_TOWNNAME_NORWEGIAN,

   486

	SPECSTR_TOWNNAME_HUNGARIAN,

   487

	SPECSTR_TOWNNAME_AUSTRIAN,

   488

	SPECSTR_TOWNNAME_ROMANIAN,

   489

	SPECSTR_TOWNNAME_CZECH,

   490

	SPECSTR_TOWNNAME_SWISS,

   491

	SPECSTR_TOWNNAME_DANISH,

   492

	SPECSTR_TOWNNAME_LAST = SPECSTR_TOWNNAME_DANISH,

   493

   494

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

   495

	SPECSTR_PLAYERNAME_START = 0x70EA,

   496

	SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,

   497

	SPECSTR_PLAYERNAME_FRENCH,

   498

	SPECSTR_PLAYERNAME_GERMAN,

   499

	SPECSTR_PLAYERNAME_AMERICAN,

   500

	SPECSTR_PLAYERNAME_LATIN,

   501

	SPECSTR_PLAYERNAME_SILLY,

   502

	SPECSTR_PLAYERNAME_LAST = SPECSTR_PLAYERNAME_SILLY,

   503

   504

	SPECSTR_ANDCO_NAME = 0x70E6,

   505

	SPECSTR_PRESIDENT_NAME = 0x70E7,

   506

	SPECSTR_SONGNAME = 0x70E8,

   507

   508

	// reserve 32 strings for the *.lng files

   509

	SPECSTR_LANGUAGE_START = 0x7100,

   510

	SPECSTR_LANGUAGE_END = 0x711f,

   511

   512