1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "debug.h"

     6

#include "functions.h"

     7

#include "road_map.h"

     8

#include "roadveh.h"

     9

#include "station_map.h"

    10

#include "table/strings.h"

    11

#include "map.h"

    12

#include "tile.h"

    13

#include "vehicle.h"

    14

#include "engine.h"

    15

#include "command.h"

    16

#include "station.h"

    17

#include "news.h"

    18

#include "pathfind.h"

    19

#include "npf.h"

    20

#include "player.h"

    21

#include "sound.h"

    22

#include "depot.h"

    23

#include "bridge.h"

    24

#include "tunnel_map.h"

    25

#include "bridge_map.h"

    26

#include "vehicle_gui.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 "date.h"

    33

    34

static const uint16 _roadveh_images[63] = {

    35

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

    36

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

    37

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

    38

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

    39

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

    40

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

    41

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

    42

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

    43

};

    44

    45

static const uint16 _roadveh_full_adder[63] = {

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

};

    55

    56

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

    57

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    58

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

    59

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

    60

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

    61

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    62

};

    63

    64

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    65

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    66

};

    67

    68

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

    69

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

    70

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    71

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    72

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    73

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    74

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    75

};

    76

    77

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

    78

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    79

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    80

};

    81

    82

int GetRoadVehImage(const Vehicle* v, Direction direction)

    83

{

    84

	int img = v->spritenum;

    85

	int image;

    86

    87

	if (is_custom_sprite(img)) {

    88

		image = GetCustomVehicleSprite(v, direction);

    89

		if (image != 0) return image;

    90

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

    91

	}

    92

    93

	image = direction + _roadveh_images[img];

    94

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

    95

	return image;

    96

}

    97

    98

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

    99

{

   100

	int spritenum = RoadVehInfo(engine)->image_index;

   101

   102

	if (is_custom_sprite(spritenum)) {

   103

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

   104

   105

		if (sprite != 0) {

   106

			DrawSprite(sprite, pal, x, y);

   107

			return;

   108

		}

   109

		spritenum = orig_road_vehicle_info[engine - ROAD_ENGINES_INDEX].image_index;

   110

	}

   111

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

   112

}

   113

   114

static int32 EstimateRoadVehCost(EngineID engine_type)

   115

{

   116

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

   117

}

   118

   119

/** Build a road vehicle.

   120

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

   121

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

   122

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

   123

 */

   124

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

   125

{

   126

	int32 cost;

   127

	Vehicle *v;

   128

	UnitID unit_num;

   129

	Engine *e;

   130

   131

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

   132

   133

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   134

   135

	cost = EstimateRoadVehCost(p1);

   136

	if (flags & DC_QUERY_COST) return cost;

   137

   138

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

   139

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

   140

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

   141

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

   142

   143

	v = AllocateVehicle();

   144

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

   145

   146

	/* find the first free roadveh id */

   147

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

   148

	if (unit_num > _patches.max_roadveh)

   149

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   150

   151

	if (flags & DC_EXEC) {

   152

		int x;

   153

		int y;

   154

   155

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   156

   157

		v->unitnumber = unit_num;

   158

		v->direction = INVALID_DIR;

   159

		v->owner = _current_player;

   160

   161

		v->tile = tile;

   162

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

   163

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

   164

		v->x_pos = x;

   165

		v->y_pos = y;

   166

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

   167

		v->z_height = 6;

   168

   169

		v->u.road.state = RVSB_IN_DEPOT;

   170

		v->vehstatus = VS_HIDDEN|VS_STOPPED|VS_DEFPAL;

   171

   172

		v->spritenum = rvi->image_index;

   173

		v->cargo_type = rvi->cargo_type;

   174

		v->cargo_subtype = 0;

   175

		v->cargo_cap = rvi->capacity;

   176

//		v->cargo_count = 0;

   177

		v->value = cost;

   178

//		v->day_counter = 0;

   179

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

   180

//		v->load_unload_time_rem = 0;

   181

//		v->progress = 0;

   182

   183

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

   184

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

   185

   186

		v->last_station_visited = INVALID_STATION;

   187

		v->max_speed = rvi->max_speed;

   188

		v->engine_type = (byte)p1;

   189

   190

		e = GetEngine(p1);

   191

		v->reliability = e->reliability;

   192

		v->reliability_spd_dec = e->reliability_spd_dec;

   193

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

   194

		_new_vehicle_id = v->index;

   195

   196

		v->string_id = STR_SV_ROADVEH_NAME;

   197

   198

		v->service_interval = _patches.servint_roadveh;

   199

   200

		v->date_of_last_service = _date;

   201

		v->build_year = _cur_year;

   202

   203

		v->type = VEH_ROAD;

   204

		v->cur_image = 0xC15;

   205

		v->random_bits = VehicleRandomBits();

   206

   207

		v->vehicle_flags = 0;

   208

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

   209

   210

		VehiclePositionChanged(v);

   211

   212

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   213

		RebuildVehicleLists();

   214

		InvalidateWindow(WC_COMPANY, v->owner);

   215

		if (IsLocalPlayer())

   216

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

   217

   218

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

   219

	}

   220

   221

	return cost;

   222

}

   223

   224

/** Start/Stop a road vehicle.

   225

 * @param tile unused

   226

 * @param p1 road vehicle ID to start/stop

   227

 * @param p2 unused

   228

 */

   229

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

   230

{

   231

	Vehicle *v;

   232

	uint16 callback;

   233

   234

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   235

   236

	v = GetVehicle(p1);

   237

   238

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

   239

   240

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

   241

	 * return 0xFF if it can. */

   242

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

   243

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

   244

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

   245

		return_cmd_error(error);

   246

	}

   247

   248

	if (flags & DC_EXEC) {

   249

		if (IsRoadVehInDepotStopped(v)) {

   250

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   251

		}

   252

   253

		v->vehstatus ^= VS_STOPPED;

   254

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

   255

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   256

	}

   257

   258

	return 0;

   259

}

   260

   261

void ClearSlot(Vehicle *v)

   262

{

   263

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

   264

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

   265

   266

	v->u.road.slot = NULL;

   267

	v->u.road.slot_age = 0;

   268

   269

	assert(rs->num_vehicles != 0);

   270

	rs->num_vehicles--;

   271

   272

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

   273

}

   274

   275

/** Sell a road vehicle.

   276

 * @param tile unused

   277

 * @param p1 vehicle ID to be sold

   278

 * @param p2 unused

   279

 */

   280

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

   281

{

   282

	Vehicle *v;

   283

   284

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   285

   286

	v = GetVehicle(p1);

   287

   288

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

   289

   290

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   291

   292

	if (!IsRoadVehInDepotStopped(v)) {

   293

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   294

	}

   295

   296

	if (flags & DC_EXEC) {

   297

		// Invalidate depot

   298

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   299

		RebuildVehicleLists();

   300

		InvalidateWindow(WC_COMPANY, v->owner);

   301

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   302

		DeleteDepotHighlightOfVehicle(v);

   303

		DeleteVehicle(v);

   304

	}

   305

   306

	return -(int32)v->value;

   307

}

   308

   309

struct RoadFindDepotData {

   310

	uint best_length;

   311

	TileIndex tile;

   312

	OwnerByte owner;

   313

};

   314

   315

static const DiagDirection _road_pf_directions[] = {

   316

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

   317

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

   318

};

   319

   320

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

   321

{

   322

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   323

   324

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   325

   326

	if (IsTileType(tile, MP_STREET) &&

   327

			GetRoadTileType(tile) == ROAD_TILE_DEPOT &&

   328

			IsTileOwner(tile, rfdd->owner) &&

   329

			length < rfdd->best_length) {

   330

		rfdd->best_length = length;

   331

		rfdd->tile = tile;

   332

	}

   333

	return false;

   334

}

   335

   336

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   337

{

   338

	TileIndex tile = v->tile;

   339

   340

	if (_patches.yapf.road_use_yapf) {

   341

		Depot* ret = YapfFindNearestRoadDepot(v);

   342

		return ret;

   343

	} else if (_patches.new_pathfinding_all) {

   344

		NPFFoundTargetData ftd;

   345

		/* See where we are now */

   346

		Trackdir trackdir = GetVehicleTrackdir(v);

   347

   348

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

   349

		if (ftd.best_bird_dist == 0) {

   350

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

   351

		} else {

   352

			return NULL; /* Target not found */

   353

		}

   354

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

   355

	} else {

   356

		RoadFindDepotData rfdd;

   357

   358

		rfdd.owner = v->owner;

   359

		rfdd.best_length = (uint)-1;

   360

   361

		/* search in all directions */

   362

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

   363

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

   364

		}

   365

   366

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

   367

   368

		return GetDepotByTile(rfdd.tile);

   369

	}

   370

}

   371

   372

/** Send a road vehicle to the depot.

   373

 * @param tile unused

   374

 * @param p1 vehicle ID to send to the depot

   375

 * @param p2 various bitmasked elements

   376

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

   377

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

   378

 */

   379

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

   380

{

   381

	Vehicle *v;

   382

	const Depot *dep;

   383

   384

	if (p2 & DEPOT_MASS_SEND) {

   385

		/* Mass goto depot requested */

   386

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

   387

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

   388

	}

   389

   390

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   391

   392

	v = GetVehicle(p1);

   393

   394

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

   395

   396

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

   397

   398

	if (IsRoadVehInDepot(v)) return CMD_ERROR;

   399

   400

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

   401

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

   402

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

   403

			/* We called with a different DEPOT_SERVICE setting.

   404

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

   405

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

   406

			if (flags & DC_EXEC) {

   407

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

   408

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

   409

			}

   410

			return 0;

   411

		}

   412

   413

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

   414

		if (flags & DC_EXEC) {

   415

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

   416

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

   417

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

   418

				v->cur_order_index++;

   419

   420

			v->current_order.type = OT_DUMMY;

   421

			v->current_order.flags = 0;

   422

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

   423

		}

   424

		return 0;

   425

	}

   426

   427

	dep = FindClosestRoadDepot(v);

   428

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

   429

   430

	if (flags & DC_EXEC) {

   431

		ClearSlot(v);

   432

		v->current_order.type = OT_GOTO_DEPOT;

   433

		v->current_order.flags = OF_NON_STOP;

   434

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

   435

		v->current_order.refit_cargo = CT_INVALID;

   436

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

   437

		v->dest_tile = dep->xy;

   438

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

   439

	}

   440

   441

	return 0;

   442

}

   443

   444

/** Turn a roadvehicle around.

   445

 * @param tile unused

   446

 * @param p1 vehicle ID to turn

   447

 * @param p2 unused

   448

 */

   449

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

   450

{

   451

	Vehicle *v;

   452

   453

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   454

   455

	v = GetVehicle(p1);

   456

   457

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

   458

   459

	if (v->vehstatus & VS_STOPPED ||

   460

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

   461

			v->breakdown_ctr != 0 ||

   462

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

   463

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

   464

			IsRoadVehInDepot(v) ||

   465

			v->cur_speed < 5) {

   466

		return CMD_ERROR;

   467

	}

   468

   469

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

   470

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

   471

   472

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

   473

   474

	return 0;

   475

}

   476

   477

   478

static void MarkRoadVehDirty(Vehicle *v)

   479

{

   480

	v->cur_image = GetRoadVehImage(v, v->direction);

   481

	MarkAllViewportsDirty(v->left_coord, v->top_coord, v->right_coord + 1, v->bottom_coord + 1);

   482

}

   483

   484

static void UpdateRoadVehDeltaXY(Vehicle *v)

   485

{

   486

#define MKIT(a,b,c,d) ((a&0xFF)<<24) | ((b&0xFF)<<16) | ((c&0xFF)<<8) | ((d&0xFF)<<0)

   487

	static const uint32 _delta_xy_table[8] = {

   488

		MKIT(3, 3, -1, -1),

   489

		MKIT(3, 7, -1, -3),

   490

		MKIT(3, 3, -1, -1),