1

/* $Id$ */

     2

     3

/** @file roadveh_cmd.cpp Handling of road vehicles. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "tile_cmd.h"

     9

#include "landscape.h"

    10

#include "road_map.h"

    11

#include "roadveh.h"

    12

#include "station_map.h"

    13

#include "command_func.h"

    14

#include "station_base.h"

    15

#include "news_func.h"

    16

#include "pathfind.h"

    17

#include "npf.h"

    18

#include "player_func.h"

    19

#include "player_base.h"

    20

#include "bridge.h"

    21

#include "tunnel_map.h"

    22

#include "bridge_map.h"

    23

#include "vehicle_gui.h"

    24

#include "articulated_vehicles.h"

    25

#include "newgrf_callbacks.h"

    26

#include "newgrf_engine.h"

    27

#include "newgrf_text.h"

    28

#include "newgrf_sound.h"

    29

#include "yapf/yapf.h"

    30

#include "cargotype.h"

    31

#include "strings_func.h"

    32

#include "tunnelbridge_map.h"

    33

#include "functions.h"

    34

#include "window_func.h"

    35

#include "date_func.h"

    36

#include "vehicle_func.h"

    37

#include "sound_func.h"

    38

#include "variables.h"

    39

#include "autoreplace_gui.h"

    40

#include "gfx_func.h"

    41

#include "ai/ai.h"

    42

#include "settings_type.h"

    43

#include "order_func.h"

    44

#include "depot_base.h"

    45

#include "depot_func.h"

    46

#include "effectvehicle_func.h"

    47

    48

#include "table/strings.h"

    49

    50

static const uint16 _roadveh_images[63] = {

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

};

    60

    61

static const uint16 _roadveh_full_adder[63] = {

    62

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

    63

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

    64

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

    65

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

    66

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

    67

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

    68

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

    69

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

    70

};

    71

    72

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

    73

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    74

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

    75

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

    76

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

    77

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    78

};

    79

    80

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    81

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    82

};

    83

    84

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

    85

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

    86

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    87

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    88

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    89

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    90

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    91

};

    92

    93

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

    94

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    95

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    96

};

    97

    98

static SpriteID GetRoadVehIcon(EngineID engine)

    99

{

   100

	uint8 spritenum = RoadVehInfo(engine)->image_index;

   101

   102

	if (is_custom_sprite(spritenum)) {

   103

		SpriteID sprite = GetCustomVehicleIcon(engine, DIR_W);

   104

		if (sprite != 0) return sprite;

   105

   106

		spritenum = GetEngine(engine)->image_index;

   107

	}

   108

   109

	return 6 + _roadveh_images[spritenum];

   110

}

   111

   112

SpriteID RoadVehicle::GetImage(Direction direction) const

   113

{

   114

	uint8 spritenum = this->spritenum;

   115

	SpriteID sprite;

   116

   117

	if (is_custom_sprite(spritenum)) {

   118

		sprite = GetCustomVehicleSprite(this, (Direction)(direction + 4 * IS_CUSTOM_SECONDHEAD_SPRITE(spritenum)));

   119

		if (sprite != 0) return sprite;

   120

   121

		spritenum = GetEngine(this->engine_type)->image_index;

   122

	}

   123

   124

	sprite = direction + _roadveh_images[spritenum];

   125

   126

	if (this->cargo.Count() >= this->cargo_cap / 2U) sprite += _roadveh_full_adder[spritenum];

   127

   128

	return sprite;

   129

}

   130

   131

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

   132

{

   133

	DrawSprite(GetRoadVehIcon(engine), pal, x, y);

   134

}

   135

   136

static CommandCost EstimateRoadVehCost(EngineID engine_type)

   137

{

   138

	return CommandCost(EXPENSES_NEW_VEHICLES, ((_price.roadveh_base >> 3) * GetEngineProperty(engine_type, 0x11, RoadVehInfo(engine_type)->base_cost)) >> 5);

   139

}

   140

   141

byte GetRoadVehLength(const Vehicle *v)

   142

{

   143

	byte length = 8;

   144

   145

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

   146

	if (veh_len != CALLBACK_FAILED) {

   147

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

   148

	}

   149

   150

	return length;

   151

}

   152

   153

void RoadVehUpdateCache(Vehicle *v)

   154

{

   155

	assert(v->type == VEH_ROAD);

   156

	assert(IsRoadVehFront(v));

   157

   158

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

   159

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

   160

		assert(u->First() == v);

   161

   162

		/* Update the 'first engine' */

   163

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

   164

   165

		/* Update the length of the vehicle. */

   166

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

   167

	}

   168

}

   169

   170

/** Build a road vehicle.

   171

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

   172

 * @param flags operation to perform

   173

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

   174

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

   175

 */

   176

CommandCost CmdBuildRoadVeh(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   177

{

   178

	CommandCost cost;

   179

	Vehicle *v;

   180

	UnitID unit_num;

   181

	Engine *e;

   182

   183

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

   184

   185

	cost = EstimateRoadVehCost(p1);

   186

	if (flags & DC_QUERY_COST) return cost;

   187

   188

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

   189

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

   190

	if (!IsRoadDepotTile(tile)) return CMD_ERROR;

   191

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

   192

   193

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

   194

   195

	uint num_vehicles = 1 + CountArticulatedParts(p1, false);

   196

   197

	/* Allow for the front and the articulated parts, plus one to "terminate" the list. */

   198

	Vehicle **vl = AllocaM(Vehicle*, num_vehicles + 1);

   199

	memset(vl, 0, sizeof(*vl) * (num_vehicles + 1));

   200

   201

	if (!Vehicle::AllocateList(vl, num_vehicles)) {

   202

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   203

	}

   204

   205

	v = vl[0];

   206

   207

	/* find the first free roadveh id */

   208

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

   209

	if (unit_num > _settings_game.vehicle.max_roadveh)

   210

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   211

   212

	if (flags & DC_EXEC) {

   213

		int x;

   214

		int y;

   215

   216

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   217

   218

		v = new (v) RoadVehicle();

   219

		v->unitnumber = unit_num;

   220

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

   221

		v->owner = _current_player;

   222

   223

		v->tile = tile;

   224

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

   225

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

   226

		v->x_pos = x;

   227

		v->y_pos = y;

   228

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

   229

   230

		v->running_ticks = 0;

   231

   232

		v->u.road.state = RVSB_IN_DEPOT;

   233

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   234

   235

		v->spritenum = rvi->image_index;

   236

		v->cargo_type = rvi->cargo_type;

   237

		v->cargo_subtype = 0;

   238

		v->cargo_cap = rvi->capacity;

   239

//		v->cargo_count = 0;

   240

		v->value = cost.GetCost();

   241

//		v->day_counter = 0;

   242

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

   243

//		v->load_unload_time_rem = 0;

   244

//		v->progress = 0;

   245

   246

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

   247

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

   248

   249

		v->last_station_visited = INVALID_STATION;

   250

		v->max_speed = rvi->max_speed;

   251

		v->engine_type = (EngineID)p1;

   252

   253

		e = GetEngine(p1);

   254

		v->reliability = e->reliability;

   255

		v->reliability_spd_dec = e->reliability_spd_dec;

   256

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

   257

		_new_vehicle_id = v->index;

   258

   259

		v->name = NULL;

   260

   261

		v->service_interval = _settings_game.vehicle.servint_roadveh;

   262

   263

		v->date_of_last_service = _date;

   264

		v->build_year = _cur_year;

   265

   266

		v->cur_image = 0xC15;

   267

		v->random_bits = VehicleRandomBits();

   268

		SetRoadVehFront(v);

   269

   270

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

   271

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

   272

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

   273

   274

		v->vehicle_flags = 0;

   275

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

   276

   277

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

   278

   279

		AddArticulatedParts(vl, VEH_ROAD);

   280

   281

		VehiclePositionChanged(v);

   282

   283

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   284

		InvalidateWindowClassesData(WC_ROADVEH_LIST, 0);

   285

		InvalidateWindow(WC_COMPANY, v->owner);

   286

		if (IsLocalPlayer())

   287

			InvalidateAutoreplaceWindow(v->engine_type, v->group_id); // updates the replace Road window

   288

   289

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

   290

	}

   291

   292

	return cost;

   293

}

   294

   295

/** Start/Stop a road vehicle.

   296

 * @param tile unused

   297

 * @param flags operation to perform

   298

 * @param p1 road vehicle ID to start/stop

   299

 * @param p2 unused

   300

 */

   301

CommandCost CmdStartStopRoadVeh(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   302

{

   303

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   304

   305

	Vehicle *v = GetVehicle(p1);

   306

   307

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

   308

   309

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

   310

	 * return 0xFF if it can. */

   311

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

   312

	if (callback != CALLBACK_FAILED && GB(callback, 0, 8) != 0xFF) {

   313

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

   314

		return_cmd_error(error);

   315

	}

   316

   317

	if (flags & DC_EXEC) {

   318

		if (v->IsStoppedInDepot()) {

   319

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   320

		}

   321

   322

		v->vehstatus ^= VS_STOPPED;

   323

		v->cur_speed = 0;

   324

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

   325

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   326

	}

   327

   328

	return CommandCost();

   329

}

   330

   331

void ClearSlot(Vehicle *v)

   332

{

   333

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

   334

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

   335

   336

	v->u.road.slot = NULL;

   337

	v->u.road.slot_age = 0;

   338

   339

	assert(rs->num_vehicles != 0);

   340

	rs->num_vehicles--;

   341

   342

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

   343

}

   344

   345

static bool CheckRoadVehInDepotStopped(const Vehicle *v)

   346

{

   347

	TileIndex tile = v->tile;

   348

   349

	if (!IsRoadDepotTile(tile)) return false;

   350

	if (IsRoadVehFront(v) && !(v->vehstatus & VS_STOPPED)) return false;

   351

   352

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

   353

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

   354

	}

   355

	return true;

   356

}

   357

   358

/** Sell a road vehicle.

   359

 * @param tile unused

   360

 * @param flags operation to perform

   361

 * @param p1 vehicle ID to be sold

   362

 * @param p2 unused

   363

 */

   364

CommandCost CmdSellRoadVeh(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   365

{

   366

	Vehicle *v;

   367

   368

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   369

   370

	v = GetVehicle(p1);

   371

   372

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

   373

   374

	if (HASBITS(v->vehstatus, VS_CRASHED)) return_cmd_error(STR_CAN_T_SELL_DESTROYED_VEHICLE);

   375

   376

	if (!CheckRoadVehInDepotStopped(v)) {

   377

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   378

	}

   379

   380

	CommandCost ret(EXPENSES_NEW_VEHICLES, -v->value);

   381

   382

	if (flags & DC_EXEC) {

   383

		// Invalidate depot

   384

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   385

		InvalidateWindowClassesData(WC_ROADVEH_LIST, 0);

   386

		InvalidateWindow(WC_COMPANY, v->owner);

   387

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   388

		DeleteDepotHighlightOfVehicle(v);

   389

		delete v;

   390

	}

   391

   392

	return ret;

   393

}

   394

   395

struct RoadFindDepotData {

   396

	uint best_length;

   397

	TileIndex tile;

   398

	OwnerByte owner;

   399

};

   400

   401

static const DiagDirection _road_pf_directions[] = {

   402

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

   403

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

   404

};

   405

   406

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

   407

{

   408

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   409

   410

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   411

   412

	if (IsRoadDepotTile(tile) &&

   413

			IsTileOwner(tile, rfdd->owner) &&

   414

			length < rfdd->best_length) {

   415

		rfdd->best_length = length;

   416

		rfdd->tile = tile;

   417

	}

   418

	return false;

   419

}

   420

   421

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   422

{

   423

	switch (_settings_game.pf.pathfinder_for_roadvehs) {

   424

		case VPF_YAPF: /* YAPF */

   425

			return YapfFindNearestRoadDepot(v);

   426

   427

		case VPF_NPF: { /* NPF */

   428

			/* See where we are now */

   429

			Trackdir trackdir = GetVehicleTrackdir(v);

   430

   431

			NPFFoundTargetData ftd = NPFRouteToDepotBreadthFirstTwoWay(v->tile, trackdir, false, v->tile, ReverseTrackdir(trackdir), false, TRANSPORT_ROAD, v->u.road.compatible_roadtypes, v->owner, INVALID_RAILTYPES, 0);

   432

   433

			if (ftd.best_bird_dist == 0) return GetDepotByTile(ftd.node.tile); /* Target found */

   434

		} break;

   435

   436

		default:

   437

		case VPF_OPF: { /* OPF */

   438

			RoadFindDepotData rfdd;

   439

   440

			rfdd.owner = v->owner;

   441

			rfdd.best_length = UINT_MAX;

   442

   443

			/* search in all directions */

   444

			for (DiagDirection d = DIAGDIR_BEGIN; d < DIAGDIR_END; d++) {

   445

				FollowTrack(v->tile, PATHFIND_FLAGS_NONE, TRANSPORT_ROAD, v->u.road.compatible_roadtypes, d, EnumRoadSignalFindDepot, NULL, &rfdd);

   446

			}

   447

   448

			if (rfdd.best_length != UINT_MAX) return GetDepotByTile(rfdd.tile);

   449

		} break;

   450

	}

   451

   452

	return NULL; /* Target not found */

   453

}

   454

   455

bool RoadVehicle::FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)

   456

{

   457

	const Depot *depot = FindClosestRoadDepot(this);

   458

   459

	if (depot == NULL) return false;

   460

   461

	if (location    != NULL) *location    = depot->xy;

   462

	if (destination != NULL) *destination = depot->index;

   463

   464

	return true;

   465

}

   466

   467

/** Send a road vehicle to the depot.

   468

 * @param tile unused

   469

 * @param flags operation to perform

   470

 * @param p1 vehicle ID to send to the depot

   471

 * @param p2 various bitmasked elements

   472

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

   473

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

   474

 */

   475

CommandCost CmdSendRoadVehToDepot(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   476

{

   477

	if (p2 & DEPOT_MASS_SEND) {

   478

		/* Mass goto depot requested */

   479

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

   480

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

   481

	}

   482

   483

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   484

   485

	Vehicle *v = GetVehicle(p1);

   486