1

/* $Id$ */

     2

     3

/** @file roadveh_cmd.cpp */

     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 "timetable.h"

    14

#include "command_func.h"

    15

#include "station_base.h"

    16

#include "news_func.h"

    17

#include "pathfind.h"

    18

#include "npf.h"

    19

#include "player_func.h"

    20

#include "player_base.h"

    21

#include "depot.h"

    22

#include "bridge.h"

    23

#include "tunnel_map.h"

    24

#include "bridge_map.h"

    25

#include "vehicle_gui.h"

    26

#include "articulated_vehicles.h"

    27

#include "newgrf_callbacks.h"

    28

#include "newgrf_engine.h"

    29

#include "newgrf_text.h"

    30

#include "newgrf_sound.h"

    31

#include "yapf/yapf.h"

    32

#include "cargotype.h"

    33

#include "strings_func.h"

    34

#include "tunnelbridge_map.h"

    35

#include "functions.h"

    36

#include "window_func.h"

    37

#include "date_func.h"

    38

#include "vehicle_func.h"

    39

#include "sound_func.h"

    40

#include "variables.h"

    41

#include "autoreplace_gui.h"

    42

#include "gfx_func.h"

    43

#include "settings_type.h"

    44

#include "order_func.h"

    45

    46

#include "table/strings.h"

    47

    48

static const uint16 _roadveh_images[63] = {

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

};

    58

    59

static const uint16 _roadveh_full_adder[63] = {

    60

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

    61

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

    62

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

    63

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

    64

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

    65

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

    66

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

    67

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

    68

};

    69

    70

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

    71

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    72

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

    73

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

    74

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

    75

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    76

};

    77

    78

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    79

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    80

};

    81

    82

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

    83

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

    84

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    85

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    86

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    87

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    88

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    89

};

    90

    91

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

    92

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    93

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    94

};

    95

    96

int RoadVehicle::GetImage(Direction direction) const

    97

{

    98

	int img = this->spritenum;

    99

	int image;

   100

   101

	if (is_custom_sprite(img)) {

   102

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

   103

		if (image != 0) return image;

   104

		img = _orig_road_vehicle_info[this->engine_type - ROAD_ENGINES_INDEX].image_index;

   105

	}

   106

   107

	image = direction + _roadveh_images[img];

   108

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

   109

	return image;

   110

}

   111

   112

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

   113

{

   114

	int spritenum = RoadVehInfo(engine)->image_index;

   115

   116

	if (is_custom_sprite(spritenum)) {

   117

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

   118

   119

		if (sprite != 0) {

   120

			DrawSprite(sprite, pal, x, y);

   121

			return;

   122

		}

   123

		spritenum = _orig_road_vehicle_info[engine - ROAD_ENGINES_INDEX].image_index;

   124

	}

   125

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

   126

}

   127

   128

static CommandCost EstimateRoadVehCost(EngineID engine_type)

   129

{

   130

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

   131

}

   132

   133

byte GetRoadVehLength(const Vehicle *v)

   134

{

   135

	byte length = 8;

   136

   137

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

   138

	if (veh_len != CALLBACK_FAILED) {

   139

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

   140

	}

   141

   142

	return length;

   143

}

   144

   145

void RoadVehUpdateCache(Vehicle *v)

   146

{

   147

	assert(v->type == VEH_ROAD);

   148

	assert(IsRoadVehFront(v));

   149

   150

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

   151

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

   152

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

   153

   154

		/* Update the 'first engine' */

   155

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

   156

   157

		/* Update the length of the vehicle. */

   158

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

   159

	}

   160

}

   161

   162

/** Build a road vehicle.

   163

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

   164

 * @param flags operation to perform

   165

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

   166

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

   167

 */

   168

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

   169

{

   170

	CommandCost cost;

   171

	Vehicle *v;

   172

	UnitID unit_num;

   173

	Engine *e;

   174

   175

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

   176

   177

	cost = EstimateRoadVehCost(p1);

   178

	if (flags & DC_QUERY_COST) return cost;

   179

   180

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

   181

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

   182

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

   183

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

   184

   185

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

   186

   187

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

   188

   189

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

   190

	Vehicle **vl = (Vehicle**)alloca(sizeof(*vl) * (num_vehicles + 1));

   191

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

   192

   193

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

   194

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   195

	}

   196

   197

	v = vl[0];

   198

   199

	/* find the first free roadveh id */

   200

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

   201

	if (unit_num > _patches.max_roadveh)

   202

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   203

   204

	if (flags & DC_EXEC) {

   205

		int x;

   206

		int y;

   207

   208

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   209

   210

		v = new (v) RoadVehicle();

   211

		v->unitnumber = unit_num;

   212

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

   213

		v->owner = _current_player;

   214

   215

		v->tile = tile;

   216

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

   217

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

   218

		v->x_pos = x;

   219

		v->y_pos = y;

   220

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

   221

   222

		v->running_ticks = 0;

   223

   224

		v->u.road.state = RVSB_IN_DEPOT;

   225

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   226

   227

		v->spritenum = rvi->image_index;

   228

		v->cargo_type = rvi->cargo_type;

   229

		v->cargo_subtype = 0;

   230

		v->cargo_cap = rvi->capacity;

   231

//		v->cargo_count = 0;

   232

		v->value = cost.GetCost();

   233

//		v->day_counter = 0;

   234

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

   235

//		v->load_unload_time_rem = 0;

   236

//		v->progress = 0;

   237

   238

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

   239

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

   240

   241

		v->last_station_visited = INVALID_STATION;

   242

		v->max_speed = rvi->max_speed;

   243

		v->engine_type = (EngineID)p1;

   244

   245

		e = GetEngine(p1);

   246

		v->reliability = e->reliability;

   247

		v->reliability_spd_dec = e->reliability_spd_dec;

   248

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

   249

		_new_vehicle_id = v->index;

   250

   251

		v->name = NULL;

   252

   253

		v->service_interval = _patches.servint_roadveh;

   254

   255

		v->date_of_last_service = _date;

   256

		v->build_year = _cur_year;

   257

   258

		v->cur_image = 0xC15;

   259

		v->random_bits = VehicleRandomBits();

   260

		SetRoadVehFront(v);

   261

   262

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

   263

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

   264

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

   265

   266

		v->vehicle_flags = 0;

   267

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

   268

   269

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

   270

   271

		AddArticulatedParts(vl, VEH_ROAD);

   272

   273

		VehiclePositionChanged(v);

   274

   275

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   276

		RebuildVehicleLists();

   277

		InvalidateWindow(WC_COMPANY, v->owner);

   278

		if (IsLocalPlayer())

   279

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

   280

   281

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

   282

	}

   283

   284

	return cost;

   285

}

   286

   287

/** Start/Stop a road vehicle.

   288

 * @param tile unused

   289

 * @param flags operation to perform

   290

 * @param p1 road vehicle ID to start/stop

   291

 * @param p2 unused

   292

 */

   293

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

   294

{

   295

	Vehicle *v;

   296

	uint16 callback;

   297

   298

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   299

   300

	v = GetVehicle(p1);

   301

   302

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

   303

   304

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

   305

	 * return 0xFF if it can. */

   306

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

   307

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

   308

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

   309

		return_cmd_error(error);

   310

	}

   311

   312

	if (flags & DC_EXEC) {

   313

		if (v->IsStoppedInDepot()) {

   314

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   315

		}

   316

   317

		v->vehstatus ^= VS_STOPPED;

   318

		v->cur_speed = 0;

   319

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

   320

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   321

	}

   322

   323

	return CommandCost();

   324

}

   325

   326

void ClearSlot(Vehicle *v)

   327

{

   328

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

   329

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

   330

   331

	v->u.road.slot = NULL;

   332

	v->u.road.slot_age = 0;

   333

   334

	assert(rs->num_vehicles != 0);

   335

	rs->num_vehicles--;

   336

   337

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

   338

}

   339

   340

static bool CheckRoadVehInDepotStopped(const Vehicle *v)

   341

{

   342

	TileIndex tile = v->tile;

   343

   344

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

   345

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

   346

   347

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

   348

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

   349

	}

   350

	return true;

   351

}

   352

   353

/** Sell a road vehicle.

   354

 * @param tile unused

   355

 * @param flags operation to perform

   356

 * @param p1 vehicle ID to be sold

   357

 * @param p2 unused

   358

 */

   359

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

   360

{

   361

	Vehicle *v;

   362

   363

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   364

   365

	v = GetVehicle(p1);

   366

   367

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

   368

   369

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

   370

   371

	if (!CheckRoadVehInDepotStopped(v)) {

   372

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   373

	}

   374

   375

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

   376

   377

	if (flags & DC_EXEC) {

   378

		// Invalidate depot

   379

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   380

		RebuildVehicleLists();

   381

		InvalidateWindow(WC_COMPANY, v->owner);

   382

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   383

		DeleteDepotHighlightOfVehicle(v);

   384

		delete v;

   385

	}

   386

   387

	return ret;

   388

}

   389

   390

struct RoadFindDepotData {

   391

	uint best_length;

   392

	TileIndex tile;

   393

	OwnerByte owner;

   394

};

   395

   396

static const DiagDirection _road_pf_directions[] = {

   397

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

   398

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

   399

};

   400

   401

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

   402

{

   403

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   404

   405

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   406

   407

	if (IsRoadDepotTile(tile) &&

   408

			IsTileOwner(tile, rfdd->owner) &&

   409

			length < rfdd->best_length) {

   410

		rfdd->best_length = length;

   411

		rfdd->tile = tile;

   412

	}

   413

	return false;

   414

}

   415

   416

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   417

{

   418

	switch (_patches.pathfinder_for_roadvehs) {

   419

		case VPF_YAPF: /* YAPF */

   420

			return YapfFindNearestRoadDepot(v);

   421

   422

		case VPF_NPF: { /* NPF */

   423

			/* See where we are now */

   424

			Trackdir trackdir = GetVehicleTrackdir(v);

   425

   426

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

   427

   428

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

   429

		} break;

   430

   431

		default:

   432

		case VPF_OPF: { /* OPF */

   433

			RoadFindDepotData rfdd;

   434

   435

			rfdd.owner = v->owner;

   436

			rfdd.best_length = UINT_MAX;

   437

   438

			/* search in all directions */

   439

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

   440

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

   441

			}

   442

   443

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

   444

		} break;

   445

	}

   446

   447

	return NULL; /* Target not found */

   448

}

   449

   450

/** Send a road vehicle to the depot.

   451

 * @param tile unused

   452

 * @param flags operation to perform

   453

 * @param p1 vehicle ID to send to the depot

   454

 * @param p2 various bitmasked elements

   455

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

   456

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

   457

 */

   458

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

   459

{

   460

	Vehicle *v;

   461

	const Depot *dep;

   462

   463

	if (p2 & DEPOT_MASS_SEND) {

   464

		/* Mass goto depot requested */

   465

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

   466

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

   467

	}

   468

   469

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   470

   471

	v = GetVehicle(p1);

   472

   473

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

   474

   475

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

   476

   477

	if (v->IsInDepot()) return CMD_ERROR;

   478

   479

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

   480

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

   481

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

   482

			/* We called with a different DEPOT_SERVICE setting.

   483

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

   484

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

   485

			if (flags & DC_EXEC) {

   486