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

    13

#include "vehicle.h"

    14

#include "timetable.h"

    15

#include "command.h"

    16

#include "pathfind.h"

    17

#include "station_map.h"

    18

#include "station.h"

    19

#include "news.h"

    20

#include "engine.h"

    21

#include "player.h"

    22

#include "sound.h"

    23

#include "npf.h"

    24

#include "depot.h"

    25

#include "vehicle_gui.h"

    26

#include "newgrf_engine.h"

    27

#include "water_map.h"

    28

#include "yapf/yapf.h"

    29

#include "debug.h"

    30

#include "newgrf_callbacks.h"

    31

#include "newgrf_text.h"

    32

#include "newgrf_sound.h"

    33

#include "date.h"

    34

#include "spritecache.h"

    35

    36

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

    37

    38

static const TrackBits _ship_sometracks[4] = {

    39

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

    40

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

    41

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

    42

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

    43

};

    44

    45

static TrackBits GetTileShipTrackStatus(TileIndex tile)

    46

{

    47

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

    48

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

    49

}

    50

    51

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

    52

{

    53

	int spritenum = ShipVehInfo(engine)->image_index;

    54

    55

	if (is_custom_sprite(spritenum)) {

    56

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    57

    58

		if (sprite != 0) {

    59

			DrawSprite(sprite, pal, x, y);

    60

			return;

    61

		}

    62

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    63

	}

    64

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

    65

}

    66

    67

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

    68

 * @param engine The engine to get the sprite from

    69

 * @param width The width of the sprite

    70

 * @param height The height of the sprite

    71

 */

    72

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

    73

{

    74

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    75

	SpriteID custom_sprite = 0;

    76

    77

	if (is_custom_sprite(spritenum)) {

    78

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    79

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    80

	}

    81

	if (custom_sprite == 0) {

    82

		spritenum = 6 + _ship_sprites[spritenum];

    83

	} else {

    84

		spritenum = custom_sprite;

    85

	}

    86

    87

	const Sprite *spr = GetSprite(spritenum);

    88

    89

	width  = spr->width;

    90

	height = spr->height;

    91

}

    92

    93

int GetShipImage(const Vehicle* v, Direction direction)

    94

{

    95

	int spritenum = v->spritenum;

    96

    97

	if (is_custom_sprite(spritenum)) {

    98

		int sprite = GetCustomVehicleSprite(v, direction);

    99

   100

		if (sprite != 0) return sprite;

   101

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

   102

	}

   103

	return _ship_sprites[spritenum] + direction;

   104

}

   105

   106

static const Depot* FindClosestShipDepot(const Vehicle* v)

   107

{

   108

	const Depot* depot;

   109

	const Depot* best_depot = NULL;

   110

	uint dist;

   111

	uint best_dist = (uint)-1;

   112

	TileIndex tile;

   113

	TileIndex tile2 = v->tile;

   114

   115

	if (_patches.new_pathfinding_all) {

   116

		NPFFoundTargetData ftd;

   117

		Trackdir trackdir = GetVehicleTrackdir(v);

   118

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

   119

		if (ftd.best_bird_dist == 0) {

   120

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

   121

		} else {

   122

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

   123

		}

   124

	} else {

   125

		FOR_ALL_DEPOTS(depot) {

   126

			tile = depot->xy;

   127

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

   128

				dist = DistanceManhattan(tile, tile2);

   129

				if (dist < best_dist) {

   130

					best_dist = dist;

   131

					best_depot = depot;

   132

				}

   133

			}

   134

		}

   135

	}

   136

	return best_depot;

   137

}

   138

   139

static void CheckIfShipNeedsService(Vehicle *v)

   140

{

   141

	const Depot* depot;

   142

   143

	if (_patches.servint_ships == 0) return;

   144

	if (!VehicleNeedsService(v))     return;

   145

	if (v->vehstatus & VS_STOPPED)   return;

   146

   147

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

   148

			v->current_order.flags & OF_HALT_IN_DEPOT)

   149

		return;

   150

   151

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

   152

   153

	if (IsShipInDepot(v)) {

   154

		VehicleServiceInDepot(v);

   155

		return;

   156

	}

   157

   158

	depot = FindClosestShipDepot(v);

   159

   160

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

   161

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

   162

			v->current_order.type = OT_DUMMY;

   163

			v->current_order.flags = 0;

   164

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

   165

		}

   166

		return;

   167

	}

   168

   169

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

   170

	v->current_order.type = OT_GOTO_DEPOT;

   171

	v->current_order.flags = OF_NON_STOP;

   172

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

   173

	v->dest_tile = depot->xy;

   174

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

   175

}

   176

   177

void OnNewDay_Ship(Vehicle *v)

   178

{

   179

	CommandCost cost;

   180

   181

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

   182

		DecreaseVehicleValue(v);

   183

   184

	CheckVehicleBreakdown(v);

   185

	AgeVehicle(v);

   186

	CheckIfShipNeedsService(v);

   187

   188

	CheckOrders(v);

   189

   190

	if (v->vehstatus & VS_STOPPED) return;

   191

   192

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

   193

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

   194

   195

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   196

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

   197

   198

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   199

	/* we need this for the profit */

   200

	InvalidateWindowClasses(WC_SHIPS_LIST);

   201

}

   202

   203

static void HandleBrokenShip(Vehicle *v)

   204

{

   205

	if (v->breakdown_ctr != 1) {

   206

		v->breakdown_ctr = 1;

   207

		v->cur_speed = 0;

   208

   209

		if (v->breakdowns_since_last_service != 255)

   210

			v->breakdowns_since_last_service++;

   211

   212

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   213

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   214

   215

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   216

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   217

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   218

		}

   219

   220

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

   221

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

   222

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

   223

		}

   224

	}

   225

   226

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

   227

		if (!--v->breakdown_delay) {

   228

			v->breakdown_ctr = 0;

   229

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   230

		}

   231

	}

   232

}

   233

   234

void Ship::MarkDirty()

   235

{

   236

	this->cur_image = GetShipImage(this, this->direction);

   237

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

   238

}

   239

   240

static void PlayShipSound(const Vehicle *v)

   241

{

   242

	if (!PlayVehicleSound(v, VSE_START)) {

   243

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

   244

	}

   245

}

   246

   247

void Ship::PlayLeaveStationSound() const

   248

{

   249

	PlayShipSound(this);

   250

}

   251

   252

static void ProcessShipOrder(Vehicle *v)

   253

{

   254

	const Order *order;

   255

   256

	switch (v->current_order.type) {

   257

		case OT_GOTO_DEPOT:

   258

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

   259

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

   260

					!VehicleNeedsService(v)) {

   261

				v->cur_order_index++;

   262

				UpdateVehicleTimetable(v, true);

   263

			}

   264

			break;

   265

   266

		case OT_LOADING:

   267

		case OT_LEAVESTATION:

   268

			return;

   269

   270

		default: break;

   271

	}

   272

   273

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

   274

   275

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

   276

   277

	if (order == NULL) {

   278

		v->current_order.Free();

   279

		v->dest_tile = 0;

   280

		return;

   281

	}

   282

   283

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

   284

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

   285

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

   286

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

   287

		return;

   288

   289

	v->current_order = *order;

   290

   291

	if (order->type == OT_GOTO_STATION) {

   292

		const Station *st;

   293

   294

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

   295

			v->last_station_visited = INVALID_STATION;

   296

   297

		st = GetStation(order->dest);

   298

		if (st->dock_tile != 0) {

   299

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

   300

		} else {

   301

			v->cur_order_index++;

   302

		}

   303

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

   304

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

   305

	} else {

   306

		v->dest_tile = 0;

   307

	}

   308

   309

	InvalidateVehicleOrder(v);

   310

   311

	InvalidateWindowClasses(WC_SHIPS_LIST);

   312

}

   313

   314

void Ship::UpdateDeltaXY(Direction direction)

   315

{

   316

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

   317

	static const uint32 _delta_xy_table[8] = {

   318

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

   319

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

   320

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

   321

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

   322

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

   323

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

   324

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

   325

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

   326

	};

   327

#undef MKIT

   328

   329

	uint32 x = _delta_xy_table[direction];

   330

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

   331

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

   332

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

   333

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

   334

	this->z_height      = 6;

   335

}

   336

   337

void RecalcShipStuff(Vehicle *v)

   338

{

   339

	v->UpdateDeltaXY(v->direction);

   340

	v->cur_image = GetShipImage(v, v->direction);

   341

	v->MarkDirty();

   342

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   343

}

   344

   345

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   346

	{-1,  0},

   347

	{ 0, -1}

   348

};

   349

   350

static void CheckShipLeaveDepot(Vehicle *v)

   351

{

   352

	TileIndex tile;

   353

	Axis axis;

   354

	uint m;

   355

   356

	if (!IsShipInDepot(v)) return;

   357

   358

	tile = v->tile;

   359

	axis = GetShipDepotAxis(tile);

   360

   361

	/* Check first side */

   362

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

   363

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

   364

	/* Check second side */

   365

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

   366

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

   367

	} else {

   368

		return;

   369

	}

   370

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

   371

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

   372

	v->vehstatus &= ~VS_HIDDEN;

   373

   374

	v->cur_speed = 0;

   375

	RecalcShipStuff(v);

   376

   377

	PlayShipSound(v);

   378

	VehicleServiceInDepot(v);

   379

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   380

	InvalidateWindowClasses(WC_SHIPS_LIST);

   381

}

   382

   383

static bool ShipAccelerate(Vehicle *v)

   384

{

   385

	uint spd;

   386

	byte t;

   387

   388

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

   389

   390

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

   391

	if (spd != v->cur_speed) {

   392

		v->cur_speed = spd;

   393

		if (_patches.vehicle_speed)

   394

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

   395

	}

   396

   397

	/* Decrease somewhat when turning */

   398

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

   399

   400

	if (spd == 0) return false;

   401

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

   402

   403

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

   404

   405

	return (t < v->progress);

   406

}

   407

   408

static CommandCost EstimateShipCost(EngineID engine_type)

   409

{

   410

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

   411

}

   412

   413

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

   414

{

   415

	/* Check if station was ever visited before */

   416

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

   417

		uint32 flags;

   418

   419

		st->had_vehicle_of_type |= HVOT_SHIP;

   420

   421

		SetDParam(0, st->index);

   422

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

   423

		AddNewsItem(

   424

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   425

			flags,

   426

			v->index,

   427

			0);

   428

	}

   429

}

   430

   431

struct PathFindShip {

   432

	TileIndex skiptile;

   433

	TileIndex dest_coords;

   434

	uint best_bird_dist;

   435

	uint best_length;

   436

};

   437

   438

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

   439

{

   440

	/* Found dest? */

   441

	if (tile == pfs->dest_coords) {

   442

		pfs->best_bird_dist = 0;

   443

   444

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

   445

		return true;

   446

	}

   447

   448

	/* Skip this tile in the calculation */

   449

	if (tile != pfs->skiptile) {

   450

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

   451

	}

   452

   453

	return false;

   454

}

   455

   456

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

   457

	{ 0, 9, 2, 9 },

   458

	{ 9, 1, 9, 3 },

   459

	{ 9, 0, 3, 9 },

   460

	{ 1, 9, 9, 2 },

   461

	{ 3, 2, 9, 9 },

   462

	{ 9, 9, 1, 0 },

   463

};

   464

   465

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

   466

   467

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

   468

{

   469

	PathFindShip pfs;

   470

	Track i, best_track;

   471

	uint best_bird_dist = 0;

   472

	uint best_length    = 0;

   473

	uint r;

   474

	byte ship_dir = v->direction & 3;

   475

   476

	pfs.dest_coords = v->dest_tile;

   477

	pfs.skiptile = skiptile;

   478

   479

	best_track = INVALID_TRACK;

   480

   481

	do {

   482

		i = RemoveFirstTrack(&bits);

   483

   484

		pfs.best_bird_dist = (uint)-1;

   485

		pfs.best_length = (uint)-1;

   486

   487

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

   488

   489

		if (best_track != INVALID_TRACK) {

   490

			if (pfs.best_bird_dist != 0) {

   491

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

   492

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   493

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   494

			} else {

   495

				if (pfs.best_length > best_length) goto bad;