1

/* $Id$ */

     2

     3

/** @vehicle.h */

     4

     5

#ifndef VEHICLE_H

     6

#define VEHICLE_H

     7

     8

#include "vehicle_type.h"

     9

#include "oldpool.h"

    10

#include "order.h"

    11

#include "track_type.h"

    12

#include "rail_type.h"

    13

#include "road_type.h"

    15

#include "window_type.h"

    16

#include "cargopacket.h"

    17

#include "texteff.hpp"

    19

    20

/** Road vehicle states */

    21

enum RoadVehicleStates {

    22

	/*

    23

	 * Lower 4 bits are used for vehicle track direction. (Trackdirs)

    24

	 * When in a road stop (bit 5 or bit 6 set) these bits give the

    25

	 * track direction of the entry to the road stop.

    26

	 * As the entry direction will always be a diagonal

    27

	 * direction (X_NE, Y_SE, X_SW or Y_NW) only bits 0 and 3

    28

	 * are needed to hold this direction. Bit 1 is then used to show

    29

	 * that the vehicle is using the second road stop bay.

    30

	 * Bit 2 is then used for drive-through stops to show the vehicle

    31

	 * is stopping at this road stop.

    32

	 */

    33

    34

	/* Numeric values */

    35

	RVSB_IN_DEPOT                = 0xFE,                      ///< The vehicle is in a depot

    36

	RVSB_WORMHOLE                = 0xFF,                      ///< The vehicle is in a tunnel and/or bridge

    37

    38

	/* Bit numbers */

    39

	RVS_USING_SECOND_BAY         =    1,                      ///< Only used while in a road stop

    40

	RVS_IS_STOPPING              =    2,                      ///< Only used for drive-through stops. Vehicle will stop here

    41

	RVS_DRIVE_SIDE               =    4,                      ///< Only used when retrieving move data

    42

	RVS_IN_ROAD_STOP             =    5,                      ///< The vehicle is in a road stop

    43

	RVS_IN_DT_ROAD_STOP          =    6,                      ///< The vehicle is in a drive-through road stop

    44

    45

	/* Bit sets of the above specified bits */

    46

	RVSB_IN_ROAD_STOP            = 1 << RVS_IN_ROAD_STOP,     ///< The vehicle is in a road stop

    47

	RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,

    48

	RVSB_IN_DT_ROAD_STOP         = 1 << RVS_IN_DT_ROAD_STOP,  ///< The vehicle is in a drive-through road stop

    49

	RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,

    50

    51

	RVSB_TRACKDIR_MASK           = 0x0F,                      ///< The mask used to extract track dirs

    52

	RVSB_ROAD_STOP_TRACKDIR_MASK = 0x09                       ///< Only bits 0 and 3 are used to encode the trackdir for road stops

    53

};

    54

    55

enum VehStatus {

    56

	VS_HIDDEN          = 0x01,

    57

	VS_STOPPED         = 0x02,

    58

	VS_UNCLICKABLE     = 0x04,

    59

	VS_DEFPAL          = 0x08,

    60

	VS_TRAIN_SLOWING   = 0x10,

    61

	VS_SHADOW          = 0x20,

    62

	VS_AIRCRAFT_BROKEN = 0x40,

    63

	VS_CRASHED         = 0x80,

    64

};

    65

    66

enum VehicleFlags {

    67

	VF_LOADING_FINISHED,

    68

	VF_CARGO_UNLOADING,

    69

	VF_BUILT_AS_PROTOTYPE,

    70

	VF_TIMETABLE_STARTED,  ///< Whether the vehicle has started running on the timetable yet.

    71

	VF_AUTOFILL_TIMETABLE, ///< Whether the vehicle should fill in the timetable automatically.

    72

};

    73

    74

/* Effect vehicle types */

    75

enum EffectVehicle {

    76

	EV_CHIMNEY_SMOKE   = 0,

    77

	EV_STEAM_SMOKE     = 1,

    78

	EV_DIESEL_SMOKE    = 2,

    79

	EV_ELECTRIC_SPARK  = 3,

    80

	EV_SMOKE           = 4,

    81

	EV_EXPLOSION_LARGE = 5,

    82

	EV_BREAKDOWN_SMOKE = 6,

    83

	EV_EXPLOSION_SMALL = 7,

    84

	EV_BULLDOZER       = 8,

    85

	EV_BUBBLE          = 9

    86

};

    87

    88

struct VehicleRail {

    89

	uint16 last_speed; // NOSAVE: only used in UI

    90

	uint16 crash_anim_pos;

    91

    92

	/* cached values, recalculated on load and each time a vehicle is added to/removed from the consist. */

    93

	uint16 cached_max_speed;  // max speed of the consist. (minimum of the max speed of all vehicles in the consist)

    94

	uint32 cached_power;      // total power of the consist.

    95

	uint8 cached_veh_length;  // length of this vehicle in units of 1/8 of normal length, cached because this can be set by a callback

    96

	uint16 cached_total_length; ///< Length of the whole train, valid only for first engine.

    97

    98

	/* cached values, recalculated when the cargo on a train changes (in addition to the conditions above) */

    99

	uint32 cached_weight;     // total weight of the consist.

   100

	uint32 cached_veh_weight; // weight of the vehicle.

   101

	uint32 cached_max_te;     // max tractive effort of consist

   102

	/**

   103

	 * Position/type of visual effect.

   104

	 * bit 0 - 3 = position of effect relative to vehicle. (0 = front, 8 = centre, 15 = rear)

   105

	 * bit 4 - 5 = type of effect. (0 = default for engine class, 1 = steam, 2 = diesel, 3 = electric)

   106

	 * bit     6 = disable visual effect.

   107

	 * bit     7 = disable powered wagons.

   108

	 */

   109

	byte cached_vis_effect;

   110

	byte user_def_data;

   111

   112

	/* NOSAVE: for wagon override - id of the first engine in train

   113

	 * 0xffff == not in train */

   114

	EngineID first_engine;

   115

   116

	TrackBitsByte track;

   117

	byte force_proceed;

   118

	RailTypeByte railtype;

   119

	RailTypeMask compatible_railtypes;

   120

   121

	byte flags;

   122

   123

	/* Link between the two ends of a multiheaded engine */

   124

	Vehicle *other_multiheaded_part;

   125

   126

	/* Cached wagon override spritegroup */

   127

	const struct SpriteGroup *cached_override;

   128

};

   129

   130

enum {

   131

	VRF_REVERSING         = 0,

   132

   133

	/* used to calculate if train is going up or down */

   134

	VRF_GOINGUP           = 1,

   135

	VRF_GOINGDOWN         = 2,

   136

   137

	/* used to store if a wagon is powered or not */

   138

	VRF_POWEREDWAGON      = 3,

   139

   140

	/* used to reverse the visible direction of the vehicle */

   141

	VRF_REVERSE_DIRECTION = 4,

   142

   143

	/* used to mark train as lost because PF can't find the route */

   144

	VRF_NO_PATH_TO_DESTINATION = 5,

   145

   146

	/* used to mark that electric train engine is allowed to run on normal rail */

   147

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   148

};

   149

   150

struct VehicleAir {

   151

	uint16 crashed_counter;

   152

	uint16 cached_max_speed;

   153

	byte pos;

   154

	byte previous_pos;

   155

	StationID targetairport;

   156

	byte state;

   157

};

   158

   159

struct VehicleRoad {

   160

	byte state;             ///< @see RoadVehicleStates

   161

	byte frame;

   162

	uint16 blocked_ctr;

   163

	byte overtaking;

   164

	byte overtaking_ctr;

   165

	uint16 crashed_ctr;

   166

	byte reverse_ctr;

   167

	struct RoadStop *slot;

   168

	byte slot_age;

   169

	EngineID first_engine;

   170

	byte cached_veh_length;

   171

   172

	RoadType roadtype;

   173

	RoadTypes compatible_roadtypes;

   174

};

   175

   176

struct VehicleSpecial {

   177

	uint16 animation_state;

   178

	byte animation_substate;

   179

};

   180

   181

struct VehicleDisaster {

   182

	uint16 image_override;

   183

	VehicleID big_ufo_destroyer_target;

   184

};

   185

   186

struct VehicleShip {

   187

	TrackBitsByte state;

   188

};

   189

   190

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   191

   192

/* Some declarations of functions, so we can make them friendly */

   193

struct SaveLoad;

   194

extern const SaveLoad *GetVehicleDescription(VehicleType vt);

   195

extern void AfterLoadVehicles();

   196

struct LoadgameState;

   197

extern bool LoadOldVehicle(LoadgameState *ls, int num);

   198

   199

struct Vehicle : PoolItem<Vehicle, VehicleID, &_Vehicle_pool> {

   200

	VehicleTypeByte type;    ///< Type of vehicle

   201

	byte subtype;            // subtype (Filled with values from EffectVehicles/TrainSubTypes/AircraftSubTypes)

   202

   203

private:

   204

	Vehicle *next;           // pointer to the next vehicle in the chain

   205

	Vehicle *previous;       // NOSAVE: pointer to the previous vehicle in the chain

   206

	Vehicle *first;          // NOSAVE: pointer to the first vehicle in the chain

   207

public:

   208

	friend const SaveLoad *GetVehicleDescription(VehicleType vt); // So we can use private/protected variables in the saveload code

   209

	friend void AfterLoadVehicles();                              // So we can set the previous and first pointers while loading

   210

	friend bool LoadOldVehicle(LoadgameState *ls, int num);       // So we can set the proper next pointer while loading

   211

   212

	Vehicle *depot_list;     // NOSAVE: linked list to tell what vehicles entered a depot during the last tick. Used by autoreplace

   213

   214

	StringID string_id;      // Displayed string

   215

   216

	UnitID unitnumber;       // unit number, for display purposes only

   217

	PlayerByte owner;        // which player owns the vehicle?

   218

   219

	TileIndex tile;          // Current tile index

   220

	TileIndex dest_tile;     // Heading for this tile

   221

   222

	int32 x_pos;             // coordinates

   223

	int32 y_pos;

   224

	byte z_pos;

   225

	DirectionByte direction; // facing

   226

   227

	byte spritenum;          // currently displayed sprite index

   228

	                         // 0xfd == custom sprite, 0xfe == custom second head sprite

   229

	                         // 0xff == reserved for another custom sprite

   230

	uint16 cur_image;        // sprite number for this vehicle

   231

	byte sprite_width;       // width of vehicle sprite

   232

	byte sprite_height;      // height of vehicle sprite

   233

	byte z_height;           // z-height of vehicle sprite

   234

	int8 x_offs;             // x offset for vehicle sprite

   235

	int8 y_offs;             // y offset for vehicle sprite

   236

	EngineID engine_type;

   237

   238

	TextEffectID fill_percent_te_id; // a text-effect id to a loading indicator object

   239

   240

	/* for randomized variational spritegroups

   241

	 * bitmask used to resolve them; parts of it get reseeded when triggers

   242

	 * of corresponding spritegroups get matched */

   243

	byte random_bits;

   244

	byte waiting_triggers;   // triggers to be yet matched

   245

   246

	uint16 max_speed;        // maximum speed

   247

	uint16 cur_speed;        // current speed

   248

	byte subspeed;           // fractional speed

   249

	byte acceleration;       // used by train & aircraft

   250

	byte progress;

   251

	uint32 motion_counter;

   252

   253

	byte vehstatus;          // Status

   254

	StationID last_station_visited;

   255

   256

	CargoID cargo_type;      // type of cargo this vehicle is carrying

   257

	uint16 cargo_cap;        // total capacity

   258

	byte cargo_subtype;      ///< Used for livery refits (NewGRF variations)

   259

	CargoList cargo;         ///< The cargo this vehicle is carrying

   260

   261

   262

	byte day_counter;        // increased by one for each day

   263

	byte tick_counter;       // increased by one for each tick

   264

   265

	/* Begin Order-stuff */

   266

	Order current_order;     ///< The current order (+ status, like: loading)

   267

	VehicleOrderID cur_order_index; ///< The index to the current order

   268

   269

	Order *orders;           ///< Pointer to the first order for this vehicle

   270

	VehicleOrderID num_orders;      ///< How many orders there are in the list

   271

   272

	Vehicle *next_shared;    ///< If not NULL, this points to the next vehicle that shared the order

   273

	Vehicle *prev_shared;    ///< If not NULL, this points to the prev vehicle that shared the order

   274

	/* End Order-stuff */

   275

   276

	/* Boundaries for the current position in the world and a next hash link.

   277

	 * NOSAVE: All of those can be updated with VehiclePositionChanged() */

   278

	int32 left_coord;

   279

	int32 top_coord;

   280

	int32 right_coord;

   281

	int32 bottom_coord;

   282

	Vehicle *next_hash;

   283

	Vehicle *next_new_hash;

   284

	Vehicle **old_new_hash;

   285

   286

	/* Related to age and service time */

   287

	Date age;     // Age in days

   288

	Date max_age; // Maximum age

   289

	Date date_of_last_service;

   290

	Date service_interval;

   291

	uint16 reliability;

   292

	uint16 reliability_spd_dec;

   293

	byte breakdown_ctr;

   294

	byte breakdown_delay;

   295

	byte breakdowns_since_last_service;

   296

	byte breakdown_chance;

   297

	Year build_year;

   298

   299

	bool leave_depot_instantly; // NOSAVE: stores if the vehicle needs to leave the depot it just entered. Used by autoreplace

   300

   301

	uint16 load_unload_time_rem;

   302

	byte vehicle_flags;         // Used for gradual loading and other miscellaneous things (@see VehicleFlags enum)

   303

   304

	Money profit_this_year;

   305

	Money profit_last_year;

   306

	Money value;

   307

   308

	GroupID group_id;              ///< Index of group Pool array

   309

   310

	/* Used for timetabling. */

   311

	uint32 current_order_time;     ///< How many ticks have passed since this order started.

   312

	int32 lateness_counter;        ///< How many ticks late (or early if negative) this vehicle is.

   313

   314

	SpriteID colormap; // NOSAVE: cached color mapping

   315

   316

	union {

   317

		VehicleRail rail;

   318

		VehicleAir air;

   319

		VehicleRoad road;

   320

		VehicleSpecial special;

   321

		VehicleDisaster disaster;

   322

		VehicleShip ship;

   323

	} u;

   324

   325

   326

	/**

   327

	 * Allocates a lot of vehicles.

   328

	 * @param vl pointer to an array of vehicles to get allocated. Can be NULL if the vehicles aren't needed (makes it test only)

   329

	 * @param num number of vehicles to allocate room for

   330

	 * @return true if there is room to allocate all the vehicles

   331

	 */

   332

	static bool AllocateList(Vehicle **vl, int num);

   333

   334

	/** Create a new vehicle */

   335

	Vehicle();

   336

   337

	/** Destroy all stuff that (still) needs the virtual functions to work properly */

   338

	void PreDestructor();

   339

	/** We want to 'destruct' the right class. */

   340

	virtual ~Vehicle();

   341

   342

	void BeginLoading();

   343

	void LeaveStation();

   344

   345

	/**

   346

	 * Handle the loading of the vehicle; when not it skips through dummy

   347

	 * orders and does nothing in all other cases.

   348

	 * @param mode is the non-first call for this vehicle in this tick?

   349

	 */

   350

	void HandleLoading(bool mode = false);

   351

   352

	/**

   353

	 * Get a string 'representation' of the vehicle type.

   354

	 * @return the string representation.

   355

	 */

   356

	virtual const char* GetTypeString() const { return "base vehicle"; }

   357

   358

	/**

   359

	 * Marks the vehicles to be redrawn and updates cached variables

   360

	 *

   361

	 * This method marks the area of the vehicle on the screen as dirty.

   362

	 * It can be use to repaint the vehicle.

   363

	 *

   364

	 * @ingroup dirty

   365

	 */

   366

	virtual void MarkDirty() {}

   367

   368

	/**

   369

	 * Updates the x and y offsets and the size of the sprite used

   370

	 * for this vehicle.

   371

	 * @param direction the direction the vehicle is facing

   372

	 */

   373

	virtual void UpdateDeltaXY(Direction direction) {}

   374

   375

	/**

   376

	 * Sets the expense type associated to this vehicle type

   377

	 * @param income whether this is income or (running) expenses of the vehicle

   378

	 */

   379

	virtual ExpensesType GetExpenseType(bool income) const { return EXPENSES_OTHER; }

   380

   381

	/**

   382

	 * Invalidates the vehicle list window of this type of vehicle

   383

	 */

   384

	virtual WindowClass GetVehicleListWindowClass() const { return WC_NONE; }

   385

   386

	/**

   387

	 * Play the sound associated with leaving the station

   388

	 */

   389

	virtual void PlayLeaveStationSound() const {}

   390

   391

	/**

   392

	 * Whether this is the primary vehicle in the chain.

   393

	 */

   394

	virtual bool IsPrimaryVehicle() const { return false; }

   395

   396

	/**

   397

	 * Gets the sprite to show for the given direction

   398

	 * @param direction the direction the vehicle is facing

   399

	 * @return the sprite for the given vehicle in the given direction

   400

	 */

   401

	virtual int GetImage(Direction direction) const { return 0; }

   402

   403

	/**

   404

	 * Gets the speed in mph that can be sent into SetDParam for string processing.

   405

	 * @return the vehicle's speed

   406

	 */

   407

	virtual int GetDisplaySpeed() const { return 0; }

   408

   409

	/**

   410

	 * Gets the maximum speed in mph that can be sent into SetDParam for string processing.

   411

	 * @return the vehicle's maximum speed

   412

	 */

   413

	virtual int GetDisplayMaxSpeed() const { return 0; }

   414

   415

	/**

   416

	 * Gets the running cost of a vehicle

   417

	 * @return the vehicle's running cost

   418

	 */

   419

	virtual Money GetRunningCost() const { return 0; }

   420

   421

	/**

   422

	 * Check whether the vehicle is in the depot.

   423

	 * @return true if and only if the vehicle is in the depot.

   424

	 */

   425

	virtual bool IsInDepot() const { return false; }

   426

   427

	/**

   428

	 * Check whether the vehicle is in the depot *and* stopped.

   429

	 * @return true if and only if the vehicle is in the depot and stopped.

   430

	 */

   431

	virtual bool IsStoppedInDepot() const { return this->IsInDepot() && (this->vehstatus & VS_STOPPED) != 0; }

   432

   433

	/**

   434

	 * Calls the tick handler of the vehicle

   435

	 */

   436

	virtual void Tick() {};

   437

   438

	/**

   439

	 * Gets the running cost of a vehicle  that can be sent into SetDParam for string processing.

   440

	 * @return the vehicle's running cost

   441

	 */

   442

	Money GetDisplayRunningCost() const { return (this->GetRunningCost() >> 8); }

   443

   444

	/**

   445

	 * Is this vehicle a valid vehicle?

   446

	 * @return true if and only if the vehicle is valid.

   447

	 */

   448

	inline bool IsValid() const { return this->type != VEH_INVALID; }

   449

   450

	/**

   451

	 * Set the next vehicle of this vehicle.

   452

	 * @param next the next vehicle. NULL removes the next vehicle.

   453

	 */

   454

	void SetNext(Vehicle *next);

   455

   456

	/**

   457

	 * Get the next vehicle of this vehicle.

   458

	 * @note articulated parts are also counted as vehicles.

   459

	 * @return the next vehicle or NULL when there isn't a next vehicle.

   460

	 */

   461

	inline Vehicle *Next() const { return this->next; }

   462

   463

	/**

   464

	 * Get the previous vehicle of this vehicle.

   465

	 * @note articulated parts are also counted as vehicles.

   466

	 * @return the previous vehicle or NULL when there isn't a previous vehicle.

   467

	 */

   468

	inline Vehicle *Previous() const { return this->previous; }

   469

   470

	/**

   471

	 * Get the first vehicle of this vehicle chain.

   472

	 * @return the first vehicle of the chain.

   473

	 */

   474

	inline Vehicle *First() const { return this->first; }

   475

};

   476

   477

/**

   478

 * This class 'wraps' Vehicle; you do not actually instantiate this class.

   479

 * You create a Vehicle using AllocateVehicle, so it is added to the pool

   480

 * and you reinitialize that to a Train using:

   481

 *   v = new (v) Train();

   482

 *

   483

 * As side-effect the vehicle type is set correctly.

   484

 *

   485

 * A special vehicle is one of the following:

   486

 *  - smoke