1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "ship.h"

     6

#include "table/strings.h"

     7

#include "functions.h"

     8

#include "map.h"

     9

#include "tile.h"

    10

#include "vehicle.h"

    11

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

    18

#include "sound.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 "date.h"

    30

#include "spritecache.h"

    31

    32

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

    33

    34

static const TrackBits _ship_sometracks[4] = {

    35

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

    36

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

    37

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

    38

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

    39

};

    40

    41

static TrackBits GetTileShipTrackStatus(TileIndex tile)

    42

{

    43

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);

    44

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

    45

}

    46

    47

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

    48

{

    49

	int spritenum = ShipVehInfo(engine)->image_index;

    50

    51

	if (is_custom_sprite(spritenum)) {

    52

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    53

    54

		if (sprite != 0) {

    55

			DrawSprite(sprite, pal, x, y);

    56

			return;

    57

		}

    58

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    59

	}

    60

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

    61

}

    62

    63

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

    64

 * @param engine The engine to get the sprite from

    65

 * @param &width The width of the sprite

    66

 * @param &height The height of the sprite

    67

 */

    68

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

    69

{

    70

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    71

	SpriteID custom_sprite = 0;

    72

    73

	if (is_custom_sprite(spritenum)) {

    74

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    75

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    76

	}

    77

	if (custom_sprite == 0) {

    78

		spritenum = 6 + _ship_sprites[spritenum];

    79

	} else {

    80

		spritenum = custom_sprite;

    81

	}

    82

    83

	const Sprite *spr = GetSprite(spritenum);

    84

    85

	width  = spr->width;

    86

	height = spr->height;

    87

}

    88

    89

int GetShipImage(const Vehicle* v, Direction direction)

    90

{

    91

	int spritenum = v->spritenum;

    92

    93

	if (is_custom_sprite(spritenum)) {

    94

		int sprite = GetCustomVehicleSprite(v, direction);

    95

    96

		if (sprite != 0) return sprite;

    97

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

    98

	}

    99

	return _ship_sprites[spritenum] + direction;

   100

}

   101

   102

static const Depot* FindClosestShipDepot(const Vehicle* v)

   103

{

   104

	const Depot* depot;

   105

	const Depot* best_depot = NULL;

   106

	uint dist;

   107

	uint best_dist = (uint)-1;

   108

	TileIndex tile;

   109

	TileIndex tile2 = v->tile;

   110

   111

	if (_patches.new_pathfinding_all) {

   112

		NPFFoundTargetData ftd;

   113

		Trackdir trackdir = GetVehicleTrackdir(v);

   114

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

   115

		if (ftd.best_bird_dist == 0) {

   116

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

   117

		} else {

   118

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

   119

		}

   120

	} else {

   121

		FOR_ALL_DEPOTS(depot) {

   122

			tile = depot->xy;

   123

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

   124

				dist = DistanceManhattan(tile, tile2);

   125

				if (dist < best_dist) {

   126

					best_dist = dist;

   127

					best_depot = depot;

   128

				}

   129

			}

   130

		}

   131

	}

   132

	return best_depot;

   133

}

   134

   135

static void CheckIfShipNeedsService(Vehicle *v)

   136

{

   137

	const Depot* depot;

   138

   139

	if (_patches.servint_ships == 0) return;

   140

	if (!VehicleNeedsService(v))     return;

   141

	if (v->vehstatus & VS_STOPPED)   return;

   142

   143

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

   144

			v->current_order.flags & OF_HALT_IN_DEPOT)

   145

		return;

   146

   147

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

   148

   149

	if (IsShipInDepot(v)) {

   150

		VehicleServiceInDepot(v);

   151

		return;

   152

	}

   153

   154

	depot = FindClosestShipDepot(v);

   155

   156

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

   157

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

   158

			v->current_order.type = OT_DUMMY;

   159

			v->current_order.flags = 0;

   160

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

   161

		}

   162

		return;

   163

	}

   164

   165

	v->current_order.type = OT_GOTO_DEPOT;

   166

	v->current_order.flags = OF_NON_STOP;

   167

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

   168

	v->dest_tile = depot->xy;

   169

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

   170

}

   171

   172

void OnNewDay_Ship(Vehicle *v)

   173

{

   174

	int32 cost;

   175

   176

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

   177

		DecreaseVehicleValue(v);

   178

   179

	CheckVehicleBreakdown(v);

   180

	AgeVehicle(v);

   181

	CheckIfShipNeedsService(v);

   182

   183

	CheckOrders(v);

   184

   185

	if (v->vehstatus & VS_STOPPED) return;

   186

   187

	cost = ShipVehInfo(v->engine_type)->running_cost * _price.ship_running / 364;

   188

	v->profit_this_year -= cost >> 8;

   189

   190

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   191

	SubtractMoneyFromPlayerFract(v->owner, cost);

   192

   193

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   194

	//we need this for the profit

   195

	InvalidateWindowClasses(WC_SHIPS_LIST);

   196

}

   197

   198

static void HandleBrokenShip(Vehicle *v)

   199

{

   200

	if (v->breakdown_ctr != 1) {

   201

		v->breakdown_ctr = 1;

   202

		v->cur_speed = 0;

   203

   204

		if (v->breakdowns_since_last_service != 255)

   205

			v->breakdowns_since_last_service++;

   206

   207

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   208

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   209

   210

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   211

			SndPlayVehicleFx((_opt.landscape != LT_CANDY) ?

   212

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   213

		}

   214

   215

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

   216

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

   217

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

   218

		}

   219

	}

   220

   221

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

   222

		if (!--v->breakdown_delay) {

   223

			v->breakdown_ctr = 0;

   224

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   225

		}

   226

	}

   227

}

   228

   229

static void MarkShipDirty(Vehicle *v)

   230

{

   231

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

   232

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

   233

}

   234

   235

static void PlayShipSound(Vehicle *v)

   236

{

   237

	if (!PlayVehicleSound(v, VSE_START)) {

   238

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

   239

	}

   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

				v->cur_order_index++;

   252

			}

   253

			break;

   254

   255

		case OT_LOADING:

   256

		case OT_LEAVESTATION:

   257

			return;

   258

   259

		default: break;

   260

	}

   261

   262

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

   263

   264

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

   265

   266

	if (order == NULL) {

   268

		v->dest_tile = 0;

   269

		return;

   270

	}

   271

   272

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

   273

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

   274

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

   275

		return;

   276

   277

	v->current_order = *order;

   278

   279

	if (order->type == OT_GOTO_STATION) {

   280

		const Station *st;

   281

   282

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

   283

			v->last_station_visited = INVALID_STATION;

   284

   285

		st = GetStation(order->dest);

   286

		if (st->dock_tile != 0) {

   287

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

   288

		}

   289

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

   290

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

   291

	} else {

   292

		v->dest_tile = 0;

   293

	}

   294

   295

	InvalidateVehicleOrder(v);

   296

   297

	InvalidateWindowClasses(WC_SHIPS_LIST);

   298

}

   299

   300

static void HandleShipLoading(Vehicle *v)

   301

{

   302

	switch (v->current_order.type) {

   303

		case OT_LOADING: {

   304

			if (--v->load_unload_time_rem) return;

   305

   306

			if (CanFillVehicle(v) && (

   307

						v->current_order.flags & OF_FULL_LOAD ||

   308

						(_patches.gradual_loading && !HASBIT(v->vehicle_flags, VF_LOADING_FINISHED))

   309

					)) {

   310

				SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   311

				if (LoadUnloadVehicle(v, false)) {

   312

					InvalidateWindow(WC_SHIPS_LIST, v->owner);

   313

					MarkShipDirty(v);

   314

				}

   315

				return;

   316

			}

   317

			PlayShipSound(v);

   318

   319

			Order b = v->current_order;

   320

			v->LeaveStation();

   321

			if (!(b.flags & OF_NON_STOP)) return;

   322

			break;

   323

		}

   324

   325

		case OT_DUMMY: break;

   326

   327

		default: return;

   328

	}

   329

   330

	v->cur_order_index++;

   331

	InvalidateVehicleOrder(v);

   332

}

   333

   334

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   335

{

   336

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

   337

	static const uint32 _delta_xy_table[8] = {

   338

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

   339

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

   340

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

   341

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

   342

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

   343

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

   344

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

   345

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

   346

	};

   347

#undef MKIT

   348

	uint32 x = _delta_xy_table[dir];

   349

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

   350

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

   351

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

   352

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

   353

}

   354

   355

void RecalcShipStuff(Vehicle *v)

   356

{

   357

	UpdateShipDeltaXY(v, v->direction);

   358

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

   359

	MarkShipDirty(v);

   360

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   361

}

   362

   363

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   364

	{-1,  0},

   365

	{ 0, -1}

   366

};

   367

   368

static void CheckShipLeaveDepot(Vehicle *v)

   369

{

   370

	TileIndex tile;

   371

	Axis axis;

   372

	uint m;

   373

   374

	if (!IsShipInDepot(v)) return;

   375

   376

	tile = v->tile;

   377

	axis = GetShipDepotAxis(tile);

   378

   379

	// Check first side

   380

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

   381

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

   382

	// Check second side

   383

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

   384

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

   385

	} else {

   386

		return;

   387

	}

   388

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

   389

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

   390

	v->vehstatus &= ~VS_HIDDEN;

   391

   392

	v->cur_speed = 0;

   393

	RecalcShipStuff(v);

   394

   395

	PlayShipSound(v);

   396

	VehicleServiceInDepot(v);

   397

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   398

	InvalidateWindowClasses(WC_SHIPS_LIST);

   399

}

   400

   401

static bool ShipAccelerate(Vehicle *v)

   402

{

   403

	uint spd;

   404

	byte t;

   405

   406

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

   407

   408

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

   409

	if (spd != v->cur_speed) {

   410

		v->cur_speed = spd;

   411

		if (_patches.vehicle_speed)

   412

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

   413

	}

   414

   415

	// Decrease somewhat when turning

   416

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

   417

   418

	if (spd == 0) return false;

   419

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

   420

   421

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

   422

   423

	return (t < v->progress);

   424

}

   425

   426

static int32 EstimateShipCost(EngineID engine_type)

   427

{

   428

	return ShipVehInfo(engine_type)->base_cost * (_price.ship_base>>3)>>5;

   429

}

   430

   431

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

   432

{

   433

	/* Check if station was ever visited before */

   434

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

   435

		uint32 flags;

   436

   437

		st->had_vehicle_of_type |= HVOT_SHIP;

   438

   439

		SetDParam(0, st->index);

   440

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

   441

		AddNewsItem(

   442

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   443

			flags,

   444

			v->index,

   445

			0);

   446

	}

   447

}

   448

   449

struct PathFindShip {

   450

	TileIndex skiptile;

   451

	TileIndex dest_coords;

   452

	uint best_bird_dist;

   453

	uint best_length;

   454

};

   455

   456

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

   457

{

   458

	// Found dest?

   459

	if (tile == pfs->dest_coords) {

   460

		pfs->best_bird_dist = 0;

   461

   462

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

   463

		return true;

   464

	}

   465

   466

	// Skip this tile in the calculation

   467

	if (tile != pfs->skiptile) {

   468

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

   469

	}

   470

   471

	return false;

   472

}

   473

   474

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

   475

	{ 0, 9, 2, 9 },

   476

	{ 9, 1, 9, 3 },

   477

	{ 9, 0, 3, 9 },

   478

	{ 1, 9, 9, 2 },

   479

	{ 3, 2, 9, 9 },

   480

	{ 9, 9, 1, 0 },

   481

};

   482

   483

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

   484

   485

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

   486

{

   487

	PathFindShip pfs;

   488

	Track i, best_track;

   489

	uint best_bird_dist = 0;

   490

	uint best_length    = 0;

   491

	uint r;

   492

	byte ship_dir = v->direction & 3;

   493

   494

	pfs.dest_coords = v->dest_tile;

   495

	pfs.skiptile = skiptile;

   496

   497

	best_track = INVALID_TRACK;

   498