1

/* $Id$ */

     2

     3

/** @file engine.h */

     4

     5

#ifndef ENGINE_H

     6

#define ENGINE_H

     7

     8

#include "oldpool.h"

     9

#include "rail.h"

    10

#include "sound.h"

    11

#include "vehicle.h"

    12

    13

enum RailVehicleTypes {

    14

	RAILVEH_SINGLEHEAD,  ///< indicates a "standalone" locomotive

    15

	RAILVEH_MULTIHEAD,   ///< indicates a combination of two locomotives

    16

	RAILVEH_WAGON,       ///< simple wagon, not motorized

    17

};

    18

    19

struct RailVehicleInfo {

    20

	byte image_index;

    21

	RailVehicleTypes railveh_type;

    22

	byte base_cost;

    23

	RailTypeByte railtype;

    24

	uint16 max_speed;

    25

	uint16 power;

    26

	uint16 weight;

    27

	byte running_cost_base;

    28

	byte running_cost_class;

    29

	byte engclass;         ///< 0: steam, 1: diesel, 2: electric

    30

	byte capacity;

    31

	CargoID cargo_type;

    32

	byte ai_rank;

    33

	uint16 pow_wag_power;

    34

	byte pow_wag_weight;

    35

	byte visual_effect; // NOTE: this is not 100% implemented yet, at the moment it is only used as a 'fallback' value

    36

	                    //       for when the 'powered wagon' callback fails. But it should really also determine what

    37

	                    //       kind of visual effect to generate for a vehicle (default, steam, diesel, electric).

    38

	                    //       Same goes for the callback result, which atm is only used to check if a wagon is powered.

    39

	byte shorten_factor;   ///< length on main map for this type is 8 - shorten_factor

    40

	byte tractive_effort; ///< Tractive effort coefficient

    41

	byte user_def_data;    ///< Property 0x25: "User-defined bit mask" Used only for (very few) NewGRF vehicles

    42

};

    43

    44

struct ShipVehicleInfo {

    45

	byte image_index;

    46

	byte base_cost;

    47

	uint16 max_speed;

    48

	CargoID cargo_type;

    49

	uint16 capacity;

    50

	byte running_cost;

    51

	SoundFxByte sfx;

    52

	bool refittable;

    53

};

    54

    55

/* AircraftVehicleInfo subtypes, bitmask type.

    56

 * If bit 0 is 0 then it is a helicopter, otherwise it is a plane

    57

 * in which case bit 1 tells us whether it's a big(fast) plane or not */

    58

enum {

    59

	AIR_HELI = 0,

    60

	AIR_CTOL = 1, ///< Conventional Take Off and Landing, i.e. planes

    61

	AIR_FAST = 2

    62

};

    63

    64

struct AircraftVehicleInfo {

    65

	byte image_index;

    66

	byte base_cost;

    67

	byte running_cost;

    68

	byte subtype;

    69

	SoundFxByte sfx;

    70

	byte acceleration;

    71

	uint16 max_speed;

    72

	byte mail_capacity;

    73

	uint16 passenger_capacity;

    74

};

    75

    76

struct RoadVehicleInfo {

    77

	byte image_index;

    78

	byte base_cost;

    79

	byte running_cost;

    80

	SoundFxByte sfx;

    81

	byte max_speed;

    82

	byte capacity;

    83

	CargoID cargo_type;

    84

};

    85

    86

/** Information about a vehicle

    87

 *  @see table/engines.h

    88

 */

    89

struct EngineInfo {

    90

	Date base_intro;

    91

	Year lifelength;

    92

	Year base_life;

    93

	byte unk2;         ///< flag for carriage(bit 7) and decay speed(bits0..6)

    94

	byte load_amount;

    95

	byte climates;

    96

	uint32 refit_mask;

    97

	byte refit_cost;

    98

	byte misc_flags;

    99

	byte callbackmask;

   100

};

   101

   102

struct Engine {

   103

	Date intro_date;

   104

	Date age;

   105

	uint16 reliability;

   106

	uint16 reliability_spd_dec;

   107

	uint16 reliability_start, reliability_max, reliability_final;

   108

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

   109

	byte lifelength;

   110

	byte flags;

   111

	PlayerByte preview_player;

   112

	byte preview_wait;

   113

	byte player_avail;

   114

	byte type; ///< type, ie VEH_ROAD, VEH_TRAIN, etc. Same as in vehicle.h

   115

};

   116

   117

/**

   118

 * EngineInfo.misc_flags is a bitmask, with the following values

   119

 */

   120

enum {

   121

	EF_RAIL_TILTS = 0, ///< Rail vehicle tilts in curves (unsupported)

   122

	EF_ROAD_TRAM  = 0, ///< Road vehicle is a tram/light rail vehicle (unsup)

   123

	EF_USES_2CC   = 1, ///< Vehicle uses two company colours

   124

	EF_RAIL_IS_MU = 2, ///< Rail vehicle is a multiple-unit (DMU/EMU)

   125

};

   126

   127

/**

   128

 * Engine.flags is a bitmask, with the following values.

   129

 */

   130

enum {

   131

	ENGINE_AVAILABLE         = 1, ///< This vehicle is available to everyone.

   132

	ENGINE_EXCLUSIVE_PREVIEW = 2, ///< This vehicle is in the exclusive preview stage, either being used or being offered to a player.

   133

	ENGINE_OFFER_WINDOW_OPEN = 4, ///< The exclusive offer window is currently open for a player.

   134

};

   135

   136

enum {

   137

	NUM_VEHICLE_TYPES = 6

   138

};

   139

   140

static const EngineID INVALID_ENGINE = 0xFFFF;

   141

   142

   143

void AddTypeToEngines();

   144

void StartupEngines();

   145

   146

   147

void DrawTrainEngine(int x, int y, EngineID engine, SpriteID pal);

   148

void DrawRoadVehEngine(int x, int y, EngineID engine, SpriteID pal);

   149

void DrawShipEngine(int x, int y, EngineID engine, SpriteID pal);

   150

void DrawAircraftEngine(int x, int y, EngineID engine, SpriteID pal);

   151

   152

void LoadCustomEngineNames();

   153

void DeleteCustomEngineNames();

   154

   155

bool IsEngineBuildable(EngineID engine, byte type, PlayerID player);

   156

CargoID GetEngineCargoType(EngineID engine);

   157

   158

enum {

   159

	NUM_NORMAL_RAIL_ENGINES = 54,

   160

	NUM_MONORAIL_ENGINES    = 30,

   161

	NUM_MAGLEV_ENGINES      = 32,

   162

	NUM_TRAIN_ENGINES       = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   163

	NUM_ROAD_ENGINES        = 88,

   164

	NUM_SHIP_ENGINES        = 11,

   165

	NUM_AIRCRAFT_ENGINES    = 41,

   166

	TOTAL_NUM_ENGINES       = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   167

	AIRCRAFT_ENGINES_INDEX  = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   168

	SHIP_ENGINES_INDEX      = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   169

	ROAD_ENGINES_INDEX      = NUM_TRAIN_ENGINES,

   170

};

   171

   172

static inline EngineID GetFirstEngineOfType(byte type)

   173

{

   174

	const EngineID start[] = {0, ROAD_ENGINES_INDEX, SHIP_ENGINES_INDEX, AIRCRAFT_ENGINES_INDEX};

   175

   176

	return start[type];

   177

}

   178

   179

static inline EngineID GetLastEngineOfType(byte type)

   180

{

   181

	const EngineID end[] = {

   182

		NUM_TRAIN_ENGINES,

   183

		ROAD_ENGINES_INDEX + NUM_ROAD_ENGINES,

   184

		SHIP_ENGINES_INDEX + NUM_SHIP_ENGINES,

   185

		AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES};

   186

   187

	return end[type];

   188

}

   189

   190

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   191

#define FOR_ALL_ENGINES(e) for (e = _engines; e != endof(_engines); e++)

   192

#define FOR_ALL_ENGINEIDS_OF_TYPE(e, type) for (e = GetFirstEngineOfType(type); e != GetLastEngineOfType(type); e++)

   193

   194

   195

static inline Engine* GetEngine(EngineID i)

   196

{

   197

	assert(i < lengthof(_engines));

   198

	return &_engines[i];

   199

}

   200

   201

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   202

   203

static inline bool IsEngineIndex(uint index)

   204

{

   205

	return index < TOTAL_NUM_ENGINES;

   206

}

   207

   208

/* Access Vehicle Data */

   209

//#include "table/engines.h"

   210

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   211

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   212

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   213

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   214

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   215

   216

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   217

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   218

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   219

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   220

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   221

   222

static inline const EngineInfo *EngInfo(EngineID e)

   223

{

   224

	assert(e < lengthof(_engine_info));

   225

	return &_engine_info[e];

   226

}

   227

   228

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   229

{

   230

	assert(e < lengthof(_rail_vehicle_info));

   231

	return &_rail_vehicle_info[e];

   232

}

   233

   234

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   235

{

   236

	assert(e >= SHIP_ENGINES_INDEX && e < SHIP_ENGINES_INDEX + lengthof(_ship_vehicle_info));

   237

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   238

}

   239

   240

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   241

{

   242

	assert(e >= AIRCRAFT_ENGINES_INDEX && e < AIRCRAFT_ENGINES_INDEX + lengthof(_aircraft_vehicle_info));

   243

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   244

}

   245

   246

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   247

{

   248

	assert(e >= ROAD_ENGINES_INDEX && e < ROAD_ENGINES_INDEX + lengthof(_road_vehicle_info));

   249

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   250

}

   251

   252

/************************************************************************

   253

 * Engine Replacement stuff

   254

 ************************************************************************/

   255

   256

/**

   257

 * Struct to store engine replacements. DO NOT USE outside of engine.c. Is

   258

 * placed here so the only exception to this rule, the saveload code, can use

   259

 * it.

   260

 */

   261

struct EngineRenew {

   262

	EngineRenewID index;

   263

	EngineID from;

   264

	EngineID to;

   265

	EngineRenew *next;

   266

};

   267

   268

/**

   269

 * Memory pool for engine renew elements. DO NOT USE outside of engine.c. Is

   270

 * placed here so the only exception to this rule, the saveload code, can use

   271

 * it.

   272

 */

   273

DECLARE_OLD_POOL(EngineRenew, EngineRenew, 3, 8000)

   274

   275

/**

   276

 * Check if a EngineRenew really exists.

   277

 */

   278

static inline bool IsValidEngineRenew(const EngineRenew *er)

   279

{

   280

	return er->from != INVALID_ENGINE;

   281

}

   282

   283

static inline void DeleteEngineRenew(EngineRenew *er)

   284

{

   285

	er->from = INVALID_ENGINE;

   286

}

   287

   288

#define FOR_ALL_ENGINE_RENEWS_FROM(er, start) for (er = GetEngineRenew(start); er != NULL; er = (er->index + 1U < GetEngineRenewPoolSize()) ? GetEngineRenew(er->index + 1U) : NULL) if (er->from != INVALID_ENGINE) if (IsValidEngineRenew(er))

   289

#define FOR_ALL_ENGINE_RENEWS(er) FOR_ALL_ENGINE_RENEWS_FROM(er, 0)

   290

   291

   292

/**

   293

 * A list to group EngineRenew directives together (such as per-player).

   294

 */

   295

typedef EngineRenew* EngineRenewList;

   296

   297

/**

   298

 * Remove all engine replacement settings for the player.

   299

 * @param  erl The renewlist for a given player.

   300

 * @return The new renewlist for the player.

   301

 */

   302

void RemoveAllEngineReplacement(EngineRenewList* erl);

   303

   304

/**

   305

 * Retrieve the engine replacement in a given renewlist for an original engine type.

   306

 * @param  erl The renewlist to search in.

   307

 * @param  engine Engine type to be replaced.

   308

 * @return The engine type to replace with, or INVALID_ENGINE if no

   309

 * replacement is in the list.

   310

 */

   311

EngineID EngineReplacement(EngineRenewList erl, EngineID engine);

   312

   313

/**

   314

 * Add an engine replacement to the given renewlist.

   315

 * @param erl The renewlist to add to.

   316

 * @param old_engine The original engine type.

   317

 * @param new_engine The replacement engine type.

   318

 * @param flags The calling command flags.

   319

 * @return 0 on success, CMD_ERROR on failure.

   320

 */

   321

int32 AddEngineReplacement(EngineRenewList* erl, EngineID old_engine, EngineID new_engine, uint32 flags);

   322

   323

/**

   324

 * Remove an engine replacement from a given renewlist.

   325

 * @param erl The renewlist from which to remove the replacement

   326

 * @param engine The original engine type.

   327

 * @param flags The calling command flags.

   328

 * @return 0 on success, CMD_ERROR on failure.

   329

 */

   330

int32 RemoveEngineReplacement(EngineRenewList* erl, EngineID engine, uint32 flags);

   331

   332

/** When an engine is made buildable or is removed from being buildable, add/remove it from the build/autoreplace lists

   333

 * @param type The type of engine

   334

 */

   335

void AddRemoveEngineFromAutoreplaceAndBuildWindows(byte type);

   336

   337

/* Engine list manipulators - current implementation is only C wrapper of CBlobT<EngineID> class (helpers.cpp) */

   338

void EngList_Create(EngineList *el);            ///< Creates engine list

   339

void EngList_Destroy(EngineList *el);           ///< Deallocate and destroy engine list

   340

uint EngList_Count(const EngineList *el);       ///< Returns number of items in the engine list

   341

void EngList_Add(EngineList *el, EngineID eid); ///< Append one item at the end of engine list

   342

EngineID* EngList_Items(EngineList *el);        ///< Returns engine list items as C array

   343

void EngList_RemoveAll(EngineList *el);         ///< Removes all items from engine list

   344

typedef int CDECL EngList_SortTypeFunction(const void*, const void*); ///< argument type for EngList_Sort()

   345

void EngList_Sort(EngineList *el, EngList_SortTypeFunction compare); ///< qsort of the engine list

   346

void EngList_SortPartial(EngineList *el, EngList_SortTypeFunction compare, uint begin, uint num_items); ///< qsort of specified portion of the engine list

   347

   348

#endif /* ENGINE_H */