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

    21

#include "vehicle_gui.h"

    22

#include "newgrf_engine.h"

    23

#include "water_map.h"

    24

#include "yapf/yapf.h"

    25

#include "debug.h"

    26

#include "newgrf_callbacks.h"

    27

#include "newgrf_text.h"

    28

#include "newgrf_sound.h"

    29

#include "spritecache.h"

    30

#include "misc/autoptr.hpp"

    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

    43

#include "table/strings.h"

    44

    45

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

    46

    47

static const TrackBits _ship_sometracks[4] = {

    48

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

    49

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

    50

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

    51

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

    52

};

    53

    54

static inline TrackBits GetTileShipTrackStatus(TileIndex tile)

    55

{

    56

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

    57

}

    58

    59

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

    60

{

    61

	int spritenum = ShipVehInfo(engine)->image_index;

    62

    63

	if (is_custom_sprite(spritenum)) {

    64

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    65

    66

		if (sprite != 0) {

    67

			DrawSprite(sprite, pal, x, y);

    68

			return;

    69

		}

    70

		spritenum = _orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    71

	}

    72

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

    73

}

    74

    75

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

    76

 * @param engine The engine to get the sprite from

    77

 * @param width The width of the sprite

    78

 * @param height The height of the sprite

    79

 */

    80

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

    81

{

    82

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    83

	SpriteID custom_sprite = 0;

    84

    85

	if (is_custom_sprite(spritenum)) {

    86

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    87

		spritenum = _orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    88

	}

    89

	if (custom_sprite == 0) {

    90

		spritenum = 6 + _ship_sprites[spritenum];

    91

	} else {

    92

		spritenum = custom_sprite;

    93

	}

    94

    95

	const Sprite *spr = GetSprite(spritenum);

    96

    97

	width  = spr->width;

    98

	height = spr->height;

    99

}

   100

   101

int Ship::GetImage(Direction direction) const

   102

{

   103

	int spritenum = this->spritenum;

   104

   105

	if (is_custom_sprite(spritenum)) {

   106

		int sprite = GetCustomVehicleSprite(this, direction);

   107

   108

		if (sprite != 0) return sprite;

   109

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

   110

	}

   111

	return _ship_sprites[spritenum] + direction;

   112

}

   113

   114

static const Depot* FindClosestShipDepot(const Vehicle* v)

   115

{

   116

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

   117

		Trackdir trackdir = GetVehicleTrackdir(v);

   118

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

   119

   120

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

   121

   122

		return NULL; /* Did not find target */

   123

	}

   124

   125

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

   126

   127

	const Depot* depot;

   128

	const Depot* best_depot = NULL;

   129

	uint best_dist = UINT_MAX;

   130

   131

	FOR_ALL_DEPOTS(depot) {

   132

		TileIndex tile = depot->xy;

   133

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

   134

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

   135

			if (dist < best_dist) {

   136

				best_dist = dist;

   137

				best_depot = depot;

   138

			}

   139

		}

   140

	}

   141

   142

	return best_depot;

   143

}

   144

   145

static void CheckIfShipNeedsService(Vehicle *v)

   146

{

   147

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

   148

	if (v->IsInDepot()) {

   149

		VehicleServiceInDepot(v);

   150

		return;

   151

	}

   152

   153

	const Depot *depot = FindClosestShipDepot(v);

   154

   155

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

   156

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

   157

			v->current_order.MakeDummy();

   158

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

   159

		}

   160

		return;

   161

	}

   162

   163

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

   164

	v->dest_tile = depot->xy;

   165

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

   166

}

   167

   168

void Ship::OnNewDay()

   169

{

   170

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

   171

		DecreaseVehicleValue(this);

   172

   173

	CheckVehicleBreakdown(this);

   174

	AgeVehicle(this);

   175

	CheckIfShipNeedsService(this);

   176

   177

	CheckOrders(this);

   178

   179

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

   180

   181

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

   182

   183

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

   184

	this->running_ticks = 0;

   185

   186

	SubtractMoneyFromPlayerFract(this->owner, cost);

   187

   188

	InvalidateWindow(WC_VEHICLE_DETAILS, this->index);

   189

	/* we need this for the profit */

   190

	InvalidateWindowClasses(WC_SHIPS_LIST);

   191

}

   192

   193

static void HandleBrokenShip(Vehicle *v)

   194

{

   195

	if (v->breakdown_ctr != 1) {

   196

		v->breakdown_ctr = 1;

   197

		v->cur_speed = 0;

   198

   199

		if (v->breakdowns_since_last_service != 255)

   200

			v->breakdowns_since_last_service++;

   201

   202

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   203

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   204

   205

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   206

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   207

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   208

		}

   209

   210

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

   211

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

   212

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

   213

		}

   214

	}

   215

   216

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

   217

		if (!--v->breakdown_delay) {

   218

			v->breakdown_ctr = 0;

   219

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   220

		}

   221

	}

   222

}

   223

   224

void Ship::MarkDirty()

   225

{

   226

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

   227

	MarkSingleVehicleDirty(this);

   228

}

   229

   230

static void PlayShipSound(const Vehicle *v)

   231

{

   232

	if (!PlayVehicleSound(v, VSE_START)) {

   233

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

   234

	}

   235

}

   236

   237

void Ship::PlayLeaveStationSound() const

   238

{

   239

	PlayShipSound(this);

   240

}

   241

   242

TileIndex Ship::GetOrderStationLocation(StationID station)

   243

{

   244

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

   245

   246

	Station *st = GetStation(station);

   247

	if (st->dock_tile != 0) {

   248

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

   249

	} else {

   250

		this->cur_order_index++;

   251

		return 0;

   252

	}

   253

}

   254

   255

void Ship::UpdateDeltaXY(Direction direction)

   256

{

   257

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

   258

	static const uint32 _delta_xy_table[8] = {

   259

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

   260

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

   261

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

   262

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

   263

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

   264

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

   265

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

   266

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

   267

	};

   268

#undef MKIT

   269

   270

	uint32 x = _delta_xy_table[direction];

   271

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

   272

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

   273

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

   274

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

   275

	this->z_extent      = 6;

   276

}

   277

   278

void RecalcShipStuff(Vehicle *v)

   279

{

   280

	v->UpdateDeltaXY(v->direction);

   281

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

   282

	v->MarkDirty();

   283

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   284

}

   285

   286

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   287

	{-1,  0},

   288

	{ 0, -1}

   289

};

   290

   291

static void CheckShipLeaveDepot(Vehicle *v)

   292

{

   293

	TileIndex tile;

   294

	Axis axis;

   295

	uint m;

   296

   297

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

   298

   299

	tile = v->tile;

   300

	axis = GetShipDepotAxis(tile);

   301

   302

	/* Check first side */

   303

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

   304

		m = (axis == AXIS_X) ? 0x101 : 0x207;

   305

	/* Check second side */

   306

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

   307

		m = (axis == AXIS_X) ? 0x105 : 0x203;

   308

	} else {

   309

		return;

   310

	}

   311

	v->direction    = (Direction)GB(m, 0, 8);

   312

	v->u.ship.state = (TrackBits)GB(m, 8, 8);

   313

	v->vehstatus &= ~VS_HIDDEN;

   314

   315

	v->cur_speed = 0;

   316

	RecalcShipStuff(v);

   317

   318

	PlayShipSound(v);

   319

	VehicleServiceInDepot(v);

   320

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   321

	InvalidateWindowClasses(WC_SHIPS_LIST);

   322

}

   323

   324

static bool ShipAccelerate(Vehicle *v)

   325

{

   326

	uint spd;

   327

	byte t;

   328

   329

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

   330

   331

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

   332

	if (spd != v->cur_speed) {

   333

		v->cur_speed = spd;

   334

		if (_patches.vehicle_speed)

   335

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

   336

	}

   337

   338

	/* Decrease somewhat when turning */

   339

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

   340

   341

	if (spd == 0) return false;

   342

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

   343

   344

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

   345

   346

	return (t < v->progress);

   347

}

   348

   349

static CommandCost EstimateShipCost(EngineID engine_type)

   350

{

   351

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

   352

}

   353

   354

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

   355

{

   356

	/* Check if station was ever visited before */

   357

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

   358

		st->had_vehicle_of_type |= HVOT_SHIP;

   359

   360

		SetDParam(0, st->index);

   361

		AddNewsItem(

   362

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   363

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

   364

			v->index,

   365

			0);

   366

	}

   367

}

   368

   369

struct PathFindShip {

   370

	TileIndex skiptile;

   371

	TileIndex dest_coords;

   372

	uint best_bird_dist;

   373

	uint best_length;

   374

};

   375

   376

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

   377

{

   378

	/* Found dest? */

   379

	if (tile == pfs->dest_coords) {

   380

		pfs->best_bird_dist = 0;

   381

   382

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

   383

		return true;

   384

	}

   385

   386

	/* Skip this tile in the calculation */

   387

	if (tile != pfs->skiptile) {

   388

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

   389

	}

   390

   391

	return false;

   392

}

   393

   394

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

   395

	{ 0, 9, 2, 9 },

   396

	{ 9, 1, 9, 3 },

   397

	{ 9, 0, 3, 9 },

   398

	{ 1, 9, 9, 2 },

   399

	{ 3, 2, 9, 9 },

   400

	{ 9, 9, 1, 0 },

   401

};

   402

   403

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

   404

   405

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

   406

{

   407

	PathFindShip pfs;

   408

	Track i, best_track;

   409

	uint best_bird_dist = 0;

   410

	uint best_length    = 0;

   411

	uint r;

   412

	byte ship_dir = v->direction & 3;

   413

   414

	pfs.dest_coords = v->dest_tile;

   415

	pfs.skiptile = skiptile;

   416

   417

	best_track = INVALID_TRACK;

   418

   419

	do {

   420

		i = RemoveFirstTrack(&bits);

   421

   422

		pfs.best_bird_dist = (uint)-1;

   423

		pfs.best_length = (uint)-1;

   424

   425

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

   426

   427

		if (best_track != INVALID_TRACK) {

   428

			if (pfs.best_bird_dist != 0) {

   429

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

   430

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   431

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   432

			} else {

   433

				if (pfs.best_length > best_length) goto bad;

   434

				if (pfs.best_length < best_length) goto good;

   435

			}

   436

   437

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

   438

			 * pick one randomly. */

   439

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

   440

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

   441

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

   442

			if (r <= 127) goto bad;

   443

		}

   444

good:;

   445

		best_track = i;

   446

		best_bird_dist = pfs.best_bird_dist;

   447

		best_length = pfs.best_length;

   448

bad:;

   449

   450

	} while (bits != 0);

   451

   452

	*track = best_track;

   453

	return best_bird_dist;

   454

}

   455

   456

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

   457

{

   458

   459

	void* perf = NpfBeginInterval();

   460

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

   461

	int t = NpfEndInterval(perf);

   462

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

   463

	return ret;

   464

}

   465

   466

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

   467

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

   468

 * direction in which we are entering the tile */

   469

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

   470

{

   471

	assert(IsValidDiagDirection(enterdir));

   472

   473

	switch (_patches.pathfinder_for_ships) {

   474

		case VPF_YAPF: { /* YAPF */

   475

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

   476

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

   477

		} break;

   478

   479

		case VPF_NPF: { /* NPF */

   480

			NPFFindStationOrTileData fstd;

   481

			Trackdir trackdir = GetVehicleTrackdir(v);

   482

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

   483

   484

			NPFFillWithOrderData(&fstd, v);

   485

   486

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

   487

   488

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

   489

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

   490

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

   491

			 * to the tile closest to our target. */

   492

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

   493

		} break;

   494