1

/* $Id$ */

     2

     3

#ifndef VEHICLE_H

     4

#define VEHICLE_H

     5

     6

#include "pool.h"

     7

#include "order.h"

     8

#include "rail.h"

     9

    10

enum {

    11

	VEH_Invalid  = 0x00,

    12

	VEH_Train    = 0x10,

    13

	VEH_Road     = 0x11,

    14

	VEH_Ship     = 0x12,

    15

	VEH_Aircraft = 0x13,

    16

	VEH_Special  = 0x14,

    17

	VEH_Disaster = 0x15,

    18

} ;

    19

    20

enum VehStatus {

    21

	VS_HIDDEN          = 0x01,

    22

	VS_STOPPED         = 0x02,

    23

	VS_UNCLICKABLE     = 0x04,

    24

	VS_DEFPAL          = 0x08,

    25

	VS_TRAIN_SLOWING   = 0x10,

    26

	VS_SHADOW          = 0x20,

    27

	VS_AIRCRAFT_BROKEN = 0x40,

    28

	VS_CRASHED         = 0x80,

    29

};

    30

    31

/* Effect vehicle types */

    32

typedef enum EffectVehicle {

    33

	EV_CHIMNEY_SMOKE   = 0,

    34

	EV_STEAM_SMOKE     = 1,

    35

	EV_DIESEL_SMOKE    = 2,

    36

	EV_ELECTRIC_SPARK  = 3,

    37

	EV_SMOKE           = 4,

    38

	EV_EXPLOSION_LARGE = 5,

    39

	EV_BREAKDOWN_SMOKE = 6,

    40

	EV_EXPLOSION_SMALL = 7,

    41

	EV_BULLDOZER       = 8,

    42

	EV_BUBBLE          = 9

    43

} EffectVehicle;

    44

    45

typedef struct VehicleRail {

    46

	uint16 last_speed; // NOSAVE: only used in UI

    47

	uint16 crash_anim_pos;

    48

	uint16 days_since_order_progr;

    49

    50

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

    51

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

    52

	uint32 cached_power;      // total power of the consist.

    53

	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

    54

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

    55

    56

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

    57

	uint16 cached_weight;     // total weight of the consist.

    58

	uint16 cached_veh_weight; // weight of the vehicle.

    59

	/**

    60

	 * Position/type of visual effect.

    61

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

    62

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

    63

	 * bit     6 = disable visual effect.

    64

	 * bit     7 = disable powered wagons.

    65

	 */

    66

	byte cached_vis_effect;

    67

    68

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

    69

	// 0xffff == not in train

    70

	EngineID first_engine;

    71

    72

	byte track;

    73

	byte force_proceed;

    74

	byte railtype;

    75

	RailTypeMask compatible_railtypes;

    76

    77

	byte flags;

    78

    79

	// Link between the two ends of a multiheaded engine

    80

	Vehicle *other_multiheaded_part;

    81

} VehicleRail;

    82

    83

enum {

    84

	VRF_REVERSING         = 0,

    85

    86

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

    87

	VRF_GOINGUP           = 1,

    88

	VRF_GOINGDOWN         = 2,

    89

    90

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

    91

	VRF_POWEREDWAGON      = 3,

    92

    93

	// used to reverse the visible direction of the vehicle

    94

	VRF_REVERSE_DIRECTION = 4,

    95

    96

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

    97

	VRF_NO_PATH_TO_DESTINATION = 5,

    98

};

    99

   100

typedef struct VehicleAir {

   101

	uint16 crashed_counter;

   102

	byte pos;

   103

	byte previous_pos;

   104

	StationID targetairport;

   105

	byte state;

   106

} VehicleAir;

   107

   108

typedef struct VehicleRoad {

   109

	byte state;

   110

	byte frame;

   111

	uint16 blocked_ctr;

   112

	byte overtaking;

   113

	byte overtaking_ctr;

   114

	uint16 crashed_ctr;

   115

	byte reverse_ctr;

   116

	struct RoadStop *slot;

   117

	byte slot_age;

   118

} VehicleRoad;

   119

   120

typedef struct VehicleSpecial {

   121

	uint16 unk0;

   122

	byte unk2;

   123

} VehicleSpecial;

   124

   125

typedef struct VehicleDisaster {

   126

	uint16 image_override;

   127

	uint16 unk2;

   128

} VehicleDisaster;

   129

   130

typedef struct VehicleShip {

   131

	byte state;

   132

} VehicleShip;

   133

   134

   135

struct Vehicle {

   136

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

   137

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

   138

   139

	VehicleID index;         // NOSAVE: Index in vehicle array

   140

   141

	Vehicle *next;           // next

   142

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

   143

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

   144

   145

	StringID string_id;      // Displayed string

   146

   147

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

   148

	PlayerID owner;          // which player owns the vehicle?

   149

   150

	TileIndex tile;          // Current tile index

   151

	TileIndex dest_tile;     // Heading for this tile

   152

   153

	int32 x_pos;             // coordinates

   154

	int32 y_pos;

   155

	byte z_pos;

   156

	byte direction;          // facing

   157

   158

	byte spritenum;          // currently displayed sprite index

   159

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

   160

	                         // 0xff == reserved for another custom sprite

   161

	uint16 cur_image;        // sprite number for this vehicle

   162

	byte sprite_width;       // width of vehicle sprite

   163

	byte sprite_height;      // height of vehicle sprite

   164

	byte z_height;           // z-height of vehicle sprite

   165

	int8 x_offs;             // x offset for vehicle sprite

   166

	int8 y_offs;             // y offset for vehicle sprite

   167

	EngineID engine_type;

   168

   169

	// for randomized variational spritegroups

   170

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

   171

	// of corresponding spritegroups get matched

   172

	byte random_bits;

   173

	byte waiting_triggers;   // triggers to be yet matched

   174

   175

	uint16 max_speed;        // maximum speed

   176

	uint16 cur_speed;        // current speed

   177

	byte subspeed;           // fractional speed

   178

	byte acceleration;       // used by train & aircraft

   179

	byte progress;

   180

	uint32 motion_counter;

   181

   182

	byte vehstatus;          // Status

   183

	StationID last_station_visited;

   184

   185

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

   186

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

   187

	StationID cargo_source;  // source of cargo

   188

	uint16 cargo_cap;        // total capacity

   189

	uint16 cargo_count;      // how many pieces are used

   190

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

   191

   192

	byte day_counter;        // increased by one for each day

   193

	byte tick_counter;       // increased by one for each tick

   194

   195

	/* Begin Order-stuff */

   196

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

   197

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

   198

   199

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

   200

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

   201

   202

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

   203

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

   204

	/* End Order-stuff */

   205

   206

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

   207

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

   208

	int32 left_coord;

   209

	int32 top_coord;

   210

	int32 right_coord;

   211

	int32 bottom_coord;

   212

	VehicleID next_hash;

   213

   214

	// Related to age and service time

   215

	Date age;     // Age in days

   216

	Date max_age; // Maximum age

   217

	Date date_of_last_service;

   218

	Date service_interval;

   219

	uint16 reliability;

   220

	uint16 reliability_spd_dec;

   221

	byte breakdown_ctr;

   222

	byte breakdown_delay;

   223

	byte breakdowns_since_last_service;

   224

	byte breakdown_chance;

   225

	Year build_year;

   226

   227

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

   228

   229

	uint16 load_unload_time_rem;

   230

   231

	int32 profit_this_year;

   232

	int32 profit_last_year;

   233

	uint32 value;

   234

   235

	union {

   236

		VehicleRail rail;

   237

		VehicleAir air;

   238

		VehicleRoad road;

   239

		VehicleSpecial special;

   240

		VehicleDisaster disaster;

   241

		VehicleShip ship;

   242

	} u;

   243

};

   244

   245

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

   246

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

   247

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

   248

   249

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

   250

   251

void VehicleServiceInDepot(Vehicle *v);

   252

Vehicle *AllocateVehicle(void);

   253

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

   254

Vehicle *ForceAllocateVehicle(void);

   255

Vehicle *ForceAllocateSpecialVehicle(void);

   256

void VehiclePositionChanged(Vehicle *v);

   257

void AfterLoadVehicles(void);

   258

Vehicle *GetLastVehicleInChain(Vehicle *v);

   259

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   260

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   261

uint CountVehiclesInChain(const Vehicle* v);

   262

bool IsEngineCountable(const Vehicle *v);

   263

void DeleteVehicleChain(Vehicle *v);

   264

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

   265

void CallVehicleTicks(void);

   266

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   267

   268

void InitializeTrains(void);

   269

byte VehicleRandomBits(void);

   270

   271

bool CanFillVehicle(Vehicle *v);

   272

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

   273

CargoID FindFirstRefittableCargo(EngineID engine_type);

   274

int32 GetRefitCost(EngineID engine_type);

   275

   276

void ViewportAddVehicles(DrawPixelInfo *dpi);

   277

   278

/* train_cmd.h */

   279

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

   280

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

   281

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

   282

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

   283

   284

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

   285

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

   286

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

   287

   288

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

   289

   290

StringID VehicleInTheWayErrMsg(const Vehicle* v);

   291

Vehicle *FindVehicleBetween(TileIndex from, TileIndex to, byte z);

   292

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   293

   294

bool UpdateSignalsOnSegment(TileIndex tile, DiagDirection direction);

   295

void SetSignalsOnBothDir(TileIndex tile, byte track);

   296

   297

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

   298

   299

void DecreaseVehicleValue(Vehicle *v);

   300

void CheckVehicleBreakdown(Vehicle *v);

   301

void AgeVehicle(Vehicle *v);

   302

void VehicleEnteredDepotThisTick(Vehicle *v);

   303

   304

void BeginVehicleMove(Vehicle *v);

   305

void EndVehicleMove(Vehicle *v);

   306

   307

void ShowAircraftViewWindow(const Vehicle* v);

   308

   309

UnitID GetFreeUnitNumber(byte type);

   310

   311

int LoadUnloadVehicle(Vehicle *v);

   312

   313

void TrainConsistChanged(Vehicle *v);

   314

void TrainPowerChanged(Vehicle *v);

   315

int32 GetTrainRunningCost(const Vehicle *v);

   316

   317

int CheckTrainStoppedInDepot(const Vehicle *v);

   318

   319

bool VehicleNeedsService(const Vehicle *v);

   320

   321

uint GenerateVehicleSortList(const Vehicle*** sort_list, uint16 *length_of_array, byte type, PlayerID owner, StationID station, OrderID order, uint16 depot_airport_index, uint16 window_type);

   322

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);

   323

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

   324

bool IsVehicleInDepot(const Vehicle *v);

   325

void VehicleEnterDepot(Vehicle *v);

   326

   327

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

   328

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

   329

enum {

   330

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

   331

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

   332

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

   333

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

   334

};

   335

   336

typedef struct GetNewVehiclePosResult {

   337

	int x,y;

   338

	TileIndex old_tile;

   339

	TileIndex new_tile;

   340

} GetNewVehiclePosResult;

   341

   342

/**

   343

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

   344

 * Works for trains and ships.

   345

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

   346

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

   347

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

   348

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

   349

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

   350

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

   351

 * in depots), returns 0xFF.

   352

 */

   353

Trackdir GetVehicleTrackdir(const Vehicle* v);

   354

   355

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

   356

bool GetNewVehiclePos(const Vehicle *v, GetNewVehiclePosResult *gp);

   357

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

   358

   359

#define BEGIN_ENUM_WAGONS(v) do {

   360

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

   361

   362

DECLARE_POOL(Vehicle, Vehicle, 9, 125)

   363

   364

static inline VehicleID GetVehicleArraySize(void)

   365

{

   366

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

   367

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

   368

	 *  _really_ returns the highest index + 1. Now it just returns

   369

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

   370

	 */

   371

	return GetVehiclePoolSize();

   372

}

   373

   374

/**

   375

 * Check if a Vehicle really exists.

   376

 */

   377

static inline bool IsValidVehicle(const Vehicle *v)

   378

{

   379

	return v->type != 0;

   380

}

   381

   382

void DestroyVehicle(Vehicle *v);

   383

   384

static inline void DeleteVehicle(Vehicle *v)

   385

{

   386

	DestroyVehicle(v);

   387

	v->type = 0;

   388

}

   389

   390

#define FOR_ALL_VEHICLES_FROM(v, start) for (v = GetVehicle(start); v != NULL; v = (v->index + 1U < GetVehiclePoolSize()) ? GetVehicle(v->index + 1) : NULL) if (IsValidVehicle(v))

   391

#define FOR_ALL_VEHICLES(v) FOR_ALL_VEHICLES_FROM(v, 0)

   392

   393

/**

   394

 * Check if an index is a vehicle-index (so between 0 and max-vehicles)

   395

 *

   396

 * @return Returns true if the vehicle-id is in range

   397

 */

   398

static inline bool IsValidVehicleID(uint index)

   399

{

   400

	return index < GetVehiclePoolSize() && IsValidVehicle(GetVehicle(index));

   401

}

   402

   403

/* Returns order 'index' of a vehicle or NULL when it doesn't exists */

   404

static inline Order *GetVehicleOrder(const Vehicle *v, int index)

   405

{

   406

	Order *order = v->orders;

   407

   408

	if (index < 0) return NULL;

   409

   410

	while (order != NULL && index-- > 0)

   411

		order = order->next;

   412

   413

	return order;

   414

}

   415

   416

/* Returns the last order of a vehicle, or NULL if it doesn't exists */

   417

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   418

{

   419

	Order *order = v->orders;

   420

   421

	if (order == NULL) return NULL;

   422

   423

	while (order->next != NULL)

   424

		order = order->next;

   425

   426

	return order;

   427

}

   428

   429

/* Get the first vehicle of a shared-list, so we only have to walk forwards */

   430

static inline Vehicle *GetFirstVehicleFromSharedList(const Vehicle *v)

   431

{

   432

	Vehicle *u = (Vehicle *)v;

   433

	while (u->prev_shared != NULL) u = u->prev_shared;

   434

   435

	return u;

   436

}

   437

   438

// NOSAVE: Return values from various commands.

   439

VARDEF VehicleID _new_vehicle_id;

   440

VARDEF uint16 _returned_refit_capacity;

   441

   442

enum {

   443

	INVALID_VEHICLE = 0xFFFF,

   444

};

   445

   446

/**

   447

 * Get the colour map for an engine. This used for unbuilt engines in the user interface.

   448

 * @param engine_type ID of engine

   449

 * @param player ID of player

   450

 * @return A ready-to-use palette modifier

   451

 */

   452

PalSpriteID GetEnginePalette(EngineID engine_type, PlayerID player);

   453

   454

/**

   455

 * Get the colour map for a vehicle.

   456

 * @param v Vehicle to get colour map for

   457

 * @return A ready-to-use palette modifier

   458

 */

   459

PalSpriteID GetVehiclePalette(const Vehicle *v);

   460

   461

/* A lot of code calls for the invalidation of the status bar, which is widget 5.

   462

 * Best is to have a virtual value for it when it needs to change again */

   463

#define STATUS_BAR 5

   464

   465

extern const uint32 _send_to_depot_proc_table[];

   466

#define CMD_SEND_TO_DEPOT(x) _send_to_depot_proc_table[ x - VEH_Train]

   467

   468

#endif /* VEHICLE_H */