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

enum EngineClass {

    20

	EC_STEAM,

    21

	EC_DIESEL,

    22

	EC_ELECTRIC,

    23

	EC_MONORAIL,

    24

	EC_MAGLEV,

    25

};

    26

    27

struct RailVehicleInfo {

    28

	byte image_index;

    29

	RailVehicleTypes railveh_type;

    30

	byte base_cost;

    31

	RailTypeByte railtype;

    32

	uint16 max_speed;

    33

	uint16 power;

    34

	uint16 weight;

    35

	byte running_cost_base;

    36

	byte running_cost_class;

    37

	EngineClass engclass;           ///< Class of engine for this vehicle

    38

	byte capacity;

    39

	CargoID cargo_type;

    40

	byte ai_rank;

    41

	uint16 pow_wag_power;

    42

	byte pow_wag_weight;

    43

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

    44

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

    45

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

    46

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

    47

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

    48

	byte tractive_effort; ///< Tractive effort coefficient

    49

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

    50

};

    51

    52

struct ShipVehicleInfo {

    53

	byte image_index;

    54

	byte base_cost;

    55

	uint16 max_speed;

    56

	CargoID cargo_type;

    57

	uint16 capacity;

    58

	byte running_cost;

    59

	SoundFxByte sfx;

    60

	bool refittable;

    61

};

    62

    63

/* AircraftVehicleInfo subtypes, bitmask type.

    64

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

    65

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

    66

enum {

    67

	AIR_HELI = 0,

    68

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

    69

	AIR_FAST = 2

    70

};

    71

    72

struct AircraftVehicleInfo {

    73

	byte image_index;

    74

	byte base_cost;

    75

	byte running_cost;

    76

	byte subtype;

    77

	SoundFxByte sfx;

    78

	byte acceleration;

    79

	uint16 max_speed;

    80

	byte mail_capacity;

    81

	uint16 passenger_capacity;

    82

};

    83

    84

struct RoadVehicleInfo {

    85

	byte image_index;

    86

	byte base_cost;

    87

	byte running_cost;

    88

	SoundFxByte sfx;

    89

	byte max_speed;

    90

	byte capacity;

    91

	CargoID cargo_type;

    92

};

    93

    94

/** Information about a vehicle

    95

 *  @see table/engines.h

    96

 */

    97

struct EngineInfo {

    98

	Date base_intro;

    99

	Year lifelength;

   100

	Year base_life;

   101

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

   102

	byte load_amount;

   103

	byte climates;

   104

	uint32 refit_mask;

   105

	byte refit_cost;

   106

	byte misc_flags;

   107

	byte callbackmask;

   109

};

   110

   111

struct Engine {

   112

	Date intro_date;

   113

	Date age;

   114

	uint16 reliability;

   115

	uint16 reliability_spd_dec;

   116

	uint16 reliability_start, reliability_max, reliability_final;

   117

	uint16 duration_phase_1, duration_phase_2, duration_phase_3;

   118

	byte lifelength;

   119

	byte flags;

   120

	PlayerByte preview_player;

   121

	byte preview_wait;

   122

	byte player_avail;

   123

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

   124

};

   125

   126

/**

   127

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

   128

 */

   129

enum {

   130

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

   131

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

   132

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

   133

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

   134

};

   135

   136

/**

   137

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

   138

 */

   139

enum {

   140

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

   141

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

   142

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

   143

};

   144

   145

enum {

   146

	NUM_VEHICLE_TYPES = 6

   147

};

   148

   149

static const EngineID INVALID_ENGINE = 0xFFFF;

   150

   151

   152

void AddTypeToEngines();

   153

void StartupEngines();

   154

   155

   156

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

   157

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

   158

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

   159

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

   160

   161

void LoadCustomEngineNames();

   162

void DeleteCustomEngineNames();

   163

   164

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

   165

CargoID GetEngineCargoType(EngineID engine);

   166

   167

enum {

   168

	NUM_NORMAL_RAIL_ENGINES = 54,

   169

	NUM_MONORAIL_ENGINES    = 30,

   170

	NUM_MAGLEV_ENGINES      = 32,

   171

	NUM_TRAIN_ENGINES       = NUM_NORMAL_RAIL_ENGINES + NUM_MONORAIL_ENGINES + NUM_MAGLEV_ENGINES,

   172

	NUM_ROAD_ENGINES        = 88,

   173

	NUM_SHIP_ENGINES        = 11,

   174

	NUM_AIRCRAFT_ENGINES    = 41,

   175

	TOTAL_NUM_ENGINES       = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES + NUM_AIRCRAFT_ENGINES,

   176

	AIRCRAFT_ENGINES_INDEX  = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES + NUM_SHIP_ENGINES,

   177

	SHIP_ENGINES_INDEX      = NUM_TRAIN_ENGINES + NUM_ROAD_ENGINES,

   178

	ROAD_ENGINES_INDEX      = NUM_TRAIN_ENGINES,

   179

};

   180

   181

static inline EngineID GetFirstEngineOfType(byte type)

   182

{

   183

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

   184

   185

	return start[type];

   186

}

   187

   188

static inline EngineID GetLastEngineOfType(byte type)

   189

{

   190

	const EngineID end[] = {

   191

		NUM_TRAIN_ENGINES,

   192

		ROAD_ENGINES_INDEX + NUM_ROAD_ENGINES,

   193

		SHIP_ENGINES_INDEX + NUM_SHIP_ENGINES,

   194

		AIRCRAFT_ENGINES_INDEX + NUM_AIRCRAFT_ENGINES};

   195

   196

	return end[type];

   197

}

   198

   199

VARDEF Engine _engines[TOTAL_NUM_ENGINES];

   200

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

   201

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

   202

   203

   204

static inline Engine* GetEngine(EngineID i)

   205

{

   206

	assert(i < lengthof(_engines));

   207

	return &_engines[i];

   208

}

   209

   210

VARDEF StringID _engine_name_strings[TOTAL_NUM_ENGINES];

   211

   212

static inline bool IsEngineIndex(uint index)

   213

{

   214

	return index < TOTAL_NUM_ENGINES;

   215

}

   216

   217

/* Access Vehicle Data */

   218

//#include "table/engines.h"

   219

extern const EngineInfo orig_engine_info[TOTAL_NUM_ENGINES];

   220

extern const RailVehicleInfo orig_rail_vehicle_info[NUM_TRAIN_ENGINES];

   221

extern const ShipVehicleInfo orig_ship_vehicle_info[NUM_SHIP_ENGINES];

   222

extern const AircraftVehicleInfo orig_aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   223

extern const RoadVehicleInfo orig_road_vehicle_info[NUM_ROAD_ENGINES];

   224

   225

extern EngineInfo _engine_info[TOTAL_NUM_ENGINES];

   226

extern RailVehicleInfo _rail_vehicle_info[NUM_TRAIN_ENGINES];

   227

extern ShipVehicleInfo _ship_vehicle_info[NUM_SHIP_ENGINES];

   228

extern AircraftVehicleInfo _aircraft_vehicle_info[NUM_AIRCRAFT_ENGINES];

   229

extern RoadVehicleInfo _road_vehicle_info[NUM_ROAD_ENGINES];

   230

   231

static inline const EngineInfo *EngInfo(EngineID e)

   232

{

   233

	assert(e < lengthof(_engine_info));

   234

	return &_engine_info[e];

   235

}

   236

   237

static inline const RailVehicleInfo* RailVehInfo(EngineID e)

   238

{

   239

	assert(e < lengthof(_rail_vehicle_info));

   240

	return &_rail_vehicle_info[e];

   241

}

   242

   243

static inline const ShipVehicleInfo* ShipVehInfo(EngineID e)

   244

{

   245

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

   246

	return &_ship_vehicle_info[e - SHIP_ENGINES_INDEX];

   247

}

   248

   249

static inline const AircraftVehicleInfo* AircraftVehInfo(EngineID e)

   250

{

   251

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

   252

	return &_aircraft_vehicle_info[e - AIRCRAFT_ENGINES_INDEX];

   253

}

   254

   255

static inline const RoadVehicleInfo* RoadVehInfo(EngineID e)

   256

{

   257

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

   258

	return &_road_vehicle_info[e - ROAD_ENGINES_INDEX];

   259

}

   260

   261

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

   262

 * Engine Replacement stuff

   263

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

   264

   265

/**

   266

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

   267

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

   268

 * it.

   269

 */

   270

struct EngineRenew {

   271

	EngineRenewID index;

   272

	EngineID from;

   273

	EngineID to;

   274

	EngineRenew *next;

   275

};

   276

   277

/**

   278

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

   279

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

   280

 * it.

   281

 */

   282

DECLARE_OLD_POOL(EngineRenew, EngineRenew, 3, 8000)

   283

   284

/**

   285

 * Check if a EngineRenew really exists.

   286

 */

   287

static inline bool IsValidEngineRenew(const EngineRenew *er)

   288

{

   289

	return er->from != INVALID_ENGINE;

   290

}

   291

   292

static inline void DeleteEngineRenew(EngineRenew *er)

   293

{

   294

	er->from = INVALID_ENGINE;

   295

}

   296

   297

#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))

   298

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

   299

   300

   301

/**

   302

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

   303

 */

   304

typedef EngineRenew* EngineRenewList;

   305

   306

/**

   307

 * Remove all engine replacement settings for the player.

   308

 * @param  erl The renewlist for a given player.

   309

 * @return The new renewlist for the player.

   310

 */

   311

void RemoveAllEngineReplacement(EngineRenewList* erl);

   312

   313

/**

   314

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

   315

 * @param  erl The renewlist to search in.

   316

 * @param  engine Engine type to be replaced.

   317

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

   318

 * replacement is in the list.

   319

 */

   320

EngineID EngineReplacement(EngineRenewList erl, EngineID engine);

   321

   322

/**

   323

 * Add an engine replacement to the given renewlist.

   324

 * @param erl The renewlist to add to.

   325

 * @param old_engine The original engine type.

   326

 * @param new_engine The replacement engine type.

   327

 * @param flags The calling command flags.

   328

 * @return 0 on success, CMD_ERROR on failure.

   329

 */

   330

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

   331

   332

/**

   333

 * Remove an engine replacement from a given renewlist.

   334

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

   335

 * @param engine The original engine type.

   336

 * @param flags The calling command flags.

   337

 * @return 0 on success, CMD_ERROR on failure.

   338

 */

   339

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

   340

   341

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

   342

 * @param type The type of engine

   343

 */

   344

void AddRemoveEngineFromAutoreplaceAndBuildWindows(byte type);

   345

   346

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

   347

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

   348

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

   349

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

   350

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

   351

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

   352

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

   353

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

   354

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

   355

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

   356

   357

#endif /* ENGINE_H */