1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "pool.h"

     5

#include "order.h"

     6

#include "rail.h"

     7

     8

enum {

     9

	VEH_Train = 0x10,

    10

	VEH_Road = 0x11,

    11

	VEH_Ship = 0x12,

    12

	VEH_Aircraft = 0x13,

    13

	VEH_Special = 0x14,

    14

	VEH_Disaster = 0x15,

    15

} ;

    16

    17

enum VehStatus {

    18

	VS_HIDDEN = 1,

    19

	VS_STOPPED = 2,

    20

	VS_UNCLICKABLE = 4,

    21

	VS_DEFPAL = 0x8,

    22

	VS_TRAIN_SLOWING = 0x10,

    23

	VS_DISASTER = 0x20,

    24

	VS_AIRCRAFT_BROKEN = 0x40,

    25

	VS_CRASHED = 0x80,

    26

};

    27

    28

// 1 and 3 do not appear to be used

    29

typedef enum TrainSubtypes {

    30

	TS_Front_Engine = 0, // Leading engine of a train

    31

	TS_Not_First = 2,    // Wagon or additional engine

    32

	TS_Free_Car = 4,     // First in a wagon chain (in depot)

    33

} TrainSubtype;

    34

    35

/* Effect vehicle types */

    36

typedef enum EffectVehicle {

    37

	EV_CHIMNEY_SMOKE   = 0,

    38

	EV_STEAM_SMOKE     = 1,

    39

	EV_DIESEL_SMOKE    = 2,

    40

	EV_ELECTRIC_SPARK  = 3,

    41

	EV_SMOKE           = 4,

    42

	EV_EXPLOSION_LARGE = 5,

    43

	EV_BREAKDOWN_SMOKE = 6,

    44

	EV_EXPLOSION_SMALL = 7,

    45

	EV_BULLDOZER       = 8,

    46

	EV_BUBBLE          = 9

    47

} EffectVehicle;

    48

    49

typedef struct VehicleRail {

    50

	uint16 last_speed;		// NOSAVE: only used in UI

    51

	uint16 crash_anim_pos;

    52

	uint16 days_since_order_progr;

    53

    54

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

    55

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

    56

	uint32 cached_power;      // total power of the consist.

    57

	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

    58

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

    59

	uint16 cached_weight;     // total weight of the consist.

    60

	uint16 cached_veh_weight; // weight of the vehicle.

    61

    62

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

    63

	// 0xffff == not in train

    64

	EngineID first_engine;

    65

    66

	byte track;

    67

	byte force_proceed;

    68

	byte railtype;

    69

    70

	byte flags;

    71

} VehicleRail;

    72

    73

enum {

    74

	VRF_REVERSING = 0,

    75

    76

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

    77

	VRF_GOINGUP   = 1,

    78

	VRF_GOINGDOWN = 2,

    79

    80

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

    81

	VRF_POWEREDWAGON = 3,

    82

};

    83

    84

typedef struct VehicleAir {

    85

	uint16 crashed_counter;

    86

	byte pos;

    87

  byte previous_pos;

    88

	uint16 targetairport;

    89

	byte state;

    90

} VehicleAir;

    91

    92

typedef struct VehicleRoad {

    93

	byte state;

    94

	byte frame;

    95

	uint16 unk2;

    96

	byte overtaking;

    97

	byte overtaking_ctr;

    98

	uint16 crashed_ctr;

    99

	byte reverse_ctr;

   100

	struct RoadStop *slot;

   101

	byte slotindex;

   102

	byte slot_age;

   103

} VehicleRoad;

   104

   105

typedef struct VehicleSpecial {

   106

	uint16 unk0;

   107

	byte unk2;

   108

} VehicleSpecial;

   109

   110

typedef struct VehicleDisaster {

   111

	uint16 image_override;

   112

	uint16 unk2;

   113

} VehicleDisaster;

   114

   115

typedef struct VehicleShip {

   116

	byte state;

   117

} VehicleShip;

   118

   119

// not used ATM

   120

struct WorldSprite {

   121

	struct WorldSprite *next;			// next sprite in hash chain

   122

	uint16 image;			// sprite number for this vehicle

   123

   124

	// screen coordinates

   125

	int16 left, top, right, bottom;

   126

   127

	// world coordinates

   128

	int16 x;

   129

	int16 y;

   130

	byte z;

   131

   132

	int8 x_offs;			// x offset for vehicle sprite

   133

	int8 y_offs;			// y offset for vehicle sprite

   134

   135

	byte width;				// width of vehicle sprite

   136

	byte height;			// height of vehicle sprite

   137

	byte depth;				// depth of vehicle sprite

   138

   139

	byte flags;				// draw flags

   140

};

   141

   142

struct Vehicle {

   143

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

   144

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

   145

   146

	VehicleID index;	// NOSAVE: Index in vehicle array

   147

   148

	Vehicle *next;		// next

   149

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

   150

   151

	StringID string_id; // Displayed string

   152

   153

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

   154

	PlayerID owner;				// which player owns the vehicle?

   155

   156

	TileIndex tile;		// Current tile index

   157

	TileIndex dest_tile; // Heading for this tile

   158

   159

	int32 x_pos;			// coordinates

   160

	int32 y_pos;

   161

	byte z_pos;

   162

	byte direction;		// facing

   163

   164

	byte spritenum; // currently displayed sprite index

   165

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

   166

	                // 0xff == reserved for another custom sprite

   167

	uint16 cur_image; // sprite number for this vehicle

   168

	byte sprite_width;// width of vehicle sprite

   169

	byte sprite_height;// height of vehicle sprite

   170

	byte z_height;		// z-height of vehicle sprite

   171

	int8 x_offs;			// x offset for vehicle sprite

   172

	int8 y_offs;			// y offset for vehicle sprite

   173

	EngineID engine_type;

   174

   175

	// for randomized variational spritegroups

   176

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

   177

	// of corresponding spritegroups get matched

   178

	byte random_bits;

   179

	byte waiting_triggers; // triggers to be yet matched

   180

   181

	uint16 max_speed;	// maximum speed

   182

	uint16 cur_speed;	// current speed

   183

	byte subspeed;		// fractional speed

   184

	byte acceleration; // used by train & aircraft

   185

	byte progress;

   186

   187

	byte vehstatus;		// Status

   188

	uint16 last_station_visited;

   189

   190

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

   191

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

   192

	uint16 cargo_source;// source of cargo

   193

	uint16 cargo_cap;	// total capacity

   194

	uint16 cargo_count;// how many pieces are used

   195

   196

	byte day_counter; // increased by one for each day

   197

	byte tick_counter;// increased by one for each tick

   198

   199

	/* Begin Order-stuff */

   200

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

   201

	OrderID cur_order_index; //! The index to the current order

   202

   203

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

   204

	OrderID num_orders;      //! How many orders there are in the list

   205

   206

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

   207

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

   208

	/* End Order-stuff */

   209

   210

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

   211

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

   212

	int32 left_coord;

   213

	int32 top_coord;

   214

	int32 right_coord;

   215

	int32 bottom_coord;

   216

	uint16 next_hash;

   217

   218

	// Related to age and service time

   219

	uint16 age;				// Age in days

   220

	uint16 max_age;		// Maximum age

   221

	uint16 date_of_last_service;

   222

	uint16 service_interval;

   223

	uint16 reliability;

   224

	uint16 reliability_spd_dec;

   225

	byte breakdown_ctr;

   226

	byte breakdown_delay;

   227

	byte breakdowns_since_last_service;

   228

	byte breakdown_chance;

   229

	byte build_year;

   230

   231

	uint16 load_unload_time_rem;

   232

   233

	int32 profit_this_year;

   234

	int32 profit_last_year;

   235

	uint32 value;

   236

   237

	union {

   238

		VehicleRail rail;

   239

		VehicleAir air;

   240

		VehicleRoad road;

   241

		VehicleSpecial special;

   242

		VehicleDisaster disaster;

   243

		VehicleShip ship;

   244

	} u;

   245

};

   246

   247

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

   248

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

   249

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

   250

   251

typedef void VehicleTickProc(Vehicle *v);

   252

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

   253

   254

void VehicleServiceInDepot(Vehicle *v);

   255

Vehicle *AllocateVehicle(void);

   256

Vehicle *ForceAllocateVehicle(void);

   257

Vehicle *ForceAllocateSpecialVehicle(void);

   258

void UpdateVehiclePosHash(Vehicle *v, int x, int y);

   259

void VehiclePositionChanged(Vehicle *v);

   260

void AfterLoadVehicles(void);

   261

Vehicle *GetLastVehicleInChain(Vehicle *v);

   262

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   263

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   264

int CountVehiclesInChain(Vehicle *v);

   265

void DeleteVehicle(Vehicle *v);

   266

void DeleteVehicleChain(Vehicle *v);

   267

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

   268

void CallVehicleTicks(void);

   269

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   270

   271

void InitializeTrains(void);

   272

   273

bool CanFillVehicle(Vehicle *v);

   274

bool CanRefitTo(const Vehicle *v, CargoID cid_to);

   275

   276

void ViewportAddVehicles(DrawPixelInfo *dpi);

   277

   278

void TrainEnterDepot(Vehicle *v, uint tile);

   279

   280

void AddRearEngineToMultiheadedTrain(Vehicle *v, Vehicle *u, bool building) ;

   281

   282

/* train_cmd.h */

   283

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

   284

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

   285

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

   286

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

   287

   288

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

   289

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

   290

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

   291

   292

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

   293

   294

void VehicleInTheWayErrMsg(Vehicle *v);

   295

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

   296

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   297

   298

bool UpdateSignalsOnSegment(uint tile, byte direction);

   299

void SetSignalsOnBothDir(uint tile, byte track);

   300

   301

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

   302

//uint GetVehicleWeight(Vehicle *v);

   303

   304

void DecreaseVehicleValue(Vehicle *v);

   305

void CheckVehicleBreakdown(Vehicle *v);

   306

void AgeVehicle(Vehicle *v);

   307

void MaybeReplaceVehicle(Vehicle *v);

   308

   309

void BeginVehicleMove(Vehicle *v);

   310

void EndVehicleMove(Vehicle *v);

   311

   312

bool IsAircraftHangarTile(TileIndex tile);

   313

void ShowAircraftViewWindow(Vehicle *v);

   314

   315

UnitID GetFreeUnitNumber(byte type);

   316

   317

int LoadUnloadVehicle(Vehicle *v);

   318

   319

void TrainConsistChanged(Vehicle *v);

   320

void UpdateTrainAcceleration(Vehicle *v);

   321

int32 GetTrainRunningCost(const Vehicle *v);

   322

   323

int CheckTrainStoppedInDepot(const Vehicle *v);

   324

   325

bool VehicleNeedsService(const Vehicle *v);

   326

   327

typedef struct GetNewVehiclePosResult {

   328

	int x,y;

   329

	uint old_tile;

   330

	uint new_tile;

   331

} GetNewVehiclePosResult;

   332

   333

/**

   334

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

   335

 * Works for trains and ships.

   336

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

   337

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

   338

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

   339

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

   340

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

   341

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

   342

 * in depots), returns 0xFF.

   343

 */

   344

Trackdir GetVehicleTrackdir(const Vehicle* v);

   345

   346

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

   347

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

   348

byte GetDirectionTowards(Vehicle *v, int x, int y);

   349

   350

#define BEGIN_ENUM_WAGONS(v) do {

   351

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

   352

   353

/* vehicle.c */

   354

VARDEF SortStruct *_vehicle_sort;

   355

   356

extern MemoryPool _vehicle_pool;

   357

   358

/**

   359

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

   360

 */

   361

static inline Vehicle *GetVehicle(VehicleID index)

   362

{

   363

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

   364

}

   365

   366

/**

   367

 * Get the current size of the VehiclePool

   368

 */

   369

static inline uint16 GetVehiclePoolSize(void)

   370

{

   371

	return _vehicle_pool.total_items;

   372

}

   373

   374

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

   375

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

   376

   377

/**

   378

 * Check if a Vehicle really exists.

   379

 */

   380

static inline bool IsValidVehicle(const Vehicle *v)

   381

{

   382

	return v->type != 0;

   383

}

   384

   385

/**

   386

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

   387

 *

   388

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

   389

 */

   390

static inline bool IsVehicleIndex(uint index)

   391

{

   392

	if (index < GetVehiclePoolSize()) return true;

   393

   394

	return false;

   395

}

   396

   397

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

   398

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

   399

{

   400

	Order *order = v->orders;

   401

   402

	if (index < 0) return NULL;

   403

   404

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

   405

		order = order->next;

   406

   407

	return order;

   408

}

   409

   410

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

   411

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   412

{

   413

	Order *order = v->orders;

   414

   415

	if (order == NULL) return NULL;

   416

   417

	while (order->next != NULL)

   418

		order = order->next;

   419

   420

	return order;

   421

}

   422

   423

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

   424

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   425

{

   426

	Vehicle *u = v;

   427

	while (u->prev_shared != NULL)

   428

		u = u->prev_shared;

   429

   430

	return u;

   431

}

   432

   433

/* Validate functions for rail building */

   434

static inline bool ValParamRailtype(uint32 rail) { return rail <= GetPlayer(_current_player)->max_railtype;}

   435

   436

// NOSAVE: Can be regenerated by inspecting the vehicles.

   437

VARDEF VehicleID _vehicle_position_hash[0x1000];

   438

   439

// NOSAVE: Return values from various commands.

   440

VARDEF VehicleID _new_train_id;

   441

VARDEF VehicleID _new_wagon_id;

   442

VARDEF VehicleID _new_aircraft_id;

   443

VARDEF VehicleID _new_ship_id;

   444

VARDEF VehicleID _new_roadveh_id;

   445

VARDEF uint16 _aircraft_refit_capacity;

   446

VARDEF byte _cmd_build_rail_veh_score;

   447

VARDEF byte _cmd_build_rail_veh_var1;

   448

   449

// for each player, for each vehicle type, keep a list of the vehicles.

   450

//VARDEF Vehicle *_vehicle_arr[8][4];

   451

   452

#define INVALID_VEHICLE 0xFFFF

   453

   454

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

   455

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

   456

#define STATUS_BAR 5

   457

   458

#endif /* VEHICLE_H */