1

#ifndef TTD_H

     2

#define TTD_H

     3

     4

// include strings

     5

#include "table/strings.h"

     6

     7

#ifndef VARDEF

     8

#define VARDEF extern

     9

#endif

    10

    11

// use this on non static functions

    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

typedef struct YearMonthDay {

    32

	int year, month, day;

    33

} YearMonthDay;

    34

    35

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

    36

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

    39

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

    41

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

    42

*/

    43

#define DAY_TICKS 74

    44

    45

#include "macros.h"

    46

    47

// Forward declarations of structs.

    48

typedef struct Vehicle Vehicle;

    49

typedef struct Depot Depot;

    50

typedef struct Checkpoint Checkpoint;

    51

typedef struct Window Window;

    52

typedef struct Station Station;

    53

typedef struct ViewPort ViewPort;

    54

typedef struct Town Town;

    55

typedef struct NewsItem NewsItem;

    56

typedef struct Industry Industry;

    57

typedef struct DrawPixelInfo DrawPixelInfo;

    58

typedef uint16 VehicleID;

    59

typedef uint16 StringID;

    60

typedef uint16 SpriteID;

    61

typedef uint32 PalSpriteID;

    62

    63

typedef uint32 WindowNumber;

    64

typedef byte WindowClass;

    65

    66

    67

enum GameModes {

    68

	GM_MENU,

    69

	GM_NORMAL,

    70

	GM_EDITOR

    71

};

    72

    73

enum SwitchModes {

    74

	SM_NONE = 0,

    75

	SM_NEWGAME = 1,

    76

	SM_EDITOR = 2,

    77

	SM_LOAD = 3,

    78

	SM_MENU = 4,

    79

	SM_SAVE = 5,

    80

	SM_GENRANDLAND = 6,

    81

	SM_LOAD_SCENARIO = 9,

    82

    83

};

    84

    85

enum MapTileTypes {

    86

	MP_CLEAR,

    87

	MP_RAILWAY,

    88

	MP_STREET,

    89

	MP_HOUSE,

    90

	MP_TREES,

    91

	MP_STATION,

    92

	MP_WATER,

    93

	MP_STRANGE,

    94

	MP_INDUSTRY,

    95

	MP_TUNNELBRIDGE,

    96

	MP_UNMOVABLE

    97

};

    98

    99

typedef enum TransportTypes {

   100

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

   101

	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge

   102

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

   103

	 * constants would be used everywhere when accessing tunnels and

   104

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

   105

	 * and rail.

   106

	 */

   107

        TRANSPORT_RAIL = 0,

   108

	TRANSPORT_ROAD = 1,

   109

	TRANSPORT_WATER,

   110

	TRANSPORT_MAX

   111

} TransportType;

   112

   113

typedef struct TileInfo {

   114

	uint x;

   115

	uint y;

   116

	uint tileh;

   117

	uint type;

   118

	uint map5;

   119

	uint tile;

   120

	uint z;

   121

} TileInfo;

   122

   123

enum {

   124

	NG_EDGE = 1,

   125

};

   126

   127

/* Display Options */

   128

enum {

   129

	DO_SHOW_TOWN_NAMES  = 1,

   130

	DO_SHOW_STATION_NAMES = 2,

   131

	DO_SHOW_SIGNS = 4,

   132

	DO_FULL_ANIMATION = 8,

   133

	DO_TRANS_BUILDINGS = 0x10,

   134

	DO_FULL_DETAIL = 0x20,

   135

	DO_CHECKPOINTS = 0x40,

   136

};

   137

   138

/* Landscape types */

   139

enum {

   140

	LT_NORMAL = 0,

   141

	LT_HILLY = 1,

   142

	LT_DESERT = 2,

   143

	LT_CANDY = 3,

   144

   145

	NUM_LANDSCAPE = 4,

   146

};

   147

   148

enum {

   149

	NUM_PRICES = 49,

   150

};

   151

   152

typedef struct Prices {

   153

	int32 station_value;

   154

	int32 build_rail;

   155

	int32 build_road;

   156

	int32 build_signals;

   157

	int32 build_bridge;

   158

	int32 build_train_depot;

   159

	int32 build_road_depot;

   160

	int32 build_ship_depot;

   161

	int32 build_tunnel;

   162

	int32 train_station_track;

   163

	int32 train_station_length;

   164

	int32 build_airport;

   165

	int32 build_bus_station;

   166

	int32 build_truck_station;

   167

	int32 build_dock;

   168

	int32 build_railvehicle;

   169

	int32 build_railwagon;

   170

	int32 aircraft_base;

   171

	int32 roadveh_base;

   172

	int32 ship_base;

   173

	int32 build_trees;

   174

	int32 terraform;

   175

	int32 clear_1;

   176

	int32 purchase_land;

   177

	int32 clear_2;

   178

	int32 clear_3;

   179

	int32 remove_trees;

   180

	int32 remove_rail;

   181

	int32 remove_signals;

   182

	int32 clear_bridge;

   183

	int32 remove_train_depot;

   184

	int32 remove_road_depot;

   185

	int32 remove_ship_depot;

   186

	int32 clear_tunnel;

   187

	int32 clear_water;

   188

	int32 remove_rail_station;

   189

	int32 remove_airport;

   190

	int32 remove_bus_station;

   191

	int32 remove_truck_station;

   192

	int32 remove_dock;

   193

	int32 remove_house;

   194

	int32 remove_road;

   195

	int32 running_rail[3];

   196

	int32 aircraft_running;

   197

	int32 roadveh_running;

   198

	int32 ship_running;

   200

} Prices;

   201

   202

#define GAME_DIFFICULTY_NUM 18

   203

   204

typedef struct GameDifficulty {

   205

	int max_no_competitors;

   206

	int competitor_start_time;

   207

	int number_towns;

   208

	int number_industries;

   209

	int max_loan;

   210

	int initial_interest;

   211

	int vehicle_costs;

   212

	int competitor_speed;

   213

	int competitor_intelligence;

   214

	int vehicle_breakdowns;

   215

	int subsidy_multiplier;

   216

	int construction_cost;

   217

	int terrain_type;

   218

	int quantity_sea_lakes;

   219

	int economy;

   220

	int line_reverse_mode;

   221

	int disasters;

   222

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

   223

} GameDifficulty;

   224

   225

typedef struct AcceptedCargo {

   226

	int type_1, amount_1;

   227

	int type_2, amount_2;

   228

	int type_3, amount_3;

   229

} AcceptedCargo;

   230

   231

typedef struct TileDesc {

   232

	StringID str;

   233

	byte owner;

   234

	uint16 build_date;

   235

	uint32 dparam[2];

   236

} TileDesc;

   237

   238

typedef struct {

   239

	int16 left, top;

   240

	byte width_1, width_2;

   241

} ViewportSign;

   242

   243

typedef struct SignStruct {

   244

	StringID str;

   245

	ViewportSign sign;

   246

	int16 x,y;

   247

	byte z;

   248

} SignStruct;

   249

   250

   251

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

   252

   253

typedef void DrawTileProc(TileInfo *ti);

   254

typedef uint GetSlopeZProc(TileInfo *ti);

   255

typedef int32 ClearTileProc(uint tile, byte flags);

   256

typedef void GetAcceptedCargoProc(uint tile, AcceptedCargo *res);

   257

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

   258

/* GetTileTrackStatusProcs return a value that contains the possible tracks

   259

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

   260

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

   261

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

   262

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

   263

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

   264

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

   265

 *

   266

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

   267

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

   268

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

   269

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

   271

 *

   272

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

   273

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

   274

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

   276

 */

   277

typedef uint32 GetTileTrackStatusProc(uint tile, TransportType mode);

   278

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

   279

typedef void ClickTileProc(uint tile);

   280

typedef void AnimateTileProc(uint tile);

   281

typedef void TileLoopProc(uint tile);

   282

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

   283

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

   284

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

   285

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

   286

 * other bits that can be set? */

   287

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

   288

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

   289

typedef uint GetSlopeTilehProc(TileInfo *ti);

   290

   291

typedef struct {

   292

	DrawTileProc *draw_tile_proc;

   293

	GetSlopeZProc *get_slope_z_proc;

   294

	ClearTileProc *clear_tile_proc;

   295

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   296

	GetTileDescProc *get_tile_desc_proc;

   297

	GetTileTrackStatusProc *get_tile_track_status_proc;

   298

	ClickTileProc *click_tile_proc;

   299

	AnimateTileProc *animate_tile_proc;

   300

	TileLoopProc *tile_loop_proc;

   301

	ChangeTileOwnerProc *change_tile_owner_proc;

   302

	GetProducedCargoProc *get_produced_cargo_proc;

   303

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   304

	VehicleLeaveTileProc *vehicle_leave_tile_proc;

   305

	GetSlopeTilehProc *get_slope_tileh_proc;

   306

} TileTypeProcs;

   307

   308

   309

   310

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

   311

   312

enum {

   313

	MP_MAP2 = 1<<0,

   314

	MP_MAP3LO = 1<<1,

   315

	MP_MAP3HI = 1<<2,

   316

	MP_MAP5 = 1<<3,

   317

	MP_MAPOWNER_CURRENT = 1<<4,

   318

	MP_MAPOWNER = 1<<5,

   320

	MP_TYPE_MASK = 0xF << 8,

   321

   322

	MP_MAP2_CLEAR = 1 << 12,

   323

	MP_MAP3LO_CLEAR = 1 << 13,

   324

	MP_MAP3HI_CLEAR = 1 << 14,

   325

   326

	MP_NODIRTY = 1<<15,

   327

};

   328

   329

enum {

   330

	// Temperate

   331

	CT_PASSENGERS = 0,

   332

	CT_COAL = 1,

   333

	CT_MAIL = 2,

   334

	CT_OIL = 3,

   335

	CT_LIVESTOCK = 4,

   336

	CT_GOODS = 5,

   337

	CT_GRAIN = 6,

   338

	CT_WOOD = 7,

   339

	CT_IRON_ORE = 8,

   340

	CT_STEEL = 9,

   341

	CT_VALUABLES = 10,

   342

	CT_FOOD = 11,

   343

   344

	// Arctic

   345

	CT_HILLY_UNUSED = 8,

   346

	CT_PAPER = 9,

   347

   348

	// Tropic

   349

	CT_RUBBER = 1,

   350

	CT_FRUIT = 4,

   351

	CT_COPPER_ORE = 8,

   352

	CT_WATER = 9,

   353

   354

	// Toyland

   355

	CT_SUGAR = 1,

   356

	CT_TOYS = 3,

   357

	CT_BATTERIES = 4,

   358

	CT_CANDY = 5,

   359

	CT_TOFFEE = 6,

   360

	CT_COLA = 7,

   361

	CT_COTTON_CANDY = 8,

   362

	CT_BUBBLES = 9,

   363

	CT_PLASTIC = 10,

   364

	CT_FIZZY_DRINKS = 11,

   365

   366

	NUM_CARGO = 12,

   367

};

   368

   369

enum {

   370

	WC_MAIN_WINDOW = 0x0,

   371

	WC_MAIN_TOOLBAR = 0x1,

   372

	WC_STATUS_BAR = 0x2,

   373

	WC_BUILD_TOOLBAR = 0x3,

   374

	WC_NEWS_WINDOW = 0x4,

   375

	WC_TOWN_DIRECTORY = 0x5,

   376

	WC_STATION_LIST = 0x6,

   377

	WC_TOWN_VIEW = 0x7,

   378

	WC_SMALLMAP = 0x8,

   379

	WC_TRAINS_LIST = 0x9,

   380

	WC_ROADVEH_LIST = 0xA,

   381

	WC_SHIPS_LIST = 0xB,

   382

	WC_AIRCRAFT_LIST = 0xC,

   383

	WC_VEHICLE_VIEW = 0xD,

   384

	WC_VEHICLE_DETAILS = 0xE,

   385

	WC_VEHICLE_REFIT = 0xF,

   386

	WC_VEHICLE_ORDERS = 0x10,

   387

	WC_STATION_VIEW = 0x11,

   388

	WC_VEHICLE_DEPOT = 0x12,

   389

	WC_BUILD_VEHICLE = 0x13,

   390

	WC_BUILD_BRIDGE = 0x14,

   391

	WC_ERRMSG = 0x15,

   392

	WC_ASK_ABANDON_GAME = 0x16,

   393

	WC_QUIT_GAME = 0x17,

   394

	WC_BUILD_STATION = 0x18,

   395

	WC_BUS_STATION = 0x19,

   396

	WC_TRUCK_STATION = 0x1A,

   397

	WC_BUILD_DEPOT = 0x1B,

   398

	WC_DEBUGGER = 0x1C,

   399

	WC_COMPANY = 0x1D,

   400

	WC_FINANCES = 0x1E,

   401

	WC_PLAYER_COLOR = 0x1F,

   402

	WC_QUERY_STRING = 0x20,

   403

	WC_SAVELOAD = 0x21,

   404

	WC_SELECT_GAME = 0x22,

   405

	WC_TOOLBAR_MENU = 0x24,

   406

	WC_INCOME_GRAPH = 0x25,

   407

	WC_OPERATING_PROFIT = 0x26,

   408

	WC_TOOLTIPS = 0x27,

   409

	WC_INDUSTRY_VIEW = 0x28,

   410

	WC_PLAYER_FACE = 0x29,

   411

	WC_LAND_INFO = 0x2A,

   412

	WC_TOWN_AUTHORITY = 0x2B,

   413

	WC_SUBSIDIES_LIST = 0x2C,

   414

	WC_GRAPH_LEGEND = 0x2D,

   415

	WC_DELIVERED_CARGO = 0x2E,

   416

	WC_PERFORMANCE_HISTORY = 0x2F,

   417

	WC_COMPANY_VALUE = 0x30,

   418

	WC_COMPANY_LEAGUE = 0x31,

   419

	WC_BUY_COMPANY = 0x32,

   420

	WC_PAYMENT_RATES = 0x33,

   421

	WC_SELECT_TUTORIAL = 0x34,

   422

	WC_ENGINE_PREVIEW = 0x35,

   423

	WC_MUSIC_WINDOW = 0x36,

   424

	WC_MUSIC_TRACK_SELECTION = 0x37,

   425

	WC_SCEN_LAND_GEN = 0x38,

   426

	WC_ASK_RESET_LANDSCAPE = 0x39,

   427

	WC_SCEN_TOWN_GEN = 0x3A,

   428

	WC_SCEN_INDUSTRY = 0x3B,

   429

	WC_SCEN_BUILD_ROAD = 0x3C,

   430

	WC_SCEN_BUILD_TREES = 0x3D,

   431

	WC_SEND_NETWORK_MSG = 0x3E,

   432

	WC_DROPDOWN_MENU = 0x3F,

   433

	WC_BUILD_INDUSTRY = 0x40,

   434

	WC_GAME_OPTIONS = 0x41,

   435

	WC_NETWORK_WINDOW = 0x42,

   436

	WC_INDUSTRY_DIRECTORY = 0x43,

   437

	WC_MESSAGE_HISTORY = 0x44,

   438

	WC_CHEATS = 0x45,

   439

	WC_PERFORMANCE_DETAIL = 0x46,

   440

	WC_CONSOLE = 0x47,

   441

	WC_EXTRA_VIEW_PORT = 0x48,

   442

};

   443

   444

   445

enum {

   446

	EXPENSES_CONSTRUCTION = 0,

   447

	EXPENSES_NEW_VEHICLES = 1,

   448

	EXPENSES_TRAIN_RUN = 2,

   449

	EXPENSES_ROADVEH_RUN = 3,

   450

	EXPENSES_AIRCRAFT_RUN = 4,

   451

	EXPENSES_SHIP_RUN = 5,

   452

	EXPENSES_PROPERTY = 6,

   453

	EXPENSES_TRAIN_INC = 7,

   454

	EXPENSES_ROADVEH_INC = 8,

   455

	EXPENSES_AIRCRAFT_INC = 9,

   456

	EXPENSES_SHIP_INC = 10,

   457

	EXPENSES_LOAN_INT = 11,

   458

	EXPENSES_OTHER = 12,

   459

};

   460

   461

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

   462

enum {

   463

	TRACKTYPE_SPRITE_PITCH = 0x52,

   464

};

   465

   466

   467

// special string constants

   468

enum SpecialStrings {

   470

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

   471

	SPECSTR_TOWNNAME_START = 0x20C0,

   472

	SPECSTR_TOWNNAME_ENGLISH = SPECSTR_TOWNNAME_START,

   473

	SPECSTR_TOWNNAME_FRENCH,

   474

	SPECSTR_TOWNNAME_GERMAN,

   475

	SPECSTR_TOWNNAME_AMERICAN,

   476

	SPECSTR_TOWNNAME_LATIN,

   477

	SPECSTR_TOWNNAME_SILLY,

   478

	SPECSTR_TOWNNAME_SWEDISH,

   479

	SPECSTR_TOWNNAME_DUTCH,

   480

	SPECSTR_TOWNNAME_FINNISH,

   481

	SPECSTR_TOWNNAME_POLISH,

   482

	SPECSTR_TOWNNAME_CZECH,

   483

	SPECSTR_TOWNNAME_SLOVAKISH,

   484

	SPECSTR_TOWNNAME_HUNGARIAN,

   485

	SPECSTR_TOWNNAME_AUSTRIAN,

   486

	SPECSTR_TOWNNAME_LAST = SPECSTR_TOWNNAME_AUSTRIAN,

   487

   488

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

   489

	SPECSTR_PLAYERNAME_START = 0x70EA,

   490

	SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,

   491

	SPECSTR_PLAYERNAME_FRENCH,

   492

	SPECSTR_PLAYERNAME_GERMAN,

   493

	SPECSTR_PLAYERNAME_AMERICAN,

   494

	SPECSTR_PLAYERNAME_LATIN,

   495

	SPECSTR_PLAYERNAME_SILLY,

   497

   498

	SPECSTR_ANDCO_NAME = 0x70E6,

   499

	SPECSTR_PRESIDENT_NAME = 0x70E7,

   500

	SPECSTR_SONGNAME = 0x70E8,

   501

   502

	// reserve 32 strings for the *.lng files

   503

	SPECSTR_LANGUAGE_START = 0x7100,

   504

	SPECSTR_LANGUAGE_END = 0x711f,

   505

   506

	// reserve 32 strings for various screen resolutions

   507

	SPECSTR_RESOLUTION_START = 0x7120,

   508

	SPECSTR_RESOLUTION_END = 0x713f,

   509

   510

	// reserve 32 strings for screenshot formats

   511

	SPECSTR_SCREENSHOT_START = 0x7140,

   512

	SPECSTR_SCREENSHOT_END = 0x715F,

   513

   514

	STR_SPEC_SCREENSHOT_NAME = 0xF800,

   515

	STR_SPEC_USERSTRING = 0xF801,

   516

};

   517

   518

typedef void PlaceProc(uint tile);

   519

   520

enum Sprites {

   521

	SPR_CANALS_BASE = 0x1406,

   522

	SPR_SLOPES_BASE = SPR_CANALS_BASE + 70,

   523

	SPR_OPENTTD_BASE = SPR_SLOPES_BASE + 74,