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

    15

#include "map.h"

    16

#include "tile.h"

    17

#include "vehicle.h"

    18

#include "timetable.h"

    19

#include "engine.h"

    20

#include "command.h"

    21

#include "station.h"

    22

#include "news.h"

    23

#include "pathfind.h"

    24

#include "npf.h"

    25

#include "player.h"

    26

#include "sound.h"

    27

#include "depot.h"

    28

#include "bridge.h"

    29

#include "tunnel_map.h"

    30

#include "bridge_map.h"

    31

#include "vehicle_gui.h"

    32

#include "articulated_vehicles.h"

    33

#include "newgrf_callbacks.h"

    34

#include "newgrf_engine.h"

    35

#include "newgrf_text.h"

    36

#include "newgrf_sound.h"

    37

#include "yapf/yapf.h"

    38

#include "date.h"

    39

#include "cargotype.h"

    40

    41

static const uint16 _roadveh_images[63] = {

    42

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

    43

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

    44

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

    45

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

    46

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

    47

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

    48

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

    49

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

    50

};

    51

    52

static const uint16 _roadveh_full_adder[63] = {

    53

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

    54

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

    55

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

    56

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

    57

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

    58

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

    59

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

    60

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

    61

};

    62

    63

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

    64

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    65

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

    66

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

    67

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

    68

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    69

};

    70

    71

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    72

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    73

};

    74

    75

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

    76

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

    77

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    78

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    79

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    80

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    81

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    82

};

    83

    84

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

    85

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    86

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    87

};

    88

    89

int RoadVehicle::GetImage(Direction direction) const

    90

{

    91

	int img = this->spritenum;

    92

	int image;

    93

    94

	if (is_custom_sprite(img)) {

    95

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

    96

		if (image != 0) return image;

    97

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

    98

	}

    99

   100

	image = direction + _roadveh_images[img];

   101

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

   102

	return image;

   103

}

   104

   105

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

   106

{

   107

	int spritenum = RoadVehInfo(engine)->image_index;

   108

   109

	if (is_custom_sprite(spritenum)) {

   110

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

   111

   112

		if (sprite != 0) {

   113

			DrawSprite(sprite, pal, x, y);

   114

			return;

   115

		}

   116

		spritenum = orig_road_vehicle_info[engine - ROAD_ENGINES_INDEX].image_index;

   117

	}

   118

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

   119

}

   120

   121

static CommandCost EstimateRoadVehCost(EngineID engine_type)

   122

{

   123

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

   124

}

   125

   126

byte GetRoadVehLength(const Vehicle *v)

   127

{

   128

	byte length = 8;

   129

   130

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

   131

	if (veh_len != CALLBACK_FAILED) {

   132

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

   133

	}

   134

   135

	return length;

   136

}

   137

   138

void RoadVehUpdateCache(Vehicle *v)

   139

{

   140

	assert(v->type == VEH_ROAD);

   141

	assert(IsRoadVehFront(v));

   142

   143

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

   144

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

   145

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

   146

   147

		/* Update the 'first engine' */

   148

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

   149

   150

		/* Update the length of the vehicle. */

   151

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

   152

	}

   153

}

   154

   155

/** Build a road vehicle.

   156

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

   157

 * @param flags operation to perform

   158

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

   159

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

   160

 */

   161

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

   162

{

   163

	CommandCost cost;

   164

	Vehicle *v;

   165

	UnitID unit_num;

   166

	Engine *e;

   167

   168

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

   169

   170

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   171

   172

	cost = EstimateRoadVehCost(p1);

   173

	if (flags & DC_QUERY_COST) return cost;

   174

   175

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

   176

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

   177

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

   178

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

   179

   180

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

   181

   182

	uint num_vehicles = 1 + CountArticulatedParts(p1);

   183

   184

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

   185

	Vehicle *vl[11];

   186

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

   187

   188

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

   189

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   190

	}

   191

   192

	v = vl[0];

   193

   194

	/* find the first free roadveh id */

   195

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

   196

	if (unit_num > _patches.max_roadveh)

   197

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   198

   199

	if (flags & DC_EXEC) {

   200

		int x;

   201

		int y;

   202

   203

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   204

   205

		v->unitnumber = unit_num;

   206

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

   207

		v->owner = _current_player;

   208

   209

		v->tile = tile;

   210

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

   211

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

   212

		v->x_pos = x;

   213

		v->y_pos = y;

   214

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

   215

   216

		v->u.road.state = RVSB_IN_DEPOT;

   217

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   218

   219

		v->spritenum = rvi->image_index;

   220

		v->cargo_type = rvi->cargo_type;

   221

		v->cargo_subtype = 0;

   222

		v->cargo_cap = rvi->capacity;

   223

//		v->cargo_count = 0;

   224

		v->value = cost.GetCost();

   225

//		v->day_counter = 0;

   226

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

   227

//		v->load_unload_time_rem = 0;

   228

//		v->progress = 0;

   229

   230

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

   231

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

   232

   233

		v->last_station_visited = INVALID_STATION;

   234

		v->max_speed = rvi->max_speed;

   235

		v->engine_type = (byte)p1;

   236

   237

		e = GetEngine(p1);

   238

		v->reliability = e->reliability;

   239

		v->reliability_spd_dec = e->reliability_spd_dec;

   240

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

   241

		_new_vehicle_id = v->index;

   242

   243

		v->string_id = STR_SV_ROADVEH_NAME;

   244

   245

		v->service_interval = _patches.servint_roadveh;

   246

   247

		v->date_of_last_service = _date;

   248

		v->build_year = _cur_year;

   249

   250

		v = new (v) RoadVehicle();

   251

		v->cur_image = 0xC15;

   252

		v->random_bits = VehicleRandomBits();

   253

		SetRoadVehFront(v);

   254

   255

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

   256

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

   257

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

   258

   259

		v->vehicle_flags = 0;

   260

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

   261

   262

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

   263

   264

		AddArticulatedParts(vl, VEH_ROAD);

   265

   266

		VehiclePositionChanged(v);

   267

   268

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   269

		RebuildVehicleLists();

   270

		InvalidateWindow(WC_COMPANY, v->owner);

   271

		if (IsLocalPlayer())

   272

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

   273

   274

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

   275

	}

   276

   277

	return CommandCost(cost);

   278

}

   279

   280

/** Start/Stop a road vehicle.

   281

 * @param tile unused

   282

 * @param flags operation to perform

   283

 * @param p1 road vehicle ID to start/stop

   284

 * @param p2 unused

   285

 */

   286

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

   287

{

   288

	Vehicle *v;

   289

	uint16 callback;

   290

   291

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   292

   293

	v = GetVehicle(p1);

   294

   295

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

   296

   297

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

   298

	 * return 0xFF if it can. */

   299

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

   300

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

   301

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

   302

		return_cmd_error(error);

   303

	}

   304

   305

	if (flags & DC_EXEC) {

   306

		if (v->IsStoppedInDepot()) {

   307

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   308

		}

   309

   310

		v->vehstatus ^= VS_STOPPED;

   311

		v->cur_speed = 0;

   312

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

   313

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   314

	}

   315

   316

	return CommandCost();

   317

}

   318

   319

void ClearSlot(Vehicle *v)

   320

{

   321

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

   322

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

   323

   324

	v->u.road.slot = NULL;

   325

	v->u.road.slot_age = 0;

   326

   327

	assert(rs->num_vehicles != 0);

   328

	rs->num_vehicles--;

   329

   330

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

   331

}

   332

   333

static bool CheckRoadVehInDepotStopped(const Vehicle *v)

   334

{

   335

	TileIndex tile = v->tile;

   336

   337

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

   338

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

   339

   340

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

   341

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

   342

	}

   343

	return true;

   344

}

   345

   346

/** Sell a road vehicle.

   347

 * @param tile unused

   348

 * @param flags operation to perform

   349

 * @param p1 vehicle ID to be sold

   350

 * @param p2 unused

   351

 */

   352

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

   353

{

   354

	Vehicle *v;

   355

   356

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   357

   358

	v = GetVehicle(p1);

   359

   360

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

   361

   362

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   363

   364

	if (!CheckRoadVehInDepotStopped(v)) {

   365

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   366

	}

   367

   368

	if (flags & DC_EXEC) {

   369

		// Invalidate depot

   370

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   371

		RebuildVehicleLists();

   372

		InvalidateWindow(WC_COMPANY, v->owner);

   373

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   374

		DeleteDepotHighlightOfVehicle(v);

   375

		delete v;

   376

	}

   377

   378

	return CommandCost(-v->value);

   379

}

   380

   381

struct RoadFindDepotData {

   382

	uint best_length;

   383

	TileIndex tile;

   384

	OwnerByte owner;

   385

};

   386

   387

static const DiagDirection _road_pf_directions[] = {

   388

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

   389

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

   390

};

   391

   392

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

   393

{

   394

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   395

   396

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   397

   398

	if (IsTileType(tile, MP_ROAD) &&

   399

			GetRoadTileType(tile) == ROAD_TILE_DEPOT &&

   400

			IsTileOwner(tile, rfdd->owner) &&

   401

			length < rfdd->best_length) {

   402

		rfdd->best_length = length;

   403

		rfdd->tile = tile;

   404

	}

   405

	return false;

   406

}

   407

   408

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   409

{

   410

	TileIndex tile = v->tile;

   411

   412

	if (_patches.yapf.road_use_yapf) {

   413

		Depot* ret = YapfFindNearestRoadDepot(v);

   414

		return ret;

   415

	} else if (_patches.new_pathfinding_all) {

   416

		NPFFoundTargetData ftd;

   417

		/* See where we are now */

   418

		Trackdir trackdir = GetVehicleTrackdir(v);

   419

   420

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

   421

		if (ftd.best_bird_dist == 0) {

   422

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

   423

		} else {

   424

			return NULL; /* Target not found */

   425

		}

   426

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

   427

	} else {

   428

		RoadFindDepotData rfdd;

   429

   430

		rfdd.owner = v->owner;

   431

		rfdd.best_length = (uint)-1;

   432

   433

		/* search in all directions */

   434

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

   435

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

   436

		}

   437

   438

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

   439

   440

		return GetDepotByTile(rfdd.tile);

   441

	}

   442

}

   443

   444

/** Send a road vehicle to the depot.

   445

 * @param tile unused

   446

 * @param flags operation to perform

   447

 * @param p1 vehicle ID to send to the depot

   448

 * @param p2 various bitmasked elements

   449

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

   450

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

   451

 */

   452

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

   453

{

   454

	Vehicle *v;

   455

	const Depot *dep;

   456

   457

	if (p2 & DEPOT_MASS_SEND) {

   458

		/* Mass goto depot requested */

   459

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

   460

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

   461

	}

   462

   463

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   464

   465

	v = GetVehicle(p1);

   466

   467

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

   468

   469

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

   470

   471

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

   472

   473

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

   474

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

   475

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

   476

			/* We called with a different DEPOT_SERVICE setting.

   477

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

   478

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

   479

			if (flags & DC_EXEC) {

   480

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

   481

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

   482

			}

   483

			return CommandCost();

   484

		}

   485

   486

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

   487

		if (flags & DC_EXEC) {