1

/* $Id$ */

     2

     3

/** @file ship_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "ship.h"

     8

#include "table/strings.h"

     9

#include "functions.h"

    10

#include "landscape.h"

    11

#include "map.h"

    12

#include "vehicle.h"

    13

#include "timetable.h"

    15

#include "pathfind.h"

    16

#include "station_map.h"

    17

#include "station.h"

    18

#include "news.h"

    19

#include "engine.h"

    20

#include "player.h"

    21

#include "sound.h"

    22

#include "npf.h"

    23

#include "depot.h"

    24

#include "vehicle_gui.h"

    25

#include "newgrf_engine.h"

    26

#include "water_map.h"

    27

#include "yapf/yapf.h"

    28

#include "debug.h"

    29

#include "newgrf_callbacks.h"

    30

#include "newgrf_text.h"

    31

#include "newgrf_sound.h"

    32

#include "date.h"

    33

#include "spritecache.h"

    34

#include "misc/autoptr.hpp"

    35

#include "strings_func.h"

    36

    37

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

    38

    39

static const TrackBits _ship_sometracks[4] = {

    40

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

    41

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

    42

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

    43

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

    44

};

    45

    46

static TrackBits GetTileShipTrackStatus(TileIndex tile)

    47

{

    48

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER, 0);

    49

	return TrackdirBitsToTrackBits((TrackdirBits)(TRACKDIR_BIT_MASK & (r | r >> 8)));

    50

}

    51

    52

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

    53

{

    54

	int spritenum = ShipVehInfo(engine)->image_index;

    55

    56

	if (is_custom_sprite(spritenum)) {

    57

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    58

    59

		if (sprite != 0) {

    60

			DrawSprite(sprite, pal, x, y);

    61

			return;

    62

		}

    63

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    64

	}

    65

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

    66

}

    67

    68

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

    69

 * @param engine The engine to get the sprite from

    70

 * @param width The width of the sprite

    71

 * @param height The height of the sprite

    72

 */

    73

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

    74

{

    75

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    76

	SpriteID custom_sprite = 0;

    77

    78

	if (is_custom_sprite(spritenum)) {

    79

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    80

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    81

	}

    82

	if (custom_sprite == 0) {

    83

		spritenum = 6 + _ship_sprites[spritenum];

    84

	} else {

    85

		spritenum = custom_sprite;

    86

	}

    87

    88

	const Sprite *spr = GetSprite(spritenum);

    89

    90

	width  = spr->width;

    91

	height = spr->height;

    92

}

    93

    94

int Ship::GetImage(Direction direction) const

    95

{

    96

	int spritenum = this->spritenum;

    97

    98

	if (is_custom_sprite(spritenum)) {

    99

		int sprite = GetCustomVehicleSprite(this, direction);

   100

   101

		if (sprite != 0) return sprite;

   102

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

   103

	}

   104

	return _ship_sprites[spritenum] + direction;

   105

}

   106

   107

static const Depot* FindClosestShipDepot(const Vehicle* v)

   108

{

   109

	const Depot* depot;

   110

	const Depot* best_depot = NULL;

   111

	uint dist;

   112

	uint best_dist = (uint)-1;

   113

	TileIndex tile;

   114

	TileIndex tile2 = v->tile;

   115

   116

	if (_patches.new_pathfinding_all) {

   117

		NPFFoundTargetData ftd;

   118

		Trackdir trackdir = GetVehicleTrackdir(v);

   119

		ftd = NPFRouteToDepotTrialError(v->tile, trackdir, TRANSPORT_WATER, 0, v->owner, INVALID_RAILTYPE);

   120

		if (ftd.best_bird_dist == 0) {

   121

			best_depot = GetDepotByTile(ftd.node.tile); /* Found target */

   122

		} else {

   123

			best_depot = NULL; /* Did not find target */

   124

		}

   125

	} else {

   126

		FOR_ALL_DEPOTS(depot) {

   127

			tile = depot->xy;

   128

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

   129

				dist = DistanceManhattan(tile, tile2);

   130

				if (dist < best_dist) {

   131

					best_dist = dist;

   132

					best_depot = depot;

   133

				}

   134

			}

   135

		}

   136

	}

   137

	return best_depot;

   138

}

   139

   140

static void CheckIfShipNeedsService(Vehicle *v)

   141

{

   142

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

   143

	if (v->IsInDepot()) {

   144

		VehicleServiceInDepot(v);

   145

		return;

   146

	}

   147

   148

	const Depot *depot = FindClosestShipDepot(v);

   149

   150

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

   151

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

   152

			v->current_order.type = OT_DUMMY;

   153

			v->current_order.flags = 0;

   154

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

   155

		}

   156

		return;

   157

	}

   158

   159

	v->current_order.type = OT_GOTO_DEPOT;

   160

	v->current_order.flags = OF_NON_STOP;

   161

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

   162

	v->dest_tile = depot->xy;

   163

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

   164

}

   165

   166

void OnNewDay_Ship(Vehicle *v)

   167

{

   168

	CommandCost cost;

   169

   170

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

   171

		DecreaseVehicleValue(v);

   172

   173

	CheckVehicleBreakdown(v);

   174

	AgeVehicle(v);

   175

	CheckIfShipNeedsService(v);

   176

   177

	CheckOrders(v);

   178

   179

	if (v->vehstatus & VS_STOPPED) return;

   180

   181

	cost.AddCost(GetVehicleProperty(v, 0x0F, ShipVehInfo(v->engine_type)->running_cost) * _price.ship_running / 364);

   182

	v->profit_this_year -= cost.GetCost() >> 8;

   183

   184

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   185

	SubtractMoneyFromPlayerFract(v->owner, CommandCost(cost));

   186

   187

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   188

	/* we need this for the profit */

   189

	InvalidateWindowClasses(WC_SHIPS_LIST);

   190

}

   191

   192

static void HandleBrokenShip(Vehicle *v)

   193

{

   194

	if (v->breakdown_ctr != 1) {

   195

		v->breakdown_ctr = 1;

   196

		v->cur_speed = 0;

   197

   198

		if (v->breakdowns_since_last_service != 255)

   199

			v->breakdowns_since_last_service++;

   200

   201

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   202

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   203

   204

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   205

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   206

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   207

		}

   208

   209

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

   210

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

   211

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

   212

		}

   213

	}

   214

   215

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

   216

		if (!--v->breakdown_delay) {

   217

			v->breakdown_ctr = 0;

   218

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   219

		}

   220

	}

   221

}

   222

   223

void Ship::MarkDirty()

   224

{

   225

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

   226

	MarkAllViewportsDirty(this->left_coord, this->top_coord, this->right_coord + 1, this->bottom_coord + 1);

   227

}

   228

   229

static void PlayShipSound(const Vehicle *v)

   230

{

   231

	if (!PlayVehicleSound(v, VSE_START)) {

   232

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

   233

	}

   234

}

   235

   236

void Ship::PlayLeaveStationSound() const

   237

{

   238

	PlayShipSound(this);

   239

}

   240

   241

static void ProcessShipOrder(Vehicle *v)

   242

{

   243

	const Order *order;

   244

   245

	switch (v->current_order.type) {

   246

		case OT_GOTO_DEPOT:

   247

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

   248

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

   249

					!VehicleNeedsService(v)) {

   250

				UpdateVehicleTimetable(v, true);

   251

				v->cur_order_index++;

   252

			}

   253

			break;

   254

   255

		case OT_LOADING:

   256

		case OT_LEAVESTATION:

   257

			return;

   258

   259

		default: break;

   260

	}

   261

   262

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

   263

   264

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

   265

   266

	if (order == NULL) {

   267

		v->current_order.Free();

   268

		v->dest_tile = 0;

   269

		return;

   270

	}

   271

   272

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

   273

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

   274

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

   275

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

   276

		return;

   277

   278

	v->current_order = *order;

   279

   280

	if (order->type == OT_GOTO_STATION) {

   281

		const Station *st;

   282

   283

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

   284

			v->last_station_visited = INVALID_STATION;

   285

   286

		st = GetStation(order->dest);

   287

		if (st->dock_tile != 0) {

   288

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

   289

		} else {

   290

			v->cur_order_index++;

   291

		}

   292

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

   293

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

   294

	} else {

   295

		v->dest_tile = 0;

   296

	}

   297

   298

	InvalidateVehicleOrder(v);

   299

   300

	InvalidateWindowClasses(WC_SHIPS_LIST);

   301

}

   302

   303

void Ship::UpdateDeltaXY(Direction direction)

   304

{

   305

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

   306

	static const uint32 _delta_xy_table[8] = {

   307

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

   308

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

   309

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

   310

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

   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

	};

   316

#undef MKIT

   317

   318

	uint32 x = _delta_xy_table[direction];

   319

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

   320

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

   321

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

   322

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

   323

	this->z_height      = 6;

   324

}

   325

   326

void RecalcShipStuff(Vehicle *v)

   327

{

   328

	v->UpdateDeltaXY(v->direction);

   329

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

   330

	v->MarkDirty();

   331

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   332

}

   333

   334

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   335

	{-1,  0},

   336

	{ 0, -1}

   337

};

   338

   339

static void CheckShipLeaveDepot(Vehicle *v)

   340

{

   341

	TileIndex tile;

   342

	Axis axis;

   343

	uint m;

   344

   345

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

   346

   347

	tile = v->tile;

   348

	axis = GetShipDepotAxis(tile);

   349

   350

	/* Check first side */

   351

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

   352

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

   353

	/* Check second side */

   354

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

   355

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

   356

	} else {

   357

		return;

   358

	}

   359

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

   360

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

   361

	v->vehstatus &= ~VS_HIDDEN;

   362

   363

	v->cur_speed = 0;

   364

	RecalcShipStuff(v);

   365

   366

	PlayShipSound(v);

   367

	VehicleServiceInDepot(v);

   368

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   369

	InvalidateWindowClasses(WC_SHIPS_LIST);

   370

}

   371

   372

static bool ShipAccelerate(Vehicle *v)

   373

{

   374

	uint spd;

   375

	byte t;

   376

   377

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

   378

   379

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

   380

	if (spd != v->cur_speed) {

   381

		v->cur_speed = spd;

   382

		if (_patches.vehicle_speed)

   383

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

   384

	}

   385

   386

	/* Decrease somewhat when turning */

   387

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

   388

   389

	if (spd == 0) return false;

   390

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

   391

   392

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

   393

   394

	return (t < v->progress);

   395

}

   396

   397

static CommandCost EstimateShipCost(EngineID engine_type)

   398

{

   399

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

   400

}

   401

   402

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

   403

{

   404

	/* Check if station was ever visited before */

   405

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

   406

		uint32 flags;

   407

   408

		st->had_vehicle_of_type |= HVOT_SHIP;

   409

   410

		SetDParam(0, st->index);

   411

		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);

   412

		AddNewsItem(

   413

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   414

			flags,

   415

			v->index,

   416

			0);

   417

	}

   418

}

   419

   420

struct PathFindShip {

   421

	TileIndex skiptile;

   422

	TileIndex dest_coords;

   423

	uint best_bird_dist;

   424

	uint best_length;

   425

};

   426

   427

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

   428

{

   429

	/* Found dest? */

   430

	if (tile == pfs->dest_coords) {

   431

		pfs->best_bird_dist = 0;

   432

   433

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

   434

		return true;

   435

	}

   436

   437

	/* Skip this tile in the calculation */

   438

	if (tile != pfs->skiptile) {

   439

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

   440

	}

   441

   442

	return false;

   443

}

   444

   445

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

   446

	{ 0, 9, 2, 9 },

   447

	{ 9, 1, 9, 3 },

   448

	{ 9, 0, 3, 9 },

   449

	{ 1, 9, 9, 2 },

   450

	{ 3, 2, 9, 9 },

   451

	{ 9, 9, 1, 0 },

   452

};

   453

   454

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

   455

   456

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

   457

{

   458

	PathFindShip pfs;

   459

	Track i, best_track;

   460

	uint best_bird_dist = 0;

   461

	uint best_length    = 0;

   462

	uint r;

   463

	byte ship_dir = v->direction & 3;

   464

   465

	pfs.dest_coords = v->dest_tile;

   466

	pfs.skiptile = skiptile;

   467

   468

	best_track = INVALID_TRACK;

   469

   470

	do {

   471

		i = RemoveFirstTrack(&bits);

   472

   473

		pfs.best_bird_dist = (uint)-1;

   474

		pfs.best_length = (uint)-1;

   475

   476

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

   477

   478

		if (best_track != INVALID_TRACK) {

   479

			if (pfs.best_bird_dist != 0) {

   480

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

   481

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   482

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   483

			} else {

   484

				if (pfs.best_length > best_length) goto bad;

   485

				if (pfs.best_length < best_length) goto good;

   486

			}

   487

   488

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

   489

			 * pick one randomly. */

   490

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

   491

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

   492

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

   493

			if (r <= 127) goto bad;

   494

		}

   495

good:;