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"

    15

#include "news_func.h"

    16

#include "engine.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 || !VehicleNeedsService(v)) 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.type == OT_GOTO_DEPOT) {

   157

			v->current_order.type = OT_DUMMY;

   158

			v->current_order.flags = 0;

   159

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

   160

		}

   161

		return;

   162

	}

   163

   164

	v->current_order.type = OT_GOTO_DEPOT;

   165

	v->current_order.flags = OFB_NON_STOP;

   166

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

   167

	v->dest_tile = depot->xy;

   168

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

   169

}

   170

   171

void Ship::OnNewDay()

   172

{

   173

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

   174

		DecreaseVehicleValue(this);

   175

   176

	CheckVehicleBreakdown(this);

   177

	AgeVehicle(this);

   178

	CheckIfShipNeedsService(this);

   179

   180

	CheckOrders(this);

   181

   182

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

   183

   184

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

   185

   186

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

   187

	this->running_ticks = 0;

   188

   189

	SubtractMoneyFromPlayerFract(this->owner, cost);

   190

   191

	InvalidateWindow(WC_VEHICLE_DETAILS, this->index);

   192

	/* we need this for the profit */

   193

	InvalidateWindowClasses(WC_SHIPS_LIST);

   194

}

   195

   196

static void HandleBrokenShip(Vehicle *v)

   197

{

   198

	if (v->breakdown_ctr != 1) {

   199

		v->breakdown_ctr = 1;

   200

		v->cur_speed = 0;

   201

   202

		if (v->breakdowns_since_last_service != 255)

   203

			v->breakdowns_since_last_service++;

   204

   205

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   206

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   207

   208

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   209

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   210

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   211

		}

   212

   213

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

   214

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

   215

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

   216

		}

   217

	}

   218

   219

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

   220

		if (!--v->breakdown_delay) {

   221

			v->breakdown_ctr = 0;

   222

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   223

		}

   224

	}

   225

}

   226

   227

void Ship::MarkDirty()

   228

{

   229

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

   230

	MarkSingleVehicleDirty(this);

   231

}

   232

   233

static void PlayShipSound(const Vehicle *v)

   234

{

   235

	if (!PlayVehicleSound(v, VSE_START)) {

   236

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

   237

	}

   238

}

   239

   240

void Ship::PlayLeaveStationSound() const

   241

{

   242

	PlayShipSound(this);

   243

}

   244

   245

static void ProcessShipOrder(Vehicle *v)

   246

{

   247

	const Order *order;

   248

   249

	switch (v->current_order.type) {

   250

		case OT_GOTO_DEPOT:

   251

			if (!(v->current_order.flags & OFB_PART_OF_ORDERS)) return;

   252

			if (v->current_order.flags & OFB_SERVICE_IF_NEEDED &&

   253

					!VehicleNeedsService(v)) {

   254

				UpdateVehicleTimetable(v, true);

   255

				v->cur_order_index++;

   256

			}

   257

			break;

   258

   259

		case OT_LOADING:

   260

		case OT_LEAVESTATION:

   261

			return;

   262

   263

		default: break;

   264

	}

   265

   266

	if (v->cur_order_index >= v->num_orders) v->cur_order_index = 0;

   267

   268

	order = GetVehicleOrder(v, v->cur_order_index);

   269

   270

	if (order == NULL) {

   271

		v->current_order.Free();

   272

		v->dest_tile = 0;

   273

		return;

   274

	}

   275

   276

	if (order->type  == v->current_order.type &&

   277

			order->flags == v->current_order.flags &&

   278

			order->dest  == v->current_order.dest &&

   279

			(order->type != OT_GOTO_STATION || GetStation(order->dest)->dock_tile != 0))

   280

		return;

   281

   282

	v->current_order = *order;

   283

   284

	if (order->type == OT_GOTO_STATION) {

   285

		const Station *st;

   286

   287

		if (order->dest == v->last_station_visited)

   288

			v->last_station_visited = INVALID_STATION;

   289

   290

		st = GetStation(order->dest);

   291

		if (st->dock_tile != 0) {

   292

			v->dest_tile = TILE_ADD(st->dock_tile, ToTileIndexDiff(GetDockOffset(st->dock_tile)));

   293

		} else {

   294

			v->cur_order_index++;

   295

		}

   296

	} else if (order->type == OT_GOTO_DEPOT) {

   297

		v->dest_tile = GetDepot(order->dest)->xy;

   298

	} else {

   299

		v->dest_tile = 0;

   300

	}

   301

   302

	InvalidateVehicleOrder(v);

   303

   304

	InvalidateWindowClasses(WC_SHIPS_LIST);

   305

}

   306

   307

void Ship::UpdateDeltaXY(Direction direction)

   308

{

   309

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

   310

	static const uint32 _delta_xy_table[8] = {

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

	};

   320

#undef MKIT

   321

   322

	uint32 x = _delta_xy_table[direction];

   323

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

   324

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

   325

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

   326

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

   327

	this->z_height      = 6;

   328

}

   329

   330

void RecalcShipStuff(Vehicle *v)

   331

{

   332

	v->UpdateDeltaXY(v->direction);

   333

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

   334

	v->MarkDirty();

   335

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   336

}

   337

   338

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   339

	{-1,  0},

   340

	{ 0, -1}

   341

};

   342

   343

static void CheckShipLeaveDepot(Vehicle *v)

   344

{

   345

	TileIndex tile;

   346

	Axis axis;

   347

	uint m;

   348

   349

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

   350

   351

	tile = v->tile;

   352

	axis = GetShipDepotAxis(tile);

   353

   354

	/* Check first side */

   355

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

   356

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

   357

	/* Check second side */

   358

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

   359

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

   360

	} else {

   361

		return;

   362

	}

   363

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

   364

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

   365

	v->vehstatus &= ~VS_HIDDEN;

   366

   367

	v->cur_speed = 0;

   368

	RecalcShipStuff(v);

   369

   370

	PlayShipSound(v);

   371

	VehicleServiceInDepot(v);

   372

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   373

	InvalidateWindowClasses(WC_SHIPS_LIST);

   374

}

   375

   376

static bool ShipAccelerate(Vehicle *v)

   377

{

   378

	uint spd;

   379

	byte t;

   380

   381

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

   382

   383

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

   384

	if (spd != v->cur_speed) {

   385

		v->cur_speed = spd;

   386

		if (_patches.vehicle_speed)

   387

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

   388

	}

   389

   390

	/* Decrease somewhat when turning */

   391

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

   392

   393

	if (spd == 0) return false;

   394

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

   395

   396

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

   397

   398

	return (t < v->progress);

   399

}

   400

   401

static CommandCost EstimateShipCost(EngineID engine_type)

   402

{

   403

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

   404

}

   405

   406

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

   407

{

   408

	/* Check if station was ever visited before */

   409

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

   410

		st->had_vehicle_of_type |= HVOT_SHIP;

   411

   412

		SetDParam(0, st->index);

   413

		AddNewsItem(

   414

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   415

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

   416

			v->index,

   417

			0);

   418

	}

   419

}

   420

   421

struct PathFindShip {

   422

	TileIndex skiptile;

   423

	TileIndex dest_coords;

   424

	uint best_bird_dist;

   425

	uint best_length;

   426

};

   427

   428

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

   429

{

   430

	/* Found dest? */

   431

	if (tile == pfs->dest_coords) {

   432

		pfs->best_bird_dist = 0;

   433

   434

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

   435

		return true;

   436

	}

   437

   438

	/* Skip this tile in the calculation */

   439

	if (tile != pfs->skiptile) {

   440

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

   441

	}

   442

   443

	return false;

   444

}

   445

   446

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

   447

	{ 0, 9, 2, 9 },

   448

	{ 9, 1, 9, 3 },

   449

	{ 9, 0, 3, 9 },

   450

	{ 1, 9, 9, 2 },

   451

	{ 3, 2, 9, 9 },

   452

	{ 9, 9, 1, 0 },

   453

};

   454

   455

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

   456

   457

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

   458

{

   459

	PathFindShip pfs;

   460

	Track i, best_track;

   461

	uint best_bird_dist = 0;

   462

	uint best_length    = 0;

   463

	uint r;

   464

	byte ship_dir = v->direction & 3;

   465

   466

	pfs.dest_coords = v->dest_tile;

   467

	pfs.skiptile = skiptile;

   468

   469

	best_track = INVALID_TRACK;

   470

   471

	do {

   472

		i = RemoveFirstTrack(&bits);

   473

   474

		pfs.best_bird_dist = (uint)-1;

   475

		pfs.best_length = (uint)-1;

   476

   477

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

   478

   479

		if (best_track != INVALID_TRACK) {

   480

			if (pfs.best_bird_dist != 0) {

   481

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

   482

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   483

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   484

			} else {

   485

				if (pfs.best_length > best_length) goto bad;

   486

				if (pfs.best_length < best_length) goto good;

   487

			}

   488

   489

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

   490

			 * pick one randomly. */

   491

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

   492

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

   493

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