1

#ifndef TTD_H

     2

#define TTD_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

    54

#include "macros.h"

    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;

    70

typedef uint16 StringID;

    71

typedef uint16 SpriteID;

    72

typedef uint32 PalSpriteID;

    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

typedef enum TransportTypes {

    97

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

    98

	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge

    99

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

   100

	 * constants would be used everywhere when accessing tunnels and

   101

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

   102

	 * and rail.

   103

	 */

   104

  TRANSPORT_RAIL = 0,

   105

	TRANSPORT_ROAD = 1,

   106

	TRANSPORT_WATER,	// = 2

   107

	TRANSPORT_MAX			// = 3

   108

} TransportType;

   109

   110

typedef struct TileInfo {

   111

	uint x;

   112

	uint y;

   113

	uint tileh;

   114

	uint type;

   115

	uint map5;

   116

	uint tile;

   117

	uint z;

   118

} TileInfo;

   119

   120

enum {

   121

	NG_EDGE = 1,

   122

};

   123

   124

/* Display Options */

   125

enum {

   126

	DO_SHOW_TOWN_NAMES  = 1,

   127

	DO_SHOW_STATION_NAMES = 2,

   128

	DO_SHOW_SIGNS = 4,

   129

	DO_FULL_ANIMATION = 8,

   130

	DO_TRANS_BUILDINGS = 0x10,

   131

	DO_FULL_DETAIL = 0x20,

   132

	DO_WAYPOINTS = 0x40,

   133

};

   134

   135

/* Landscape types */

   136

enum {

   137

	LT_NORMAL = 0,

   138

	LT_HILLY = 1,

   139

	LT_DESERT = 2,

   140

	LT_CANDY = 3,

   141

   142

	NUM_LANDSCAPE = 4,

   143

};

   144

   145

enum {

   146

	NUM_PRICES = 49,

   147

};

   148

   149

typedef struct Prices {

   150

	int32 station_value;

   151

	int32 build_rail;

   152

	int32 build_road;

   153

	int32 build_signals;

   154

	int32 build_bridge;

   155

	int32 build_train_depot;

   156

	int32 build_road_depot;

   157

	int32 build_ship_depot;

   158

	int32 build_tunnel;

   159

	int32 train_station_track;

   160

	int32 train_station_length;

   161

	int32 build_airport;

   162

	int32 build_bus_station;

   163

	int32 build_truck_station;

   164

	int32 build_dock;

   165

	int32 build_railvehicle;

   166

	int32 build_railwagon;

   167

	int32 aircraft_base;

   168

	int32 roadveh_base;

   169

	int32 ship_base;

   170

	int32 build_trees;

   171

	int32 terraform;

   172

	int32 clear_1;

   173

	int32 purchase_land;

   174

	int32 clear_2;

   175

	int32 clear_3;

   176

	int32 remove_trees;

   177

	int32 remove_rail;

   178

	int32 remove_signals;

   179

	int32 clear_bridge;

   180

	int32 remove_train_depot;

   181

	int32 remove_road_depot;

   182

	int32 remove_ship_depot;

   183

	int32 clear_tunnel;

   184

	int32 clear_water;

   185

	int32 remove_rail_station;

   186

	int32 remove_airport;

   187

	int32 remove_bus_station;

   188

	int32 remove_truck_station;

   189

	int32 remove_dock;

   190

	int32 remove_house;

   191

	int32 remove_road;

   192

	int32 running_rail[3];

   193

	int32 aircraft_running;

   194

	int32 roadveh_running;

   195

	int32 ship_running;

   196

	int32 build_industry;

   197

} Prices;

   198

   199

#define GAME_DIFFICULTY_NUM 18

   200

   201

typedef struct GameDifficulty {

   202

	int max_no_competitors;

   203

	int competitor_start_time;

   204

	int number_towns;

   205

	int number_industries;

   206

	int max_loan;

   207

	int initial_interest;

   208

	int vehicle_costs;

   209

	int competitor_speed;

   210

	int competitor_intelligence;

   211

	int vehicle_breakdowns;

   212

	int subsidy_multiplier;

   213

	int construction_cost;

   214

	int terrain_type;

   215

	int quantity_sea_lakes;

   216

	int economy;

   217

	int line_reverse_mode;

   218

	int disasters;

   219

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

   220

} GameDifficulty;

   221

   222

enum {

   223

	// Temperate

   224

	CT_PASSENGERS = 0,

   225

	CT_COAL = 1,

   226

	CT_MAIL = 2,

   227

	CT_OIL = 3,

   228

	CT_LIVESTOCK = 4,

   229

	CT_GOODS = 5,

   230

	CT_GRAIN = 6,

   231

	CT_WOOD = 7,

   232

	CT_IRON_ORE = 8,

   233

	CT_STEEL = 9,

   234

	CT_VALUABLES = 10,

   235

	CT_FOOD = 11,

   236

   237

	// Arctic

   238

	CT_WHEAT = 6,

   239

	CT_HILLY_UNUSED = 8,

   240

	CT_PAPER = 9,

   241

	CT_GOLD = 10,

   242

   243

	// Tropic

   244

	CT_RUBBER = 1,

   245

	CT_FRUIT = 4,

   246

	CT_MAIZE = 6,

   247

	CT_COPPER_ORE = 8,

   248

	CT_WATER = 9,

   249

	CT_DIAMONDS = 10,

   250

   251

	// Toyland

   252

	CT_SUGAR = 1,

   253

	CT_TOYS = 3,

   254

	CT_BATTERIES = 4,

   255

	CT_CANDY = 5,

   256

	CT_TOFFEE = 6,

   257

	CT_COLA = 7,

   258

	CT_COTTON_CANDY = 8,

   259

	CT_BUBBLES = 9,

   260

	CT_PLASTIC = 10,

   261

	CT_FIZZY_DRINKS = 11,

   262

   263

	NUM_CARGO = 12,

   264

   265

	CT_INVALID = 0xFF

   266

};

   267

   268

typedef uint AcceptedCargo[NUM_CARGO];

   269

   270

typedef struct TileDesc {

   271

	StringID str;

   272

	byte owner;

   273

	uint16 build_date;

   274

	uint32 dparam[2];

   275

} TileDesc;

   276

   277

typedef struct {

   278

	int32 left;

   279

	int32 top;

   280

	byte width_1, width_2;

   281

} ViewportSign;

   282

   283

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

   284

   285

typedef void DrawTileProc(TileInfo *ti);

   286

typedef uint GetSlopeZProc(TileInfo *ti);

   287

typedef int32 ClearTileProc(uint tile, byte flags);

   288

typedef void GetAcceptedCargoProc(uint tile, AcceptedCargo res);

   289

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

   290

/* GetTileTrackStatusProcs return a value that contains the possible tracks

   291

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

   292

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

   293

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

   294

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

   295

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

   296

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

   297

 *

   298

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

   299

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

   300

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

   301

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

   302

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

   303

 *

   304

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

   305

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

   306

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

   307

 * above.

   308

 */

   309

typedef uint32 GetTileTrackStatusProc(uint tile, TransportType mode);

   310

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

   311

typedef void ClickTileProc(uint tile);

   312

typedef void AnimateTileProc(uint tile);

   313

typedef void TileLoopProc(uint tile);

   314

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

   315

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

   316

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

   317

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

   318

 * other bits that can be set? */

   319

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

   320

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

   321

typedef uint GetSlopeTilehProc(TileInfo *ti);

   322

   323

typedef struct {

   324

	DrawTileProc *draw_tile_proc;

   325

	GetSlopeZProc *get_slope_z_proc;

   326

	ClearTileProc *clear_tile_proc;

   327

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   328

	GetTileDescProc *get_tile_desc_proc;

   329

	GetTileTrackStatusProc *get_tile_track_status_proc;

   330

	ClickTileProc *click_tile_proc;

   331

	AnimateTileProc *animate_tile_proc;

   332

	TileLoopProc *tile_loop_proc;

   333

	ChangeTileOwnerProc *change_tile_owner_proc;

   334

	GetProducedCargoProc *get_produced_cargo_proc;

   335

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   336

	VehicleLeaveTileProc *vehicle_leave_tile_proc;

   337

	GetSlopeTilehProc *get_slope_tileh_proc;

   338

} TileTypeProcs;

   339

   340

   341

   342

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

   343

   344

enum {

   345

	MP_MAP2 = 1<<0,

   346

	MP_MAP3LO = 1<<1,

   347

	MP_MAP3HI = 1<<2,

   348

	MP_MAP5 = 1<<3,

   349

	MP_MAPOWNER_CURRENT = 1<<4,

   350

	MP_MAPOWNER = 1<<5,

   351

   352

	MP_TYPE_MASK = 0xF << 8,

   353

   354

	MP_MAP2_CLEAR = 1 << 12,

   355

	MP_MAP3LO_CLEAR = 1 << 13,

   356

	MP_MAP3HI_CLEAR = 1 << 14,

   357

   358

	MP_NODIRTY = 1<<15,

   359

};

   360

   361

enum {

   362

	WC_MAIN_WINDOW = 0x0,

   363

	WC_MAIN_TOOLBAR = 0x1,

   364

	WC_STATUS_BAR = 0x2,

   365

	WC_BUILD_TOOLBAR = 0x3,

   366

	WC_NEWS_WINDOW = 0x4,

   367

	WC_TOWN_DIRECTORY = 0x5,

   368

	WC_STATION_LIST = 0x6,

   369

	WC_TOWN_VIEW = 0x7,

   370

	WC_SMALLMAP = 0x8,

   371

	WC_TRAINS_LIST = 0x9,

   372

	WC_ROADVEH_LIST = 0xA,

   373

	WC_SHIPS_LIST = 0xB,

   374

	WC_AIRCRAFT_LIST = 0xC,

   375

	WC_VEHICLE_VIEW = 0xD,

   376

	WC_VEHICLE_DETAILS = 0xE,

   377

	WC_VEHICLE_REFIT = 0xF,

   378

	WC_VEHICLE_ORDERS = 0x10,

   379

	WC_STATION_VIEW = 0x11,

   380

	WC_VEHICLE_DEPOT = 0x12,

   381

	WC_BUILD_VEHICLE = 0x13,

   382

	WC_BUILD_BRIDGE = 0x14,

   383

	WC_ERRMSG = 0x15,

   384

	WC_ASK_ABANDON_GAME = 0x16,

   385

	WC_QUIT_GAME = 0x17,

   386

	WC_BUILD_STATION = 0x18,

   387

	WC_BUS_STATION = 0x19,

   388

	WC_TRUCK_STATION = 0x1A,

   389

	WC_BUILD_DEPOT = 0x1B,

   390

	WC_DEBUGGER = 0x1C,

   391

	WC_COMPANY = 0x1D,

   392

	WC_FINANCES = 0x1E,

   393

	WC_PLAYER_COLOR = 0x1F,

   394

	WC_QUERY_STRING = 0x20,

   395

	WC_SAVELOAD = 0x21,

   396

	WC_SELECT_GAME = 0x22,

   397

	WC_TOOLBAR_MENU = 0x24,

   398

	WC_INCOME_GRAPH = 0x25,

   399

	WC_OPERATING_PROFIT = 0x26,

   400

	WC_TOOLTIPS = 0x27,

   401

	WC_INDUSTRY_VIEW = 0x28,

   402

	WC_PLAYER_FACE = 0x29,

   403

	WC_LAND_INFO = 0x2A,

   404

	WC_TOWN_AUTHORITY = 0x2B,

   405

	WC_SUBSIDIES_LIST = 0x2C,

   406

	WC_GRAPH_LEGEND = 0x2D,

   407

	WC_DELIVERED_CARGO = 0x2E,

   408

	WC_PERFORMANCE_HISTORY = 0x2F,

   409

	WC_COMPANY_VALUE = 0x30,

   410

	WC_COMPANY_LEAGUE = 0x31,

   411

	WC_BUY_COMPANY = 0x32,

   412

	WC_PAYMENT_RATES = 0x33,

   413

	WC_SELECT_TUTORIAL = 0x34,

   414

	WC_ENGINE_PREVIEW = 0x35,

   415

	WC_MUSIC_WINDOW = 0x36,

   416

	WC_MUSIC_TRACK_SELECTION = 0x37,

   417

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

   418

	WC_ASK_RESET_LANDSCAPE = 0x39,

   419

	WC_SCEN_TOWN_GEN = 0x3A,

   420

	WC_SCEN_INDUSTRY = 0x3B,

   421

	WC_SCEN_BUILD_ROAD = 0x3C,

   422

	WC_BUILD_TREES = 0x3D,

   423

	WC_SEND_NETWORK_MSG = 0x3E,

   424

	WC_DROPDOWN_MENU = 0x3F,

   425

	WC_BUILD_INDUSTRY = 0x40,

   426

	WC_GAME_OPTIONS = 0x41,

   427

	WC_NETWORK_WINDOW = 0x42,

   428

	WC_INDUSTRY_DIRECTORY = 0x43,

   429

	WC_MESSAGE_HISTORY = 0x44,

   430

	WC_CHEATS = 0x45,

   431

	WC_PERFORMANCE_DETAIL = 0x46,

   432

	WC_CONSOLE = 0x47,

   433

	WC_EXTRA_VIEW_PORT = 0x48,

   434

	WC_CLIENT_LIST = 0x49,

   435

	WC_NETWORK_STATUS_WINDOW = 0x4A,

   436

	WC_CUSTOM_CURRENCY = 0x4B,

   437

	WC_REPLACE_VEHICLE = 0x4C,

   438

	WC_HIGHSCORE_ENDSCREEN = 0x4D,

   439

	WC_SIGN_LIST = 0x4E,

   440

};

   441

   442

   443

enum {

   444

	EXPENSES_CONSTRUCTION = 0,

   445

	EXPENSES_NEW_VEHICLES = 1,

   446

	EXPENSES_TRAIN_RUN = 2,

   447

	EXPENSES_ROADVEH_RUN = 3,

   448

	EXPENSES_AIRCRAFT_RUN = 4,

   449

	EXPENSES_SHIP_RUN = 5,

   450

	EXPENSES_PROPERTY = 6,

   451

	EXPENSES_TRAIN_INC = 7,

   452

	EXPENSES_ROADVEH_INC = 8,

   453

	EXPENSES_AIRCRAFT_INC = 9,

   454

	EXPENSES_SHIP_INC = 10,

   455

	EXPENSES_LOAN_INT = 11,

   456

	EXPENSES_OTHER = 12,

   457

};

   458

   459

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

   460

enum {

   461

	TRACKTYPE_SPRITE_PITCH = 0x52,

   462

};

   463

   464

   465

// special string constants

   466

enum SpecialStrings {

   467

   468

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

   469

	SPECSTR_TOWNNAME_START = 0x20C0,

   470

	SPECSTR_TOWNNAME_ENGLISH = SPECSTR_TOWNNAME_START,

   471

	SPECSTR_TOWNNAME_FRENCH,

   472

	SPECSTR_TOWNNAME_GERMAN,

   473

	SPECSTR_TOWNNAME_AMERICAN,

   474

	SPECSTR_TOWNNAME_LATIN,

   475

	SPECSTR_TOWNNAME_SILLY,

   476

	SPECSTR_TOWNNAME_SWEDISH,

   477

	SPECSTR_TOWNNAME_DUTCH,

   478

	SPECSTR_TOWNNAME_FINNISH,

   479

	SPECSTR_TOWNNAME_POLISH,

   480

	SPECSTR_TOWNNAME_SLOVAKISH,

   481

	SPECSTR_TOWNNAME_NORWEGIAN,

   482

	SPECSTR_TOWNNAME_HUNGARIAN,

   483

	SPECSTR_TOWNNAME_AUSTRIAN,

   484

	SPECSTR_TOWNNAME_ROMANIAN,

   485

	SPECSTR_TOWNNAME_CZECH,

   486

	SPECSTR_TOWNNAME_SWISS,

   487

  SPECSTR_TOWNNAME_LAST = SPECSTR_TOWNNAME_SWISS,

   488

   489

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

   490

	SPECSTR_PLAYERNAME_START = 0x70EA,

   491

	SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,

   492

	SPECSTR_PLAYERNAME_FRENCH,

   493

	SPECSTR_PLAYERNAME_GERMAN,

   494

	SPECSTR_PLAYERNAME_AMERICAN,

   495

	SPECSTR_PLAYERNAME_LATIN,

   496

	SPECSTR_PLAYERNAME_SILLY,

   497

	SPECSTR_PLAYERNAME_LAST = SPECSTR_PLAYERNAME_SILLY,

   498

   499

	SPECSTR_ANDCO_NAME = 0x70E6,

   500

	SPECSTR_PRESIDENT_NAME = 0x70E7,

   501

	SPECSTR_SONGNAME = 0x70E8,

   502

   503

	// reserve 32 strings for the *.lng files

   504

	SPECSTR_LANGUAGE_START = 0x7100,

   505

	SPECSTR_LANGUAGE_END = 0x711f,

   506

   507

	// reserve 32 strings for various screen resolutions

   508

	SPECSTR_RESOLUTION_START = 0x7120,

   509

	SPECSTR_RESOLUTION_END = 0x713f,

   510

   511

	// reserve 32 strings for screenshot formats

   512

	SPECSTR_SCREENSHOT_START = 0x7140,

   513

	SPECSTR_SCREENSHOT_END = 0x715F,

   514