1

/* $Id$ */

     2

     3

/** @vehicle.h */

     4

     5

#ifndef VEHICLE_H

     6

#define VEHICLE_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 "window_type.h"

    14

#include "gfx_type.h"

    15

#include "command_type.h"

    16

#include "oldpool.h"

    17

#include "order.h"

    18

#include "cargopacket.h"

    19

#include "texteff.hpp"

    20

    21

/** Road vehicle states */

    22

enum RoadVehicleStates {

    23

	/*

    24

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

    25

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

    26

	 * track direction of the entry to the road stop.

    27

	 * As the entry direction will always be a diagonal

    28

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

    29

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

    30

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

    31

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

    32

	 * is stopping at this road stop.

    33

	 */

    34

    35

	/* Numeric values */

    36

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

    37

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

    38

    39

	/* Bit numbers */

    40

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

    41

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

    42

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

    43

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

    44

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

    45

    46

	/* Bit sets of the above specified bits */

    47

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

    48

	RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,

    49

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

    50

	RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,

    51

    52

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

    53

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

    54

};

    55

    56

enum VehStatus {

    57

	VS_HIDDEN          = 0x01,

    58

	VS_STOPPED         = 0x02,

    59

	VS_UNCLICKABLE     = 0x04,

    60

	VS_DEFPAL          = 0x08,

    61

	VS_TRAIN_SLOWING   = 0x10,

    62

	VS_SHADOW          = 0x20,

    63

	VS_AIRCRAFT_BROKEN = 0x40,

    64

	VS_CRASHED         = 0x80,

    65

};

    66

    67

enum VehicleFlags {

    68

	VF_LOADING_FINISHED,

    69

	VF_CARGO_UNLOADING,

    70

	VF_BUILT_AS_PROTOTYPE,

    71

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

    72

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

    73

};

    74

    75

/* Effect vehicle types */

    76

enum EffectVehicle {

    77

	EV_CHIMNEY_SMOKE   = 0,

    78

	EV_STEAM_SMOKE     = 1,

    79

	EV_DIESEL_SMOKE    = 2,

    80

	EV_ELECTRIC_SPARK  = 3,

    81

	EV_SMOKE           = 4,

    82

	EV_EXPLOSION_LARGE = 5,

    83

	EV_BREAKDOWN_SMOKE = 6,

    84

	EV_EXPLOSION_SMALL = 7,

    85

	EV_BULLDOZER       = 8,

    86

	EV_BUBBLE          = 9

    87

};

    88

    89

struct VehicleRail {

    90

	uint16 last_speed; // NOSAVE: only used in UI

    91

	uint16 crash_anim_pos;

    92

    93

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

    94

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

    95

	uint32 cached_power;      // total power of the consist.

    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

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

    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

	 * Position/type of visual effect.

   105

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

   106

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

   107

	 * bit     6 = disable visual effect.

   108

	 * bit     7 = disable powered wagons.

   109

	 */

   110

	byte cached_vis_effect;

   111

	byte user_def_data;

   112

   113

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

   114

	 * 0xffff == not in train */

   115

	EngineID first_engine;

   116

   117

	TrackBitsByte track;

   118

	byte force_proceed;

   119

	RailTypeByte railtype;

   120

	RailTypeMask compatible_railtypes;

   121

   122

	byte flags;

   123

   124

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

   125

	Vehicle *other_multiheaded_part;

   126

   127

	/* Cached wagon override spritegroup */

   128

	const struct SpriteGroup *cached_override;

   129

};

   130

   131

enum {

   132

	VRF_REVERSING         = 0,

   133

   134

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

   135

	VRF_GOINGUP           = 1,

   136

	VRF_GOINGDOWN         = 2,

   137

   138

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

   139

	VRF_POWEREDWAGON      = 3,

   140

   141

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

   142

	VRF_REVERSE_DIRECTION = 4,

   143

   144

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

   145

	VRF_NO_PATH_TO_DESTINATION = 5,

   146

   147

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

   148

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   149

};

   150

   151

struct VehicleAir {

   152

	uint16 crashed_counter;

   153

	uint16 cached_max_speed;

   154

	byte pos;

   155

	byte previous_pos;

   156

	StationID targetairport;

   157

	byte state;

   158

};

   159

   160

struct VehicleRoad {

   161

	byte state;             ///< @see RoadVehicleStates

   162

	byte frame;

   163

	uint16 blocked_ctr;

   164

	byte overtaking;

   165

	byte overtaking_ctr;

   166

	uint16 crashed_ctr;

   167

	byte reverse_ctr;

   168

	struct RoadStop *slot;

   169

	byte slot_age;

   170

	EngineID first_engine;

   171

	byte cached_veh_length;

   172

   173

	RoadType roadtype;

   174

	RoadTypes compatible_roadtypes;

   175

};

   176

   177

struct VehicleSpecial {

   178

	uint16 animation_state;

   179

	byte animation_substate;

   180

};

   181

   182

struct VehicleDisaster {

   183

	uint16 image_override;

   184

	VehicleID big_ufo_destroyer_target;

   185

};

   186

   187

struct VehicleShip {

   188

	TrackBitsByte state;

   189

};

   190

   191

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   192

   193

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

   194

struct SaveLoad;

   195

extern const SaveLoad *GetVehicleDescription(VehicleType vt);

   196

extern void AfterLoadVehicles();

   197

struct LoadgameState;

   198

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

   199

   200

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

   201

	VehicleTypeByte type;    ///< Type of vehicle

   202

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

   203

   204

private:

   205

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

   206

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

   207

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

   208

public:

   209

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

   210

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

   211

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

   212

   213

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

   214

   215

	StringID string_id;      // Displayed string

   216

   217

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

   218

	PlayerByte owner;        // which player owns the vehicle?

   219

   220

	TileIndex tile;          // Current tile index

   221

	TileIndex dest_tile;     // Heading for this tile

   222

   223

	int32 x_pos;             // coordinates

   224

	int32 y_pos;

   225

	byte z_pos;

   226

	DirectionByte direction; // facing

   227

   228

	byte spritenum;          // currently displayed sprite index

   229

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

   230

	                         // 0xff == reserved for another custom sprite

   231

	uint16 cur_image;        // sprite number for this vehicle

   232

	byte sprite_width;       // width of vehicle sprite

   233

	byte sprite_height;      // height of vehicle sprite

   234

	byte z_height;           // z-height of vehicle sprite

   235

	int8 x_offs;             // x offset for vehicle sprite

   236

	int8 y_offs;             // y offset for vehicle sprite

   237

	EngineID engine_type;

   238

   239

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

   240

   241

	/* for randomized variational spritegroups

   242

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

   243

	 * of corresponding spritegroups get matched */

   244

	byte random_bits;

   245

	byte waiting_triggers;   // triggers to be yet matched

   246

   247

	uint16 max_speed;        // maximum speed

   248

	uint16 cur_speed;        // current speed

   249

	byte subspeed;           // fractional speed

   250

	byte acceleration;       // used by train & aircraft

   251

	byte progress;

   252

	uint32 motion_counter;

   253

   254

	byte vehstatus;          // Status

   255

	StationID last_station_visited;

   256

   257

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

   258

	uint16 cargo_cap;        // total capacity

   259

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

   260

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

   261

   262

   263

	byte day_counter;        // increased by one for each day

   264

	byte tick_counter;       // increased by one for each tick

   265

   266

	/* Begin Order-stuff */

   267

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

   268

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

   269

   270

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

   271

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

   272

   273

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

   274

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

   275

	/* End Order-stuff */

   276

   277

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

   278

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

   279

	int32 left_coord;

   280

	int32 top_coord;

   281

	int32 right_coord;

   282

	int32 bottom_coord;

   283

	Vehicle *next_hash;

   284

	Vehicle *next_new_hash;

   285

	Vehicle **old_new_hash;

   286

   287

	/* Related to age and service time */

   288

	Date age;     // Age in days

   289

	Date max_age; // Maximum age

   290

	Date date_of_last_service;

   291

	Date service_interval;

   292

	uint16 reliability;

   293

	uint16 reliability_spd_dec;

   294

	byte breakdown_ctr;

   295

	byte breakdown_delay;

   296

	byte breakdowns_since_last_service;

   297

	byte breakdown_chance;

   298

	Year build_year;

   299

   300

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

   301

   302

	uint16 load_unload_time_rem;

   303

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

   304

   305

	Money profit_this_year;

   306

	Money profit_last_year;

   307

	Money value;

   308

   309

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

   310

   311

	/* Used for timetabling. */

   312

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

   313

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

   314

   315

	SpriteID colormap; // NOSAVE: cached color mapping

   316

   317

	union {

   318

		VehicleRail rail;

   319

		VehicleAir air;

   320

		VehicleRoad road;

   321

		VehicleSpecial special;

   322

		VehicleDisaster disaster;

   323

		VehicleShip ship;

   324

	} u;

   325

   326

   327

	/**

   328

	 * Allocates a lot of vehicles.

   329

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

   330

	 * @param num number of vehicles to allocate room for

   331

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

   332

	 */

   333

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

   334

   335

	/** Create a new vehicle */

   336

	Vehicle();

   337

   338

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

   339

	void PreDestructor();

   340

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

   341

	virtual ~Vehicle();

   342

   343

	void BeginLoading();

   344

	void LeaveStation();

   345

   346

	/**

   347

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

   348

	 * orders and does nothing in all other cases.

   349

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

   350

	 */

   351

	void HandleLoading(bool mode = false);

   352

   353

	/**

   354

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

   355

	 * @return the string representation.

   356

	 */

   357

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

   358

   359

	/**

   360

	 * Marks the vehicles to be redrawn and updates cached variables

   361

	 *

   362

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

   363

	 * It can be use to repaint the vehicle.

   364

	 *

   365

	 * @ingroup dirty

   366

	 */

   367

	virtual void MarkDirty() {}

   368

   369

	/**

   370

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

   371

	 * for this vehicle.

   372

	 * @param direction the direction the vehicle is facing

   373

	 */

   374

	virtual void UpdateDeltaXY(Direction direction) {}

   375

   376

	/**

   377

	 * Sets the expense type associated to this vehicle type

   378

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

   379

	 */

   380

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

   381

   382

	/**

   383

	 * Invalidates the vehicle list window of this type of vehicle

   384

	 */

   385

	virtual WindowClass GetVehicleListWindowClass() const { return WC_NONE; }

   386

   387

	/**

   388

	 * Play the sound associated with leaving the station

   389

	 */

   390

	virtual void PlayLeaveStationSound() const {}

   391

   392

	/**

   393

	 * Whether this is the primary vehicle in the chain.

   394

	 */

   395

	virtual bool IsPrimaryVehicle() const { return false; }

   396

   397

	/**

   398

	 * Gets the sprite to show for the given direction

   399

	 * @param direction the direction the vehicle is facing

   400

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

   401

	 */

   402

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

   403

   404

	/**

   405

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

   406

	 * @return the vehicle's speed

   407

	 */

   408

	virtual int GetDisplaySpeed() const { return 0; }

   409

   410

	/**

   411

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

   412

	 * @return the vehicle's maximum speed

   413

	 */

   414

	virtual int GetDisplayMaxSpeed() const { return 0; }

   415

   416

	/**

   417

	 * Gets the running cost of a vehicle

   418

	 * @return the vehicle's running cost

   419

	 */

   420

	virtual Money GetRunningCost() const { return 0; }

   421

   422

	/**

   423

	 * Check whether the vehicle is in the depot.

   424

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

   425

	 */

   426

	virtual bool IsInDepot() const { return false; }

   427

   428

	/**

   429

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

   430

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

   431

	 */

   432

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

   433

   434

	/**

   435

	 * Calls the tick handler of the vehicle

   436

	 */

   437

	virtual void Tick() {};

   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

	 * Is this vehicle a valid vehicle?

   447

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

   448

	 */

   449

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

   450

   451

	/**

   452

	 * Set the next vehicle of this vehicle.

   453

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

   454

	 */

   455

	void SetNext(Vehicle *next);

   456

   457

	/**

   458

	 * Get the next vehicle of this vehicle.

   459

	 * @note articulated parts are also counted as vehicles.

   460

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

   461

	 */

   462

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

   463

   464

	/**

   465

	 * Get the previous vehicle of this vehicle.

   466

	 * @note articulated parts are also counted as vehicles.

   467

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

   468

	 */

   469

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

   470

   471

	/**

   472

	 * Get the first vehicle of this vehicle chain.

   473

	 * @return the first vehicle of the chain.

   474

	 */

   475

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

   476

};

   477

   478

/**

   479

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

   480

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

   481

 * and you reinitialize that to a Train using:

   482

 *   v = new (v) Train();

   483

 *

   484

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

   485

 *

   486

 * A special vehicle is one of the following: