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

static const byte _ship_sometracks[4] = {0x19, 0x16, 0x25, 0x2A};

    33

    34

static byte GetTileShipTrackStatus(TileIndex tile)

    35

{

    36

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);

    37

	return r | r >> 8;

    38

}

    39

    40

void DrawShipEngine(int x, int y, EngineID engine, uint32 image_ormod)

    41

{

    42

	int spritenum = ShipVehInfo(engine)->image_index;

    43

    44

	if (is_custom_sprite(spritenum)) {

    45

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    46

    47

		if (sprite != 0) {

    48

			DrawSprite(sprite | image_ormod, x, y);

    49

			return;

    50

		}

    51

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    52

	}

    53

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

    54

}

    55

    56

int GetShipImage(const Vehicle* v, Direction direction)

    57

{

    58

	int spritenum = v->spritenum;

    59

    60

	if (is_custom_sprite(spritenum)) {

    61

		int sprite = GetCustomVehicleSprite(v, direction);

    62

    63

		if (sprite != 0) return sprite;

    64

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

    65

	}

    66

	return _ship_sprites[spritenum] + direction;

    67

}

    68

    69

static const Depot* FindClosestShipDepot(const Vehicle* v)

    70

{

    71

	const Depot* depot;

    72

	const Depot* best_depot = NULL;

    73

	uint dist;

    74

	uint best_dist = (uint)-1;

    75

	TileIndex tile;

    76

	TileIndex tile2 = v->tile;

    77

    78

	if (_patches.new_pathfinding_all) {

    79

		NPFFoundTargetData ftd;

    80

		byte trackdir = GetVehicleTrackdir(v);

    81

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

    82

		if (ftd.best_bird_dist == 0) {

    83

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

    84

		} else {

    85

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

    86

		}

    87

	} else {

    88

		FOR_ALL_DEPOTS(depot) {

    89

			tile = depot->xy;

    90

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

    91

				dist = DistanceManhattan(tile, tile2);

    92

				if (dist < best_dist) {

    93

					best_dist = dist;

    94

					best_depot = depot;

    95

				}

    96

			}

    97

		}

    98

	}

    99

	return best_depot;

   100

}

   101

   102

static void CheckIfShipNeedsService(Vehicle *v)

   103

{

   104

	const Depot* depot;

   105

   106

	if (_patches.servint_ships == 0) return;

   107

	if (!VehicleNeedsService(v))     return;

   108

	if (v->vehstatus & VS_STOPPED)   return;

   109

   110

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

   111

			v->current_order.flags & OF_HALT_IN_DEPOT)

   112

		return;

   113

   114

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

   115

   116

	if (IsShipInDepot(v)) {

   117

		VehicleServiceInDepot(v);

   118

		return;

   119

	}

   120

   121

	depot = FindClosestShipDepot(v);

   122

   123

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

   124

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

   125

			v->current_order.type = OT_DUMMY;

   126

			v->current_order.flags = 0;

   127

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

   128

		}

   129

		return;

   130

	}

   131

   132

	v->current_order.type = OT_GOTO_DEPOT;

   133

	v->current_order.flags = OF_NON_STOP;

   134

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

   135

	v->dest_tile = depot->xy;

   136

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

   137

}

   138

   139

void OnNewDay_Ship(Vehicle *v)

   140

{

   141

	int32 cost;

   142

   143

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

   144

		DecreaseVehicleValue(v);

   145

   146

	CheckVehicleBreakdown(v);

   147

	AgeVehicle(v);

   148

	CheckIfShipNeedsService(v);

   149

   150

	CheckOrders(v);

   151

   152

	if (v->vehstatus & VS_STOPPED) return;

   153

   154

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

   155

	v->profit_this_year -= cost >> 8;

   156

   157

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   158

	SubtractMoneyFromPlayerFract(v->owner, cost);

   159

   160

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   161

	//we need this for the profit

   162

	InvalidateWindowClasses(WC_SHIPS_LIST);

   163

}

   164

   165

static void HandleBrokenShip(Vehicle *v)

   166

{

   167

	if (v->breakdown_ctr != 1) {

   168

		v->breakdown_ctr = 1;

   169

		v->cur_speed = 0;

   170

   171

		if (v->breakdowns_since_last_service != 255)

   172

			v->breakdowns_since_last_service++;

   173

   174

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   175

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   176

   177

		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {

   178

			SndPlayVehicleFx((_opt.landscape != LT_CANDY) ?

   179

				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   180

		}

   181

   182

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

   183

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

   184

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

   185

		}

   186

	}

   187

   188

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

   189

		if (!--v->breakdown_delay) {

   190

			v->breakdown_ctr = 0;

   191

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   192

		}

   193

	}

   194

}

   195

   196

static void MarkShipDirty(Vehicle *v)

   197

{

   198

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

   199

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

   200

}

   201

   202

static void PlayShipSound(Vehicle *v)

   203

{

   204

	if (!PlayVehicleSound(v, VSE_START)) {

   205

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

   206

	}

   207

}

   208

   209

static void ProcessShipOrder(Vehicle *v)

   210

{

   211

	const Order *order;

   212

   213

	switch (v->current_order.type) {

   214

		case OT_GOTO_DEPOT:

   215

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

   216

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

   217

					!VehicleNeedsService(v)) {

   218

				v->cur_order_index++;

   219

			}

   220

			break;

   221

   222

		case OT_LOADING:

   223

		case OT_LEAVESTATION:

   224

			return;

   225

   226

		default: break;

   227

	}

   228

   229

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

   230

   231

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

   232

   233

	if (order == NULL) {

   234

		v->current_order.type  = OT_NOTHING;

   235

		v->current_order.flags = 0;

   236

		v->dest_tile = 0;

   237

		return;

   238

	}

   239

   240

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

   241

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

   242

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

   243

		return;

   244

   245

	v->current_order = *order;

   246

   247

	if (order->type == OT_GOTO_STATION) {

   248

		const Station *st;

   249

   250

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

   251

			v->last_station_visited = INVALID_STATION;

   252

   253

		st = GetStation(order->dest);

   254

		if (st->dock_tile != 0) {

   255

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

   256

		}

   257

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

   258

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

   259

	} else {

   260

		v->dest_tile = 0;

   261

	}

   262

   263

	InvalidateVehicleOrder(v);

   264

   265

	InvalidateWindowClasses(WC_SHIPS_LIST);

   266

}

   267

   268

static void HandleShipLoading(Vehicle *v)

   269

{

   270

	if (v->current_order.type == OT_NOTHING) return;

   271

   272

	if (v->current_order.type != OT_DUMMY) {

   273

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

   274

		if (--v->load_unload_time_rem) return;

   275

   276

		if (v->current_order.flags & OF_FULL_LOAD && CanFillVehicle(v)) {

   277

			SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   278

			if (LoadUnloadVehicle(v)) {

   279

				InvalidateWindow(WC_SHIPS_LIST, v->owner);

   280

				MarkShipDirty(v);

   281

			}

   282

			return;

   283

		}

   284

		PlayShipSound(v);

   285

   286

		{

   287

			Order b = v->current_order;

   288

			v->current_order.type = OT_LEAVESTATION;

   289

			v->current_order.flags = 0;

   290

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

   291

		}

   292

	}

   293

   294

	v->cur_order_index++;

   295

	InvalidateVehicleOrder(v);

   296

}

   297

   298

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   299

{

   300

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

   301

	static const uint32 _delta_xy_table[8] = {

   302

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

   303

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

   304

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

   305

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

   306

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

   307

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

   308

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

   309

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

   310

	};

   311

#undef MKIT

   312

	uint32 x = _delta_xy_table[dir];

   313

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

   314

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

   315

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

   316

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

   317

}

   318

   319

static void RecalcShipStuff(Vehicle *v)

   320

{

   321

	UpdateShipDeltaXY(v, v->direction);

   322

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

   323

	MarkShipDirty(v);

   324

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   325

}

   326

   327

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   328

	{-1,  0},

   329

	{ 0, -1}

   330

};

   331

   332

static void CheckShipLeaveDepot(Vehicle *v)

   333

{

   334

	TileIndex tile;

   335

	Axis axis;

   336

	uint m;

   337

   338

	if (!IsShipInDepot(v)) return;

   339

   340

	tile = v->tile;

   341

	axis = GetShipDepotAxis(tile);

   342

   343

	// Check first side

   344

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

   345

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

   346

	// Check second side

   347

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

   348

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

   349

	} else {

   350

		return;

   351

	}

   352

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

   353

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

   354

	v->vehstatus &= ~VS_HIDDEN;

   355

   356

	v->cur_speed = 0;

   357

	RecalcShipStuff(v);

   358

   359

	PlayShipSound(v);

   360

	VehicleServiceInDepot(v);

   361

	InvalidateWindowClasses(WC_SHIPS_LIST);

   362

}

   363

   364

static bool ShipAccelerate(Vehicle *v)

   365

{

   366

	uint spd;

   367

	byte t;

   368

   369

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

   370

   371

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

   372

	if (spd != v->cur_speed) {

   373

		v->cur_speed = spd;

   374

		if (_patches.vehicle_speed)

   375

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

   376

	}

   377

   378

	// Decrease somewhat when turning

   379

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

   380

   381

	if (spd == 0) return false;

   382

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

   383

   384

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

   385

   386

	return (t < v->progress);

   387

}

   388

   389

static int32 EstimateShipCost(EngineID engine_type)

   390

{

   391

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

   392

}

   393

   394

static void ShipEnterDepot(Vehicle *v)

   395

{

   396

	v->u.ship.state = 0x80;

   397

	v->vehstatus |= VS_HIDDEN;

   398

	v->cur_speed = 0;

   399

	RecalcShipStuff(v);

   400

   401

	VehicleServiceInDepot(v);

   402

   403

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   404

   405

	TriggerVehicle(v, VEHICLE_TRIGGER_DEPOT);

   406

   407

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

   408

		Order t;

   409

   410

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   411

   412

		t = v->current_order;

   413

		v->current_order.type = OT_DUMMY;

   414

		v->current_order.flags = 0;

   415

   416

		if (HASBIT(t.flags, OFB_PART_OF_ORDERS)) {

   417

			v->cur_order_index++;

   418

		} else if (HASBIT(t.flags, OFB_HALT_IN_DEPOT)) {

   419

			v->vehstatus |= VS_STOPPED;

   420

			if (v->owner == _local_player) {

   421

				SetDParam(0, v->unitnumber);

   422

				AddNewsItem(

   423

					STR_981C_SHIP_IS_WAITING_IN_DEPOT,

   424

					NEWS_FLAGS(NM_SMALL, NF_VIEWPORT|NF_VEHICLE, NT_ADVICE, 0),

   425

					v->index,

   426

					0);

   427

			}

   428

		}

   429

	}

   430

	InvalidateWindowClasses(WC_SHIPS_LIST);

   431

}

   432

   433

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

   434

{

   435

	/* Check if station was ever visited before */

   436

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

   437

		uint32 flags;

   438

   439

		st->had_vehicle_of_type |= HVOT_SHIP;

   440

   441

		SetDParam(0, st->index);

   442

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

   443

		AddNewsItem(

   444

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   445

			flags,

   446

			v->index,

   447

			0);

   448

	}

   449

}

   450

   451

typedef struct {

   452

	TileIndex skiptile;

   453

	TileIndex dest_coords;

   454

	uint best_bird_dist;

   455

	uint best_length;

   456

} PathFindShip;

   457

   458

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

   459

{

   460

	// Found dest?

   461

	if (tile == pfs->dest_coords) {

   462

		pfs->best_bird_dist = 0;

   463

   464

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

   465

		return true;

   466

	}

   467

   468

	// Skip this tile in the calculation

   469

	if (tile != pfs->skiptile) {

   470

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

   471

	}

   472

   473

	return false;

   474

}

   475

   476

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

   477

	{ 0, 9, 2, 9 },

   478

	{ 9, 1, 9, 3 },

   479

	{ 9, 0, 3, 9 },

   480

	{ 1, 9, 9, 2 },

   481

	{ 3, 2, 9, 9 },

   482

	{ 9, 9, 1, 0 },

   483

};

   484

   485

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

   486

   487

static uint FindShipTrack(Vehicle *v, TileIndex tile, int dir, uint bits, TileIndex skiptile, int *track)

   488

{

   489

	PathFindShip pfs;

   490

	int i, best_track;

   491

	uint best_bird_dist = 0;

   492

	uint best_length    = 0;

   493

	uint r;

   494

	byte ship_dir = v->direction & 3;

   495

   496

	pfs.dest_coords = v->dest_tile;

   497

	pfs.skiptile = skiptile;

   498

   499

	best_track = -1;

   500

   501

	do {