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

    21

#include "bridge.h"

    22

#include "tunnel_map.h"

    23

#include "bridge_map.h"

    24

#include "vehicle_gui.h"

    25

#include "articulated_vehicles.h"

    26

#include "newgrf_callbacks.h"

    27

#include "newgrf_engine.h"

    28

#include "newgrf_text.h"

    29

#include "newgrf_sound.h"

    30

#include "yapf/yapf.h"

    31

#include "cargotype.h"

    32

#include "strings_func.h"

    33

#include "tunnelbridge_map.h"

    34

#include "functions.h"

    35

#include "window_func.h"

    36

#include "date_func.h"

    37

#include "vehicle_func.h"

    38

#include "sound_func.h"

    39

#include "variables.h"

    40

#include "autoreplace_gui.h"

    41

#include "gfx_func.h"

    42

#include "settings_type.h"

    43

#include "order_func.h"

    44

    45

#include "table/strings.h"

    46

    47

static const uint16 _roadveh_images[63] = {

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

};

    57

    58

static const uint16 _roadveh_full_adder[63] = {

    59

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

    60

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

    61

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

    62

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

    63

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

    64

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

    65

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

    66

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

    67

};

    68

    69

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

    70

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    71

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

    72

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

    73

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

    74

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    75

};

    76

    77

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    78

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    79

};

    80

    81

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

    82

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

    83

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    84

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    85

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    86

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    87

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    88

};

    89

    90

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

    91

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    92

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    93

};

    94

    95

int RoadVehicle::GetImage(Direction direction) const

    96

{

    97

	int img = this->spritenum;

    98

	int image;

    99

   100

	if (is_custom_sprite(img)) {

   101

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

   102

		if (image != 0) return image;

   103

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

   104

	}

   105

   106

	image = direction + _roadveh_images[img];

   107

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

   108

	return image;

   109

}

   110

   111

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

   112

{

   113

	int spritenum = RoadVehInfo(engine)->image_index;

   114

   115

	if (is_custom_sprite(spritenum)) {

   116

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

   117

   118

		if (sprite != 0) {

   119

			DrawSprite(sprite, pal, x, y);

   120

			return;

   121

		}

   122

		spritenum = _orig_road_vehicle_info[engine - ROAD_ENGINES_INDEX].image_index;

   123

	}

   124

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

   125

}

   126

   127

static CommandCost EstimateRoadVehCost(EngineID engine_type)

   128

{

   129

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

   130

}

   131

   132

byte GetRoadVehLength(const Vehicle *v)

   133

{

   134

	byte length = 8;

   135

   136

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

   137

	if (veh_len != CALLBACK_FAILED) {

   138

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

   139

	}

   140

   141

	return length;

   142

}

   143

   144

void RoadVehUpdateCache(Vehicle *v)

   145

{

   146

	assert(v->type == VEH_ROAD);

   147

	assert(IsRoadVehFront(v));

   148

   149

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

   150

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

   151

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

   152

   153

		/* Update the 'first engine' */

   154

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

   155

   156

		/* Update the length of the vehicle. */

   157

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

   158

	}

   159

}

   160

   161

/** Build a road vehicle.

   162

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

   163

 * @param flags operation to perform

   164

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

   165

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

   166

 */

   167

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

   168

{

   169

	CommandCost cost;

   170

	Vehicle *v;

   171

	UnitID unit_num;

   172

	Engine *e;

   173

   174

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

   175

   176

	cost = EstimateRoadVehCost(p1);

   177

	if (flags & DC_QUERY_COST) return cost;

   178

   179

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

   180

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

   181

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

   182

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

   183

   184

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

   185

   186

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

   187

   188

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

   189

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

   190

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

   191

   192

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

   193

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   194

	}

   195

   196

	v = vl[0];

   197

   198

	/* find the first free roadveh id */

   199

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

   200

	if (unit_num > _patches.max_roadveh)

   201

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   202

   203

	if (flags & DC_EXEC) {

   204

		int x;

   205

		int y;

   206

   207

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   208

   209

		v = new (v) RoadVehicle();

   210

		v->unitnumber = unit_num;

   211

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

   212

		v->owner = _current_player;

   213

   214

		v->tile = tile;

   215

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

   216

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

   217

		v->x_pos = x;

   218

		v->y_pos = y;

   219

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

   220

   221

		v->running_ticks = 0;

   222

   223

		v->u.road.state = RVSB_IN_DEPOT;

   224

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   225

   226

		v->spritenum = rvi->image_index;

   227

		v->cargo_type = rvi->cargo_type;

   228

		v->cargo_subtype = 0;

   229

		v->cargo_cap = rvi->capacity;

   230

//		v->cargo_count = 0;

   231

		v->value = cost.GetCost();

   232

//		v->day_counter = 0;

   233

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

   234

//		v->load_unload_time_rem = 0;

   235

//		v->progress = 0;

   236

   237

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

   238

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

   239

   240

		v->last_station_visited = INVALID_STATION;

   241

		v->max_speed = rvi->max_speed;

   242

		v->engine_type = (EngineID)p1;

   243

   244

		e = GetEngine(p1);

   245

		v->reliability = e->reliability;

   246

		v->reliability_spd_dec = e->reliability_spd_dec;

   247

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

   248

		_new_vehicle_id = v->index;

   249

   250

		v->name = NULL;

   251

   252

		v->service_interval = _patches.servint_roadveh;

   253

   254

		v->date_of_last_service = _date;

   255

		v->build_year = _cur_year;

   256

   257

		v->cur_image = 0xC15;

   258

		v->random_bits = VehicleRandomBits();

   259

		SetRoadVehFront(v);

   260

   261

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

   262

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

   263

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

   264

   265

		v->vehicle_flags = 0;

   266

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

   267

   268

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

   269

   270

		AddArticulatedParts(vl, VEH_ROAD);

   271

   272

		VehiclePositionChanged(v);

   273

   274

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   275

		RebuildVehicleLists();

   276

		InvalidateWindow(WC_COMPANY, v->owner);

   277

		if (IsLocalPlayer())

   278

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

   279

   280

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

   281

	}

   282

   283

	return cost;

   284

}

   285

   286

/** Start/Stop a road vehicle.

   287

 * @param tile unused

   288

 * @param flags operation to perform

   289

 * @param p1 road vehicle ID to start/stop

   290

 * @param p2 unused

   291

 */

   292

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

   293

{

   294

	Vehicle *v;

   295

	uint16 callback;

   296

   297

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   298

   299

	v = GetVehicle(p1);

   300

   301

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

   302

   303

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

   304

	 * return 0xFF if it can. */

   305

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

   306

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

   307

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

   308

		return_cmd_error(error);

   309

	}

   310

   311

	if (flags & DC_EXEC) {

   312

		if (v->IsStoppedInDepot()) {

   313

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   314

		}

   315

   316

		v->vehstatus ^= VS_STOPPED;

   317

		v->cur_speed = 0;

   318

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

   319

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   320

	}

   321

   322

	return CommandCost();

   323

}

   324

   325

void ClearSlot(Vehicle *v)

   326

{

   327

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

   328

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

   329

   330

	v->u.road.slot = NULL;

   331

	v->u.road.slot_age = 0;

   332

   333

	assert(rs->num_vehicles != 0);

   334

	rs->num_vehicles--;

   335

   336

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

   337

}

   338

   339

static bool CheckRoadVehInDepotStopped(const Vehicle *v)

   340

{

   341

	TileIndex tile = v->tile;

   342

   343

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

   344

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

   345

   346

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

   347

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

   348

	}

   349

	return true;

   350

}

   351

   352

/** Sell a road vehicle.

   353

 * @param tile unused

   354

 * @param flags operation to perform

   355

 * @param p1 vehicle ID to be sold

   356

 * @param p2 unused

   357

 */

   358

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

   359

{

   360

	Vehicle *v;

   361

   362

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   363

   364

	v = GetVehicle(p1);

   365

   366

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

   367

   368

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

   369

   370

	if (!CheckRoadVehInDepotStopped(v)) {

   371

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   372

	}

   373

   374

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

   375

   376

	if (flags & DC_EXEC) {

   377

		// Invalidate depot

   378

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   379

		RebuildVehicleLists();

   380

		InvalidateWindow(WC_COMPANY, v->owner);

   381

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   382

		DeleteDepotHighlightOfVehicle(v);

   383

		delete v;

   384

	}

   385

   386

	return ret;

   387

}

   388

   389

struct RoadFindDepotData {

   390

	uint best_length;

   391

	TileIndex tile;

   392

	OwnerByte owner;

   393

};

   394

   395

static const DiagDirection _road_pf_directions[] = {

   396

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

   397

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

   398

};

   399

   400

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

   401

{

   402

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   403

   404

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   405

   406

	if (IsRoadDepotTile(tile) &&

   407

			IsTileOwner(tile, rfdd->owner) &&

   408

			length < rfdd->best_length) {

   409

		rfdd->best_length = length;

   410

		rfdd->tile = tile;

   411

	}

   412

	return false;

   413

}

   414

   415

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   416

{

   417

	switch (_patches.pathfinder_for_roadvehs) {

   418

		case VPF_YAPF: /* YAPF */

   419

			return YapfFindNearestRoadDepot(v);

   420

   421

		case VPF_NPF: { /* NPF */

   422

			/* See where we are now */

   423

			Trackdir trackdir = GetVehicleTrackdir(v);

   424

   425

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

   426

   427

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

   428

		} break;

   429

   430

		default:

   431

		case VPF_OPF: { /* OPF */

   432

			RoadFindDepotData rfdd;

   433

   434

			rfdd.owner = v->owner;

   435

			rfdd.best_length = UINT_MAX;

   436

   437

			/* search in all directions */

   438

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

   439

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

   440

			}

   441

   442

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

   443

		} break;

   444

	}

   445

   446

	return NULL; /* Target not found */

   447

}

   448

   449

/** Send a road vehicle to the depot.

   450

 * @param tile unused

   451

 * @param flags operation to perform

   452

 * @param p1 vehicle ID to send to the depot

   453

 * @param p2 various bitmasked elements

   454

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

   455

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

   456

 */

   457

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

   458

{

   459

	Vehicle *v;

   460

	const Depot *dep;

   461

   462

	if (p2 & DEPOT_MASS_SEND) {

   463

		/* Mass goto depot requested */

   464

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

   465

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

   466

	}

   467

   468

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   469

   470

	v = GetVehicle(p1);

   471

   472

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

   473

   474

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

   475

   476

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

   477

   478

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

   479

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

   480

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

   481

			/* We called with a different DEPOT_SERVICE setting.

   482

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

   483

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

   484

			if (flags & DC_EXEC) {

   485

				ClrBit(v->current_order.flags, OF_PART_OF_ORDERS);