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

#include "cargotype.h"

    34

    35

static const uint16 _roadveh_images[63] = {

    36

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

    37

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

    38

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

    39

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

    40

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

    41

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

    42

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

    43

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

    44

};

    45

    46

static const uint16 _roadveh_full_adder[63] = {

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

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

    54

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

    55

};

    56

    57

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

    58

static const TrackdirBits _road_enter_dir_to_reachable_trackdirs[DIAGDIR_END] = {

    59

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

    60

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

    61

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

    62

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_Y_NW     // Enter from north west

    63

};

    64

    65

static const Trackdir _road_reverse_table[DIAGDIR_END] = {

    66

	TRACKDIR_RVREV_NE, TRACKDIR_RVREV_SE, TRACKDIR_RVREV_SW, TRACKDIR_RVREV_NW

    67

};

    68

    69

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

    70

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

    71

static const TrackdirBits _road_exit_dir_to_incoming_trackdirs[DIAGDIR_END] = {

    72

	TRACKDIR_BIT_LOWER_W | TRACKDIR_BIT_X_SW    | TRACKDIR_BIT_LEFT_S,

    73

	TRACKDIR_BIT_LEFT_N  | TRACKDIR_BIT_UPPER_W | TRACKDIR_BIT_Y_NW,

    74

	TRACKDIR_BIT_RIGHT_N | TRACKDIR_BIT_UPPER_E | TRACKDIR_BIT_X_NE,

    75

	TRACKDIR_BIT_RIGHT_S | TRACKDIR_BIT_LOWER_E | TRACKDIR_BIT_Y_SE

    76

};

    77

    78

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

    79

static const Trackdir _roadveh_depot_exit_trackdir[DIAGDIR_END] = {

    80

	TRACKDIR_X_NE, TRACKDIR_Y_SE, TRACKDIR_X_SW, TRACKDIR_Y_NW

    81

};

    82

    83

int GetRoadVehImage(const Vehicle* v, Direction direction)

    84

{

    85

	int img = v->spritenum;

    86

	int image;

    87

    88

	if (is_custom_sprite(img)) {

    89

		image = GetCustomVehicleSprite(v, direction);

    90

		if (image != 0) return image;

    91

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

    92

	}

    93

    94

	image = direction + _roadveh_images[img];

    95

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

    96

	return image;

    97

}

    98

    99

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

   100

{

   101

	int spritenum = RoadVehInfo(engine)->image_index;

   102

   103

	if (is_custom_sprite(spritenum)) {

   104

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

   105

   106

		if (sprite != 0) {

   107

			DrawSprite(sprite, pal, x, y);

   108

			return;

   109

		}

   110

		spritenum = orig_road_vehicle_info[engine - ROAD_ENGINES_INDEX].image_index;

   111

	}

   112

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

   113

}

   114

   115

static int32 EstimateRoadVehCost(EngineID engine_type)

   116

{

   117

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

   118

}

   119

   120

/** Build a road vehicle.

   121

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

   122

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

   123

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

   124

 */

   125

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

   126

{

   127

	int32 cost;

   128

	Vehicle *v;

   129

	UnitID unit_num;

   130

	Engine *e;

   131

   132

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

   133

   134

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   135

   136

	cost = EstimateRoadVehCost(p1);

   137

	if (flags & DC_QUERY_COST) return cost;

   138

   139

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

   140

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

   141

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

   142

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

   143

   144

	v = AllocateVehicle();

   145

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

   146

   147

	/* find the first free roadveh id */

   148

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

   149

	if (unit_num > _patches.max_roadveh)

   150

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   151

   152

	if (flags & DC_EXEC) {

   153

		int x;

   154

		int y;

   155

   156

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   157

   158

		v->unitnumber = unit_num;

   159

		v->direction = INVALID_DIR;

   160

		v->owner = _current_player;

   161

   162

		v->tile = tile;

   163

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

   164

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

   165

		v->x_pos = x;

   166

		v->y_pos = y;

   167

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

   168

		v->z_height = 6;

   169

   170

		v->u.road.state = RVSB_IN_DEPOT;

   171

		v->vehstatus = VS_HIDDEN|VS_STOPPED|VS_DEFPAL;

   172

   173

		v->spritenum = rvi->image_index;

   174

		v->cargo_type = rvi->cargo_type;

   175

		v->cargo_subtype = 0;

   176

		v->cargo_cap = rvi->capacity;

   177

//		v->cargo_count = 0;

   178

		v->value = cost;

   179

//		v->day_counter = 0;

   180

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

   181

//		v->load_unload_time_rem = 0;

   182

//		v->progress = 0;

   183

   184

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

   185

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

   186

   187

		v->last_station_visited = INVALID_STATION;

   188

		v->max_speed = rvi->max_speed;

   189

		v->engine_type = (byte)p1;

   190

   191

		e = GetEngine(p1);

   192

		v->reliability = e->reliability;

   193

		v->reliability_spd_dec = e->reliability_spd_dec;

   194

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

   195

		_new_vehicle_id = v->index;

   196

   197

		v->string_id = STR_SV_ROADVEH_NAME;

   198

   199

		v->service_interval = _patches.servint_roadveh;

   200

   201

		v->date_of_last_service = _date;

   202

		v->build_year = _cur_year;

   203

   204

		v->type = VEH_ROAD;

   205

		v->cur_image = 0xC15;

   206

		v->random_bits = VehicleRandomBits();

   207

   208

		v->vehicle_flags = 0;

   209

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

   210

   211

		VehiclePositionChanged(v);

   212

   213

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   214

		RebuildVehicleLists();

   215

		InvalidateWindow(WC_COMPANY, v->owner);

   216

		if (IsLocalPlayer())

   217

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

   218

   219

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

   220

	}

   221

   222

	return cost;

   223

}

   224

   225

/** Start/Stop a road vehicle.

   226

 * @param tile unused

   227

 * @param p1 road vehicle ID to start/stop

   228

 * @param p2 unused

   229

 */

   230

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

   231

{

   232

	Vehicle *v;

   233

	uint16 callback;

   234

   235

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   236

   237

	v = GetVehicle(p1);

   238

   239

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

   240

   241

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

   242

	 * return 0xFF if it can. */

   243

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

   244

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

   245

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

   246

		return_cmd_error(error);

   247

	}

   248

   249

	if (flags & DC_EXEC) {

   250

		if (IsRoadVehInDepotStopped(v)) {

   251

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   252

		}

   253

   254

		v->vehstatus ^= VS_STOPPED;

   255

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

   256

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   257

	}

   258

   259

	return 0;

   260

}

   261

   262

void ClearSlot(Vehicle *v)

   263

{

   264

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

   265

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

   266

   267

	v->u.road.slot = NULL;

   268

	v->u.road.slot_age = 0;

   269

   270

	assert(rs->num_vehicles != 0);

   271

	rs->num_vehicles--;

   272

   273

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

   274

}

   275

   276

/** Sell a road vehicle.

   277

 * @param tile unused

   278

 * @param p1 vehicle ID to be sold

   279

 * @param p2 unused

   280

 */

   281

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

   282

{

   283

	Vehicle *v;

   284

   285

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   286

   287

	v = GetVehicle(p1);

   288

   289

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

   290

   291

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   292

   293

	if (!IsRoadVehInDepotStopped(v)) {

   294

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   295

	}

   296

   297

	if (flags & DC_EXEC) {

   298

		// Invalidate depot

   299

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   300

		RebuildVehicleLists();

   301

		InvalidateWindow(WC_COMPANY, v->owner);

   302

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   303

		DeleteDepotHighlightOfVehicle(v);

   304

		DeleteVehicle(v);

   305

	}

   306

   307

	return -(int32)v->value;

   308

}

   309

   310

struct RoadFindDepotData {

   311

	uint best_length;

   312

	TileIndex tile;

   313

	OwnerByte owner;

   314

};

   315

   316

static const DiagDirection _road_pf_directions[] = {

   317

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

   318

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

   319

};

   320

   321

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

   322

{

   323

	RoadFindDepotData* rfdd = (RoadFindDepotData*)data;

   324

   325

	tile += TileOffsByDiagDir(_road_pf_directions[trackdir]);

   326

   327

	if (IsTileType(tile, MP_STREET) &&

   328

			GetRoadTileType(tile) == ROAD_TILE_DEPOT &&

   329

			IsTileOwner(tile, rfdd->owner) &&

   330

			length < rfdd->best_length) {

   331

		rfdd->best_length = length;

   332

		rfdd->tile = tile;

   333

	}

   334

	return false;

   335

}

   336

   337

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   338

{

   339

	TileIndex tile = v->tile;

   340

   341

	if (_patches.yapf.road_use_yapf) {

   342

		Depot* ret = YapfFindNearestRoadDepot(v);

   343

		return ret;

   344

	} else if (_patches.new_pathfinding_all) {

   345

		NPFFoundTargetData ftd;

   346

		/* See where we are now */

   347

		Trackdir trackdir = GetVehicleTrackdir(v);

   348

   349

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

   350

		if (ftd.best_bird_dist == 0) {

   351

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

   352

		} else {

   353

			return NULL; /* Target not found */

   354

		}

   355

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

   356

	} else {

   357

		RoadFindDepotData rfdd;

   358

   359

		rfdd.owner = v->owner;

   360

		rfdd.best_length = (uint)-1;

   361

   362

		/* search in all directions */

   363

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

   364

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

   365

		}

   366

   367

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

   368

   369

		return GetDepotByTile(rfdd.tile);

   370

	}

   371

}

   372

   373

/** Send a road vehicle to the depot.

   374

 * @param tile unused

   375

 * @param p1 vehicle ID to send to the depot

   376

 * @param p2 various bitmasked elements

   377

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

   378

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

   379

 */

   380

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

   381

{

   382

	Vehicle *v;

   383

	const Depot *dep;

   384

   385

	if (p2 & DEPOT_MASS_SEND) {

   386

		/* Mass goto depot requested */

   387

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

   388

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

   389

	}

   390

   391

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   392

   393

	v = GetVehicle(p1);

   394

   395

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

   396

   397

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

   398

   399

	if (IsRoadVehInDepot(v)) return CMD_ERROR;

   400

   401

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

   402

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

   403

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

   404

			/* We called with a different DEPOT_SERVICE setting.

   405

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

   406

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

   407

			if (flags & DC_EXEC) {

   408

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

   409

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

   410

			}

   411

			return 0;

   412

		}

   413

   414

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

   415

		if (flags & DC_EXEC) {

   416

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

   417

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

   418

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

   419

				v->cur_order_index++;

   420

   421

			v->current_order.type = OT_DUMMY;

   422

			v->current_order.flags = 0;

   423

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

   424

		}

   425

		return 0;

   426

	}

   427

   428

	dep = FindClosestRoadDepot(v);

   429

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

   430

   431

	if (flags & DC_EXEC) {

   432

		ClearSlot(v);

   433

		v->current_order.type = OT_GOTO_DEPOT;

   434

		v->current_order.flags = OF_NON_STOP;

   435

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

   436

		v->current_order.refit_cargo = CT_INVALID;

   437

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

   438

		v->dest_tile = dep->xy;

   439

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

   440

	}

   441

   442

	return 0;

   443

}

   444

   445

/** Turn a roadvehicle around.

   446

 * @param tile unused

   447

 * @param p1 vehicle ID to turn

   448

 * @param p2 unused

   449

 */

   450

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

   451

{

   452

	Vehicle *v;

   453

   454

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   455

   456

	v = GetVehicle(p1);

   457

   458

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

   459

   460

	if (v->vehstatus & VS_STOPPED ||

   461

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

   462

			v->breakdown_ctr != 0 ||

   463

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

   464

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

   465

			IsRoadVehInDepot(v) ||

   466

			v->cur_speed < 5) {

   467

		return CMD_ERROR;

   468

	}

   469

   470

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

   471

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

   472

   473

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

   474

   475

	return 0;

   476

}

   477

   478

   479

static void MarkRoadVehDirty(Vehicle *v)

   480

{

   481

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

   482

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

   483

}

   484

   485

static void UpdateRoadVehDeltaXY(Vehicle *v)

   486

{

   487

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

   488

	static const uint32 _delta_xy_table[8] = {

   489

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

   490

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