1

/* $Id$ */

     2

     3

/** @file roadveh_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "landscape.h"

    10

#include "road_map.h"

    11

#include "roadveh.h"

    12

#include "station_map.h"

    13

#include "table/strings.h"

    14

#include "map.h"

    15

#include "tile.h"

    16

#include "vehicle.h"

    17

#include "engine.h"

    18

#include "command.h"

    19

#include "station.h"

    20

#include "news.h"

    21

#include "pathfind.h"

    22

#include "npf.h"

    23

#include "player.h"

    24

#include "sound.h"

    25

#include "depot.h"

    26

#include "bridge.h"

    27

#include "tunnel_map.h"

    28

#include "bridge_map.h"

    29

#include "vehicle_gui.h"

    30

#include "articulated_vehicles.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_engine.h"

    33

#include "newgrf_text.h"

    34

#include "newgrf_sound.h"

    35

#include "yapf/yapf.h"

    36

#include "date.h"

    37

#include "cargotype.h"

    38

    39

static const uint16 _roadveh_images[63] = {

    40

	0xCD4, 0xCDC, 0xCE4, 0xCEC, 0xCF4, 0xCFC, 0xD0C, 0xD14,

    41

	0xD24, 0xD1C, 0xD2C, 0xD04, 0xD1C, 0xD24, 0xD6C, 0xD74,

    42

	0xD7C, 0xC14, 0xC1C, 0xC24, 0xC2C, 0xC34, 0xC3C, 0xC4C,

    43

	0xC54, 0xC64, 0xC5C, 0xC6C, 0xC44, 0xC5C, 0xC64, 0xCAC,

    44

	0xCB4, 0xCBC, 0xD94, 0xD9C, 0xDA4, 0xDAC, 0xDB4, 0xDBC,

    45

	0xDCC, 0xDD4, 0xDE4, 0xDDC, 0xDEC, 0xDC4, 0xDDC, 0xDE4,

    46

	0xE2C, 0xE34, 0xE3C, 0xC14, 0xC1C, 0xC2C, 0xC3C, 0xC4C,

    47

	0xC5C, 0xC64, 0xC6C, 0xC74, 0xC84, 0xC94, 0xCA4

    48

};

    49

    50

static const uint16 _roadveh_full_adder[63] = {

    51

	 0,  88,   0,   0,   0,   0,  48,  48,

    52

	48,  48,   0,   0,  64,  64,   0,  16,

    53

	16,   0,  88,   0,   0,   0,   0,  48,

    54

	48,  48,  48,   0,   0,  64,  64,   0,

    55

	16,  16,   0,  88,   0,   0,   0,   0,

    56

	48,  48,  48,  48,   0,   0,  64,  64,

    57

	 0,  16,  16,   0,   8,   8,   8,   8,

    58

	 0,   0,   0,   8,   8,   8,   8

    59

};

    60

    61

/** 'Convert' the DiagDirection where a road vehicle enters to the trackdirs it can drive onto */

    62

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    63

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_X_NE,    // Enter from north east

    64

	TRACKDIR_BIT_LEFT_S  | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_Y_SE,    // Enter from south east

    65

	TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_RIGHT_S, // Enter from south west

    66

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    67

};

    68

    69

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    70

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    71

};

    72

    73

/** 'Convert' the DiagDirection where a road vehicle should exit to

    74

 * the trackdirs it can use to drive to the exit direction*/

    75

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    76

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    77

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    78

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    79

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    80

};

    81

    82

/** Converts the exit direction of a depot to trackdir the vehicle is going to drive to */

    83

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    84

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    85

};

    86

    87

int GetRoadVehImage(const Vehicle* v, Direction direction)

    88

{

    89

	int img = v->spritenum;

    90

	int image;

    91

    92

	if (is_custom_sprite(img)) {

    93

		image = GetCustomVehicleSprite(v, (Direction)(direction + 4 * IS_CUSTOM_SECONDHEAD_SPRITE(img)));

    94

		if (image != 0) return image;

    95

		img = orig_road_vehicle_info[v->engine_type - ROAD_ENGINES_INDEX].image_index;

    96

	}

    97

    98

	image = direction + _roadveh_images[img];

    99

	if (v->cargo_count >= v->cargo_cap / 2) image += _roadveh_full_adder[img];

   100

	return image;

   101

}

   102

   103

void DrawRoadVehEngine(int x, int y, EngineID engine, SpriteID pal)

   104

{

   105

	int spritenum = RoadVehInfo(engine)->image_index;

   106

   107

	if (is_custom_sprite(spritenum)) {

   108

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

   109

   110

		if (sprite != 0) {

   111

			DrawSprite(sprite, pal, x, y);

   112

			return;

   113

		}

   114

		spritenum = orig_road_vehicle_info[engine - ROAD_ENGINES_INDEX].image_index;

   115

	}

   116

	DrawSprite(6 + _roadveh_images[spritenum], pal, x, y);

   117

}

   118

   120

{

   121

	return ((_eco->GetPrice(CEconomy::ROADVEH_BASE) >> 3) * GetEngineProperty(engine_type, 0x11, RoadVehInfo(engine_type)->base_cost)) >> 5;

   122

}

   123

   124

byte GetRoadVehLength(const Vehicle *v)

   125

{

   126

	byte length = 8;

   127

   128

	uint16 veh_len = GetVehicleCallback(CBID_TRAIN_VEHICLE_LENGTH, 0, 0, v->engine_type, v);

   129

	if (veh_len != CALLBACK_FAILED) {

   130

		length -= clamp(veh_len, 0, 7);

   131

	}

   132

   133

	return length;

   134

}

   135

   136

void RoadVehUpdateCache(Vehicle *v)

   137

{

   138

	assert(v->type == VEH_ROAD);

   139

	assert(IsRoadVehFront(v));

   140

   141

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

   142

		/* Update the v->first cache. */

   143

		if (u->first == NULL) u->first = v;

   144

   145

		/* Update the 'first engine' */

   146

		u->u.road.first_engine = (v == u) ? INVALID_ENGINE : v->engine_type;

   147

   148

		/* Update the length of the vehicle. */

   149

		u->u.road.cached_veh_length = GetRoadVehLength(u);

   150

	}

   151

}

   152

   153

/** Build a road vehicle.

   154

 * @param tile tile of depot where road vehicle is built

   155

 * @param flags operation to perform

   156

 * @param p1 bus/truck type being built (engine)

   157

 * @param p2 bit 0 when set, the unitnumber will be 0, otherwise it will be a free number

   158

 */

   160

{

   162

	Vehicle *v;

   163

	UnitID unit_num;

   164

	Engine *e;

   165

   166

	if (!IsEngineBuildable(p1, VEH_ROAD, _current_player)) return_cmd_error(STR_ROAD_VEHICLE_NOT_AVAILABLE);

   167

   168

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   169

   170

	cost = EstimateRoadVehCost(p1);

   171

	if (flags & DC_QUERY_COST) return cost;

   172

   173

	/* The ai_new queries the vehicle cost before building the route,

   174

	 * so we must check against cheaters no sooner than now. --pasky */

   175

	if (!IsTileDepotType(tile, TRANSPORT_ROAD)) return CMD_ERROR;

   176

	if (!IsTileOwner(tile, _current_player)) return CMD_ERROR;

   177

   178

	if (HASBIT(GetRoadTypes(tile), ROADTYPE_TRAM) != HASBIT(EngInfo(p1)->misc_flags, EF_ROAD_TRAM)) return_cmd_error(STR_DEPOT_WRONG_DEPOT_TYPE);

   179

   180

	uint num_vehicles = 1 + CountArticulatedParts(p1);

   181

   182

	/* Allow for the front and up to 10 articulated parts. */

   183

	Vehicle *vl[11];

   184

	memset(&vl, 0, sizeof(vl));

   185

   186

	if (!AllocateVehicles(vl, num_vehicles)) {

   187

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   188

	}

   189

   190

	v = vl[0];

   191

   192

	/* find the first free roadveh id */

   193

	unit_num = HASBIT(p2, 0) ? 0 : GetFreeUnitNumber(VEH_ROAD);

   194

	if (unit_num > _patches.max_roadveh)

   195

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   196

   197

	if (flags & DC_EXEC) {

   198

		int x;

   199

		int y;

   200

   201

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   202

   203

		v->unitnumber = unit_num;

   204

		v->direction = DiagDirToDir(GetRoadDepotDirection(tile));

   205

		v->owner = _current_player;

   206

   207

		v->tile = tile;

   208

		x = TileX(tile) * TILE_SIZE + TILE_SIZE / 2;

   209

		y = TileY(tile) * TILE_SIZE + TILE_SIZE / 2;

   210

		v->x_pos = x;

   211

		v->y_pos = y;

   212

		v->z_pos = GetSlopeZ(x, y);

   213

   214

		v->u.road.state = RVSB_IN_DEPOT;

   215

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   216

   217

		v->spritenum = rvi->image_index;

   218

		v->cargo_type = rvi->cargo_type;

   219

		v->cargo_subtype = 0;

   220

		v->cargo_cap = rvi->capacity;

   221

//		v->cargo_count = 0;

   222

		v->value = cost;

   223

//		v->day_counter = 0;

   224

//		v->next_order_param = v->next_order = 0;

   225

//		v->load_unload_time_rem = 0;

   226

//		v->progress = 0;

   227

   228

//	v->u.road.unk2 = 0;

   229

//	v->u.road.overtaking = 0;

   230

   231

		v->last_station_visited = INVALID_STATION;

   232

		v->max_speed = rvi->max_speed;

   233

		v->engine_type = (byte)p1;

   234

   235

		e = GetEngine(p1);

   236

		v->reliability = e->reliability;

   237

		v->reliability_spd_dec = e->reliability_spd_dec;

   238

		v->max_age = e->lifelength * 366;

   239

		_new_vehicle_id = v->index;

   240

   241

		v->string_id = STR_SV_ROADVEH_NAME;

   242

   243

		v->service_interval = _patches.servint_roadveh;

   244

   245

		v->date_of_last_service = _date;

   246

		v->build_year = _cur_year;

   247

   248

		v = new (v) RoadVehicle();

   249

		v->cur_image = 0xC15;

   250

		v->random_bits = VehicleRandomBits();

   251

		SetRoadVehFront(v);

   252

   253

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

   254

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

   255

		v->u.road.cached_veh_length = GetRoadVehLength(v);

   256

   257

		v->vehicle_flags = 0;

   258

		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) SETBIT(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE);

   259

   260

		v->first = NULL;

   261

		v->cargo_cap = GetVehicleProperty(v, 0x0F, rvi->capacity);

   262

   263

		AddArticulatedParts(vl, VEH_ROAD);

   264

   265

		VehiclePositionChanged(v);

   266

   267

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   268

		RebuildVehicleLists();

   269

		InvalidateWindow(WC_COMPANY, v->owner);

   270

		if (IsLocalPlayer())

   271

			InvalidateAutoreplaceWindow(VEH_ROAD); // updates the replace Road window

   272

   273

		GetPlayer(_current_player)->num_engines[p1]++;

   274

	}

   275

   276

	return cost;

   277

}

   278

   279

/** Start/Stop a road vehicle.

   280

 * @param tile unused

   281

 * @param flags operation to perform

   282

 * @param p1 road vehicle ID to start/stop

   283

 * @param p2 unused

   284

 */

   286

{

   287

	Vehicle *v;

   288

	uint16 callback;

   289

   290

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   291

   292

	v = GetVehicle(p1);

   293

   294

	if (v->type != VEH_ROAD || !CheckOwnership(v->owner)) return CMD_ERROR;

   295

   296

	/* Check if this road veh can be started/stopped. The callback will fail or

   297

	 * return 0xFF if it can. */

   298

	callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);

   299

	if (callback != CALLBACK_FAILED && callback != 0xFF) {

   300

		StringID error = GetGRFStringID(GetEngineGRFID(v->engine_type), 0xD000 + callback);

   301

		return_cmd_error(error);

   302

	}

   303

   304

	if (flags & DC_EXEC) {

   305

		if (IsRoadVehInDepotStopped(v)) {

   306

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   307

		}

   308

   309

		v->vehstatus ^= VS_STOPPED;

   310

		v->cur_speed = 0;

   311

		InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   312

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   313

	}

   314

   315

	return 0;

   316

}

   317

   318

void ClearSlot(Vehicle *v)

   319

{

   320

	RoadStop *rs = v->u.road.slot;

   321

	if (v->u.road.slot == NULL) return;

   322

   323

	v->u.road.slot = NULL;

   324

	v->u.road.slot_age = 0;

   325

   326

	assert(rs->num_vehicles != 0);

   327

	rs->num_vehicles--;

   328

   329

	DEBUG(ms, 3, "Clearing slot at 0x%X", rs->xy);

   330

}

   331

   332

static bool CheckRoadVehInDepotStopped(const Vehicle *v)

   333

{

   334

	TileIndex tile = v->tile;

   335

   336

	if (!IsTileDepotType(tile, TRANSPORT_ROAD) || !(v->vehstatus & VS_STOPPED)) return false;

   337

   338

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

   339

		if (v->u.road.state != RVSB_IN_DEPOT || v->tile != tile) return false;

   340

	}

   341

	return true;

   342

}

   343

   344

/** Sell a road vehicle.

   345

 * @param tile unused

   346

 * @param flags operation to perform

   347

 * @param p1 vehicle ID to be sold

   348

 * @param p2 unused

   349

 */

   351

{

   352

	Vehicle *v;

   353

   354

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   355

   356

	v = GetVehicle(p1);

   357

   358

	if (v->type != VEH_ROAD || !CheckOwnership(v->owner)) return CMD_ERROR;

   359

   360

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   361

   362

	if (!CheckRoadVehInDepotStopped(v)) {

   363

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   364

	}

   365

   366

	if (flags & DC_EXEC) {

   367

		// Invalidate depot

   368

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   369

		RebuildVehicleLists();

   370

		InvalidateWindow(WC_COMPANY, v->owner);

   371

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   372

		DeleteDepotHighlightOfVehicle(v);

   373

		DeleteVehicle(v);

   374

	}

   375

   376

	return -(int32)v->value;

   377

}

   378

   379

struct RoadFindDepotData {

   380

	uint best_length;

   381

	TileIndex tile;

   382

	OwnerByte owner;

   383

};

   384

   385

static const DiagDirection _road_pf_directions[] = {

   386

	DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_SW, DIAGDIR_SE, INVALID_DIAGDIR, INVALID_DIAGDIR,

   387

	DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NE, INVALID_DIAGDIR, INVALID_DIAGDIR

   388

};

   389

   390

static bool EnumRoadSignalFindDepot(TileIndex tile, void* data, Trackdir trackdir, uint length, byte* state)

   391

{

   392

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   393

   394

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   395

   396

	if (IsTileType(tile, MP_STREET) &&

   397

			GetRoadTileType(tile) == ROAD_TILE_DEPOT &&

   398

			IsTileOwner(tile, rfdd->owner) &&

   399

			length < rfdd->best_length) {

   400

		rfdd->best_length = length;

   401

		rfdd->tile = tile;

   402

	}

   403

	return false;

   404

}

   405

   406

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   407

{

   408

	TileIndex tile = v->tile;

   409

   410

	if (_patches.yapf.road_use_yapf) {

   411

		Depot* ret = YapfFindNearestRoadDepot(v);

   412

		return ret;

   413

	} else if (_patches.new_pathfinding_all) {

   414

		NPFFoundTargetData ftd;

   415

		/* See where we are now */

   416

		Trackdir trackdir = GetVehicleTrackdir(v);

   417

   418

		ftd = NPFRouteToDepotBreadthFirst(v->tile, trackdir, TRANSPORT_ROAD, v->u.road.compatible_roadtypes, v->owner, INVALID_RAILTYPE);

   419

		if (ftd.best_bird_dist == 0) {

   420

			return GetDepotByTile(ftd.node.tile); /* Target found */

   421

		} else {

   422

			return NULL; /* Target not found */

   423

		}

   424

		/* We do not search in two directions here, why should we? We can't reverse right now can we? */

   425

	} else {

   426

		RoadFindDepotData rfdd;

   427

   428

		rfdd.owner = v->owner;

   429

		rfdd.best_length = (uint)-1;

   430

   431

		/* search in all directions */

   432

		for (DiagDirection i = DIAGDIR_BEGIN; i != DIAGDIR_END; i++) {

   433

			FollowTrack(tile, 0x2000 | TRANSPORT_ROAD, v->u.road.compatible_roadtypes, i, EnumRoadSignalFindDepot, NULL, &rfdd);

   434

		}

   435

   436

		if (rfdd.best_length == (uint)-1) return NULL;

   437

   438

		return GetDepotByTile(rfdd.tile);

   439

	}

   440

}

   441

   442

/** Send a road vehicle to the depot.

   443

 * @param tile unused

   444

 * @param flags operation to perform

   445

 * @param p1 vehicle ID to send to the depot

   446

 * @param p2 various bitmasked elements

   447

 * - p2 bit 0-3 - DEPOT_ flags (see vehicle.h)

   448

 * - p2 bit 8-10 - VLW flag (for mass goto depot)

   449

 */

   451

{

   452

	Vehicle *v;

   453

	const Depot *dep;

   454

   455

	if (p2 & DEPOT_MASS_SEND) {

   456

		/* Mass goto depot requested */

   457

		if (!ValidVLWFlags(p2 & VLW_MASK)) return CMD_ERROR;

   458

		return SendAllVehiclesToDepot(VEH_ROAD, flags, p2 & DEPOT_SERVICE, _current_player, (p2 & VLW_MASK), p1);

   459

	}

   460

   461

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   462

   463

	v = GetVehicle(p1);

   464

   465

	if (v->type != VEH_ROAD || !CheckOwnership(v->owner)) return CMD_ERROR;

   466

   467

	if (v->vehstatus & VS_CRASHED) return CMD_ERROR;

   468

   469

	if (IsRoadVehInDepot(v)) return CMD_ERROR;

   470

   471

	/* If the current orders are already goto-depot */

   472

	if (v->current_order.type == OT_GOTO_DEPOT) {

   473

		if (!!(p2 & DEPOT_SERVICE) == HASBIT(v->current_order.flags, OFB_HALT_IN_DEPOT)) {

   474

			/* We called with a different DEPOT_SERVICE setting.

   475

			 * Now we change the setting to apply the new one and let the vehicle head for the same depot.

   476

			 * Note: the if is (true for requesting service == true for ordered to stop in depot) */

   477

			if (flags & DC_EXEC) {

   478

				TOGGLEBIT(v->current_order.flags, OFB_HALT_IN_DEPOT);

   479

				InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);

   480

			}

   481

			return 0;

   482

		}

   483

   484

		if (p2 & DEPOT_DONT_CANCEL) return CMD_ERROR; // Requested no cancelation of depot orders

   485

		if (flags & DC_EXEC) {

   486

			/* If the orders to 'goto depot' are in the orders list (forced servicing),

   487

			 * then skip to the next order; effectively cancelling this forced service */

   488

			if (HASBIT(v->current_order.flags, OFB_PART_OF_ORDERS))

   489

				v->cur_order_index++;