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

    31

#include "functions.h"

    32

#include "window_func.h"

    33

#include "date_func.h"

    34

#include "vehicle_func.h"

    35

#include "sound_func.h"

    36

#include "variables.h"

    37

#include "autoreplace_gui.h"

    38

#include "gfx_func.h"

    39

#include "settings_type.h"

    40

    41

#include "table/strings.h"

    42

    43

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

    44

    45

static const TrackBits _ship_sometracks[4] = {

    46

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

    47

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

    48

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

    49

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

    50

};

    51

    52

static inline TrackBits GetTileShipTrackStatus(TileIndex tile)

    53

{

    54

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

    55

}

    56

    57

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

    58

{

    59

	int spritenum = ShipVehInfo(engine)->image_index;

    60

    61

	if (is_custom_sprite(spritenum)) {

    62

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    63

    64

		if (sprite != 0) {

    65

			DrawSprite(sprite, pal, x, y);

    66

			return;

    67

		}

    68

		spritenum = _orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    69

	}

    70

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

    71

}

    72

    73

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

    74

 * @param engine The engine to get the sprite from

    75

 * @param width The width of the sprite

    76

 * @param height The height of the sprite

    77

 */

    78

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

    79

{

    80

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    81

	SpriteID custom_sprite = 0;

    82

    83

	if (is_custom_sprite(spritenum)) {

    84

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    85

		spritenum = _orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    86

	}

    87

	if (custom_sprite == 0) {

    88

		spritenum = 6 + _ship_sprites[spritenum];

    89

	} else {

    90

		spritenum = custom_sprite;

    91

	}

    92

    93

	const Sprite *spr = GetSprite(spritenum);

    94

    95

	width  = spr->width;

    96

	height = spr->height;

    97

}

    98

    99

int Ship::GetImage(Direction direction) const

   100

{

   101

	int spritenum = this->spritenum;

   102

   103

	if (is_custom_sprite(spritenum)) {

   104

		int sprite = GetCustomVehicleSprite(this, direction);

   105

   106

		if (sprite != 0) return sprite;

   107

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

   108

	}

   109

	return _ship_sprites[spritenum] + direction;

   110

}

   111

   112

static const Depot* FindClosestShipDepot(const Vehicle* v)

   113

{

   114

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

   115

		Trackdir trackdir = GetVehicleTrackdir(v);

   116

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

   117

   118

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

   119

   120

		return NULL; /* Did not find target */

   121

	}

   122

   123

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

   124

   125

	const Depot* depot;

   126

	const Depot* best_depot = NULL;

   127

	uint best_dist = UINT_MAX;

   128

   129

	FOR_ALL_DEPOTS(depot) {

   130

		TileIndex tile = depot->xy;

   131

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

   132

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

   133

			if (dist < best_dist) {

   134

				best_dist = dist;

   135

				best_depot = depot;

   136

			}

   137

		}

   138

	}

   139

   140

	return best_depot;

   141

}

   142

   143

static void CheckIfShipNeedsService(Vehicle *v)

   144

{

   145

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

   146

	if (v->IsInDepot()) {

   147

		VehicleServiceInDepot(v);

   148

		return;

   149

	}

   150

   151

	const Depot *depot = FindClosestShipDepot(v);

   152

   153

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

   154

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

   155

			v->current_order.type = OT_DUMMY;

   156

			v->current_order.flags = 0;

   157

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

   158

		}

   159

		return;

   160

	}

   161

   162

	v->current_order.type = OT_GOTO_DEPOT;

   163

	v->current_order.flags = OFB_NON_STOP;

   164

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

   165

	v->dest_tile = depot->xy;

   166

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

   167

}

   168

   169

void Ship::OnNewDay()

   170

{

   171

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

   172

		DecreaseVehicleValue(this);

   173

   174

	CheckVehicleBreakdown(this);

   175

	AgeVehicle(this);

   176

	CheckIfShipNeedsService(this);

   177

   178

	CheckOrders(this);

   179

   180

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

   181

   182

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

   183

   184

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

   185

	this->running_ticks = 0;

   186

   187

	SubtractMoneyFromPlayerFract(this->owner, cost);

   188

   189

	InvalidateWindow(WC_VEHICLE_DETAILS, this->index);

   190

	/* we need this for the profit */

   191

	InvalidateWindowClasses(WC_SHIPS_LIST);

   192

}

   193

   194

static void HandleBrokenShip(Vehicle *v)

   195

{

   196

	if (v->breakdown_ctr != 1) {

   197

		v->breakdown_ctr = 1;

   198

		v->cur_speed = 0;

   199

   200

		if (v->breakdowns_since_last_service != 255)

   201

			v->breakdowns_since_last_service++;

   202

   203

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   204

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   205

   206

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   207

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   208

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   209

		}

   210

   211

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

   212

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

   213

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

   214

		}

   215

	}

   216

   217

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

   218

		if (!--v->breakdown_delay) {

   219

			v->breakdown_ctr = 0;

   220

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   221

		}

   222

	}

   223

}

   224

   225

void Ship::MarkDirty()

   226

{

   227

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

   228

	MarkSingleVehicleDirty(this);

   229

}

   230

   231

static void PlayShipSound(const Vehicle *v)

   232

{

   233

	if (!PlayVehicleSound(v, VSE_START)) {

   234

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

   235

	}

   236

}

   237

   238

void Ship::PlayLeaveStationSound() const

   239

{

   240

	PlayShipSound(this);

   241

}

   242

   243

static void ProcessShipOrder(Vehicle *v)

   244

{

   245

	const Order *order;

   246

   247

	switch (v->current_order.type) {

   248

		case OT_GOTO_DEPOT:

   249

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

   250

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

   251

					!v->NeedsServicing()) {

   252

				UpdateVehicleTimetable(v, true);

   253

				v->cur_order_index++;

   254

			}

   255

			break;

   256

   257

		case OT_LOADING:

   258

		case OT_LEAVESTATION:

   259

			return;

   260

   261

		default: break;

   262

	}

   263

   264

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

   265

   266

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

   267

   268

	if (order == NULL) {

   269

		v->current_order.Free();

   270

		v->dest_tile = 0;

   271

		return;

   272

	}

   273

   274

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

   275

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

   276

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

   277

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

   278

		return;

   279

   280

	v->current_order = *order;

   281

   282

	if (order->type == OT_GOTO_STATION) {

   283

		const Station *st;

   284

   285

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

   286

			v->last_station_visited = INVALID_STATION;

   287

   288

		st = GetStation(order->dest);

   289

		if (st->dock_tile != 0) {

   290

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

   291

		} else {

   292

			v->cur_order_index++;

   293

		}

   294

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

   295

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

   296

	} else {

   297

		v->dest_tile = 0;

   298

	}

   299

   300

	InvalidateVehicleOrder(v);

   301

   302

	InvalidateWindowClasses(WC_SHIPS_LIST);

   303

}

   304

   305

void Ship::UpdateDeltaXY(Direction direction)

   306

{

   307

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

   308

	static const uint32 _delta_xy_table[8] = {

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

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

   317

	};

   318

#undef MKIT

   319

   320

	uint32 x = _delta_xy_table[direction];

   321

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

   322

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

   323

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

   324

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

   325

	this->z_height      = 6;

   326

}

   327

   328

void RecalcShipStuff(Vehicle *v)

   329

{

   330

	v->UpdateDeltaXY(v->direction);

   331

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

   332

	v->MarkDirty();

   333

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   334

}

   335

   336

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   337

	{-1,  0},

   338

	{ 0, -1}

   339

};

   340

   341

static void CheckShipLeaveDepot(Vehicle *v)

   342

{

   343

	TileIndex tile;

   344

	Axis axis;

   345

	uint m;

   346

   347

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

   348

   349

	tile = v->tile;

   350

	axis = GetShipDepotAxis(tile);

   351

   352

	/* Check first side */

   353

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

   354

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

   355

	/* Check second side */

   356

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

   357

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

   358

	} else {

   359

		return;

   360

	}

   361

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

   362

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

   363

	v->vehstatus &= ~VS_HIDDEN;

   364

   365

	v->cur_speed = 0;

   366

	RecalcShipStuff(v);

   367

   368

	PlayShipSound(v);

   369

	VehicleServiceInDepot(v);

   370

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   371

	InvalidateWindowClasses(WC_SHIPS_LIST);

   372

}

   373

   374

static bool ShipAccelerate(Vehicle *v)

   375

{

   376

	uint spd;

   377

	byte t;

   378

   379

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

   380

   381

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

   382

	if (spd != v->cur_speed) {

   383

		v->cur_speed = spd;

   384

		if (_patches.vehicle_speed)

   385

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

   386

	}

   387

   388

	/* Decrease somewhat when turning */

   389

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

   390

   391

	if (spd == 0) return false;

   392

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

   393

   394

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

   395

   396

	return (t < v->progress);

   397

}

   398

   399

static CommandCost EstimateShipCost(EngineID engine_type)

   400

{

   401

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

   402

}

   403

   404

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

   405

{

   406

	/* Check if station was ever visited before */

   407

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

   408

		uint32 flags;

   409

   410

		st->had_vehicle_of_type |= HVOT_SHIP;

   411

   412

		SetDParam(0, st->index);

   413

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

   414

		AddNewsItem(

   415

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   416

			flags,

   417

			v->index,

   418

			0);

   419

	}

   420

}

   421

   422

struct PathFindShip {

   423

	TileIndex skiptile;

   424

	TileIndex dest_coords;

   425

	uint best_bird_dist;

   426

	uint best_length;

   427

};

   428

   429

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

   430

{

   431

	/* Found dest? */

   432

	if (tile == pfs->dest_coords) {

   433

		pfs->best_bird_dist = 0;

   434

   435

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

   436

		return true;

   437

	}

   438

   439

	/* Skip this tile in the calculation */

   440

	if (tile != pfs->skiptile) {

   441

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

   442

	}

   443

   444

	return false;

   445

}

   446

   447

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

   448

	{ 0, 9, 2, 9 },

   449

	{ 9, 1, 9, 3 },

   450

	{ 9, 0, 3, 9 },

   451

	{ 1, 9, 9, 2 },

   452

	{ 3, 2, 9, 9 },

   453

	{ 9, 9, 1, 0 },

   454

};

   455

   456

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

   457

   458

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

   459

{

   460

	PathFindShip pfs;

   461

	Track i, best_track;

   462

	uint best_bird_dist = 0;

   463

	uint best_length    = 0;

   464

	uint r;

   465

	byte ship_dir = v->direction & 3;

   466

   467

	pfs.dest_coords = v->dest_tile;

   468

	pfs.skiptile = skiptile;

   469

   470

	best_track = INVALID_TRACK;

   471

   472

	do {

   473

		i = RemoveFirstTrack(&bits);

   474

   475

		pfs.best_bird_dist = (uint)-1;

   476

		pfs.best_length = (uint)-1;

   477

   478

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

   479

   480

		if (best_track != INVALID_TRACK) {

   481

			if (pfs.best_bird_dist != 0) {

   482

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

   483

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   484

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   485

			} else {

   486

				if (pfs.best_length > best_length) goto bad;

   487

				if (pfs.best_length < best_length) goto good;

   488

			}

   489

   490

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

   491

			 * pick one randomly. */

   492

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

   493

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