1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "pool.h"

     5

#include "vehicle_gui.h"

     6

#include "order.h"

     7

     8

typedef struct VehicleRail {

     9

	uint16 last_speed;		// NOSAVE: only used in UI

    10

	uint16 crash_anim_pos;

    11

	uint16 days_since_order_progr;

    12

    13

	uint16 cached_weight; // cached power and weight for the vehicle.

    14

	uint32 cached_power;  // no need to save those, they are recomputed on load.

    15

    16

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

    17

	// 0xffff == not in train

    18

	uint16 first_engine;

    19

    20

	byte track;

    21

	byte force_proceed;

    22

	byte railtype;

    23

    24

	byte flags;

    25

} VehicleRail;

    26

    27

enum {

    28

	VRF_REVERSING = 0,

    29

    30

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

    31

	VRF_GOINGUP   = 1,

    32

	VRF_GOINGDOWN = 2,

    33

};

    34

    35

typedef struct VehicleAir {

    36

	uint16 crashed_counter;

    37

	byte pos;

    38

  byte previous_pos;

    39

	uint16 targetairport;

    40

	byte state;

    41

} VehicleAir;

    42

    43

typedef struct VehicleRoad {

    44

	byte state;

    45

	byte frame;

    46

	uint16 unk2;

    47

	byte overtaking;

    48

	byte overtaking_ctr;

    49

	uint16 crashed_ctr;

    50

	byte reverse_ctr;

    51

	struct RoadStop *slot;

    52

	byte slotindex;

    53

	byte slot_age;

    54

} VehicleRoad;

    55

    56

typedef struct VehicleSpecial {

    57

	uint16 unk0;

    58

	byte unk2;

    59

} VehicleSpecial;

    60

    61

typedef struct VehicleDisaster {

    62

	uint16 image_override;

    63

	uint16 unk2;

    64

} VehicleDisaster;

    65

    66

typedef struct VehicleShip {

    67

	byte state;

    68

} VehicleShip;

    69

    70

// not used ATM

    71

struct WorldSprite {

    72

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

    73

	uint16 image;			// sprite number for this vehicle

    74

    75

	// screen coordinates

    76

	int16 left, top, right, bottom;

    77

    78

	// world coordinates

    79

	int16 x;

    80

	int16 y;

    81

	byte z;

    82

    83

	int8 x_offs;			// x offset for vehicle sprite

    84

	int8 y_offs;			// y offset for vehicle sprite

    85

    86

	byte width;				// width of vehicle sprite

    87

	byte height;			// height of vehicle sprite

    88

	byte depth;				// depth of vehicle sprite

    89

    90

	byte flags;				// draw flags

    91

};

    92

    93

struct Vehicle {

    94

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

    95

	byte subtype;			// subtype (for trains, 0 == loco, 4 wagon ??)

    96

    97

	uint16 index;			// NOSAVE: Index in vehicle array

    98

    99

	Vehicle *next;		// next

   101

   102

	StringID string_id; // Displayed string

   103

   104

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

   105

	byte owner;				// which player owns the vehicle?

   106

   107

	TileIndex tile;		// Current tile index

   108

	TileIndex dest_tile; // Heading for this tile

   109

   110

	int32 x_pos;			// coordinates

   111

	int32 y_pos;

   112

	byte z_pos;

   113

	byte direction;		// facing

   114

   115

	byte spritenum; // currently displayed sprite index

   116

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

   117

	                // 0xff == reserved for another custom sprite

   118

	uint16 cur_image; // sprite number for this vehicle

   119

	byte sprite_width;// width of vehicle sprite

   120

	byte sprite_height;// height of vehicle sprite

   121

	byte z_height;		// z-height of vehicle sprite

   122

	int8 x_offs;			// x offset for vehicle sprite

   123

	int8 y_offs;			// y offset for vehicle sprite

   124

	uint16 engine_type;

   125

   126

	// for randomized variational spritegroups

   127

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

   128

	// of corresponding spritegroups get matched

   129

	byte random_bits;

   130

	byte waiting_triggers; // triggers to be yet matched

   131

   132

	uint16 max_speed;	// maximum speed

   133

	uint16 cur_speed;	// current speed

   134

	byte subspeed;		// fractional speed

   135

	byte acceleration; // used by train & aircraft

   136

	byte progress;

   137

   138

	byte vehstatus;		// Status

   139

	uint16 last_station_visited;

   140

   141

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

   142

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

   143

	uint16 cargo_source;// source of cargo

   144

	uint16 cargo_cap;	// total capacity

   145

	uint16 cargo_count;// how many pieces are used

   146

   147

	byte day_counter; // increased by one for each day

   148

	byte tick_counter;// increased by one for each tick

   149

   150

	/* Begin Order-stuff */

   151

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

   152

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

   153

   154

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

   155

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

   156

   157

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

   158

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

   159

	/* End Order-stuff */

   160

   161

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

   162

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

   163

	int32 left_coord;

   164

	int32 top_coord;

   165

	int32 right_coord;

   166

	int32 bottom_coord;

   167

	uint16 next_hash;

   168

   169

	// Related to age and service time

   170

	uint16 age;				// Age in days

   171

	uint16 max_age;		// Maximum age

   172

	uint16 date_of_last_service;

   173

	uint16 service_interval;

   174

	uint16 reliability;

   175

	uint16 reliability_spd_dec;

   176

	byte breakdown_ctr;

   177

	byte breakdown_delay;

   178

	byte breakdowns_since_last_service;

   179

	byte breakdown_chance;

   180

	byte build_year;

   181

   182

	uint16 load_unload_time_rem;

   183

   184

	int32 profit_this_year;

   185

	int32 profit_last_year;

   186

	uint32 value;

   187

   188

	union {

   189

		VehicleRail rail;

   190

		VehicleAir air;

   191

		VehicleRoad road;

   192

		VehicleSpecial special;

   193

		VehicleDisaster disaster;

   194

		VehicleShip ship;

   195

	} u;

   196

};

   197

   198

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

   199

#define is_custom_firsthead_sprite(x) (x == 0xfd)

   200

#define is_custom_secondhead_sprite(x) (x == 0xfe)

   201

   202

enum {

   203

	VEH_Train = 0x10,

   204

	VEH_Road = 0x11,

   205

	VEH_Ship = 0x12,

   206

	VEH_Aircraft = 0x13,

   207

	VEH_Special = 0x14,

   208

	VEH_Disaster = 0x15,

   209

};

   210

   211

enum VehStatus {

   212

	VS_HIDDEN = 1,

   213

	VS_STOPPED = 2,

   214

	VS_UNCLICKABLE = 4,

   215

	VS_DEFPAL = 0x8,

   216

	VS_TRAIN_SLOWING = 0x10,

   217

	VS_DISASTER = 0x20,

   218

	VS_AIRCRAFT_BROKEN = 0x40,

   219

	VS_CRASHED = 0x80,

   220

};

   221

   222

// 1 and 3 do not appear to be used

   223

enum TrainSubtype {

   224

	TS_Front_Engine = 0,

   225

	TS_Not_First = 2,

   226

	TS_Free_Car = 4,

   227

};

   228

   229

/* Effect vehicle types */

   230

typedef enum EffectVehicle {

   231

	EV_CHIMNEY_SMOKE   = 0,

   232

	EV_STEAM_SMOKE     = 1,

   233

	EV_DIESEL_SMOKE    = 2,

   234

	EV_ELECTRIC_SPARK  = 3,

   235

	EV_SMOKE           = 4,

   236

	EV_EXPLOSION_LARGE = 5,

   237

	EV_BREAKDOWN_SMOKE = 6,

   238

	EV_EXPLOSION_SMALL = 7,

   239

	EV_BULLDOZER       = 8,

   240

	EV_BUBBLE          = 9

   241

} EffectVehicle;

   242

   243

typedef void VehicleTickProc(Vehicle *v);

   244

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

   245

   246

void VehicleServiceInDepot(Vehicle *v);

   247

Vehicle *AllocateVehicle(void);

   248

Vehicle *ForceAllocateVehicle(void);

   249

Vehicle *ForceAllocateSpecialVehicle(void);

   250

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

   251

void VehiclePositionChanged(Vehicle *v);

   252

void AfterLoadVehicles(void);

   253

Vehicle *GetLastVehicleInChain(Vehicle *v);

   254

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   255

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   256

int CountVehiclesInChain(Vehicle *v);

   257

void DeleteVehicle(Vehicle *v);

   258

void DeleteVehicleChain(Vehicle *v);

   259

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

   260

void CallVehicleTicks(void);

   261

   262

void InitializeTrains(void);

   263

   264

bool CanFillVehicle(Vehicle *v);

   265

   266

void ViewportAddVehicles(DrawPixelInfo *dpi);

   267

   268

void TrainEnterDepot(Vehicle *v, uint tile);

   269

   270

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

   271

   272

/* train_cmd.h */

   273

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

   274

int GetAircraftImage(Vehicle *v, byte direction);

   275

int GetRoadVehImage(Vehicle *v, byte direction);

   276

int GetShipImage(Vehicle *v, byte direction);

   277

   278

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

   279

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

   280

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

   281

   282

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

   283

   284

void VehicleInTheWayErrMsg(Vehicle *v);

   285

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

   286

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   287

   288

bool UpdateSignalsOnSegment(uint tile, byte direction);

   289

void SetSignalsOnBothDir(uint tile, byte track);

   290

   291

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

   292

//uint GetVehicleWeight(Vehicle *v);

   293

   294

void DecreaseVehicleValue(Vehicle *v);

   295

void CheckVehicleBreakdown(Vehicle *v);

   296

void AgeVehicle(Vehicle *v);

   297

void MaybeReplaceVehicle(Vehicle *v);

   298

   299

void BeginVehicleMove(Vehicle *v);

   300

void EndVehicleMove(Vehicle *v);

   301

   302

bool IsAircraftHangarTile(TileIndex tile);

   303

void ShowAircraftViewWindow(Vehicle *v);

   304

   305

UnitID GetFreeUnitNumber(byte type);

   306

   307

int LoadUnloadVehicle(Vehicle *v);

   308

   309

void UpdateTrainAcceleration(Vehicle *v);

   310

int32 GetTrainRunningCost(Vehicle *v);

   311

   312

int CheckTrainStoppedInDepot(const Vehicle *v);

   313

   314

bool VehicleNeedsService(const Vehicle *v);

   315

   316

typedef struct GetNewVehiclePosResult {

   317

	int x,y;

   318

	uint old_tile;

   319

	uint new_tile;

   320

} GetNewVehiclePosResult;

   321

   322

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

   323

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

   324

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

   325

   326

#define BEGIN_ENUM_WAGONS(v) do {

   327

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

   328

   329

/* vehicle.c */

   330

VARDEF SortStruct *_vehicle_sort;

   331

   332

extern MemoryPool _vehicle_pool;

   333

   334

/**

   335

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

   336

 */

   337

static inline Vehicle *GetVehicle(VehicleID index)

   338

{

   339

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

   340

}

   341

   342

/**

   343

 * Get the current size of the VehiclePool

   344

 */

   345

static inline uint16 GetVehiclePoolSize(void)

   346

{

   347

	return _vehicle_pool.total_items;

   348

}

   349

   350

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

   351

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

   352

   353

/**

   354

 * Check if a Vehicle really exists.

   355

 */

   356

static inline bool IsValidVehicle(Vehicle* v)

   357

{

   358

	return v->type != 0;

   359

}

   360

   361

/**

   362

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

   363

 *

   364

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

   365

 */

   366

static inline bool IsVehicleIndex(uint index)

   367

{

   368

	if (index < GetVehiclePoolSize())

   369

		return true;

   370

   371

	return false;

   372

}

   373

   374

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

   375

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

   376

{

   377

	Order *order = v->orders;

   378

   379

	if (index < 0)

   380

		return NULL;

   381

   382

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

   383

		order = order->next;

   384

   385

	return order;

   386

}

   387

   388

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

   389

static inline Order *GetLastVehicleOrder(const Vehicle *v)

   390

{

   391

	Order *order = v->orders;

   392

   393

	if (order == NULL)

   394

		return NULL;

   395

   396

	while (order->next != NULL)

   397

		order = order->next;

   398

   399

	return order;

   400

}

   401

   402

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

   403

static inline Vehicle *GetFirstVehicleFromSharedList(Vehicle *v)

   404

{

   405

	Vehicle *u = v;

   406

	while (u->prev_shared != NULL)

   407

		u = u->prev_shared;

   408

   409

	return u;

   410

}

   411

   412

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

   413

VARDEF VehicleID _vehicle_position_hash[0x1000];

   414

   415

// NOSAVE: Return values from various commands.

   416

VARDEF VehicleID _new_train_id;

   417

VARDEF VehicleID _new_wagon_id;

   418

VARDEF VehicleID _new_aircraft_id;

   419

VARDEF VehicleID _new_ship_id;

   420

VARDEF VehicleID _new_roadveh_id;

   421

VARDEF uint16 _aircraft_refit_capacity;

   422

VARDEF byte _cmd_build_rail_veh_score;

   423

VARDEF byte _cmd_build_rail_veh_var1;

   424

   425

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

   426

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

   427

   428

#define INVALID_VEHICLE 0xffff

   429

   430

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

   431

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

   432

#define STATUS_BAR 5

   433

   434

#endif /* VEHICLE_H */