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

#define INVALID_STRING_ID 0xFFFF

    56

    57

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

    58

    59

/* IDs used in Pools */

    60

typedef uint16 VehicleID;

    61

typedef uint16 StationID;

    62

typedef uint16 RoadStopID;

    63

typedef uint16 TownID;

    64

typedef uint16 IndustryID;

    65

typedef uint16 DepotID;

    66

typedef uint16 WaypointID;

    67

typedef uint16 OrderID;

    68

typedef uint16 SignID;

    69

typedef uint16 GroupID;

    70

typedef uint16 EngineRenewID;

    71

typedef uint16 DestinationID;

    73

    74

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

    75

 * be any of them

    76

 */

    77

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

    78

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

    79

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

    80

    81

typedef int32 WindowNumber;

    82

    83

enum {

    84

	INVALID_YEAR = -1,

    85

	INVALID_DATE = -1,

    86

};

    87

    88

typedef int32 Year;

    89

typedef int32 Date;

    90

    91

    92

enum SwitchModes {

    93

	SM_NONE            =  0,

    94

	SM_NEWGAME         =  1,

    95

	SM_EDITOR          =  2,

    96

	SM_LOAD            =  3,

    97

	SM_MENU            =  4,

    98

	SM_SAVE            =  5,

    99

	SM_GENRANDLAND     =  6,

   100

	SM_LOAD_SCENARIO   =  9,

   101

	SM_START_SCENARIO  = 10,

   102

	SM_START_HEIGHTMAP = 11,

   103

	SM_LOAD_HEIGHTMAP  = 12,

   104

};

   105

   106

   107

/* Modes for GenerateWorld */

   108

enum GenerateWorldModes {

   109

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

   110

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

   111

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

   112

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

   113

};

   114

   115

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

   116

enum InitializeGameModes {

   117

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

   118

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

   119

};

   120

   121

enum Owner {

   122

	PLAYER_INACTIVE_CLIENT = 253,

   123

	PLAYER_NEW_COMPANY = 254,

   124

	PLAYER_SPECTATOR = 255,

   125

	OWNER_BEGIN     = 0x00,

   126

	PLAYER_FIRST    = 0x00,

   127

	MAX_PLAYERS     = 8,

   128

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

   129

	OWNER_NONE      = 0x10, // nobody owns the tile

   130

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

   131

	OWNER_END       = 0x12,

   132

	INVALID_OWNER   = 0xFF,

   133

	INVALID_PLAYER  = 0xFF,

   134

	/* Player identifiers All players below MAX_PLAYERS are playable

   135

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

   136

};

   137

   138

typedef Owner PlayerID;

   139

   140

DECLARE_POSTFIX_INCREMENT(Owner);

   141

   142

/** Define basic enum properties */

   143

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

   144

typedef TinyEnumT<Owner> OwnerByte;

   145

typedef OwnerByte PlayerByte;

   146

   147

   148

enum TransportType {

   149

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

   150

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

   151

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

   152

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

   153

	 * the values for road and rail.

   154

	 */

   155

	TRANSPORT_BEGIN = 0,

   156

	TRANSPORT_RAIL = 0,

   157

	TRANSPORT_ROAD = 1,

   158

	TRANSPORT_WATER, // = 2

   159

	TRANSPORT_END,

   160

	INVALID_TRANSPORT = 0xff,

   161

};

   162

   163

/** Define basic enum properties */

   164

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

   165

typedef TinyEnumT<TransportType> TransportTypeByte;

   166

   167

   168

struct TileInfo {

   169

	uint x;

   170

	uint y;

   171

	Slope tileh;

   172

	TileIndex tile;

   173

	uint z;

   174

};

   175

   176

   177

/* Display Options */

   178

enum {

   179

	DO_SHOW_TOWN_NAMES    = 0,

   180

	DO_SHOW_STATION_NAMES = 1,

   181

	DO_SHOW_SIGNS         = 2,

   182

	DO_FULL_ANIMATION     = 3,

   183

	DO_FULL_DETAIL        = 5,

   184

	DO_WAYPOINTS          = 6,

   185

};

   186

   187

enum {

   188

	TO_SIGNS,

   189

	TO_TREES,

   190

	TO_HOUSES,

   191

	TO_INDUSTRIES,

   192

	TO_BUILDINGS,

   193

	TO_BRIDGES,

   194

	TO_STRUCTURES,

   195

};

   196

   197

/* Landscape types */

   198

enum {

   199

	LT_TEMPERATE  = 0,

   200

	LT_ARCTIC     = 1,

   201

	LT_TROPIC     = 2,

   202

	LT_TOYLAND    = 3,

   203

   204

	NUM_LANDSCAPE = 4,

   205

};

   206

   207

/**

   208

 * Town Layouts

   209

 */

   210

enum TownLayout {

   211

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

   212

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

   213

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

   214

	TL_2X2_GRID,         ///< Geometric 2x2 grid algorithm

   215

	TL_3X3_GRID,         ///< Geometric 3x3 grid algorithm

   216

   217

	NUM_TLS,             ///< Number of town layouts

   218

};

   219

   220

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

   221

/** Define basic enum properties */

   222

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

   223

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

   224

   225

enum {

   226

	NUM_PRICES = 49,

   227

};

   228

   229

struct Prices {

   277

};

   278

   279

#define GAME_DIFFICULTY_NUM 18

   280

   281

struct GameDifficulty {

   282

	int max_no_competitors;

   283

	int competitor_start_time;

   284

	int number_towns;

   285

	int number_industries;

   286

	int max_loan;

   287

	int initial_interest;

   288

	int vehicle_costs;

   289

	int competitor_speed;

   290

	int competitor_intelligence; // no longer in use

   291

	int vehicle_breakdowns;

   292

	int subsidy_multiplier;

   293

	int construction_cost;

   294

	int terrain_type;

   295

	int quantity_sea_lakes;

   296

	int economy;

   297

	int line_reverse_mode;

   298

	int disasters;

   299

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

   300

};

   301

   302

enum {

   303

	// Temperate

   304

	CT_PASSENGERS   =  0,

   305

	CT_COAL         =  1,

   306

	CT_MAIL         =  2,

   307

	CT_OIL          =  3,

   308

	CT_LIVESTOCK    =  4,

   309

	CT_GOODS        =  5,

   310

	CT_GRAIN        =  6,

   311

	CT_WOOD         =  7,

   312

	CT_IRON_ORE     =  8,

   313

	CT_STEEL        =  9,

   314

	CT_VALUABLES    = 10,

   315

   316

	// Arctic

   317

	CT_WHEAT        =  6,

   318

	CT_HILLY_UNUSED =  8,

   319

	CT_PAPER        =  9,

   320

	CT_GOLD         = 10,

   321

	CT_FOOD         = 11,

   322

   323

	// Tropic

   324

	CT_RUBBER       =  1,

   325

	CT_FRUIT        =  4,

   326

	CT_MAIZE        =  6,

   327

	CT_COPPER_ORE   =  8,

   328

	CT_WATER        =  9,

   329

	CT_DIAMONDS     = 10,

   330

   331

	// Toyland

   332

	CT_SUGAR        =  1,

   333

	CT_TOYS         =  3,

   334

	CT_BATTERIES    =  4,

   335

	CT_CANDY        =  5,

   336

	CT_TOFFEE       =  6,

   337

	CT_COLA         =  7,

   338

	CT_COTTON_CANDY =  8,

   339

	CT_BUBBLES      =  9,

   340

	CT_PLASTIC      = 10,

   341

	CT_FIZZY_DRINKS = 11,

   342

   343

	NUM_CARGO       = 32,

   344

   345

	CT_NO_REFIT     = 0xFE,

   346

	CT_INVALID      = 0xFF

   347

};

   348

   349

typedef uint AcceptedCargo[NUM_CARGO];

   350

   351

struct TileDesc {

   352

	StringID str;

   353

	Owner owner;

   354

	Date build_date;

   355

	uint32 dparam[2];

   356

};

   357

   358

struct ViewportSign {

   359

	int32 left;

   360

	int32 top;

   361

	byte width_1, width_2;

   362

};

   363

   364

/**

   365

 * Common return value for all commands. Wraps the cost and

   366

 * a possible error message/state together.

   367

 */

   368

class CommandCost {

   370

	StringID message; ///< Warning message for when success is unset

   371

	bool success;     ///< Whether the comment went fine up to this moment

   372

   373

public:

   374

	/**

   375

	 * Creates a command cost return with no cost and no error

   376

	 */

   377

	CommandCost() : cost(0), message(INVALID_STRING_ID), success(true) {}

   378

   379

	/**

   380

	 * Creates a command return value the is failed with the given message

   381

	 */

   382

	CommandCost(StringID msg) : cost(0), message(msg), success(false) {}

   383

   384

	/**

   385

	 * Creates a command return value with the given start cost

   386

	 * @param cst the initial cost of this command

   387

	 */

   389

	/** "Hack" to make everything compile nicely, not needed when cost is int64 */

   390

	CommandCost(uint cst) : cost(cst), message(INVALID_STRING_ID), success(true) {}

   391

   392

	/**

   393

	 * Adds the cost of the given command return value to this cost.

   394

	 * Also takes a possible error message when it is set.

   395

	 * @param ret the command to add the cost of.

   396

	 * @return this class.

   397

	 */

   398

	CommandCost AddCost(CommandCost ret);

   399

   400

	/**

   401

	 * Adds the given cost to the cost of the command.

   402

	 * @param cost the cost to add

   403

	 * @return this class.

   404

	 */

   406

   407

	/**

   408

	 * Multiplies the cost of the command by the given factor.

   409

	 * @param cost factor to multiply the costs with

   410

	 * @return this class

   411

	 */

   412

	CommandCost MultiplyCost(int factor);

   413

   414

	/**

   415

	 * The costs as made up to this moment

   416

	 * @return the costs

   417

	 */

   419

   420

	/**

   421

	 * Sets the global error message *if* this class has one.

   422

	 */

   423

	void SetGlobalErrorMessage() const;

   424

   425

	/**

   426

	 * Did this command succeed?

   427

	 * @return true if and only if it succeeded

   428

	 */

   429

	bool Succeeded() const;

   430

   431

	/**

   432

	 * Did this command fail?

   433

	 * @return true if and only if it failed

   434

	 */

   435

	bool Failed() const;

   436

};

   437

   438

   439

typedef void DrawTileProc(TileInfo *ti);

   440

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

   441

typedef CommandCost ClearTileProc(TileIndex tile, byte flags);

   442

typedef void GetAcceptedCargoProc(TileIndex tile, AcceptedCargo res);

   443

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

   444

/**

   445

 * GetTileTrackStatusProcs return a value that contains the possible tracks

   446

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

   447

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

   448

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

   449

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

   450

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

   451

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

   452

 *

   453

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

   454

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

   455

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

   456

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

   457

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

   458

 *

   459

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

   460

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

   461

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

   462

 * above.

   463

 * @param tile     the tile to get the track status from

   464

 * @param mode     the mode of transportation

   465

 * @param sub_mode used to differentiate between different kinds within the mode

   466

 * @return the above mentions track status information

   467

 */

   468

typedef uint32 GetTileTrackStatusProc(TileIndex tile, TransportType mode, uint sub_mode);

   469

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

   470

typedef void ClickTileProc(TileIndex tile);

   471

typedef void AnimateTileProc(TileIndex tile);

   472

typedef void TileLoopProc(TileIndex tile);

   473

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

   474

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

   475

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

   476

typedef Slope GetSlopeTilehProc(TileIndex, Slope tileh);

   477

   478

struct TileTypeProcs {

   479

	DrawTileProc *draw_tile_proc;

   480

	GetSlopeZProc *get_slope_z_proc;

   481

	ClearTileProc *clear_tile_proc;

   482

	GetAcceptedCargoProc *get_accepted_cargo_proc;

   483

	GetTileDescProc *get_tile_desc_proc;

   484

	GetTileTrackStatusProc *get_tile_track_status_proc;

   485

	ClickTileProc *click_tile_proc;

   486

	AnimateTileProc *animate_tile_proc;

   487

	TileLoopProc *tile_loop_proc;

   488

	ChangeTileOwnerProc *change_tile_owner_proc;

   489

	GetProducedCargoProc *get_produced_cargo_proc;

   490

	VehicleEnterTileProc *vehicle_enter_tile_proc;

   491

	GetSlopeTilehProc *get_slope_tileh_proc;