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

void VehicleServiceInDepot(Vehicle *v)

    97

{

    98

	v->date_of_last_service = _date;

    99

	v->breakdowns_since_last_service = 0;

   100

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

   101

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

   102

}

   103

   104

bool VehicleNeedsService(const Vehicle *v)

   105

{

   106

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

   107

	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

   108

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

   109

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

   110

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

   111

	}

   112

   113

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

   114

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

   115

	}

   116

   117

	return _patches.servint_ispercent ?

   118

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

   119

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

   120

}

   121

   122

StringID VehicleInTheWayErrMsg(const Vehicle* v)

   123

{

   124

	switch (v->type) {

   125

		case VEH_TRAIN:    return STR_8803_TRAIN_IN_THE_WAY;

   126

		case VEH_ROAD:     return STR_9000_ROAD_VEHICLE_IN_THE_WAY;

   127

		case VEH_AIRCRAFT: return STR_A015_AIRCRAFT_IN_THE_WAY;

   128

		default:           return STR_980E_SHIP_IN_THE_WAY;

   129

	}

   130

}

   131

   132

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

   133

{

   134

	byte z = *(byte*)data;

   135

   136

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

   137

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

   138

   139

	_error_message = VehicleInTheWayErrMsg(v);

   140

	return v;

   141

}

   142

   143

Vehicle *FindVehicleOnTileZ(TileIndex tile, byte z)

   144

{

   145

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

   146

}

   147

   148

bool EnsureNoVehicleOnGround(TileIndex tile)

   149

{

   150

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

   151

}

   152

   153

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

   154

{

   155

	int x1 = TileX(from);

   156

	int y1 = TileY(from);

   157

	int x2 = TileX(to);

   158

	int y2 = TileY(to);

   159

	Vehicle *veh;

   160

   161

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

   162

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

   163

		Swap(x1, x2);

   164

		Swap(y1, y2);

   165

	}

   166

	FOR_ALL_VEHICLES(veh) {

   167

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

   168

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

   169

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

   170

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

   171

				return veh;

   172

			}

   173

		}

   174

	}

   175

	return NULL;

   176

}

   177

   178

   179

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

   180

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

   181

{

   182

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

   183

   184

	_error_message = VehicleInTheWayErrMsg(v);

   185

	return v;

   186

}

   187

   188

/**

   189

 * Finds vehicle in tunnel / bridge

   190

 * @param tile first end

   191

 * @param endtile second end

   192

 * @return pointer to vehicle found

   193

 */

   194

Vehicle *GetVehicleTunnelBridge(TileIndex tile, TileIndex endtile)

   195

{

   196

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

   197

	if (v != NULL) return v;

   198

   199

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

   200

}

   201

   202

   203

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

   204

   205

void VehiclePositionChanged(Vehicle *v)

   206

{

   207

	int img = v->cur_image;

   208

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

   209

	const Sprite* spr = GetSprite(img);

   210

   211

	pt.x += spr->x_offs;

   212

	pt.y += spr->y_offs;

   213

   214

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

   215

   216

	v->left_coord = pt.x;

   217

	v->top_coord = pt.y;

   218

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

   219

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

   220

}

   221

   222

/** Called after load to update coordinates */

   223

void AfterLoadVehicles(bool clear_te_id)

   224

{

   225

	Vehicle *v;

   226

   227

	FOR_ALL_VEHICLES(v) {

   228

		/* Reinstate the previous pointer */

   229

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

   230

   231

		v->UpdateDeltaXY(v->direction);

   232

   233

		if (clear_te_id) v->fill_percent_te_id = INVALID_TE_ID;

   234

		v->first = NULL;

   235

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

   236

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

   237

   238

		v->cargo.InvalidateCache();

   239

	}

   240

   241

	FOR_ALL_VEHICLES(v) {

   242

		/* Fill the first pointers */

   243

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

   244

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

   245

				u->first = v;

   246

			}

   247

		}

   248

	}

   249

   250

	FOR_ALL_VEHICLES(v) {

   251

		assert(v->first != NULL);

   252

   253

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

   254

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

   255

			TrainConsistChanged(v);

   256

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

   257

			RoadVehUpdateCache(v);

   258

		}

   259

	}

   260

   261

	FOR_ALL_VEHICLES(v) {

   262

		switch (v->type) {

   263

			case VEH_ROAD:

   264

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

   265

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

   266

				/* FALL THROUGH */

   267

			case VEH_TRAIN:

   268

			case VEH_SHIP:

   269

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

   270

				break;

   271

   272

			case VEH_AIRCRAFT:

   273

				if (IsNormalAircraft(v)) {

   274

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

   275

   276

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

   277

					Vehicle *shadow = v->Next();

   278

					shadow->cur_image = v->cur_image;

   279

   280

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

   281

					if (v->subtype == AIR_HELICOPTER) {

   282

						Vehicle *rotor = shadow->Next();

   283

						rotor->cur_image = GetRotorImage(v);

   284

					}

   285

   286

					UpdateAircraftCache(v);

   287

				}

   288

				break;

   289

			default: break;

   290

		}

   291

   292

		v->left_coord = INVALID_COORD;

   293

		VehiclePositionChanged(v);

   294

	}

   295

}

   296

   297

Vehicle::Vehicle()

   298

{

   299

	this->type               = VEH_INVALID;

   300

	this->left_coord         = INVALID_COORD;

   301

	this->group_id           = DEFAULT_GROUP;

   302

	this->fill_percent_te_id = INVALID_TE_ID;

   303

	this->first              = this;

   304

	this->colormap           = PAL_NONE;

   305

}

   306

   307

/**

   308

 * Get a value for a vehicle's random_bits.

   309

 * @return A random value from 0 to 255.

   310

 */

   311

byte VehicleRandomBits()

   312

{

   313

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

   314

}

   315

   316

   317

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

   318

{

   319

	uint counter = _Vehicle_pool.first_free_index;

   320

   321

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

   322

		Vehicle *v = AllocateRaw(counter);

   323

   324

		if (v == NULL) return false;

   325

		v = new (v) InvalidVehicle();

   326

   327

		if (vl != NULL) {

   328

			vl[i] = v;

   329

		}

   330

		counter++;

   331

	}

   332

   333

	return true;

   334

}

   335

   336

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

   337

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

   338

const int HASH_BITS = 7;

   339

const int HASH_SIZE = 1 << HASH_BITS;

   340

const int HASH_MASK = HASH_SIZE - 1;

   341

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

   342

const int TOTAL_HASH_MASK = TOTAL_HASH_SIZE - 1;

   343

   344

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

   345

 * Profiling results show that 0 is fastest. */

   346

const int HASH_RES = 0;

   347

   348

static Vehicle *_new_vehicle_position_hash[TOTAL_HASH_SIZE];

   349

   350

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

   351

{

   352

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

   353

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

   354

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

   355

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

   356

				void *a = proc(v, data);

   357

				if (a != NULL) return a;

   358

			}

   359

			if (x == xu) break;

   360

		}

   361

		if (y == yu) break;

   362

	}

   363

   364

	return NULL;

   365

}

   366

   367

   368

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

   369

{

   370

	const int COLL_DIST = 6;

   371

   372

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

   373

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

   374

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

   375

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

   376

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

   377

   378

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

   379

}

   380

   381

   382

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

   383

{

   384

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

   385

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

   386

   387

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

   388

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

   389

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

   390

   391

		void *a = proc(v, data);

   392

		if (a != NULL) return a;

   393

	}

   394

   395

	return NULL;

   396

}

   397

   398

static void UpdateNewVehiclePosHash(Vehicle *v, bool remove)

   399

{

   400

	Vehicle **old_hash = v->old_new_hash;

   401

	Vehicle **new_hash;

   402

   403

	if (remove) {

   404

		new_hash = NULL;

   405

	} else {

   406

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

   407

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

   408

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

   409

	}

   410

   411

	if (old_hash == new_hash) return;

   412

   413

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

   414

	if (old_hash != NULL) {

   415

		Vehicle *last = NULL;

   416

		Vehicle *u = *old_hash;

   417

		while (u != v) {

   418

			last = u;

   419

			u = u->next_new_hash;

   420

			assert(u != NULL);

   421

		}

   422

   423

		if (last == NULL) {

   424

			*old_hash = v->next_new_hash;

   425

		} else {

   426

			last->next_new_hash = v->next_new_hash;

   427

		}

   428

	}

   429

   430

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

   431

	if (new_hash != NULL) {

   432

		v->next_new_hash = *new_hash;

   433

		*new_hash = v;

   434

		assert(v != v->next_new_hash);

   435

	}

   436

   437

	/* Remember current hash position */

   438

	v->old_new_hash = new_hash;

   439

}

   440

   441

static Vehicle *_vehicle_position_hash[0x1000];

   442

   443

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

   444

{

   445

	UpdateNewVehiclePosHash(v, x == INVALID_COORD);

   446

   447

	Vehicle **old_hash, **new_hash;

   448

	int old_x = v->left_coord;

   449

	int old_y = v->top_coord;

   450

   451

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

   452

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

   453

   454

	if (old_hash == new_hash) return;

   455

   456

	/* remove from hash table? */

   457

	if (old_hash != NULL) {

   458

		Vehicle *last = NULL;

   459

		Vehicle *u = *old_hash;

   460

		while (u != v) {

   461

			last = u;

   462

			u = u->next_hash;

   463

			assert(u != NULL);

   464

		}

   465

   466

		if (last == NULL) {

   467

			*old_hash = v->next_hash;

   468

		} else {

   469

			last->next_hash = v->next_hash;

   470

		}

   471

	}

   472

   473

	/* insert into hash table? */

   474

	if (new_hash != NULL) {

   475

		v->next_hash = *new_hash;

   476

		*new_hash = v;

   477

	}

   478

}

   479

   480

void ResetVehiclePosHash()

   481

{

   482

	Vehicle *v;

   483

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

   484

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

   485

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

   486

}

   487

   488

void ResetVehicleColorMap()