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

    13

/** The returned bits of VehicleEnterTile. */

    14

enum VehicleEnterTileStatus {

    15

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

    16

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

    17

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

    18

    19

	/**

    20

	 * Shift the VehicleEnterTileStatus this many bits

    21

	 * to the right to get the station ID when

    22

	 * VETS_ENTERED_STATION is set

    23

	 */

    24

	VETS_STATION_ID_OFFSET = 8,

    25

    26

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

    27

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

    28

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

    29

	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)

    30

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

    31

};

    32

    33

/** Road vehicle states */

    34

enum RoadVehicleStates {

    35

	/*

    36

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

    37

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

    38

	 * track direction of the entry to the road stop.

    39

	 * As the entry direction will always be a diagonal

    40

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

    41

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

    42

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

    43

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

    44

	 * is stopping at this road stop.

    45

	 */

    46

    47

	/* Numeric values */

    48

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

    49

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

    50

    51

	/* Bit numbers */

    52

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

    53

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

    54

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

    55

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

    56

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

    57

    58

	/* Bit sets of the above specified bits */

    59

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

    60

	RVSB_IN_ROAD_STOP_END        = RVSB_IN_ROAD_STOP + TRACKDIR_END,

    61

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

    62

	RVSB_IN_DT_ROAD_STOP_END     = RVSB_IN_DT_ROAD_STOP + TRACKDIR_END,

    63

    64

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

    65

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

    66

};

    67

    68

enum VehicleType {

    69

	VEH_TRAIN,

    70

	VEH_ROAD,

    71

	VEH_SHIP,

    72

	VEH_AIRCRAFT,

    73

	VEH_SPECIAL,

    74

	VEH_DISASTER,

    75

	VEH_END,

    76

	VEH_INVALID = 0xFF,

    77

};

    78

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

    79

typedef TinyEnumT<VehicleType> VehicleTypeByte;

    80

    81

enum VehStatus {

    82

	VS_HIDDEN          = 0x01,

    83

	VS_STOPPED         = 0x02,

    84

	VS_UNCLICKABLE     = 0x04,

    85

	VS_DEFPAL          = 0x08,

    86

	VS_TRAIN_SLOWING   = 0x10,

    87

	VS_SHADOW          = 0x20,

    88

	VS_AIRCRAFT_BROKEN = 0x40,

    89

	VS_CRASHED         = 0x80,

    90

};

    91

    92

enum VehicleFlags {

    93

	VF_LOADING_FINISHED,

    94

	VF_CARGO_UNLOADING,

    95

	VF_BUILT_AS_PROTOTYPE,

    96

};

    97

    98

/* Effect vehicle types */

    99

enum EffectVehicle {

   100

	EV_CHIMNEY_SMOKE   = 0,

   101

	EV_STEAM_SMOKE     = 1,

   102

	EV_DIESEL_SMOKE    = 2,

   103

	EV_ELECTRIC_SPARK  = 3,

   104

	EV_SMOKE           = 4,

   105

	EV_EXPLOSION_LARGE = 5,

   106

	EV_BREAKDOWN_SMOKE = 6,

   107

	EV_EXPLOSION_SMALL = 7,

   108

	EV_BULLDOZER       = 8,

   109

	EV_BUBBLE          = 9

   110

};

   111

   112

struct VehicleRail {

   113

	uint16 last_speed; // NOSAVE: only used in UI

   114

	uint16 crash_anim_pos;

   115

   116

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

   117

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

   118

	uint32 cached_power;      // total power of the consist.

   119

	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

   120

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

   121

   122

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

   123

	uint32 cached_weight;     // total weight of the consist.

   124

	uint32 cached_veh_weight; // weight of the vehicle.

   125

	uint32 cached_max_te;     // max tractive effort of consist

   126

	/**

   127

	 * Position/type of visual effect.

   128

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

   129

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

   130

	 * bit     6 = disable visual effect.

   131

	 * bit     7 = disable powered wagons.

   132

	 */

   133

	byte cached_vis_effect;

   134

   135

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

   136

	 * 0xffff == not in train */

   137

	EngineID first_engine;

   138

   139

	TrackBitsByte track;

   140

	byte force_proceed;

   141

	RailTypeByte railtype;

   142

	RailTypeMask compatible_railtypes;

   143

   144

	byte flags;

   145

   146

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

   147

	Vehicle *other_multiheaded_part;

   148

   149

	/* Cached wagon override spritegroup */

   150

	const struct SpriteGroup *cached_override;

   151

};

   152

   153

enum {

   154

	VRF_REVERSING         = 0,

   155

   156

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

   157

	VRF_GOINGUP           = 1,

   158

	VRF_GOINGDOWN         = 2,

   159

   160

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

   161

	VRF_POWEREDWAGON      = 3,

   162

   163

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

   164

	VRF_REVERSE_DIRECTION = 4,

   165

   166

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

   167

	VRF_NO_PATH_TO_DESTINATION = 5,

   168

   169

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

   170

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   171

};

   172

   173

struct VehicleAir {

   174

	uint16 crashed_counter;

   175

	uint16 cached_max_speed;

   176

	byte pos;

   177

	byte previous_pos;

   178

	StationID targetairport;

   179

	byte state;

   180

};

   181

   182

struct VehicleRoad {

   183

	byte state;             ///< @see RoadVehicleStates

   184

	byte frame;

   185

	uint16 blocked_ctr;

   186

	byte overtaking;

   187

	byte overtaking_ctr;

   188

	uint16 crashed_ctr;

   189

	byte reverse_ctr;

   190

	struct RoadStop *slot;

   191

	byte slot_age;

   192

	EngineID first_engine;

   193

	byte cached_veh_length;

   194

   195

	RoadType roadtype;

   196

	RoadTypes compatible_roadtypes;

   197

};

   198

   199

struct VehicleSpecial {

   200

	uint16 unk0;

   201

	byte unk2;

   202

};

   203

   204

struct VehicleDisaster {

   205

	uint16 image_override;

   206

	uint16 unk2;

   207

};

   208

   209

struct VehicleShip {

   210

	TrackBitsByte state;

   211

};

   212

   213

   214

struct Vehicle {

   215

	VehicleTypeByte type;    ///< Type of vehicle

   216

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

   217

   218

	VehicleID index;         // NOSAVE: Index in vehicle array

   219

   220

	Vehicle *next;           // next

   221

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

   222

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

   223

   224

	StringID string_id;      // Displayed string

   225

   226

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

   227

	PlayerByte owner;        // which player owns the vehicle?

   228

   229

	TileIndex tile;          // Current tile index

   230

	TileIndex dest_tile;     // Heading for this tile

   231

   232

	int32 x_pos;             // coordinates

   233

	int32 y_pos;

   234

	byte z_pos;

   235

	DirectionByte direction; // facing

   236

   237

	byte spritenum;          // currently displayed sprite index

   238

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

   239

	                         // 0xff == reserved for another custom sprite

   240

	uint16 cur_image;        // sprite number for this vehicle

   241

	byte sprite_width;       // width of vehicle sprite

   242

	byte sprite_height;      // height of vehicle sprite

   243

	byte z_height;           // z-height of vehicle sprite

   244

	int8 x_offs;             // x offset for vehicle sprite

   245

	int8 y_offs;             // y offset for vehicle sprite

   246

	EngineID engine_type;

   247

   248

	/* for randomized variational spritegroups

   249

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

   250

	 * of corresponding spritegroups get matched */

   251

	byte random_bits;

   252

	byte waiting_triggers;   // triggers to be yet matched

   253

   254

	uint16 max_speed;        // maximum speed

   255

	uint16 cur_speed;        // current speed

   256

	byte subspeed;           // fractional speed

   257

	byte acceleration;       // used by train & aircraft

   258

	byte progress;

   259

	uint32 motion_counter;

   260

   261

	byte vehstatus;          // Status

   262

	StationID last_station_visited;

   263

   264

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

   265

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

   266

	StationID cargo_source;  // source of cargo

   267

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

   268

	uint16 cargo_cap;        // total capacity

   269

	uint16 cargo_count;      // how many pieces are used

   270

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

   271

   272

	byte day_counter;        // increased by one for each day

   273

	byte tick_counter;       // increased by one for each tick

   274

   275

	/* Begin Order-stuff */

   276

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

   277

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

   278

   279

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

   280

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

   281

   282

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

   283

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

   284

	/* End Order-stuff */

   285

   286

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

   287

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

   288

	int32 left_coord;

   289

	int32 top_coord;

   290

	int32 right_coord;

   291

	int32 bottom_coord;

   292

	Vehicle *next_hash;

   295

   296

	/* Related to age and service time */

   297

	Date age;     // Age in days

   298

	Date max_age; // Maximum age

   299

	Date date_of_last_service;

   300

	Date service_interval;

   301

	uint16 reliability;

   302

	uint16 reliability_spd_dec;

   303

	byte breakdown_ctr;

   304

	byte breakdown_delay;

   305

	byte breakdowns_since_last_service;

   306

	byte breakdown_chance;

   307

	Year build_year;

   308

   309

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

   310

   311

	uint16 load_unload_time_rem;

   312

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

   313

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

   314

   315

	int32 profit_this_year;

   316

	int32 profit_last_year;

   317

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

   318

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

   319

	uint32 value;

   320

   321

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

   322

   323

	union {

   324

		VehicleRail rail;

   325

		VehicleAir air;

   326

		VehicleRoad road;

   327

		VehicleSpecial special;

   328

		VehicleDisaster disaster;

   329

		VehicleShip ship;

   330

	} u;

   331

   332

	void BeginLoading();

   333

	void LeaveStation();

   334

   335

	/**

   336

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

   337

	 * orders and does nothing in all other cases.

   338

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

   339

	 */

   340

	void HandleLoading(bool mode = false);

   341

   342

	/**

   343

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

   344

	 * instead of a newly allocated piece of memory.

   345

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

   346

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

   347

	 * @return the memory that is 'allocated'

   348

	 */

   349

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

   350

   351

	/**

   352

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

   353

	 * @param p the memory to 'free'

   354

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

   355

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

   356

	 *       to please some compiler.

   357

	 */

   358

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

   359

   360

	/**

   361

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

   362

	 * @param p the memory to 'free'

   363

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

   364

	 *       as the above function was needed to please some compiler

   365

	 *       which made it necessary to add this to please yet

   366

	 *       another compiler...

   367

	 */

   368

	void operator delete(void *p) {}

   369

   370

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

   371

	virtual ~Vehicle() {}

   372

   373

	/**

   374

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

   375

	 * @return the string representation.

   376

	 */

   377

	virtual const char* GetTypeString() const = 0;

   378

   379

	/**

   380

	 * Marks the vehicles to be redrawn and updates cached variables

   381

	 */

   382

	virtual void MarkDirty() {}

   383

   384

	/**

   385

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

   386

	 * for this vehicle.

   387

	 * @param direction the direction the vehicle is facing

   388

	 */

   389

	virtual void UpdateDeltaXY(Direction direction) {}

   390

   391

	/**

   392

	 * Sets the expense type associated to this vehicle type

   393

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

   394

	 */

   395

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

   396

   397

	/**

   398

	 * Invalidates the vehicle list window of this type of vehicle

   399

	 */

   400

	virtual WindowClass GetVehicleListWindowClass() const { return WC_NONE; }

   401

   402

	/**

   403

	 * Play the sound associated with leaving the station

   404

	 */

   405

	virtual void PlayLeaveStationSound() const {}

   406

   407

	/**

   408

	 * Whether this is the primary vehicle in the chain.

   409

	 */

   410

	virtual bool IsPrimaryVehicle() const { return false; }

   411

   412

	/**

   413

	 * Whether this vehicle understands the concept of a front engine, so

   414

	 * basically, if GetFirstVehicleInChain() can be called for it.

   415

	 */

   416

	virtual bool HasFront() const { return false; }

   417

};

   418

   419

/**

   420

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

   421

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

   422

 * and you reinitialize that to a Train using:

   423

 *   v = new (v) Train();

   424

 *

   425

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

   426

 *

   427

 * A special vehicle is one of the following:

   428

 *  - smoke

   429

 *  - electric sparks for trains

   430

 *  - explosions

   431

 *  - bulldozer (road works)

   432

 *  - bubbles (industry)

   433

 */

   434

struct SpecialVehicle : public Vehicle {

   435

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

   436

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

   437

   438

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

   439

	virtual ~SpecialVehicle() {}

   440

   441

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

   442

	void UpdateDeltaXY(Direction direction);

   443

};

   444

   445

/**

   446

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

   447

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

   448

 * and you reinitialize that to a Train using:

   449

 *   v = new (v) Train();

   450

 *

   451

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

   452

 */

   453

struct DisasterVehicle : public Vehicle {

   454

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

   455

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

   456

   457

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

   458

	virtual ~DisasterVehicle() {}

   459

   460

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

   461

	void UpdateDeltaXY(Direction direction);

   462

};

   463

   464

/**

   465

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

   466

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

   467

 * and you reinitialize that to a Train using:

   468

 *   v = new (v) Train();

   469

 *

   470

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

   471

 */

   472

struct InvalidVehicle : public Vehicle {

   473

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

   474

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

   475

   476

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

   477

	virtual ~InvalidVehicle() {}

   478

   479

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

   480

};

   481

   482

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

   483

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

   484

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

   485

   486

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

   487

   488

void VehicleServiceInDepot(Vehicle *v);

   489

Vehicle *AllocateVehicle();