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

    24

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

    25

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

    26

    27

static byte GetTileShipTrackStatus(TileIndex tile)

    28

{

    29

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);

    30

	return r | r >> 8;

    31

}

    32

    33

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

    34

{

    35

	int spritenum = ShipVehInfo(engine)->image_index;

    36

    37

	if (is_custom_sprite(spritenum)) {

    38

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    39

    40

		if (sprite != 0) {

    41

			DrawSprite(sprite | image_ormod, x, y);

    42

			return;

    43

		}

    44

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    45

	}

    46

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

    47

}

    48

    49

int GetShipImage(const Vehicle* v, Direction direction)

    50

{

    51

	int spritenum = v->spritenum;

    52

    53

	if (is_custom_sprite(spritenum)) {

    54

		int sprite = GetCustomVehicleSprite(v, direction);

    55

    56

		if (sprite != 0) return sprite;

    57

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

    58

	}

    59

	return _ship_sprites[spritenum] + direction;

    60

}

    61

    62

static const Depot* FindClosestShipDepot(const Vehicle* v)

    63

{

    64

	const Depot* depot;

    65

	const Depot* best_depot = NULL;

    66

	uint dist;

    67

	uint best_dist = (uint)-1;

    68

	TileIndex tile;

    69

	TileIndex tile2 = v->tile;

    70

    71

	if (_patches.new_pathfinding_all) {

    72

		NPFFoundTargetData ftd;

    73

		byte trackdir = GetVehicleTrackdir(v);

    74

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

    75

		if (ftd.best_bird_dist == 0) {

    76

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

    77

		} else {

    78

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

    79

		}

    80

	} else {

    81

		FOR_ALL_DEPOTS(depot) {

    82

			tile = depot->xy;

    83

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

    84

				dist = DistanceManhattan(tile, tile2);

    85

				if (dist < best_dist) {

    86

					best_dist = dist;

    87

					best_depot = depot;

    88

				}

    89

			}

    90

		}

    91

	}

    92

	return best_depot;

    93

}

    94

    95

static void CheckIfShipNeedsService(Vehicle *v)

    96

{

    97

	const Depot* depot;

    98

    99

	if (_patches.servint_ships == 0) return;

   100

	if (!VehicleNeedsService(v))     return;

   101

	if (v->vehstatus & VS_STOPPED)   return;

   102

   103

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

   104

			v->current_order.flags & OF_HALT_IN_DEPOT)

   105

		return;

   106

   107

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

   108

   109

	depot = FindClosestShipDepot(v);

   110

   111

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

   112

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

   113

			v->current_order.type = OT_DUMMY;

   114

			v->current_order.flags = 0;

   115

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

   116

		}

   117

		return;

   118

	}

   119

   120

	v->current_order.type = OT_GOTO_DEPOT;

   121

	v->current_order.flags = OF_NON_STOP;

   122

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

   123

	v->dest_tile = depot->xy;

   124

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

   125

}

   126

   127

void OnNewDay_Ship(Vehicle *v)

   128

{

   129

	int32 cost;

   130

   131

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

   132

		DecreaseVehicleValue(v);

   133

   134

	CheckVehicleBreakdown(v);

   135

	AgeVehicle(v);

   136

	CheckIfShipNeedsService(v);

   137

   138

	CheckOrders(v);

   139

   140

	if (v->vehstatus & VS_STOPPED) return;

   141

   142

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

   143

	v->profit_this_year -= cost >> 8;

   144

   145

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   146

	SubtractMoneyFromPlayerFract(v->owner, cost);

   147

   148

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   149

	//we need this for the profit

   150

	InvalidateWindowClasses(WC_SHIPS_LIST);

   151

}

   152

   153

static void HandleBrokenShip(Vehicle *v)

   154

{

   155

	if (v->breakdown_ctr != 1) {

   156

		v->breakdown_ctr = 1;

   157

		v->cur_speed = 0;

   158

   159

		if (v->breakdowns_since_last_service != 255)

   160

			v->breakdowns_since_last_service++;

   161

   162

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   163

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   164

   165

		SndPlayVehicleFx((_opt.landscape != LT_CANDY) ?

   166

			SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   167

   168

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

   169

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

   170

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

   171

		}

   172

	}

   173

   174

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

   175

		if (!--v->breakdown_delay) {

   176

			v->breakdown_ctr = 0;

   177

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   178

		}

   179

	}

   180

}

   181

   182

static void MarkShipDirty(Vehicle *v)

   183

{

   184

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

   185

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

   186

}

   187

   188

static void PlayShipSound(Vehicle *v)

   189

{

   190

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

   191

}

   192

   193

static void ProcessShipOrder(Vehicle *v)

   194

{

   195

	const Order *order;

   196

   197

	switch (v->current_order.type) {

   198

		case OT_GOTO_DEPOT:

   199

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

   200

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

   201

					!VehicleNeedsService(v)) {

   202

				v->cur_order_index++;

   203

			}

   204

			break;

   205

   206

		case OT_LOADING:

   207

		case OT_LEAVESTATION:

   208

			return;

   209

	}

   210

   211

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

   212

   213

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

   214

   215

	if (order == NULL) {

   216

		v->current_order.type  = OT_NOTHING;

   217

		v->current_order.flags = 0;

   218

		v->dest_tile = 0;

   219

		return;

   220

	}

   221

   222

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

   223

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

   224

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

   225

		return;

   226

   227

	v->current_order = *order;

   228

   229

	if (order->type == OT_GOTO_STATION) {

   230

		const Station *st;

   231

   232

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

   233

			v->last_station_visited = INVALID_STATION;

   234

   235

		st = GetStation(order->station);

   236

		if (st->dock_tile != 0) {

   237

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

   238

		}

   239

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

   240

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

   241

	} else {

   242

		v->dest_tile = 0;

   243

	}

   244

   245

	InvalidateVehicleOrder(v);

   246

   247

	InvalidateWindowClasses(WC_SHIPS_LIST);

   248

}

   249

   250

static void HandleShipLoading(Vehicle *v)

   251

{

   252

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

   253

   254

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

   255

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

   256

		if (--v->load_unload_time_rem) return;

   257

   258

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

   259

			SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   260

			if (LoadUnloadVehicle(v)) {

   261

				InvalidateWindow(WC_SHIPS_LIST, v->owner);

   262

				MarkShipDirty(v);

   263

			}

   264

			return;

   265

		}

   266

		PlayShipSound(v);

   267

   268

		{

   269

			Order b = v->current_order;

   270

			v->current_order.type = OT_LEAVESTATION;

   271

			v->current_order.flags = 0;

   272

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

   273

		}

   274

	}

   275

   276

	v->cur_order_index++;

   277

	InvalidateVehicleOrder(v);

   278

}

   279

   280

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   281

{

   282

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

   283

	static const uint32 _delta_xy_table[8] = {

   284

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

   285

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

   286

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

   287

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

   288

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

   289

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

   290

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

   291

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

   292

	};

   293

#undef MKIT

   294

	uint32 x = _delta_xy_table[dir];

   295

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

   296

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

   297

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

   298

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

   299

}

   300

   301

static void RecalcShipStuff(Vehicle *v)

   302

{

   303

	UpdateShipDeltaXY(v, v->direction);

   304

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

   305

	MarkShipDirty(v);

   306

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   307

}

   308

   309

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   310

	{-1,  0},

   311

	{ 0, -1}

   312

};

   313

   314

static void CheckShipLeaveDepot(Vehicle *v)

   315

{

   316

	TileIndex tile;

   317

	Axis axis;

   318

	uint m;

   319

   320

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

   321

   322

	tile = v->tile;

   323

	axis = GetShipDepotAxis(tile);

   324

   325

	// Check first side

   326

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

   327

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

   328

	// Check second side

   329

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

   330

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

   331

	} else {

   332

		return;

   333

	}

   334

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

   335

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

   336

	v->vehstatus &= ~VS_HIDDEN;

   337

   338

	v->cur_speed = 0;

   339

	RecalcShipStuff(v);

   340

   341

	PlayShipSound(v);

   342

	VehicleServiceInDepot(v);

   343

	InvalidateWindowClasses(WC_SHIPS_LIST);

   344

}

   345

   346

static bool ShipAccelerate(Vehicle *v)

   347

{

   348

	uint spd;

   349

	byte t;

   350

   351

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

   352

   353

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

   354

	if (spd != v->cur_speed) {

   355

		v->cur_speed = spd;

   356

		if (_patches.vehicle_speed)

   357

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

   358

	}

   359

   360

	// Decrease somewhat when turning

   361

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

   362

   363

	if (spd == 0) return false;

   364

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

   365

   366

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

   367

   368

	return (t < v->progress);

   369

}

   370

   371

static int32 EstimateShipCost(EngineID engine_type)

   372

{

   373

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

   374

}

   375

   376

static void ShipEnterDepot(Vehicle *v)

   377

{

   378

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

   379

	v->vehstatus |= VS_HIDDEN;

   380

	v->cur_speed = 0;

   381

	RecalcShipStuff(v);

   382

   383

	VehicleServiceInDepot(v);

   384

   385

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   386

   387

	TriggerVehicle(v, VEHICLE_TRIGGER_DEPOT);

   388

   389

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

   390

		Order t;

   391

   392

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   393

   394

		t = v->current_order;

   395

		v->current_order.type = OT_DUMMY;

   396

		v->current_order.flags = 0;

   397

   398

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

   399

			v->cur_order_index++;

   400

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

   401

			v->vehstatus |= VS_STOPPED;

   402

			if (v->owner == _local_player) {

   403

				SetDParam(0, v->unitnumber);

   404

				AddNewsItem(

   405

					STR_981C_SHIP_IS_WAITING_IN_DEPOT,

   406

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

   407

					v->index,

   408

					0);

   409

			}

   410

		}

   411

	}

   412

	InvalidateWindowClasses(WC_SHIPS_LIST);

   413

}

   414

   415

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

   416

{

   417

	/* Check if station was ever visited before */

   418

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

   419

		uint32 flags;

   420

   421

		st->had_vehicle_of_type |= HVOT_SHIP;

   422

   423

		SetDParam(0, st->index);

   424

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

   425

		AddNewsItem(

   426

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   427

			flags,

   428

			v->index,

   429

			0);

   430

	}

   431

}

   432

   433

typedef struct {

   434

	TileIndex skiptile;

   435

	TileIndex dest_coords;

   436

	uint best_bird_dist;

   437

	uint best_length;

   438

} PathFindShip;

   439

   440

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

   441

{

   442

	// Found dest?

   443

	if (tile == pfs->dest_coords) {

   444

		pfs->best_bird_dist = 0;

   445

   446

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

   447

		return true;

   448

	}

   449

   450

	// Skip this tile in the calculation

   451

	if (tile != pfs->skiptile) {

   452

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

   453

	}

   454

   455

	return false;

   456

}

   457

   458

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

   459

	{ 0, 9, 2, 9 },

   460

	{ 9, 1, 9, 3 },

   461

	{ 9, 0, 3, 9 },

   462

	{ 1, 9, 9, 2 },

   463

	{ 3, 2, 9, 9 },

   464

	{ 9, 9, 1, 0 },

   465

};

   466

   467

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

   468

   469

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

   470

{

   471

	PathFindShip pfs;

   472

	int i, best_track;

   473

	uint best_bird_dist = 0;

   474

	uint best_length    = 0;

   475

	uint r;

   476

	byte ship_dir = v->direction & 3;

   477

   478

	pfs.dest_coords = v->dest_tile;

   479

	pfs.skiptile = skiptile;

   480

   481

	best_track = -1;

   482

   483

	do {

   484

		i = FIND_FIRST_BIT(bits);

   485

		bits = KILL_FIRST_BIT(bits);

   486

   487

		pfs.best_bird_dist = (uint)-1;

   488

		pfs.best_length = (uint)-1;

   489

   490

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

   491

   492

		if (best_track >= 0) {

   493

			if (pfs.best_bird_dist != 0) {

   494

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

   495

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   496

				if (pfs.best_bird_dist < best_bird_dist) goto good;

   497

			} else {

   498

				if (pfs.best_length > best_length) goto bad;

   499

				if (pfs.best_length < best_length) goto good;

   500

			}

   501

   502

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

   503

			 * pick one randomly. */