1

/* $Id$ */

     2

     3

/** @vehicle.h */

     4

     5

#ifndef VEHICLE_H

     6

#define VEHICLE_H

     7

     8

#include "oldpool.h"

     9

#include "order.h"

    10

#include "rail.h"

    11

#include "road.h"

    12

#include "cargopacket.h"

    13

#include "texteff.hpp"

    14

    15

/** The returned bits of VehicleEnterTile. */

    16

enum VehicleEnterTileStatus {

    17

	VETS_ENTERED_STATION  = 1, ///< The vehicle entered a station

    18

	VETS_ENTERED_WORMHOLE = 2, ///< The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/tunnel)

    19

	VETS_CANNOT_ENTER     = 3, ///< The vehicle cannot enter the tile

    20

    21

	/**

    22

	 * Shift the VehicleEnterTileStatus this many bits

    23

	 * to the right to get the station ID when

    24

	 * VETS_ENTERED_STATION is set

    25

	 */

    26

	VETS_STATION_ID_OFFSET = 8,

    27

    28

	/** Bit sets of the above specified bits */

    29

	VETSB_CONTINUE         = 0,                          ///< The vehicle can continue normally

    30

	VETSB_ENTERED_STATION  = 1 << VETS_ENTERED_STATION,  ///< The vehicle entered a station

    31

	VETSB_ENTERED_WORMHOLE = 1 << VETS_ENTERED_WORMHOLE, ///< The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/tunnel)

    32

	VETSB_CANNOT_ENTER     = 1 << VETS_CANNOT_ENTER,     ///< The vehicle cannot enter the tile

    33

};

    34

    35

/** Road vehicle states */

    36

enum RoadVehicleStates {

    37

	/*

    38

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

    39

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

    40

	 * track direction of the entry to the road stop.

    41

	 * As the entry direction will always be a diagonal

    42

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

    43

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

    44

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

    45

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

    46

	 * is stopping at this road stop.

    47

	 */

    48

    49

	/* Numeric values */

    50

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

    51

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

    52

    53

	/* Bit numbers */

    54

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

    55

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

    56

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

    57

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

    58

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

    59

    60

	/* Bit sets of the above specified bits */

    61

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

    62

	RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,

    63

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

    64

	RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,

    65

    66

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

    67

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

    68

};

    69

    70

enum VehicleType {

    71

	VEH_TRAIN,

    72

	VEH_ROAD,

    73

	VEH_SHIP,

    74

	VEH_AIRCRAFT,

    75

	VEH_SPECIAL,

    76

	VEH_DISASTER,

    77

	VEH_END,

    78

	VEH_INVALID = 0xFF,

    79

};

    80

DECLARE_POSTFIX_INCREMENT(VehicleType);

    81

template <> struct EnumPropsT<VehicleType> : MakeEnumPropsT<VehicleType, byte, VEH_TRAIN, VEH_END, VEH_INVALID> {};

    82

typedef TinyEnumT<VehicleType> VehicleTypeByte;

    83

    84

enum VehStatus {

    85

	VS_HIDDEN          = 0x01,

    86

	VS_STOPPED         = 0x02,

    87

	VS_UNCLICKABLE     = 0x04,

    88

	VS_DEFPAL          = 0x08,

    89

	VS_TRAIN_SLOWING   = 0x10,

    90

	VS_SHADOW          = 0x20,

    91

	VS_AIRCRAFT_BROKEN = 0x40,

    92

	VS_CRASHED         = 0x80,

    93

};

    94

    95

enum VehicleFlags {

    96

	VF_LOADING_FINISHED,

    97

	VF_CARGO_UNLOADING,

    98

	VF_BUILT_AS_PROTOTYPE,

    99

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

   100

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

   101

};

   102

   103

/* Effect vehicle types */

   104

enum EffectVehicle {

   105

	EV_CHIMNEY_SMOKE   = 0,

   106

	EV_STEAM_SMOKE     = 1,

   107

	EV_DIESEL_SMOKE    = 2,

   108

	EV_ELECTRIC_SPARK  = 3,

   109

	EV_SMOKE           = 4,

   110

	EV_EXPLOSION_LARGE = 5,

   111

	EV_BREAKDOWN_SMOKE = 6,

   112

	EV_EXPLOSION_SMALL = 7,

   113

	EV_BULLDOZER       = 8,

   114

	EV_BUBBLE          = 9

   115

};

   116

   117

struct VehicleRail {

   118

	uint16 last_speed; // NOSAVE: only used in UI

   119

	uint16 crash_anim_pos;

   120

   121

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

   122

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

   123

	uint32 cached_power;      // total power of the consist.

   124

	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

   125

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

   126

   127

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

   128

	uint32 cached_weight;     // total weight of the consist.

   129

	uint32 cached_veh_weight; // weight of the vehicle.

   130

	uint32 cached_max_te;     // max tractive effort of consist

   131

	/**

   132

	 * Position/type of visual effect.

   133

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

   134

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

   135

	 * bit     6 = disable visual effect.

   136

	 * bit     7 = disable powered wagons.

   137

	 */

   138

	byte cached_vis_effect;

   139

	byte user_def_data;

   140

   141

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

   142

	 * 0xffff == not in train */

   143

	EngineID first_engine;

   144

   145

	TrackBitsByte track;

   146

	byte force_proceed;

   147

	RailTypeByte railtype;

   148

	RailTypeMask compatible_railtypes;

   149

   150

	byte flags;

   151

   152

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

   153

	Vehicle *other_multiheaded_part;

   154

   155

	/* Cached wagon override spritegroup */

   156

	const struct SpriteGroup *cached_override;

   157

};

   158

   159

enum {

   160

	VRF_REVERSING         = 0,

   161

   162

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

   163

	VRF_GOINGUP           = 1,

   164

	VRF_GOINGDOWN         = 2,

   165

   166

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

   167

	VRF_POWEREDWAGON      = 3,

   168

   169

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

   170

	VRF_REVERSE_DIRECTION = 4,

   171

   172

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

   173

	VRF_NO_PATH_TO_DESTINATION = 5,

   174

   175

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

   176

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   177

};

   178

   179

struct VehicleAir {

   180

	uint16 crashed_counter;

   181

	uint16 cached_max_speed;

   182

	byte pos;

   183

	byte previous_pos;

   184

	StationID targetairport;

   185

	byte state;

   186

};

   187

   188

struct VehicleRoad {

   189

	byte state;             ///< @see RoadVehicleStates

   190

	byte frame;

   191

	uint16 blocked_ctr;

   192

	byte overtaking;

   193

	byte overtaking_ctr;

   194

	uint16 crashed_ctr;

   195

	byte reverse_ctr;

   196

	struct RoadStop *slot;

   197

	byte slot_age;

   198

	EngineID first_engine;

   199

	byte cached_veh_length;

   200

   201

	RoadType roadtype;

   202

	RoadTypes compatible_roadtypes;

   203

};

   204

   205

struct VehicleSpecial {

   206

	uint16 animation_state;

   207

	byte animation_substate;

   208

};

   209

   210

struct VehicleDisaster {

   211

	uint16 image_override;

   212

	VehicleID big_ufo_destroyer_target;

   213

};

   214

   215

struct VehicleShip {

   216

	TrackBitsByte state;

   217

};

   218

   219

struct Vehicle;

   220

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   221

   222

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

   223

struct SaveLoad;

   224

extern const SaveLoad *GetVehicleDescription(VehicleType vt);

   225

extern void AfterLoadVehicles();

   226

struct LoadgameState;

   227

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

   228

   229

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

   230

	VehicleTypeByte type;    ///< Type of vehicle

   231

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

   232

   233

private:

   234

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

   235

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

   236

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

   237

public:

   238

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

   239

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

   240

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

   241

   242

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

   243

   244

	StringID string_id;      // Displayed string

   245

   246

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

   247

	PlayerByte owner;        // which player owns the vehicle?

   248

   249

	TileIndex tile;          // Current tile index

   250

	TileIndex dest_tile;     // Heading for this tile

   251

   252

	int32 x_pos;             // coordinates

   253

	int32 y_pos;

   254

	byte z_pos;

   255

	DirectionByte direction; // facing

   256

   257

	byte spritenum;          // currently displayed sprite index

   258

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

   259

	                         // 0xff == reserved for another custom sprite

   260

	uint16 cur_image;        // sprite number for this vehicle

   261

	byte sprite_width;       // width of vehicle sprite

   262

	byte sprite_height;      // height of vehicle sprite

   263

	byte z_height;           // z-height of vehicle sprite

   264

	int8 x_offs;             // x offset for vehicle sprite

   265

	int8 y_offs;             // y offset for vehicle sprite

   266

	EngineID engine_type;

   267

   268

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

   269

   270

	/* for randomized variational spritegroups

   271

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

   272

	 * of corresponding spritegroups get matched */

   273

	byte random_bits;

   274

	byte waiting_triggers;   // triggers to be yet matched

   275

   276

	uint16 max_speed;        // maximum speed

   277

	uint16 cur_speed;        // current speed

   278

	byte subspeed;           // fractional speed

   279

	byte acceleration;       // used by train & aircraft

   280

	byte progress;

   281

	uint32 motion_counter;

   282

   283

	byte vehstatus;          // Status

   284

	StationID last_station_visited;

   285

   286

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

   287

	uint16 cargo_cap;        // total capacity

   288

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

   289

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

   290

   291

   292

	byte day_counter;        // increased by one for each day

   293

	byte tick_counter;       // increased by one for each tick

   294

   295

	/* Begin Order-stuff */

   296

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

   297

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

   298

   299

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

   300

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

   301

   302

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

   303

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

   304

	/* End Order-stuff */

   305

   306

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

   307

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

   308

	int32 left_coord;

   309

	int32 top_coord;

   310

	int32 right_coord;

   311

	int32 bottom_coord;

   312

	Vehicle *next_hash;

   313

	Vehicle *next_new_hash;

   314

	Vehicle **old_new_hash;

   315

   316

	/* Related to age and service time */

   317

	Date age;     // Age in days

   318

	Date max_age; // Maximum age

   319

	Date date_of_last_service;

   320

	Date service_interval;

   321

	uint16 reliability;

   322

	uint16 reliability_spd_dec;

   323

	byte breakdown_ctr;

   324

	byte breakdown_delay;

   325

	byte breakdowns_since_last_service;

   326

	byte breakdown_chance;

   327

	Year build_year;

   328

   329

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

   330

   331

	uint16 load_unload_time_rem;

   332

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

   333

   334

	Money profit_this_year;

   335

	Money profit_last_year;

   336

	Money value;

   337

   338

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

   339

   340

	/* Used for timetabling. */

   341

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

   342

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

   343

   344

	SpriteID colormap; // NOSAVE: cached color mapping

   345

   346

	union {

   347

		VehicleRail rail;

   348

		VehicleAir air;

   349

		VehicleRoad road;

   350

		VehicleSpecial special;

   351

		VehicleDisaster disaster;

   352

		VehicleShip ship;

   353

	} u;

   354

   355

   356

	/**

   357

	 * Allocates a lot of vehicles.

   358

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

   359

	 * @param num number of vehicles to allocate room for

   360

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

   361

	 */

   362

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

   363

   364

	/** Create a new vehicle */

   365

	Vehicle();

   366

   367

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

   368

	void PreDestructor();

   369

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

   370

	virtual ~Vehicle();

   371

   372

	void BeginLoading();

   373

	void LeaveStation();

   374

   375

	/**

   376

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

   377

	 * orders and does nothing in all other cases.

   378

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

   379

	 */

   380

	void HandleLoading(bool mode = false);

   381

   382

	/**

   383

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

   384

	 * @return the string representation.

   385

	 */

   386

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

   387

   388

	/**

   389

	 * Marks the vehicles to be redrawn and updates cached variables

   390

	 *

   391

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

   392

	 * It can be use to repaint the vehicle.

   393

	 *

   394

	 * @ingroup dirty

   395

	 */

   396

	virtual void MarkDirty() {}

   397

   398

	/**

   399

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

   400

	 * for this vehicle.

   401

	 * @param direction the direction the vehicle is facing

   402

	 */

   403

	virtual void UpdateDeltaXY(Direction direction) {}

   404

   405

	/**

   406

	 * Sets the expense type associated to this vehicle type

   407

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

   408

	 */

   409

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

   410

   411

	/**

   412

	 * Invalidates the vehicle list window of this type of vehicle

   413

	 */

   414

	virtual WindowClass GetVehicleListWindowClass() const { return WC_NONE; }

   415

   416

	/**

   417

	 * Play the sound associated with leaving the station

   418

	 */

   419

	virtual void PlayLeaveStationSound() const {}

   420

   421

	/**

   422

	 * Whether this is the primary vehicle in the chain.

   423

	 */

   424

	virtual bool IsPrimaryVehicle() const { return false; }

   425

   426

	/**

   427

	 * Gets the sprite to show for the given direction

   428

	 * @param direction the direction the vehicle is facing

   429

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

   430

	 */

   431

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

   432

   433

	/**

   434

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

   435

	 * @return the vehicle's speed

   436

	 */

   437

	virtual int GetDisplaySpeed() const { return 0; }

   438

   439

	/**

   440

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

   441

	 * @return the vehicle's maximum speed

   442

	 */

   443

	virtual int GetDisplayMaxSpeed() const { return 0; }

   444

   445

	/**

   446

	 * Gets the running cost of a vehicle

   447

	 * @return the vehicle's running cost

   448

	 */

   449

	virtual Money GetRunningCost() const { return 0; }

   450

   451

	/**

   452

	 * Check whether the vehicle is in the depot.

   453

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

   454

	 */

   455

	virtual bool IsInDepot() const { return false; }

   456

   457

	/**

   458

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

   459

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

   460

	 */

   461

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

   462

   463

	/**

   464

	 * Calls the tick handler of the vehicle

   465

	 */

   466

	virtual void Tick() {};

   467

   468

	/**

   469

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

   470

	 * @return the vehicle's running cost

   471

	 */

   472

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

   473

   474

	/**

   475

	 * Is this vehicle a valid vehicle?

   476

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

   477

	 */

   478

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

   479

   480

	/**

   481

	 * Set the next vehicle of this vehicle.

   482

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

   483

	 */

   484

	void SetNext(Vehicle *next);

   485

   486