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 {

    68

	VEH_TRAIN,

    69

	VEH_ROAD,

    70

	VEH_SHIP,

    71

	VEH_AIRCRAFT,

    72

	VEH_SPECIAL,

    73

	VEH_DISASTER,

    74

	VEH_INVALID = 0xFF,

    75

} ;

    76

    77

enum VehStatus {

    78

	VS_HIDDEN          = 0x01,

    79

	VS_STOPPED         = 0x02,

    80

	VS_UNCLICKABLE     = 0x04,

    81

	VS_DEFPAL          = 0x08,

    82

	VS_TRAIN_SLOWING   = 0x10,

    83

	VS_SHADOW          = 0x20,

    84

	VS_AIRCRAFT_BROKEN = 0x40,

    85

	VS_CRASHED         = 0x80,

    86

};

    87

    88

enum VehicleFlags {

    89

	VF_LOADING_FINISHED,

    90

	VF_CARGO_UNLOADING,

    91

	VF_BUILT_AS_PROTOTYPE,

    92

};

    93

    94

/* Effect vehicle types */

    95

enum EffectVehicle {

    96

	EV_CHIMNEY_SMOKE   = 0,

    97

	EV_STEAM_SMOKE     = 1,

    98

	EV_DIESEL_SMOKE    = 2,

    99

	EV_ELECTRIC_SPARK  = 3,

   100

	EV_SMOKE           = 4,

   101

	EV_EXPLOSION_LARGE = 5,

   102

	EV_BREAKDOWN_SMOKE = 6,

   103

	EV_EXPLOSION_SMALL = 7,

   104

	EV_BULLDOZER       = 8,

   105

	EV_BUBBLE          = 9

   106

};

   107

   108

struct VehicleRail {

   109

	uint16 last_speed; // NOSAVE: only used in UI

   110

	uint16 crash_anim_pos;

   111

	uint16 days_since_order_progr;

   112

   113

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

   114

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

   115

	uint32 cached_power;      // total power of the consist.

   116

	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

   117

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

   118

   119

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

   120

	uint32 cached_weight;     // total weight of the consist.

   121

	uint32 cached_veh_weight; // weight of the vehicle.

   122

	uint32 cached_max_te;     // max tractive effort of consist

   123

	/**

   124

	 * Position/type of visual effect.

   125

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

   126

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

   127

	 * bit     6 = disable visual effect.

   128

	 * bit     7 = disable powered wagons.

   129

	 */

   130

	byte cached_vis_effect;

   131

   132

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

   133

	 * 0xffff == not in train */

   134

	EngineID first_engine;

   135

   136

	TrackBitsByte track;

   137

	byte force_proceed;

   138

	RailTypeByte railtype;

   139

	RailTypeMask compatible_railtypes;

   140

   141

	byte flags;

   142

   143

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

   144

	Vehicle *other_multiheaded_part;

   145

};

   146

   147

enum {

   148

	VRF_REVERSING         = 0,

   149

   150

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

   151

	VRF_GOINGUP           = 1,

   152

	VRF_GOINGDOWN         = 2,

   153

   154

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

   155

	VRF_POWEREDWAGON      = 3,

   156

   157

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

   158

	VRF_REVERSE_DIRECTION = 4,

   159

   160

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

   161

	VRF_NO_PATH_TO_DESTINATION = 5,

   162

   163

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

   164

	VRF_EL_ENGINE_ALLOWED_NORMAL_RAIL = 6,

   165

};

   166

   167

struct VehicleAir {

   168

	uint16 crashed_counter;

   169

	uint16 cached_max_speed;

   170

	byte pos;

   171

	byte previous_pos;

   172

	StationID targetairport;

   173

	byte state;

   174

};

   175

   176

struct VehicleRoad {

   177

	byte state;             ///< @see RoadVehicleStates

   178

	byte frame;

   179

	uint16 blocked_ctr;

   180

	byte overtaking;

   181

	byte overtaking_ctr;

   182

	uint16 crashed_ctr;

   183

	byte reverse_ctr;

   184

	struct RoadStop *slot;

   185

	byte slot_age;

   186

};

   187

   188

struct VehicleSpecial {

   189

	uint16 unk0;

   190

	byte unk2;

   191

};

   192

   193

struct VehicleDisaster {

   194

	uint16 image_override;

   195

	uint16 unk2;

   196

};

   197

   198

struct VehicleShip {

   199

	TrackBitsByte state;

   200

};

   201

   202

   203

struct Vehicle {

   204

	byte type;               // type, ie roadven,train,ship,aircraft,special

   205

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

   206

   207

	VehicleID index;         // NOSAVE: Index in vehicle array

   208

   209

	Vehicle *next;           // next

   210

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

   211

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

   212

   213

	StringID string_id;      // Displayed string

   214

   215

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

   216

	PlayerByte owner;        // which player owns the vehicle?

   217

   218

	TileIndex tile;          // Current tile index

   219

	TileIndex dest_tile;     // Heading for this tile

   220

   221

	int32 x_pos;             // coordinates

   222

	int32 y_pos;

   223

	byte z_pos;

   224

	DirectionByte direction; // facing

   225

   226

	byte spritenum;          // currently displayed sprite index

   227

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

   228

	                         // 0xff == reserved for another custom sprite

   229

	uint16 cur_image;        // sprite number for this vehicle

   230

	byte sprite_width;       // width of vehicle sprite

   231

	byte sprite_height;      // height of vehicle sprite

   232

	byte z_height;           // z-height of vehicle sprite

   233

	int8 x_offs;             // x offset for vehicle sprite

   234

	int8 y_offs;             // y offset for vehicle sprite

   235

	EngineID engine_type;

   236

   237

	/* for randomized variational spritegroups

   238

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

   239

	 * of corresponding spritegroups get matched */

   240

	byte random_bits;

   241

	byte waiting_triggers;   // triggers to be yet matched

   242

   243

	uint16 max_speed;        // maximum speed

   244

	uint16 cur_speed;        // current speed

   245

	byte subspeed;           // fractional speed

   246

	byte acceleration;       // used by train & aircraft

   247

	byte progress;

   248

	uint32 motion_counter;

   249

   250

	byte vehstatus;          // Status

   251

	StationID last_station_visited;

   252

   253

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

   254

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

   255

	StationID cargo_source;  // source of cargo

   256

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

   257

	uint16 cargo_cap;        // total capacity

   258

	uint16 cargo_count;      // how many pieces are used

   259

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

   260

   261

	byte day_counter;        // increased by one for each day

   262

	byte tick_counter;       // increased by one for each tick

   263

   264

	/* Begin Order-stuff */

   265

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

   266

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

   267

   268

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

   269

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

   270

   271

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

   272

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

   273

	/* End Order-stuff */

   274

   275

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

   276

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

   277

	int32 left_coord;

   278

	int32 top_coord;

   279

	int32 right_coord;

   280

	int32 bottom_coord;

   281

	Vehicle *next_hash;

   282

   283

	/* Related to age and service time */

   284

	Date age;     // Age in days

   285

	Date max_age; // Maximum age

   286

	Date date_of_last_service;

   287

	Date service_interval;

   288

	uint16 reliability;

   289

	uint16 reliability_spd_dec;

   290

	byte breakdown_ctr;

   291

	byte breakdown_delay;

   292

	byte breakdowns_since_last_service;

   293

	byte breakdown_chance;

   294

	Year build_year;

   295

   296

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

   297

   298

	uint16 load_unload_time_rem;

   299

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

   300

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

   301

   302

	int32 profit_this_year;

   303

	int32 profit_last_year;

   304

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

   305

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

   306

	uint32 value;

   307

   308

	union {

   309

		VehicleRail rail;

   310

		VehicleAir air;

   311

		VehicleRoad road;

   312

		VehicleSpecial special;

   313

		VehicleDisaster disaster;

   314

		VehicleShip ship;

   315

	} u;

   316

   317

	void BeginLoading();

   318

	void LeaveStation();

   319

};

   320

   321

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

   322

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

   323

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

   324

   325

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

   326

   327

void VehicleServiceInDepot(Vehicle *v);

   328

Vehicle *AllocateVehicle();

   329

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

   330

Vehicle *ForceAllocateVehicle();

   331

Vehicle *ForceAllocateSpecialVehicle();

   332

void VehiclePositionChanged(Vehicle *v);

   333

void AfterLoadVehicles();

   334

Vehicle *GetLastVehicleInChain(Vehicle *v);

   335

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   336

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   337

uint CountVehiclesInChain(const Vehicle* v);

   338

bool IsEngineCountable(const Vehicle *v);

   339

void DeleteVehicleChain(Vehicle *v);

   340

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

   341

void CallVehicleTicks();

   342

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   343

   344

void InitializeTrains();

   345

byte VehicleRandomBits();

   346

void ResetVehiclePosHash();

   347

   348

bool CanFillVehicle(Vehicle *v);

   349

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

   350

CargoID FindFirstRefittableCargo(EngineID engine_type);

   351

int32 GetRefitCost(EngineID engine_type);

   352

   353

void ViewportAddVehicles(DrawPixelInfo *dpi);

   354

   355

/* train_cmd.h */

   356

int GetTrainImage(const Vehicle* v, Direction direction);

   357

int GetAircraftImage(const Vehicle* v, Direction direction);

   358

int GetRoadVehImage(const Vehicle* v, Direction direction);

   359

int GetShipImage(const Vehicle* v, Direction direction);

   360

SpriteID GetRotorImage(const Vehicle *v);

   361

   362

Vehicle *CreateEffectVehicle(int x, int y, int z, EffectVehicle type);

   363

Vehicle *CreateEffectVehicleAbove(int x, int y, int z, EffectVehicle type);

   364

Vehicle *CreateEffectVehicleRel(const Vehicle *v, int x, int y, int z, EffectVehicle type);

   365

   366

uint32 VehicleEnterTile(Vehicle *v, TileIndex tile, int x, int y);

   367

   368

StringID VehicleInTheWayErrMsg(const Vehicle* v);

   369

Vehicle *FindVehicleBetween(TileIndex from, TileIndex to, byte z, bool without_crashed = false);

   370

   371

bool UpdateSignalsOnSegment(TileIndex tile, DiagDirection direction);

   372

void SetSignalsOnBothDir(TileIndex tile, byte track);

   373

   374

Vehicle *CheckClickOnVehicle(const ViewPort *vp, int x, int y);

   375

   376

void DecreaseVehicleValue(Vehicle *v);

   377

void CheckVehicleBreakdown(Vehicle *v);

   378

void AgeVehicle(Vehicle *v);

   379

void VehicleEnteredDepotThisTick(Vehicle *v);

   380

   381

void BeginVehicleMove(Vehicle *v);

   382

void EndVehicleMove(Vehicle *v);

   383

   384

void ShowAircraftViewWindow(const Vehicle* v);

   385

   386

UnitID GetFreeUnitNumber(byte type);

   387

   388

int LoadUnloadVehicle(Vehicle *v, bool just_arrived);

   389

   390

void TrainConsistChanged(Vehicle *v);

   391

void TrainPowerChanged(Vehicle *v);

   392

int32 GetTrainRunningCost(const Vehicle *v);

   393

   394

int CheckTrainStoppedInDepot(const Vehicle *v);

   395

   396

bool VehicleNeedsService(const Vehicle *v);

   397

   398

uint GenerateVehicleSortList(const Vehicle*** sort_list, uint16 *length_of_array, byte type, PlayerID owner, uint32 index, uint16 window_type);

   399

void BuildDepotVehicleList(byte type, TileIndex tile, Vehicle ***engine_list, uint16 *engine_list_length, uint16 *engine_count, Vehicle ***wagon_list, uint16 *wagon_list_length, uint16 *wagon_count);

   400

int32 SendAllVehiclesToDepot(byte type, uint32 flags, bool service, PlayerID owner, uint16 vlw_flag, uint32 id);

   401

bool IsVehicleInDepot(const Vehicle *v);

   402

void VehicleEnterDepot(Vehicle *v);

   403

   404

void InvalidateAutoreplaceWindow(EngineID e);

   405

   406

int32 MaybeReplaceVehicle(Vehicle *v, bool check, bool display_costs);

   407

   408

/* Flags to add to p2 for goto depot commands */

   409

/* Note: bits 8-10 are used for VLW flags */

   410

enum {

   411

	DEPOT_SERVICE       = (1 << 0), // The vehicle will leave the depot right after arrival (serivce only)

   412

	DEPOT_MASS_SEND     = (1 << 1), // Tells that it's a mass send to depot command (type in VLW flag)

   413

	DEPOT_DONT_CANCEL   = (1 << 2), // Don't cancel current goto depot command if any

   414

	DEPOT_LOCATE_HANGAR = (1 << 3), // Find another airport if the target one lacks a hangar

   415

};

   416

   417

struct GetNewVehiclePosResult {

   418

	int x,y;

   419

	TileIndex old_tile;

   420

	TileIndex new_tile;

   421

};

   422

   423

/**

   424

 * Returns the Trackdir on which the vehicle is currently located.

   425

 * Works for trains and ships.

   426

 * Currently works only sortof for road vehicles, since they have a fuzzy

   427

 * concept of being "on" a trackdir. Dunno really what it returns for a road

   428

 * vehicle that is halfway a tile, never really understood that part. For road

   429

 * vehicles that are at the beginning or end of the tile, should just return

   430

 * the diagonal trackdir on which they are driving. I _think_.

   431

 * For other vehicles types, or vehicles with no clear trackdir (such as those

   432

 * in depots), returns 0xFF.

   433

 */

   434

Trackdir GetVehicleTrackdir(const Vehicle* v);

   435

   436

/* returns true if staying in the same tile */

   437

GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v);

   438

Direction GetDirectionTowards(const Vehicle* v, int x, int y);

   439

   440

#define BEGIN_ENUM_WAGONS(v) do {

   441

#define END_ENUM_WAGONS(v) } while ( (v=v->next) != NULL);

   442

   443

DECLARE_OLD_POOL(Vehicle, Vehicle, 9, 125)

   444

   445

static inline VehicleID GetMaxVehicleIndex()

   446

{

   447

	/* TODO - This isn't the real content of the function, but

   448

	 *  with the new pool-system this will be replaced with one that

   449

	 *  _really_ returns the highest index. Now it just returns

   450

	 *  the next safe value we are sure about everything is below.

   451

	 */

   452

	return GetVehiclePoolSize() - 1;

   453

}

   454

   455

static inline uint GetNumVehicles()

   456

{

   457

	return GetVehiclePoolSize();

   458

}

   459

   460

/**

   461

 * Check if a Vehicle really exists.

   462

 */

   463

static inline bool IsValidVehicle(const Vehicle *v)

   464

{

   465

	return v->type != VEH_INVALID;

   466

}

   467

   468

void DestroyVehicle(Vehicle *v);

   469

   470

static inline void DeleteVehicle(Vehicle *v)

   471

{

   472

	DestroyVehicle(v);

   473

	v->type = VEH_INVALID;

   474

}

   475

   476

static inline bool IsPlayerBuildableVehicleType(byte type)

   477

{

   478

	switch (type) {

   479

		case VEH_TRAIN:

   480

		case VEH_ROAD:

   481

		case VEH_SHIP:

   482

		case VEH_AIRCRAFT:

   483

			return true;

   484

	}

   485

	return false;

   486

}