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;

    73

} VehicleRail;

    74

    75

enum {

    76

	VRF_REVERSING = 0,

    77

    78

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

    79

	VRF_GOINGUP   = 1,

    80

	VRF_GOINGDOWN = 2,

    81

    82

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

    83

	VRF_POWEREDWAGON = 3,

    84

};

    85

    86

typedef struct VehicleAir {

    87

	uint16 crashed_counter;

    88

	byte pos;

    89

  byte previous_pos;

    90

	uint16 targetairport;

    91

	byte state;

    92

} VehicleAir;

    93

    94

typedef struct VehicleRoad {

    95

	byte state;

    96

	byte frame;

    97

	uint16 unk2;

    98

	byte overtaking;

    99

	byte overtaking_ctr;

   100

	uint16 crashed_ctr;

   101

	byte reverse_ctr;

   102

	struct RoadStop *slot;

   103

	byte slotindex;

   104

	byte slot_age;

   105

} VehicleRoad;

   106

   107

typedef struct VehicleSpecial {

   108

	uint16 unk0;

   109

	byte unk2;

   110

} VehicleSpecial;

   111

   112

typedef struct VehicleDisaster {

   113

	uint16 image_override;

   114

	uint16 unk2;

   115

} VehicleDisaster;

   116

   117

typedef struct VehicleShip {

   118

	byte state;

   119

} VehicleShip;

   120

   121

// not used ATM

   122

struct WorldSprite {

   123

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

   124

	uint16 image;			// sprite number for this vehicle

   125

   126

	// screen coordinates

   127

	int16 left, top, right, bottom;

   128

   129

	// world coordinates

   130

	int16 x;

   131

	int16 y;

   132

	byte z;

   133

   134

	int8 x_offs;			// x offset for vehicle sprite

   135

	int8 y_offs;			// y offset for vehicle sprite

   136

   137

	byte width;				// width of vehicle sprite

   138

	byte height;			// height of vehicle sprite

   139

	byte depth;				// depth of vehicle sprite

   140

   141

	byte flags;				// draw flags

   142

};

   143

   144

struct Vehicle {

   145

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

   146

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

   147

   148

	VehicleID index;	// NOSAVE: Index in vehicle array

   149

   150

	Vehicle *next;		// next

   151

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

   152

   153

	StringID string_id; // Displayed string

   154

   155

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

   156

	PlayerID owner;				// which player owns the vehicle?

   157

   158

	TileIndex tile;		// Current tile index

   159

	TileIndex dest_tile; // Heading for this tile

   160

   161

	int32 x_pos;			// coordinates

   162

	int32 y_pos;

   163

	byte z_pos;

   164

	byte direction;		// facing

   165

   166

	byte spritenum; // currently displayed sprite index

   167

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

   168

	                // 0xff == reserved for another custom sprite

   169

	uint16 cur_image; // sprite number for this vehicle

   170

	byte sprite_width;// width of vehicle sprite

   171

	byte sprite_height;// height of vehicle sprite

   172

	byte z_height;		// z-height of vehicle sprite

   173

	int8 x_offs;			// x offset for vehicle sprite

   174

	int8 y_offs;			// y offset for vehicle sprite

   175

	EngineID engine_type;

   176

   177

	// for randomized variational spritegroups

   178

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

   179

	// of corresponding spritegroups get matched

   180

	byte random_bits;

   181

	byte waiting_triggers; // triggers to be yet matched

   182

   183

	uint16 max_speed;	// maximum speed

   184

	uint16 cur_speed;	// current speed

   185

	byte subspeed;		// fractional speed

   186

	byte acceleration; // used by train & aircraft

   187

	byte progress;

   188

   189

	byte vehstatus;		// Status

   190

	uint16 last_station_visited;

   191

   192

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

   193

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

   194

	uint16 cargo_source;// source of cargo

   195

	uint16 cargo_cap;	// total capacity

   196

	uint16 cargo_count;// how many pieces are used

   197

   198

	byte day_counter; // increased by one for each day

   199

	byte tick_counter;// increased by one for each tick

   200

   201

	/* Begin Order-stuff */

   202

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

   203

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

   204

   205

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

   206

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

   207

   208

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

   209

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

   210

	/* End Order-stuff */

   211

   212

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

   213

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

   214

	int32 left_coord;

   215

	int32 top_coord;

   216

	int32 right_coord;

   217

	int32 bottom_coord;

   218

	uint16 next_hash;

   219

   220

	// Related to age and service time

   221

	uint16 age;				// Age in days

   222

	uint16 max_age;		// Maximum age

   223

	uint16 date_of_last_service;

   224

	uint16 service_interval;

   225

	uint16 reliability;

   226

	uint16 reliability_spd_dec;

   227

	byte breakdown_ctr;

   228

	byte breakdown_delay;

   229

	byte breakdowns_since_last_service;

   230

	byte breakdown_chance;

   231

	byte build_year;

   232

   233

	uint16 load_unload_time_rem;

   234

   235

	int32 profit_this_year;

   236

	int32 profit_last_year;

   237

	uint32 value;

   238

   239

	union {

   240

		VehicleRail rail;

   241

		VehicleAir air;

   242

		VehicleRoad road;

   243

		VehicleSpecial special;

   244

		VehicleDisaster disaster;

   245

		VehicleShip ship;

   246

	} u;

   247

};

   248

   249

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

   250

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

   251

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

   252

   253

typedef void VehicleTickProc(Vehicle *v);

   254

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

   255

   256

void VehicleServiceInDepot(Vehicle *v);

   257

Vehicle *AllocateVehicle(void);

   258

Vehicle *ForceAllocateVehicle(void);

   259

Vehicle *ForceAllocateSpecialVehicle(void);

   260

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

   261

void VehiclePositionChanged(Vehicle *v);

   262

void AfterLoadVehicles(void);

   263

Vehicle *GetLastVehicleInChain(Vehicle *v);

   264

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   265

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   266

int CountVehiclesInChain(Vehicle *v);

   267

void DeleteVehicle(Vehicle *v);

   268

void DeleteVehicleChain(Vehicle *v);

   269

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

   270

void CallVehicleTicks(void);

   271

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   272

   273

void InitializeTrains(void);

   274

   275

bool CanFillVehicle(Vehicle *v);

   276

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

   277

   278

void ViewportAddVehicles(DrawPixelInfo *dpi);

   279

   280

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   281

   282

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

   283

   284

/* train_cmd.h */

   285

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

   286

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

   287

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

   288

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

   289

   290

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

   291

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

   292

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

   293

   294

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

   295

   296

void VehicleInTheWayErrMsg(Vehicle *v);

   297

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

   298

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   299

   300

bool UpdateSignalsOnSegment(TileIndex tile, byte direction);

   301

void SetSignalsOnBothDir(TileIndex tile, byte track);

   302

   303

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

   304

//uint GetVehicleWeight(Vehicle *v);

   305

   306

void DecreaseVehicleValue(Vehicle *v);

   307

void CheckVehicleBreakdown(Vehicle *v);

   308

void AgeVehicle(Vehicle *v);

   309

void MaybeReplaceVehicle(Vehicle *v);

   310

   311

void BeginVehicleMove(Vehicle *v);

   312

void EndVehicleMove(Vehicle *v);

   313

   314

bool IsAircraftHangarTile(TileIndex tile);

   315

void ShowAircraftViewWindow(Vehicle *v);

   316

   317

UnitID GetFreeUnitNumber(byte type);

   318

   319

int LoadUnloadVehicle(Vehicle *v);

   320

   321

void TrainConsistChanged(Vehicle *v);

   322

void UpdateTrainAcceleration(Vehicle *v);

   323

int32 GetTrainRunningCost(const Vehicle *v);

   324

   325

int CheckTrainStoppedInDepot(const Vehicle *v);

   326

   327

bool VehicleNeedsService(const Vehicle *v);

   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(Vehicle *v, GetNewVehiclePosResult *gp);

   350

byte GetDirectionTowards(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

/* vehicle.c */

   356

VARDEF SortStruct *_vehicle_sort;

   357

   358

extern MemoryPool _vehicle_pool;

   359

   360

/**

   361

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

   362

 */

   363

static inline Vehicle *GetVehicle(VehicleID index)

   364

{

   365

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

   366

}

   367

   368

/**

   369

 * Get the current size of the VehiclePool

   370

 */

   371

static inline uint16 GetVehiclePoolSize(void)

   372

{

   373

	return _vehicle_pool.total_items;

   374

}

   375

   376

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

   377

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

   378

   379

/**

   380

 * Check if a Vehicle really exists.

   381

 */

   382

static inline bool IsValidVehicle(const Vehicle *v)

   383

{

   384

	return v->type != 0;

   385

}

   386

   387

/**

   388

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

   389

 *

   390

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

   391

 */

   392

static inline bool IsVehicleIndex(uint index)

   393

{

   394

	if (index < GetVehiclePoolSize()) return true;

   395

   396

	return false;

   397

}

   398

   399

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

   400

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

   401

{

   402

	Order *order = v->orders;

   403

   404

	if (index < 0) return NULL;

   405

   406

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

   407

		order = order->next;

   408

   409

	return order;

   410

}

   411

   412

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

   413

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   414

{

   415

	Order *order = v->orders;

   416

   417

	if (order == NULL) return NULL;

   418

   419

	while (order->next != NULL)

   420

		order = order->next;

   421

   422

	return order;

   423

}

   424

   425

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

   426

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   427

{

   428

	Vehicle *u = v;

   429

	while (u->prev_shared != NULL)

   430

		u = u->prev_shared;

   431

   432

	return u;

   433

}

   434

   435

/* Validate functions for rail building */

   436

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

   437

   438

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

   439

VARDEF VehicleID _vehicle_position_hash[0x1000];

   440

   441

// NOSAVE: Return values from various commands.

   442

VARDEF VehicleID _new_train_id;

   443

VARDEF VehicleID _new_wagon_id;

   444

VARDEF VehicleID _new_aircraft_id;

   445

VARDEF VehicleID _new_ship_id;

   446

VARDEF VehicleID _new_roadveh_id;

   447

VARDEF uint16 _aircraft_refit_capacity;

   448

VARDEF byte _cmd_build_rail_veh_score;

   449

VARDEF byte _cmd_build_rail_veh_var1;

   450

   451

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

   452

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

   453

   454

#define INVALID_VEHICLE 0xFFFF

   455

   456

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

   457

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

   458

#define STATUS_BAR 5

   459

   460

#endif /* VEHICLE_H */