1

/* $Id$ */

     2

     3

/** @file vehicle.cpp Base implementations of all vehicles. */

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

    23

#include "train.h"

    24

#include "aircraft.h"

    25

#include "industry_map.h"

    26

#include "station_map.h"

    27

#include "water_map.h"

    28

#include "yapf/yapf.h"

    29

#include "newgrf_callbacks.h"

    30

#include "newgrf_engine.h"

    31

#include "newgrf_sound.h"

    32

#include "newgrf_station.h"

    33

#include "group.h"

    34

#include "order_func.h"

    35

#include "strings_func.h"

    36

#include "zoom_func.h"

    37

#include "functions.h"

    38

#include "date_func.h"

    39

#include "window_func.h"

    40

#include "vehicle_func.h"

    41

#include "signal_func.h"

    42

#include "sound_func.h"

    43

#include "variables.h"

    44

#include "autoreplace_func.h"

    45

#include "autoreplace_gui.h"

    46

#include "string_func.h"

    47

#include "settings_type.h"

    48

#include "oldpool_func.h"

    49

#include "depot_map.h"

    50

#include "animated_tile_func.h"

    51

#include "effectvehicle_base.h"

    52

#include "core/alloc_func.hpp"

    53

#include "vehiclelist.h"

    54

    55

#include "table/sprites.h"

    56

#include "table/strings.h"

    57

    58

#define INVALID_COORD (0x7fffffff)

    59

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

    60

    61

VehicleID _vehicle_id_ctr_day;

    62

const Vehicle *_place_clicked_vehicle;

    63

VehicleID _new_vehicle_id;

    64

uint16 _returned_refit_capacity;

    65

    66

    67

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

    68

const uint32 _veh_build_proc_table[] = {

    69

	CMD_BUILD_RAIL_VEHICLE,

    70

	CMD_BUILD_ROAD_VEH,

    71

	CMD_BUILD_SHIP,

    72

	CMD_BUILD_AIRCRAFT,

    73

};

    74

const uint32 _veh_sell_proc_table[] = {

    75

	CMD_SELL_RAIL_WAGON,

    76

	CMD_SELL_ROAD_VEH,

    77

	CMD_SELL_SHIP,

    78

	CMD_SELL_AIRCRAFT,

    79

};

    80

    81

const uint32 _veh_refit_proc_table[] = {

    82

	CMD_REFIT_RAIL_VEHICLE,

    83

	CMD_REFIT_ROAD_VEH,

    84

	CMD_REFIT_SHIP,

    85

	CMD_REFIT_AIRCRAFT,

    86

};

    87

    88

const uint32 _send_to_depot_proc_table[] = {

    89

	CMD_SEND_TRAIN_TO_DEPOT,

    90

	CMD_SEND_ROADVEH_TO_DEPOT,

    91

	CMD_SEND_SHIP_TO_DEPOT,

    92

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    93

};

    94

    95

    96

/* Initialize the vehicle-pool */

    97

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    98

    99

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

   100

 * @param *p The vehicle owner

   101

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

   102

 */

   103

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

   104

{

   105

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

   106

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

   107

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

   108

	 * argument rather than finding it again. */

   109

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

   110

   111

	if (!p->engine_renew) return false;

   112

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

   113

	if (this->age == 0) return false; // rail cars don't age and lacks a max age

   114

   115

	return true;

   116

}

   117

   118

void VehicleServiceInDepot(Vehicle *v)

   119

{

   120

	v->date_of_last_service = _date;

   121

	v->breakdowns_since_last_service = 0;

   122

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

   123

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

   124

}

   125

   126

bool Vehicle::NeedsServicing() const

   127

{

   128

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

   129

   130

	if (_settings_game.order.no_servicing_if_no_breakdowns && _settings_game.difficulty.vehicle_breakdowns == 0) {

   131

		/* Vehicles set for autoreplacing needs to go to a depot even if breakdowns are turned off.

   132

		 * Note: If servicing is enabled, we postpone replacement till next service. */

   133

		return EngineHasReplacementForPlayer(GetPlayer(this->owner), this->engine_type, this->group_id);

   134

	}

   135

   136

	return _settings_game.vehicle.servint_ispercent ?

   137

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

   138

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

   139

}

   140

   141

bool Vehicle::NeedsAutomaticServicing() const

   142

{

   143

	if (_settings_game.order.gotodepot && VehicleHasDepotOrders(this)) return false;

   144

	if (this->current_order.IsType(OT_LOADING))            return false;

   145

	if (this->current_order.IsType(OT_GOTO_DEPOT) && this->current_order.GetDepotOrderType() != ODTFB_SERVICE) return false;

   146

	return NeedsServicing();

   147

}

   148

   149

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   150

{

   151

	switch (v->type) {

   152

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   153

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   154

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   155

		default:           return STR_980E_SHIP_IN_THE_WAY;

   156

	}

   157

}

   158

   159

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

   160

{

   161

	byte z = *(byte*)data;

   162

   163

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

   164

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

   165

   166

	_error_message = VehicleInTheWayErrMsg(v);

   167

	return v;

   168

}

   169

   170

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   171

{

   172

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

   173

}

   174

   175

bool EnsureNoVehicleOnGround(TileIndex tile)

   176

{

   177

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

   178

}

   179

   180

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

   181

{

   182

	int x1 = TileX(from);

   183

	int y1 = TileY(from);

   184

	int x2 = TileX(to);

   185

	int y2 = TileY(to);

   186

	Vehicle *veh;

   187

   188

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

   189

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

   190

		Swap(x1, x2);

   191

		Swap(y1, y2);

   192

	}

   193

	FOR_ALL_VEHICLES(veh) {

   194

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

   195

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

   196

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

   197

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

   198

				return veh;

   199

			}

   200

		}

   201

	}

   202

	return NULL;

   203

}

   204

   205

   206

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

   207

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

   208

{

   209

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

   210

   211

	_error_message = VehicleInTheWayErrMsg(v);

   212

	return v;

   213

}

   214

   215

/**

   216

 * Finds vehicle in tunnel / bridge

   217

 * @param tile first end

   218

 * @param endtile second end

   219

 * @return pointer to vehicle found

   220

 */

   221

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   222

{

   223

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

   224

	if (v != NULL) return v;

   225

   226

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

   227

}

   228

   229

   230

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

   231

   232

void VehiclePositionChanged(Vehicle *v)

   233

{

   234

	int img = v->cur_image;

   235

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

   236

	const Sprite *spr = GetSprite(img);

   237

   238

	pt.x += spr->x_offs;

   239

	pt.y += spr->y_offs;

   240

   241

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

   242

   243

	v->left_coord = pt.x;

   244

	v->top_coord = pt.y;

   245

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

   246

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

   247

}

   248

   249

/** Called after load to update coordinates */

   250

void AfterLoadVehicles(bool clear_te_id)

   251

{

   252

	Vehicle *v;

   253

   254

	FOR_ALL_VEHICLES(v) {

   255

		/* Reinstate the previous pointer */

   256

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

   257

   258

		v->UpdateDeltaXY(v->direction);

   259

   260

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   261

		v->first = NULL;

   262

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

   263

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

   264

   265

		v->cargo.InvalidateCache();

   266

	}

   267

   268

	FOR_ALL_VEHICLES(v) {

   269

		/* Fill the first pointers */

   270

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

   271

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

   272

				u->first = v;

   273

			}

   274

		}

   275

	}

   276

   277

	FOR_ALL_VEHICLES(v) {

   278

		assert(v->first != NULL);

   279

   280

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

   281

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

   282

			TrainConsistChanged(v);

   283

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

   284

			RoadVehUpdateCache(v);

   285

		}

   286

	}

   287

   288

	FOR_ALL_VEHICLES(v) {

   289

		switch (v->type) {

   290

			case VEH_ROAD:

   291

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

   292

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

   293

				/* FALL THROUGH */

   294

			case VEH_TRAIN:

   295

			case VEH_SHIP:

   296

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

   297

				break;

   298

   299

			case VEH_AIRCRAFT:

   300

				if (IsNormalAircraft(v)) {

   301

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

   302

   303

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

   304

					Vehicle *shadow = v->Next();

   305

					shadow->cur_image = v->cur_image;

   306

   307

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

   308

					if (v->subtype == AIR_HELICOPTER) {

   309

						Vehicle *rotor = shadow->Next();

   310

						rotor->cur_image = GetRotorImage(v);

   311

					}

   312

   313

					UpdateAircraftCache(v);

   314

				}

   315

				break;

   316

			default: break;

   317

		}

   318

   319

		v->left_coord = INVALID_COORD;

   320

		VehiclePositionChanged(v);

   321

	}

   322

}

   323

   324

Vehicle::Vehicle()

   325

{

   326

	this->type               = VEH_INVALID;

   327

	this->left_coord         = INVALID_COORD;

   328

	this->group_id           = DEFAULT_GROUP;

   329

	this->fill_percent_te_id = INVALID_TE_ID;

   330

	this->first              = this;

   331

	this->colormap           = PAL_NONE;

   332

}

   333

   334

/**

   335

 * Get a value for a vehicle's random_bits.

   336

 * @return A random value from 0 to 255.

   337

 */

   338

byte VehicleRandomBits()

   339

{

   340

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

   341

}

   342

   343

   344

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

   345

{

   346

	uint counter = _Vehicle_pool.first_free_index;

   347

   348

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

   349

		Vehicle *v = AllocateRaw(counter);

   350

   351

		if (v == NULL) return false;

   352

		v = new (v) InvalidVehicle();

   353

   354

		if (vl != NULL) {

   355

			vl[i] = v;

   356

		}

   357

		counter++;

   358

	}

   359

   360

	return true;

   361

}

   362

   363

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

   364

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

   365

const int HASH_BITS = 7;

   366

const int HASH_SIZE = 1 << HASH_BITS;

   367

const int HASH_MASK = HASH_SIZE - 1;

   368

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

   369

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   370

   371

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

   372

 * Profiling results show that 0 is fastest. */

   373

const int HASH_RES = 0;

   374

   375

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   376

   377

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

   378

{

   379

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

   380

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

   381

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

   382

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

   383

				void *a = proc(v, data);

   384

				if (a != NULL) return a;

   385

			}

   386

			if (x == xu) break;

   387

		}

   388

		if (y == yu) break;

   389

	}

   390

   391

	return NULL;

   392

}

   393

   394

   395

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

   396

{

   397

	const int COLL_DIST = 6;

   398

   399

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

   400

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

   401

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

   402

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

   403

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

   404

   405

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

   406

}

   407

   408

   409

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

   410

{

   411

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

   412

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

   413

   414

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

   415

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

   416

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

   417

   418

		void *a = proc(v, data);

   419

		if (a != NULL) return a;

   420

	}

   421

   422

	return NULL;

   423

}

   424

   425

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   426

{

   427

	Vehicle **old_hash = v->old_new_hash;

   428

	Vehicle **new_hash;

   429

   430

	if (remove) {

   431

		new_hash = NULL;

   432

	} else {

   433

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

   434

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

   435

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

   436

	}

   437

   438

	if (old_hash == new_hash) return;

   439

   440

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

   441

	if (old_hash != NULL) {

   442

		Vehicle *last = NULL;

   443

		Vehicle *u = *old_hash;

   444

		while (u != v) {

   445

			last = u;

   446

			u = u->next_new_hash;

   447

			assert(u != NULL);

   448

		}

   449

   450

		if (last == NULL) {

   451

			*old_hash = v->next_new_hash;

   452

		} else {

   453

			last->next_new_hash = v->next_new_hash;

   454

		}

   455

	}

   456

   457

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

   458

	if (new_hash != NULL) {

   459

		v->next_new_hash = *new_hash;

   460

		*new_hash = v;

   461

		assert(v != v->next_new_hash);

   462

	}

   463

   464

	/* Remember current hash position */

   465

	v->old_new_hash = new_hash;

   466

}

   467

   468

static Vehicle *_vehicle_position_hash[0x1000];

   469

   470

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

   471

{

   472

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   473

   474

	Vehicle **old_hash, **new_hash;

   475

	int old_x = v->left_coord;

   476

	int old_y = v->top_coord;

   477

   478

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

   479

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

   480

   481

	if (old_hash == new_hash) return;

   482

   483

	/* remove from hash table? */

   484

	if (old_hash != NULL) {

   485

		Vehicle *last = NULL;

   486

		Vehicle *u = *old_hash;

   487

		while (u != v) {

   488

			last = u;