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

    15

#include "tile.h"

    16

#include "vehicle.h"

    17

#include "engine.h"

    18

#include "command.h"

    19

#include "station.h"

    20

#include "news.h"

    21

#include "pathfind.h"

    22

#include "npf.h"

    23

#include "player.h"

    24

#include "sound.h"

    25

#include "depot.h"

    26

#include "bridge.h"

    27

#include "tunnel_map.h"

    28

#include "bridge_map.h"

    29

#include "vehicle_gui.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_engine.h"

    32

#include "newgrf_text.h"

    33

#include "newgrf_sound.h"

    34

#include "yapf/yapf.h"

    35

#include "date.h"

    36

#include "cargotype.h"

    37

    38

static const uint16 _roadveh_images[63] = {

    39

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

    40

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

    41

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

    42

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

    43

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

    44

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

    45

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

    46

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

    47

};

    48

    49

static const uint16 _roadveh_full_adder[63] = {

    50

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

    51

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

    52

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

    53

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

    54

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

    55

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

    56

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

    57

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

    58

};

    59

    60

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

    61

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    62

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

    63

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

    64

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

    65

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    66

};

    67

    68

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    69

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    70

};

    71

    72

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

    73

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

    74

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    75

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    76

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    77

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    78

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    79

};

    80

    81

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

    82

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    83

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    84

};

    85

    86

int GetRoadVehImage(const Vehicle* v, Direction direction)

    87

{

    88

	int img = v->spritenum;

    89

	int image;

    90

    91

	if (is_custom_sprite(img)) {

    92

		image = GetCustomVehicleSprite(v, direction);

    93

		if (image != 0) return image;

    94

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

    95

	}

    96

    97

	image = direction + _roadveh_images[img];

    98

	if (v->cargo_count >= v->cargo_cap / 2) image += _roadveh_full_adder[img];

    99

	return image;

   100

}

   101

   102

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

   103

{

   104

	int spritenum = RoadVehInfo(engine)->image_index;

   105

   106

	if (is_custom_sprite(spritenum)) {

   107

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

   108

   109

		if (sprite != 0) {

   110

			DrawSprite(sprite, pal, x, y);

   111

			return;

   112

		}

   113

		spritenum = orig_road_vehicle_info[engine - ROAD_ENGINES_INDEX].image_index;

   114

	}

   115

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

   116

}

   117

   118

static int32 EstimateRoadVehCost(EngineID engine_type)

   119

{

   120

	return ((_price.roadveh_base >> 3) * RoadVehInfo(engine_type)->base_cost) >> 5;

   121

}

   122

   123

/** Build a road vehicle.

   124

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

   126

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

   127

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

   128

 */

   129

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

   130

{

   131

	int32 cost;

   132

	Vehicle *v;

   133

	UnitID unit_num;

   134

	Engine *e;

   135

   136

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

   137

   138

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   139

   140

	cost = EstimateRoadVehCost(p1);

   141

	if (flags & DC_QUERY_COST) return cost;

   142

   143

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

   144

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

   145

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

   146

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

   147

   148

	v = AllocateVehicle();

   149

	if (v == NULL) return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   150

   151

	/* find the first free roadveh id */

   152

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

   153

	if (unit_num > _patches.max_roadveh)

   154

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   155

   156

	if (flags & DC_EXEC) {

   157

		int x;

   158

		int y;

   159

   160

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   161

   162

		v->unitnumber = unit_num;

   163

		v->direction = INVALID_DIR;

   164

		v->owner = _current_player;

   165

   166

		v->tile = tile;

   167

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

   168

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

   169

		v->x_pos = x;

   170

		v->y_pos = y;

   172

		v->z_height = 6;

   173

   174

		v->u.road.state = RVSB_IN_DEPOT;

   176

   177

		v->spritenum = rvi->image_index;

   178

		v->cargo_type = rvi->cargo_type;

   179

		v->cargo_subtype = 0;

   180

		v->cargo_cap = rvi->capacity;

   181

//		v->cargo_count = 0;

   182

		v->value = cost;

   183

//		v->day_counter = 0;

   184

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

   185

//		v->load_unload_time_rem = 0;

   186

//		v->progress = 0;

   187

   188

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

   189

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

   190

   191

		v->last_station_visited = INVALID_STATION;

   192

		v->max_speed = rvi->max_speed;

   193

		v->engine_type = (byte)p1;

   194

   195

		e = GetEngine(p1);

   196

		v->reliability = e->reliability;

   197

		v->reliability_spd_dec = e->reliability_spd_dec;

   198

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

   199

		_new_vehicle_id = v->index;

   200

   201

		v->string_id = STR_SV_ROADVEH_NAME;

   202

   203

		v->service_interval = _patches.servint_roadveh;

   204

   205

		v->date_of_last_service = _date;

   206

		v->build_year = _cur_year;

   207

   208

		v->type = VEH_ROAD;

   209

		v->cur_image = 0xC15;

   210

		v->random_bits = VehicleRandomBits();

   211

   212

		v->vehicle_flags = 0;

   213

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

   214

   215

		VehiclePositionChanged(v);

   216

   217

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   218

		RebuildVehicleLists();

   219

		InvalidateWindow(WC_COMPANY, v->owner);

   220

		if (IsLocalPlayer())

   221

			InvalidateAutoreplaceWindow(VEH_ROAD); // updates the replace Road window

   222

   223

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

   224

	}

   225

   226

	return cost;

   227

}

   228

   229

/** Start/Stop a road vehicle.

   230

 * @param tile unused

   232

 * @param p1 road vehicle ID to start/stop

   233

 * @param p2 unused

   234

 */

   235

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

   236

{

   237

	Vehicle *v;

   238

	uint16 callback;

   239

   240

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   241

   242

	v = GetVehicle(p1);

   243

   244

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

   245

   246

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

   247

	 * return 0xFF if it can. */

   248

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

   249

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

   250

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

   251

		return_cmd_error(error);

   252

	}

   253

   254

	if (flags & DC_EXEC) {

   255

		if (IsRoadVehInDepotStopped(v)) {

   256

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   257

		}

   258

   259

		v->vehstatus ^= VS_STOPPED;

   260

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

   261

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   262

	}

   263

   264

	return 0;

   265

}

   266

   267

void ClearSlot(Vehicle *v)

   268

{

   269

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

   270

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

   271

   272

	v->u.road.slot = NULL;

   273

	v->u.road.slot_age = 0;

   274

   275

	assert(rs->num_vehicles != 0);

   276

	rs->num_vehicles--;

   277

   278

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

   279

}

   280

   281

/** Sell a road vehicle.

   282

 * @param tile unused

   284

 * @param p1 vehicle ID to be sold

   285

 * @param p2 unused

   286

 */

   287

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

   288

{

   289

	Vehicle *v;

   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

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   298

   299

	if (!IsRoadVehInDepotStopped(v)) {

   300

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   301

	}

   302

   303

	if (flags & DC_EXEC) {

   304

		// Invalidate depot

   305

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   306

		RebuildVehicleLists();

   307

		InvalidateWindow(WC_COMPANY, v->owner);

   308

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   309

		DeleteDepotHighlightOfVehicle(v);

   310

		DeleteVehicle(v);

   311

	}

   312

   313

	return -(int32)v->value;

   314

}

   315

   316

struct RoadFindDepotData {

   317

	uint best_length;

   318

	TileIndex tile;

   319

	OwnerByte owner;

   320

};

   321

   322

static const DiagDirection _road_pf_directions[] = {

   323

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

   324

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

   325

};

   326

   327

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

   328

{

   329

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   330

   331

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   332

   333

	if (IsTileType(tile, MP_STREET) &&

   334

			GetRoadTileType(tile) == ROAD_TILE_DEPOT &&

   335

			IsTileOwner(tile, rfdd->owner) &&

   336

			length < rfdd->best_length) {

   337

		rfdd->best_length = length;

   338

		rfdd->tile = tile;

   339

	}

   340

	return false;

   341

}

   342

   343

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   344

{

   345

	TileIndex tile = v->tile;

   346

   347

	if (_patches.yapf.road_use_yapf) {

   348

		Depot* ret = YapfFindNearestRoadDepot(v);

   349

		return ret;

   350

	} else if (_patches.new_pathfinding_all) {

   351

		NPFFoundTargetData ftd;

   352

		/* See where we are now */

   353

		Trackdir trackdir = GetVehicleTrackdir(v);

   354

   355

		ftd = NPFRouteToDepotBreadthFirst(v->tile, trackdir, TRANSPORT_ROAD, v->owner, INVALID_RAILTYPE);

   356

		if (ftd.best_bird_dist == 0) {

   357

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

   358

		} else {

   359

			return NULL; /* Target not found */

   360

		}

   361

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

   362

	} else {

   363

		RoadFindDepotData rfdd;

   364

   365

		rfdd.owner = v->owner;

   366

		rfdd.best_length = (uint)-1;

   367

   368

		/* search in all directions */

   369

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

   370

			FollowTrack(tile, 0x2000 | TRANSPORT_ROAD, i, EnumRoadSignalFindDepot, NULL, &rfdd);

   371

		}

   372

   373

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

   374

   375

		return GetDepotByTile(rfdd.tile);

   376

	}

   377

}

   378

   379

/** Send a road vehicle to the depot.

   380

 * @param tile unused

   382

 * @param p1 vehicle ID to send to the depot

   383

 * @param p2 various bitmasked elements

   384

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

   385

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

   386

 */

   387

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

   388

{

   389

	Vehicle *v;

   390

	const Depot *dep;

   391

   392

	if (p2 & DEPOT_MASS_SEND) {

   393

		/* Mass goto depot requested */

   394

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

   395

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

   396

	}

   397

   398

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   399

   400

	v = GetVehicle(p1);

   401

   402

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

   403

   404

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

   405

   406

	if (IsRoadVehInDepot(v)) return CMD_ERROR;

   407

   408

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

   409

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

   410

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

   411

			/* We called with a different DEPOT_SERVICE setting.

   412

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

   413

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

   414

			if (flags & DC_EXEC) {

   415

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

   416

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

   417

			}

   418

			return 0;

   419

		}

   420

   421

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

   422

		if (flags & DC_EXEC) {

   423

			/* If the orders to 'goto depot' are in the orders list (forced servicing),

   424

			 * then skip to the next order; effectively cancelling this forced service */

   425

			if (HASBIT(v->current_order.flags, OFB_PART_OF_ORDERS))

   426

				v->cur_order_index++;

   427

   428

			v->current_order.type = OT_DUMMY;

   429

			v->current_order.flags = 0;

   430

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

   431

		}

   432

		return 0;

   433

	}

   434

   435

	dep = FindClosestRoadDepot(v);

   436

	if (dep == NULL) return_cmd_error(STR_9019_UNABLE_TO_FIND_LOCAL_DEPOT);

   437

   438

	if (flags & DC_EXEC) {

   441

		ClearSlot(v);

   442

		v->current_order.type = OT_GOTO_DEPOT;

   443

		v->current_order.flags = OF_NON_STOP;

   444

		if (!(p2 & DEPOT_SERVICE)) SETBIT(v->current_order.flags, OFB_HALT_IN_DEPOT);

   445

		v->current_order.refit_cargo = CT_INVALID;

   446

		v->current_order.dest = dep->index;

   447

		v->dest_tile = dep->xy;

   448

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

   449

	}

   450

   451

	return 0;

   452

}

   453

   454

/** Turn a roadvehicle around.

   455

 * @param tile unused

   457

 * @param p1 vehicle ID to turn

   458

 * @param p2 unused

   459

 */

   460

int32 CmdTurnRoadVeh(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   461

{

   462

	Vehicle *v;

   463

   464

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   465

   466

	v = GetVehicle(p1);

   467

   468

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

   469

   470

	if (v->vehstatus & VS_STOPPED ||

   471

			v->u.road.crashed_ctr != 0 ||

   472

			v->breakdown_ctr != 0 ||

   473

			v->u.road.overtaking != 0 ||

   474

			v->u.road.state == RVSB_WORMHOLE ||

   475

			IsRoadVehInDepot(v) ||

   476

			v->cur_speed < 5) {

   477

		return CMD_ERROR;

   478

	}

   479

   480

	if (IsTunnelTile(v->tile) && DirToDiagDir(v->direction) == GetTunnelDirection(v->tile)) return CMD_ERROR;

   481

	if (IsBridgeTile(v->tile) && DirToDiagDir(v->direction) == GetBridgeRampDirection(v->tile)) return CMD_ERROR;

   482

   483

	if (flags & DC_EXEC) v->u.road.reverse_ctr = 180;

   484

   485

	return 0;

   486

}

   487

   488

   489

static void MarkRoadVehDirty(Vehicle *v)