1

#ifndef OPENTTD_H

     2

#define OPENTTD_H

     3

     4

#ifndef VARDEF

     5

#define VARDEF extern

     6

#endif

     7

     8

// use this on non static functions

     9

#define PUBLIC

    10

    11

typedef struct Rect {

    12

	int left,top,right,bottom;

    13

} Rect;

    14

    15

typedef struct SmallPoint {

    16

	int16 x,y;

    17

} SmallPoint;

    18

    19

typedef struct Point {

    20

	int x,y;

    21

} Point;

    22

    23

typedef struct Pair {

    24

	int a;

    25

	int b;

    26

} Pair;

    27

    28

/**

    29

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

    30

 * sorting vehicles and stations at the moment

    31

 */

    32

typedef struct SortStruct {

    33

	uint32	index;

    34

	byte		owner;

    35

} SortStruct;

    36

    37

typedef struct YearMonthDay {

    38

	int year, month, day;

    39

} YearMonthDay;

    40

    41

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

    42

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

    43

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

    44

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

    45

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

    46

* * 1 tick is approximately 27ms.

    47

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

    48

*/

    49

#define DAY_TICKS 74

    50

#define MAX_YEAR_BEGIN_REAL 1920

    51

#define MAX_YEAR_END_REAL 2090

    52

#define MAX_YEAR_END 170

    53

    55

    56

// Forward declarations of structs.

    57

typedef struct Vehicle Vehicle;

    58

typedef struct Depot Depot;

    59

typedef struct Waypoint Waypoint;

    60

typedef struct Window Window;

    61

typedef struct Station Station;

    62

typedef struct ViewPort ViewPort;

    63

typedef struct Town Town;

    64

typedef struct NewsItem NewsItem;

    65

typedef struct Industry Industry;

    66

typedef struct DrawPixelInfo DrawPixelInfo;

    67

typedef uint16 VehicleID;

    68

typedef byte PlayerID;

    69

typedef byte OrderID;

    70

typedef byte CargoID;

    71

typedef uint16 StringID;

    72

typedef uint16 SpriteID;

    73

typedef uint32 PalSpriteID;

    74

typedef uint32 CursorID;

    75

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

    76

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

    77

    78

typedef uint32 WindowNumber;

    79

typedef byte WindowClass;

    80

    81

    82

enum GameModes {

    83

	GM_MENU,

    84

	GM_NORMAL,

    85

	GM_EDITOR

    86

};

    87

    88

enum SwitchModes {

    89

	SM_NONE = 0,

    90

	SM_NEWGAME = 1,

    91

	SM_EDITOR = 2,

    92

	SM_LOAD = 3,

    93

	SM_MENU = 4,

    94

	SM_SAVE = 5,

    95

	SM_GENRANDLAND = 6,

    96

	SM_LOAD_SCENARIO = 9,

    97

	SM_START_SCENARIO = 10,

    98

};

    99

   100

typedef enum TransportTypes {

   101

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

   102

	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge

   103

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

   104

	 * constants would be used everywhere when accessing tunnels and

   105

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

   106

	 * and rail.

   107

	 */

   108

  TRANSPORT_RAIL = 0,

   109

	TRANSPORT_ROAD = 1,

   110

	TRANSPORT_WATER,	// = 2

   111

	TRANSPORT_END,

   112

	INVALID_TRANSPORT = 0xff,

   113

} TransportType;

   114

   115

typedef struct TileInfo {

   116

	uint x;

   117

	uint y;

   118

	uint tileh;

   119

	uint type;

   120

	uint map5;

   121

	TileIndex tile;

   122

	uint z;

   123

} TileInfo;

   124

   125

enum {

   126

	NG_EDGE = 1,

   127

};

   128

   129

/* Display Options */

   130

enum {

   131

	DO_SHOW_TOWN_NAMES =    1 << 0,

   132

	DO_SHOW_STATION_NAMES = 1 << 1,

   133

	DO_SHOW_SIGNS =         1 << 2,

   134

	DO_FULL_ANIMATION =     1 << 3,

   135

	DO_TRANS_BUILDINGS =    1 << 4,

   136

	DO_FULL_DETAIL =        1 << 5,

   137

	DO_WAYPOINTS =          1 << 6,

   138

	DO_TRANS_SIGNS =        1 << 7,

   139

};

   140

   141

/* Landscape types */

   142

enum {

   143

	LT_NORMAL = 0,

   144

	LT_HILLY = 1,

   145

	LT_DESERT = 2,

   146

	LT_CANDY = 3,

   147

   148

	NUM_LANDSCAPE = 4,

   149

};

   150

   151

enum {

   152

	NUM_PRICES = 49,

   153

};

   154

   155

typedef struct Prices {

   156

	int32 station_value;

   157

	int32 build_rail;

   158

	int32 build_road;

   159

	int32 build_signals;

   160

	int32 build_bridge;

   161

	int32 build_train_depot;

   162

	int32 build_road_depot;

   163

	int32 build_ship_depot;

   164

	int32 build_tunnel;

   165

	int32 train_station_track;

   166

	int32 train_station_length;

   167

	int32 build_airport;

   168

	int32 build_bus_station;

   169

	int32 build_truck_station;

   170

	int32 build_dock;

   171

	int32 build_railvehicle;

   172

	int32 build_railwagon;

   173

	int32 aircraft_base;

   174

	int32 roadveh_base;

   175

	int32 ship_base;

   176

	int32 build_trees;

   177

	int32 terraform;

   178

	int32 clear_1;

   179

	int32 purchase_land;

   180

	int32 clear_2;

   181

	int32 clear_3;

   182

	int32 remove_trees;

   183

	int32 remove_rail;

   184

	int32 remove_signals;

   185

	int32 clear_bridge;

   186

	int32 remove_train_depot;

   187

	int32 remove_road_depot;

   188

	int32 remove_ship_depot;

   189

	int32 clear_tunnel;

   190

	int32 clear_water;

   191

	int32 remove_rail_station;

   192

	int32 remove_airport;

   193

	int32 remove_bus_station;

   194

	int32 remove_truck_station;

   195

	int32 remove_dock;

   196

	int32 remove_house;

   197

	int32 remove_road;

   198

	int32 running_rail[3];

   199

	int32 aircraft_running;

   200

	int32 roadveh_running;

   201

	int32 ship_running;

   202

	int32 build_industry;

   203

} Prices;

   204

   205

#define GAME_DIFFICULTY_NUM 18

   206

   207

typedef struct GameDifficulty {

   208

	int max_no_competitors;

   209

	int competitor_start_time;

   210

	int number_towns;

   211

	int number_industries;

   212

	int max_loan;

   213

	int initial_interest;

   214

	int vehicle_costs;

   215

	int competitor_speed;

   216

	int competitor_intelligence;

   217

	int vehicle_breakdowns;

   218

	int subsidy_multiplier;

   219

	int construction_cost;

   220

	int terrain_type;

   221

	int quantity_sea_lakes;

   222

	int economy;

   223

	int line_reverse_mode;

   224

	int disasters;

   225

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

   226

} GameDifficulty;

   227

   228

enum {

   229

	// Temperate

   230

	CT_PASSENGERS = 0,

   231

	CT_COAL = 1,

   232

	CT_MAIL = 2,

   233

	CT_OIL = 3,

   234

	CT_LIVESTOCK = 4,

   235

	CT_GOODS = 5,

   236

	CT_GRAIN = 6,

   237

	CT_WOOD = 7,

   238

	CT_IRON_ORE = 8,

   239

	CT_STEEL = 9,

   240

	CT_VALUABLES = 10,

   241

	CT_FOOD = 11,

   242

   243

	// Arctic

   244

	CT_WHEAT = 6,

   245

	CT_HILLY_UNUSED = 8,

   246

	CT_PAPER = 9,

   247

	CT_GOLD = 10,

   248

   249

	// Tropic

   250

	CT_RUBBER = 1,

   251

	CT_FRUIT = 4,

   252

	CT_MAIZE = 6,

   253

	CT_COPPER_ORE = 8,

   254

	CT_WATER = 9,

   255

	CT_DIAMONDS = 10,

   256

   257

	// Toyland

   258

	CT_SUGAR = 1,

   259

	CT_TOYS = 3,

   260

	CT_BATTERIES = 4,

   261

	CT_CANDY = 5,

   262

	CT_TOFFEE = 6,

   263

	CT_COLA = 7,

   264

	CT_COTTON_CANDY = 8,

   265

	CT_BUBBLES = 9,

   266

	CT_PLASTIC = 10,

   267

	CT_FIZZY_DRINKS = 11,

   268

   269

	NUM_CARGO = 12,

   270

   271

	CT_INVALID = 0xFF

   272

};

   273

   274

typedef uint AcceptedCargo[NUM_CARGO];

   275

   276

typedef struct TileDesc {

   277

	StringID str;

   278

	byte owner;

   279

	uint16 build_date;

   280

	uint32 dparam[2];

   281

} TileDesc;

   282

   283

typedef struct {

   284

	int32 left;

   285

	int32 top;

   286

	byte width_1, width_2;

   287

} ViewportSign;

   288

   289

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

   290

   291

typedef void DrawTileProc(TileInfo *ti);

   292

typedef uint GetSlopeZProc(TileInfo *ti);

   293

typedef int32 ClearTileProc(TileIndex tile, byte flags);

   294

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

   295

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

   296

/* GetTileTrackStatusProcs return a value that contains the possible tracks

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

 *

   304

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

   305

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

   306

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

   307

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

   308

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

   309

 *

   310

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

   311

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

   312

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

   313

 * above.

   314

 */

   315

typedef uint32 GetTileTrackStatusProc(TileIndex tile, TransportType mode);

   316

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

   317

typedef void ClickTileProc(TileIndex tile);

   318

typedef void AnimateTileProc(TileIndex tile);

   319

typedef void TileLoopProc(TileIndex tile);

   320

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

   321

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

   322

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

   323

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

   324

 * other bits that can be set? */

   325

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

   326

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

   327

typedef uint GetSlopeTilehProc(TileInfo *ti);

   328

   329

typedef struct {

   330

	DrawTileProc *draw_tile_proc;

   331

	GetSlopeZProc *get_slope_z_proc;

   332

	ClearTileProc *clear_tile_proc;

   333

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   334

	GetTileDescProc *get_tile_desc_proc;

   335

	GetTileTrackStatusProc *get_tile_track_status_proc;

   336

	ClickTileProc *click_tile_proc;

   337

	AnimateTileProc *animate_tile_proc;

   338

	TileLoopProc *tile_loop_proc;

   339

	ChangeTileOwnerProc *change_tile_owner_proc;

   340

	GetProducedCargoProc *get_produced_cargo_proc;

   341

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   342

	VehicleLeaveTileProc *vehicle_leave_tile_proc;

   343

	GetSlopeTilehProc *get_slope_tileh_proc;

   344

} TileTypeProcs;

   345

   346

   347

   348

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

   349

   350

enum {

   351

	MP_MAP2 = 1<<0,

   352

	MP_MAP3LO = 1<<1,

   353

	MP_MAP3HI = 1<<2,

   354

	MP_MAP5 = 1<<3,

   355

	MP_MAPOWNER_CURRENT = 1<<4,

   356

	MP_MAPOWNER = 1<<5,

   357

   358

	MP_TYPE_MASK = 0xF << 8,

   359

   360

	MP_MAP2_CLEAR = 1 << 12,

   361

	MP_MAP3LO_CLEAR = 1 << 13,

   362

	MP_MAP3HI_CLEAR = 1 << 14,

   363

   364

	MP_NODIRTY = 1<<15,

   365

};

   366

   367

enum {

   368

	WC_MAIN_WINDOW = 0x0,

   369

	WC_MAIN_TOOLBAR = 0x1,

   370

	WC_STATUS_BAR = 0x2,

   371

	WC_BUILD_TOOLBAR = 0x3,

   372

	WC_NEWS_WINDOW = 0x4,

   373

	WC_TOWN_DIRECTORY = 0x5,

   374

	WC_STATION_LIST = 0x6,

   375

	WC_TOWN_VIEW = 0x7,

   376

	WC_SMALLMAP = 0x8,

   377

	WC_TRAINS_LIST = 0x9,

   378

	WC_ROADVEH_LIST = 0xA,

   379

	WC_SHIPS_LIST = 0xB,

   380

	WC_AIRCRAFT_LIST = 0xC,

   381

	WC_VEHICLE_VIEW = 0xD,

   382

	WC_VEHICLE_DETAILS = 0xE,

   383

	WC_VEHICLE_REFIT = 0xF,

   384

	WC_VEHICLE_ORDERS = 0x10,

   385

	WC_STATION_VIEW = 0x11,

   386

	WC_VEHICLE_DEPOT = 0x12,

   387

	WC_BUILD_VEHICLE = 0x13,

   388

	WC_BUILD_BRIDGE = 0x14,

   389

	WC_ERRMSG = 0x15,

   390

	WC_ASK_ABANDON_GAME = 0x16,

   391

	WC_QUIT_GAME = 0x17,

   392

	WC_BUILD_STATION = 0x18,

   393

	WC_BUS_STATION = 0x19,

   394

	WC_TRUCK_STATION = 0x1A,

   395

	WC_BUILD_DEPOT = 0x1B,

   396

	WC_DEBUGGER = 0x1C,

   397

	WC_COMPANY = 0x1D,

   398

	WC_FINANCES = 0x1E,

   399

	WC_PLAYER_COLOR = 0x1F,

   400

	WC_QUERY_STRING = 0x20,

   401

	WC_SAVELOAD = 0x21,

   402

	WC_SELECT_GAME = 0x22,

   403

	WC_TOOLBAR_MENU = 0x24,

   404

	WC_INCOME_GRAPH = 0x25,

   405

	WC_OPERATING_PROFIT = 0x26,

   406

	WC_TOOLTIPS = 0x27,

   407

	WC_INDUSTRY_VIEW = 0x28,

   408

	WC_PLAYER_FACE = 0x29,

   409

	WC_LAND_INFO = 0x2A,

   410

	WC_TOWN_AUTHORITY = 0x2B,

   411

	WC_SUBSIDIES_LIST = 0x2C,

   412

	WC_GRAPH_LEGEND = 0x2D,

   413

	WC_DELIVERED_CARGO = 0x2E,

   414

	WC_PERFORMANCE_HISTORY = 0x2F,

   415

	WC_COMPANY_VALUE = 0x30,

   416

	WC_COMPANY_LEAGUE = 0x31,

   417

	WC_BUY_COMPANY = 0x32,

   418

	WC_PAYMENT_RATES = 0x33,

   419

	WC_SELECT_TUTORIAL = 0x34,

   420

	WC_ENGINE_PREVIEW = 0x35,

   421

	WC_MUSIC_WINDOW = 0x36,

   422

	WC_MUSIC_TRACK_SELECTION = 0x37,

   423

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

   424

	WC_ASK_RESET_LANDSCAPE = 0x39,

   425

	WC_SCEN_TOWN_GEN = 0x3A,

   426

	WC_SCEN_INDUSTRY = 0x3B,

   427

	WC_SCEN_BUILD_ROAD = 0x3C,

   428

	WC_BUILD_TREES = 0x3D,

   429

	WC_SEND_NETWORK_MSG = 0x3E,

   430

	WC_DROPDOWN_MENU = 0x3F,

   431

	WC_BUILD_INDUSTRY = 0x40,

   432

	WC_GAME_OPTIONS = 0x41,

   433

	WC_NETWORK_WINDOW = 0x42,

   434

	WC_INDUSTRY_DIRECTORY = 0x43,

   435

	WC_MESSAGE_HISTORY = 0x44,

   436

	WC_CHEATS = 0x45,

   437

	WC_PERFORMANCE_DETAIL = 0x46,

   438

	WC_CONSOLE = 0x47,

   439

	WC_EXTRA_VIEW_PORT = 0x48,

   440

	WC_CLIENT_LIST = 0x49,

   441

	WC_NETWORK_STATUS_WINDOW = 0x4A,

   442

	WC_CUSTOM_CURRENCY = 0x4B,

   443

	WC_REPLACE_VEHICLE = 0x4C,

   444

	WC_HIGHSCORE = 0x4D,

   445

	WC_ENDSCREEN = 0x4E,

   446

	WC_SIGN_LIST = 0x4F,

   447

};

   448

   449

   450

enum {

   451

	EXPENSES_CONSTRUCTION = 0,

   452

	EXPENSES_NEW_VEHICLES = 1,

   453

	EXPENSES_TRAIN_RUN = 2,

   454

	EXPENSES_ROADVEH_RUN = 3,

   455

	EXPENSES_AIRCRAFT_RUN = 4,

   456

	EXPENSES_SHIP_RUN = 5,

   457

	EXPENSES_PROPERTY = 6,

   458

	EXPENSES_TRAIN_INC = 7,

   459

	EXPENSES_ROADVEH_INC = 8,

   460

	EXPENSES_AIRCRAFT_INC = 9,

   461

	EXPENSES_SHIP_INC = 10,

   462

	EXPENSES_LOAN_INT = 11,

   463

	EXPENSES_OTHER = 12,

   464

};

   465

   466

// Tile type misc constants, don't know where to put these

   467

enum {

   468

	TRACKTYPE_SPRITE_PITCH = 0x52,

   469

};

   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_LAST = SPECSTR_TOWNNAME_SWISS,

   495

   496

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

   497

	SPECSTR_PLAYERNAME_START = 0x70EA,

   498

	SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,

   499

	SPECSTR_PLAYERNAME_FRENCH,

   500

	SPECSTR_PLAYERNAME_GERMAN,

   501

	SPECSTR_PLAYERNAME_AMERICAN,

   502

	SPECSTR_PLAYERNAME_LATIN,

   503

	SPECSTR_PLAYERNAME_SILLY,

   504

	SPECSTR_PLAYERNAME_LAST = SPECSTR_PLAYERNAME_SILLY,

   505

   506

	SPECSTR_ANDCO_NAME = 0x70E6,

   507

	SPECSTR_PRESIDENT_NAME = 0x70E7,

   508

	SPECSTR_SONGNAME = 0x70E8,

   509

   510

	// reserve 32 strings for the *.lng files

   511

	SPECSTR_LANGUAGE_START = 0x7100,

   512

	SPECSTR_LANGUAGE_END = 0x711f,

   513