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

#include "map.h"

    25

#include "slope.h"

    26

    27

// Forward declarations of structs.

    28

typedef struct Vehicle Vehicle;

    29

typedef struct Depot Depot;

    30

typedef struct Waypoint Waypoint;

    31

typedef struct Window Window;

    32

typedef struct Station Station;

    33

typedef struct ViewPort ViewPort;

    34

typedef struct Town Town;

    35

typedef struct NewsItem NewsItem;

    36

typedef struct Industry Industry;

    37

typedef struct DrawPixelInfo DrawPixelInfo;

    38

typedef uint16 VehicleID;

    39

typedef uint16 StationID;

    40

typedef uint16 TownID;

    41

typedef byte PlayerID;

    42

typedef byte OrderID;

    43

typedef byte CargoID;

    44

typedef byte LandscapeID;

    45

typedef uint16 StringID;

    46

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

    47

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

    48

typedef uint32 CursorID;

    49

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

    50

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

    51

    52

typedef uint32 WindowNumber;

    53

typedef byte WindowClass;

    54

    55

enum {

    56

	INVALID_YEAR = -1,

    58

};

    59

    62

    63

    64

enum GameModes {

    65

	GM_MENU,

    66

	GM_NORMAL,

    67

	GM_EDITOR

    68

};

    69

    70

enum SwitchModes {

    71

	SM_NONE = 0,

    72

	SM_NEWGAME = 1,

    73

	SM_EDITOR = 2,

    74

	SM_LOAD = 3,

    75

	SM_MENU = 4,

    76

	SM_SAVE = 5,

    77

	SM_GENRANDLAND = 6,

    78

	SM_LOAD_SCENARIO = 9,

    79

	SM_START_SCENARIO = 10,

    80

	SM_START_HEIGHTMAP = 11,

    81

	SM_LOAD_HEIGHTMAP = 12,

    82

};

    83

    84

    85

/* Modes for GenerateWorld */

    86

enum GenerateWorldModes {

    87

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

    88

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

    89

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

    90

	GW_HEIGHTMAP = 3,    /* Generate a newgame from a heightmap */

    91

};

    92

    93

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

    94

enum InitializeGameModes {

    95

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

    96

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

    97

};

    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

	 * In an ideal world, these constants would be used everywhere when

   104

	 * accessing tunnels and bridges. For now, you should just not change

   105

	 * the values for road and rail.

   106

	 */

   107

	TRANSPORT_RAIL = 0,

   108

	TRANSPORT_ROAD = 1,

   109

	TRANSPORT_WATER,	// = 2

   110

	TRANSPORT_END,

   111

	INVALID_TRANSPORT = 0xff,

   112

} TransportType;

   113

   114

typedef struct TileInfo {

   115

	uint x;

   116

	uint y;

   117

	Slope tileh;

   118

	TileIndex tile;

   119

	uint z;

   120

} TileInfo;

   121

   122

   123

/* Display Options */

   124

enum {

   125

	DO_SHOW_TOWN_NAMES =    1 << 0,

   126

	DO_SHOW_STATION_NAMES = 1 << 1,

   127

	DO_SHOW_SIGNS =         1 << 2,

   128

	DO_FULL_ANIMATION =     1 << 3,

   129

	DO_TRANS_BUILDINGS =    1 << 4,

   130

	DO_FULL_DETAIL =        1 << 5,

   131

	DO_WAYPOINTS =          1 << 6,

   132

	DO_TRANS_SIGNS =        1 << 7,

   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; // no longer in use

   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

	Date 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

   284

typedef void DrawTileProc(TileInfo *ti);

   285

typedef uint GetSlopeZProc(TileIndex tile, uint x, uint y);

   286

typedef int32 ClearTileProc(TileIndex tile, byte flags);

   287

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

   288

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

   289

/* GetTileTrackStatusProcs return a value that contains the possible tracks

   290

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

   291

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

   292

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

   293

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

   294

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

   295

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

   296

 *

   297

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

   298

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

   299

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

   300

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

   301

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

   302

 *

   303

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

   304

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

   305

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

   306

 * above.

   307

 */

   308

typedef uint32 GetTileTrackStatusProc(TileIndex tile, TransportType mode);

   309

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

   310

typedef void ClickTileProc(TileIndex tile);

   311

typedef void AnimateTileProc(TileIndex tile);

   312

typedef void TileLoopProc(TileIndex tile);

   313

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

   314

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

   315

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

   316

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

   317

 * other bits that can be set? */

   318

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

   319

typedef Slope GetSlopeTilehProc(TileIndex, Slope tileh);

   320

   321

typedef struct {

   322

	DrawTileProc *draw_tile_proc;

   323

	GetSlopeZProc *get_slope_z_proc;

   324

	ClearTileProc *clear_tile_proc;

   325

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   326

	GetTileDescProc *get_tile_desc_proc;

   327

	GetTileTrackStatusProc *get_tile_track_status_proc;

   328

	ClickTileProc *click_tile_proc;

   329

	AnimateTileProc *animate_tile_proc;

   330

	TileLoopProc *tile_loop_proc;

   331

	ChangeTileOwnerProc *change_tile_owner_proc;

   332

	GetProducedCargoProc *get_produced_cargo_proc;

   333

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   334

	GetSlopeTilehProc *get_slope_tileh_proc;

   335

} TileTypeProcs;

   336

   337

   338

enum {

   339

	WC_MAIN_WINDOW = 0x0,

   340

	WC_MAIN_TOOLBAR = 0x1,

   341

	WC_STATUS_BAR = 0x2,

   342

	WC_BUILD_TOOLBAR = 0x3,

   343

	WC_NEWS_WINDOW = 0x4,

   344

	WC_TOWN_DIRECTORY = 0x5,

   345

	WC_STATION_LIST = 0x6,

   346

	WC_TOWN_VIEW = 0x7,

   347

	WC_SMALLMAP = 0x8,

   348

	WC_TRAINS_LIST = 0x9,

   349

	WC_ROADVEH_LIST = 0xA,

   350

	WC_SHIPS_LIST = 0xB,

   351

	WC_AIRCRAFT_LIST = 0xC,

   352

	WC_VEHICLE_VIEW = 0xD,

   353

	WC_VEHICLE_DETAILS = 0xE,

   354

	WC_VEHICLE_REFIT = 0xF,

   355

	WC_VEHICLE_ORDERS = 0x10,

   356

	WC_STATION_VIEW = 0x11,

   357

	WC_VEHICLE_DEPOT = 0x12,

   358

	WC_BUILD_VEHICLE = 0x13,

   359

	WC_BUILD_BRIDGE = 0x14,

   360

	WC_ERRMSG = 0x15,

   361

	WC_ASK_ABANDON_GAME = 0x16,

   362

	WC_QUIT_GAME = 0x17,

   363

	WC_BUILD_STATION = 0x18,

   364

	WC_BUS_STATION = 0x19,

   365

	WC_TRUCK_STATION = 0x1A,

   366

	WC_BUILD_DEPOT = 0x1B,

   367

	WC_COMPANY = 0x1D,

   368

	WC_FINANCES = 0x1E,

   369

	WC_PLAYER_COLOR = 0x1F,

   370

	WC_QUERY_STRING = 0x20,

   371

	WC_SAVELOAD = 0x21,

   372

	WC_SELECT_GAME = 0x22,

   373

	WC_TOOLBAR_MENU = 0x24,

   374

	WC_INCOME_GRAPH = 0x25,

   375

	WC_OPERATING_PROFIT = 0x26,

   376

	WC_TOOLTIPS = 0x27,

   377

	WC_INDUSTRY_VIEW = 0x28,

   378

	WC_PLAYER_FACE = 0x29,

   379

	WC_LAND_INFO = 0x2A,

   380

	WC_TOWN_AUTHORITY = 0x2B,

   381

	WC_SUBSIDIES_LIST = 0x2C,

   382

	WC_GRAPH_LEGEND = 0x2D,

   383

	WC_DELIVERED_CARGO = 0x2E,

   384

	WC_PERFORMANCE_HISTORY = 0x2F,

   385

	WC_COMPANY_VALUE = 0x30,

   386

	WC_COMPANY_LEAGUE = 0x31,

   387

	WC_BUY_COMPANY = 0x32,

   388

	WC_PAYMENT_RATES = 0x33,

   389

	WC_ENGINE_PREVIEW = 0x35,

   390

	WC_MUSIC_WINDOW = 0x36,

   391

	WC_MUSIC_TRACK_SELECTION = 0x37,

   392

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

   393

	WC_ASK_RESET_LANDSCAPE = 0x39,

   394

	WC_SCEN_TOWN_GEN = 0x3A,

   395

	WC_SCEN_INDUSTRY = 0x3B,

   396

	WC_SCEN_BUILD_ROAD = 0x3C,

   397

	WC_BUILD_TREES = 0x3D,

   398

	WC_SEND_NETWORK_MSG = 0x3E,

   399

	WC_DROPDOWN_MENU = 0x3F,

   400

	WC_BUILD_INDUSTRY = 0x40,

   401

	WC_GAME_OPTIONS = 0x41,

   402

	WC_NETWORK_WINDOW = 0x42,

   403

	WC_INDUSTRY_DIRECTORY = 0x43,

   404

	WC_MESSAGE_HISTORY = 0x44,

   405

	WC_CHEATS = 0x45,

   406

	WC_PERFORMANCE_DETAIL = 0x46,

   407

	WC_CONSOLE = 0x47,

   408

	WC_EXTRA_VIEW_PORT = 0x48,

   409

	WC_CLIENT_LIST = 0x49,

   410

	WC_NETWORK_STATUS_WINDOW = 0x4A,

   411

	WC_CUSTOM_CURRENCY = 0x4B,

   412

	WC_REPLACE_VEHICLE = 0x4C,

   413

	WC_HIGHSCORE = 0x4D,

   414

	WC_ENDSCREEN = 0x4E,

   415

	WC_SIGN_LIST = 0x4F,

   416

	WC_GENERATE_LANDSCAPE = 0x50,

   417

	WC_GENERATE_PROGRESS_WINDOW = 0x51,

   418

	WC_OK_CANCEL_QUERY = 0x52,

   419

};

   420

   421

   422

enum {

   423

	EXPENSES_CONSTRUCTION = 0,

   424

	EXPENSES_NEW_VEHICLES = 1,

   425

	EXPENSES_TRAIN_RUN = 2,

   426

	EXPENSES_ROADVEH_RUN = 3,

   427

	EXPENSES_AIRCRAFT_RUN = 4,

   428

	EXPENSES_SHIP_RUN = 5,

   429

	EXPENSES_PROPERTY = 6,

   430

	EXPENSES_TRAIN_INC = 7,

   431

	EXPENSES_ROADVEH_INC = 8,

   432

	EXPENSES_AIRCRAFT_INC = 9,

   433

	EXPENSES_SHIP_INC = 10,

   434

	EXPENSES_LOAN_INT = 11,

   435

	EXPENSES_OTHER = 12,

   436

};

   437

   438

// special string constants

   439

enum SpecialStrings {

   440

   441

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

   442

	SPECSTR_TOWNNAME_START = 0x20C0,

   443

	SPECSTR_TOWNNAME_ENGLISH = SPECSTR_TOWNNAME_START,

   444

	SPECSTR_TOWNNAME_FRENCH,

   445

	SPECSTR_TOWNNAME_GERMAN,

   446

	SPECSTR_TOWNNAME_AMERICAN,

   447

	SPECSTR_TOWNNAME_LATIN,

   448

	SPECSTR_TOWNNAME_SILLY,

   449

	SPECSTR_TOWNNAME_SWEDISH,

   450

	SPECSTR_TOWNNAME_DUTCH,

   451

	SPECSTR_TOWNNAME_FINNISH,

   452

	SPECSTR_TOWNNAME_POLISH,

   453

	SPECSTR_TOWNNAME_SLOVAKISH,

   454

	SPECSTR_TOWNNAME_NORWEGIAN,

   455

	SPECSTR_TOWNNAME_HUNGARIAN,

   456

	SPECSTR_TOWNNAME_AUSTRIAN,

   457

	SPECSTR_TOWNNAME_ROMANIAN,

   458

	SPECSTR_TOWNNAME_CZECH,

   459

	SPECSTR_TOWNNAME_SWISS,

   460

	SPECSTR_TOWNNAME_DANISH,

   461

	SPECSTR_TOWNNAME_TURKISH,

   462

	SPECSTR_TOWNNAME_ITALIAN,

   463

	SPECSTR_TOWNNAME_CATALAN,

   464

	SPECSTR_TOWNNAME_LAST = SPECSTR_TOWNNAME_CATALAN,

   465

   466

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

   467

	SPECSTR_PLAYERNAME_START = 0x70EA,

   468

	SPECSTR_PLAYERNAME_ENGLISH = SPECSTR_PLAYERNAME_START,

   469

	SPECSTR_PLAYERNAME_FRENCH,

   470

	SPECSTR_PLAYERNAME_GERMAN,

   471

	SPECSTR_PLAYERNAME_AMERICAN,

   472

	SPECSTR_PLAYERNAME_LATIN,

   473

	SPECSTR_PLAYERNAME_SILLY,

   474

	SPECSTR_PLAYERNAME_LAST = SPECSTR_PLAYERNAME_SILLY,

   475

   476

	SPECSTR_ANDCO_NAME = 0x70E6,

   477

	SPECSTR_PRESIDENT_NAME = 0x70E7,

   478

	SPECSTR_SONGNAME = 0x70E8,

   479

   480

	// reserve 32 strings for the *.lng files

   481

	SPECSTR_LANGUAGE_START = 0x7100,

   482

	SPECSTR_LANGUAGE_END = 0x711f,

   483

   484

	// reserve 32 strings for various screen resolutions

   485

	SPECSTR_RESOLUTION_START = 0x7120,

   486

	SPECSTR_RESOLUTION_END = 0x713f,

   487

   488

	// reserve 32 strings for screenshot formats

   489

	SPECSTR_SCREENSHOT_START = 0x7140,

   490

	SPECSTR_SCREENSHOT_END = 0x715F,

   491

   492

	// Used to implement SetDParamStr

   493

	STR_SPEC_DYNSTRING = 0xF800,

   494

	STR_SPEC_USERSTRING = 0xF808,

   495

};

   496

   497

typedef void PlaceProc(TileIndex tile);

   498

   499

enum {

   500

	SORT_ASCENDING  = 0,

   501

	SORT_DESCENDING = 1,

   502

	SORT_BY_DATE    = 0,

   503

	SORT_BY_NAME    = 2

   504

};

   505

   506

VARDEF byte _savegame_sort_order;

   507

   508

#define INVALID_STRING_ID 0xFFFF

   509