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

    29

#include "yapf/yapf.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_engine.h"

    32

#include "newgrf_sound.h"

    33

#include "newgrf_station.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

#include "oldpool_func.h"

    50

#include "depot_map.h"

    51

#include "animated_tile_func.h"

    52

#include "effectvehicle_base.h"

    53

#include "core/alloc_func.hpp"

    55

    56

#include "table/sprites.h"

    57

#include "table/strings.h"

    58

    59

#define INVALID_COORD (0x7fffffff)

    60

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

    61

    62

VehicleID _vehicle_id_ctr_day;

    63

const Vehicle *_place_clicked_vehicle;

    64

VehicleID _new_vehicle_id;

    65

uint16 _returned_refit_capacity;

    66

    67

    68

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

    69

const uint32 _veh_build_proc_table[] = {

    70

	CMD_BUILD_RAIL_VEHICLE,

    71

	CMD_BUILD_ROAD_VEH,

    72

	CMD_BUILD_SHIP,

    73

	CMD_BUILD_AIRCRAFT,

    74

};

    75

const uint32 _veh_sell_proc_table[] = {

    76

	CMD_SELL_RAIL_WAGON,

    77

	CMD_SELL_ROAD_VEH,

    78

	CMD_SELL_SHIP,

    79

	CMD_SELL_AIRCRAFT,

    80

};

    81

    82

const uint32 _veh_refit_proc_table[] = {

    83

	CMD_REFIT_RAIL_VEHICLE,

    84

	CMD_REFIT_ROAD_VEH,

    85

	CMD_REFIT_SHIP,

    86

	CMD_REFIT_AIRCRAFT,

    87

};

    88

    89

const uint32 _send_to_depot_proc_table[] = {

    90

	CMD_SEND_TRAIN_TO_DEPOT,

    91

	CMD_SEND_ROADVEH_TO_DEPOT,

    92

	CMD_SEND_SHIP_TO_DEPOT,

    93

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    94

};

    95

    96

    97

/* Initialize the vehicle-pool */

    98

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    99

   100

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

   101

 * @param *p The vehicle owner

   102

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

   103

 */

   104

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

   105

{

   106

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

   107

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

   108

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

   109

	 * argument rather than finding it again. */

   110

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

   111

   112

	if (!p->engine_renew) return false;

   113

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

   114

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

   115

   116

	return true;

   117

}

   118

   119

void VehicleServiceInDepot(Vehicle *v)

   120

{

   121

	v->date_of_last_service = _date;

   122

	v->breakdowns_since_last_service = 0;

   123

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

   124

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

   125

}

   126

   127

bool Vehicle::NeedsServicing() const

   128

{

   129

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

   130

   131

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

   132

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

   133

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

   134

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

   135

	}

   136

   137

	return _settings.vehicle.servint_ispercent ?

   138

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

   139

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

   140

}

   141

   142

bool Vehicle::NeedsAutomaticServicing() const

   143

{

   144

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

   145

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

   146

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

   147

	return NeedsServicing();

   148

}

   149

   150

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   151

{

   152

	switch (v->type) {

   153

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   154

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   155

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   156

		default:           return STR_980E_SHIP_IN_THE_WAY;

   157

	}

   158

}

   159

   160

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

   161

{

   162

	byte z = *(byte*)data;

   163

   164

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

   165

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

   166

   167

	_error_message = VehicleInTheWayErrMsg(v);

   168

	return v;

   169

}

   170

   171

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   172

{

   173

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

   174

}

   175

   176

bool EnsureNoVehicleOnGround(TileIndex tile)

   177

{

   178

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

   179

}

   180

   181

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

   182

{

   183

	int x1 = TileX(from);

   184

	int y1 = TileY(from);

   185

	int x2 = TileX(to);

   186

	int y2 = TileY(to);

   187

	Vehicle *veh;

   188

   189

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

   190

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

   191

		Swap(x1, x2);

   192

		Swap(y1, y2);

   193

	}

   194

	FOR_ALL_VEHICLES(veh) {

   195

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

   196

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

   197

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

   198

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

   199

				return veh;

   200

			}

   201

		}

   202

	}

   203

	return NULL;

   204

}

   205

   206

   207

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

   208

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

   209

{

   210

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

   211

   212

	_error_message = VehicleInTheWayErrMsg(v);

   213

	return v;

   214

}

   215

   216

/**

   217

 * Finds vehicle in tunnel / bridge

   218

 * @param tile first end

   219

 * @param endtile second end

   220

 * @return pointer to vehicle found

   221

 */

   222

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   223

{

   224

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

   225

	if (v != NULL) return v;

   226

   227

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

   228

}

   229

   230

   231

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

   232

   233

void VehiclePositionChanged(Vehicle *v)

   234

{

   235

	int img = v->cur_image;

   236

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

   237

	const Sprite *spr = GetSprite(img);

   238

   239

	pt.x += spr->x_offs;

   240

	pt.y += spr->y_offs;

   241

   242

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

   243

   244

	v->left_coord = pt.x;

   245

	v->top_coord = pt.y;

   246

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

   247

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

   248

}

   249

   250

/** Called after load to update coordinates */

   251

void AfterLoadVehicles(bool clear_te_id)

   252

{

   253

	Vehicle *v;

   254

   255

	FOR_ALL_VEHICLES(v) {

   256

		/* Reinstate the previous pointer */

   257

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

   258

   259

		v->UpdateDeltaXY(v->direction);

   260

   261

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   262

		v->first = NULL;

   263

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

   264

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

   265

   266

		v->cargo.InvalidateCache();

   267

	}

   268

   269

	FOR_ALL_VEHICLES(v) {

   270

		/* Fill the first pointers */

   271

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

   272

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

   273

				u->first = v;

   274

			}

   275

		}

   276

	}

   277

   278

	FOR_ALL_VEHICLES(v) {

   279

		assert(v->first != NULL);

   280

   281

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

   282

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

   283

			TrainConsistChanged(v);

   284

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

   285

			RoadVehUpdateCache(v);

   286

		}

   287

	}

   288

   289

	FOR_ALL_VEHICLES(v) {

   290

		switch (v->type) {

   291

			case VEH_ROAD:

   292

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

   293

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

   294

				/* FALL THROUGH */

   295

			case VEH_TRAIN:

   296

			case VEH_SHIP:

   297

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

   298

				break;

   299

   300

			case VEH_AIRCRAFT:

   301

				if (IsNormalAircraft(v)) {

   302

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

   303

   304

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

   305

					Vehicle *shadow = v->Next();

   306

					shadow->cur_image = v->cur_image;

   307

   308

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

   309

					if (v->subtype == AIR_HELICOPTER) {

   310

						Vehicle *rotor = shadow->Next();

   311

						rotor->cur_image = GetRotorImage(v);

   312

					}

   313

   314

					UpdateAircraftCache(v);

   315

				}

   316

				break;

   317

			default: break;

   318

		}

   319

   320

		v->left_coord = INVALID_COORD;

   321

		VehiclePositionChanged(v);

   322

	}

   323

}

   324

   325

Vehicle::Vehicle()

   326

{

   327

	this->type               = VEH_INVALID;

   328

	this->left_coord         = INVALID_COORD;

   329

	this->group_id           = DEFAULT_GROUP;

   330

	this->fill_percent_te_id = INVALID_TE_ID;

   331

	this->first              = this;

   332

	this->colormap           = PAL_NONE;

   333

}

   334

   335

/**

   336

 * Get a value for a vehicle's random_bits.

   337

 * @return A random value from 0 to 255.

   338

 */

   339

byte VehicleRandomBits()

   340

{

   341

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

   342

}

   343

   344

   345

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

   346

{

   347

	uint counter = _Vehicle_pool.first_free_index;

   348

   349

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

   350

		Vehicle *v = AllocateRaw(counter);

   351

   352

		if (v == NULL) return false;

   353

		v = new (v) InvalidVehicle();

   354

   355

		if (vl != NULL) {

   356

			vl[i] = v;

   357

		}

   358

		counter++;

   359

	}

   360

   361

	return true;

   362

}

   363

   364

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

   365

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

   366

const int HASH_BITS = 7;

   367

const int HASH_SIZE = 1 << HASH_BITS;

   368

const int HASH_MASK = HASH_SIZE - 1;

   369

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

   370

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   371

   372

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

   373

 * Profiling results show that 0 is fastest. */

   374

const int HASH_RES = 0;

   375

   376

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   377

   378

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

   379

{

   380

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

   381

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

   382

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

   383

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

   384

				void *a = proc(v, data);

   385

				if (a != NULL) return a;

   386

			}

   387

			if (x == xu) break;

   388

		}

   389

		if (y == yu) break;

   390

	}

   391

   392

	return NULL;

   393

}

   394

   395

   396

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

   397

{

   398

	const int COLL_DIST = 6;

   399

   400

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

   401

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

   402

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

   403

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

   404

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

   405

   406

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

   407

}

   408

   409

   410

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

   411

{

   412

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

   413

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

   414

   415

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

   416

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

   417

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

   418

   419

		void *a = proc(v, data);

   420

		if (a != NULL) return a;

   421

	}

   422

   423

	return NULL;

   424

}

   425

   426

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   427

{

   428

	Vehicle **old_hash = v->old_new_hash;

   429

	Vehicle **new_hash;

   430

   431

	if (remove) {

   432

		new_hash = NULL;

   433

	} else {

   434

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

   435

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

   436

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

   437

	}

   438

   439

	if (old_hash == new_hash) return;

   440

   441

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

   442

	if (old_hash != NULL) {

   443

		Vehicle *last = NULL;

   444

		Vehicle *u = *old_hash;

   445

		while (u != v) {

   446

			last = u;

   447

			u = u->next_new_hash;

   448

			assert(u != NULL);

   449

		}

   450

   451

		if (last == NULL) {

   452

			*old_hash = v->next_new_hash;

   453

		} else {

   454

			last->next_new_hash = v->next_new_hash;

   455

		}

   456

	}

   457

   458

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

   459

	if (new_hash != NULL) {

   460

		v->next_new_hash = *new_hash;

   461

		*new_hash = v;

   462

		assert(v != v->next_new_hash);

   463

	}

   464

   465

	/* Remember current hash position */

   466

	v->old_new_hash = new_hash;

   467

}

   468

   469

static Vehicle *_vehicle_position_hash[0x1000];

   470

   471

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

   472

{

   473

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   474

   475

	Vehicle **old_hash, **new_hash;

   476

	int old_x = v->left_coord;

   477

	int old_y = v->top_coord;

   478

   479

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

   480

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

   481

   482

	if (old_hash == new_hash) return;

   483

   484

	/* remove from hash table? */

   485

	if (old_hash != NULL) {

   486

		Vehicle *last = NULL;

   487

		Vehicle *u = *old_hash;