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

    10

#include "landscape.h"

    11

#include "timetable.h"

    12

#include "command_func.h"

    13

#include "pathfind.h"

    14

#include "station_map.h"

    15

#include "station.h"

    16

#include "news.h"

    17

#include "engine.h"

    18

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

    39

    40

    41

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

    42

    43

static const TrackBits _ship_sometracks[4] = {

    44

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

    45

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

    46

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

    47

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

    48

};

    49

    50

static TrackBits GetTileShipTrackStatus(TileIndex tile)

    51

{

    52

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

    53

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

    54

}

    55

    56

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

    57

{

    58

	int spritenum = ShipVehInfo(engine)->image_index;

    59

    60

	if (is_custom_sprite(spritenum)) {

    61

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    62

    63

		if (sprite != 0) {

    64

			DrawSprite(sprite, pal, x, y);

    65

			return;

    66

		}

    67

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    68

	}

    69

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

    70

}

    71

    72

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

    73

 * @param engine The engine to get the sprite from

    74

 * @param width The width of the sprite

    75

 * @param height The height of the sprite

    76

 */

    77

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

    78

{

    79

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    80

	SpriteID custom_sprite = 0;

    81

    82

	if (is_custom_sprite(spritenum)) {

    83

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    84

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    85

	}

    86

	if (custom_sprite == 0) {

    87

		spritenum = 6 + _ship_sprites[spritenum];

    88

	} else {

    89

		spritenum = custom_sprite;

    90

	}

    91

    92

	const Sprite *spr = GetSprite(spritenum);

    93

    94

	width  = spr->width;

    95

	height = spr->height;

    96

}

    97

    98

int Ship::GetImage(Direction direction) const

    99

{

   100

	int spritenum = this->spritenum;

   101

   102

	if (is_custom_sprite(spritenum)) {

   103

		int sprite = GetCustomVehicleSprite(this, direction);

   104

   105

		if (sprite != 0) return sprite;

   106

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

   107

	}

   108

	return _ship_sprites[spritenum] + direction;

   109

}

   110

   111

static const Depot* FindClosestShipDepot(const Vehicle* v)

   112

{

   113

	const Depot* depot;

   114

	const Depot* best_depot = NULL;

   115

	uint dist;

   116

	uint best_dist = (uint)-1;

   117

	TileIndex tile;

   118

	TileIndex tile2 = v->tile;

   119

   120

	if (_patches.new_pathfinding_all) {

   121

		NPFFoundTargetData ftd;

   122

		Trackdir trackdir = GetVehicleTrackdir(v);

   123

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

   124

		if (ftd.best_bird_dist == 0) {

   125

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

   126

		} else {

   127

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

   128

		}

   129

	} else {

   130

		FOR_ALL_DEPOTS(depot) {

   131

			tile = depot->xy;

   132

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

   133

				dist = DistanceManhattan(tile, tile2);

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

   159

		}

   160

		return;

   161

	}

   162

   163

	v->current_order.type = OT_GOTO_DEPOT;

   164

	v->current_order.flags = OF_NON_STOP;

   165

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

   166

	v->dest_tile = depot->xy;

   167

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

   168

}

   169

   170

void OnNewDay_Ship(Vehicle *v)

   171

{

   172

	CommandCost cost;

   173

   174

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

   175

		DecreaseVehicleValue(v);

   176

   177

	CheckVehicleBreakdown(v);

   178

	AgeVehicle(v);

   179

	CheckIfShipNeedsService(v);

   180

   181

	CheckOrders(v);

   182

   183

	if (v->vehstatus & VS_STOPPED) return;

   184

   185

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

   186

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

   187

   188

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   189

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

   190

   191

	InvalidateWindow(WC_VEHICLE_DETAILS, v->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

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

   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 & OF_PART_OF_ORDERS)) return;

   252

			if (v->current_order.flags & OF_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, STATUS_BAR);

   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(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

		uint32 flags;

   411

   412

		st->had_vehicle_of_type |= HVOT_SHIP;

   413

   414

		SetDParam(0, st->index);

   415

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

   416

		AddNewsItem(

   417

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   418

			flags,

   419

			v->index,

   420

			0);

   421

	}

   422

}

   423

   424

struct PathFindShip {

   425

	TileIndex skiptile;

   426

	TileIndex dest_coords;

   427

	uint best_bird_dist;

   428

	uint best_length;

   429

};

   430

   431

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

   432

{

   433

	/* Found dest? */

   434

	if (tile == pfs->dest_coords) {

   435

		pfs->best_bird_dist = 0;

   436

   437

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

   438

		return true;

   439

	}

   440

   441

	/* Skip this tile in the calculation */

   442

	if (tile != pfs->skiptile) {

   443

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

   444

	}

   445

   446

	return false;

   447

}

   448

   449

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

   450

	{ 0, 9, 2, 9 },

   451

	{ 9, 1, 9, 3 },

   452

	{ 9, 0, 3, 9 },

   453

	{ 1, 9, 9, 2 },

   454

	{ 3, 2, 9, 9 },

   455

	{ 9, 9, 1, 0 },

   456

};

   457

   458

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

   459

   460

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

   461

{

   462

	PathFindShip pfs;

   463

	Track i, best_track;

   464

	uint best_bird_dist = 0;

   465

	uint best_length    = 0;

   466

	uint r;

   467

	byte ship_dir = v->direction & 3;

   468

   469

	pfs.dest_coords = v->dest_tile;

   470

	pfs.skiptile = skiptile;

   471

   472

	best_track = INVALID_TRACK;

   473

   474

	do {

   475

		i = RemoveFirstTrack(&bits);

   476

   477

		pfs.best_bird_dist = (uint)-1;

   478

		pfs.best_length = (uint)-1;

   479

   480

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

   481

   482

		if (best_track != INVALID_TRACK) {

   483

			if (pfs.best_bird_dist != 0) {

   484

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

   485

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   486

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   487

			} else {

   488

				if (pfs.best_length > best_length) goto bad;

   489

				if (pfs.best_length < best_length) goto good;

   490

			}

   491

   492

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

   493

			 * pick one randomly. */

   494

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