1

/* $Id$ */

     2

     3

/** @file  vehicle_base.h Base class for all vehicles. */

     4

     5

#ifndef VEHICLE_BASE_H

     6

#define VEHICLE_BASE_H

     7

     8

#include "vehicle_type.h"

     9

#include "track_type.h"

    10

#include "rail_type.h"

    11

#include "road_type.h"

    12

#include "cargo_type.h"

    13

#include "direction_type.h"

    14

#include "window_type.h"

    15

#include "gfx_type.h"

    16

#include "command_type.h"

    17

#include "date_type.h"

    18

#include "player_type.h"

    19

#include "oldpool.h"

    20

#include "order.h"

    21

#include "cargopacket.h"

    22

#include "texteff.hpp"

    23

    24

/** Road vehicle states */

    25

enum RoadVehicleStates {

    26

	/*

    27

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

    28

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

    29

	 * track direction of the entry to the road stop.

    30

	 * As the entry direction will always be a diagonal

    31

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

    32

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

    33

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

    34

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

    35

	 * is stopping at this road stop.

    36

	 */

    37

    38

	/* Numeric values */

    39

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

    40

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

    41

    42

	/* Bit numbers */

    43

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

    44

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

    45

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

    46

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

    47

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

    48

    49

	/* Bit sets of the above specified bits */

    50

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

    51

	RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,

    52

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

    53

	RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,

    54

    55

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

    56

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

    57

};

    58

    59

enum VehStatus {

    60

	VS_HIDDEN          = 0x01,

    61

	VS_STOPPED         = 0x02,

    62

	VS_UNCLICKABLE     = 0x04,

    63

	VS_DEFPAL          = 0x08,

    64

	VS_TRAIN_SLOWING   = 0x10,

    65

	VS_SHADOW          = 0x20,

    66

	VS_AIRCRAFT_BROKEN = 0x40,

    67

	VS_CRASHED         = 0x80,

    68

};

    69

    70

enum VehicleFlags {

    71

	VF_LOADING_FINISHED,

    72

	VF_CARGO_UNLOADING,

    73

	VF_BUILT_AS_PROTOTYPE,

    74

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

    75

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

    76

};

    77

    78

struct VehicleRail {

    79

	uint16 last_speed; // NOSAVE: only used in UI

    80

	uint16 crash_anim_pos;

    81

    82

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

    83

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

    84

	uint32 cached_power;      // total power of the consist.

    85

	bool cached_tilt;         // train can tilt; feature provides a bonus in curves

    86

	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

    87

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

    88

    89

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

    90

	uint32 cached_weight;     // total weight of the consist.

    91

	uint32 cached_veh_weight; // weight of the vehicle.

    92

	uint32 cached_max_te;     // max tractive effort of consist

    93

	/**

    94

	 * Position/type of visual effect.

    95

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

    96

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

    97

	 * bit     6 = disable visual effect.

    98

	 * bit     7 = disable powered wagons.

    99

	 */

   100

	byte cached_vis_effect;

   101

	byte user_def_data;

   102

   103

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

   104

	 * 0xffff == not in train */

   105

	EngineID first_engine;

   106

   107

	TrackBitsByte track;

   108

	byte force_proceed;

   109

	RailTypeByte railtype;

   110

	RailTypes compatible_railtypes;

   111

   112

	byte flags;

   113

   114

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

   115

	Vehicle *other_multiheaded_part;

   116

   117

	/* Cached wagon override spritegroup */

   118

	const struct SpriteGroup *cached_override;

   119

};

   120

   121

enum {

   122

	VRF_REVERSING         = 0,

   123

   124

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

   125

	VRF_GOINGUP           = 1,

   126

	VRF_GOINGDOWN         = 2,

   127

   128

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

   129

	VRF_POWEREDWAGON      = 3,

   130

   131

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

   132

	VRF_REVERSE_DIRECTION = 4,

   133

   134

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

   135

	VRF_NO_PATH_TO_DESTINATION = 5,

   136

   137

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

   138

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   139

};

   140

   141

struct VehicleAir {

   142

	uint16 crashed_counter;

   143

	uint16 cached_max_speed;

   144

	byte pos;

   145

	byte previous_pos;

   146

	StationID targetairport;

   147

	byte state;

   148

};

   149

   150

struct VehicleRoad {

   151

	byte state;             ///< @see RoadVehicleStates

   152

	byte frame;

   153

	uint16 blocked_ctr;

   154

	byte overtaking;

   155

	byte overtaking_ctr;

   156

	uint16 crashed_ctr;

   157

	byte reverse_ctr;

   158

	struct RoadStop *slot;

   159

	byte slot_age;

   160

	EngineID first_engine;

   161

	byte cached_veh_length;

   162

   163

	RoadType roadtype;

   164

	RoadTypes compatible_roadtypes;

   165

};

   166

   167

struct VehicleSpecial {

   168

	uint16 animation_state;

   169

	byte animation_substate;

   170

};

   171

   172

struct VehicleDisaster {

   173

	uint16 image_override;

   174

	VehicleID big_ufo_destroyer_target;

   175

};

   176

   177

struct VehicleShip {

   178

	TrackBitsByte state;

   179

};

   180

   181

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   182

   183

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

   184

struct SaveLoad;

   185

extern const SaveLoad *GetVehicleDescription(VehicleType vt);

   186

extern void AfterLoadVehicles(bool clear_te_id);

   187

struct LoadgameState;

   188

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

   189

   190

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

   191

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

   192

   193

private:

   194

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

   195

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

   196

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

   197

public:

   198

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

   199

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

   200

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

   201

   202

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

   203

   204

	char *name;              ///< Name of vehicle

   205

   206

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

   207

	PlayerByte owner;        // which player owns the vehicle?

   208

   209

	TileIndex tile;          // Current tile index

   210

	TileIndex dest_tile;     // Heading for this tile

   211

   212

	int32 x_pos;             // coordinates

   213

	int32 y_pos;

   214

	byte z_pos;

   215

	DirectionByte direction; // facing

   216

   217

	byte spritenum;          // currently displayed sprite index

   218

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

   219

	                         // 0xff == reserved for another custom sprite

   220

	uint16 cur_image;        // sprite number for this vehicle

   221

	byte sprite_width;       // width of vehicle sprite

   222

	byte sprite_height;      // height of vehicle sprite

   223

	byte z_height;           // z-height of vehicle sprite

   224

	int8 x_offs;             // x offset for vehicle sprite

   225

	int8 y_offs;             // y offset for vehicle sprite

   226

	EngineID engine_type;

   227

   228

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

   229

   230

	/* for randomized variational spritegroups

   231

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

   232

	 * of corresponding spritegroups get matched */

   233

	byte random_bits;

   234

	byte waiting_triggers;   // triggers to be yet matched

   235

   236

	uint16 max_speed;        // maximum speed

   237

	uint16 cur_speed;        // current speed

   238

	byte subspeed;           // fractional speed

   239

	byte acceleration;       // used by train & aircraft

   240

	byte progress;

   241

	uint32 motion_counter;

   242

   243

	byte vehstatus;          // Status

   244

	StationID last_station_visited;

   245

   246

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

   247

	uint16 cargo_cap;        // total capacity

   248

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

   249

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

   250

   251

   252

	byte day_counter;        ///< Increased by one for each day

   253

	byte tick_counter;       ///< Increased by one for each tick

   254

	byte running_ticks;      ///< Number of ticks this vehicle was not stopped this day

   255

   256

	/* Begin Order-stuff */

   257

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

   258

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

   259

   260

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

   261

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

   262

   263

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

   264

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

   265

	/* End Order-stuff */

   266

   267

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

   268

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

   269

	int32 left_coord;

   270

	int32 top_coord;

   271

	int32 right_coord;

   272

	int32 bottom_coord;

   273

	Vehicle *next_hash;

   274

	Vehicle *next_new_hash;

   275

	Vehicle **old_new_hash;

   276

   277

	/* Related to age and service time */

   278

	Date age;     // Age in days

   279

	Date max_age; // Maximum age

   280

	Date date_of_last_service;

   281

	Date service_interval;

   282

	uint16 reliability;

   283

	uint16 reliability_spd_dec;

   284

	byte breakdown_ctr;

   285

	byte breakdown_delay;

   286

	byte breakdowns_since_last_service;

   287

	byte breakdown_chance;

   288

	Year build_year;

   289

   290

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

   291

   292

	uint16 load_unload_time_rem;

   293

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

   294

   295

	Money profit_this_year;        ///< Profit this year << 8, low 8 bits are fract

   296

	Money profit_last_year;        ///< Profit last year << 8, low 8 bits are fract

   297

	Money value;

   298

   299

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

   300

   301

	/* Used for timetabling. */

   302

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

   303

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

   304

   305

	SpriteID colormap; // NOSAVE: cached color mapping

   306

   307

	union {

   308

		VehicleRail rail;

   309

		VehicleAir air;

   310

		VehicleRoad road;

   311

		VehicleSpecial special;

   312

		VehicleDisaster disaster;

   313

		VehicleShip ship;

   314

	} u;

   315

   316

   317

	/**

   318

	 * Allocates a lot of vehicles.

   319

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

   320

	 * @param num number of vehicles to allocate room for

   321

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

   322

	 */

   323

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

   324

   325

	/** Create a new vehicle */

   326

	Vehicle();

   327

   328

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

   329

	void PreDestructor();

   330

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

   331

	virtual ~Vehicle();

   332

   333

	void BeginLoading();

   334

	void LeaveStation();

   335

   336

	/**

   337

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

   338

	 * orders and does nothing in all other cases.

   339

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

   340

	 */

   341

	void HandleLoading(bool mode = false);

   342

   343

	/**

   344

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

   345

	 * @return the string representation.

   346

	 */

   347

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

   348

   349

	/**

   350

	 * Marks the vehicles to be redrawn and updates cached variables

   351

	 *

   352

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

   353

	 * It can be use to repaint the vehicle.

   354

	 *

   355

	 * @ingroup dirty

   356

	 */

   357

	virtual void MarkDirty() {}

   358

   359

	/**

   360

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

   361

	 * for this vehicle.

   362

	 * @param direction the direction the vehicle is facing

   363

	 */

   364

	virtual void UpdateDeltaXY(Direction direction) {}

   365

   366

	/**

   367

	 * Sets the expense type associated to this vehicle type

   368

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

   369

	 */

   370

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

   371

   372

	/**

   373

	 * Invalidates the vehicle list window of this type of vehicle

   374

	 */

   375

	virtual WindowClass GetVehicleListWindowClass() const { return WC_NONE; }

   376

   377

	/**

   378

	 * Play the sound associated with leaving the station

   379

	 */

   380

	virtual void PlayLeaveStationSound() const {}

   381

   382

	/**

   383

	 * Whether this is the primary vehicle in the chain.

   384

	 */

   385

	virtual bool IsPrimaryVehicle() const { return false; }

   386

   387

	/**

   388

	 * Gets the sprite to show for the given direction

   389

	 * @param direction the direction the vehicle is facing

   390

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

   391

	 */

   392

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

   393

   394

	/**

   395

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

   396

	 * @return the vehicle's speed

   397

	 */

   398

	virtual int GetDisplaySpeed() const { return 0; }

   399

   400

	/**

   401

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

   402

	 * @return the vehicle's maximum speed

   403

	 */

   404

	virtual int GetDisplayMaxSpeed() const { return 0; }

   405

   406

	/**

   407

	 * Gets the running cost of a vehicle

   408

	 * @return the vehicle's running cost

   409

	 */

   410

	virtual Money GetRunningCost() const { return 0; }

   411

   412

	/**

   413

	 * Check whether the vehicle is in the depot.

   414

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

   415

	 */

   416

	virtual bool IsInDepot() const { return false; }

   417

   418

	/**

   419

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

   420

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

   421

	 */

   422

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

   423

   424

	/**

   425

	 * Calls the tick handler of the vehicle

   426

	 */

   427

	virtual void Tick() {};

   428

   429

	/**

   430

	 * Calls the new day handler of the vehicle

   431

	 */

   432

	virtual void OnNewDay() {};

   433

   434

	/**

   435

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

   436

	 * @return the vehicle's running cost

   437

	 */

   438

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

   439

   440

	/**

   441

	 * Set the next vehicle of this vehicle.

   442

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

   443

	 */

   444

	void SetNext(Vehicle *next);

   445

   446

	/**

   447

	 * Get the next vehicle of this vehicle.

   448

	 * @note articulated parts are also counted as vehicles.

   449

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

   450

	 */

   451

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

   452

   453

	/**

   454

	 * Get the previous vehicle of this vehicle.

   455

	 * @note articulated parts are also counted as vehicles.

   456

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

   457

	 */

   458

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

   459

   460

	/**

   461

	 * Get the first vehicle of this vehicle chain.

   462

	 * @return the first vehicle of the chain.

   463

	 */

   464

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

   465

   466

	/**

   467

	 * Check if we share our orders with another vehicle.

   468

	 * This is done by checking the previous and next pointers in the shared chain.

   469

	 * @return true if there are other vehicles sharing the same order

   470

	 */

   471

	inline bool IsOrderListShared() const { return this->next_shared != NULL || this->prev_shared != NULL; };

   472

};

   473

   474

/**

   475

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

   476

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

   477

 * and you reinitialize that to a Train using:

   478

 *   v = new (v) Train();

   479

 *

   480

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

   481

 *

   482

 * A special vehicle is one of the following:

   483

 *  - smoke

   484

 *  - electric sparks for trains

   485

 *  - explosions

   486

 *  - bulldozer (road works)

   487

 *  - bubbles (industry)

   488

 */

   489

struct SpecialVehicle : public Vehicle {

   490

	/** Initializes the Vehicle to a special vehicle */

   491

	SpecialVehicle() { this->type = VEH_SPECIAL; }

   492

   493

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

   494

	virtual ~SpecialVehicle() {}

   495

   496

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

   497

	void UpdateDeltaXY(Direction direction);

   498

	void Tick();

   499

};

   500

   501

/**

   502

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

   503

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

   504

 * and you reinitialize that to a Train using:

   505

 *   v = new (v) Train();

   506

 *

   507

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

   508

 */

   509

struct DisasterVehicle : public Vehicle {

   510

	/** Initializes the Vehicle to a disaster vehicle */

   511

	DisasterVehicle() { this->type = VEH_DISASTER; }

   512

   513

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

   514

	virtual ~DisasterVehicle() {}

   515

   516

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

   517

	void UpdateDeltaXY(Direction direction);

   518

	void Tick();

   519

};

   520

   521

/**

   522

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

   523

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

   524

 * and you reinitialize that to a Train using:

   525

 *   v = new (v) Train();

   526

 *

   527