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

    42

#include "order_func.h"

    43

#include "depot_base.h"

    44

#include "depot_func.h"

    45

#include "effectvehicle_func.h"

    46

    47

#include "table/strings.h"

    48

    49

static const uint16 _roadveh_images[63] = {

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

};

    59

    60

static const uint16 _roadveh_full_adder[63] = {

    61

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

    62

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

    63

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

    64

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

    65

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

    66

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

    67

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

    68

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

    69

};

    70

    71

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

    72

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    73

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

    74

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

    75

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

    76

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    77

};

    78

    79

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    80

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    81

};

    82

    83

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

    84

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

    85

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    86

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    87

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    88

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    89

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    90

};

    91

    92

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

    93

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    94

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    95

};

    96

    97

static SpriteID GetRoadVehIcon(EngineID engine)

    98

{

    99

	uint8 spritenum = RoadVehInfo(engine)->image_index;

   100

   101

	if (is_custom_sprite(spritenum)) {

   102

		SpriteID sprite = GetCustomVehicleIcon(engine, DIR_W);

   103

		if (sprite != 0) return sprite;

   104

   105

		spritenum = GetEngine(engine)->image_index;

   106

	}

   107

   108

	return 6 + _roadveh_images[spritenum];

   109

}

   110

   111

SpriteID RoadVehicle::GetImage(Direction direction) const

   112

{

   113

	uint8 spritenum = this->spritenum;

   114

	SpriteID sprite;

   115

   116

	if (is_custom_sprite(spritenum)) {

   117

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

   118

		if (sprite != 0) return sprite;

   119

   120

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

   121

	}

   122

   123

	sprite = direction + _roadveh_images[spritenum];

   124

   125

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

   126

   127

	return sprite;

   128

}

   129

   130

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

   131

{

   132

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

   133

}

   134

   135

static CommandCost EstimateRoadVehCost(EngineID engine_type)

   136

{

   137

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

   138

}

   139

   140

byte GetRoadVehLength(const Vehicle *v)

   141

{

   142

	byte length = 8;

   143

   144

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

   145

	if (veh_len != CALLBACK_FAILED) {

   146

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

   147

	}

   148

   149

	return length;

   150

}

   151

   152

void RoadVehUpdateCache(Vehicle *v)

   153

{

   154

	assert(v->type == VEH_ROAD);

   155

	assert(IsRoadVehFront(v));

   156

   157

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

   158

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

   159

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

   160

   161

		/* Update the 'first engine' */

   162

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

   163

   164

		/* Update the length of the vehicle. */

   165

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

   166

	}

   167

}

   168

   169

/** Build a road vehicle.

   170

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

   171

 * @param flags operation to perform

   172

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

   173

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

   174

 */

   175

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

   176

{

   177

	CommandCost cost;

   178

	Vehicle *v;

   179

	UnitID unit_num;

   180

	Engine *e;

   181

   182

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

   183

   184

	cost = EstimateRoadVehCost(p1);

   185

	if (flags & DC_QUERY_COST) return cost;

   186

   187

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

   188

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

   189

	if (!IsRoadDepotTile(tile)) return CMD_ERROR;

   190

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

   191

   192

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

   193

   194

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

   195

   196

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

   198

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

   199

   200

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

   201

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   202

	}

   203

   204

	v = vl[0];

   205

   206

	/* find the first free roadveh id */

   207

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

   208

	if (unit_num > _settings_game.vehicle.max_roadveh)

   209

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   210

   211

	if (flags & DC_EXEC) {

   212

		int x;

   213

		int y;

   214

   215

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   216

   217

		v = new (v) RoadVehicle();

   218

		v->unitnumber = unit_num;

   219

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

   220

		v->owner = _current_player;

   221

   222

		v->tile = tile;

   223

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

   224

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

   225

		v->x_pos = x;

   226

		v->y_pos = y;

   227

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

   228

   229

		v->running_ticks = 0;

   230

   231

		v->u.road.state = RVSB_IN_DEPOT;

   232

		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;

   233

   234

		v->spritenum = rvi->image_index;

   235

		v->cargo_type = rvi->cargo_type;

   236

		v->cargo_subtype = 0;

   237

		v->cargo_cap = rvi->capacity;

   238

//		v->cargo_count = 0;

   239

		v->value = cost.GetCost();

   240

//		v->day_counter = 0;

   241

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

   242

//		v->load_unload_time_rem = 0;

   243

//		v->progress = 0;

   244

   245

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

   246

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

   247

   248

		v->last_station_visited = INVALID_STATION;

   249

		v->max_speed = rvi->max_speed;

   250

		v->engine_type = (EngineID)p1;

   251

   252

		e = GetEngine(p1);

   253

		v->reliability = e->reliability;

   254

		v->reliability_spd_dec = e->reliability_spd_dec;

   255

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

   256

		_new_vehicle_id = v->index;

   257

   258

		v->name = NULL;

   259

   260

		v->service_interval = _settings_game.vehicle.servint_roadveh;

   261

   262

		v->date_of_last_service = _date;

   263

		v->build_year = _cur_year;

   264

   265

		v->cur_image = 0xC15;

   266

		v->random_bits = VehicleRandomBits();

   267

		SetRoadVehFront(v);

   268

   269

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

   270

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

   271

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

   272

   273

		v->vehicle_flags = 0;

   274

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

   275

   276

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

   277

   278

		AddArticulatedParts(vl, VEH_ROAD);

   279

   280

		VehiclePositionChanged(v);

   281

   282

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   283

		InvalidateWindowClassesData(WC_ROADVEH_LIST, 0);

   284

		InvalidateWindow(WC_COMPANY, v->owner);

   285

		if (IsLocalPlayer())

   286

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

   287

   288

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

   289

	}

   290

   291

	return cost;

   292

}

   293

   294

/** Start/Stop a road vehicle.

   295

 * @param tile unused

   296

 * @param flags operation to perform

   297

 * @param p1 road vehicle ID to start/stop

   298

 * @param p2 unused

   299

 */

   300

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

   301

{

   302

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   303

   304

	Vehicle *v = GetVehicle(p1);

   305

   306

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

   307

   308

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

   309

	 * return 0xFF if it can. */

   310

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

   311

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

   312

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

   313

		return_cmd_error(error);

   314

	}

   315

   316

	if (flags & DC_EXEC) {

   317

		if (v->IsStoppedInDepot()) {

   318

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   319

		}

   320

   321

		v->vehstatus ^= VS_STOPPED;

   322

		v->cur_speed = 0;

   323

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

   324

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   325

	}

   326

   327

	return CommandCost();

   328

}

   329

   330

void ClearSlot(Vehicle *v)

   331

{

   332

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

   333

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

   334

   335

	v->u.road.slot = NULL;

   336

	v->u.road.slot_age = 0;

   337

   338

	assert(rs->num_vehicles != 0);

   339

	rs->num_vehicles--;

   340

   341

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

   342

}

   343

   344

static bool CheckRoadVehInDepotStopped(const Vehicle *v)

   345

{

   346

	TileIndex tile = v->tile;

   347

   348

	if (!IsRoadDepotTile(tile)) return false;

   349

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

   350

   351

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

   352

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

   353

	}

   354

	return true;

   355

}

   356

   357

/** Sell a road vehicle.

   358

 * @param tile unused

   359

 * @param flags operation to perform

   360

 * @param p1 vehicle ID to be sold

   361

 * @param p2 unused

   362

 */

   363

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

   364

{

   365

	Vehicle *v;

   366

   367

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   368

   369

	v = GetVehicle(p1);

   370

   371

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

   372

   373

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

   374

   375

	if (!CheckRoadVehInDepotStopped(v)) {

   376

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   377

	}

   378

   379

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

   380

   381

	if (flags & DC_EXEC) {

   382

		// Invalidate depot

   383

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   384

		InvalidateWindowClassesData(WC_ROADVEH_LIST, 0);

   385

		InvalidateWindow(WC_COMPANY, v->owner);

   386

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   387

		DeleteDepotHighlightOfVehicle(v);

   388

		delete v;

   389

	}

   390

   391

	return ret;

   392

}

   393

   394

struct RoadFindDepotData {

   395

	uint best_length;

   396

	TileIndex tile;

   397

	OwnerByte owner;

   398

};

   399

   400

static const DiagDirection _road_pf_directions[] = {

   401

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

   402

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

   403

};

   404

   405

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

   406

{

   407

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   408

   409

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   410

   411

	if (IsRoadDepotTile(tile) &&

   412

			IsTileOwner(tile, rfdd->owner) &&

   413

			length < rfdd->best_length) {

   414

		rfdd->best_length = length;

   415

		rfdd->tile = tile;

   416

	}

   417

	return false;

   418

}

   419

   420

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   421

{

   422

	switch (_settings_game.pf.pathfinder_for_roadvehs) {

   423

		case VPF_YAPF: /* YAPF */

   424

			return YapfFindNearestRoadDepot(v);

   425

   426

		case VPF_NPF: { /* NPF */

   427

			/* See where we are now */

   428

			Trackdir trackdir = GetVehicleTrackdir(v);

   429

   430

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

   431

   432

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

   433

		} break;

   434

   435

		default:

   436

		case VPF_OPF: { /* OPF */

   437

			RoadFindDepotData rfdd;

   438

   439

			rfdd.owner = v->owner;

   440

			rfdd.best_length = UINT_MAX;

   441

   442

			/* search in all directions */

   443

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

   444

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

   445

			}

   446

   447

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

   448

		} break;

   449

	}

   450

   451

	return NULL; /* Target not found */

   452

}

   453

   454

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

   455

{

   456

	const Depot *depot = FindClosestRoadDepot(this);

   457

   458

	if (depot == NULL) return false;

   459

   460

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

   461

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

   462

   463

	return true;

   464

}

   465

   466

/** Send a road vehicle to the depot.

   467

 * @param tile unused

   468

 * @param flags operation to perform

   469

 * @param p1 vehicle ID to send to the depot

   470

 * @param p2 various bitmasked elements

   471

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

   472

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

   473

 */

   474

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

   475

{

   476

	if (p2 & DEPOT_MASS_SEND) {

   477

		/* Mass goto depot requested */

   478

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

   479

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

   480

	}

   481

   482

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   483

   484

	Vehicle *v = GetVehicle(p1);

   485

   486

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

   487