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

    15

#include "command_type.h"

    16

#include "date_type.h"

    17

#include "player_base.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

#include "order_func.h"

    26

#include "transport_type.h"

    27

    28

/** Road vehicle states */

    29

enum RoadVehicleStates {

    30

	/*

    31

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

    32

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

    33

	 * track direction of the entry to the road stop.

    34

	 * As the entry direction will always be a diagonal

    35

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

    36

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

    37

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

    38

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

    39

	 * is stopping at this road stop.

    40

	 */

    41

    42

	/* Numeric values */

    43

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

    44

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

    45

    46

	/* Bit numbers */

    47

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

    48

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

    49

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

    50

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

    51

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

    52

    53

	/* Bit sets of the above specified bits */

    54

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

    55

	RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,

    56

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

    57

	RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,

    58

    59

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

    60

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

    61

};

    62

    63

enum VehStatus {

    64

	VS_HIDDEN          = 0x01,

    65

	VS_STOPPED         = 0x02,

    66

	VS_UNCLICKABLE     = 0x04,

    67

	VS_DEFPAL          = 0x08,

    68

	VS_TRAIN_SLOWING   = 0x10,

    69

	VS_SHADOW          = 0x20,

    70

	VS_AIRCRAFT_BROKEN = 0x40,

    71

	VS_CRASHED         = 0x80,

    72

};

    73

    74

enum VehicleFlags {

    75

	VF_LOADING_FINISHED,

    76

	VF_CARGO_UNLOADING,

    77

	VF_BUILT_AS_PROTOTYPE,

    78

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

    79

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

    80

};

    81

    82

struct VehicleRail {

    83

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

    84

	Vehicle *other_multiheaded_part;

    85

    86

	/* Cached wagon override spritegroup */

    87

	const struct SpriteGroup *cached_override;

    88

    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

	uint32 cached_power;        ///< total power of the consist.

    94

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

    95

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

    96

	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

    97

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

    98

    99

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

   100

	uint32 cached_weight;     ///< total weight of the consist.

   101

	uint32 cached_veh_weight; ///< weight of the vehicle.

   102

	uint32 cached_max_te;     ///< max tractive effort of consist

   103

   104

	/**

   105

	 * Position/type of visual effect.

   106

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

   107

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

   108

	 * bit     6 = disable visual effect.

   109

	 * bit     7 = disable powered wagons.

   110

	 */

   111

	byte cached_vis_effect;

   112

	byte user_def_data;

   113

   114

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

   115

	 * 0xffff == not in train */

   116

	EngineID first_engine;

   117

   118

	byte flags;

   119

	TrackBitsByte track;

   120

	byte force_proceed;

   121

	RailTypeByte railtype;

   122

	RailTypes compatible_railtypes;

   123

};

   124

   125

enum VehicleRailFlags {

   126

	VRF_REVERSING         = 0,

   127

   128

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

   129

	VRF_GOINGUP           = 1,

   130

	VRF_GOINGDOWN         = 2,

   131

   132

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

   133

	VRF_POWEREDWAGON      = 3,

   134

   135

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

   136

	VRF_REVERSE_DIRECTION = 4,

   137

   138

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

   139

	VRF_NO_PATH_TO_DESTINATION = 5,

   140

   141

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

   142

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   143

   144

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

   145

	VRF_TOGGLE_REVERSE = 7,

   146

};

   147

   148

struct VehicleAir {

   149

	uint16 crashed_counter;

   150

	uint16 cached_max_speed;

   151

	byte pos;

   152

	byte previous_pos;

   153

	StationID targetairport;

   154

	byte state;

   155

};

   156

   157

struct VehicleRoad {

   158

	byte state;             ///< @see RoadVehicleStates

   159

	byte frame;

   160

	uint16 blocked_ctr;

   161

	byte overtaking;

   162

	byte overtaking_ctr;

   163

	uint16 crashed_ctr;

   164

	byte reverse_ctr;

   165

	struct RoadStop *slot;

   166

	byte slot_age;

   167

	EngineID first_engine;

   168

	byte cached_veh_length;

   169

   170

	RoadType roadtype;

   171

	RoadTypes compatible_roadtypes;

   172

};

   173

   174

struct VehicleEffect {

   175

	uint16 animation_state;

   176

	byte animation_substate;

   177

};

   178

   179

struct VehicleDisaster {

   180

	uint16 image_override;

   181

	VehicleID big_ufo_destroyer_target;

   182

};

   183

   184

struct VehicleShip {

   185

	TrackBitsByte state;

   186

};

   187

   188

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   189

   190

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

   191

struct SaveLoad;

   192

extern const SaveLoad *GetVehicleDescription(VehicleType vt);

   193

extern void AfterLoadVehicles(bool clear_te_id);

   194

struct LoadgameState;

   195

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

   196

   197

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

   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

	TileIndex tile;          ///< Current tile index

   212

	TileIndex dest_tile;     ///< Heading for this tile

   213

   214

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

   215

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

   216

   217

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

   218

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

   219

	Money value;

   220

   221

	/* Used for timetabling. */

   222

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

   223

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

   224

   225

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

   226

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

   227

	int32 left_coord;

   228

	int32 top_coord;

   229

	int32 right_coord;

   230

	int32 bottom_coord;

   231

	Vehicle *next_hash;

   232

	Vehicle *next_new_hash;

   233

	Vehicle **old_new_hash;

   234

   235

	SpriteID colormap; // NOSAVE: cached color mapping

   236

   237

	/* Related to age and service time */

   238

	Year build_year;

   239

	Date age;     // Age in days

   240

	Date max_age; // Maximum age

   241

	Date date_of_last_service;

   242

	Date service_interval;

   243

	uint16 reliability;

   244

	uint16 reliability_spd_dec;

   245

	byte breakdown_ctr;

   246

	byte breakdown_delay;

   247

	byte breakdowns_since_last_service;

   248

	byte breakdown_chance;

   249

   250

	int32 x_pos;             // coordinates

   251

	int32 y_pos;

   252

	byte z_pos;

   253

	DirectionByte direction; // facing

   254

   255

	PlayerByte owner;        // which player owns the vehicle?

   256

	byte spritenum;          // currently displayed sprite index

   257

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

   258

	                         // 0xff == reserved for another custom sprite

   259

	uint16 cur_image;        // sprite number for this vehicle

   260

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

   261

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

   262

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

   263

	int8 x_offs;             // x offset for vehicle sprite

   264

	int8 y_offs;             // y offset for vehicle sprite

   265

	EngineID engine_type;

   266

   267

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

   268

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

   269

   270

	uint16 max_speed;        ///< maximum speed

   271

	uint16 cur_speed;        ///< current speed

   272

	byte subspeed;           ///< fractional speed

   273

	byte acceleration;       ///< used by train & aircraft

   274

	uint32 motion_counter;

   275

	byte progress;

   276

   277

	/* for randomized variational spritegroups

   278

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

   279

	 * of corresponding spritegroups get matched */

   280

	byte random_bits;

   281

	byte waiting_triggers;   ///< triggers to be yet matched

   282

   283

	StationID last_station_visited;

   284

   285

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

   286

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

   287

	uint16 cargo_cap;        ///< total capacity

   288

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

   289

   290

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

   291

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

   292

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

   293

   294

	byte vehstatus;                 ///< Status

   295

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

   296

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

   297

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

   298

   299

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

   300

   301

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

   302

   303

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

   304

	uint16 load_unload_time_rem;

   305

   306

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

   307

   308

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

   309

   310

	union {

   311

		VehicleRail rail;

   312

		VehicleAir air;

   313

		VehicleRoad road;

   314

		VehicleEffect effect;

   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

	 * Play the sound associated with leaving the station

   377

	 */

   378

	virtual void PlayLeaveStationSound() const {}

   379

   380

	/**

   381

	 * Whether this is the primary vehicle in the chain.

   382

	 */

   383

	virtual bool IsPrimaryVehicle() const { return false; }

   384

   385

	/**

   386

	 * Gets the sprite to show for the given direction

   387

	 * @param direction the direction the vehicle is facing

   388

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

   389

	 */

   390

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

   391

   392

	/**

   393

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

   394

	 * @return the vehicle's speed

   395

	 */

   396

	virtual int GetDisplaySpeed() const { return 0; }

   397

   398

	/**

   399

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

   400

	 * @return the vehicle's maximum speed

   401

	 */

   402

	virtual int GetDisplayMaxSpeed() const { return 0; }

   403

   404

	/**

   405

	 * Gets the running cost of a vehicle

   406

	 * @return the vehicle's running cost

   407

	 */

   408

	virtual Money GetRunningCost() const { return 0; }

   409

   410

	/**

   411

	 * Check whether the vehicle is in the depot.

   412

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

   413

	 */

   414

	virtual bool IsInDepot() const { return false; }

   415

   416

	/**

   417

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

   418

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

   419

	 */

   420

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

   421

   422

	/**

   423

	 * Calls the tick handler of the vehicle

   424

	 */

   425

	virtual void Tick() {};

   426

   427

	/**

   428

	 * Calls the new day handler of the vehicle

   429

	 */

   430

	virtual void OnNewDay() {};

   431

   432

	/**

   433

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

   434

	 * @return the vehicle's running cost

   435

	 */

   436

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

   437

   438

	/**

   439

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

   440

	 * @return the vehicle's profit this year

   441

	 */

   442

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

   443

   444

	/**

   445

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

   446

	 * @return the vehicle's profit last year

   447

	 */

   448

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

   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

	 * Check if we share our orders with another vehicle.

   478

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

   479

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

   480

	 */

   481

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

   482

   483

	bool NeedsAutorenewing(const Player *p) const;

   484

   485

	/**

   486

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

   487

	 *

   488

	 * @see NeedsAutomaticServicing()

   489

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

   490

	 */

   491

	bool NeedsServicing() const;

   492

   493

	/**

   494

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

   495

	 * @see NeedsServicing()

   496

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

   497

	 */

   498

	bool NeedsAutomaticServicing() const;

   499

   500

	/**

   501

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

   502

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

   503

	 * location of the platform is determined for ships.

   504

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

   505

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

   506

	 */

   507

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

   508

   509

	/**

   510

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

   511

	 * DestinationID and whether we should reverse.

   512

	 * @param location    where do we go to?

   513

	 * @param destination what hangar do we go to?

   514