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

#include "hal.h"

    12

#include "helpers.hpp"

    13

    14

struct Oblong {

    15

	int x, y;

    16

	int width, height;

    17

};

    18

    19

struct BoundingRect {

    20

	int width;

    21

	int height;

    22

};

    23

    24

struct Pair {

    25

	int a;

    26

	int b;

    27

};

    28

    29

#include "map.h"

    30

#include "slope.h"

    31

    32

// Forward declarations of structs.

    33

struct Vehicle;

    34

struct Depot;

    35

struct Waypoint;

    36

struct Window;

    37

struct Station;

    38

struct ViewPort;

    39

struct Town;

    40

struct NewsItem;

    41

struct Industry;

    42

struct DrawPixelInfo;

    43

struct Group;

    44

typedef byte VehicleOrderID;  ///< The index of an order within its current vehicle (not pool related)

    45

typedef byte CargoID;

    46

typedef byte LandscapeID;

    47

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

    48

struct PalSpriteID {

    49

	SpriteID sprite;

    50

	SpriteID pal;

    51

};

    52

typedef uint16 EngineID;

    53

typedef uint16 UnitID;

    54

typedef uint16 StringID;

    55

typedef EngineID *EngineList; ///< engine list type placeholder acceptable for C code (see helpers.cpp)

    56

    57

/* IDs used in Pools */

    58

typedef uint16 VehicleID;

    59

typedef uint16 StationID;

    60

typedef uint16 RoadStopID;

    61

typedef uint16 TownID;

    62

typedef uint16 IndustryID;

    63

typedef uint16 DepotID;

    64

typedef uint16 WaypointID;

    65

typedef uint16 OrderID;

    66

typedef uint16 SignID;

    67

typedef uint16 GroupID;

    68

typedef uint16 EngineRenewID;

    69

typedef uint16 DestinationID;

    70

    71

/* DestinationID must be at least as large as every these below, because it can

    72

 * be any of them

    73

 */

    74

assert_compile(sizeof(DestinationID) == sizeof(DepotID));

    75

assert_compile(sizeof(DestinationID) == sizeof(WaypointID));

    76

assert_compile(sizeof(DestinationID) == sizeof(StationID));

    77

    78

typedef int32 WindowNumber;

    79

    80

enum {

    81

	INVALID_YEAR = -1,

    82

	INVALID_DATE = -1,

    83

};

    84

    85

typedef int32 Year;

    86

typedef int32 Date;

    87

    88

    89

enum SwitchModes {

    90

	SM_NONE            =  0,

    91

	SM_NEWGAME         =  1,

    92

	SM_EDITOR          =  2,

    93

	SM_LOAD            =  3,

    94

	SM_MENU            =  4,

    95

	SM_SAVE            =  5,

    96

	SM_GENRANDLAND     =  6,

    97

	SM_LOAD_SCENARIO   =  9,

    98

	SM_START_SCENARIO  = 10,

    99

	SM_START_HEIGHTMAP = 11,

   100

	SM_LOAD_HEIGHTMAP  = 12,

   101

};

   102

   103

   104

/* Modes for GenerateWorld */

   105

enum GenerateWorldModes {

   106

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

   107

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

   108

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

   109

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

   110

};

   111

   112

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

   113

enum InitializeGameModes {

   114

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

   115

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

   116

};

   117

   118

enum Owner {

   119

	PLAYER_INACTIVE_CLIENT = 253,

   120

	PLAYER_NEW_COMPANY = 254,

   121

	PLAYER_SPECTATOR = 255,

   122

	OWNER_BEGIN     = 0x00,

   123

	PLAYER_FIRST    = 0x00,

   124

	MAX_PLAYERS     = 8,

   125

	OWNER_TOWN      = 0x0F, // a town owns the tile

   126

	OWNER_NONE      = 0x10, // nobody owns the tile

   127

	OWNER_WATER     = 0x11, // "water" owns the tile

   128

	OWNER_END       = 0x12,

   129

	INVALID_OWNER   = 0xFF,

   130

	INVALID_PLAYER  = 0xFF,

   131

	/* Player identifiers All players below MAX_PLAYERS are playable

   132

	* players, above, they are special, computer controlled players */

   133

};

   134

   135

typedef Owner PlayerID;

   136

   137

DECLARE_POSTFIX_INCREMENT(Owner);

   138

   139

/** Define basic enum properties */

   140

template <> struct EnumPropsT<Owner> : MakeEnumPropsT<Owner, byte, OWNER_BEGIN, OWNER_END, INVALID_OWNER> {};

   141

typedef TinyEnumT<Owner> OwnerByte;

   142

typedef OwnerByte PlayerByte;

   143

   144

   145

enum TransportType {

   146

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

   147

	 * and tunnels, so they can be used by GetTileTrackStatus_TunnelBridge.

   148

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

   149

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

   150

	 * the values for road and rail.

   151

	 */

   152

	TRANSPORT_BEGIN = 0,

   153

	TRANSPORT_RAIL = 0,

   154

	TRANSPORT_ROAD = 1,

   155

	TRANSPORT_WATER, // = 2

   156

	TRANSPORT_END,

   157

	INVALID_TRANSPORT = 0xff,

   158

};

   159

   160

/** Define basic enum properties */

   161

template <> struct EnumPropsT<TransportType> : MakeEnumPropsT<TransportType, byte, TRANSPORT_BEGIN, TRANSPORT_END, INVALID_TRANSPORT> {};

   162

typedef TinyEnumT<TransportType> TransportTypeByte;

   163

   164

   165

struct TileInfo {

   166

	uint x;

   167

	uint y;

   168

	Slope tileh;

   169

	TileIndex tile;

   170

	uint z;

   171

};

   172

   173

   174

/* Display Options */

   175

enum {

   176

	DO_SHOW_TOWN_NAMES    = 0,

   177

	DO_SHOW_STATION_NAMES = 1,

   178

	DO_SHOW_SIGNS         = 2,

   179

	DO_FULL_ANIMATION     = 3,

   180

	DO_FULL_DETAIL        = 5,

   181

	DO_WAYPOINTS          = 6,

   182

};

   183

   184

enum {

   185

	TO_SIGNS,

   186

	TO_TREES,

   187

	TO_HOUSES,

   188

	TO_INDUSTRIES,

   189

	TO_BUILDINGS,

   190

	TO_BRIDGES,

   191

	TO_STRUCTURES,

   192

};

   193

   194

/* Landscape types */

   195

enum {

   196

	LT_TEMPERATE  = 0,

   197

	LT_ARCTIC     = 1,

   198

	LT_TROPIC     = 2,

   199

	LT_TOYLAND    = 3,

   200

   201

	NUM_LANDSCAPE = 4,

   202

};

   203

   204

#define GAME_DIFFICULTY_NUM 20

   205

/**

   206

 * Town Layouts

   207

 */

   208

enum TownLayout {

   209

	TL_NO_ROADS     = 0, ///< Build no more roads, but still build houses

   210

	TL_ORIGINAL,         ///< Original algorithm (min. 1 distance between roads)

   211

	TL_BETTER_ROADS,     ///< Extended original algorithm (min. 2 distance between roads)

   212

	TL_2X2_GRID,         ///< Geometric 2x2 grid algorithm

   213

	TL_3X3_GRID,         ///< Geometric 3x3 grid algorithm

   214

   215

	NUM_TLS,             ///< Number of town layouts

   216

};

   217

   218

/* It needs to be 8bits, because we save and load it as such */

   219

/** Define basic enum properties */

   220

template <> struct EnumPropsT<TownLayout> : MakeEnumPropsT<TownLayout, byte, TL_NO_ROADS, NUM_TLS, NUM_TLS> {};

   221

typedef TinyEnumT<TownLayout> TownLayoutByte; //typedefing-enumification of TownLayout

   222

   223

struct GameDifficulty {

   224

	int max_no_competitors;

   225

	int competitor_start_time;

   226

	int number_towns;

   227

	int number_industries;

   228

	int max_loan;

   229

	int initial_interest;

   230

	int vehicle_costs;

   231

	int competitor_speed;

   232

	int competitor_intelligence; // no longer in use

   233

	int vehicle_breakdowns;

   234

	int subsidy_multiplier;

   235

	int construction_cost;

   236

	int terrain_type;

   237

	int quantity_sea_lakes;

   238

	int economy;

   239

	int line_reverse_mode;

   240

	int disasters;

   241

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

   242

	int economic_growth;

   243

	int economic_model;

   244

};

   245

   246

enum {

   247

	// Temperate

   248

	CT_PASSENGERS   =  0,

   249

	CT_COAL         =  1,

   250

	CT_MAIL         =  2,

   251

	CT_OIL          =  3,

   252

	CT_LIVESTOCK    =  4,

   253

	CT_GOODS        =  5,

   254

	CT_GRAIN        =  6,

   255

	CT_WOOD         =  7,

   256

	CT_IRON_ORE     =  8,

   257

	CT_STEEL        =  9,

   258

	CT_VALUABLES    = 10,

   259

   260

	// Arctic

   261

	CT_WHEAT        =  6,

   262

	CT_HILLY_UNUSED =  8,

   263

	CT_PAPER        =  9,

   264

	CT_GOLD         = 10,

   265

	CT_FOOD         = 11,

   266

   267

	// Tropic

   268

	CT_RUBBER       =  1,

   269

	CT_FRUIT        =  4,

   270

	CT_MAIZE        =  6,

   271

	CT_COPPER_ORE   =  8,

   272

	CT_WATER        =  9,

   273

	CT_DIAMONDS     = 10,

   274

   275

	// Toyland

   276

	CT_SUGAR        =  1,

   277

	CT_TOYS         =  3,

   278

	CT_BATTERIES    =  4,

   279

	CT_CANDY        =  5,

   280

	CT_TOFFEE       =  6,

   281

	CT_COLA         =  7,

   282

	CT_COTTON_CANDY =  8,

   283

	CT_BUBBLES      =  9,

   284

	CT_PLASTIC      = 10,

   285

	CT_FIZZY_DRINKS = 11,

   286

   287

	NUM_CARGO       = 32,

   288

   289

	CT_NO_REFIT     = 0xFE,

   290

	CT_INVALID      = 0xFF

   291

};

   292

   293

typedef uint AcceptedCargo[NUM_CARGO];

   294

   295

struct TileDesc {

   296

	StringID str;

   297

	Owner owner;

   298

	Date build_date;

   299

	uint32 dparam[2];

   300

};

   301

   302

struct ViewportSign {

   303

	int32 left;

   304

	int32 top;

   305

	byte width_1, width_2;

   306

};

   307

   308

   309

typedef void DrawTileProc(TileInfo *ti);

   310

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

   311

typedef int32 ClearTileProc(TileIndex tile, byte flags);

   312

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

   313

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

   316

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

   317

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

   318

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

   319

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

   320

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

   321

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

   322

 *

   323

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

   324

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

   325

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

   326

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

   327

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

   328

 *

   329

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

   330

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

   331

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

   332

 * above.

   337

 */

   339

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

   340

typedef void ClickTileProc(TileIndex tile);

   341

typedef void AnimateTileProc(TileIndex tile);

   342

typedef void TileLoopProc(TileIndex tile);

   343

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

   344

/** @see VehicleEnterTileStatus to see what the return values mean */

   345

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

   346

typedef Slope GetSlopeTilehProc(TileIndex, Slope tileh);

   347

   348

struct TileTypeProcs {

   349

	DrawTileProc *draw_tile_proc;

   350

	GetSlopeZProc *get_slope_z_proc;

   351

	ClearTileProc *clear_tile_proc;

   352

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   353

	GetTileDescProc *get_tile_desc_proc;

   354

	GetTileTrackStatusProc *get_tile_track_status_proc;

   355

	ClickTileProc *click_tile_proc;

   356

	AnimateTileProc *animate_tile_proc;

   357

	TileLoopProc *tile_loop_proc;

   358

	ChangeTileOwnerProc *change_tile_owner_proc;

   359

	GetProducedCargoProc *get_produced_cargo_proc;

   360

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   361

	GetSlopeTilehProc *get_slope_tileh_proc;

   362

};

   363

   364

   365

enum WindowClass {

   366

	WC_NONE,

   367

	WC_MAIN_WINDOW = WC_NONE,

   368

	WC_MAIN_TOOLBAR,

   369

	WC_STATUS_BAR,

   370

	WC_BUILD_TOOLBAR,

   371

	WC_NEWS_WINDOW,

   372

	WC_TOWN_DIRECTORY,

   373

	WC_STATION_LIST,

   374

	WC_TOWN_VIEW,

   375

	WC_SMALLMAP,

   376

	WC_TRAINS_LIST,

   377

	WC_ROADVEH_LIST,

   378

	WC_SHIPS_LIST,

   379

	WC_AIRCRAFT_LIST,

   380

	WC_VEHICLE_VIEW,

   381

	WC_VEHICLE_DETAILS,

   382

	WC_VEHICLE_REFIT,

   383

	WC_VEHICLE_ORDERS,

   384

	WC_STATION_VIEW,

   385

	WC_VEHICLE_DEPOT,

   386

	WC_BUILD_VEHICLE,

   387

	WC_BUILD_BRIDGE,

   388

	WC_ERRMSG,

   389

	WC_BUILD_STATION,

   390

	WC_BUS_STATION,

   391

	WC_TRUCK_STATION,

   392

	WC_BUILD_DEPOT,

   393

	WC_COMPANY,

   394

	WC_FINANCES,

   395

	WC_PLAYER_COLOR,

   396

	WC_QUERY_STRING,

   397

	WC_SAVELOAD,

   398

	WC_SELECT_GAME,

   399

	WC_TOOLBAR_MENU,

   400

	WC_INCOME_GRAPH,

   401

	WC_OPERATING_PROFIT,

   402

	WC_TOOLTIPS,

   403

	WC_INDUSTRY_VIEW,

   404

	WC_PLAYER_FACE,

   405

	WC_LAND_INFO,

   406

	WC_TOWN_AUTHORITY,

   407

	WC_SUBSIDIES_LIST,

   408

	WC_GRAPH_LEGEND,

   409

	WC_DELIVERED_CARGO,

   410

	WC_PERFORMANCE_HISTORY,

   411

	WC_COMPANY_VALUE,

   412

	WC_COMPANY_LEAGUE,

   413

	WC_BUY_COMPANY,

   414

	WC_PAYMENT_RATES,

   415

	WC_ENGINE_PREVIEW,

   416

	WC_MUSIC_WINDOW,

   417

	WC_MUSIC_TRACK_SELECTION,

   418

	WC_SCEN_LAND_GEN,

   419

	WC_SCEN_TOWN_GEN,

   420

	WC_SCEN_INDUSTRY,

   421

	WC_SCEN_BUILD_ROAD,

   422

	WC_BUILD_TREES,

   423

	WC_SEND_NETWORK_MSG,

   424

	WC_DROPDOWN_MENU,

   425

	WC_BUILD_INDUSTRY,

   426

	WC_GAME_OPTIONS,

   427

	WC_NETWORK_WINDOW,

   428

	WC_INDUSTRY_DIRECTORY,

   429

	WC_MESSAGE_HISTORY,

   430

	WC_CHEATS,

   431

	WC_PERFORMANCE_DETAIL,

   432

	WC_CONSOLE,

   433

	WC_EXTRA_VIEW_PORT,

   434

	WC_CLIENT_LIST,

   435

	WC_NETWORK_STATUS_WINDOW,

   436

	WC_CUSTOM_CURRENCY,

   437

	WC_REPLACE_VEHICLE,

   438

	WC_HIGHSCORE,

   439

	WC_ENDSCREEN,

   440

	WC_SIGN_LIST,

   441

	WC_GENERATE_LANDSCAPE,

   442

	WC_GENERATE_PROGRESS_WINDOW,

   443

	WC_CONFIRM_POPUP_QUERY,

   444

	WC_TRANSPARENCY_TOOLBAR,

   445

};

   446

   447

   448

enum ExpensesType {

   449

	EXPENSES_CONSTRUCTION =  0,

   450

	EXPENSES_NEW_VEHICLES =  1,

   451

	EXPENSES_TRAIN_RUN    =  2,

   452

	EXPENSES_ROADVEH_RUN  =  3,

   453

	EXPENSES_AIRCRAFT_RUN =  4,

   454

	EXPENSES_SHIP_RUN     =  5,

   455

	EXPENSES_PROPERTY     =  6,

   456

	EXPENSES_TRAIN_INC    =  7,

   457

	EXPENSES_ROADVEH_INC  =  8,

   458

	EXPENSES_AIRCRAFT_INC =  9,

   459

	EXPENSES_SHIP_INC     = 10,

   460

	EXPENSES_LOAN_INT     = 11,

   461

	EXPENSES_OTHER        = 12,

   462

};

   463

   464

enum {

   465

	MAX_LANG = 64,

   466

};

   467

   468

// special string constants

   469

enum SpecialStrings {

   470

   471

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

   472

	SPECSTR_TOWNNAME_START     = 0x20C0,

   473

	SPECSTR_TOWNNAME_ENGLISH   = SPECSTR_TOWNNAME_START,

   474

	SPECSTR_TOWNNAME_FRENCH,

   475

	SPECSTR_TOWNNAME_GERMAN,

   476

	SPECSTR_TOWNNAME_AMERICAN,

   477

	SPECSTR_TOWNNAME_LATIN,

   478

	SPECSTR_TOWNNAME_SILLY,

   479

	SPECSTR_TOWNNAME_SWEDISH,

   480

	SPECSTR_TOWNNAME_DUTCH,

   481

	SPECSTR_TOWNNAME_FINNISH,

   482

	SPECSTR_TOWNNAME_POLISH,

   483

	SPECSTR_TOWNNAME_SLOVAKISH,

   484

	SPECSTR_TOWNNAME_NORWEGIAN,

   485

	SPECSTR_TOWNNAME_HUNGARIAN,

   486

	SPECSTR_TOWNNAME_AUSTRIAN,

   487

	SPECSTR_TOWNNAME_ROMANIAN,

   488

	SPECSTR_TOWNNAME_CZECH,

   489

	SPECSTR_TOWNNAME_SWISS,

   490

	SPECSTR_TOWNNAME_DANISH,

   491

	SPECSTR_TOWNNAME_TURKISH,