1

#ifndef VEHICLE_H

     2

#define VEHICLE_H

     3

     4

#include "vehicle_gui.h"

     5

     6

typedef struct VehicleRail {

     7

	uint16 last_speed;		// NOSAVE: only used in UI

     8

	uint16 crash_anim_pos;

     9

	uint16 days_since_order_progr;

    10

    11

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

    12

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

    13

    14

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

    15

	// 0xffff == not in train

    16

	uint16 first_engine;

    17

    18

	byte track;

    19

	byte force_proceed;

    20

	byte railtype;

    21

    22

	byte flags;

    23

} VehicleRail;

    24

    25

enum {

    26

	VRF_REVERSING = 1,

    27

    28

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

    29

	VRF_GOINGUP = 2,

    30

	VRF_GOINGDOWN = 4,

    31

};

    32

    33

typedef struct VehicleAir {

    34

	uint16 crashed_counter;

    35

	byte pos;

    36

  byte previous_pos;

    37

	byte targetairport;

    38

	byte state;

    39

} VehicleAir;

    40

    41

typedef struct VehicleRoad {

    42

	byte state;

    43

	byte frame;

    44

	uint16 unk2;

    45

	byte overtaking;

    46

	byte overtaking_ctr;

    47

	uint16 crashed_ctr;

    48

	byte reverse_ctr;

    49

} VehicleRoad;

    50

    51

typedef struct VehicleSpecial {

    52

	uint16 unk0;

    53

	byte unk2;

    54

} VehicleSpecial;

    55

    56

typedef struct VehicleDisaster {

    57

	uint16 image_override;

    58

	uint16 unk2;

    59

} VehicleDisaster;

    60

    61

typedef struct VehicleShip {

    62

	byte state;

    63

} VehicleShip;

    64

    65

// not used ATM

    66

struct WorldSprite {

    67

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

    68

	uint16 image;			// sprite number for this vehicle

    69

    70

	// screen coordinates

    71

	int16 left, top, right, bottom;

    72

    73

	// world coordinates

    74

	int16 x;

    75

	int16 y;

    76

	byte z;

    77

    78

	int8 x_offs;			// x offset for vehicle sprite

    79

	int8 y_offs;			// y offset for vehicle sprite

    80

    81

	byte width;				// width of vehicle sprite

    82

	byte height;			// height of vehicle sprite

    83

	byte depth;				// depth of vehicle sprite

    84

    85

	byte flags;				// draw flags

    86

};

    87

    88

struct Vehicle {

    89

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

    90

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

    91

    92

	uint16 index;			// NOSAVE: Index in vehicle array

    93

	uint16 next_in_chain_old; // Next vehicle index for chained vehicles

    94

    95

	Vehicle *next;		// next

    96

    97

	StringID string_id; // Displayed string

    98

    99

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

   100

	byte owner;				// which player owns the vehicle?

   101

   102

	TileIndex tile;		// Current tile index

   103

	TileIndex dest_tile; // Heading for this tile

   104

   105

	int16 x_pos;			// coordinates

   106

	int16 y_pos;

   107

	byte z_pos;

   108

	byte direction;		// facing

   109

   110

	uint16 cur_image; // sprite number for this vehicle

   111

	byte spritenum; // currently displayed sprite index

   112

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

   113

	                // 0xff == reserved for another custom sprite

   114

	byte sprite_width;// width of vehicle sprite

   115

	byte sprite_height;// height of vehicle sprite

   116

	byte z_height;		// z-height of vehicle sprite

   117

	int8 x_offs;			// x offset for vehicle sprite

   118

	int8 y_offs;			// y offset for vehicle sprite

   119

	uint16 engine_type;

   120

   121

	uint16 max_speed;	// maximum speed

   122

	uint16 cur_speed;	// current speed

   123

	byte subspeed;		// fractional speed

   124

	byte acceleration; // used by train & aircraft

   125

	byte progress;

   126

   127

	byte vehstatus;		// Status

   128

	byte last_station_visited;

   129

   130

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

   131

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

   132

	byte cargo_source;// source of cargo

   133

	uint16 cargo_cap;	// total capacity

   134

	uint16 cargo_count;// how many pieces are used

   135

   136

	byte day_counter; // increased by one for each day

   137

	byte tick_counter;// increased by one for each tick

   138

   139

	// related to the current order

   140

	byte cur_order_index;

   141

	byte num_orders;

   142

	byte next_order;

   143

	byte next_order_param;

   144

	uint16 *schedule_ptr;

   145

   146

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

   147

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

   148

	int16 left_coord, top_coord, right_coord, bottom_coord;

   149

	uint16 next_hash;

   150

   151

	// Related to age and service time

   152

	uint16 age;				// Age in days

   153

	uint16 max_age;		// Maximum age

   154

	uint16 date_of_last_service;

   155

	uint16 service_interval;

   156

	uint16 reliability;

   157

	uint16 reliability_spd_dec;

   158

	byte breakdown_ctr;

   159

	byte breakdown_delay;

   160

	byte breakdowns_since_last_service;

   161

	byte breakdown_chance;

   162

	byte build_year;

   163

   164

	uint16 load_unload_time_rem;

   165

   166

	int32 profit_this_year;

   167

	int32 profit_last_year;

   168

	uint32 value;

   169

   170

	union {

   171

		VehicleRail rail;

   172

		VehicleAir air;

   173

		VehicleRoad road;

   174

		VehicleSpecial special;

   175

		VehicleDisaster disaster;

   176

		VehicleShip ship;

   177

	} u;

   178

};

   179

   180

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

   181

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

   182

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

   183

   184

struct Depot {

   185

	TileIndex xy;

   186

	uint16 town_index;

   187

};

   188

   189

// train waypoint

   190

struct Waypoint {

   191

	TileIndex xy;

   192

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

   193

	ViewportSign sign;

   194

	uint16 build_date;

   195

	byte stat_id;

   196

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

   197

};

   198

   199

enum {

   200

	VEH_Train = 0x10,

   201

	VEH_Road = 0x11,

   202

	VEH_Ship = 0x12,

   203

	VEH_Aircraft = 0x13,

   204

	VEH_Special = 0x14,

   205

	VEH_Disaster = 0x15,

   206

};

   207

   208

/* Order types */

   209

enum {

   210

	OT_NOTHING = 0,

   211

	OT_GOTO_STATION = 1,

   212

	OT_GOTO_DEPOT = 2,

   213

	OT_LOADING = 3,

   214

	OT_LEAVESTATION = 4,

   215

	OT_DUMMY = 5,

   216

	OT_GOTO_WAYPOINT = 6,

   217

   218

	OT_MASK = 0x1F,

   219

};

   220

   221

/* Order flags */

   222

enum {

   223

	OF_UNLOAD = 0x20,

   224

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

   225

	OF_NON_STOP = 0x80,

   226

	OF_MASK = 0xE0,

   227

};

   228

   229

   230

enum VehStatus {

   231

	VS_HIDDEN = 1,

   232

	VS_STOPPED = 2,

   233

	VS_UNCLICKABLE = 4,

   234

	VS_DEFPAL = 0x8,

   235

	VS_TRAIN_SLOWING = 0x10,

   236

	VS_DISASTER = 0x20,

   237

	VS_AIRCRAFT_BROKEN = 0x40,

   238

	VS_CRASHED = 0x80,

   239

};

   240

   241

   242

   243

/* Effect vehicle types */

   244

enum {

   245

	EV_INDUSTRYSMOKE = 0,

   246

	EV_STEAM_SMOKE = 1,

   247

   248

	EV_SMOKE_1 = 2,

   249

	EV_SMOKE_2 = 3,

   250

	EV_SMOKE_3 = 4,

   251

   252

	EV_CRASHED_SMOKE = 5,

   253

	EV_BREAKDOWN_SMOKE = 6,

   254

   255

	EV_DEMOLISH = 7,

   256

	EV_ROADWORK = 8,

   257

   258

	EV_INDUSTRY_SMOKE = 9,

   259

   260

};

   261

   262

typedef void VehicleTickProc(Vehicle *v);

   263

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

   264

   265

typedef struct {

   266

	byte orderindex;

   267

	uint16 order[41];

   268

	uint16 service_interval;

   269

	char name[32];

   270

} BackuppedOrders;

   271

   272

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

   273

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

   274

Vehicle *AllocateVehicle();

   275

Vehicle *ForceAllocateVehicle();

   276

Vehicle *ForceAllocateSpecialVehicle();

   277

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

   278

void InitializeVehicles();

   279

void VehiclePositionChanged(Vehicle *v);

   280

void AfterLoadVehicles();

   281

Vehicle *GetLastVehicleInChain(Vehicle *v);

   282

Vehicle *GetPrevVehicleInChain(Vehicle *v);

   283

Vehicle *GetFirstVehicleInChain(Vehicle *v);

   284

int CountVehiclesInChain(Vehicle *v);

   285

void DeleteVehicle(Vehicle *v);

   286

void DeleteVehicleChain(Vehicle *v);

   287

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

   288

void CallVehicleTicks();

   289

void DeleteVehicleSchedule(Vehicle *v);

   290

Vehicle *IsScheduleShared(Vehicle *v);

   291

   292

Depot *AllocateDepot();

   293

Waypoint *AllocateWaypoint();

   294

void UpdateWaypointSign(Waypoint *cp);

   295

void RedrawWaypointSign(Waypoint *cp);

   296

   297

void InitializeTrains();

   298

bool IsTrainDepotTile(TileIndex tile);

   299

bool IsRoadDepotTile(TileIndex tile);

   300

   301

bool CanFillVehicle(Vehicle *v);

   302

   303

void ViewportAddVehicles(DrawPixelInfo *dpi);

   304

   305

void TrainEnterDepot(Vehicle *v, uint tile);

   306

   307

/* train_cmd.h */

   308

int GetTrainImage(Vehicle *v, byte direction);

   309

int GetAircraftImage(Vehicle *v, byte direction);

   310

int GetRoadVehImage(Vehicle *v, byte direction);

   311

int GetShipImage(Vehicle *v, byte direction);

   312

   313

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

   314

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

   315

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

   316

   317

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

   318

   319

void VehicleInTheWayErrMsg(Vehicle *v);

   320

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

   321

uint GetVehicleOutOfTunnelTile(Vehicle *v);

   322

   323

bool UpdateSignalsOnSegment(uint tile, byte direction);

   324

void SetSignalsOnBothDir(uint tile, byte track);

   325

   326

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

   327

//uint GetVehicleWeight(Vehicle *v);

   328

   329

void DecreaseVehicleValue(Vehicle *v);

   330

void CheckVehicleBreakdown(Vehicle *v);

   331

void AgeVehicle(Vehicle *v);

   332

void MaybeRenewVehicle(Vehicle *v, int32 build_cost);

   333

   334

void DeleteCommandFromVehicleSchedule(uint cmd);

   335

   336

void BeginVehicleMove(Vehicle *v);

   337

void EndVehicleMove(Vehicle *v);

   338

   339

bool IsAircraftHangarTile(TileIndex tile);

   340

void ShowAircraftViewWindow(Vehicle *v);

   341

   342

void InvalidateVehicleOrderWidget(Vehicle *v);

   343

   344

bool IsShipDepotTile(TileIndex tile);

   345

uint GetFreeUnitNumber(byte type);

   346

   347

int LoadUnloadVehicle(Vehicle *v);

   348

int GetDepotByTile(uint tile);

   349

uint GetWaypointByTile(uint tile);

   350

   351

void DoDeleteDepot(uint tile);

   352

   353

void UpdateTrainAcceleration(Vehicle *v);

   354

int32 GetTrainRunningCost(Vehicle *v);

   355

   356

int CheckStoppedInDepot(Vehicle *v);

   357

   358

int ScheduleHasDepotOrders(uint16 *schedule);

   359

int CheckOrders(Vehicle *v);

   360

   361

typedef struct GetNewVehiclePosResult {

   362

	int x,y;

   363

	uint old_tile;

   364

	uint new_tile;

   365

} GetNewVehiclePosResult;

   366

   367

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

   368

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

   369

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

   370

   371

#define BEGIN_ENUM_WAGONS(v) do {

   372

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

   373

   374

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

   375

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

   376

   377

/* vehicle.c */

   378

enum {

   379

	NUM_NORMAL_VEHICLES = 2048,

   380

	NUM_SPECIAL_VEHICLES = 512,

   381

	NUM_VEHICLES = NUM_NORMAL_VEHICLES + NUM_SPECIAL_VEHICLES

   382

};

   383

   384

VARDEF Vehicle _vehicles[NUM_VEHICLES];

   385

   386

VARDEF uint16 _order_array[5000];

   387

VARDEF uint16 *_ptr_to_next_order;

   388

   389

VARDEF Depot _depots[255];

   390

   391

// 128 waypoints

   392

VARDEF Waypoint _waypoints[128];

   393

   394

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

   395

VARDEF VehicleID _vehicle_position_hash[0x1000];

   396

   397

// NOSAVE: Return values from various commands.

   398

VARDEF VehicleID _new_train_id;

   399

VARDEF VehicleID _new_wagon_id;

   400

VARDEF VehicleID _new_aircraft_id;

   401

VARDEF VehicleID _new_ship_id;

   402

VARDEF VehicleID _new_roadveh_id;

   403

VARDEF uint16 _aircraft_refit_capacity;

   404

VARDEF byte _cmd_build_rail_veh_score;

   405

VARDEF byte _cmd_build_rail_veh_var1;

   406

   407

// NOSAVE: Player specific info

   408

VARDEF TileIndex _last_built_train_depot_tile;

   409

VARDEF TileIndex _last_built_road_depot_tile;

   410

VARDEF TileIndex _last_built_aircraft_depot_tile;

   411

VARDEF TileIndex _last_built_ship_depot_tile;

   412

VARDEF TileIndex _backup_orders_tile;

   413

VARDEF BackuppedOrders _backup_orders_data[1];

   414

   415

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

   416

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

   417

   418

#define INVALID_VEHICLE 0xffff

   419

   420

#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))

   421

#define MIN_SERVINT_PERCENT  5

   422

#define MAX_SERVINT_PERCENT 90

   423

#define MIN_SERVINT_DAYS    30

   424

#define MAX_SERVINT_DAYS   800

   425

   426

#endif /* VEHICLE_H */