1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "vehicle_gui.h"

     5

     6

typedef struct Order {

     8

	uint8 type:4;

     9

	uint8 flags:4;

    14

	uint8 station;

    15

} Order;

    16

    17

static inline uint16 PackOrder(const Order *order)

    18

{

    19

	return order->station << 8 | order->flags << 4 | order->type;

    20

}

    21

    22

static inline Order UnpackOrder(uint16 packed)

    23

{

    28

	return order;

    29

}

    30

    31

typedef struct VehicleRail {

    32

	uint16 last_speed;		// NOSAVE: only used in UI

    33

	uint16 crash_anim_pos;

    34

	uint16 days_since_order_progr;

    35

    36

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

    37

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

    38

    39

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

    40

	// 0xffff == not in train

    41

	uint16 first_engine;

    42

    43

	byte track;

    44

	byte force_proceed;

    45

	byte railtype;

    46

    47

	byte flags;

    48

} VehicleRail;

    49

    50

enum {

    51

	VRF_REVERSING = 1,

    52

    53

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

    54

	VRF_GOINGUP = 2,

    55

	VRF_GOINGDOWN = 4,

    56

};

    57

    58

typedef struct VehicleAir {

    59

	uint16 crashed_counter;

    60

	byte pos;

    61

  byte previous_pos;

    62

	byte targetairport;

    63

	byte state;

    64

} VehicleAir;

    65

    66

typedef struct VehicleRoad {

    67

	byte state;

    68

	byte frame;

    69

	uint16 unk2;

    70

	byte overtaking;

    71

	byte overtaking_ctr;

    72

	uint16 crashed_ctr;

    73

	byte reverse_ctr;

    74

} VehicleRoad;

    75

    76

typedef struct VehicleSpecial {

    77

	uint16 unk0;

    78

	byte unk2;

    79

} VehicleSpecial;

    80

    81

typedef struct VehicleDisaster {

    82

	uint16 image_override;

    83

	uint16 unk2;

    84

} VehicleDisaster;

    85

    86

typedef struct VehicleShip {

    87

	byte state;

    88

} VehicleShip;

    89

    90

// not used ATM

    91

struct WorldSprite {

    92

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

    93

	uint16 image;			// sprite number for this vehicle

    94

    95

	// screen coordinates

    96

	int16 left, top, right, bottom;

    97

    98

	// world coordinates

    99

	int16 x;

   100

	int16 y;

   101

	byte z;

   102

   103

	int8 x_offs;			// x offset for vehicle sprite

   104

	int8 y_offs;			// y offset for vehicle sprite

   105

   106

	byte width;				// width of vehicle sprite

   107

	byte height;			// height of vehicle sprite

   108

	byte depth;				// depth of vehicle sprite

   109

   110

	byte flags;				// draw flags

   111

};

   112

   113

struct Vehicle {

   114

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

   115

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

   116

   117

	uint16 index;			// NOSAVE: Index in vehicle array

   118

	uint16 next_in_chain_old; // Next vehicle index for chained vehicles

   119

   120

	Vehicle *next;		// next

   121

   122

	StringID string_id; // Displayed string

   123

   124

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

   125

	byte owner;				// which player owns the vehicle?

   126

   127

	TileIndex tile;		// Current tile index

   128

	TileIndex dest_tile; // Heading for this tile

   129

   130

	int16 x_pos;			// coordinates

   131

	int16 y_pos;

   132

	byte z_pos;

   133

	byte direction;		// facing

   134

   135

	byte spritenum; // currently displayed sprite index

   136

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

   137

	                // 0xff == reserved for another custom sprite

   138

	uint16 cur_image; // sprite number for this vehicle

   139

	byte sprite_width;// width of vehicle sprite

   140

	byte sprite_height;// height of vehicle sprite

   141

	byte z_height;		// z-height of vehicle sprite

   142

	int8 x_offs;			// x offset for vehicle sprite

   143

	int8 y_offs;			// y offset for vehicle sprite

   144

	uint16 engine_type;

   145

   146

	// for randomized variational spritegroups

   147

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

   148

	// of corresponding spritegroups get matched

   149

	byte random_bits;

   150

	byte waiting_triggers; // triggers to be yet matched

   151

   152

	uint16 max_speed;	// maximum speed

   153

	uint16 cur_speed;	// current speed

   154

	byte subspeed;		// fractional speed

   155

	byte acceleration; // used by train & aircraft

   156

	byte progress;

   157

   158

	byte vehstatus;		// Status

   159

	byte last_station_visited;

   160

   161

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

   162

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

   163

	byte cargo_source;// source of cargo

   164

	uint16 cargo_cap;	// total capacity

   165

	uint16 cargo_count;// how many pieces are used

   166

   167

	byte day_counter; // increased by one for each day

   168

	byte tick_counter;// increased by one for each tick

   169

   170

	// related to the current order

   171

	byte cur_order_index;

   172

	byte num_orders;

   173

	Order current_order;

   174

	Order *schedule_ptr;

   175

   176

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

   177

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

   178

	int16 left_coord, top_coord, right_coord, bottom_coord;

   179

	uint16 next_hash;

   180

   181

	// Related to age and service time

   182

	uint16 age;				// Age in days

   183

	uint16 max_age;		// Maximum age

   184

	uint16 date_of_last_service;

   185

	uint16 service_interval;

   186

	uint16 reliability;

   187

	uint16 reliability_spd_dec;

   188

	byte breakdown_ctr;

   189

	byte breakdown_delay;

   190

	byte breakdowns_since_last_service;

   191

	byte breakdown_chance;

   192

	byte build_year;

   193

   194

	uint16 load_unload_time_rem;

   195

   196

	int32 profit_this_year;

   197

	int32 profit_last_year;

   198

	uint32 value;

   199

   200

	union {

   201

		VehicleRail rail;

   202

		VehicleAir air;

   203

		VehicleRoad road;

   204

		VehicleSpecial special;

   205

		VehicleDisaster disaster;

   206

		VehicleShip ship;

   207

	} u;

   208

};

   209

   210

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

   211

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

   212

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

   213

   214

struct Depot {

   215

	TileIndex xy;

   216

	uint16 town_index;

   217

};

   218

   219

// train waypoint

   220

struct Waypoint {

   221

	TileIndex xy;

   222

	uint16 town_or_string; // if this is 0xC000, it's a string id, otherwise a town.

   223

	ViewportSign sign;

   224

	uint16 build_date;

   225

	byte stat_id;

   226

	byte deleted;					 // this is a delete counter. when it reaches 0, the waypoint struct is deleted.

   227

};

   228

   229

enum {

   230

	VEH_Train = 0x10,

   231

	VEH_Road = 0x11,

   232

	VEH_Ship = 0x12,

   233

	VEH_Aircraft = 0x13,

   234

	VEH_Special = 0x14,

   235

	VEH_Disaster = 0x15,

   236

};

   237

   238

/* Order types */

   239

enum {

   240

	OT_NOTHING = 0,

   241

	OT_GOTO_STATION = 1,

   242

	OT_GOTO_DEPOT = 2,

   243

	OT_LOADING = 3,

   244

	OT_LEAVESTATION = 4,

   245

	OT_DUMMY = 5,

   246

	OT_GOTO_WAYPOINT = 6,

   247

};

   248

   249

/* Order flags */

   250

enum {

   251

	OF_UNLOAD    = 0x2,

   252

	OF_FULL_LOAD = 0x4, // Also used when to force an aircraft into a depot

   253

	OF_NON_STOP  = 0x8

   254

};

   255

   256

   257

enum VehStatus {

   258

	VS_HIDDEN = 1,

   259

	VS_STOPPED = 2,

   260

	VS_UNCLICKABLE = 4,

   261

	VS_DEFPAL = 0x8,

   262

	VS_TRAIN_SLOWING = 0x10,

   263

	VS_DISASTER = 0x20,

   264

	VS_AIRCRAFT_BROKEN = 0x40,

   265

	VS_CRASHED = 0x80,

   266

};

   267

   268

   269

   270

/* Effect vehicle types */

   271

enum {

   272

	EV_INDUSTRYSMOKE = 0,

   273

	EV_STEAM_SMOKE = 1,

   274

   275

	EV_SMOKE_1 = 2,

   276

	EV_SMOKE_2 = 3,

   277

	EV_SMOKE_3 = 4,

   278

   279

	EV_CRASHED_SMOKE = 5,

   280

	EV_BREAKDOWN_SMOKE = 6,

   281

   282

	EV_DEMOLISH = 7,

   283

	EV_ROADWORK = 8,

   284

   285

	EV_INDUSTRY_SMOKE = 9,

   286

   287

};

   288

   289

typedef void VehicleTickProc(Vehicle *v);

   290

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

   291

   292

typedef struct {

   293

	VehicleID clone;

   294

	byte orderindex;

   295

	Order order[41];

   296

	uint16 service_interval;

   297

	char name[32];

   298

} BackuppedOrders;

   299

   300

void BackupVehicleOrders(Vehicle *v, BackuppedOrders *order);

   301

void RestoreVehicleOrders(Vehicle *v, BackuppedOrders *order);

   302

Vehicle *AllocateVehicle();

   303

Vehicle *ForceAllocateVehicle();

   304

Vehicle *ForceAllocateSpecialVehicle();

   305

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

   306

void InitializeVehicles();

   307

void VehiclePositionChanged(Vehicle *v);

   308

void AfterLoadVehicles();

   309

Vehicle *GetLastVehicleInChain(Vehicle *v);

   310

Vehicle *GetPrevVehicleInChain(Vehicle *v);

   311

Vehicle *GetFirstVehicleInChain(Vehicle *v);

   312

int CountVehiclesInChain(Vehicle *v);

   313

void DeleteVehicle(Vehicle *v);

   314

void DeleteVehicleChain(Vehicle *v);

   315

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

   316

void CallVehicleTicks();

   317

void DeleteVehicleSchedule(Vehicle *v);

   318

Vehicle *IsScheduleShared(Vehicle *v);

   319

   320

Depot *AllocateDepot();

   321

Waypoint *AllocateWaypoint();

   322

void UpdateWaypointSign(Waypoint *cp);

   323

void RedrawWaypointSign(Waypoint *cp);

   324

   325

void InitializeTrains();

   326

bool IsTrainDepotTile(TileIndex tile);

   327

bool IsRoadDepotTile(TileIndex tile);

   328

   329

bool CanFillVehicle(Vehicle *v);

   330

   331

void ViewportAddVehicles(DrawPixelInfo *dpi);

   332

   333

void TrainEnterDepot(Vehicle *v, uint tile);

   334

   335

/* train_cmd.h */

   336

int GetTrainImage(Vehicle *v, byte direction);

   337

int GetAircraftImage(Vehicle *v, byte direction);

   338

int GetRoadVehImage(Vehicle *v, byte direction);

   339

int GetShipImage(Vehicle *v, byte direction);

   340

   341

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

   342

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

   343

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

   344

   345

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

   346

   347

void VehicleInTheWayErrMsg(Vehicle *v);

   348

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

   349

uint GetVehicleOutOfTunnelTile(Vehicle *v);

   350

   351

bool UpdateSignalsOnSegment(uint tile, byte direction);

   352

void SetSignalsOnBothDir(uint tile, byte track);

   353

   354

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

   355

//uint GetVehicleWeight(Vehicle *v);

   356

   357

void DecreaseVehicleValue(Vehicle *v);

   358

void CheckVehicleBreakdown(Vehicle *v);

   359

void AgeVehicle(Vehicle *v);

   360

void MaybeRenewVehicle(Vehicle *v, int32 build_cost);

   361

   362

void DeleteCommandFromVehicleSchedule(Order cmd);

   363

   364

void BeginVehicleMove(Vehicle *v);

   365

void EndVehicleMove(Vehicle *v);

   366

   367

bool IsAircraftHangarTile(TileIndex tile);

   368

void ShowAircraftViewWindow(Vehicle *v);

   369

   370

void InvalidateVehicleOrderWidget(Vehicle *v);

   371

   372

bool IsShipDepotTile(TileIndex tile);

   373

uint GetFreeUnitNumber(byte type);

   374

   375

int LoadUnloadVehicle(Vehicle *v);

   376

int GetDepotByTile(uint tile);

   377

uint GetWaypointByTile(uint tile);

   378

   379

void DoDeleteDepot(uint tile);

   380

   381

void UpdateTrainAcceleration(Vehicle *v);

   382

int32 GetTrainRunningCost(Vehicle *v);

   383

   384

int CheckStoppedInDepot(Vehicle *v);

   385

   386

int ScheduleHasDepotOrders(const Order *schedule);

   387

int CheckOrders(Vehicle *v);

   388

   389

typedef struct GetNewVehiclePosResult {

   390

	int x,y;

   391

	uint old_tile;

   392

	uint new_tile;

   393

} GetNewVehiclePosResult;

   394

   395

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

   396

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

   397

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

   398

   399

#define BEGIN_ENUM_WAGONS(v) do {

   400

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

   401

   402

#define DEREF_VEHICLE(i) (&_vehicles[i])

   403

#define FOR_ALL_VEHICLES(v) for(v=_vehicles; v != endof(_vehicles); v++)

   404

   405

/* vehicle.c */

   406

enum {

   407

	NUM_NORMAL_VEHICLES = 2048,

   408

	NUM_SPECIAL_VEHICLES = 512,

   409

	NUM_VEHICLES = NUM_NORMAL_VEHICLES + NUM_SPECIAL_VEHICLES

   410

};

   411

   412

VARDEF Vehicle _vehicles[NUM_VEHICLES];

   413

   414

VARDEF Order _order_array[5000];

   415

VARDEF Order *_ptr_to_next_order;

   416

   417

VARDEF Depot _depots[255];

   418

   419

// 128 waypoints

   420

VARDEF Waypoint _waypoints[128];

   421

   422

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

   423

VARDEF VehicleID _vehicle_position_hash[0x1000];

   424

   425

// NOSAVE: Return values from various commands.

   426

VARDEF VehicleID _new_train_id;

   427

VARDEF VehicleID _new_wagon_id;

   428

VARDEF VehicleID _new_aircraft_id;

   429

VARDEF VehicleID _new_ship_id;

   430

VARDEF VehicleID _new_roadveh_id;

   431

VARDEF uint16 _aircraft_refit_capacity;

   432

VARDEF byte _cmd_build_rail_veh_score;

   433

VARDEF byte _cmd_build_rail_veh_var1;

   434

   435

// NOSAVE: Player specific info

   436

VARDEF TileIndex _last_built_train_depot_tile;

   437

VARDEF TileIndex _last_built_road_depot_tile;

   438

VARDEF TileIndex _last_built_aircraft_depot_tile;

   439

VARDEF TileIndex _last_built_ship_depot_tile;

   440

VARDEF TileIndex _backup_orders_tile;

   441

VARDEF BackuppedOrders _backup_orders_data[1];

   442

   443

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

   444

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

   445

   446

#define INVALID_VEHICLE 0xffff

   447

   448

#define SERVICE_INTERVAL (_patches.servint_ispercent ? (v->reliability > _engines[v->engine_type].reliability * (100 - v->service_interval) / 100) : (v->date_of_last_service + v->service_interval > _date))

   449

#define MIN_SERVINT_PERCENT  5

   450

#define MAX_SERVINT_PERCENT 90

   451

#define MIN_SERVINT_DAYS    30

   452

#define MAX_SERVINT_DAYS   800

   453

   454

#endif /* VEHICLE_H */