1

/* $Id$ */

     2

     3

/** @file vehicle.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "road_map.h"

     8

#include "roadveh.h"

     9

#include "ship.h"

    10

#include "spritecache.h"

    11

#include "tile_cmd.h"

    12

#include "landscape.h"

    13

#include "timetable.h"

    14

#include "viewport_func.h"

    15

#include "gfx_func.h"

    16

#include "news_func.h"

    17

#include "command_func.h"

    18

#include "saveload.h"

    19

#include "player_func.h"

    20

#include "debug.h"

    21

#include "vehicle_gui.h"

    22

#include "depot.h"

    23

#include "rail_type.h"

    24

#include "train.h"

    25

#include "aircraft.h"

    26

#include "industry_map.h"

    27

#include "station_map.h"

    28

#include "water_map.h"

    29

#include "network/network.h"

    30

#include "yapf/yapf.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_engine.h"

    33

#include "newgrf_sound.h"

    34

#include "group.h"

    35

#include "order_func.h"

    36

#include "strings_func.h"

    37

#include "zoom_func.h"

    38

#include "functions.h"

    39

#include "date_func.h"

    40

#include "window_func.h"

    41

#include "vehicle_func.h"

    42

#include "signal_func.h"

    43

#include "sound_func.h"

    44

#include "variables.h"

    45

#include "autoreplace_func.h"

    46

#include "autoreplace_gui.h"

    47

#include "string_func.h"

    48

#include "settings_type.h"

    49

    50

#include "table/sprites.h"

    51

#include "table/strings.h"

    52

    53

#define INVALID_COORD (0x7fffffff)

    54

#define GEN_HASH(x, y) ((GB((y), 6, 6) << 6) + GB((x), 7, 6))

    55

    56

VehicleID _vehicle_id_ctr_day;

    57

Vehicle *_place_clicked_vehicle;

    58

VehicleID _new_vehicle_id;

    59

uint16 _returned_refit_capacity;

    60

    61

    62

/* Tables used in vehicle.h to find the right command for a certain vehicle type */

    63

const uint32 _veh_build_proc_table[] = {

    64

	CMD_BUILD_RAIL_VEHICLE,

    65

	CMD_BUILD_ROAD_VEH,

    66

	CMD_BUILD_SHIP,

    67

	CMD_BUILD_AIRCRAFT,

    68

};

    69

const uint32 _veh_sell_proc_table[] = {

    70

	CMD_SELL_RAIL_WAGON,

    71

	CMD_SELL_ROAD_VEH,

    72

	CMD_SELL_SHIP,

    73

	CMD_SELL_AIRCRAFT,

    74

};

    75

    76

const uint32 _veh_refit_proc_table[] = {

    77

	CMD_REFIT_RAIL_VEHICLE,

    78

	CMD_REFIT_ROAD_VEH,

    79

	CMD_REFIT_SHIP,

    80

	CMD_REFIT_AIRCRAFT,

    81

};

    82

    83

const uint32 _send_to_depot_proc_table[] = {

    84

	CMD_SEND_TRAIN_TO_DEPOT,

    85

	CMD_SEND_ROADVEH_TO_DEPOT,

    86

	CMD_SEND_SHIP_TO_DEPOT,

    87

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    88

};

    89

    90

    91

/* Initialize the vehicle-pool */

    92

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    93

    94

/** Function to tell if a vehicle needs to be autorenewed

    95

 * @param *p The vehicle owner

    96

 * @return true if the vehicle is old enough for replacement

    97

 */

    98

bool Vehicle::NeedsAutorenewing(const Player *p) const

    99

{

   100

	/* We can always generate the Player pointer when we have the vehicle.

   101

	 * However this takes time and since the Player pointer is often present

   102

	 * when this function is called then it's faster to pass the pointer as an

   103

	 * argument rather than finding it again. */

   104

	assert(p == GetPlayer(this->owner));

   105

   106

	if (!p->engine_renew) return false;

   107

	if (this->age - this->max_age < (p->engine_renew_months * 30)) return false;

   108

   109

	return true;

   110

}

   111

   112

void VehicleServiceInDepot(Vehicle *v)

   113

{

   114

	v->date_of_last_service = _date;

   115

	v->breakdowns_since_last_service = 0;

   116

	v->reliability = GetEngine(v->engine_type)->reliability;

   117

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index); // ensure that last service date and reliability are updated

   118

}

   119

   120

bool VehicleNeedsService(const Vehicle *v)

   121

{

   122

	if (v->vehstatus & (VS_STOPPED | VS_CRASHED))       return false;

   124

		if (_patches.gotodepot && VehicleHasDepotOrders(v)) return false;

   127

	}

   128

   129

	if (_patches.no_servicing_if_no_breakdowns && _opt.diff.vehicle_breakdowns == 0) {

   130

		return EngineHasReplacementForPlayer(GetPlayer(v->owner), v->engine_type, v->group_id);  /* Vehicles set for autoreplacing needs to go to a depot even if breakdowns are turned off */

   131

	}

   132

   133

	return _patches.servint_ispercent ?

   134

		(v->reliability < GetEngine(v->engine_type)->reliability * (100 - v->service_interval) / 100) :

   135

		(v->date_of_last_service + v->service_interval < _date);

   136

}

   137

   138

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   139

{

   140

	switch (v->type) {

   141

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   142

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   143

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   144

		default:           return STR_980E_SHIP_IN_THE_WAY;

   145

	}

   146

}

   147

   148

static void *EnsureNoVehicleProcZ(Vehicle *v, void *data)

   149

{

   150

	byte z = *(byte*)data;

   151

   152

	if (v->type == VEH_DISASTER || (v->type == VEH_AIRCRAFT && v->subtype == AIR_SHADOW)) return NULL;

   153

	if (v->z_pos > z) return NULL;

   154

   155

	_error_message = VehicleInTheWayErrMsg(v);

   156

	return v;

   157

}

   158

   159

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   160

{

   161

	return (Vehicle*)VehicleFromPos(tile, &z, &EnsureNoVehicleProcZ);

   162

}

   163

   164

bool EnsureNoVehicleOnGround(TileIndex tile)

   165

{

   166

	return FindVehicleOnTileZ(tile, GetTileMaxZ(tile)) == NULL;

   167

}

   168

   169

Vehicle *FindVehicleBetween(TileIndex from, TileIndex to, byte z, bool without_crashed)

   170

{

   171

	int x1 = TileX(from);

   172

	int y1 = TileY(from);

   173

	int x2 = TileX(to);

   174

	int y2 = TileY(to);

   175

	Vehicle *veh;

   176

   177

	/* Make sure x1 < x2 or y1 < y2 */

   178

	if (x1 > x2 || y1 > y2) {

   179

		Swap(x1, x2);

   180

		Swap(y1, y2);

   181

	}

   182

	FOR_ALL_VEHICLES(veh) {

   183

		if (without_crashed && (veh->vehstatus & VS_CRASHED) != 0) continue;

   184

		if ((veh->type == VEH_TRAIN || veh->type == VEH_ROAD) && (z == 0xFF || veh->z_pos == z)) {

   185

			if ((veh->x_pos >> 4) >= x1 && (veh->x_pos >> 4) <= x2 &&

   186

					(veh->y_pos >> 4) >= y1 && (veh->y_pos >> 4) <= y2) {

   187

				return veh;

   188

			}

   189

		}

   190

	}

   191

	return NULL;

   192

}

   193

   194

   195

/** Procedure called for every vehicle found in tunnel/bridge in the hash map */

   196

static void *GetVehicleTunnelBridgeProc(Vehicle *v, void *data)

   197

{

   198

	if (v->type != VEH_TRAIN && v->type != VEH_ROAD) return NULL;

   199

   200

	_error_message = VehicleInTheWayErrMsg(v);

   201

	return v;

   202

}

   203

   204

/**

   205

 * Finds vehicle in tunnel / bridge

   206

 * @param tile first end

   207

 * @param endtile second end

   208

 * @return pointer to vehicle found

   209

 */

   210

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   211

{

   212

	Vehicle *v = (Vehicle*)VehicleFromPos(tile, NULL, &GetVehicleTunnelBridgeProc);

   213

	if (v != NULL) return v;

   214

   215

	return (Vehicle*)VehicleFromPos(endtile, NULL, &GetVehicleTunnelBridgeProc);

   216

}

   217

   218

   219

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

   220

   221

void VehiclePositionChanged(Vehicle *v)

   222

{

   223

	int img = v->cur_image;

   224

	Point pt = RemapCoords(v->x_pos + v->x_offs, v->y_pos + v->y_offs, v->z_pos);

   225

	const Sprite* spr = GetSprite(img);

   226

   227

	pt.x += spr->x_offs;

   228

	pt.y += spr->y_offs;

   229

   230

	UpdateVehiclePosHash(v, pt.x, pt.y);

   231

   232

	v->left_coord = pt.x;

   233

	v->top_coord = pt.y;

   234

	v->right_coord = pt.x + spr->width + 2;

   235

	v->bottom_coord = pt.y + spr->height + 2;

   236

}

   237

   238

/** Called after load to update coordinates */

   239

void AfterLoadVehicles(bool clear_te_id)

   240

{

   241

	Vehicle *v;

   242

   243

	FOR_ALL_VEHICLES(v) {

   244

		/* Reinstate the previous pointer */

   245

		if (v->Next() != NULL) v->Next()->previous = v;

   246

   247

		v->UpdateDeltaXY(v->direction);

   248

   249

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   250

		v->first = NULL;

   251

		if (v->type == VEH_TRAIN) v->u.rail.first_engine = INVALID_ENGINE;

   252

		if (v->type == VEH_ROAD)  v->u.road.first_engine = INVALID_ENGINE;

   253

   254

		v->cargo.InvalidateCache();

   255

	}

   256

   257

	FOR_ALL_VEHICLES(v) {

   258

		/* Fill the first pointers */

   259

		if (v->Previous() == NULL) {

   260

			for (Vehicle *u = v; u != NULL; u = u->Next()) {

   261

				u->first = v;

   262

			}

   263

		}

   264

	}

   265

   266

	FOR_ALL_VEHICLES(v) {

   267

		assert(v->first != NULL);

   268

   269

		if (v->type == VEH_TRAIN && (IsFrontEngine(v) || IsFreeWagon(v))) {

   270

			if (IsFrontEngine(v)) v->u.rail.last_speed = v->cur_speed; // update displayed train speed

   271

			TrainConsistChanged(v);

   272

		} else if (v->type == VEH_ROAD && IsRoadVehFront(v)) {

   273

			RoadVehUpdateCache(v);

   274

		}

   275

	}

   276

   277

	FOR_ALL_VEHICLES(v) {

   278

		switch (v->type) {

   279

			case VEH_ROAD:

   280

				v->u.road.roadtype = HasBit(EngInfo(v->engine_type)->misc_flags, EF_ROAD_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD;

   281

				v->u.road.compatible_roadtypes = RoadTypeToRoadTypes(v->u.road.roadtype);

   282

				/* FALL THROUGH */

   283

			case VEH_TRAIN:

   284

			case VEH_SHIP:

   285

				v->cur_image = v->GetImage(v->direction);

   286

				break;

   287

   288

			case VEH_AIRCRAFT:

   289

				if (IsNormalAircraft(v)) {

   290

					v->cur_image = v->GetImage(v->direction);

   291

   292

					/* The plane's shadow will have the same image as the plane */

   293

					Vehicle *shadow = v->Next();

   294

					shadow->cur_image = v->cur_image;

   295

   296

					/* In the case of a helicopter we will update the rotor sprites */

   297

					if (v->subtype == AIR_HELICOPTER) {

   298

						Vehicle *rotor = shadow->Next();

   299

						rotor->cur_image = GetRotorImage(v);

   300

					}

   301

   302

					UpdateAircraftCache(v);

   303

				}

   304

				break;

   305

			default: break;

   306

		}

   307

   308

		v->left_coord = INVALID_COORD;

   309

		VehiclePositionChanged(v);

   310

	}

   311

}

   312

   313

Vehicle::Vehicle()

   314

{

   315

	this->type               = VEH_INVALID;

   316

	this->left_coord         = INVALID_COORD;

   317

	this->group_id           = DEFAULT_GROUP;

   318

	this->fill_percent_te_id = INVALID_TE_ID;

   319

	this->first              = this;

   320

	this->colormap           = PAL_NONE;

   321

}

   322

   323

/**

   324

 * Get a value for a vehicle's random_bits.

   325

 * @return A random value from 0 to 255.

   326

 */

   327

byte VehicleRandomBits()

   328

{

   329

	return GB(Random(), 0, 8);

   330

}

   331

   332

   333

/* static */ bool Vehicle::AllocateList(Vehicle **vl, int num)

   334

{

   335

	uint counter = _Vehicle_pool.first_free_index;

   336

   337

	for (int i = 0; i != num; i++) {

   338

		Vehicle *v = AllocateRaw(counter);

   339

   340

		if (v == NULL) return false;

   341

		v = new (v) InvalidVehicle();

   342

   343

		if (vl != NULL) {

   344

			vl[i] = v;

   345

		}

   346

		counter++;

   347

	}

   348

   349

	return true;

   350

}

   351

   352

/* Size of the hash, 6 = 64 x 64, 7 = 128 x 128. Larger sizes will (in theory) reduce hash

   353

 * lookup times at the expense of memory usage. */

   354

const int HASH_BITS = 7;

   355

const int HASH_SIZE = 1 << HASH_BITS;

   356

const int HASH_MASK = HASH_SIZE - 1;

   357

const int TOTAL_HASH_SIZE = 1 << (HASH_BITS * 2);

   358

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   359

   360

/* Resolution of the hash, 0 = 1*1 tile, 1 = 2*2 tiles, 2 = 4*4 tiles, etc.

   361

 * Profiling results show that 0 is fastest. */

   362

const int HASH_RES = 0;

   363

   364

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   365

   366

static void *VehicleFromHash(int xl, int yl, int xu, int yu, void *data, VehicleFromPosProc *proc)

   367

{

   368

	for (int y = yl; ; y = (y + (1 << HASH_BITS)) & (HASH_MASK << HASH_BITS)) {

   369

		for (int x = xl; ; x = (x + 1) & HASH_MASK) {

   370

			Vehicle *v = _new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   371

			for (; v != NULL; v = v->next_new_hash) {

   372

				void *a = proc(v, data);

   373

				if (a != NULL) return a;

   374

			}

   375

			if (x == xu) break;

   376

		}

   377

		if (y == yu) break;

   378

	}

   379

   380

	return NULL;

   381

}

   382

   383

   384

void *VehicleFromPosXY(int x, int y, void *data, VehicleFromPosProc *proc)

   385

{

   386

	const int COLL_DIST = 6;

   387

   388

	/* Hash area to scan is from xl,yl to xu,yu */

   389

	int xl = GB((x - COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS);

   390

	int xu = GB((x + COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS);

   391

	int yl = GB((y - COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS) << HASH_BITS;

   392

	int yu = GB((y + COLL_DIST) / TILE_SIZE, HASH_RES, HASH_BITS) << HASH_BITS;

   393

   394

	return VehicleFromHash(xl, yl, xu, yu, data, proc);

   395

}

   396

   397

   398

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

   399

{

   400

	int x = GB(TileX(tile), HASH_RES, HASH_BITS);

   401

	int y = GB(TileY(tile), HASH_RES, HASH_BITS) << HASH_BITS;

   402

   403

	Vehicle *v = _new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   404

	for (; v != NULL; v = v->next_new_hash) {

   405

		if (v->tile != tile) continue;

   406

   407

		void *a = proc(v, data);

   408

		if (a != NULL) return a;

   409

	}

   410

   411

	return NULL;

   412

}

   413

   414

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   415

{

   416

	Vehicle **old_hash = v->old_new_hash;

   417

	Vehicle **new_hash;

   418

   419

	if (remove) {

   420

		new_hash = NULL;

   421

	} else {

   422

		int x = GB(TileX(v->tile), HASH_RES, HASH_BITS);

   423

		int y = GB(TileY(v->tile), HASH_RES, HASH_BITS) << HASH_BITS;

   424

		new_hash = &_new_vehicle_position_hash[(x + y) & TOTAL_HASH_MASK];

   425

	}

   426

   427

	if (old_hash == new_hash) return;

   428

   429

	/* Remove from the old position in the hash table */

   430

	if (old_hash != NULL) {

   431

		Vehicle *last = NULL;

   432

		Vehicle *u = *old_hash;

   433

		while (u != v) {

   434

			last = u;

   435

			u = u->next_new_hash;

   436

			assert(u != NULL);

   437

		}

   438

   439

		if (last == NULL) {

   440

			*old_hash = v->next_new_hash;

   441

		} else {

   442

			last->next_new_hash = v->next_new_hash;

   443

		}

   444

	}

   445

   446

	/* Insert vehicle at beginning of the new position in the hash table */

   447

	if (new_hash != NULL) {

   448

		v->next_new_hash = *new_hash;

   449

		*new_hash = v;

   450

		assert(v != v->next_new_hash);

   451

	}

   452

   453

	/* Remember current hash position */

   454

	v->old_new_hash = new_hash;

   455

}

   456

   457

static Vehicle *_vehicle_position_hash[0x1000];

   458

   459

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

   460

{

   461

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   462

   463

	Vehicle **old_hash, **new_hash;

   464

	int old_x = v->left_coord;

   465

	int old_y = v->top_coord;

   466

   467

	new_hash = (x == INVALID_COORD) ? NULL : &_vehicle_position_hash[GEN_HASH(x, y)];

   468

	old_hash = (old_x == INVALID_COORD) ? NULL : &_vehicle_position_hash[GEN_HASH(old_x, old_y)];

   469

   470

	if (old_hash == new_hash) return;

   471

   472

	/* remove from hash table? */

   473

	if (old_hash != NULL) {

   474

		Vehicle *last = NULL;

   475

		Vehicle *u = *old_hash;

   476

		while (u != v) {

   477

			last = u;

   478

			u = u->next_hash;

   479

			assert(u != NULL);

   480

		}

   481

   482

		if (last == NULL) {

   483

			*old_hash = v->next_hash;

   484

		} else {

   485

			last->next_hash = v->next_hash;

   486

		}

   487

	}

   488