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

    31

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

    32

    33

static const TrackBits _ship_sometracks[4] = {

    34

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

    35

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

    36

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

    37

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

    38

};

    39

    40

static TrackBits GetTileShipTrackStatus(TileIndex tile)

    41

{

    42

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);

    43

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

    44

}

    45

    46

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

    47

{

    48

	int spritenum = ShipVehInfo(engine)->image_index;

    49

    50

	if (is_custom_sprite(spritenum)) {

    51

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    52

    53

		if (sprite != 0) {

    54

			DrawSprite(sprite, pal, x, y);

    55

			return;

    56

		}

    57

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    58

	}

    59

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

    60

}

    61

    62

int GetShipImage(const Vehicle* v, Direction direction)

    63

{

    64

	int spritenum = v->spritenum;

    65

    66

	if (is_custom_sprite(spritenum)) {

    67

		int sprite = GetCustomVehicleSprite(v, direction);

    68

    69

		if (sprite != 0) return sprite;

    70

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

    71

	}

    72

	return _ship_sprites[spritenum] + direction;

    73

}

    74

    75

static const Depot* FindClosestShipDepot(const Vehicle* v)

    76

{

    77

	const Depot* depot;

    78

	const Depot* best_depot = NULL;

    79

	uint dist;

    80

	uint best_dist = (uint)-1;

    81

	TileIndex tile;

    82

	TileIndex tile2 = v->tile;

    83

    84

	if (_patches.new_pathfinding_all) {

    85

		NPFFoundTargetData ftd;

    86

		Trackdir trackdir = GetVehicleTrackdir(v);

    87

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

    88

		if (ftd.best_bird_dist == 0) {

    89

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

    90

		} else {

    91

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

    92

		}

    93

	} else {

    94

		FOR_ALL_DEPOTS(depot) {

    95

			tile = depot->xy;

    96

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

    97

				dist = DistanceManhattan(tile, tile2);

    98

				if (dist < best_dist) {

    99

					best_dist = dist;

   100

					best_depot = depot;

   101

				}

   102

			}

   103

		}

   104

	}

   105

	return best_depot;

   106

}

   107

   108

static void CheckIfShipNeedsService(Vehicle *v)

   109

{

   110

	const Depot* depot;

   111

   112

	if (_patches.servint_ships == 0) return;

   113

	if (!VehicleNeedsService(v))     return;

   114

	if (v->vehstatus & VS_STOPPED)   return;

   115

   116

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

   117

			v->current_order.flags & OF_HALT_IN_DEPOT)

   118

		return;

   119

   120

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

   121

   122

	if (IsShipInDepot(v)) {

   123

		VehicleServiceInDepot(v);

   124

		return;

   125

	}

   126

   127

	depot = FindClosestShipDepot(v);

   128

   129

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

   130

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

   131

			v->current_order.type = OT_DUMMY;

   132

			v->current_order.flags = 0;

   133

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

   134

		}

   135

		return;

   136

	}

   137

   138

	v->current_order.type = OT_GOTO_DEPOT;

   139

	v->current_order.flags = OF_NON_STOP;

   140

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

   141

	v->dest_tile = depot->xy;

   142

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

   143

}

   144

   145

void OnNewDay_Ship(Vehicle *v)

   146

{

   147

	int32 cost;

   148

   149

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

   150

		DecreaseVehicleValue(v);

   151

   152

	CheckVehicleBreakdown(v);

   153

	AgeVehicle(v);

   154

	CheckIfShipNeedsService(v);

   155

   156

	CheckOrders(v);

   157

   158

	if (v->vehstatus & VS_STOPPED) return;

   159

   160

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

   161

	v->profit_this_year -= cost >> 8;

   162

   163

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   164

	SubtractMoneyFromPlayerFract(v->owner, cost);

   165

   166

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   167

	//we need this for the profit

   168

	InvalidateWindowClasses(WC_SHIPS_LIST);

   169

}

   170

   171

static void HandleBrokenShip(Vehicle *v)

   172

{

   173

	if (v->breakdown_ctr != 1) {

   174

		v->breakdown_ctr = 1;

   175

		v->cur_speed = 0;

   176

   177

		if (v->breakdowns_since_last_service != 255)

   178

			v->breakdowns_since_last_service++;

   179

   180

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   181

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   182

   183

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   184

			SndPlayVehicleFx((_opt.landscape != LT_CANDY) ?

   185

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   186

		}

   187

   188

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

   189

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

   190

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

   191

		}

   192

	}

   193

   194

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

   195

		if (!--v->breakdown_delay) {

   196

			v->breakdown_ctr = 0;

   197

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   198

		}

   199

	}

   200

}

   201

   202

static void MarkShipDirty(Vehicle *v)

   203

{

   204

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

   205

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

   206

}

   207

   208

static void PlayShipSound(Vehicle *v)

   209

{

   210

	if (!PlayVehicleSound(v, VSE_START)) {

   211

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

   212

	}

   213

}

   214

   215

static void ProcessShipOrder(Vehicle *v)

   216

{

   217

	const Order *order;

   218

   219

	switch (v->current_order.type) {

   220

		case OT_GOTO_DEPOT:

   221

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

   222

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

   223

					!VehicleNeedsService(v)) {

   224

				v->cur_order_index++;

   225

			}

   226

			break;

   227

   228

		case OT_LOADING:

   229

		case OT_LEAVESTATION:

   230

			return;

   231

   232

		default: break;

   233

	}

   234

   235

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

   236

   237

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

   238

   239

	if (order == NULL) {

   240

		v->current_order.type  = OT_NOTHING;

   241

		v->current_order.flags = 0;

   242

		v->dest_tile = 0;

   243

		return;

   244

	}

   245

   246

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

   247

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

   248

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

   249

		return;

   250

   251

	v->current_order = *order;

   252

   253

	if (order->type == OT_GOTO_STATION) {

   254

		const Station *st;

   255

   256

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

   257

			v->last_station_visited = INVALID_STATION;

   258

   259

		st = GetStation(order->dest);

   260

		if (st->dock_tile != 0) {

   261

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

   262

		}

   263

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

   264

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

   265

	} else {

   266

		v->dest_tile = 0;

   267

	}

   268

   269

	InvalidateVehicleOrder(v);

   270

   271

	InvalidateWindowClasses(WC_SHIPS_LIST);

   272

}

   273

   274

static void HandleShipLoading(Vehicle *v)

   275

{

   276

	switch (v->current_order.type) {

   277

		case OT_LOADING: {

   278

			if (--v->load_unload_time_rem) return;

   279

   280

			if (CanFillVehicle(v) && (

   281

						v->current_order.flags & OF_FULL_LOAD ||

   282

						(_patches.gradual_loading && !HASBIT(v->load_status, LS_LOADING_FINISHED))

   283

					)) {

   284

				SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   285

				if (LoadUnloadVehicle(v, false)) {

   286

					InvalidateWindow(WC_SHIPS_LIST, v->owner);

   287

					MarkShipDirty(v);

   288

				}

   289

				return;

   290

			}

   291

			PlayShipSound(v);

   292

   293

			Order b = v->current_order;

   294

			v->LeaveStation();

   295

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

   296

			break;

   297

		}

   298

   299

		case OT_DUMMY: break;

   300

   301

		default: return;

   302

	}

   303

   304

	v->cur_order_index++;

   305

	InvalidateVehicleOrder(v);

   306

}

   307

   308

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   309

{

   310

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

   311

	static const uint32 _delta_xy_table[8] = {

   312

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

   313

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

   314

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

   315

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

   316

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

   317

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

   318

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

   319

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

   320

	};

   321

#undef MKIT

   322

	uint32 x = _delta_xy_table[dir];

   323

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

   324

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

   325

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

   326

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

   327

}

   328

   329

void RecalcShipStuff(Vehicle *v)

   330

{

   331

	UpdateShipDeltaXY(v, v->direction);

   332

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

   333

	MarkShipDirty(v);

   334

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   335

}

   336

   337

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   338

	{-1,  0},

   339

	{ 0, -1}

   340

};

   341

   342

static void CheckShipLeaveDepot(Vehicle *v)

   343

{

   344

	TileIndex tile;

   345

	Axis axis;

   346

	uint m;

   347

   348

	if (!IsShipInDepot(v)) return;

   349

   350

	tile = v->tile;

   351

	axis = GetShipDepotAxis(tile);

   352

   353

	// Check first side

   354

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

   355

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

   356

	// Check second side

   357

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

   358

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

   359

	} else {

   360

		return;

   361

	}

   362

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

   363

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

   364

	v->vehstatus &= ~VS_HIDDEN;

   365

   366

	v->cur_speed = 0;

   367

	RecalcShipStuff(v);

   368

   369

	PlayShipSound(v);

   370

	VehicleServiceInDepot(v);

   371

	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);

   372

	InvalidateWindowClasses(WC_SHIPS_LIST);

   373

}

   374

   375

static bool ShipAccelerate(Vehicle *v)

   376

{

   377

	uint spd;

   378

	byte t;

   379

   380

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

   381

   382

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

   383

	if (spd != v->cur_speed) {

   384

		v->cur_speed = spd;

   385

		if (_patches.vehicle_speed)

   386

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

   387

	}

   388

   389

	// Decrease somewhat when turning

   390

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

   391

   392

	if (spd == 0) return false;

   393

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

   394

   395

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

   396

   397

	return (t < v->progress);

   398

}

   399

   400

static int32 EstimateShipCost(EngineID engine_type)

   401

{

   402

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

   403

}

   404

   405

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

   406

{

   407

	/* Check if station was ever visited before */

   408

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

   409

		uint32 flags;

   410

   411

		st->had_vehicle_of_type |= HVOT_SHIP;

   412

   413

		SetDParam(0, st->index);

   414

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

   415

		AddNewsItem(

   416

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   417

			flags,

   418

			v->index,

   419

			0);

   420

	}

   421

}

   422

   423

typedef struct {

   424

	TileIndex skiptile;

   425

	TileIndex dest_coords;

   426

	uint best_bird_dist;

   427

	uint best_length;

   428

} PathFindShip;

   429

   430

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

   431

{

   432

	// Found dest?

   433

	if (tile == pfs->dest_coords) {

   434

		pfs->best_bird_dist = 0;

   435

   436

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

   437

		return true;

   438

	}

   439

   440

	// Skip this tile in the calculation

   441

	if (tile != pfs->skiptile) {

   442

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

   443

	}

   444

   445

	return false;

   446

}

   447

   448

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

   449

	{ 0, 9, 2, 9 },

   450

	{ 9, 1, 9, 3 },

   451

	{ 9, 0, 3, 9 },

   452

	{ 1, 9, 9, 2 },

   453

	{ 3, 2, 9, 9 },

   454

	{ 9, 9, 1, 0 },

   455

};

   456

   457

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

   458

   459

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

   460

{

   461

	PathFindShip pfs;

   462

	Track i, best_track;

   463

	uint best_bird_dist = 0;

   464

	uint best_length    = 0;

   465

	uint r;

   466

	byte ship_dir = v->direction & 3;

   467

   468

	pfs.dest_coords = v->dest_tile;

   469

	pfs.skiptile = skiptile;

   470

   471

	best_track = INVALID_TRACK;

   472

   473

	do {

   474

		i = RemoveFirstTrack(&bits);

   475

   476

		pfs.best_bird_dist = (uint)-1;

   477

		pfs.best_length = (uint)-1;

   478

   479

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

   480

   481

		if (best_track != INVALID_TRACK) {

   482

			if (pfs.best_bird_dist != 0) {

   483

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

   484

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   485

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   486

			} else {

   487

				if (pfs.best_length > best_length) goto bad;

   488

				if (pfs.best_length < best_length) goto good;

   489

			}

   490

   491

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

   492

			 * pick one randomly. */

   493

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

   494

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

   495

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

   496

			if (r <= 127) goto bad;

   497

		}

   498

good:;

   499

		best_track = i;