1

/* $Id$ */

     2

     3

/** @file ship_cmd.cpp Handling of ships. */

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

    18

#include "company_func.h"

    19

#include "company_base.h"

    20

#include "npf.h"

    21

#include "depot_base.h"

    22

#include "depot_func.h"

    23

#include "vehicle_gui.h"

    24

#include "newgrf_engine.h"

    25

#include "water_map.h"

    26

#include "yapf/yapf.h"

    27

#include "debug.h"

    28

#include "newgrf_callbacks.h"

    29

#include "newgrf_text.h"

    30

#include "newgrf_sound.h"

    31

#include "spritecache.h"

    32

#include "strings_func.h"

    33

#include "functions.h"

    34

#include "window_func.h"

    35

#include "date_func.h"

    36

#include "vehicle_func.h"

    37

#include "sound_func.h"

    38

#include "variables.h"

    39

#include "autoreplace_gui.h"

    40

#include "gfx_func.h"

    41

#include "settings_type.h"

    42

#include "order_func.h"

    43

#include "effectvehicle_func.h"

    44

    45

#include "table/strings.h"

    46

    47

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

    48

    49

static const TrackBits _ship_sometracks[4] = {

    50

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

    51

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

    52

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

    53

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

    54

};

    55

    56

static inline TrackBits GetTileShipTrackStatus(TileIndex tile)

    57

{

    58

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

    59

}

    60

    61

static SpriteID GetShipIcon(EngineID engine)

    62

{

    63

	uint8 spritenum = ShipVehInfo(engine)->image_index;

    64

    65

	if (is_custom_sprite(spritenum)) {

    66

		SpriteID sprite = GetCustomVehicleIcon(engine, DIR_W);

    67

		if (sprite != 0) return sprite;

    68

    69

		spritenum = GetEngine(engine)->image_index;

    70

	}

    71

    72

	return 6 + _ship_sprites[spritenum];

    73

}

    74

    75

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

    76

{

    77

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

    78

}

    79

    80

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

    81

 * @param engine The engine to get the sprite from

    82

 * @param width The width of the sprite

    83

 * @param height The height of the sprite

    84

 */

    85

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

    86

{

    87

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

    88

    89

	width  = spr->width;

    90

	height = spr->height;

    91

}

    92

    93

SpriteID Ship::GetImage(Direction direction) const

    94

{

    95

	uint8 spritenum = this->spritenum;

    96

    97

	if (is_custom_sprite(spritenum)) {

    98

		SpriteID sprite = GetCustomVehicleSprite(this, direction);

    99

		if (sprite != 0) return sprite;

   100

   101

		spritenum = GetEngine(this->engine_type)->image_index;

   102

	}

   103

   104

	return _ship_sprites[spritenum] + direction;

   105

}

   106

   107

static const Depot* FindClosestShipDepot(const Vehicle* v)

   108

{

   109

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

   110

		Trackdir trackdir = GetVehicleTrackdir(v);

   111

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

   112

   113

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

   114

   115

		return NULL; /* Did not find target */

   116

	}

   117

   118

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

   119

   120

	const Depot* depot;

   121

	const Depot* best_depot = NULL;

   122

	uint best_dist = UINT_MAX;

   123

   124

	FOR_ALL_DEPOTS(depot) {

   125

		TileIndex tile = depot->xy;

   126

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

   127

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

   128

			if (dist < best_dist) {

   129

				best_dist = dist;

   130

				best_depot = depot;

   131

			}

   132

		}

   133

	}

   134

   135

	return best_depot;

   136

}

   137

   138

static void CheckIfShipNeedsService(Vehicle *v)

   139

{

   140

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

   141

	if (v->IsInDepot()) {

   142

		VehicleServiceInDepot(v);

   143

		return;

   144

	}

   145

   146

	const Depot *depot = FindClosestShipDepot(v);

   147

   148

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

   149

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

   150

			v->current_order.MakeDummy();

   151

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

   152

		}

   153

		return;

   154

	}

   155

   156

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

   157

	v->dest_tile = depot->xy;

   158

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

   159

}

   160

   161

void Ship::OnNewDay()

   162

{

   163

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

   164

		DecreaseVehicleValue(this);

   165

   166

	CheckVehicleBreakdown(this);

   167

	AgeVehicle(this);

   168

	CheckIfShipNeedsService(this);

   169

   170

	CheckOrders(this);

   171

   172

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

   173

   174

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

   175

   176

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

   177

	this->running_ticks = 0;

   178

   179

	SubtractMoneyFromCompanyFract(this->owner, cost);

   180

   181

	InvalidateWindow(WC_VEHICLE_DETAILS, this->index);

   182

	/* we need this for the profit */

   183

	InvalidateWindowClasses(WC_SHIPS_LIST);

   184

}

   185

   186

static void HandleBrokenShip(Vehicle *v)

   187

{

   188

	if (v->breakdown_ctr != 1) {

   189

		v->breakdown_ctr = 1;

   190

		v->cur_speed = 0;

   191

   192

		if (v->breakdowns_since_last_service != 255)

   193

			v->breakdowns_since_last_service++;

   194

   195

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   196

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   197

   198

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   199

			SndPlayVehicleFx((_settings_game.game_creation.landscape != LT_TOYLAND) ?

   200

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   201

		}

   202

   203

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

   204

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

   205

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

   206

		}

   207

	}

   208

   209

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

   210

		if (!--v->breakdown_delay) {

   211

			v->breakdown_ctr = 0;

   212

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   213

		}

   214

	}

   215

}

   216

   217

void Ship::MarkDirty()

   218

{

   219

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

   220

	MarkSingleVehicleDirty(this);

   221

}

   222

   223

static void PlayShipSound(const Vehicle *v)

   224

{

   225

	if (!PlayVehicleSound(v, VSE_START)) {

   226

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

   227

	}

   228

}

   229

   230

void Ship::PlayLeaveStationSound() const

   231

{

   232

	PlayShipSound(this);

   233

}

   234

   235

TileIndex Ship::GetOrderStationLocation(StationID station)

   236

{

   237

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

   238

   239

	const Station *st = GetStation(station);

   240

	if (st->dock_tile != 0) {

   241

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

   242

	} else {

   243

		this->cur_order_index++;

   244

		return 0;

   245

	}

   246

}

   247

   248

void Ship::UpdateDeltaXY(Direction direction)

   249

{

   250

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

   251

	static const uint32 _delta_xy_table[8] = {

   252

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

   253

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

   254

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

   255

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

   256

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

   257

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

   258

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

   259

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

   260

	};

   261

#undef MKIT

   262

   263

	uint32 x = _delta_xy_table[direction];

   264

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

   265

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

   266

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

   267

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

   268

	this->z_extent      = 6;

   269

}

   270

   271

void RecalcShipStuff(Vehicle *v)

   272

{

   273

	v->UpdateDeltaXY(v->direction);

   274

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

   275

	v->MarkDirty();

   276

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   277

}

   278

   279

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   280

	{-1,  0},

   281

	{ 0, -1}

   282

};

   283

   284

static void CheckShipLeaveDepot(Vehicle *v)

   285

{

   286

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

   287

   288

	TileIndex tile = v->tile;

   289

	Axis axis = GetShipDepotAxis(tile);

   290

   291

	/* Check first (north) side */

   292

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

   293

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

   294

	/* Check second (south) side */

   295

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

   296

		v->direction = AxisToDirection(axis);

   297

	} else {

   298

		return;

   299

	}

   300

   301

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

   302

	v->vehstatus &= ~VS_HIDDEN;

   303

   304

	v->cur_speed = 0;

   305

	RecalcShipStuff(v);

   306

   307

	PlayShipSound(v);

   308

	VehicleServiceInDepot(v);

   309

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   310

	InvalidateWindowClasses(WC_SHIPS_LIST);

   311

}

   312

   313

static bool ShipAccelerate(Vehicle *v)

   314

{

   315

	uint spd;

   316

	byte t;

   317

   318

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

   319

   320

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

   321

	if (spd != v->cur_speed) {

   322

		v->cur_speed = spd;

   323

		if (_settings_client.gui.vehicle_speed)

   324

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

   325

	}

   326

   327

	/* Decrease somewhat when turning */

   328

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

   329

   330

	if (spd == 0) return false;

   331

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

   332

   333

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

   334

   335

	return (t < v->progress);

   336

}

   337

   338

static CommandCost EstimateShipCost(EngineID engine_type)

   339

{

   340

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

   341

}

   342

   343

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

   344

{

   345

	/* Check if station was ever visited before */

   346

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

   347

		st->had_vehicle_of_type |= HVOT_SHIP;

   348

   349

		SetDParam(0, st->index);

   350

		AddNewsItem(

   351

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   352

			(v->owner == _local_company) ? NS_ARRIVAL_COMPANY : NS_ARRIVAL_OTHER,

   353

			v->index,

   354

			st->index

   355

		);

   356

	}

   357

}

   358

   359

struct PathFindShip {

   360

	TileIndex skiptile;

   361

	TileIndex dest_coords;

   362

	uint best_bird_dist;

   363

	uint best_length;

   364

};

   365

   366

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

   367

{

   368

	/* Found dest? */

   369

	if (tile == pfs->dest_coords) {

   370

		pfs->best_bird_dist = 0;

   371

   372

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

   373

		return true;

   374

	}

   375

   376

	/* Skip this tile in the calculation */

   377

	if (tile != pfs->skiptile) {

   378

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

   379

	}

   380

   381

	return false;

   382

}

   383

   384

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

   385

	{ 0, 9, 2, 9 },

   386

	{ 9, 1, 9, 3 },

   387

	{ 9, 0, 3, 9 },

   388

	{ 1, 9, 9, 2 },

   389

	{ 3, 2, 9, 9 },

   390

	{ 9, 9, 1, 0 },

   391

};

   392

   393

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

   394

   395

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

   396

{

   397

	PathFindShip pfs;

   398

	Track i, best_track;

   399

	uint best_bird_dist = 0;

   400

	uint best_length    = 0;

   401

	uint r;

   402

	byte ship_dir = v->direction & 3;

   403

   404

	pfs.dest_coords = v->dest_tile;

   405

	pfs.skiptile = skiptile;

   406

   407

	best_track = INVALID_TRACK;

   408

   409

	do {

   410

		i = RemoveFirstTrack(&bits);

   411

   412

		pfs.best_bird_dist = UINT_MAX;

   413

		pfs.best_length = UINT_MAX;

   414

   415

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

   416

   417

		if (best_track != INVALID_TRACK) {

   418

			if (pfs.best_bird_dist != 0) {

   419

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

   420

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   421

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   422

			} else {

   423

				if (pfs.best_length > best_length) goto bad;

   424

				if (pfs.best_length < best_length) goto good;

   425

			}

   426

   427

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

   428

			 * pick one randomly. */

   429

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

   430

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

   431

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

   432

			if (r <= 127) goto bad;

   433

		}

   434

good:;

   435

		best_track = i;

   436

		best_bird_dist = pfs.best_bird_dist;

   437

		best_length = pfs.best_length;

   438

bad:;

   439

   440

	} while (bits != 0);

   441

   442

	*track = best_track;

   443

	return best_bird_dist;

   444

}

   445

   446

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

   447

{

   448

   449

	void* perf = NpfBeginInterval();

   450

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

   451

	int t = NpfEndInterval(perf);

   452

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

   453

	return ret;

   454

}

   455

   456

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

   457

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

   458

 * direction in which we are entering the tile */

   459

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

   460

{

   461

	assert(IsValidDiagDirection(enterdir));

   462

   463

	switch (_settings_game.pf.pathfinder_for_ships) {

   464

		case VPF_YAPF: { /* YAPF */

   465

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

   466

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

   467

		} break;

   468

   469

		case VPF_NPF: { /* NPF */

   470

			NPFFindStationOrTileData fstd;

   471

			Trackdir trackdir = GetVehicleTrackdir(v);

   472

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

   473

   474

			NPFFillWithOrderData(&fstd, v);

   475

   476

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

   477

   478

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

   479

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

   480

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

   481

			 * to the tile closest to our target. */

   482

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

   483

		} break;

   484

   485

		default:

   486

		case VPF_OPF: { /* OPF */

   487

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

   488

			Track track;

   489

   490

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

   491

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

   492

   493

			uint distr = UINT_MAX; // distance if we reversed