1

/* $Id$ */

     2

     3

/** @file ship_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "ship.h"

     8

#include "tile_cmd.h"

     9

#include "landscape.h"

    10

#include "timetable.h"

    11

#include "command_func.h"

    12

#include "pathfind.h"

    13

#include "station_map.h"

    14

#include "station_base.h"

    15

#include "news_func.h"

    16

#include "engine_func.h"

    17

#include "player_func.h"

    18

#include "player_base.h"

    19

#include "npf.h"

    20

#include "depot_base.h"

    21

#include "depot_func.h"

    22

#include "vehicle_gui.h"

    23

#include "newgrf_engine.h"

    24

#include "water_map.h"

    25

#include "yapf/yapf.h"

    26

#include "debug.h"

    27

#include "newgrf_callbacks.h"

    28

#include "newgrf_text.h"

    29

#include "newgrf_sound.h"

    30

#include "spritecache.h"

    31

#include "strings_func.h"

    32

#include "functions.h"

    33

#include "window_func.h"

    34

#include "date_func.h"

    35

#include "vehicle_func.h"

    36

#include "sound_func.h"

    37

#include "variables.h"

    38

#include "autoreplace_gui.h"

    39

#include "gfx_func.h"

    40

#include "settings_type.h"

    41

#include "order_func.h"

    42

#include "effectvehicle_func.h"

    43

    44

#include "table/strings.h"

    45

    46

static const uint16 _ship_sprites[] = {0x0E5D, 0x0E55, 0x0E65, 0x0E6D};

    47

    48

static const TrackBits _ship_sometracks[4] = {

    49

	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_LEFT,  // 0x19, // DIAGDIR_NE

    50

	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_LEFT,  // 0x16, // DIAGDIR_SE

    51

	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_RIGHT, // 0x25, // DIAGDIR_SW

    52

	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_RIGHT, // 0x2A, // DIAGDIR_NW

    53

};

    54

    55

static inline TrackBits GetTileShipTrackStatus(TileIndex tile)

    56

{

    57

	return TrackStatusToTrackBits(GetTileTrackStatus(tile, TRANSPORT_WATER, 0));

    58

}

    59

    60

static SpriteID GetShipIcon(EngineID engine)

    61

{

    62

	uint8 spritenum = ShipVehInfo(engine)->image_index;

    63

    64

	if (is_custom_sprite(spritenum)) {

    65

		SpriteID sprite = GetCustomVehicleIcon(engine, DIR_W);

    66

		if (sprite != 0) return sprite;

    67

    68

		spritenum = _orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    69

	}

    70

    71

	return 6 + _ship_sprites[spritenum];

    72

}

    73

    74

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

    75

{

    76

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

    77

}

    78

    79

/** Get the size of the sprite of a ship sprite heading west (used for lists)

    80

 * @param engine The engine to get the sprite from

    81

 * @param width The width of the sprite

    82

 * @param height The height of the sprite

    83

 */

    84

void GetShipSpriteSize(EngineID engine, uint &width, uint &height)

    85

{

    86

	const Sprite *spr = GetSprite(GetShipIcon(engine));

    87

    88

	width  = spr->width;

    89

	height = spr->height;

    90

}

    91

    92

SpriteID Ship::GetImage(Direction direction) const

    93

{

    94

	uint8 spritenum = this->spritenum;

    95

    96

	if (is_custom_sprite(spritenum)) {

    97

		SpriteID sprite = GetCustomVehicleSprite(this, direction);

    98

		if (sprite != 0) return sprite;

    99

   100

		spritenum = _orig_ship_vehicle_info[this->engine_type - SHIP_ENGINES_INDEX].image_index;

   101

	}

   102

   103

	return _ship_sprites[spritenum] + direction;

   104

}

   105

   106

static const Depot* FindClosestShipDepot(const Vehicle* v)

   107

{

   108

	if (_patches.pathfinder_for_ships == VPF_NPF) { /* NPF is used */

   109

		Trackdir trackdir = GetVehicleTrackdir(v);

   110

		NPFFoundTargetData ftd = NPFRouteToDepotTrialError(v->tile, trackdir, false, TRANSPORT_WATER, 0, v->owner, INVALID_RAILTYPES);

   111

   112

		if (ftd.best_bird_dist == 0) return GetDepotByTile(ftd.node.tile); /* Found target */

   113

   114

		return NULL; /* Did not find target */

   115

	}

   116

   117

	/* OPF or YAPF - find the closest depot */

   118

   119

	const Depot* depot;

   120

	const Depot* best_depot = NULL;

   121

	uint best_dist = UINT_MAX;

   122

   123

	FOR_ALL_DEPOTS(depot) {

   124

		TileIndex tile = depot->xy;

   125

		if (IsShipDepotTile(tile) && IsTileOwner(tile, v->owner)) {

   126

			uint dist = DistanceManhattan(tile, v->tile);

   127

			if (dist < best_dist) {

   128

				best_dist = dist;

   129

				best_depot = depot;

   130

			}

   131

		}

   132

	}

   133

   134

	return best_depot;

   135

}

   136

   137

static void CheckIfShipNeedsService(Vehicle *v)

   138

{

   139

	if (_patches.servint_ships == 0 || !v->NeedsAutomaticServicing()) return;

   140

	if (v->IsInDepot()) {

   141

		VehicleServiceInDepot(v);

   142

		return;

   143

	}

   144

   145

	const Depot *depot = FindClosestShipDepot(v);

   146

   147

	if (depot == NULL || DistanceManhattan(v->tile, depot->xy) > 12) {

   148

		if (v->current_order.IsType(OT_GOTO_DEPOT)) {

   149

			v->current_order.MakeDummy();

   150

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

   151

		}

   152

		return;

   153

	}

   154

   155

	v->current_order.MakeGoToDepot(depot->index, ODTFB_SERVICE);

   156

	v->dest_tile = depot->xy;

   157

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

   158

}

   159

   160

void Ship::OnNewDay()

   161

{

   162

	if ((++this->day_counter & 7) == 0)

   163

		DecreaseVehicleValue(this);

   164

   165

	CheckVehicleBreakdown(this);

   166

	AgeVehicle(this);

   167

	CheckIfShipNeedsService(this);

   168

   169

	CheckOrders(this);

   170

   171

	if (this->running_ticks == 0) return;

   172

   173

	CommandCost cost(EXPENSES_SHIP_RUN, GetVehicleProperty(this, 0x0F, ShipVehInfo(this->engine_type)->running_cost) * _price.ship_running * this->running_ticks / (364 * DAY_TICKS));

   174

   175

	this->profit_this_year -= cost.GetCost();

   176

	this->running_ticks = 0;

   177

   178

	SubtractMoneyFromPlayerFract(this->owner, cost);

   179

   180

	InvalidateWindow(WC_VEHICLE_DETAILS, this->index);

   181

	/* we need this for the profit */

   182

	InvalidateWindowClasses(WC_SHIPS_LIST);

   183

}

   184

   185

static void HandleBrokenShip(Vehicle *v)

   186

{

   187

	if (v->breakdown_ctr != 1) {

   188

		v->breakdown_ctr = 1;

   189

		v->cur_speed = 0;

   190

   191

		if (v->breakdowns_since_last_service != 255)

   192

			v->breakdowns_since_last_service++;

   193

   194

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   195

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   196

   197

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   198

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   199

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   200

		}

   201

   202

		if (!(v->vehstatus & VS_HIDDEN)) {

   203

			Vehicle *u = CreateEffectVehicleRel(v, 4, 4, 5, EV_BREAKDOWN_SMOKE);

   204

			if (u != NULL) u->u.effect.animation_state = v->breakdown_delay * 2;

   205

		}

   206

	}

   207

   208

	if (!(v->tick_counter & 1)) {

   209

		if (!--v->breakdown_delay) {

   210

			v->breakdown_ctr = 0;

   211

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   212

		}

   213

	}

   214

}

   215

   216

void Ship::MarkDirty()

   217

{

   218

	this->cur_image = this->GetImage(this->direction);

   219

	MarkSingleVehicleDirty(this);

   220

}

   221

   222

static void PlayShipSound(const Vehicle *v)

   223

{

   224

	if (!PlayVehicleSound(v, VSE_START)) {

   225

		SndPlayVehicleFx(ShipVehInfo(v->engine_type)->sfx, v);

   226

	}

   227

}

   228

   229

void Ship::PlayLeaveStationSound() const

   230

{

   231

	PlayShipSound(this);

   232

}

   233

   234

TileIndex Ship::GetOrderStationLocation(StationID station)

   235

{

   236

	if (station == this->last_station_visited) this->last_station_visited = INVALID_STATION;

   237

   238

	const Station *st = GetStation(station);

   239

	if (st->dock_tile != 0) {

   240

		return TILE_ADD(st->dock_tile, ToTileIndexDiff(GetDockOffset(st->dock_tile)));

   241

	} else {

   242

		this->cur_order_index++;

   243

		return 0;

   244

	}

   245

}

   246

   247

void Ship::UpdateDeltaXY(Direction direction)

   248

{

   249

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

   250

	static const uint32 _delta_xy_table[8] = {

   251

		MKIT( 6,  6,  -3,  -3),

   252

		MKIT( 6, 32,  -3, -16),

   253

		MKIT( 6,  6,  -3,  -3),

   254

		MKIT(32,  6, -16,  -3),

   255

		MKIT( 6,  6,  -3,  -3),

   256

		MKIT( 6, 32,  -3, -16),

   257

		MKIT( 6,  6,  -3,  -3),

   258

		MKIT(32,  6, -16,  -3),

   259

	};

   260

#undef MKIT

   261

   262

	uint32 x = _delta_xy_table[direction];

   263

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

   264

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

   265

	this->x_extent      = GB(x, 16, 8);

   266

	this->y_extent      = GB(x, 24, 8);

   267

	this->z_extent      = 6;

   268

}

   269

   270

void RecalcShipStuff(Vehicle *v)

   271

{

   272

	v->UpdateDeltaXY(v->direction);

   273

	v->cur_image = v->GetImage(v->direction);

   274

	v->MarkDirty();

   275

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   276

}

   277

   278

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   279

	{-1,  0},

   280

	{ 0, -1}

   281

};

   282

   283

static void CheckShipLeaveDepot(Vehicle *v)

   284

{

   285

	if (!v->IsInDepot()) return;

   286

   287

	TileIndex tile = v->tile;

   288

	Axis axis = GetShipDepotAxis(tile);

   289

   290

	/* Check first (north) side */

   291

	if (_ship_sometracks[axis] & GetTileShipTrackStatus(TILE_ADD(tile, ToTileIndexDiff(_ship_leave_depot_offs[axis])))) {

   292

		v->direction = ReverseDir(AxisToDirection(axis));

   293

	/* Check second (south) side */

   294

	} else if (_ship_sometracks[axis + 2] & GetTileShipTrackStatus(TILE_ADD(tile, -2 * ToTileIndexDiff(_ship_leave_depot_offs[axis])))) {

   295

		v->direction = AxisToDirection(axis);

   296

	} else {

   297

		return;

   298

	}

   299

   300

	v->u.ship.state = AxisToTrackBits(axis);

   301

	v->vehstatus &= ~VS_HIDDEN;

   302

   303

	v->cur_speed = 0;

   304

	RecalcShipStuff(v);

   305

   306

	PlayShipSound(v);

   307

	VehicleServiceInDepot(v);

   308

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   309

	InvalidateWindowClasses(WC_SHIPS_LIST);

   310

}

   311

   312

static bool ShipAccelerate(Vehicle *v)

   313

{

   314

	uint spd;

   315

	byte t;

   316

   317

	spd = min(v->cur_speed + 1, GetVehicleProperty(v, 0x0B, v->max_speed));

   318

   319

	/*updates statusbar only if speed have changed to save CPU time */

   320

	if (spd != v->cur_speed) {

   321

		v->cur_speed = spd;

   322

		if (_patches.vehicle_speed)

   323

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

   324

	}

   325

   326

	/* Decrease somewhat when turning */

   327

	if (!(v->direction & 1)) spd = spd * 3 / 4;

   328

   329

	if (spd == 0) return false;

   330

	if ((byte)++spd == 0) return true;

   331

   332

	v->progress = (t = v->progress) - (byte)spd;

   333

   334

	return (t < v->progress);

   335

}

   336

   337

static CommandCost EstimateShipCost(EngineID engine_type)

   338

{

   339

	return CommandCost(EXPENSES_NEW_VEHICLES, GetEngineProperty(engine_type, 0x0A, ShipVehInfo(engine_type)->base_cost) * (_price.ship_base >> 3) >> 5);

   340

}

   341

   342

static void ShipArrivesAt(const Vehicle* v, Station* st)

   343

{

   344

	/* Check if station was ever visited before */

   345

	if (!(st->had_vehicle_of_type & HVOT_SHIP)) {

   346

		st->had_vehicle_of_type |= HVOT_SHIP;

   347

   348

		SetDParam(0, st->index);

   349

		AddNewsItem(

   350

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   351

			NM_THIN, NF_VIEWPORT | NF_VEHICLE, (v->owner == _local_player) ? NT_ARRIVAL_PLAYER : NT_ARRIVAL_OTHER, DNC_NONE,

   352

			v->index,

   353

			0);

   354

	}

   355

}

   356

   357

struct PathFindShip {

   358

	TileIndex skiptile;

   359

	TileIndex dest_coords;

   360

	uint best_bird_dist;

   361

	uint best_length;

   362

};

   363

   364

static bool ShipTrackFollower(TileIndex tile, PathFindShip *pfs, int track, uint length)

   365

{

   366

	/* Found dest? */

   367

	if (tile == pfs->dest_coords) {

   368

		pfs->best_bird_dist = 0;

   369

   370

		pfs->best_length = minu(pfs->best_length, length);

   371

		return true;

   372

	}

   373

   374

	/* Skip this tile in the calculation */

   375

	if (tile != pfs->skiptile) {

   376

		pfs->best_bird_dist = minu(pfs->best_bird_dist, DistanceMaxPlusManhattan(pfs->dest_coords, tile));

   377

	}

   378

   379

	return false;

   380

}

   381

   382

static const byte _ship_search_directions[6][4] = {

   383

	{ 0, 9, 2, 9 },

   384

	{ 9, 1, 9, 3 },

   385

	{ 9, 0, 3, 9 },

   386

	{ 1, 9, 9, 2 },

   387

	{ 3, 2, 9, 9 },

   388

	{ 9, 9, 1, 0 },

   389

};

   390

   391

static const byte _pick_shiptrack_table[6] = {1, 3, 2, 2, 0, 0};

   392

   393

static uint FindShipTrack(Vehicle *v, TileIndex tile, DiagDirection dir, TrackBits bits, TileIndex skiptile, Track *track)

   394

{

   395

	PathFindShip pfs;

   396

	Track i, best_track;

   397

	uint best_bird_dist = 0;

   398

	uint best_length    = 0;

   399

	uint r;

   400

	byte ship_dir = v->direction & 3;

   401

   402

	pfs.dest_coords = v->dest_tile;

   403

	pfs.skiptile = skiptile;

   404

   405

	best_track = INVALID_TRACK;

   406

   407

	do {

   408

		i = RemoveFirstTrack(&bits);

   409

   410

		pfs.best_bird_dist = (uint)-1;

   411

		pfs.best_length = (uint)-1;

   412

   413

		FollowTrack(tile, PATHFIND_FLAGS_SHIP_MODE | PATHFIND_FLAGS_DISABLE_TILE_HASH, TRANSPORT_WATER, 0, (DiagDirection)_ship_search_directions[i][dir], (TPFEnumProc*)ShipTrackFollower, NULL, &pfs);

   414

   415

		if (best_track != INVALID_TRACK) {

   416

			if (pfs.best_bird_dist != 0) {

   417

				/* neither reached the destination, pick the one with the smallest bird dist */

   418

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   419

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   420

			} else {

   421

				if (pfs.best_length > best_length) goto bad;

   422

				if (pfs.best_length < best_length) goto good;

   423

			}

   424

   425

			/* if we reach this position, there's two paths of equal value so far.

   426

			 * pick one randomly. */

   427

			r = GB(Random(), 0, 8);

   428

			if (_pick_shiptrack_table[i] == ship_dir) r += 80;

   429

			if (_pick_shiptrack_table[best_track] == ship_dir) r -= 80;

   430

			if (r <= 127) goto bad;

   431

		}

   432

good:;

   433

		best_track = i;

   434

		best_bird_dist = pfs.best_bird_dist;

   435

		best_length = pfs.best_length;

   436

bad:;

   437

   438

	} while (bits != 0);

   439

   440

	*track = best_track;

   441

	return best_bird_dist;

   442

}

   443

   444

static inline NPFFoundTargetData PerfNPFRouteToStationOrTile(TileIndex tile, Trackdir trackdir, bool ignore_start_tile, NPFFindStationOrTileData* target, TransportType type, Owner owner, RailTypes railtypes)

   445

{

   446

   447

	void* perf = NpfBeginInterval();

   448

	NPFFoundTargetData ret = NPFRouteToStationOrTile(tile, trackdir, ignore_start_tile, target, type, 0, owner, railtypes);

   449

	int t = NpfEndInterval(perf);

   450

	DEBUG(yapf, 4, "[NPFW] %d us - %d rounds - %d open - %d closed -- ", t, 0, _aystar_stats_open_size, _aystar_stats_closed_size);

   451

	return ret;

   452

}

   453

   454

/** returns the track to choose on the next tile, or -1 when it's better to

   455

 * reverse. The tile given is the tile we are about to enter, enterdir is the

   456

 * direction in which we are entering the tile */

   457

static Track ChooseShipTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks)

   458

{

   459

	assert(IsValidDiagDirection(enterdir));

   460

   461

	switch (_patches.pathfinder_for_ships) {

   462

		case VPF_YAPF: { /* YAPF */

   463

			Trackdir trackdir = YapfChooseShipTrack(v, tile, enterdir, tracks);

   464

			if (trackdir != INVALID_TRACKDIR) return TrackdirToTrack(trackdir);

   465

		} break;

   466

   467

		case VPF_NPF: { /* NPF */

   468

			NPFFindStationOrTileData fstd;

   469

			Trackdir trackdir = GetVehicleTrackdir(v);

   470

			assert(trackdir != INVALID_TRACKDIR); // Check that we are not in a depot

   471

   472

			NPFFillWithOrderData(&fstd, v);

   473

   474

			NPFFoundTargetData ftd = PerfNPFRouteToStationOrTile(tile - TileOffsByDiagDir(enterdir), trackdir, true, &fstd, TRANSPORT_WATER, v->owner, INVALID_RAILTYPES);

   475

   476

			/* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains

   477

			 * the direction we need to take to get there, if ftd.best_bird_dist is not 0,

   478

			 * we did not find our target, but ftd.best_trackdir contains the direction leading

   479

			 * to the tile closest to our target. */

   480

			if (ftd.best_trackdir != 0xff) return TrackdirToTrack(ftd.best_trackdir); /* TODO: Wrapper function? */

   481

		} break;

   482

   483

		default:

   484

		case VPF_OPF: { /* OPF */

   485

			TileIndex tile2 = TILE_ADD(tile, -TileOffsByDiagDir(enterdir));

   486

			Track track;

   487

   488

			/* Let's find out how far it would be if we would reverse first */

   489

			TrackBits b = GetTileShipTrackStatus(tile2) & _ship_sometracks[ReverseDiagDir(enterdir)] & v->u.ship.state;

   490

   491

			uint distr = UINT_MAX; // distance if we reversed

   492

			if (b != 0) {

   493

				distr = FindShipTrack(v, tile2, ReverseDiagDir(enterdir), b, tile, &track);