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

#include "misc/autoptr.hpp"

    37

    38

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

    39

    40

static const TrackBits _ship_sometracks[4] = {

    41

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

    42

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

    43

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

    44

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

    45

};

    46

    47

static TrackBits GetTileShipTrackStatus(TileIndex tile)

    48

{

    49

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

    50

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

    51

}

    52

    53

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

    54

{

    55

	int spritenum = ShipVehInfo(engine)->image_index;

    56

    57

	if (is_custom_sprite(spritenum)) {

    58

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    59

    60

		if (sprite != 0) {

    61

			DrawSprite(sprite, pal, x, y);

    62

			return;

    63

		}

    64

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    65

	}

    66

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

    67

}

    68

    69

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

    70

 * @param engine The engine to get the sprite from

    71

 * @param width The width of the sprite

    72

 * @param height The height of the sprite

    73

 */

    74

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

    75

{

    76

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    77

	SpriteID custom_sprite = 0;

    78

    79

	if (is_custom_sprite(spritenum)) {

    80

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    81

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    82

	}

    83

	if (custom_sprite == 0) {

    84

		spritenum = 6 + _ship_sprites[spritenum];

    85

	} else {

    86

		spritenum = custom_sprite;

    87

	}

    88

    89

	const Sprite *spr = GetSprite(spritenum);

    90

    91

	width  = spr->width;

    92

	height = spr->height;

    93

}

    94

    95

int Ship::GetImage(Direction direction) const

    96

{

    97

	int spritenum = this->spritenum;

    98

    99

	if (is_custom_sprite(spritenum)) {

   100

		int sprite = GetCustomVehicleSprite(this, direction);

   101

   102

		if (sprite != 0) return sprite;

   103

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

   104

	}

   105

	return _ship_sprites[spritenum] + direction;

   106

}

   107

   108

static const Depot* FindClosestShipDepot(const Vehicle* v)

   109

{

   110

	const Depot* depot;

   111

	const Depot* best_depot = NULL;

   112

	uint dist;

   113

	uint best_dist = (uint)-1;

   114

	TileIndex tile;

   115

	TileIndex tile2 = v->tile;

   116

   117

	if (_patches.new_pathfinding_all) {

   118

		NPFFoundTargetData ftd;

   119

		Trackdir trackdir = GetVehicleTrackdir(v);

   120

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

   121

		if (ftd.best_bird_dist == 0) {

   122

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

   123

		} else {

   124

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

   125

		}

   126

	} else {

   127

		FOR_ALL_DEPOTS(depot) {

   128

			tile = depot->xy;

   129

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

   130

				dist = DistanceManhattan(tile, tile2);

   131

				if (dist < best_dist) {

   132

					best_dist = dist;

   133

					best_depot = depot;

   134

				}

   135

			}

   136

		}

   137

	}

   138

	return best_depot;

   139

}

   140

   141

static void CheckIfShipNeedsService(Vehicle *v)

   142

{

   143

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

   144

	if (v->IsInDepot()) {

   145

		VehicleServiceInDepot(v);

   146

		return;

   147

	}

   148

   149

	const Depot *depot = FindClosestShipDepot(v);

   150

   151

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

   152

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

   153

			v->current_order.type = OT_DUMMY;

   154

			v->current_order.flags = 0;

   155

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

   156

		}

   157

		return;

   158

	}

   159

   160

	v->current_order.type = OT_GOTO_DEPOT;

   161

	v->current_order.flags = OF_NON_STOP;

   162

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

   163

	v->dest_tile = depot->xy;

   164

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

   165

}

   166

   167

void OnNewDay_Ship(Vehicle *v)

   168

{

   169

	CommandCost cost;

   170

   171

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

   172

		DecreaseVehicleValue(v);

   173

   174

	CheckVehicleBreakdown(v);

   175

	AgeVehicle(v);

   176

	CheckIfShipNeedsService(v);

   177

   178

	CheckOrders(v);

   179

   180

	if (v->vehstatus & VS_STOPPED) return;

   181

   182

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

   183

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

   184

   185

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   186

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

   187

   188

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   189

	/* we need this for the profit */

   190

	InvalidateWindowClasses(WC_SHIPS_LIST);

   191

}

   192

   193

static void HandleBrokenShip(Vehicle *v)

   194

{

   195

	if (v->breakdown_ctr != 1) {

   196

		v->breakdown_ctr = 1;

   197

		v->cur_speed = 0;

   198

   199

		if (v->breakdowns_since_last_service != 255)

   200

			v->breakdowns_since_last_service++;

   201

   202

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   203

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   204

   205

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   206

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   207

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   208

		}

   209

   210

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

   211

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

   212

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

   213

		}

   214

	}

   215

   216

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

   217

		if (!--v->breakdown_delay) {

   218

			v->breakdown_ctr = 0;

   219

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   220

		}

   221

	}

   222

}

   223

   224

void Ship::MarkDirty()

   225

{

   226

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

   227

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

   228

}

   229

   230

static void PlayShipSound(const Vehicle *v)

   231

{

   232

	if (!PlayVehicleSound(v, VSE_START)) {

   233

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

   234

	}

   235

}

   236

   237

void Ship::PlayLeaveStationSound() const

   238

{

   239

	PlayShipSound(this);

   240

}

   241

   242

static void ProcessShipOrder(Vehicle *v)

   243

{

   244

	const Order *order;

   245

   246

	switch (v->current_order.type) {

   247

		case OT_GOTO_DEPOT:

   248

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

   249

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

   250

					!VehicleNeedsService(v)) {

   251

				UpdateVehicleTimetable(v, true);

   252

				v->cur_order_index++;

   253

			}

   254

			break;

   255

   256

		case OT_LOADING:

   257

		case OT_LEAVESTATION:

   258

			return;

   259

   260

		default: break;

   261

	}

   262

   263

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

   264

   265

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

   266

   267

	if (order == NULL) {

   268

		v->current_order.Free();

   269

		v->dest_tile = 0;

   270

		return;

   271

	}

   272

   273

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

   274

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

   275

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

   276

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

   277

		return;

   278

   279

	v->current_order = *order;

   280

   281

	if (order->type == OT_GOTO_STATION) {

   282

		const Station *st;

   283

   284

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

   285

			v->last_station_visited = INVALID_STATION;

   286

   287

		st = GetStation(order->dest);

   288

		if (st->dock_tile != 0) {

   289

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

   290

		} else {

   291

			v->cur_order_index++;

   292

		}

   293

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

   294

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

   295

	} else {

   296

		v->dest_tile = 0;

   297

	}

   298

   299

	InvalidateVehicleOrder(v);

   300

   301

	InvalidateWindowClasses(WC_SHIPS_LIST);

   302

}

   303

   304

void Ship::UpdateDeltaXY(Direction direction)

   305

{

   306

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

   307

	static const uint32 _delta_xy_table[8] = {

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

	};

   317

#undef MKIT

   318

   319

	uint32 x = _delta_xy_table[direction];

   320

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

   321

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

   322

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

   323

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

   324

	this->z_height      = 6;

   325

}

   326

   327

void RecalcShipStuff(Vehicle *v)

   328

{

   329

	v->UpdateDeltaXY(v->direction);

   330

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

   331

	v->MarkDirty();

   332

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   333

}

   334

   335

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   336

	{-1,  0},

   337

	{ 0, -1}

   338

};

   339

   340

static void CheckShipLeaveDepot(Vehicle *v)

   341

{

   342

	TileIndex tile;

   343

	Axis axis;

   344

	uint m;

   345

   346

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

   347

   348

	tile = v->tile;

   349

	axis = GetShipDepotAxis(tile);

   350

   351

	/* Check first side */

   352

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

   353

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

   354

	/* Check second side */

   355

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

   356

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

   357

	} else {

   358

		return;

   359

	}

   360

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

   361

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

   362

	v->vehstatus &= ~VS_HIDDEN;

   363

   364

	v->cur_speed = 0;

   365

	RecalcShipStuff(v);

   366

   367

	PlayShipSound(v);

   368

	VehicleServiceInDepot(v);

   369

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   370

	InvalidateWindowClasses(WC_SHIPS_LIST);

   371

}

   372

   373

static bool ShipAccelerate(Vehicle *v)

   374

{

   375

	uint spd;

   376

	byte t;

   377

   378

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

   379

   380

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

   381

	if (spd != v->cur_speed) {

   382

		v->cur_speed = spd;

   383

		if (_patches.vehicle_speed)

   384

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

   385

	}

   386

   387

	/* Decrease somewhat when turning */

   388

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

   389

   390

	if (spd == 0) return false;

   391

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

   392

   393

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

   394

   395

	return (t < v->progress);

   396

}

   397

   398

static CommandCost EstimateShipCost(EngineID engine_type)

   399

{

   400

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

   401

}

   402

   403

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

   404

{

   405

	/* Check if station was ever visited before */

   406

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

   407

		uint32 flags;

   408

   409

		st->had_vehicle_of_type |= HVOT_SHIP;

   410

   411

		SetDParam(0, st->index);

   412

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

   413

		AddNewsItem(

   414

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   415

			flags,

   416

			v->index,

   417

			0);

   418

	}

   419

}

   420

   421

struct PathFindShip {

   422

	TileIndex skiptile;

   423

	TileIndex dest_coords;

   424

	uint best_bird_dist;

   425

	uint best_length;

   426

};

   427

   428

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

   429

{

   430

	/* Found dest? */

   431

	if (tile == pfs->dest_coords) {

   432

		pfs->best_bird_dist = 0;

   433

   434

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

   435

		return true;

   436

	}

   437

   438

	/* Skip this tile in the calculation */

   439

	if (tile != pfs->skiptile) {

   440

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

   441

	}

   442

   443

	return false;

   444

}

   445

   446

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

   447

	{ 0, 9, 2, 9 },

   448

	{ 9, 1, 9, 3 },

   449

	{ 9, 0, 3, 9 },

   450

	{ 1, 9, 9, 2 },

   451

	{ 3, 2, 9, 9 },

   452

	{ 9, 9, 1, 0 },

   453

};

   454

   455

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

   456

   457

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

   458

{

   459

	PathFindShip pfs;

   460

	Track i, best_track;

   461

	uint best_bird_dist = 0;

   462

	uint best_length    = 0;

   463

	uint r;

   464

	byte ship_dir = v->direction & 3;

   465

   466

	pfs.dest_coords = v->dest_tile;

   467

	pfs.skiptile = skiptile;

   468

   469

	best_track = INVALID_TRACK;

   470

   471

	do {

   472

		i = RemoveFirstTrack(&bits);

   473

   474

		pfs.best_bird_dist = (uint)-1;

   475

		pfs.best_length = (uint)-1;

   476

   477

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

   478

   479

		if (best_track != INVALID_TRACK) {

   480

			if (pfs.best_bird_dist != 0) {

   481

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

   482

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   483

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   484

			} else {

   485

				if (pfs.best_length > best_length) goto bad;

   486

				if (pfs.best_length < best_length) goto good;

   487

			}

   488

   489

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

   490

			 * pick one randomly. */

   491

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

   492

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

   493

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

   494

			if (r <= 127) goto bad;

   495

		}