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 "table/sprites.h"

    12

#include "table/strings.h"

    13

#include "functions.h"

    14

#include "landscape.h"

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "vehicle.h"

    18

#include "timetable.h"

    19

#include "gfx.h"

    20

#include "viewport.h"

    21

#include "news.h"

    22

#include "command.h"

    23

#include "saveload.h"

    24

#include "player.h"

    25

#include "engine.h"

    26

#include "sound.h"

    27

#include "debug.h"

    28

#include "vehicle_gui.h"

    29

#include "depot.h"

    30

#include "station.h"

    31

#include "rail.h"

    32

#include "train.h"

    33

#include "aircraft.h"

    34

#include "industry_map.h"

    35

#include "station_map.h"

    36

#include "water_map.h"

    37

#include "network/network.h"

    38

#include "yapf/yapf.h"

    39

#include "date.h"

    40

#include "newgrf_callbacks.h"

    41

#include "newgrf_engine.h"

    42

#include "newgrf_sound.h"

    43

#include "helpers.hpp"

    44

#include "group.h"

    45

#include "economy.h"

    46

#include "strings.h"

    47

    48

#define INVALID_COORD (0x7fffffff)

    49

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

    50

    51

    52

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

    53

const uint32 _veh_build_proc_table[] = {

    54

	CMD_BUILD_RAIL_VEHICLE,

    55

	CMD_BUILD_ROAD_VEH,

    56

	CMD_BUILD_SHIP,

    57

	CMD_BUILD_AIRCRAFT,

    58

};

    59

const uint32 _veh_sell_proc_table[] = {

    60

	CMD_SELL_RAIL_WAGON,

    61

	CMD_SELL_ROAD_VEH,

    62

	CMD_SELL_SHIP,

    63

	CMD_SELL_AIRCRAFT,

    64

};

    65

    66

const uint32 _veh_refit_proc_table[] = {

    67

	CMD_REFIT_RAIL_VEHICLE,

    68

	CMD_REFIT_ROAD_VEH,

    69

	CMD_REFIT_SHIP,

    70

	CMD_REFIT_AIRCRAFT,

    71

};

    72

    73

const uint32 _send_to_depot_proc_table[] = {

    74

	CMD_SEND_TRAIN_TO_DEPOT,

    75

	CMD_SEND_ROADVEH_TO_DEPOT,

    76

	CMD_SEND_SHIP_TO_DEPOT,

    77

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    78

};

    79

    80

    81

/* Initialize the vehicle-pool */

    82

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    83

    84

void VehicleServiceInDepot(Vehicle *v)

    85

{

    86

	v->date_of_last_service = _date;

    87

	v->breakdowns_since_last_service = 0;

    88

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

    89

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

    90

}

    91

    92

bool VehicleNeedsService(const Vehicle *v)

    93

{

    94

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

    95

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

    96

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

    97

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

    98

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

    99

	}

   100

   101

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

   102

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

   103

	}

   104

   105

	return _patches.servint_ispercent ?

   106

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

   107

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

   108

}

   109

   110

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   111

{

   112

	switch (v->type) {

   113

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   114

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   115

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   116

		default:           return STR_980E_SHIP_IN_THE_WAY;

   117

	}

   118

}

   119

   120

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

   121

{

   122

	const TileInfo *ti = (const TileInfo*)data;

   123

   124

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

   125

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

   126

   127

	_error_message = VehicleInTheWayErrMsg(v);

   128

	return v;

   129

}

   130

   131

   132

bool EnsureNoVehicleOnGround(TileIndex tile)

   133

{

   134

	TileInfo ti;

   135

   136

	ti.tile = tile;

   137

	ti.z = GetTileMaxZ(tile);

   138

	return VehicleFromPos(tile, &ti, EnsureNoVehicleProcZ) == NULL;

   139

}

   140

   141

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   142

{

   143

	TileInfo ti;

   144

   145

	ti.tile = tile;

   146

	ti.z = z;

   147

   148

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

   149

}

   150

   151

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

   152

{

   153

	int x1 = TileX(from);

   154

	int y1 = TileY(from);

   155

	int x2 = TileX(to);

   156

	int y2 = TileY(to);

   157

	Vehicle *veh;

   158

   159

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

   160

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

   161

		Swap(x1, x2);

   162

		Swap(y1, y2);

   163

	}

   164

	FOR_ALL_VEHICLES(veh) {

   165

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

   166

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

   167

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

   168

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

   169

				return veh;

   170

			}

   171

		}

   172

	}

   173

	return NULL;

   174

}

   175

   176

   177

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

   178

   179

void VehiclePositionChanged(Vehicle *v)

   180

{

   181

	int img = v->cur_image;

   182

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

   183

	const Sprite* spr = GetSprite(img);

   184

   185

	pt.x += spr->x_offs;

   186

	pt.y += spr->y_offs;

   187

   188

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

   189

   190

	v->left_coord = pt.x;

   191

	v->top_coord = pt.y;

   192

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

   193

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

   194

}

   195

   196

/** Called after load to update coordinates */

   197

void AfterLoadVehicles()

   198

{

   199

	Vehicle *v;

   200

   201

	FOR_ALL_VEHICLES(v) {

   202

		/* Reinstate the previous pointer */

   203

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

   204

   205

		v->UpdateDeltaXY(v->direction);

   206

   207

		v->fill_percent_te_id = INVALID_TE_ID;

   208

		v->first = NULL;

   209

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

   210

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

   211

   212

		v->cargo.InvalidateCache();

   213

	}

   214

   215

	FOR_ALL_VEHICLES(v) {

   216

		/* Fill the first pointers */

   217

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

   218

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

   219

				u->first = v;

   220

			}

   221

		}

   222

	}

   223

   224

	FOR_ALL_VEHICLES(v) {

   225

		assert(v->first != NULL);

   226

   227

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

   228

			TrainConsistChanged(v);

   229

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

   230

			RoadVehUpdateCache(v);

   231

		}

   232

	}

   233

   234

	FOR_ALL_VEHICLES(v) {

   235

		switch (v->type) {

   236

			case VEH_ROAD:

   237

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

   238

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

   239

				/* FALL THROUGH */

   240

			case VEH_TRAIN:

   241

			case VEH_SHIP:

   242

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

   243

				break;

   244

   245

			case VEH_AIRCRAFT:

   246

				if (IsNormalAircraft(v)) {

   247

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

   248

   249

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

   250

					Vehicle *shadow = v->Next();

   251

					shadow->cur_image = v->cur_image;

   252

   253

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

   254

					if (v->subtype == AIR_HELICOPTER) {

   255

						Vehicle *rotor = shadow->Next();

   256

						rotor->cur_image = GetRotorImage(v);

   257

					}

   258

   259

					UpdateAircraftCache(v);

   260

				}

   261

				break;

   262

			default: break;

   263

		}

   264

   265

		v->left_coord = INVALID_COORD;

   266

		VehiclePositionChanged(v);

   267

	}

   268

}

   269

   270

Vehicle::Vehicle()

   271

{

   272

	this->type               = VEH_INVALID;

   273

	this->left_coord         = INVALID_COORD;

   274

	this->group_id           = DEFAULT_GROUP;

   275

	this->fill_percent_te_id = INVALID_TE_ID;

   276

	this->first              = this;

   277

}

   278

   279

/**

   280

 * Get a value for a vehicle's random_bits.

   281

 * @return A random value from 0 to 255.

   282

 */

   283

byte VehicleRandomBits()

   284

{

   285

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

   286

}

   287

   288

   289

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

   290

{

   291

	uint counter = _Vehicle_pool.first_free_index;

   292

   293

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

   294

		Vehicle *v = AllocateRaw(counter);

   295

   296

		if (v == NULL) return false;

   297

		v = new (v) InvalidVehicle();

   298

   299

		if (vl != NULL) {

   300

			vl[i] = v;

   301

		}

   302

		counter++;

   303

	}

   304

   305

	return true;

   306

}

   307

   308

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

   309

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

   310

const int HASH_BITS = 7;

   311

const int HASH_SIZE = 1 << HASH_BITS;

   312

const int HASH_MASK = HASH_SIZE - 1;

   313

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

   314

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   315

   316

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

   317

 * Profiling results show that 0 is fastest. */

   318

const int HASH_RES = 0;

   319

   320

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   321

   322

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

   323

{

   324

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

   325

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

   326

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

   327

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

   328

				void *a = proc(v, data);

   329

				if (a != NULL) return a;

   330

			}

   331

			if (x == xu) break;

   332

		}

   333

		if (y == yu) break;

   334

	}

   335

   336

	return NULL;

   337

}

   338

   339

   340

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

   341

{

   342

	const int COLL_DIST = 6;

   343

   344

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

   345

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

   346

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

   347

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

   348

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

   349

   350

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

   351

}

   352

   353

   354

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

   355

{

   356

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

   357

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

   358

   359

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

   360

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

   361

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

   362

   363

		void *a = proc(v, data);

   364

		if (a != NULL) return a;

   365

	}

   366

   367

	return NULL;

   368

}

   369

   370

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   371

{

   372

	Vehicle **old_hash = v->old_new_hash;

   373

	Vehicle **new_hash;

   374

   375

	if (remove) {

   376

		new_hash = NULL;

   377

	} else {

   378

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

   379

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

   380

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

   381

	}

   382

   383

	if (old_hash == new_hash) return;

   384

   385

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

   386

	if (old_hash != NULL) {

   387

		Vehicle *last = NULL;

   388

		Vehicle *u = *old_hash;

   389

		while (u != v) {

   390

			last = u;

   391

			u = u->next_new_hash;

   392

			assert(u != NULL);

   393

		}

   394

   395

		if (last == NULL) {

   396

			*old_hash = v->next_new_hash;

   397

		} else {

   398

			last->next_new_hash = v->next_new_hash;

   399

		}

   400

	}

   401

   402

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

   403

	if (new_hash != NULL) {

   404

		v->next_new_hash = *new_hash;

   405

		*new_hash = v;

   406

		assert(v != v->next_new_hash);

   407

	}

   408

   409

	/* Remember current hash position */

   410

	v->old_new_hash = new_hash;

   411

}

   412

   413

static Vehicle *_vehicle_position_hash[0x1000];

   414

   415

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

   416

{

   417

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   418

   419

	Vehicle **old_hash, **new_hash;

   420

	int old_x = v->left_coord;

   421

	int old_y = v->top_coord;

   422

   423

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

   424

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

   425

   426

	if (old_hash == new_hash) return;

   427

   428

	/* remove from hash table? */

   429

	if (old_hash != NULL) {

   430

		Vehicle *last = NULL;

   431

		Vehicle *u = *old_hash;

   432

		while (u != v) {

   433

			last = u;

   434

			u = u->next_hash;

   435

			assert(u != NULL);

   436

		}

   437

   438

		if (last == NULL) {

   439

			*old_hash = v->next_hash;

   440

		} else {

   441

			last->next_hash = v->next_hash;

   442

		}

   443

	}

   444

   445

	/* insert into hash table? */

   446

	if (new_hash != NULL) {

   447

		v->next_hash = *new_hash;

   448

		*new_hash = v;

   449

	}

   450

}

   451

   452

void ResetVehiclePosHash()

   453

{

   454

	Vehicle *v;

   455

	FOR_ALL_VEHICLES(v) { v->old_new_hash = NULL; }

   456

	memset(_vehicle_position_hash, 0, sizeof(_vehicle_position_hash));

   457

	memset(_new_vehicle_position_hash, 0, sizeof(_new_vehicle_position_hash));

   458

}

   459

   460

void InitializeVehicles()

   461

{

   462

	_Vehicle_pool.CleanPool();

   463

	_Vehicle_pool.AddBlockToPool();

   464

   465

	ResetVehiclePosHash();

   466

}

   467

   468

Vehicle *GetLastVehicleInChain(Vehicle *v)

   469

{

   470

	while (v->Next() != NULL) v = v->Next();

   471

	return v;

   472

}

   473

   474

uint CountVehiclesInChain(const Vehicle* v)

   475

{

   476

	uint count = 0;

   477

	do count++; while ((v = v->Next()) != NULL);

   478

	return count;

   479

}

   480

   481

/** Check if a vehicle is counted in num_engines in each player struct

   482

 * @param *v Vehicle to test

   483

 * @return true if the vehicle is counted in num_engines

   484

 */

   485

bool IsEngineCountable(const Vehicle *v)

   486

{

   487

	switch (v->type) {

   488

		case VEH_AIRCRAFT: return IsNormalAircraft(v); // don't count plane shadows and helicopter rotors

   489

		case VEH_TRAIN: