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

#include "oldpool_func.h"

    50

    51

#include "table/sprites.h"

    52

#include "table/strings.h"

    53

    54

#define INVALID_COORD (0x7fffffff)

    55

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

    56

    57

VehicleID _vehicle_id_ctr_day;

    58

Vehicle *_place_clicked_vehicle;

    59

VehicleID _new_vehicle_id;

    60

uint16 _returned_refit_capacity;

    61

    62

    63

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

    64

const uint32 _veh_build_proc_table[] = {

    65

	CMD_BUILD_RAIL_VEHICLE,

    66

	CMD_BUILD_ROAD_VEH,

    67

	CMD_BUILD_SHIP,

    68

	CMD_BUILD_AIRCRAFT,

    69

};

    70

const uint32 _veh_sell_proc_table[] = {

    71

	CMD_SELL_RAIL_WAGON,

    72

	CMD_SELL_ROAD_VEH,

    73

	CMD_SELL_SHIP,

    74

	CMD_SELL_AIRCRAFT,

    75

};

    76

    77

const uint32 _veh_refit_proc_table[] = {

    78

	CMD_REFIT_RAIL_VEHICLE,

    79

	CMD_REFIT_ROAD_VEH,

    80

	CMD_REFIT_SHIP,

    81

	CMD_REFIT_AIRCRAFT,

    82

};

    83

    84

const uint32 _send_to_depot_proc_table[] = {

    85

	CMD_SEND_TRAIN_TO_DEPOT,

    86

	CMD_SEND_ROADVEH_TO_DEPOT,

    87

	CMD_SEND_SHIP_TO_DEPOT,

    88

	CMD_SEND_AIRCRAFT_TO_HANGAR,

    89

};

    90

    91

    92

/* Initialize the vehicle-pool */

    93

DEFINE_OLD_POOL_GENERIC(Vehicle, Vehicle)

    94

    95

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

    96

 * @param *p The vehicle owner

    97

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

    98

 */

    99

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

   100

{

   101

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

   102

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

   103

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

   104

	 * argument rather than finding it again. */

   105

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

   106

   107

	if (!p->engine_renew) return false;

   108

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

   109

   110

	return true;

   111

}

   112

   113

void VehicleServiceInDepot(Vehicle *v)

   114

{

   115

	v->date_of_last_service = _date;

   116

	v->breakdowns_since_last_service = 0;

   117

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

   118

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

   119

}

   120

   121

bool Vehicle::NeedsServicing() const

   122

{

   123

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

   124

   125

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

   126

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

   127

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

   128

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

   129

	}

   130

   131

	return _patches.servint_ispercent ?

   132

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

   133

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

   134

}

   135

   136

bool Vehicle::NeedsAutomaticServicing() const

   137

{

   138

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

   139

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

   140

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

   141

	return NeedsServicing();

   142

}

   143

   144

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   145

{

   146

	switch (v->type) {

   147

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   148

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   149

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   150

		default:           return STR_980E_SHIP_IN_THE_WAY;

   151

	}

   152

}

   153

   154

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

   155

{

   156

	byte z = *(byte*)data;

   157

   158

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

   159

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

   160

   161

	_error_message = VehicleInTheWayErrMsg(v);

   162

	return v;

   163

}

   164

   165

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   166

{

   167

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

   168

}

   169

   170

bool EnsureNoVehicleOnGround(TileIndex tile)

   171

{

   172

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

   173

}

   174

   175

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

   176

{

   177

	int x1 = TileX(from);

   178

	int y1 = TileY(from);

   179

	int x2 = TileX(to);

   180

	int y2 = TileY(to);

   181

	Vehicle *veh;

   182

   183

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

   184

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

   185

		Swap(x1, x2);

   186

		Swap(y1, y2);

   187

	}

   188

	FOR_ALL_VEHICLES(veh) {

   189

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

   190

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

   191

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

   192

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

   193

				return veh;

   194

			}

   195

		}

   196

	}

   197

	return NULL;

   198

}

   199

   200

   201

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

   202

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

   203

{

   204

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

   205

   206

	_error_message = VehicleInTheWayErrMsg(v);

   207

	return v;

   208

}

   209

   210

/**

   211

 * Finds vehicle in tunnel / bridge

   212

 * @param tile first end

   213

 * @param endtile second end

   214

 * @return pointer to vehicle found

   215

 */

   216

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   217

{

   218

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

   219

	if (v != NULL) return v;

   220

   221

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

   222

}

   223

   224

   225

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

   226

   227

void VehiclePositionChanged(Vehicle *v)

   228

{

   229

	int img = v->cur_image;

   230

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

   231

	const Sprite *spr = GetSprite(img);

   232

   233

	pt.x += spr->x_offs;

   234

	pt.y += spr->y_offs;

   235

   236

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

   237

   238

	v->left_coord = pt.x;

   239

	v->top_coord = pt.y;

   240

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

   241

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

   242

}

   243

   244

/** Called after load to update coordinates */

   245

void AfterLoadVehicles(bool clear_te_id)

   246

{

   247

	Vehicle *v;

   248

   249

	FOR_ALL_VEHICLES(v) {

   250

		/* Reinstate the previous pointer */

   251

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

   252

   253

		v->UpdateDeltaXY(v->direction);

   254

   255

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   256

		v->first = NULL;

   257

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

   258

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

   259

   260

		v->cargo.InvalidateCache();

   261

	}

   262

   263

	FOR_ALL_VEHICLES(v) {

   264

		/* Fill the first pointers */

   265

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

   266

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

   267

				u->first = v;

   268

			}

   269

		}

   270

	}

   271

   272

	FOR_ALL_VEHICLES(v) {

   273

		assert(v->first != NULL);

   274

   275

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

   276

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

   277

			TrainConsistChanged(v);

   278

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

   279

			RoadVehUpdateCache(v);

   280

		}

   281

	}

   282

   283

	FOR_ALL_VEHICLES(v) {

   284

		switch (v->type) {

   285

			case VEH_ROAD:

   286

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

   287

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

   288

				/* FALL THROUGH */

   289

			case VEH_TRAIN:

   290

			case VEH_SHIP:

   291

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

   292

				break;

   293

   294

			case VEH_AIRCRAFT:

   295

				if (IsNormalAircraft(v)) {

   296

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

   297

   298

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

   299

					Vehicle *shadow = v->Next();

   300

					shadow->cur_image = v->cur_image;

   301

   302

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

   303

					if (v->subtype == AIR_HELICOPTER) {

   304

						Vehicle *rotor = shadow->Next();

   305

						rotor->cur_image = GetRotorImage(v);

   306

					}

   307

   308

					UpdateAircraftCache(v);

   309

				}

   310

				break;

   311

			default: break;

   312

		}

   313

   314

		v->left_coord = INVALID_COORD;

   315

		VehiclePositionChanged(v);

   316

	}

   317

}

   318

   319

Vehicle::Vehicle()

   320

{

   321

	this->type               = VEH_INVALID;

   322

	this->left_coord         = INVALID_COORD;

   323

	this->group_id           = DEFAULT_GROUP;

   324

	this->fill_percent_te_id = INVALID_TE_ID;

   325

	this->first              = this;

   326

	this->colormap           = PAL_NONE;

   327

}

   328

   329

/**

   330

 * Get a value for a vehicle's random_bits.

   331

 * @return A random value from 0 to 255.

   332

 */

   333

byte VehicleRandomBits()

   334

{

   335

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

   336

}

   337

   338

   339

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

   340

{

   341

	uint counter = _Vehicle_pool.first_free_index;

   342

   343

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

   344

		Vehicle *v = AllocateRaw(counter);

   345

   346

		if (v == NULL) return false;

   347

		v = new (v) InvalidVehicle();

   348

   349

		if (vl != NULL) {

   350

			vl[i] = v;

   351

		}

   352

		counter++;

   353

	}

   354

   355

	return true;

   356

}

   357

   358

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

   359

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

   360

const int HASH_BITS = 7;

   361

const int HASH_SIZE = 1 << HASH_BITS;

   362

const int HASH_MASK = HASH_SIZE - 1;

   363

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

   364

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   365

   366

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

   367

 * Profiling results show that 0 is fastest. */

   368

const int HASH_RES = 0;

   369

   370

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   371

   372

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

   373

{

   374

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

   375

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

   376

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

   377

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

   378

				void *a = proc(v, data);

   379

				if (a != NULL) return a;

   380

			}

   381

			if (x == xu) break;

   382

		}

   383

		if (y == yu) break;

   384

	}

   385

   386

	return NULL;

   387

}

   388

   389

   390

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

   391

{

   392

	const int COLL_DIST = 6;

   393

   394

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

   395

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

   396

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

   397

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

   398

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

   399

   400

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

   401

}

   402

   403

   404

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

   405

{

   406

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

   407

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

   408

   409

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

   410

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

   411

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

   412

   413

		void *a = proc(v, data);

   414

		if (a != NULL) return a;

   415

	}

   416

   417

	return NULL;

   418

}

   419

   420

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   421

{

   422

	Vehicle **old_hash = v->old_new_hash;

   423

	Vehicle **new_hash;

   424

   425

	if (remove) {

   426

		new_hash = NULL;

   427

	} else {

   428

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

   429

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

   430

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

   431

	}

   432

   433

	if (old_hash == new_hash) return;

   434

   435

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

   436

	if (old_hash != NULL) {

   437

		Vehicle *last = NULL;

   438

		Vehicle *u = *old_hash;

   439

		while (u != v) {

   440

			last = u;

   441

			u = u->next_new_hash;

   442

			assert(u != NULL);

   443

		}

   444

   445

		if (last == NULL) {

   446

			*old_hash = v->next_new_hash;

   447

		} else {

   448

			last->next_new_hash = v->next_new_hash;

   449

		}

   450

	}

   451

   452

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

   453

	if (new_hash != NULL) {

   454

		v->next_new_hash = *new_hash;

   455

		*new_hash = v;

   456

		assert(v != v->next_new_hash);

   457

	}

   458

   459

	/* Remember current hash position */

   460

	v->old_new_hash = new_hash;

   461

}

   462

   463

static Vehicle *_vehicle_position_hash[0x1000];

   464

   465

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

   466

{

   467

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   468

   469

	Vehicle **old_hash, **new_hash;

   470

	int old_x = v->left_coord;

   471

	int old_y = v->top_coord;

   472

   473

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

   474

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

   475

   476

	if (old_hash == new_hash) return;

   477

   478

	/* remove from hash table? */

   479

	if (old_hash != NULL) {

   480

		Vehicle *last = NULL;

   481

		Vehicle *u = *old_hash;

   482

		while (u != v) {

   483

			last = u;

   484

			u = u->next_hash;

   485

			assert(u != NULL);

   486

		}

   487

   488