1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "table/strings.h"

     6

#include "functions.h"

     7

#include "map.h"

     8

#include "tile.h"

     9

#include "vehicle.h"

    10

#include "command.h"

    11

#include "pathfind.h"

    12

#include "station_map.h"

    13

#include "station.h"

    14

#include "news.h"

    15

#include "engine.h"

    16

#include "player.h"

    17

#include "sound.h"

    18

#include "npf.h"

    19

#include "depot.h"

    20

#include "vehicle_gui.h"

    21

#include "newgrf_engine.h"

    22

#include "water_map.h"

    23

#include "yapf/yapf.h"

    24

#include "debug.h"

    25

    26

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

    27

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

    28

    29

static byte GetTileShipTrackStatus(TileIndex tile)

    30

{

    31

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);

    32

	return r | r >> 8;

    33

}

    34

    35

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

    36

{

    37

	int spritenum = ShipVehInfo(engine)->image_index;

    38

    39

	if (is_custom_sprite(spritenum)) {

    40

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    41

    42

		if (sprite != 0) {

    43

			DrawSprite(sprite | image_ormod, x, y);

    44

			return;

    45

		}

    46

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    47

	}

    48

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

    49

}

    50

    51

int GetShipImage(const Vehicle* v, Direction direction)

    52

{

    53

	int spritenum = v->spritenum;

    54

    55

	if (is_custom_sprite(spritenum)) {

    56

		int sprite = GetCustomVehicleSprite(v, direction);

    57

    58

		if (sprite != 0) return sprite;

    59

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

    60

	}

    61

	return _ship_sprites[spritenum] + direction;

    62

}

    63

    64

static const Depot* FindClosestShipDepot(const Vehicle* v)

    65

{

    66

	const Depot* depot;

    67

	const Depot* best_depot = NULL;

    68

	uint dist;

    69

	uint best_dist = (uint)-1;

    70

	TileIndex tile;

    71

	TileIndex tile2 = v->tile;

    72

    73

	if (_patches.new_pathfinding_all) {

    74

		NPFFoundTargetData ftd;

    75

		byte trackdir = GetVehicleTrackdir(v);

    76

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

    77

		if (ftd.best_bird_dist == 0) {

    78

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

    79

		} else {

    80

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

    81

		}

    82

	} else {

    83

		FOR_ALL_DEPOTS(depot) {

    84

			tile = depot->xy;

    85

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

    86

				dist = DistanceManhattan(tile, tile2);

    87

				if (dist < best_dist) {

    88

					best_dist = dist;

    89

					best_depot = depot;

    90

				}

    91

			}

    92

		}

    93

	}

    94

	return best_depot;

    95

}

    96

    97

static void CheckIfShipNeedsService(Vehicle *v)

    98

{

    99

	const Depot* depot;

   100

   101

	if (_patches.servint_ships == 0) return;

   102

	if (!VehicleNeedsService(v))     return;

   103

	if (v->vehstatus & VS_STOPPED)   return;

   104

   105

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

   106

			v->current_order.flags & OF_HALT_IN_DEPOT)

   107

		return;

   108

   109

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

   110

   111

	depot = FindClosestShipDepot(v);

   112

   113

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

   114

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

   115

			v->current_order.type = OT_DUMMY;

   116

			v->current_order.flags = 0;

   117

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

   118

		}

   119

		return;

   120

	}

   121

   122

	v->current_order.type = OT_GOTO_DEPOT;

   123

	v->current_order.flags = OF_NON_STOP;

   124

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

   125

	v->dest_tile = depot->xy;

   126

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

   127

}

   128

   129

void OnNewDay_Ship(Vehicle *v)

   130

{

   131

	int32 cost;

   132

   133

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

   134

		DecreaseVehicleValue(v);

   135

   136

	CheckVehicleBreakdown(v);

   137

	AgeVehicle(v);

   138

	CheckIfShipNeedsService(v);

   139

   140

	CheckOrders(v);

   141

   142

	if (v->vehstatus & VS_STOPPED) return;

   143

   144

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

   145

	v->profit_this_year -= cost >> 8;

   146

   147

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   148

	SubtractMoneyFromPlayerFract(v->owner, cost);

   149

   150

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   151

	//we need this for the profit

   152

	InvalidateWindowClasses(WC_SHIPS_LIST);

   153

}

   154

   155

static void HandleBrokenShip(Vehicle *v)

   156

{

   157

	if (v->breakdown_ctr != 1) {

   158

		v->breakdown_ctr = 1;

   159

		v->cur_speed = 0;

   160

   161

		if (v->breakdowns_since_last_service != 255)

   162

			v->breakdowns_since_last_service++;

   163

   164

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   165

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   166

   167

		SndPlayVehicleFx((_opt.landscape != LT_CANDY) ?

   168

			SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   169

   170

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

   171

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

   172

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

   173

		}

   174

	}

   175

   176

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

   177

		if (!--v->breakdown_delay) {

   178

			v->breakdown_ctr = 0;

   179

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   180

		}

   181

	}

   182

}

   183

   184

static void MarkShipDirty(Vehicle *v)

   185

{

   186

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

   187

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

   188

}

   189

   190

static void PlayShipSound(Vehicle *v)

   191

{

   192

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

   193

}

   194

   195

static void ProcessShipOrder(Vehicle *v)

   196

{

   197

	const Order *order;

   198

   199

	switch (v->current_order.type) {

   200

		case OT_GOTO_DEPOT:

   201

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

   202

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

   203

					!VehicleNeedsService(v)) {

   204

				v->cur_order_index++;

   205

			}

   206

			break;

   207

   208

		case OT_LOADING:

   209

		case OT_LEAVESTATION:

   210

			return;

   211

	}

   212

   213

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

   214

   215

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

   216

   217

	if (order == NULL) {

   218

		v->current_order.type  = OT_NOTHING;

   219

		v->current_order.flags = 0;

   220

		v->dest_tile = 0;

   221

		return;

   222

	}

   223

   224

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

   225

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

   226

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

   227

		return;

   228

   229

	v->current_order = *order;

   230

   231

	if (order->type == OT_GOTO_STATION) {

   232

		const Station *st;

   233

   234

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

   235

			v->last_station_visited = INVALID_STATION;

   236

   237

		st = GetStation(order->station);

   238

		if (st->dock_tile != 0) {

   239

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

   240

		}

   241

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

   242

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

   243

	} else {

   244

		v->dest_tile = 0;

   245

	}

   246

   247

	InvalidateVehicleOrder(v);

   248

   249

	InvalidateWindowClasses(WC_SHIPS_LIST);

   250

}

   251

   252

static void HandleShipLoading(Vehicle *v)

   253

{

   254

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

   255

   256

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

   257

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

   258

		if (--v->load_unload_time_rem) return;

   259

   260

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

   261

			SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   262

			if (LoadUnloadVehicle(v)) {

   263

				InvalidateWindow(WC_SHIPS_LIST, v->owner);

   264

				MarkShipDirty(v);

   265

			}

   266

			return;

   267

		}

   268

		PlayShipSound(v);

   269

   270

		{

   271

			Order b = v->current_order;

   272

			v->current_order.type = OT_LEAVESTATION;

   273

			v->current_order.flags = 0;

   274

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

   275

		}

   276

	}

   277

   278

	v->cur_order_index++;

   279

	InvalidateVehicleOrder(v);

   280

}

   281

   282

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   283

{

   284

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

   285

	static const uint32 _delta_xy_table[8] = {

   286

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

   287

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

   288

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

   289

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

   290

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

   291

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

   292

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

   293

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

   294

	};

   295

#undef MKIT

   296

	uint32 x = _delta_xy_table[dir];

   297

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

   298

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

   299

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

   300

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

   301

}

   302

   303

static void RecalcShipStuff(Vehicle *v)

   304

{

   305

	UpdateShipDeltaXY(v, v->direction);

   306

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

   307

	MarkShipDirty(v);

   308

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   309

}

   310

   311

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   312

	{-1,  0},

   313

	{ 0, -1}

   314

};

   315

   316

static void CheckShipLeaveDepot(Vehicle *v)

   317

{

   318

	TileIndex tile;

   319

	Axis axis;

   320

	uint m;

   321

   322

	if (v->u.ship.state != 0x80) return;

   323

   324

	tile = v->tile;

   325

	axis = GetShipDepotAxis(tile);

   326

   327

	// Check first side

   328

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

   329

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

   330

	// Check second side

   331

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

   332

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

   333

	} else {

   334

		return;

   335

	}

   336

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

   337

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

   338

	v->vehstatus &= ~VS_HIDDEN;

   339

   340

	v->cur_speed = 0;

   341

	RecalcShipStuff(v);

   342

   343

	PlayShipSound(v);

   344

	VehicleServiceInDepot(v);

   345

	InvalidateWindowClasses(WC_SHIPS_LIST);

   346

}

   347

   348

static bool ShipAccelerate(Vehicle *v)

   349

{

   350

	uint spd;

   351

	byte t;

   352

   353

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

   354

   355

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

   356

	if (spd != v->cur_speed) {

   357

		v->cur_speed = spd;

   358

		if (_patches.vehicle_speed)

   359

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

   360

	}

   361

   362

	// Decrease somewhat when turning

   363

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

   364

   365

	if (spd == 0) return false;

   366

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

   367

   368

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

   369

   370

	return (t < v->progress);

   371

}

   372

   373

static int32 EstimateShipCost(EngineID engine_type)

   374

{

   375

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

   376

}

   377

   378

static void ShipEnterDepot(Vehicle *v)

   379

{

   380

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

   381

	v->vehstatus |= VS_HIDDEN;

   382

	v->cur_speed = 0;

   383

	RecalcShipStuff(v);

   384

   385

	VehicleServiceInDepot(v);

   386

   387

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   388

   389

	TriggerVehicle(v, VEHICLE_TRIGGER_DEPOT);

   390

   391

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

   392

		Order t;

   393

   394

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   395

   396

		t = v->current_order;

   397

		v->current_order.type = OT_DUMMY;

   398

		v->current_order.flags = 0;

   399

   400

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

   401

			v->cur_order_index++;

   402

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

   403

			v->vehstatus |= VS_STOPPED;

   404

			if (v->owner == _local_player) {

   405

				SetDParam(0, v->unitnumber);

   406

				AddNewsItem(

   407

					STR_981C_SHIP_IS_WAITING_IN_DEPOT,

   408

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

   409

					v->index,

   410

					0);

   411

			}

   412

		}

   413

	}

   414

	InvalidateWindowClasses(WC_SHIPS_LIST);

   415

}

   416

   417

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

   418

{

   419

	/* Check if station was ever visited before */

   420

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

   421

		uint32 flags;

   422

   423

		st->had_vehicle_of_type |= HVOT_SHIP;

   424

   425

		SetDParam(0, st->index);

   426

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

   427

		AddNewsItem(

   428

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   429

			flags,

   430

			v->index,

   431

			0);

   432

	}

   433

}

   434

   435

typedef struct {

   436

	TileIndex skiptile;

   437

	TileIndex dest_coords;

   438

	uint best_bird_dist;

   439

	uint best_length;

   440

} PathFindShip;

   441

   442

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

   443

{

   444

	// Found dest?

   445

	if (tile == pfs->dest_coords) {

   446

		pfs->best_bird_dist = 0;

   447

   448

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

   449

		return true;

   450

	}

   451

   452

	// Skip this tile in the calculation

   453

	if (tile != pfs->skiptile) {

   454

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

   455

	}

   456

   457

	return false;

   458

}

   459

   460

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

   461

	{ 0, 9, 2, 9 },

   462

	{ 9, 1, 9, 3 },

   463

	{ 9, 0, 3, 9 },

   464

	{ 1, 9, 9, 2 },

   465

	{ 3, 2, 9, 9 },

   466

	{ 9, 9, 1, 0 },

   467

};

   468

   469

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

   470

   471

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

   472

{

   473

	PathFindShip pfs;

   474

	int i, best_track;

   475

	uint best_bird_dist = 0;

   476

	uint best_length    = 0;

   477

	uint r;

   478

	byte ship_dir = v->direction & 3;

   479

   480

	pfs.dest_coords = v->dest_tile;

   481

	pfs.skiptile = skiptile;

   482

   483

	best_track = -1;

   484

   485

	do {

   486

		i = FIND_FIRST_BIT(bits);

   487

		bits = KILL_FIRST_BIT(bits);

   488

   489

		pfs.best_bird_dist = (uint)-1;

   490

		pfs.best_length = (uint)-1;

   491

   492

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

   493

   494

		if (best_track >= 0) {

   495

			if (pfs.best_bird_dist != 0) {

   496

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

   497

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   498

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   499

			} else {

   500

				if (pfs.best_length > best_length) goto bad;

   501

				if (pfs.best_length < best_length) goto good;

   502

			}

   503