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

    15

#include "pathfind.h"

    16

#include "station_map.h"

    17

#include "station.h"

    18

#include "news.h"

    19

#include "engine.h"

    20

#include "player.h"

    21

#include "sound.h"

    22

#include "npf.h"

    23

#include "depot.h"

    24

#include "vehicle_gui.h"

    25

#include "newgrf_engine.h"

    26

#include "water_map.h"

    27

#include "yapf/yapf.h"

    28

#include "debug.h"

    29

#include "newgrf_callbacks.h"

    30

#include "newgrf_text.h"

    31

#include "newgrf_sound.h"

    32

#include "date.h"

    33

#include "spritecache.h"

    34

    35

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

    36

    37

static const TrackBits _ship_sometracks[4] = {

    38

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

    39

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

    40

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

    41

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

    42

};

    43

    44

static TrackBits GetTileShipTrackStatus(TileIndex tile)

    45

{

    46

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);

    47

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

    48

}

    49

    50

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

    51

{

    52

	int spritenum = ShipVehInfo(engine)->image_index;

    53

    54

	if (is_custom_sprite(spritenum)) {

    55

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    56

    57

		if (sprite != 0) {

    58

			DrawSprite(sprite, pal, x, y);

    59

			return;

    60

		}

    61

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    62

	}

    63

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

    64

}

    65

    66

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

    67

 * @param engine The engine to get the sprite from

    68

 * @param width The width of the sprite

    69

 * @param height The height of the sprite

    70

 */

    71

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

    72

{

    73

	SpriteID spritenum = ShipVehInfo(engine)->image_index;

    74

	SpriteID custom_sprite = 0;

    75

    76

	if (is_custom_sprite(spritenum)) {

    77

		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);

    78

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    79

	}

    80

	if (custom_sprite == 0) {

    81

		spritenum = 6 + _ship_sprites[spritenum];

    82

	} else {

    83

		spritenum = custom_sprite;

    84

	}

    85

    86

	const Sprite *spr = GetSprite(spritenum);

    87

    88

	width  = spr->width;

    89

	height = spr->height;

    90

}

    91

    92

int GetShipImage(const Vehicle* v, Direction direction)

    93

{

    94

	int spritenum = v->spritenum;

    95

    96

	if (is_custom_sprite(spritenum)) {

    97

		int sprite = GetCustomVehicleSprite(v, direction);

    98

    99

		if (sprite != 0) return sprite;

   100

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

   101

	}

   102

	return _ship_sprites[spritenum] + direction;

   103

}

   104

   105

static const Depot* FindClosestShipDepot(const Vehicle* v)

   106

{

   107

	const Depot* depot;

   108

	const Depot* best_depot = NULL;

   109

	uint dist;

   110

	uint best_dist = (uint)-1;

   111

	TileIndex tile;

   112

	TileIndex tile2 = v->tile;

   113

   114

	if (_patches.new_pathfinding_all) {

   115

		NPFFoundTargetData ftd;

   116

		Trackdir trackdir = GetVehicleTrackdir(v);

   117

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

   118

		if (ftd.best_bird_dist == 0) {

   119

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

   120

		} else {

   121

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

   122

		}

   123

	} else {

   124

		FOR_ALL_DEPOTS(depot) {

   125

			tile = depot->xy;

   126

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

   127

				dist = DistanceManhattan(tile, tile2);

   128

				if (dist < best_dist) {

   129

					best_dist = dist;

   130

					best_depot = depot;

   131

				}

   132

			}

   133

		}

   134

	}

   135

	return best_depot;

   136

}

   137

   138

static void CheckIfShipNeedsService(Vehicle *v)

   139

{

   140

	const Depot* depot;

   141

   142

	if (_patches.servint_ships == 0) return;

   143

	if (!VehicleNeedsService(v))     return;

   144

	if (v->vehstatus & VS_STOPPED)   return;

   145

   146

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

   147

			v->current_order.flags & OF_HALT_IN_DEPOT)

   148

		return;

   149

   150

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

   151

   152

	if (IsShipInDepot(v)) {

   153

		VehicleServiceInDepot(v);

   154

		return;

   155

	}

   156

   157

	depot = FindClosestShipDepot(v);

   158

   159

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

   160

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

   161

			v->current_order.type = OT_DUMMY;

   162

			v->current_order.flags = 0;

   163

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

   164

		}

   165

		return;

   166

	}

   167

   168

	v->current_order.type = OT_GOTO_DEPOT;

   169

	v->current_order.flags = OF_NON_STOP;

   170

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

   171

	v->dest_tile = depot->xy;

   172

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

   173

}

   174

   175

void OnNewDay_Ship(Vehicle *v)

   176

{

   177

	int32 cost;

   178

   179

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

   180

		DecreaseVehicleValue(v);

   181

   182

	CheckVehicleBreakdown(v);

   183

	AgeVehicle(v);

   184

	CheckIfShipNeedsService(v);

   185

   186

	CheckOrders(v);

   187

   188

	if (v->vehstatus & VS_STOPPED) return;

   189

   190

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

   191

	v->profit_this_year -= cost >> 8;

   192

   193

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   194

	SubtractMoneyFromPlayerFract(v->owner, cost);

   195

   196

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   197

	/* we need this for the profit */

   198

	InvalidateWindowClasses(WC_SHIPS_LIST);

   199

}

   200

   201

static void HandleBrokenShip(Vehicle *v)

   202

{

   203

	if (v->breakdown_ctr != 1) {

   204

		v->breakdown_ctr = 1;

   205

		v->cur_speed = 0;

   206

   207

		if (v->breakdowns_since_last_service != 255)

   208

			v->breakdowns_since_last_service++;

   209

   210

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   211

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   212

   213

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   214

			SndPlayVehicleFx((_opt.landscape != LT_TOYLAND) ?

   215

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   216

		}

   217

   218

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

   219

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

   220

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

   221

		}

   222

	}

   223

   224

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

   225

		if (!--v->breakdown_delay) {

   226

			v->breakdown_ctr = 0;

   227

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   228

		}

   229

	}

   230

}

   231

   232

static void MarkShipDirty(Vehicle *v)

   233

{

   234

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

   235

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

   236

}

   237

   238

static void PlayShipSound(Vehicle *v)

   239

{

   240

	if (!PlayVehicleSound(v, VSE_START)) {

   241

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

   242

	}

   243

}

   244

   245

static void ProcessShipOrder(Vehicle *v)

   246

{

   247

	const Order *order;

   248

   249

	switch (v->current_order.type) {

   250

		case OT_GOTO_DEPOT:

   251

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

   252

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

   253

					!VehicleNeedsService(v)) {

   254

				v->cur_order_index++;

   255

			}

   256

			break;

   257

   258

		case OT_LOADING:

   259

		case OT_LEAVESTATION:

   260

			return;

   261

   262

		default: break;

   263

	}

   264

   265

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

   266

   267

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

   268

   269

	if (order == NULL) {

   270

		v->current_order.Free();

   271

		v->dest_tile = 0;

   272

		return;

   273

	}

   274

   275

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

   276

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

   277

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

   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

		}

   292

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

   293

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

   294

	} else {

   295

		v->dest_tile = 0;

   296

	}

   297

   298

	InvalidateVehicleOrder(v);

   299

   300

	InvalidateWindowClasses(WC_SHIPS_LIST);

   301

}

   302

   303

static void HandleShipLoading(Vehicle *v)

   304

{

   305

	switch (v->current_order.type) {

   306

		case OT_LOADING: {

   307

			if (--v->load_unload_time_rem) return;

   308

   309

			if (CanFillVehicle(v) && (

   310

						v->current_order.flags & OF_FULL_LOAD ||

   311

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

   312

					)) {

   313

				SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   314

				if (LoadUnloadVehicle(v, false)) {

   315

					InvalidateWindow(WC_SHIPS_LIST, v->owner);

   316

					MarkShipDirty(v);

   317

				}

   318

				return;

   319

			}

   320

			PlayShipSound(v);

   321

   322

			Order b = v->current_order;

   323

			v->LeaveStation();

   324

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

   325

			break;

   326

		}

   327

   328

		case OT_DUMMY: break;

   329

   330

		default: return;

   331

	}

   332

   333

	v->cur_order_index++;

   334

	InvalidateVehicleOrder(v);

   335

}

   336

   337

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   338

{

   339

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

   340

	static const uint32 _delta_xy_table[8] = {

   341

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

   342

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

   343

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

   344

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

   345

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

   346

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

   347

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

   348

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

   349

	};

   350

#undef MKIT

   351

	uint32 x = _delta_xy_table[dir];

   352

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

   353

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

   354

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

   355

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

   356

}

   357

   358

void RecalcShipStuff(Vehicle *v)

   359

{

   360

	UpdateShipDeltaXY(v, v->direction);

   361

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

   362

	MarkShipDirty(v);

   363

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   364

}

   365

   366

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   367

	{-1,  0},

   368

	{ 0, -1}

   369

};

   370

   371

static void CheckShipLeaveDepot(Vehicle *v)

   372

{

   373

	TileIndex tile;

   374

	Axis axis;

   375

	uint m;

   376

   377

	if (!IsShipInDepot(v)) return;

   378

   379

	tile = v->tile;

   380

	axis = GetShipDepotAxis(tile);

   381

   382

	/* Check first side */

   383

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

   384

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

   385

	/* Check second side */

   386

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

   387

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

   388

	} else {

   389

		return;

   390

	}

   391

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

   392

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

   393

	v->vehstatus &= ~VS_HIDDEN;

   394

   395

	v->cur_speed = 0;

   396

	RecalcShipStuff(v);

   397

   398

	PlayShipSound(v);

   399

	VehicleServiceInDepot(v);

   400

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   401

	InvalidateWindowClasses(WC_SHIPS_LIST);

   402

}

   403

   404

static bool ShipAccelerate(Vehicle *v)

   405

{

   406

	uint spd;

   407

	byte t;

   408

   410

   411

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

   412

	if (spd != v->cur_speed) {

   413

		v->cur_speed = spd;

   414

		if (_patches.vehicle_speed)

   415

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

   416

	}

   417

   418

	/* Decrease somewhat when turning */

   419

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

   420

   421

	if (spd == 0) return false;

   422

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

   423

   424

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

   425

   426

	return (t < v->progress);

   427

}

   428

   429

static int32 EstimateShipCost(EngineID engine_type)

   430

{

   431

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

   432

}

   433

   434

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

   435

{

   436

	/* Check if station was ever visited before */

   437

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

   438

		uint32 flags;

   439

   440

		st->had_vehicle_of_type |= HVOT_SHIP;

   441

   442

		SetDParam(0, st->index);

   443

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

   444

		AddNewsItem(

   445

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   446

			flags,

   447

			v->index,

   448

			0);

   449

	}

   450

}

   451

   452

struct PathFindShip {

   453

	TileIndex skiptile;

   454

	TileIndex dest_coords;

   455

	uint best_bird_dist;

   456

	uint best_length;

   457

};

   458

   459

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

   460

{

   461

	/* Found dest? */

   462

	if (tile == pfs->dest_coords) {

   463

		pfs->best_bird_dist = 0;

   464

   465

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

   466

		return true;

   467

	}

   468

   469

	/* Skip this tile in the calculation */

   470

	if (tile != pfs->skiptile) {

   471

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

   472

	}

   473

   474

	return false;

   475

}

   476

   477

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

   478

	{ 0, 9, 2, 9 },

   479

	{ 9, 1, 9, 3 },

   480

	{ 9, 0, 3, 9 },

   481

	{ 1, 9, 9, 2 },

   482

	{ 3, 2, 9, 9 },

   483

	{ 9, 9, 1, 0 },

   484

};

   485

   486

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

   487

   488

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

   489

{

   490

	PathFindShip pfs;

   491

	Track i, best_track;

   492

	uint best_bird_dist = 0;

   493

	uint best_length    = 0;

   494

	uint r;

   495

	byte ship_dir = v->direction & 3;

   496

   497