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_base.h"

    21

#include "cargopacket.h"

    22

#include "texteff.hpp"

    23

#include "group_type.h"

    24

#include "engine_type.h"

    25

    26

/** Road vehicle states */

    27

enum RoadVehicleStates {

    28

	/*

    29

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

    30

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

    31

	 * track direction of the entry to the road stop.

    32

	 * As the entry direction will always be a diagonal

    33

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

    34

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

    35

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

    36

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

    37

	 * is stopping at this road stop.

    38

	 */

    39

    40

	/* Numeric values */

    41

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

    42

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

    43

    44

	/* Bit numbers */

    45

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

    46

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

    47

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

    48

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

    49

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

    50

    51

	/* Bit sets of the above specified bits */

    52

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

    53

	RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,

    54

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

    55

	RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,

    56

    57

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

    58

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

    59

};

    60

    61

enum VehStatus {

    62

	VS_HIDDEN          = 0x01,

    63

	VS_STOPPED         = 0x02,

    64

	VS_UNCLICKABLE     = 0x04,

    65

	VS_DEFPAL          = 0x08,

    66

	VS_TRAIN_SLOWING   = 0x10,

    67

	VS_SHADOW          = 0x20,

    68

	VS_AIRCRAFT_BROKEN = 0x40,

    69

	VS_CRASHED         = 0x80,

    70

};

    71

    72

enum VehicleFlags {

    73

	VF_LOADING_FINISHED,

    74

	VF_CARGO_UNLOADING,

    75

	VF_BUILT_AS_PROTOTYPE,

    76

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

    77

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

    78

};

    79

    80

struct VehicleRail {

    81

	uint16 last_speed; // NOSAVE: only used in UI

    82

	uint16 crash_anim_pos;

    83

    84

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

    85

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

    86

	uint32 cached_power;      // total power of the consist.

    87

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

    88

	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

    89

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

    90

    91

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

    92

	uint32 cached_weight;     // total weight of the consist.

    93

	uint32 cached_veh_weight; // weight of the vehicle.

    94

	uint32 cached_max_te;     // max tractive effort of consist

    95

	/**

    96

	 * Position/type of visual effect.

    97

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

    98

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

    99

	 * bit     6 = disable visual effect.

   100

	 * bit     7 = disable powered wagons.

   101

	 */

   102

	byte cached_vis_effect;

   103

	byte user_def_data;

   104

   105

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

   106

	 * 0xffff == not in train */

   107

	EngineID first_engine;

   108

   109

	TrackBitsByte track;

   110

	byte force_proceed;

   111

	RailTypeByte railtype;

   112

	RailTypes compatible_railtypes;

   113

   114

	byte flags;

   115

   116

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

   117

	Vehicle *other_multiheaded_part;

   118

   119

	/* Cached wagon override spritegroup */

   120

	const struct SpriteGroup *cached_override;

   121

};

   122

   123

enum VehicleRailFlags {

   124

	VRF_REVERSING         = 0,

   125

   126

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

   127

	VRF_GOINGUP           = 1,

   128

	VRF_GOINGDOWN         = 2,

   129

   130

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

   131

	VRF_POWEREDWAGON      = 3,

   132

   133

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

   134

	VRF_REVERSE_DIRECTION = 4,

   135

   136

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

   137

	VRF_NO_PATH_TO_DESTINATION = 5,

   138

   139

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

   140

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   141

   143

	VRF_TOGGLE_REVERSE = 7,

   144

};

   145

   146

struct VehicleAir {

   147

	uint16 crashed_counter;

   148

	uint16 cached_max_speed;

   149

	byte pos;

   150

	byte previous_pos;

   151

	StationID targetairport;

   152

	byte state;

   153

};

   154

   155

struct VehicleRoad {

   156

	byte state;             ///< @see RoadVehicleStates

   157

	byte frame;

   158

	uint16 blocked_ctr;

   159

	byte overtaking;

   160

	byte overtaking_ctr;

   161

	uint16 crashed_ctr;

   162

	byte reverse_ctr;

   163

	struct RoadStop *slot;

   164

	byte slot_age;

   165

	EngineID first_engine;

   166

	byte cached_veh_length;

   167

   168

	RoadType roadtype;

   169

	RoadTypes compatible_roadtypes;

   170

};

   171

   172

struct VehicleSpecial {

   173

	uint16 animation_state;

   174

	byte animation_substate;

   175

};

   176

   177

struct VehicleDisaster {

   178

	uint16 image_override;

   179

	VehicleID big_ufo_destroyer_target;

   180

};

   181

   182

struct VehicleShip {

   183

	TrackBitsByte state;

   184

};

   185

   186

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   187

   188

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

   189

struct SaveLoad;

   190

extern const SaveLoad *GetVehicleDescription(VehicleType vt);

   191

extern void AfterLoadVehicles(bool clear_te_id);

   192

struct LoadgameState;

   193

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

   194

   195

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

   196

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

   197

   198

private:

   199

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

   200

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

   201

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

   202

public:

   203

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

   204

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

   205

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

   206

   207

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

   208

   209

	char *name;              ///< Name of vehicle

   210

   211

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

   212

	PlayerByte owner;        // which player owns the vehicle?

   213

   214

	TileIndex tile;          // Current tile index

   215

	TileIndex dest_tile;     // Heading for this tile

   216

   217

	int32 x_pos;             // coordinates

   218

	int32 y_pos;

   219

	byte z_pos;

   220

	DirectionByte direction; // facing

   221

   222

	byte spritenum;          // currently displayed sprite index

   223

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

   224

	                         // 0xff == reserved for another custom sprite

   225

	uint16 cur_image;        // sprite number for this vehicle

   226

	byte x_extent;           // x-extent of vehicle bounding box

   227

	byte y_extent;           // y-extent of vehicle bounding box

   228

	byte z_extent;           // z-extent of vehicle bounding box

   229

	int8 x_offs;             // x offset for vehicle sprite

   230

	int8 y_offs;             // y offset for vehicle sprite

   231

	EngineID engine_type;

   232

   233

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

   234

   235

	/* for randomized variational spritegroups

   236

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

   237

	 * of corresponding spritegroups get matched */

   238

	byte random_bits;

   239

	byte waiting_triggers;   // triggers to be yet matched

   240

   241

	uint16 max_speed;        // maximum speed

   242

	uint16 cur_speed;        // current speed

   243

	byte subspeed;           // fractional speed

   244

	byte acceleration;       // used by train & aircraft

   245

	byte progress;

   246

	uint32 motion_counter;

   247

   248

	byte vehstatus;          // Status

   249

	StationID last_station_visited;

   250

   251

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

   252

	uint16 cargo_cap;        // total capacity

   253

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

   254

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

   255

   256

   257

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

   258

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

   259

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

   260

   261

	/* Begin Order-stuff */

   262

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

   263

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

   264

   265

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

   266

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

   267

   268

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

   269

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

   270

	/* End Order-stuff */

   271

   272

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

   273

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

   274

	int32 left_coord;

   275

	int32 top_coord;

   276

	int32 right_coord;

   277

	int32 bottom_coord;

   278

	Vehicle *next_hash;

   279

	Vehicle *next_new_hash;

   280

	Vehicle **old_new_hash;

   281

   282

	/* Related to age and service time */

   283

	Date age;     // Age in days

   284

	Date max_age; // Maximum age

   285

	Date date_of_last_service;

   286

	Date service_interval;

   287

	uint16 reliability;

   288

	uint16 reliability_spd_dec;

   289

	byte breakdown_ctr;

   290

	byte breakdown_delay;

   291

	byte breakdowns_since_last_service;

   292

	byte breakdown_chance;

   293

	Year build_year;

   294

   295

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

   296

   297

	uint16 load_unload_time_rem;

   298

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

   299

   300

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

   301

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

   302

	Money value;

   303

   304

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

   305

   306

	/* Used for timetabling. */

   307

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

   308

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

   309

   310

	SpriteID colormap; // NOSAVE: cached color mapping

   311

   312

	union {

   313

		VehicleRail rail;

   314

		VehicleAir air;

   315

		VehicleRoad road;

   316

		VehicleSpecial special;

   317

		VehicleDisaster disaster;

   318

		VehicleShip ship;

   319

	} u;

   320

   321

   322

	/**

   323

	 * Allocates a lot of vehicles.

   324

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

   325

	 * @param num number of vehicles to allocate room for

   326

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

   327

	 */

   328

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

   329

   330

	/** Create a new vehicle */

   331

	Vehicle();

   332

   333

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

   334

	void PreDestructor();

   335

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

   336

	virtual ~Vehicle();

   337

   338

	void BeginLoading();

   339

	void LeaveStation();

   340

   341

	/**

   342

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

   343

	 * orders and does nothing in all other cases.

   344

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

   345

	 */

   346

	void HandleLoading(bool mode = false);

   347

   348

	/**

   349

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

   350

	 * @return the string representation.

   351

	 */

   352

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

   353

   354

	/**

   355

	 * Marks the vehicles to be redrawn and updates cached variables

   356

	 *

   357

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

   358

	 * It can be use to repaint the vehicle.

   359

	 *

   360

	 * @ingroup dirty

   361

	 */

   362

	virtual void MarkDirty() {}

   363

   364

	/**

   365

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

   366

	 * for this vehicle.

   367

	 * @param direction the direction the vehicle is facing

   368

	 */

   369

	virtual void UpdateDeltaXY(Direction direction) {}

   370

   371

	/**

   372

	 * Sets the expense type associated to this vehicle type

   373

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

   374

	 */

   375

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

   376

   377

	/**

   378

	 * Invalidates the vehicle list window of this type of vehicle

   379

	 */

   380

	virtual WindowClass GetVehicleListWindowClass() const { return WC_NONE; }

   381

   382

	/**

   383

	 * Play the sound associated with leaving the station

   384

	 */

   385

	virtual void PlayLeaveStationSound() const {}

   386

   387

	/**

   388

	 * Whether this is the primary vehicle in the chain.

   389

	 */

   390

	virtual bool IsPrimaryVehicle() const { return false; }

   391

   392

	/**

   393

	 * Gets the sprite to show for the given direction

   394

	 * @param direction the direction the vehicle is facing

   395

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

   396

	 */

   397

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

   398

   399

	/**

   400

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

   401

	 * @return the vehicle's speed

   402

	 */

   403

	virtual int GetDisplaySpeed() const { return 0; }

   404

   405

	/**

   406

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

   407

	 * @return the vehicle's maximum speed

   408

	 */

   409

	virtual int GetDisplayMaxSpeed() const { return 0; }

   410

   411

	/**

   412

	 * Gets the running cost of a vehicle

   413

	 * @return the vehicle's running cost

   414

	 */

   415

	virtual Money GetRunningCost() const { return 0; }

   416

   417

	/**

   418

	 * Check whether the vehicle is in the depot.

   419

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

   420

	 */

   421

	virtual bool IsInDepot() const { return false; }

   422

   423

	/**

   424

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

   425

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

   426

	 */

   427

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

   428

   429

	/**

   430

	 * Calls the tick handler of the vehicle

   431

	 */

   432

	virtual void Tick() {};

   433

   434

	/**

   435

	 * Calls the new day handler of the vehicle

   436

	 */

   437

	virtual void OnNewDay() {};

   438

   439

	/**

   440

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

   441

	 * @return the vehicle's running cost

   442

	 */

   443

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

   444

   445

	/**

   446

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

   447

	 * @return the vehicle's profit this year

   448

	 */

   449

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

   450

   451

	/**

   452

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

   453

	 * @return the vehicle's profit last year

   454

	 */

   455

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

   456

   457

	/**

   458

	 * Set the next vehicle of this vehicle.

   459

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

   460

	 */

   461

	void SetNext(Vehicle *next);

   462

   463

	/**

   464

	 * Get the next vehicle of this vehicle.

   465

	 * @note articulated parts are also counted as vehicles.

   466

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

   467

	 */

   468

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

   469

   470

	/**

   471

	 * Get the previous vehicle of this vehicle.

   472

	 * @note articulated parts are also counted as vehicles.

   473

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

   474

	 */

   475

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

   476

   477

	/**

   478

	 * Get the first vehicle of this vehicle chain.

   479

	 * @return the first vehicle of the chain.

   480

	 */

   481

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

   482

   483

	/**

   484

	 * Check if we share our orders with another vehicle.

   485

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

   486

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

   487

	 */

   488

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

   489

   490

	bool NeedsAutorenewing(const Player *p) const;

   491

   492

	/**

   493

	 * Check if the vehicle needs to go to a depot in near future (if a opportunity presents itself) for service or replacement.

   494

	 *

   495

	 * @see NeedsAutomaticServicing()

   496

	 * @return true if the vehicle should go to a depot if a opportunity presents itself.

   497

	 */

   498

	bool NeedsServicing() const;

   499

   500

	/**

   501

	 * Checks if the current order should be interupted for a service-in-depot-order.

   502

	 * @see NeedsServicing()

   503

	 * @return true if the current order should be interupted.

   504

	 */

   505

	bool NeedsAutomaticServicing() const;

   506

   507

	/**

   508

	 * Determine the location for the station where the vehicle goes to next.

   509

	 * Things done for example are allocating slots in a road stop or exact

   510

	 * location of the platform is determined for ships.

   511

	 * @param station the station to make the next location of the vehicle.

   512

	 * @return the location (tile) to aim for.

   513

	 */

   514

	virtual TileIndex GetOrderStationLocation(StationID station) { return INVALID_TILE; }

   515

   516

	/**

   517

	 * Find the closest depot for this vehicle and tell us the location,

   518

	 * DestinationID and whether we should reverse.

   519

	 * @param location    where do we go to?

   520

	 * @param destination what hangar do we go to?

   521

	 * @param reverse     should the vehicle be reversed?

   522

	 * @return true if a depot could be found.