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

    15

#include "news.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

    42

#include "table/strings.h"

    43

    44

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

    45

    46

static const TrackBits _ship_sometracks[4] = {

    47

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

    48

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

    49

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

    50

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

    51

};

    52

    53

static inline TrackBits GetTileShipTrackStatus(TileIndex tile)

    54

{

    55

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

    56

}

    57

    58

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

    59

{

    60

	int spritenum = ShipVehInfo(engine)->image_index;

    61

    62

	if (is_custom_sprite(spritenum)) {

    63

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    64

    65

		if (sprite != 0) {

    66

			DrawSprite(sprite, pal, x, y);

    67

			return;

    68

		}

    69

		spritenum = _orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    70

	}

    71

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

    72

}

    73

    74

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

    75

 * @param engine The engine to get the sprite from

    76

 * @param width The width of the sprite

    77

 * @param height The height of the sprite

    78

 */

    79

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

    80

{

    81

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    82

	SpriteID custom_sprite = 0;

    83

    84

	if (is_custom_sprite(spritenum)) {

    85

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    86

		spritenum = _orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    87

	}

    88

	if (custom_sprite == 0) {

    89

		spritenum = 6 + _ship_sprites[spritenum];

    90

	} else {

    91

		spritenum = custom_sprite;

    92

	}

    93

    94

	const Sprite *spr = GetSprite(spritenum);

    95

    96

	width  = spr->width;

    97

	height = spr->height;

    98

}

    99

   100

int Ship::GetImage(Direction direction) const

   101

{

   102

	int spritenum = this->spritenum;

   103

   104

	if (is_custom_sprite(spritenum)) {

   105

		int sprite = GetCustomVehicleSprite(this, direction);

   106

   107

		if (sprite != 0) return sprite;

   108

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

   109

	}

   110

	return _ship_sprites[spritenum] + direction;

   111

}

   112

   113

static const Depot* FindClosestShipDepot(const Vehicle* v)

   114

{

   115

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

   116

		Trackdir trackdir = GetVehicleTrackdir(v);

   117

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

   118

   119

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

   120

   121

		return NULL; /* Did not find target */

   122

	}

   123

   124

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

   125

   126

	const Depot* depot;

   127

	const Depot* best_depot = NULL;

   128

	uint best_dist = UINT_MAX;

   129

   130

	FOR_ALL_DEPOTS(depot) {

   131

		TileIndex tile = depot->xy;

   132

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

   133

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

   134

			if (dist < best_dist) {

   135

				best_dist = dist;

   136

				best_depot = depot;

   137

			}

   138

		}

   139

	}

   140

   141

	return best_depot;

   142

}

   143

   144

static void CheckIfShipNeedsService(Vehicle *v)

   145

{

   146

	if (_patches.servint_ships == 0 || !VehicleNeedsService(v)) return;

   147

	if (v->IsInDepot()) {

   148

		VehicleServiceInDepot(v);

   149

		return;

   150

	}

   151

   152

	const Depot *depot = FindClosestShipDepot(v);

   153

   154

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

   155

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

   156

			v->current_order.type = OT_DUMMY;

   157

			v->current_order.flags = 0;

   158

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

   159

		}

   160

		return;

   161

	}

   162

   163

	v->current_order.type = OT_GOTO_DEPOT;

   164

	v->current_order.flags = OFB_NON_STOP;

   165

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

   166

	v->dest_tile = depot->xy;

   167

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

   168

}

   169

   170

void Ship::OnNewDay()

   171

{

   172

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

   173

		DecreaseVehicleValue(this);

   174

   175

	CheckVehicleBreakdown(this);

   176

	AgeVehicle(this);

   177

	CheckIfShipNeedsService(this);

   178

   179

	CheckOrders(this);

   180

   181

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

   182

   183

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

   184

   185

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

   186

	this->running_ticks = 0;

   187

   188

	SubtractMoneyFromPlayerFract(this->owner, cost);

   189

   190

	InvalidateWindow(WC_VEHICLE_DETAILS, this->index);

   191

	/* we need this for the profit */

   192

	InvalidateWindowClasses(WC_SHIPS_LIST);

   193

}

   194

   195

static void HandleBrokenShip(Vehicle *v)

   196

{

   197

	if (v->breakdown_ctr != 1) {

   198

		v->breakdown_ctr = 1;

   199

		v->cur_speed = 0;

   200

   201

		if (v->breakdowns_since_last_service != 255)

   202

			v->breakdowns_since_last_service++;

   203

   204

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   205

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   206

   207

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   208

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   209

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   210

		}

   211

   212

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

   213

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

   214

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

   215

		}

   216

	}

   217

   218

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

   219

		if (!--v->breakdown_delay) {

   220

			v->breakdown_ctr = 0;

   221

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   222

		}

   223

	}

   224

}

   225

   226

void Ship::MarkDirty()

   227

{

   228

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

   229

	MarkSingleVehicleDirty(this);

   230

}

   231

   232

static void PlayShipSound(const Vehicle *v)

   233

{

   234

	if (!PlayVehicleSound(v, VSE_START)) {

   235

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

   236

	}

   237

}

   238

   239

void Ship::PlayLeaveStationSound() const

   240

{

   241

	PlayShipSound(this);

   242

}

   243

   244

static void ProcessShipOrder(Vehicle *v)

   245

{

   246

	const Order *order;

   247

   248

	switch (v->current_order.type) {

   249

		case OT_GOTO_DEPOT:

   250

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

   251

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

   252

					!VehicleNeedsService(v)) {

   253

				UpdateVehicleTimetable(v, true);

   254

				v->cur_order_index++;

   255

			}

   256

			break;

   257

   258

		case OT_LOADING:

   259

		case OT_LEAVESTATION:

   260

			return;

   261

   262

		default: break;

   263

	}

   264

   265

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

   266

   267

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

   268

   269

	if (order == NULL) {

   270

		v->current_order.Free();

   271

		v->dest_tile = 0;

   272

		return;

   273

	}

   274

   275

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

   276

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

   277

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

   278

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

   279

		return;

   280

   281

	v->current_order = *order;

   282

   283

	if (order->type == OT_GOTO_STATION) {

   284

		const Station *st;

   285

   286

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

   287

			v->last_station_visited = INVALID_STATION;

   288

   289

		st = GetStation(order->dest);

   290

		if (st->dock_tile != 0) {

   291

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

   292

		} else {

   293

			v->cur_order_index++;

   294

		}

   295

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

   296

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

   297

	} else {

   298

		v->dest_tile = 0;

   299

	}

   300

   301

	InvalidateVehicleOrder(v);

   302

   303

	InvalidateWindowClasses(WC_SHIPS_LIST);

   304

}

   305

   306

void Ship::UpdateDeltaXY(Direction direction)

   307

{

   308

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

   309

	static const uint32 _delta_xy_table[8] = {

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

	};

   319

#undef MKIT

   320

   321

	uint32 x = _delta_xy_table[direction];

   322

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

   323

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

   324

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

   325

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

   326

	this->z_height      = 6;

   327

}

   328

   329

void RecalcShipStuff(Vehicle *v)

   330

{

   331

	v->UpdateDeltaXY(v->direction);

   332

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

   333

	v->MarkDirty();

   334

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   335

}

   336

   337

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   338

	{-1,  0},

   339

	{ 0, -1}

   340

};

   341

   342

static void CheckShipLeaveDepot(Vehicle *v)

   343

{

   344

	TileIndex tile;

   345

	Axis axis;

   346

	uint m;

   347

   348

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

   349

   350

	tile = v->tile;

   351

	axis = GetShipDepotAxis(tile);

   352

   353

	/* Check first side */

   354

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

   355

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

   356

	/* Check second side */

   357

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

   358

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

   359

	} else {

   360

		return;

   361

	}

   362

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

   363

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

   364

	v->vehstatus &= ~VS_HIDDEN;

   365

   366

	v->cur_speed = 0;

   367

	RecalcShipStuff(v);

   368

   369

	PlayShipSound(v);

   370

	VehicleServiceInDepot(v);

   371

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   372

	InvalidateWindowClasses(WC_SHIPS_LIST);

   373

}

   374

   375

static bool ShipAccelerate(Vehicle *v)

   376

{

   377

	uint spd;

   378

	byte t;

   379

   380

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

   381

   382

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

   383

	if (spd != v->cur_speed) {

   384

		v->cur_speed = spd;

   385

		if (_patches.vehicle_speed)

   386

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

   387

	}

   388

   389

	/* Decrease somewhat when turning */

   390

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

   391

   392

	if (spd == 0) return false;

   393

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

   394

   395

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

   396

   397

	return (t < v->progress);

   398

}

   399

   400

static CommandCost EstimateShipCost(EngineID engine_type)

   401

{

   402

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

   403

}

   404

   405

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

   406

{

   407

	/* Check if station was ever visited before */

   408

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

   409

		uint32 flags;

   410

   411

		st->had_vehicle_of_type |= HVOT_SHIP;

   412

   413

		SetDParam(0, st->index);

   414

		flags = (v->owner == _local_player) ? NEWS_FLAGS(NM_THIN, NF_VIEWPORT|NF_VEHICLE, NT_ARRIVAL_PLAYER, 0) : NEWS_FLAGS(NM_THIN, NF_VIEWPORT|NF_VEHICLE, NT_ARRIVAL_OTHER, 0);

   415

		AddNewsItem(

   416

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   417

			flags,

   418

			v->index,

   419

			0);

   420

	}

   421

}

   422

   423

struct PathFindShip {

   424

	TileIndex skiptile;

   425

	TileIndex dest_coords;

   426

	uint best_bird_dist;

   427

	uint best_length;

   428

};

   429

   430

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

   431

{

   432

	/* Found dest? */

   433

	if (tile == pfs->dest_coords) {

   434

		pfs->best_bird_dist = 0;

   435

   436

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

   437

		return true;

   438

	}

   439

   440

	/* Skip this tile in the calculation */

   441

	if (tile != pfs->skiptile) {

   442

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

   443

	}

   444

   445

	return false;

   446

}

   447

   448

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

   449

	{ 0, 9, 2, 9 },

   450

	{ 9, 1, 9, 3 },

   451

	{ 9, 0, 3, 9 },

   452

	{ 1, 9, 9, 2 },

   453

	{ 3, 2, 9, 9 },

   454

	{ 9, 9, 1, 0 },

   455

};

   456

   457

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

   458

   459

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

   460

{

   461

	PathFindShip pfs;

   462

	Track i, best_track;

   463

	uint best_bird_dist = 0;

   464

	uint best_length    = 0;

   465

	uint r;

   466

	byte ship_dir = v->direction & 3;

   467

   468

	pfs.dest_coords = v->dest_tile;

   469

	pfs.skiptile = skiptile;

   470

   471

	best_track = INVALID_TRACK;

   472

   473

	do {

   474

		i = RemoveFirstTrack(&bits);

   475

   476

		pfs.best_bird_dist = (uint)-1;

   477

		pfs.best_length = (uint)-1;

   478

   479

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

   480

   481

		if (best_track != INVALID_TRACK) {

   482

			if (pfs.best_bird_dist != 0) {

   483

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

   484

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   485

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   486

			} else {

   487

				if (pfs.best_length > best_length) goto bad;

   488

				if (pfs.best_length < best_length) goto good;

   489

			}

   490

   491

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

   492

			 * pick one randomly. */

   493

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