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_Train = 0x10,

    12

	VEH_Road = 0x11,

    13

	VEH_Ship = 0x12,

    14

	VEH_Aircraft = 0x13,

    15

	VEH_Special = 0x14,

    16

	VEH_Disaster = 0x15,

    17

} ;

    18

    19

enum VehStatus {

    20

	VS_HIDDEN = 1,

    21

	VS_STOPPED = 2,

    22

	VS_UNCLICKABLE = 4,

    23

	VS_DEFPAL = 0x8,

    24

	VS_TRAIN_SLOWING = 0x10,

    25

	VS_DISASTER = 0x20,

    26

	VS_AIRCRAFT_BROKEN = 0x40,

    27

	VS_CRASHED = 0x80,

    28

};

    29

    30

// 1 and 3 do not appear to be used

    31

typedef enum TrainSubtypes {

    32

	TS_Front_Engine = 0, // Leading engine of a train

    33

	TS_Not_First = 2,    // Wagon or additional engine

    34

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

    35

} TrainSubtype;

    36

    37

/* Effect vehicle types */

    38

typedef enum EffectVehicle {

    39

	EV_CHIMNEY_SMOKE   = 0,

    40

	EV_STEAM_SMOKE     = 1,

    41

	EV_DIESEL_SMOKE    = 2,

    42

	EV_ELECTRIC_SPARK  = 3,

    43

	EV_SMOKE           = 4,

    44

	EV_EXPLOSION_LARGE = 5,

    45

	EV_BREAKDOWN_SMOKE = 6,

    46

	EV_EXPLOSION_SMALL = 7,

    47

	EV_BULLDOZER       = 8,

    48

	EV_BUBBLE          = 9

    49

} EffectVehicle;

    50

    51

typedef struct VehicleRail {

    52

	uint16 last_speed;		// NOSAVE: only used in UI

    53

	uint16 crash_anim_pos;

    54

	uint16 days_since_order_progr;

    55

    56

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

    57

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

    58

	uint32 cached_power;      // total power of the consist.

    59

	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

    60

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

    61

	uint16 cached_weight;     // total weight of the consist.

    62

	uint16 cached_veh_weight; // weight of the vehicle.

    63

    64

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

    65

	// 0xffff == not in train

    66

	EngineID first_engine;

    67

    68

	byte track;

    69

	byte force_proceed;

    70

	byte railtype;

    71

    72

	byte flags;

    73

    74

	byte pbs_status;

    75

	TileIndex pbs_end_tile;

    76

	Trackdir pbs_end_trackdir;

    77

} VehicleRail;

    78

    79

enum {

    80

	VRF_REVERSING = 0,

    81

    82

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

    83

	VRF_GOINGUP   = 1,

    84

	VRF_GOINGDOWN = 2,

    85

    86

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

    87

	VRF_POWEREDWAGON = 3,

    88

};

    89

    90

typedef struct VehicleAir {

    91

	uint16 crashed_counter;

    92

	byte pos;

    93

  byte previous_pos;

    94

	uint16 targetairport;

    95

	byte state;

    96

} VehicleAir;

    97

    98

typedef struct VehicleRoad {

    99

	byte state;

   100

	byte frame;

   101

	uint16 unk2;

   102

	byte overtaking;

   103

	byte overtaking_ctr;

   104

	uint16 crashed_ctr;

   105

	byte reverse_ctr;

   106

	struct RoadStop *slot;

   107

	byte slotindex;

   108

	byte slot_age;

   109

} VehicleRoad;

   110

   111

typedef struct VehicleSpecial {

   112

	uint16 unk0;

   113

	byte unk2;

   114

} VehicleSpecial;

   115

   116

typedef struct VehicleDisaster {

   117

	uint16 image_override;

   118

	uint16 unk2;

   119

} VehicleDisaster;

   120

   121

typedef struct VehicleShip {

   122

	byte state;

   123

} VehicleShip;

   124

   125

// not used ATM

   126

struct WorldSprite {

   127

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

   128

	uint16 image;			// sprite number for this vehicle

   129

   130

	// screen coordinates

   131

	int16 left, top, right, bottom;

   132

   133

	// world coordinates

   134

	int16 x;

   135

	int16 y;

   136

	byte z;

   137

   138

	int8 x_offs;			// x offset for vehicle sprite

   139

	int8 y_offs;			// y offset for vehicle sprite

   140

   141

	byte width;				// width of vehicle sprite

   142

	byte height;			// height of vehicle sprite

   143

	byte depth;				// depth of vehicle sprite

   144

   145

	byte flags;				// draw flags

   146

};

   147

   148

struct Vehicle {

   149

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

   150

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

   151

   152

	VehicleID index;	// NOSAVE: Index in vehicle array

   153

   154

	Vehicle *next;		// next

   155

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

   156

   157

	StringID string_id; // Displayed string

   158

   159

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

   160

	PlayerID owner;				// which player owns the vehicle?

   161

   162

	TileIndex tile;		// Current tile index

   163

	TileIndex dest_tile; // Heading for this tile

   164

   165

	int32 x_pos;			// coordinates

   166

	int32 y_pos;

   167

	byte z_pos;

   168

	byte direction;		// facing

   169

   170

	byte spritenum; // currently displayed sprite index

   171

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

   172

	                // 0xff == reserved for another custom sprite

   173

	uint16 cur_image; // sprite number for this vehicle

   174

	byte sprite_width;// width of vehicle sprite

   175

	byte sprite_height;// height of vehicle sprite

   176

	byte z_height;		// z-height of vehicle sprite

   177

	int8 x_offs;			// x offset for vehicle sprite

   178

	int8 y_offs;			// y offset for vehicle sprite

   179

	EngineID engine_type;

   180

   181

	// for randomized variational spritegroups

   182

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

   183

	// of corresponding spritegroups get matched

   184

	byte random_bits;

   185

	byte waiting_triggers; // triggers to be yet matched

   186

   187

	uint16 max_speed;	// maximum speed

   188

	uint16 cur_speed;	// current speed

   189

	byte subspeed;		// fractional speed

   190

	byte acceleration; // used by train & aircraft

   191

	byte progress;

   192

   193

	byte vehstatus;		// Status

   194

	uint16 last_station_visited;

   195

   196

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

   197

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

   198

	uint16 cargo_source;// source of cargo

   199

	uint16 cargo_cap;	// total capacity

   200

	uint16 cargo_count;// how many pieces are used

   201

   202

	byte day_counter; // increased by one for each day

   203

	byte tick_counter;// increased by one for each tick

   204

   205

	/* Begin Order-stuff */

   206

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

   207

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

   208

   209

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

   210

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

   211

   212

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

   213

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

   214

	/* End Order-stuff */

   215

   216

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

   217

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

   218

	int32 left_coord;

   219

	int32 top_coord;

   220

	int32 right_coord;

   221

	int32 bottom_coord;

   222

	uint16 next_hash;

   223

   224

	// Related to age and service time

   225

	uint16 age;				// Age in days

   226

	uint16 max_age;		// Maximum age

   227

	uint16 date_of_last_service;

   228

	uint16 service_interval;

   229

	uint16 reliability;

   230

	uint16 reliability_spd_dec;

   231

	byte breakdown_ctr;

   232

	byte breakdown_delay;

   233

	byte breakdowns_since_last_service;

   234

	byte breakdown_chance;

   235

	byte build_year;

   236

   237

	uint16 load_unload_time_rem;

   238

   239

	int32 profit_this_year;

   240

	int32 profit_last_year;

   241

	uint32 value;

   242

   243

	union {

   244

		VehicleRail rail;

   245

		VehicleAir air;

   246

		VehicleRoad road;

   247

		VehicleSpecial special;

   248

		VehicleDisaster disaster;

   249

		VehicleShip ship;

   250

	} u;

   251

};

   252

   253

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

   254

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

   255

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

   256

   257

typedef void VehicleTickProc(Vehicle *v);

   258

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

   259

   260

void VehicleServiceInDepot(Vehicle *v);

   261

Vehicle *AllocateVehicle(void);

   262

Vehicle *ForceAllocateVehicle(void);

   263

Vehicle *ForceAllocateSpecialVehicle(void);

   264

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

   265

void VehiclePositionChanged(Vehicle *v);

   266

void AfterLoadVehicles(void);

   267

Vehicle *GetLastVehicleInChain(Vehicle *v);

   268

Vehicle *GetPrevVehicleInChain(const Vehicle *v);

   269

Vehicle *GetFirstVehicleInChain(const Vehicle *v);

   270

int CountVehiclesInChain(Vehicle *v);

   271

void DeleteVehicle(Vehicle *v);

   272

void DeleteVehicleChain(Vehicle *v);

   273

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

   274

void CallVehicleTicks(void);

   275

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z);

   276

   277

void InitializeTrains(void);

   278

   279

bool CanFillVehicle(Vehicle *v);

   280

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

   281

   282

void ViewportAddVehicles(DrawPixelInfo *dpi);

   283

   284

void TrainEnterDepot(Vehicle *v, TileIndex tile);

   285

   286

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

   287

   288

/* train_cmd.h */

   289

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

   290

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

   291

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

   292

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

   293

   294

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

   295

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

   296

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

   297

   298

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

   299

   300

void VehicleInTheWayErrMsg(Vehicle *v);

   301

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

   302

TileIndex GetVehicleOutOfTunnelTile(const Vehicle *v);

   303

   304

bool UpdateSignalsOnSegment(TileIndex tile, byte direction);

   305

void SetSignalsOnBothDir(TileIndex tile, byte track);

   306

   307

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

   308

//uint GetVehicleWeight(Vehicle *v);

   309

   310

void DecreaseVehicleValue(Vehicle *v);

   311

void CheckVehicleBreakdown(Vehicle *v);

   312

void AgeVehicle(Vehicle *v);

   313

void MaybeReplaceVehicle(Vehicle *v);

   314

   315

void BeginVehicleMove(Vehicle *v);

   316

void EndVehicleMove(Vehicle *v);

   317

   318

bool IsAircraftHangarTile(TileIndex tile);

   319

void ShowAircraftViewWindow(Vehicle *v);

   320

   321

UnitID GetFreeUnitNumber(byte type);

   322

   323

int LoadUnloadVehicle(Vehicle *v);

   324

   325

void TrainConsistChanged(Vehicle *v);

   326

void UpdateTrainAcceleration(Vehicle *v);

   327

int32 GetTrainRunningCost(const Vehicle *v);

   328

   329

int CheckTrainStoppedInDepot(const Vehicle *v);

   330

   331

bool VehicleNeedsService(const Vehicle *v);

   332

   333

typedef struct GetNewVehiclePosResult {

   334

	int x,y;

   335

	TileIndex old_tile;

   336

	TileIndex new_tile;

   337

} GetNewVehiclePosResult;

   338

   339

/**

   340

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

   341

 * Works for trains and ships.

   342

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

   343

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

   344

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

   345

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

   346

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

   347

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

   348

 * in depots), returns 0xFF.

   349

 */

   350

Trackdir GetVehicleTrackdir(const Vehicle* v);

   351

   352

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

   355

   356

#define BEGIN_ENUM_WAGONS(v) do {

   357

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

   358

   359

/* vehicle.c */

   360

VARDEF SortStruct *_vehicle_sort;

   361

   362

extern MemoryPool _vehicle_pool;

   363

   364

/**

   365

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

   366

 */

   367

static inline Vehicle *GetVehicle(VehicleID index)

   368

{

   369

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

   370

}

   371

   372

/**

   373

 * Get the current size of the VehiclePool

   374

 */

   375

static inline uint16 GetVehiclePoolSize(void)

   376

{

   377

	return _vehicle_pool.total_items;

   378

}

   379

   380

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

   381

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

   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

/**

   392

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

   393

 *

   394

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

   395

 */

   396

static inline bool IsVehicleIndex(uint index)

   397

{

   398

	if (index < GetVehiclePoolSize()) return true;

   399

   400

	return false;

   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(Vehicle *v)

   431

{

   432

	Vehicle *u = v;

   433

	while (u->prev_shared != NULL)

   434

		u = u->prev_shared;

   435

   436

	return u;

   437

}

   438

   439

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

   440

VARDEF VehicleID _vehicle_position_hash[0x1000];

   441

   442

// NOSAVE: Return values from various commands.

   443

VARDEF VehicleID _new_train_id;

   444

VARDEF VehicleID _new_wagon_id;

   445

VARDEF VehicleID _new_aircraft_id;

   446

VARDEF VehicleID _new_ship_id;

   447

VARDEF VehicleID _new_roadveh_id;

   448

VARDEF uint16 _aircraft_refit_capacity;

   449

VARDEF byte _cmd_build_rail_veh_score;

   450

VARDEF byte _cmd_build_rail_veh_var1;

   451

   452

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

   453

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

   454

   455

#define INVALID_VEHICLE 0xFFFF

   456

#define INVALID_ENGINE 0xFFFF

   457

   458

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

   459

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

   460

#define STATUS_BAR 5

   461

   462

#endif /* VEHICLE_H */