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 VehicleRailFlags {

   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

	/* used for vehicle var 0xFE bit 8 (toggled each time the train is reversed) */

   141

	VRF_TOGGLE_REVERSE = 7,

   142

};

   143

   144

struct VehicleAir {

   145

	uint16 crashed_counter;

   146

	uint16 cached_max_speed;

   147

	byte pos;

   148

	byte previous_pos;

   149

	StationID targetairport;

   150

	byte state;

   151

};

   152

   153

struct VehicleRoad {

   154

	byte state;             ///< @see RoadVehicleStates

   155

	byte frame;

   156

	uint16 blocked_ctr;

   157

	byte overtaking;

   158

	byte overtaking_ctr;

   159

	uint16 crashed_ctr;

   160

	byte reverse_ctr;

   161

	struct RoadStop *slot;

   162

	byte slot_age;

   163

	EngineID first_engine;

   164

	byte cached_veh_length;

   165

   166

	RoadType roadtype;

   167

	RoadTypes compatible_roadtypes;

   168

};

   169

   170

struct VehicleSpecial {

   171

	uint16 animation_state;

   172

	byte animation_substate;

   173

};

   174

   175

struct VehicleDisaster {

   176

	uint16 image_override;

   177

	VehicleID big_ufo_destroyer_target;

   178

};

   179

   180

struct VehicleShip {

   181

	TrackBitsByte state;

   182

};

   183

   184

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   185

   186

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

   187

struct SaveLoad;

   188

extern const SaveLoad *GetVehicleDescription(VehicleType vt);

   189

extern void AfterLoadVehicles(bool clear_te_id);

   190

struct LoadgameState;

   191

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

   192

   193

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

   194

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

   195

   196

private:

   197

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

   198

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

   199

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

   200

public:

   201

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

   202

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

   203

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

   204

   205

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

   206

   207

	char *name;              ///< Name of vehicle

   208

   209

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

   210

	PlayerByte owner;        // which player owns the vehicle?

   211

   212

	TileIndex tile;          // Current tile index

   213

	TileIndex dest_tile;     // Heading for this tile

   214

   215

	int32 x_pos;             // coordinates

   216

	int32 y_pos;

   217

	byte z_pos;

   218

	DirectionByte direction; // facing

   219

   220

	byte spritenum;          // currently displayed sprite index

   221

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

   222

	                         // 0xff == reserved for another custom sprite

   223

	uint16 cur_image;        // sprite number for this vehicle

   224

	byte sprite_width;       // width of vehicle sprite

   225

	byte sprite_height;      // height of vehicle sprite

   226

	byte z_height;           // z-height of vehicle sprite

   227

	int8 x_offs;             // x offset for vehicle sprite

   228

	int8 y_offs;             // y offset for vehicle sprite

   229

	EngineID engine_type;

   230

   231

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

   232

   233

	/* for randomized variational spritegroups

   234

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

   235

	 * of corresponding spritegroups get matched */

   236

	byte random_bits;

   237

	byte waiting_triggers;   // triggers to be yet matched

   238

   239

	uint16 max_speed;        // maximum speed

   240

	uint16 cur_speed;        // current speed

   241

	byte subspeed;           // fractional speed

   242

	byte acceleration;       // used by train & aircraft

   243

	byte progress;

   244

	uint32 motion_counter;

   245

   246

	byte vehstatus;          // Status

   247

	StationID last_station_visited;

   248

   249

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

   250

	uint16 cargo_cap;        // total capacity

   251

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

   252

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

   253

   254

   255

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

   256

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

   257

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

   258

   259

	/* Begin Order-stuff */

   260

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

   261

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

   262

   263

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

   264

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

   265

   266

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

   267

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

   268

	/* End Order-stuff */

   269

   270

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

   271

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

   272

	int32 left_coord;

   273

	int32 top_coord;

   274

	int32 right_coord;

   275

	int32 bottom_coord;

   276

	Vehicle *next_hash;

   277

	Vehicle *next_new_hash;

   278

	Vehicle **old_new_hash;

   279

   280

	/* Related to age and service time */

   281

	Date age;     // Age in days

   282

	Date max_age; // Maximum age

   283

	Date date_of_last_service;

   284

	Date service_interval;

   285

	uint16 reliability;

   286

	uint16 reliability_spd_dec;

   287

	byte breakdown_ctr;

   288

	byte breakdown_delay;

   289

	byte breakdowns_since_last_service;

   290

	byte breakdown_chance;

   291

	Year build_year;

   292

   293

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

   294

   295

	uint16 load_unload_time_rem;

   296

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

   297

   298

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

   299

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

   300

	Money value;

   301

   302

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

   303

   304

	/* Used for timetabling. */

   305

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

   306

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

   307

   308

	SpriteID colormap; // NOSAVE: cached color mapping

   309

   310

	union {

   311

		VehicleRail rail;

   312

		VehicleAir air;

   313

		VehicleRoad road;

   314

		VehicleSpecial special;

   315

		VehicleDisaster disaster;

   316

		VehicleShip ship;

   317

	} u;

   318

   319

   320

	/**

   321

	 * Allocates a lot of vehicles.

   322

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

   323

	 * @param num number of vehicles to allocate room for

   324

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

   325

	 */

   326

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

   327

   328

	/** Create a new vehicle */

   329

	Vehicle();

   330

   331

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

   332

	void PreDestructor();

   333

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

   334

	virtual ~Vehicle();

   335

   336

	void BeginLoading();

   337

	void LeaveStation();

   338

   339

	/**

   340

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

   341

	 * orders and does nothing in all other cases.

   342

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

   343

	 */

   344

	void HandleLoading(bool mode = false);

   345

   346

	/**

   347

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

   348

	 * @return the string representation.

   349

	 */

   350

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

   351

   352

	/**

   353

	 * Marks the vehicles to be redrawn and updates cached variables

   354

	 *

   355

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

   356

	 * It can be use to repaint the vehicle.

   357

	 *

   358

	 * @ingroup dirty

   359

	 */

   360

	virtual void MarkDirty() {}

   361

   362

	/**

   363

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

   364

	 * for this vehicle.

   365

	 * @param direction the direction the vehicle is facing

   366

	 */

   367

	virtual void UpdateDeltaXY(Direction direction) {}

   368

   369

	/**

   370

	 * Sets the expense type associated to this vehicle type

   371

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

   372

	 */

   373

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

   374

   375

	/**

   376

	 * Invalidates the vehicle list window of this type of vehicle

   377

	 */

   378

	virtual WindowClass GetVehicleListWindowClass() const { return WC_NONE; }

   379

   380

	/**

   381

	 * Play the sound associated with leaving the station

   382

	 */

   383

	virtual void PlayLeaveStationSound() const {}

   384

   385

	/**

   386

	 * Whether this is the primary vehicle in the chain.

   387

	 */

   388

	virtual bool IsPrimaryVehicle() const { return false; }

   389

   390

	/**

   391

	 * Gets the sprite to show for the given direction

   392

	 * @param direction the direction the vehicle is facing

   393

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

   394

	 */

   395

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

   396

   397

	/**

   398

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

   399

	 * @return the vehicle's speed

   400

	 */

   401

	virtual int GetDisplaySpeed() const { return 0; }

   402

   403

	/**

   404

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

   405

	 * @return the vehicle's maximum speed

   406

	 */

   407

	virtual int GetDisplayMaxSpeed() const { return 0; }

   408

   409

	/**

   410

	 * Gets the running cost of a vehicle

   411

	 * @return the vehicle's running cost

   412

	 */

   413

	virtual Money GetRunningCost() const { return 0; }

   414

   415

	/**

   416

	 * Check whether the vehicle is in the depot.

   417

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

   418

	 */

   419

	virtual bool IsInDepot() const { return false; }

   420

   421

	/**

   422

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

   423

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

   424

	 */

   425

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

   426

   427

	/**

   428

	 * Calls the tick handler of the vehicle

   429

	 */

   430

	virtual void Tick() {};

   431

   432

	/**

   433

	 * Calls the new day handler of the vehicle

   434

	 */

   435

	virtual void OnNewDay() {};

   436

   437

	/**

   438

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

   439

	 * @return the vehicle's running cost

   440

	 */

   441

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

   442

   443

	/**

   444

	 * Gets the profit vehicle had this year. It can be sent into SetDParam for string processing.

   445

	 * @return the vehicle's profit this year

   446

	 */

   447

	Money GetDisplayProfitThisYear() const { return (this->profit_this_year >> 8); }

   448

   449

	/**

   450

	 * Gets the profit vehicle had last year. It can be sent into SetDParam for string processing.

   451

	 * @return the vehicle's profit last year

   452

	 */

   453

	Money GetDisplayProfitLastYear() const { return (this->profit_last_year >> 8); }

   454

   455

	/**

   456

	 * Set the next vehicle of this vehicle.

   457

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

   458

	 */

   459

	void SetNext(Vehicle *next);

   460

   461

	/**

   462

	 * Get the next vehicle of this vehicle.

   463

	 * @note articulated parts are also counted as vehicles.

   464

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

   465

	 */

   466

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

   467

   468

	/**

   469

	 * Get the previous vehicle of this vehicle.

   470

	 * @note articulated parts are also counted as vehicles.

   471

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

   472

	 */

   473

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

   474

   475

	/**

   476

	 * Get the first vehicle of this vehicle chain.

   477

	 * @return the first vehicle of the chain.

   478

	 */

   479

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

   480

   481

	/**

   482

	 * Check if we share our orders with another vehicle.

   483

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

   484

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

   485

	 */

   486

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

   487

   488

	bool NeedsAutorenewing(const Player *p) const;

   489

};

   490

   491

/**

   492

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

   493

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

   494

 * and you reinitialize that to a Train using:

   495

 *   v = new (v) Train();

   496

 *

   497

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

   498

 *

   499

 * A special vehicle is one of the following:

   500

 *  - smoke

   501

 *  - electric sparks for trains

   502

 *  - explosions

   503

 *  - bulldozer (road works)

   504

 *  - bubbles (industry)

   505

 */

   506

struct SpecialVehicle : public Vehicle {

   507

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

   508

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

   509

   510

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

   511

	virtual ~SpecialVehicle() {}

   512

   513

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

   514

	void UpdateDeltaXY(Direction direction);

   515

	void Tick();

   516

};

   517

   518

/**

   519

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

   520

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

   521

 * and you reinitialize that to a Train using:

   522

 *   v = new (v) Train();

   523

 *

   524

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

   525

 */