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"

    10

#include "functions.h"

    11

#include "landscape.h"

    12

#include "map.h"

    13

#include "tile.h"

    14

#include "vehicle.h"

    15

#include "timetable.h"

    16

#include "command.h"

    17

#include "pathfind.h"

    18

#include "station_map.h"

    19

#include "station.h"

    20

#include "news.h"

    21

#include "engine.h"

    22

#include "player.h"

    23

#include "sound.h"

    24

#include "npf.h"

    25

#include "depot.h"

    26

#include "vehicle_gui.h"

    27

#include "newgrf_engine.h"

    28

#include "water_map.h"

    29

#include "yapf/yapf.h"

    30

#include "debug.h"

    31

#include "newgrf_callbacks.h"

    32

#include "newgrf_text.h"

    33

#include "newgrf_sound.h"

    34

#include "date.h"

    35

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

	const Depot* depot;

   143

   144

	if (_patches.servint_ships == 0) return;

   145

	if (!VehicleNeedsService(v))     return;

   146

	if (v->vehstatus & VS_STOPPED)   return;

   147

   148

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

   149

			v->current_order.flags & OF_HALT_IN_DEPOT)

   150

		return;

   151

   152

	if (_patches.gotodepot && VehicleHasDepotOrders(v)) return;

   153

   154

	if (IsShipInDepot(v)) {

   155

		VehicleServiceInDepot(v);

   156

		return;

   157

	}

   158

   159

	depot = FindClosestShipDepot(v);

   160

   161

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

   162

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

   163

			v->current_order.type = OT_DUMMY;

   164

			v->current_order.flags = 0;

   165

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

   166

		}

   167

		return;

   168

	}

   169

   170

	if (v->current_order.type == OT_LOADING) v->LeaveStation();

   171

	v->current_order.type = OT_GOTO_DEPOT;

   172

	v->current_order.flags = OF_NON_STOP;

   173

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

   174

	v->dest_tile = depot->xy;

   175

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

   176

}

   177

   178

void OnNewDay_Ship(Vehicle *v)

   179

{

   180

	CommandCost cost;

   181

   182

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

   183

		DecreaseVehicleValue(v);

   184

   185

	CheckVehicleBreakdown(v);

   186

	AgeVehicle(v);

   187

	CheckIfShipNeedsService(v);

   188

   189

	CheckOrders(v);

   190

   191

	if (v->vehstatus & VS_STOPPED) return;

   192

   193

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

   194

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

   195

   196

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   197

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

   198

   199

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   200

	/* we need this for the profit */

   201

	InvalidateWindowClasses(WC_SHIPS_LIST);

   202

}

   203

   204

static void HandleBrokenShip(Vehicle *v)

   205

{

   206

	if (v->breakdown_ctr != 1) {

   207

		v->breakdown_ctr = 1;

   208

		v->cur_speed = 0;

   209

   210

		if (v->breakdowns_since_last_service != 255)

   211

			v->breakdowns_since_last_service++;

   212

   213

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   214

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   215

   216

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   217

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   218

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   219

		}

   220

   221

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

   222

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

   223

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

   224

		}

   225

	}

   226

   227

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

   228

		if (!--v->breakdown_delay) {

   229

			v->breakdown_ctr = 0;

   230

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   231

		}

   232

	}

   233

}

   234

   235

void Ship::MarkDirty()

   236

{

   237

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

   238

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

   239

}

   240

   241

static void PlayShipSound(const Vehicle *v)

   242

{

   243

	if (!PlayVehicleSound(v, VSE_START)) {

   244

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

   245

	}

   246

}

   247

   248

void Ship::PlayLeaveStationSound() const

   249

{

   250

	PlayShipSound(this);

   251

}

   252

   253

static void ProcessShipOrder(Vehicle *v)

   254

{

   255

	const Order *order;

   256

   257

	switch (v->current_order.type) {

   258

		case OT_GOTO_DEPOT:

   259

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

   260

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

   261

					!VehicleNeedsService(v)) {

   262

				UpdateVehicleTimetable(v, true);

   263

				v->cur_order_index++;

   264

			}

   265

			break;

   266

   267

		case OT_LOADING:

   268

		case OT_LEAVESTATION:

   269

			return;

   270

   271

		default: break;

   272

	}

   273

   274

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

   275

   276

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

   277

   278

	if (order == NULL) {

   279

		v->current_order.Free();

   280

		v->dest_tile = 0;

   281

		return;

   282

	}

   283

   284

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

   285

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

   286

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

   287

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

   288

		return;

   289

   290

	v->current_order = *order;

   291

   292

	if (order->type == OT_GOTO_STATION) {

   293

		const Station *st;

   294

   295

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

   296

			v->last_station_visited = INVALID_STATION;

   297

   298

		st = GetStation(order->dest);

   299

		if (st->dock_tile != 0) {

   300

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

   301

		} else {

   302

			v->cur_order_index++;

   303

		}

   304

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

   305

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

   306

	} else {

   307

		v->dest_tile = 0;

   308

	}

   309

   310

	InvalidateVehicleOrder(v);

   311

   312

	InvalidateWindowClasses(WC_SHIPS_LIST);

   313

}

   314

   315

void Ship::UpdateDeltaXY(Direction direction)

   316

{

   317

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

   318

	static const uint32 _delta_xy_table[8] = {

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

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

   326

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

   327

	};

   328

#undef MKIT

   329

   330

	uint32 x = _delta_xy_table[direction];

   331

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

   332

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

   333

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

   334

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

   335

	this->z_height      = 6;

   336

}

   337

   338

void RecalcShipStuff(Vehicle *v)

   339

{

   340

	v->UpdateDeltaXY(v->direction);

   341

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

   342

	v->MarkDirty();

   343

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   344

}

   345

   346

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   347

	{-1,  0},

   348

	{ 0, -1}

   349

};

   350

   351

static void CheckShipLeaveDepot(Vehicle *v)

   352

{

   353

	TileIndex tile;

   354

	Axis axis;

   355

	uint m;

   356

   357

	if (!IsShipInDepot(v)) return;

   358

   359

	tile = v->tile;

   360

	axis = GetShipDepotAxis(tile);

   361

   362

	/* Check first side */

   363

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

   364

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

   365

	/* Check second side */

   366

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

   367

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

   368

	} else {

   369

		return;

   370

	}

   371

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

   372

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

   373

	v->vehstatus &= ~VS_HIDDEN;

   374

   375

	v->cur_speed = 0;

   376

	RecalcShipStuff(v);

   377

   378

	PlayShipSound(v);

   379

	VehicleServiceInDepot(v);

   380

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   381

	InvalidateWindowClasses(WC_SHIPS_LIST);

   382

}

   383

   384

static bool ShipAccelerate(Vehicle *v)

   385

{

   386

	uint spd;

   387

	byte t;

   388

   389

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

   390

   391

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

   392

	if (spd != v->cur_speed) {

   393

		v->cur_speed = spd;

   394

		if (_patches.vehicle_speed)

   395

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

   396

	}

   397

   398

	/* Decrease somewhat when turning */

   399

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

   400

   401

	if (spd == 0) return false;

   402

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

   403

   404

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

   405

   406

	return (t < v->progress);

   407

}

   408

   409

static CommandCost EstimateShipCost(EngineID engine_type)

   410

{

   411

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

   412

}

   413

   414

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

   415

{

   416

	/* Check if station was ever visited before */

   417

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

   418

		uint32 flags;

   419

   420

		st->had_vehicle_of_type |= HVOT_SHIP;

   421

   422

		SetDParam(0, st->index);

   423

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

   424

		AddNewsItem(

   425

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   426

			flags,

   427

			v->index,

   428

			0);

   429

	}

   430

}

   431

   432

struct PathFindShip {

   433

	TileIndex skiptile;

   434

	TileIndex dest_coords;

   435

	uint best_bird_dist;

   436

	uint best_length;

   437

};

   438

   439

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

   440

{

   441

	/* Found dest? */

   442

	if (tile == pfs->dest_coords) {

   443

		pfs->best_bird_dist = 0;

   444

   445

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

   446

		return true;

   447

	}

   448

   449

	/* Skip this tile in the calculation */

   450

	if (tile != pfs->skiptile) {

   451

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

   452

	}

   453

   454

	return false;

   455

}

   456

   457

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

   458

	{ 0, 9, 2, 9 },

   459

	{ 9, 1, 9, 3 },

   460

	{ 9, 0, 3, 9 },

   461

	{ 1, 9, 9, 2 },

   462

	{ 3, 2, 9, 9 },

   463

	{ 9, 9, 1, 0 },

   464

};

   465

   466

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

   467

   468

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

   469

{

   470

	PathFindShip pfs;

   471

	Track i, best_track;

   472

	uint best_bird_dist = 0;

   473

	uint best_length    = 0;

   474

	uint r;

   475

	byte ship_dir = v->direction & 3;

   476

   477

	pfs.dest_coords = v->dest_tile;

   478

	pfs.skiptile = skiptile;

   479

   480

	best_track = INVALID_TRACK;

   481

   482

	do {

   483

		i = RemoveFirstTrack(&bits);

   484

   485

		pfs.best_bird_dist = (uint)-1;

   486

		pfs.best_length = (uint)-1;

   487

   488

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

   489

   490

		if (best_track != INVALID_TRACK) {

   491

			if (pfs.best_bird_dist != 0) {

   492

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

   493

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   494

				if (pfs.best_bird_dist < best_bird_dist) goto good;