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.h"

    17

#include "command_func.h"

    18

#include "saveload.h"

    19

#include "player_func.h"

    20

#include "engine.h"

    21

#include "debug.h"

    22

#include "vehicle_gui.h"

    23

#include "depot.h"

    24

#include "station.h"

    25

#include "rail_type.h"

    26

#include "train.h"

    27

#include "aircraft.h"

    28

#include "industry_map.h"

    29

#include "station_map.h"

    30

#include "water_map.h"

    31

#include "network/network.h"

    32

#include "yapf/yapf.h"

    33

#include "newgrf_callbacks.h"

    34

#include "newgrf_engine.h"

    35

#include "newgrf_sound.h"

    36

#include "group.h"

    37

#include "order.h"

    38

#include "strings_func.h"

    39

#include "zoom_func.h"

    40

#include "functions.h"

    41

#include "date_func.h"

    42

#include "window_func.h"

    43

#include "vehicle_func.h"

    44

#include "signal_func.h"

    45

#include "sound_func.h"

    46

#include "variables.h"

    47

#include "autoreplace_func.h"

    48

#include "autoreplace_gui.h"

    49

#include "string_func.h"

    50

#include "settings_type.h"

    51

    52

#include "table/sprites.h"

    53

#include "table/strings.h"

    54

    55

#define INVALID_COORD (0x7fffffff)

    56

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

    57

    58

VehicleID _vehicle_id_ctr_day;

    59

Vehicle *_place_clicked_vehicle;

    60

VehicleID _new_vehicle_id;

    61

uint16 _returned_refit_capacity;

    62

    63

    64

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

    65

const uint32 _veh_build_proc_table[] = {

    66

	CMD_BUILD_RAIL_VEHICLE,

    67

	CMD_BUILD_ROAD_VEH,

    68

	CMD_BUILD_SHIP,

    69

	CMD_BUILD_AIRCRAFT,

    70

};

    71

const uint32 _veh_sell_proc_table[] = {

    72

	CMD_SELL_RAIL_WAGON,

    73

	CMD_SELL_ROAD_VEH,

    74

	CMD_SELL_SHIP,

    75

	CMD_SELL_AIRCRAFT,

    76

};

    77

    78

const uint32 _veh_refit_proc_table[] = {

    79

	CMD_REFIT_RAIL_VEHICLE,

    80

	CMD_REFIT_ROAD_VEH,

    81

	CMD_REFIT_SHIP,

    82

	CMD_REFIT_AIRCRAFT,

    83

};

    84

    85

const uint32 _send_to_depot_proc_table[] = {

    86

	CMD_SEND_TRAIN_TO_DEPOT,

    87

	CMD_SEND_ROADVEH_TO_DEPOT,

    88

	CMD_SEND_SHIP_TO_DEPOT,

    89

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    90

};

    91

    92

    93

/* Initialize the vehicle-pool */

    94

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    95

    96

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

    97

 * @param *p The vehicle owner

    98

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

    99

 */

   100

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

   101

{

   102

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

   103

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

   104

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

   105

	 * argument rather than finding it again. */

   106

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

   107

   108

	if (!p->engine_renew) return false;

   109

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

   110

   111

	return true;

   112

}

   113

   114

void VehicleServiceInDepot(Vehicle *v)

   115

{

   116

	v->date_of_last_service = _date;

   117

	v->breakdowns_since_last_service = 0;

   118

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

   119

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

   120

}

   121

   122

bool VehicleNeedsService(const Vehicle *v)

   123

{

   124

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

   125

	if (v->current_order.type != OT_GOTO_DEPOT || !(v->current_order.flags & OFB_PART_OF_ORDERS)) { // Don't interfere with a depot visit by the order list

   126

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

   127

		if (v->current_order.type == OT_LOADING)            return false;

   128

		if (v->current_order.type == OT_GOTO_DEPOT && v->current_order.flags & OFB_HALT_IN_DEPOT) return false;

   129

	}

   130

   131

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

   132

		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 */

   133

	}

   134

   135

	return _patches.servint_ispercent ?

   136

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

   137

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

   138

}

   139

   140

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   141

{

   142

	switch (v->type) {

   143

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   144

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   145

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   146

		default:           return STR_980E_SHIP_IN_THE_WAY;

   147

	}

   148

}

   149

   150

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

   151

{

   152

	byte z = *(byte*)data;

   153

   154

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

   155

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

   156

   157

	_error_message = VehicleInTheWayErrMsg(v);

   158

	return v;

   159

}

   160

   161

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   162

{

   163

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

   164

}

   165

   166

bool EnsureNoVehicleOnGround(TileIndex tile)

   167

{

   168

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

   169

}

   170

   171

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

   172

{

   173

	int x1 = TileX(from);

   174

	int y1 = TileY(from);

   175

	int x2 = TileX(to);

   176

	int y2 = TileY(to);

   177

	Vehicle *veh;

   178

   179

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

   180

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

   181

		Swap(x1, x2);

   182

		Swap(y1, y2);

   183

	}

   184

	FOR_ALL_VEHICLES(veh) {

   185

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

   186

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

   187

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

   188

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

   189

				return veh;

   190

			}

   191

		}

   192

	}

   193

	return NULL;

   194

}

   195

   196

   197

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

   198

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

   199

{

   200

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

   201

   202

	_error_message = VehicleInTheWayErrMsg(v);

   203

	return v;

   204

}

   205

   206

/**

   207

 * Finds vehicle in tunnel / bridge

   208

 * @param tile first end

   209

 * @param endtile second end

   210

 * @return pointer to vehicle found

   211

 */

   212

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   213

{

   214

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

   215

	if (v != NULL) return v;

   216

   217

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

   218

}

   219

   220

   221

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

   222

   223

void VehiclePositionChanged(Vehicle *v)

   224

{

   225

	int img = v->cur_image;

   226

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

   227

	const Sprite* spr = GetSprite(img);

   228

   229

	pt.x += spr->x_offs;

   230

	pt.y += spr->y_offs;

   231

   232

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

   233

   234

	v->left_coord = pt.x;

   235

	v->top_coord = pt.y;

   236

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

   237

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

   238

}

   239

   240

/** Called after load to update coordinates */

   241

void AfterLoadVehicles(bool clear_te_id)

   242

{

   243

	Vehicle *v;

   244

   245

	FOR_ALL_VEHICLES(v) {

   246

		/* Reinstate the previous pointer */

   247

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

   248

   249

		v->UpdateDeltaXY(v->direction);

   250

   251

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   252

		v->first = NULL;

   253

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

   254

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

   255

   256

		v->cargo.InvalidateCache();

   257

	}

   258

   259

	FOR_ALL_VEHICLES(v) {

   260

		/* Fill the first pointers */

   261

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

   262

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

   263

				u->first = v;

   264

			}

   265

		}

   266

	}

   267

   268

	FOR_ALL_VEHICLES(v) {

   269

		assert(v->first != NULL);

   270

   271

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

   272

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

   273

			TrainConsistChanged(v);

   274

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

   275

			RoadVehUpdateCache(v);

   276

		}

   277

	}

   278

   279

	FOR_ALL_VEHICLES(v) {

   280

		switch (v->type) {

   281

			case VEH_ROAD:

   282

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

   283

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

   284

				/* FALL THROUGH */

   285

			case VEH_TRAIN:

   286

			case VEH_SHIP:

   287

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

   288

				break;

   289

   290

			case VEH_AIRCRAFT:

   291

				if (IsNormalAircraft(v)) {

   292

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

   293

   294

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

   295

					Vehicle *shadow = v->Next();

   296

					shadow->cur_image = v->cur_image;

   297

   298

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

   299

					if (v->subtype == AIR_HELICOPTER) {

   300

						Vehicle *rotor = shadow->Next();

   301

						rotor->cur_image = GetRotorImage(v);

   302

					}

   303

   304

					UpdateAircraftCache(v);

   305

				}

   306

				break;

   307

			default: break;

   308

		}

   309

   310

		v->left_coord = INVALID_COORD;

   311

		VehiclePositionChanged(v);

   312

	}

   313

}

   314

   315

Vehicle::Vehicle()

   316

{

   317

	this->type               = VEH_INVALID;

   318

	this->left_coord         = INVALID_COORD;

   319

	this->group_id           = DEFAULT_GROUP;

   320

	this->fill_percent_te_id = INVALID_TE_ID;

   321

	this->first              = this;

   322

	this->colormap           = PAL_NONE;

   323

}

   324

   325

/**

   326

 * Get a value for a vehicle's random_bits.

   327

 * @return A random value from 0 to 255.

   328

 */

   329

byte VehicleRandomBits()

   330

{

   331

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

   332

}

   333

   334

   335

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

   336

{

   337

	uint counter = _Vehicle_pool.first_free_index;

   338

   339

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

   340

		Vehicle *v = AllocateRaw(counter);

   341

   342

		if (v == NULL) return false;

   343

		v = new (v) InvalidVehicle();

   344

   345

		if (vl != NULL) {

   346

			vl[i] = v;

   347

		}

   348

		counter++;

   349

	}

   350

   351

	return true;

   352

}

   353

   354

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

   355

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

   356

const int HASH_BITS = 7;

   357

const int HASH_SIZE = 1 << HASH_BITS;

   358

const int HASH_MASK = HASH_SIZE - 1;

   359

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

   360

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   361

   362

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

   363

 * Profiling results show that 0 is fastest. */

   364

const int HASH_RES = 0;

   365

   366

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   367

   368

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

   369

{

   370

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

   371

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

   372

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

   373

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

   374

				void *a = proc(v, data);

   375

				if (a != NULL) return a;

   376

			}

   377

			if (x == xu) break;

   378

		}

   379

		if (y == yu) break;

   380

	}

   381

   382

	return NULL;

   383

}

   384

   385

   386

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

   387

{

   388

	const int COLL_DIST = 6;

   389

   390

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

   391

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

   392

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

   393

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

   394

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

   395

   396

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

   397

}

   398

   399

   400

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

   401

{

   402

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

   403

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

   404

   405

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

   406

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

   407

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

   408

   409

		void *a = proc(v, data);

   410

		if (a != NULL) return a;

   411

	}

   412

   413

	return NULL;

   414

}

   415

   416

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   417

{

   418

	Vehicle **old_hash = v->old_new_hash;

   419

	Vehicle **new_hash;

   420

   421

	if (remove) {

   422

		new_hash = NULL;

   423

	} else {

   424

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

   425

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

   426

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

   427

	}

   428

   429

	if (old_hash == new_hash) return;

   430

   431

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

   432

	if (old_hash != NULL) {

   433

		Vehicle *last = NULL;

   434

		Vehicle *u = *old_hash;

   435

		while (u != v) {

   436

			last = u;

   437

			u = u->next_new_hash;

   438

			assert(u != NULL);

   439

		}

   440

   441

		if (last == NULL) {

   442

			*old_hash = v->next_new_hash;

   443

		} else {

   444

			last->next_new_hash = v->next_new_hash;

   445

		}

   446

	}

   447

   448

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

   449

	if (new_hash != NULL) {

   450

		v->next_new_hash = *new_hash;

   451

		*new_hash = v;

   452

		assert(v != v->next_new_hash);

   453

	}

   454

   455

	/* Remember current hash position */

   456

	v->old_new_hash = new_hash;

   457

}

   458

   459

static Vehicle *_vehicle_position_hash[0x1000];

   460

   461

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

   462

{

   463

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   464

   465

	Vehicle **old_hash, **new_hash;

   466

	int old_x = v->left_coord;

   467

	int old_y = v->top_coord;

   468

   469

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

   470

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

   471

   472

	if (old_hash == new_hash) return;

   473

   474

	/* remove from hash table? */

   475

	if (old_hash != NULL) {

   476

		Vehicle *last = NULL;

   477

		Vehicle *u = *old_hash;

   478

		while (u != v) {

   479

			last = u;

   480

			u = u->next_hash;

   481

			assert(u != NULL);

   482

		}

   483

   484

		if (last == NULL) {

   485

			*old_hash = v->next_hash;

   486

		} else {

   487

			last->next_hash = v->next_hash;