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

    97

typedef struct VehicleAir {

    98

	uint16 crashed_counter;

    99

	byte pos;

   100

	byte previous_pos;

   101

	StationID targetairport;

   102

	byte state;

   103

} VehicleAir;

   104

   105

typedef struct VehicleRoad {

   106

	byte state;

   107

	byte frame;

   108

	uint16 blocked_ctr;

   109

	byte overtaking;

   110

	byte overtaking_ctr;

   111

	uint16 crashed_ctr;

   112

	byte reverse_ctr;

   113

	struct RoadStop *slot;

   114

	byte slot_age;

   115

} VehicleRoad;

   116

   117

typedef struct VehicleSpecial {

   118

	uint16 unk0;

   119

	byte unk2;

   120

} VehicleSpecial;

   121

   122

typedef struct VehicleDisaster {

   123

	uint16 image_override;

   124

	uint16 unk2;

   125

} VehicleDisaster;

   126

   127

typedef struct VehicleShip {

   128

	byte state;

   129

} VehicleShip;

   130

   131

   132

struct Vehicle {

   133

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

   134

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

   135

   136

	VehicleID index;         // NOSAVE: Index in vehicle array

   137

   138

	Vehicle *next;           // next

   139

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

   140

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

   141

   142

	StringID string_id;      // Displayed string

   143

   144

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

   145

	PlayerID owner;          // which player owns the vehicle?

   146

   147

	TileIndex tile;          // Current tile index

   148

	TileIndex dest_tile;     // Heading for this tile

   149

   150

	int32 x_pos;             // coordinates

   151

	int32 y_pos;

   152

	byte z_pos;

   153

	byte direction;          // facing

   154

   155

	byte spritenum;          // currently displayed sprite index

   156

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

   157

	                         // 0xff == reserved for another custom sprite

   158

	uint16 cur_image;        // sprite number for this vehicle

   159

	byte sprite_width;       // width of vehicle sprite

   160

	byte sprite_height;      // height of vehicle sprite

   161

	byte z_height;           // z-height of vehicle sprite

   162

	int8 x_offs;             // x offset for vehicle sprite

   163

	int8 y_offs;             // y offset for vehicle sprite

   164

	EngineID engine_type;

   165

   166

	// for randomized variational spritegroups

   167

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

   168

	// of corresponding spritegroups get matched

   169

	byte random_bits;

   170

	byte waiting_triggers;   // triggers to be yet matched

   171

   172

	uint16 max_speed;        // maximum speed

   173

	uint16 cur_speed;        // current speed

   174

	byte subspeed;           // fractional speed

   175

	byte acceleration;       // used by train & aircraft

   176

	byte progress;

   177

   178

	byte vehstatus;          // Status

   179

	StationID last_station_visited;

   180

   181

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

   182

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

   183

	StationID cargo_source;  // source of cargo

   184

	uint16 cargo_cap;        // total capacity

   185

	uint16 cargo_count;      // how many pieces are used

   186

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

   187

   188

	byte day_counter;        // increased by one for each day

   189

	byte tick_counter;       // increased by one for each tick

   190

   191

	/* Begin Order-stuff */

   192

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

   193

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

   194

   195

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

   196

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

   197

   198

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

   199

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

   200

	/* End Order-stuff */

   201

   202

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

   203

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

   204

	int32 left_coord;

   205

	int32 top_coord;

   206

	int32 right_coord;

   207

	int32 bottom_coord;

   208

	VehicleID next_hash;

   209

   210

	// Related to age and service time

   211

	Date age;     // Age in days

   212

	Date max_age; // Maximum age

   213

	Date date_of_last_service;

   214

	Date service_interval;

   215

	uint16 reliability;

   216

	uint16 reliability_spd_dec;

   217

	byte breakdown_ctr;

   218

	byte breakdown_delay;

   219

	byte breakdowns_since_last_service;

   220

	byte breakdown_chance;

   221

	Year build_year;

   222

   223

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

   224

   225

	uint16 load_unload_time_rem;

   226

   227

	int32 profit_this_year;

   228

	int32 profit_last_year;

   229

	uint32 value;

   230

   231

	union {

   232

		VehicleRail rail;

   233

		VehicleAir air;

   234

		VehicleRoad road;

   235

		VehicleSpecial special;

   236

		VehicleDisaster disaster;

   237

		VehicleShip ship;

   238

	} u;

   239

};

   240

   241

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

   242

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

   243

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

   244

   245

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

   246

   247

void VehicleServiceInDepot(Vehicle *v);

   248

Vehicle *AllocateVehicle(void);

   249

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

   250

Vehicle *ForceAllocateVehicle(void);

   251

Vehicle *ForceAllocateSpecialVehicle(void);

   252

void VehiclePositionChanged(Vehicle *v);

   253

void AfterLoadVehicles(void);

   254

Vehicle *GetLastVehicleInChain(Vehicle *v);

   255

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   256

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   257

uint CountVehiclesInChain(const Vehicle* v);

   258

void DeleteVehicleChain(Vehicle *v);

   259

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

   260

void CallVehicleTicks(void);

   261

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   262

   263

void InitializeTrains(void);

   264

byte VehicleRandomBits(void);

   265

   266

bool CanFillVehicle(Vehicle *v);

   267

bool CanRefitTo(EngineID engine_type, CargoID cid_to);

   268

CargoID FindFirstRefittableCargo(EngineID engine_type);

   269

   270

void ViewportAddVehicles(DrawPixelInfo *dpi);

   271

   272

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   273

   274

/* train_cmd.h */

   275

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

   276

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

   277

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

   278

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

   279

   280

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

   281

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

   282

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

   283

   284

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

   285

   286

StringID VehicleInTheWayErrMsg(const Vehicle* v);

   287

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

   288

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   289

   290

bool UpdateSignalsOnSegment(TileIndex tile, DiagDirection direction);

   291

void SetSignalsOnBothDir(TileIndex tile, byte track);

   292

   293

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

   294

   295

void DecreaseVehicleValue(Vehicle *v);

   296

void CheckVehicleBreakdown(Vehicle *v);

   297

void AgeVehicle(Vehicle *v);

   298

void VehicleEnteredDepotThisTick(Vehicle *v);

   299

   300

void BeginVehicleMove(Vehicle *v);

   301

void EndVehicleMove(Vehicle *v);

   302

   303

void ShowAircraftViewWindow(const Vehicle* v);

   304

   305

UnitID GetFreeUnitNumber(byte type);

   306

   307

int LoadUnloadVehicle(Vehicle *v);

   308

   309

void TrainConsistChanged(Vehicle *v);

   310

void TrainPowerChanged(Vehicle *v);

   311

int32 GetTrainRunningCost(const Vehicle *v);

   312

   313

int CheckTrainStoppedInDepot(const Vehicle *v);

   314

   315

bool VehicleNeedsService(const Vehicle *v);

   316

   317

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

   318

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

   319

   320

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

   321

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

   322

enum {

   323

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

   324

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

   325

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

   326

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

   327

};

   328

   329

typedef struct GetNewVehiclePosResult {

   330

	int x,y;

   331

	TileIndex old_tile;

   332

	TileIndex new_tile;

   333

} GetNewVehiclePosResult;

   334

   335

/**

   336

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

   337

 * Works for trains and ships.

   338

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

   339

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

   340

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

   341

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

   342

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

   343

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

   344

 * in depots), returns 0xFF.

   345

 */

   346

Trackdir GetVehicleTrackdir(const Vehicle* v);

   347

   348

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

   349

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

   350

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

   351

   352

#define BEGIN_ENUM_WAGONS(v) do {

   353

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

   354

   355

extern MemoryPool _vehicle_pool;

   356

   357

/**

   358

 * Get the pointer to the vehicle with index 'index'

   359

 */

   360

static inline Vehicle *GetVehicle(VehicleID index)

   361

{

   362

	return (Vehicle*)GetItemFromPool(&_vehicle_pool, index);

   363

}

   364

   365

/**

   366

 * Get the current size of the VehiclePool

   367

 */

   368

static inline uint16 GetVehiclePoolSize(void)

   369

{

   370

	return _vehicle_pool.total_items;

   371

}

   372

   373

static inline VehicleID GetVehicleArraySize(void)

   374

{

   375

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

   376

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

   377

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

   378

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

   379

	 */

   380

	return GetVehiclePoolSize();

   381

}

   382

   383

/**

   384

 * Check if a Vehicle really exists.

   385

 */

   386

static inline bool IsValidVehicle(const Vehicle *v)

   387

{

   388

	return v->type != 0;

   389

}

   390

   391

void DestroyVehicle(Vehicle *v);

   392

   393

static inline void DeleteVehicle(Vehicle *v)

   394

{

   395

	DestroyVehicle(v);

   396

	v->type = 0;

   397

}

   398

   399

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

   400

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

   401

   402

/**

   403

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

   404

 *

   405

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

   406

 */

   407

static inline bool IsValidVehicleID(uint index)

   408

{

   409

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

   410

}

   411

   412

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

   413

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

   414

{

   415

	Order *order = v->orders;

   416

   417

	if (index < 0) return NULL;

   418

   419

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

   420

		order = order->next;

   421

   422

	return order;

   423

}

   424

   425

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

   426

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   427

{

   428

	Order *order = v->orders;

   429

   430

	if (order == NULL) return NULL;

   431

   432

	while (order->next != NULL)

   433

		order = order->next;

   434

   435

	return order;

   436

}

   437

   438

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

   439

static inline Vehicle *GetFirstVehicleFromSharedList(const Vehicle *v)

   440

{

   441

	Vehicle *u = (Vehicle *)v;

   442

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

   443

   444

	return u;

   445

}

   446

   447

// NOSAVE: Return values from various commands.

   448

VARDEF VehicleID _new_vehicle_id;

   449

VARDEF uint16 _returned_refit_capacity;

   450

   451

enum {

   452

	INVALID_VEHICLE = 0xFFFF,

   453

};

   454

   455

/**

   456

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

   457

 * @param engine_type ID of engine

   458

 * @param player ID of player

   459

 * @return A ready-to-use palette modifier

   460

 */

   461

PalSpriteID GetEnginePalette(EngineID engine_type, PlayerID player);

   462

   463

/**

   464

 * Get the colour map for a vehicle.

   465

 * @param v Vehicle to get colour map for

   466

 * @return A ready-to-use palette modifier

   467

 */

   468

PalSpriteID GetVehiclePalette(const Vehicle *v);

   469

   470

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

   471

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

   472

#define STATUS_BAR 5

   473

   474

extern const uint32 _send_to_depot_proc_table[];

   475

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

   476

   477

#endif /* VEHICLE_H */