1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include <limits.h>

     5

#include "openttd.h"

     6

#include "debug.h"

     7

#include "functions.h"

     8

#include "road_map.h"

     9

#include "roadveh.h"

    10

#include "station_map.h"

    11

#include "table/strings.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "vehicle.h"

    15

#include "engine.h"

    16

#include "command.h"

    17

#include "station.h"

    18

#include "news.h"

    19

#include "pathfind.h"

    20

#include "npf.h"

    21

#include "player.h"

    22

#include "sound.h"

    23

#include "depot.h"

    24

#include "tunnel_map.h"

    25

#include "vehicle_gui.h"

    26

#include "newgrf_callbacks.h"

    27

#include "newgrf_engine.h"

    28

#include "newgrf_text.h"

    29

#include "newgrf_sound.h"

    30

#include "yapf/yapf.h"

    31

#include "date.h"

    32

    33

static const uint16 _roadveh_images[63] = {

    34

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

    35

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

    36

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

    37

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

    38

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

    39

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

    40

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

    41

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

    42

};

    43

    44

static const uint16 _roadveh_full_adder[63] = {

    45

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

    46

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

    47

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

    48

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

    49

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

    50

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

    51

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

    52

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

    53

};

    54

    55

    56

static const uint16 _road_veh_fp_ax_and[4] = {

    57

	0x1009, 0x16, 0x520, 0x2A00

    58

};

    59

    60

static const byte _road_reverse_table[4] = {

    61

	6, 7, 14, 15

    62

};

    63

    64

static const uint16 _road_pf_table_3[4] = {

    65

	0x910, 0x1600, 0x2005, 0x2A

    66

};

    67

    68

int GetRoadVehImage(const Vehicle* v, Direction direction)

    69

{

    70

	int img = v->spritenum;

    71

	int image;

    72

    73

	if (is_custom_sprite(img)) {

    74

		image = GetCustomVehicleSprite(v, direction);

    75

		if (image != 0) return image;

    76

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

    77

	}

    78

    79

	image = direction + _roadveh_images[img];

    80

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

    81

	return image;

    82

}

    83

    84

void DrawRoadVehEngine(int x, int y, EngineID engine, uint32 image_ormod)

    85

{

    86

	int spritenum = RoadVehInfo(engine)->image_index;

    87

    88

	if (is_custom_sprite(spritenum)) {

    89

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    90

    91

		if (sprite != 0) {

    92

			DrawSprite(sprite | image_ormod, x, y);

    93

			return;

    94

		}

    95

		spritenum = orig_road_vehicle_info[engine - ROAD_ENGINES_INDEX].image_index;

    96

	}

    97

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

    98

}

    99

   100

static int32 EstimateRoadVehCost(EngineID engine_type)

   101

{

   102

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

   103

}

   104

   105

/** Build a road vehicle.

   106

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

   107

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

   108

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

   109

 */

   110

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

   111

{

   112

	int32 cost;

   113

	Vehicle *v;

   114

	UnitID unit_num;

   115

	Engine *e;

   116

   117

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

   118

   119

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   120

   121

	cost = EstimateRoadVehCost(p1);

   122

	if (flags & DC_QUERY_COST) return cost;

   123

   124

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

   125

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

   126

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

   127

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

   128

   129

	v = AllocateVehicle();

   130

	if (v == NULL || IsOrderPoolFull())

   131

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   132

   133

	/* find the first free roadveh id */

   134

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

   135

	if (unit_num > _patches.max_roadveh)

   136

		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);

   137

   138

	if (flags & DC_EXEC) {

   139

		int x;

   140

		int y;

   141

   142

		const RoadVehicleInfo *rvi = RoadVehInfo(p1);

   143

   144

		v->unitnumber = unit_num;

   145

		v->direction = 0;

   146

		v->owner = _current_player;

   147

   148

		v->tile = tile;

   149

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

   150

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

   151

		v->x_pos = x;

   152

		v->y_pos = y;

   153

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

   154

		v->z_height = 6;

   155

   156

		v->u.road.state = 254;

   157

		v->vehstatus = VS_HIDDEN|VS_STOPPED|VS_DEFPAL;

   158

   159

		v->spritenum = rvi->image_index;

   160

		v->cargo_type = rvi->cargo_type;

   161

		v->cargo_subtype = 0;

   162

		v->cargo_cap = rvi->capacity;

   163

//		v->cargo_count = 0;

   164

		v->value = cost;

   165

//		v->day_counter = 0;

   166

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

   167

//		v->load_unload_time_rem = 0;

   168

//		v->progress = 0;

   169

   170

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

   171

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

   172

   173

		v->last_station_visited = INVALID_STATION;

   174

		v->max_speed = rvi->max_speed;

   175

		v->engine_type = (byte)p1;

   176

   177

		e = GetEngine(p1);

   178

		v->reliability = e->reliability;

   179

		v->reliability_spd_dec = e->reliability_spd_dec;

   180

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

   181

		_new_vehicle_id = v->index;

   182

   183

		v->string_id = STR_SV_ROADVEH_NAME;

   184

   185

		v->service_interval = _patches.servint_roadveh;

   186

   187

		v->date_of_last_service = _date;

   188

		v->build_year = _cur_year;

   189

   190

		v->type = VEH_Road;

   191

		v->cur_image = 0xC15;

   192

		v->random_bits = VehicleRandomBits();

   193

   194

		VehiclePositionChanged(v);

   195

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

   196

   197

		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   198

		RebuildVehicleLists();

   199

		InvalidateWindow(WC_COMPANY, v->owner);

   200

		if (IsLocalPlayer())

   201

			InvalidateWindow(WC_REPLACE_VEHICLE, VEH_Road); // updates the replace Road window

   202

	}

   203

   204

	return cost;

   205

}

   206

   207

/** Start/Stop a road vehicle.

   208

 * @param tile unused

   209

 * @param p1 road vehicle ID to start/stop

   210

 * @param p2 unused

   211

 */

   212

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

   213

{

   214

	Vehicle *v;

   215

	uint16 callback;

   216

   217

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   218

   219

	v = GetVehicle(p1);

   220

   221

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

   222

   223

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

   224

	 * return 0xFF if it can. */

   225

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

   226

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

   227

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

   228

		return_cmd_error(error);

   229

	}

   230

   231

	if (flags & DC_EXEC) {

   232

		if (IsRoadVehInDepotStopped(v)) {

   233

			DeleteVehicleNews(p1, STR_9016_ROAD_VEHICLE_IS_WAITING);

   234

		}

   235

   236

		v->vehstatus ^= VS_STOPPED;

   237

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

   238

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   239

	}

   240

   241

	return 0;

   242

}

   243

   244

void ClearSlot(Vehicle *v)

   245

{

   246

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

   247

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

   248

   249

	v->u.road.slot = NULL;

   250

	v->u.road.slot_age = 0;

   251

   252

	assert(rs->num_vehicles != 0);

   253

	rs->num_vehicles--;

   254

   255

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

   256

}

   257

   258

/** Sell a road vehicle.

   259

 * @param tile unused

   260

 * @param p1 vehicle ID to be sold

   261

 * @param p2 unused

   262

 */

   263

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

   264

{

   265

	Vehicle *v;

   266

   267

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   268

   269

	v = GetVehicle(p1);

   270

   271

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

   272

   273

	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);

   274

   275

	if (!IsRoadVehInDepotStopped(v)) {

   276

		return_cmd_error(STR_9013_MUST_BE_STOPPED_INSIDE);

   277

	}

   278

   279

	if (flags & DC_EXEC) {

   280

		// Invalidate depot

   281

		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   282

		RebuildVehicleLists();

   283

		InvalidateWindow(WC_COMPANY, v->owner);

   284

		DeleteWindowById(WC_VEHICLE_VIEW, v->index);

   285

		ClearSlot(v);

   286

		DeleteVehicle(v);

   287

		if (IsLocalPlayer()) InvalidateWindow(WC_REPLACE_VEHICLE, VEH_Road);

   288

	}

   289

   290

	return -(int32)v->value;

   291

}

   292

   293

typedef struct RoadFindDepotData {

   294

	uint best_length;

   295

	TileIndex tile;

   296

	byte owner;

   297

} RoadFindDepotData;

   298

   299

static const DiagDirection _road_pf_directions[] = {

   300

	DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_NE, DIAGDIR_SE, DIAGDIR_SW, DIAGDIR_SE, 255, 255,

   301

	DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NW, DIAGDIR_SW, DIAGDIR_NW, DIAGDIR_NE, 255, 255

   302

};

   303

   304

static bool EnumRoadSignalFindDepot(TileIndex tile, void* data, int track, uint length, byte* state)

   305

{

   306

	RoadFindDepotData* rfdd = data;

   307

   308

	tile += TileOffsByDiagDir(_road_pf_directions[track]);

   309

   310

	if (IsTileType(tile, MP_STREET) &&

   311

			GetRoadTileType(tile) == ROAD_TILE_DEPOT &&

   312

			IsTileOwner(tile, rfdd->owner) &&

   313

			length < rfdd->best_length) {

   314

		rfdd->best_length = length;

   315

		rfdd->tile = tile;

   316

	}

   317

	return false;

   318

}

   319

   320

static const Depot* FindClosestRoadDepot(const Vehicle* v)

   321

{

   322

	TileIndex tile = v->tile;

   323

   324

	if (v->u.road.state == 255) tile = GetVehicleOutOfTunnelTile(v);

   325

   326

	if (_patches.yapf.road_use_yapf) {

   327

		Depot* ret = YapfFindNearestRoadDepot(v);

   328

		return ret;

   329

	} else if (_patches.new_pathfinding_all) {

   330

		NPFFoundTargetData ftd;

   331

		/* See where we are now */

   332

		Trackdir trackdir = GetVehicleTrackdir(v);

   333

   334

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

   335

		if (ftd.best_bird_dist == 0) {

   336

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

   337

		} else {

   338

			return NULL; /* Target not found */

   339

		}

   340

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

   341

	} else {

   342

		RoadFindDepotData rfdd;

   343

		DiagDirection i;

   344

   345

		rfdd.owner = v->owner;

   346

		rfdd.best_length = (uint)-1;

   347

   348

		/* search in all directions */

   349

		for (i = 0; i != 4; i++) {

   350

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

   351

		}

   352

   353

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

   354

   355

		return GetDepotByTile(rfdd.tile);

   356

	}

   357

}

   358

   359

/** Send a road vehicle to the depot.

   360

 * @param tile unused

   361

 * @param p1 vehicle ID to send to the depot

   362

 * @param p2 various bitmasked elements

   363

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

   364

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

   365

 */

   366

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

   367

{

   368

	Vehicle *v;

   369

	const Depot *dep;

   370

   371

	if (p2 & DEPOT_MASS_SEND) {

   372

		/* Mass goto depot requested */

   373

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

   374

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

   375

	}

   376

   377

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   378

   379

	v = GetVehicle(p1);

   380

   381

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

   382

   383

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

   384

   385

	if (IsRoadVehInDepot(v)) return CMD_ERROR;

   386

   387

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

   388

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

   389

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

   390

			/* We called with a different DEPOT_SERVICE setting.

   391

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

   392

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

   393

			if (flags & DC_EXEC) {

   394

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

   395

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

   396

			}

   397

			return 0;

   398

		}

   399

   400

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

   401

		if (flags & DC_EXEC) {

   402

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

   403

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

   404

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

   405

				v->cur_order_index++;

   406

   407

			v->current_order.type = OT_DUMMY;

   408

			v->current_order.flags = 0;

   409

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

   410

		}

   411

		return 0;

   412

	}

   413

   414

	dep = FindClosestRoadDepot(v);

   415

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

   416

   417

	if (flags & DC_EXEC) {

   418

		ClearSlot(v);

   419

		v->current_order.type = OT_GOTO_DEPOT;

   420

		v->current_order.flags = OF_NON_STOP;

   421

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

   422

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

   423

		v->dest_tile = dep->xy;

   424

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

   425

	}

   426

   427

	return 0;

   428

}

   429

   430

/** Turn a roadvehicle around.

   431

 * @param tile unused

   432

 * @param p1 vehicle ID to turn

   433

 * @param p2 unused

   434

 */

   435

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

   436

{

   437

	Vehicle *v;

   438

   439

	if (!IsValidVehicleID(p1)) return CMD_ERROR;

   440

   441

	v = GetVehicle(p1);

   442

   443

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

   444

   445

	if (v->vehstatus & (VS_HIDDEN | VS_STOPPED) ||

   446

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

   447

			v->breakdown_ctr != 0 ||

   448

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

   449

			v->cur_speed < 5) {

   450

		return CMD_ERROR;

   451

	}

   452

   453

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

   454

   455

	return 0;

   456

}

   457

   458

   459

static void MarkRoadVehDirty(Vehicle *v)

   460

{

   461

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

   462

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

   463

}

   464

   465

static void UpdateRoadVehDeltaXY(Vehicle *v)

   466

{

   467

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

   468

	static const uint32 _delta_xy_table[8] = {

   469

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

   470

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

   471

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

   472

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

   473

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

   474

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

   475

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

   476

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

   477

	};

   478

#undef MKIT

   479

	uint32 x = _delta_xy_table[v->direction];

   480

	v->x_offs        = GB(x,  0, 8);

   481

	v->y_offs        = GB(x,  8, 8);

   482

	v->sprite_width  = GB(x, 16, 8);

   483

	v->sprite_height = GB(x, 24, 8);

   484

}

   485

   486

static void ClearCrashedStation(Vehicle *v)

   487

{

   488

	RoadStop *rs = GetRoadStopByTile(v->tile, GetRoadStopType(v->tile));

   489

   490

	// mark station as not busy

   491

	CLRBIT(rs->status, 7);

   492

   493

	// free parking bay