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

    12

/** The returned bits of VehicleEnterTile. */

    13

enum VehicleEnterTileStatus {

    14

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

    15

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

    16

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

    17

    18

	/**

    19

	 * Shift the VehicleEnterTileStatus this many bits

    20

	 * to the right to get the station ID when

    21

	 * VETS_ENTERED_STATION is set

    22

	 */

    23

	VETS_STATION_ID_OFFSET = 8,

    24

    25

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

    26

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

    27

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

    28

	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)

    29

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

    30

};

    31

    32

/** Road vehicle states */

    33

enum RoadVehicleStates {

    34

	/*

    35

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

    36

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

    37

	 * track direction of the entry to the road stop.

    38

	 * As the entry direction will always be a diagonal

    39

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

    40

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

    41

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

    42

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

    43

	 * is stopping at this road stop.

    44

	 */

    45

    46

	/* Numeric values */

    47

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

    48

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

    49

    50

	/* Bit numbers */

    51

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

    52

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

    53

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

    54

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

    55

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

    56

    57

	/* Bit sets of the above specified bits */

    58

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

    59

	RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,

    60

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

    61

	RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,

    62

    63

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

    64

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

    65

};

    66

    67

enum VehicleType {

    68

	VEH_TRAIN,

    69

	VEH_ROAD,

    70

	VEH_SHIP,

    71

	VEH_AIRCRAFT,

    72

	VEH_SPECIAL,

    73

	VEH_DISASTER,

    74

	VEH_END,

    75

	VEH_INVALID = 0xFF,

    76

};

    77

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

    78

typedef TinyEnumT<VehicleType> VehicleTypeByte;

    79

    80

enum VehStatus {

    81

	VS_HIDDEN          = 0x01,

    82

	VS_STOPPED         = 0x02,

    83

	VS_UNCLICKABLE     = 0x04,

    84

	VS_DEFPAL          = 0x08,

    85

	VS_TRAIN_SLOWING   = 0x10,

    86

	VS_SHADOW          = 0x20,

    87

	VS_AIRCRAFT_BROKEN = 0x40,

    88

	VS_CRASHED         = 0x80,

    89

};

    90

    91

enum VehicleFlags {

    92

	VF_LOADING_FINISHED,

    93

	VF_CARGO_UNLOADING,

    94

	VF_BUILT_AS_PROTOTYPE,

    95

};

    96

    97

/* Effect vehicle types */

    98

enum EffectVehicle {

    99

	EV_CHIMNEY_SMOKE   = 0,

   100

	EV_STEAM_SMOKE     = 1,

   101

	EV_DIESEL_SMOKE    = 2,

   102

	EV_ELECTRIC_SPARK  = 3,

   103

	EV_SMOKE           = 4,

   104

	EV_EXPLOSION_LARGE = 5,

   105

	EV_BREAKDOWN_SMOKE = 6,

   106

	EV_EXPLOSION_SMALL = 7,

   107

	EV_BULLDOZER       = 8,

   108

	EV_BUBBLE          = 9

   109

};

   110

   111

struct VehicleRail {

   112

	uint16 last_speed; // NOSAVE: only used in UI

   113

	uint16 crash_anim_pos;

   114

   115

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

   116

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

   117

	uint32 cached_power;      // total power of the consist.

   118

	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

   119

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

   120

   121

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

   122

	uint32 cached_weight;     // total weight of the consist.

   123

	uint32 cached_veh_weight; // weight of the vehicle.

   124

	uint32 cached_max_te;     // max tractive effort of consist

   125

	/**

   126

	 * Position/type of visual effect.

   127

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

   128

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

   129

	 * bit     6 = disable visual effect.

   130

	 * bit     7 = disable powered wagons.

   131

	 */

   132

	byte cached_vis_effect;

   133

   134

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

   135

	 * 0xffff == not in train */

   136

	EngineID first_engine;

   137

   138

	TrackBitsByte track;

   139

	byte force_proceed;

   140

	RailTypeByte railtype;

   141

	RailTypeMask compatible_railtypes;

   142

   143

	byte flags;

   144

   145

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

   146

	Vehicle *other_multiheaded_part;

   147

   148

	/* Cached wagon override spritegroup */

   149

	const struct SpriteGroup *cached_override;

   150

};

   151

   152

enum {

   153

	VRF_REVERSING         = 0,

   154

   155

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

   156

	VRF_GOINGUP           = 1,

   157

	VRF_GOINGDOWN         = 2,

   158

   159

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

   160

	VRF_POWEREDWAGON      = 3,

   161

   162

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

   163

	VRF_REVERSE_DIRECTION = 4,

   164

   165

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

   166

	VRF_NO_PATH_TO_DESTINATION = 5,

   167

   168

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

   169

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   170

};

   171

   172

struct VehicleAir {

   173

	uint16 crashed_counter;

   174

	uint16 cached_max_speed;

   175

	byte pos;

   176

	byte previous_pos;

   177

	StationID targetairport;

   178

	byte state;

   179

};

   180

   181

struct VehicleRoad {

   182

	byte state;             ///< @see RoadVehicleStates

   183

	byte frame;

   184

	uint16 blocked_ctr;

   185

	byte overtaking;

   186

	byte overtaking_ctr;

   187

	uint16 crashed_ctr;

   188

	byte reverse_ctr;

   189

	struct RoadStop *slot;

   190

	byte slot_age;

   191

};

   192

   193

struct VehicleSpecial {

   194

	uint16 unk0;

   195

	byte unk2;

   196

};

   197

   198

struct VehicleDisaster {

   199

	uint16 image_override;

   200

	uint16 unk2;

   201

};

   202

   203

struct VehicleShip {

   204

	TrackBitsByte state;

   205

};

   206

   207

   208

struct Vehicle {

   209

	VehicleTypeByte type;    ///< Type of vehicle

   210

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

   211

   212

	VehicleID index;         // NOSAVE: Index in vehicle array

   213

   214

	Vehicle *next;           // next

   215

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

   216

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

   217

   218

	StringID string_id;      // Displayed string

   219

   220

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

   221

	PlayerByte owner;        // which player owns the vehicle?

   222

   223

	TileIndex tile;          // Current tile index

   224

	TileIndex dest_tile;     // Heading for this tile

   225

   226

	int32 x_pos;             // coordinates

   227

	int32 y_pos;

   228

	byte z_pos;

   229

	DirectionByte direction; // facing

   230

   231

	byte spritenum;          // currently displayed sprite index

   232

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

   233

	                         // 0xff == reserved for another custom sprite

   234

	uint16 cur_image;        // sprite number for this vehicle

   235

	byte sprite_width;       // width of vehicle sprite

   236

	byte sprite_height;      // height of vehicle sprite

   237

	byte z_height;           // z-height of vehicle sprite

   238

	int8 x_offs;             // x offset for vehicle sprite

   239

	int8 y_offs;             // y offset for vehicle sprite

   240

	EngineID engine_type;

   241

   242

	/* for randomized variational spritegroups

   243

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

   244

	 * of corresponding spritegroups get matched */

   245

	byte random_bits;

   246

	byte waiting_triggers;   // triggers to be yet matched

   247

   248

	uint16 max_speed;        // maximum speed

   249

	uint16 cur_speed;        // current speed

   250

	byte subspeed;           // fractional speed

   251

	byte acceleration;       // used by train & aircraft

   252

	byte progress;

   253

	uint32 motion_counter;

   254

   255

	byte vehstatus;          // Status

   256

	StationID last_station_visited;

   257

   258

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

   259

	byte cargo_days;         // how many days have the pieces been in transit

   260

	StationID cargo_source;  // source of cargo

   261

	TileIndex cargo_source_xy; //< stores the Tile where the source station is located, in case it is removed

   262

	uint16 cargo_cap;        // total capacity

   263

	uint16 cargo_count;      // how many pieces are used

   264

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

   265

   266

	byte day_counter;        // increased by one for each day

   267

	byte tick_counter;       // increased by one for each tick

   268

   269

	/* Begin Order-stuff */

   270

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

   271

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

   272

   273

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

   274

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

   275

   276

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

   277

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

   278

	/* End Order-stuff */

   279

   280

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

   281

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

   282

	int32 left_coord;

   283

	int32 top_coord;

   284

	int32 right_coord;

   285

	int32 bottom_coord;

   286

	Vehicle *next_hash;

   287

   288

	/* Related to age and service time */

   289

	Date age;     // Age in days

   290

	Date max_age; // Maximum age

   291

	Date date_of_last_service;

   292

	Date service_interval;

   293

	uint16 reliability;

   294

	uint16 reliability_spd_dec;

   295

	byte breakdown_ctr;

   296

	byte breakdown_delay;

   297

	byte breakdowns_since_last_service;

   298

	byte breakdown_chance;

   299

	Year build_year;

   300

   301

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

   302

   303

	uint16 load_unload_time_rem;

   304

	uint16 cargo_paid_for;      // How much of the cargo currently on board has been paid for.

   305

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

   306

   307

	int32 profit_this_year;

   308

	int32 profit_last_year;

   309

	int32 cargo_feeder_share;      ///< value of feeder pickup to be paid for on delivery of cargo

   310

	TileIndex cargo_loaded_at_xy;  ///< tile index where feeder cargo was loaded

   311

	uint32 value;

   312

   313

	union {

   314

		VehicleRail rail;

   315

		VehicleAir air;

   316

		VehicleRoad road;

   317

		VehicleSpecial special;

   318

		VehicleDisaster disaster;

   319

		VehicleShip ship;

   320

	} u;

   321

   322

	void BeginLoading();

   323

	void LeaveStation();

   324

   325

	/**

   326

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

   327

	 * orders and does nothing in all other cases.

   328

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

   329

	 */

   330

	void HandleLoading(bool mode = false);

   331

   332

	/**

   333

	 * An overriden version of new, so you can use the vehicle instance

   334

	 * instead of a newly allocated piece of memory.

   335

	 * @param size the size of the variable (unused)

   336

	 * @param v    the vehicle to use as 'storage' backend

   337

	 * @return the memory that is 'allocated'

   338

	 */

   339

	void* operator new(size_t size, Vehicle *v) { return v; }

   340

   341

	/**

   342

	 * 'Free' the memory allocated by the overriden new.

   343

	 * @param p the memory to 'free'

   344

	 * @param v the vehicle that was given to 'new' on creation.

   345

	 * @note This function isn't used (at the moment) and only added

   346

	 *       to please some compiler.

   347

	 */

   348

	void operator delete(void *p, Vehicle *v) {}

   349

   350

	/**

   351

	 * 'Free' the memory allocated by the overriden new.

   352

	 * @param p the memory to 'free'

   353

	 * @note This function isn't used (at the moment) and only added

   354

	 *       as the above function was needed to please some compiler

   355

	 *       which made it necessary to add this to please yet

   356

	 *       another compiler...

   357

	 */

   358

	void operator delete(void *p) {}

   359

   360

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

   361

	virtual ~Vehicle() {}

   362

   363

	/**

   364

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

   365

	 * @return the string representation.

   366

	 */

   367

	virtual const char* GetTypeString() const = 0;

   368

   369

	/**

   370

	 * Marks the vehicles to be redrawn and updates cached variables

   371

	 */

   372

	virtual void MarkDirty() {}

   373

   374

	/**

   375

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

   376

	 * for this vehicle.

   377

	 * @param direction the direction the vehicle is facing

   378

	 */

   379

	virtual void UpdateDeltaXY(Direction direction) {}

   380

   381

	/**

   382

	 * Sets the expense type associated to this vehicle type

   383

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

   384

	 */

   385

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

   386

   387

	/**

   388

	 * Invalidates the vehicle list window of this type of vehicle

   389

	 */

   390

	virtual WindowClass GetVehicleListWindowClass() const { return WC_NONE; }

   391

   392

	/**

   393

	 * Play the sound associated with leaving the station

   394

	 */

   395

	virtual void PlayLeaveStationSound() const {}

   396

};

   397

   398

/**

   399

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

   400

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

   401

 * and you reinitialize that to a Train using:

   402

 *   v = new (v) Train();

   403

 *

   404

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

   405

 *

   406

 * A special vehicle is one of the following:

   407

 *  - smoke

   408

 *  - electric sparks for trains

   409

 *  - explosions

   410

 *  - bulldozer (road works)

   411

 *  - bubbles (industry)

   412

 */

   413

struct SpecialVehicle : public Vehicle {

   414

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

   415

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

   416

   417

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

   418

	virtual ~SpecialVehicle() {}

   419

   420

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

   421

	void UpdateDeltaXY(Direction direction);

   422

};

   423

   424

/**

   425

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

   426

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

   427

 * and you reinitialize that to a Train using:

   428

 *   v = new (v) Train();

   429

 *

   430

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

   431

 */

   432

struct DisasterVehicle : public Vehicle {

   433

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

   434

	DisasterVehicle() { this->type = VEH_DISASTER; }

   435

   436

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

   437

	virtual ~DisasterVehicle() {}

   438

   439

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

   440

	void UpdateDeltaXY(Direction direction);

   441

};

   442

   443

/**

   444

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

   445

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

   446

 * and you reinitialize that to a Train using:

   447

 *   v = new (v) Train();

   448

 *

   449

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

   450

 */

   451

struct InvalidVehicle : public Vehicle {

   452

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

   453

	InvalidVehicle() { this->type = VEH_INVALID; }

   454

   455

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

   456

	virtual ~InvalidVehicle() {}

   457

   458

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

   459

};

   460

   461

#define is_custom_sprite(x) (x >= 0xFD)

   462

#define IS_CUSTOM_FIRSTHEAD_SPRITE(x) (x == 0xFD)

   463

#define IS_CUSTOM_SECONDHEAD_SPRITE(x) (x == 0xFE)

   464

   465

typedef void *VehicleFromPosProc(Vehicle *v, void *data);

   466

   467

void VehicleServiceInDepot(Vehicle *v);

   468

Vehicle *AllocateVehicle();

   469

bool AllocateVehicles(Vehicle **vl, int num);

   470

Vehicle *ForceAllocateVehicle();

   471

Vehicle *ForceAllocateSpecialVehicle();

   472

void VehiclePositionChanged(Vehicle *v);

   473

void AfterLoadVehicles();

   474

Vehicle *GetLastVehicleInChain(Vehicle *v);

   475

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   476

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   477

uint CountVehiclesInChain(const Vehicle* v);

   478

bool IsEngineCountable(const Vehicle *v);

   479

void DeleteVehicleChain(Vehicle *v);

   480

void *VehicleFromPos(TileIndex tile, void *data, VehicleFromPosProc *proc);

   481

void CallVehicleTicks();

   482

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   483

   484

void InitializeTrains();

   485

byte VehicleRandomBits();

   486

void ResetVehiclePosHash();

   487

   488

bool CanRefitTo(EngineID engine_type, CargoID cid_to);