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

    29

    30

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

    31

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

    32

    33

static byte GetTileShipTrackStatus(TileIndex tile)

    34

{

    35

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);

    36

	return r | r >> 8;

    37

}

    38

    39

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

    40

{

    41

	int spritenum = ShipVehInfo(engine)->image_index;

    42

    43

	if (is_custom_sprite(spritenum)) {

    44

		int sprite = GetCustomVehicleIcon(engine, DIR_W);

    45

    46

		if (sprite != 0) {

    47

			DrawSprite(sprite | image_ormod, x, y);

    48

			return;

    49

		}

    50

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    51

	}

    52

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

    53

}

    54

    55

int GetShipImage(const Vehicle* v, Direction direction)

    56

{

    57

	int spritenum = v->spritenum;

    58

    59

	if (is_custom_sprite(spritenum)) {

    60

		int sprite = GetCustomVehicleSprite(v, direction);

    61

    62

		if (sprite != 0) return sprite;

    63

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

    64

	}

    65

	return _ship_sprites[spritenum] + direction;

    66

}

    67

    68

static const Depot* FindClosestShipDepot(const Vehicle* v)

    69

{

    70

	const Depot* depot;

    71

	const Depot* best_depot = NULL;

    72

	uint dist;

    73

	uint best_dist = (uint)-1;

    74

	TileIndex tile;

    75

	TileIndex tile2 = v->tile;

    76

    77

	if (_patches.new_pathfinding_all) {

    78

		NPFFoundTargetData ftd;

    79

		byte trackdir = GetVehicleTrackdir(v);

    80

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

    81

		if (ftd.best_bird_dist == 0) {

    82

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

    83

		} else {

    84

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

    85

		}

    86

	} else {

    87

		FOR_ALL_DEPOTS(depot) {

    88

			tile = depot->xy;

    89

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

    90

				dist = DistanceManhattan(tile, tile2);

    91

				if (dist < best_dist) {

    92

					best_dist = dist;

    93

					best_depot = depot;

    94

				}

    95

			}

    96

		}

    97

	}

    98

	return best_depot;

    99

}

   100

   101

static void CheckIfShipNeedsService(Vehicle *v)

   102

{

   103

	const Depot* depot;

   104

   105

	if (_patches.servint_ships == 0) return;

   106

	if (!VehicleNeedsService(v))     return;

   107

	if (v->vehstatus & VS_STOPPED)   return;

   108

   109

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

   110

			v->current_order.flags & OF_HALT_IN_DEPOT)

   111

		return;

   112

   113

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

   114

   115

	depot = FindClosestShipDepot(v);

   116

   117

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

   118

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

   119

			v->current_order.type = OT_DUMMY;

   120

			v->current_order.flags = 0;

   121

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

   122

		}

   123

		return;

   124

	}

   125

   126

	v->current_order.type = OT_GOTO_DEPOT;

   127

	v->current_order.flags = OF_NON_STOP;

   128

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

   129

	v->dest_tile = depot->xy;

   130

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

   131

}

   132

   133

void OnNewDay_Ship(Vehicle *v)

   134

{

   135

	int32 cost;

   136

   137

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

   138

		DecreaseVehicleValue(v);

   139

   140

	CheckVehicleBreakdown(v);

   141

	AgeVehicle(v);

   142

	CheckIfShipNeedsService(v);

   143

   144

	CheckOrders(v);

   145

   146

	if (v->vehstatus & VS_STOPPED) return;

   147

   148

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

   149

	v->profit_this_year -= cost >> 8;

   150

   151

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   152

	SubtractMoneyFromPlayerFract(v->owner, cost);

   153

   154

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   155

	//we need this for the profit

   156

	InvalidateWindowClasses(WC_SHIPS_LIST);

   157

}

   158

   159

static void HandleBrokenShip(Vehicle *v)

   160

{

   161

	if (v->breakdown_ctr != 1) {

   162

		v->breakdown_ctr = 1;

   163

		v->cur_speed = 0;

   164

   165

		if (v->breakdowns_since_last_service != 255)

   166

			v->breakdowns_since_last_service++;

   167

   168

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   169

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   170

   171

		SndPlayVehicleFx((_opt.landscape != LT_CANDY) ?

   172

			SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   173

   174

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

   175

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

   176

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

   177

		}

   178

	}

   179

   180

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

   181

		if (!--v->breakdown_delay) {

   182

			v->breakdown_ctr = 0;

   183

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   184

		}

   185

	}

   186

}

   187

   188

static void MarkShipDirty(Vehicle *v)

   189

{

   190

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

   191

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

   192

}

   193

   194

static void PlayShipSound(Vehicle *v)

   195

{

   196

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

   197

}

   198

   199

static void ProcessShipOrder(Vehicle *v)

   200

{

   201

	const Order *order;

   202

   203

	switch (v->current_order.type) {

   204

		case OT_GOTO_DEPOT:

   205

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

   206

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

   207

					!VehicleNeedsService(v)) {

   208

				v->cur_order_index++;

   209

			}

   210

			break;

   211

   212

		case OT_LOADING:

   213

		case OT_LEAVESTATION:

   214

			return;

   215

	}

   216

   217

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

   218

   219

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

   220

   221

	if (order == NULL) {

   222

		v->current_order.type  = OT_NOTHING;

   223

		v->current_order.flags = 0;

   224

		v->dest_tile = 0;

   225

		return;

   226

	}

   227

   228

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

   229

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

   230

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

   231

		return;

   232

   233

	v->current_order = *order;

   234

   235

	if (order->type == OT_GOTO_STATION) {

   236

		const Station *st;

   237

   238

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

   239

			v->last_station_visited = INVALID_STATION;

   240

   241

		st = GetStation(order->station);

   242

		if (st->dock_tile != 0) {

   243

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

   244

		}

   245

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

   246

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

   247

	} else {

   248

		v->dest_tile = 0;

   249

	}

   250

   251

	InvalidateVehicleOrder(v);

   252

   253

	InvalidateWindowClasses(WC_SHIPS_LIST);

   254

}

   255

   256

static void HandleShipLoading(Vehicle *v)

   257

{

   258

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

   259

   260

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

   261

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

   262

		if (--v->load_unload_time_rem) return;

   263

   264

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

   265

			SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   266

			if (LoadUnloadVehicle(v)) {

   267

				InvalidateWindow(WC_SHIPS_LIST, v->owner);

   268

				MarkShipDirty(v);

   269

			}

   270

			return;

   271

		}

   272

		PlayShipSound(v);

   273

   274

		{

   275

			Order b = v->current_order;

   276

			v->current_order.type = OT_LEAVESTATION;

   277

			v->current_order.flags = 0;

   278

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

   279

		}

   280

	}

   281

   282

	v->cur_order_index++;

   283

	InvalidateVehicleOrder(v);

   284

}

   285

   286

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   287

{

   288

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

   289

	static const uint32 _delta_xy_table[8] = {

   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

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

   295

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

   296

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

   297

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

   298

	};

   299

#undef MKIT

   300

	uint32 x = _delta_xy_table[dir];

   301

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

   302

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

   303

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

   304

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

   305

}

   306

   307

static void RecalcShipStuff(Vehicle *v)

   308

{

   309

	UpdateShipDeltaXY(v, v->direction);

   310

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

   311

	MarkShipDirty(v);

   312

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   313

}

   314

   315

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   316

	{-1,  0},

   317

	{ 0, -1}

   318

};

   319

   320

static void CheckShipLeaveDepot(Vehicle *v)

   321

{

   322

	TileIndex tile;

   323

	Axis axis;

   324

	uint m;

   325

   326

	if (!IsShipInDepot(v)) return;

   327

   328

	tile = v->tile;

   329

	axis = GetShipDepotAxis(tile);

   330

   331

	// Check first side

   332

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

   333

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

   334

	// Check second side

   335

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

   336

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

   337

	} else {

   338

		return;

   339

	}

   340

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

   341

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

   342

	v->vehstatus &= ~VS_HIDDEN;

   343

   344

	v->cur_speed = 0;

   345

	RecalcShipStuff(v);

   346

   347

	PlayShipSound(v);

   348

	VehicleServiceInDepot(v);

   349

	InvalidateWindowClasses(WC_SHIPS_LIST);

   350

}

   351

   352

static bool ShipAccelerate(Vehicle *v)

   353

{

   354

	uint spd;

   355

	byte t;

   356

   357

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

   358

   359

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

   360

	if (spd != v->cur_speed) {

   361

		v->cur_speed = spd;

   362

		if (_patches.vehicle_speed)

   363

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

   364

	}

   365

   366

	// Decrease somewhat when turning

   367

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

   368

   369

	if (spd == 0) return false;

   370

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

   371

   372

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

   373

   374

	return (t < v->progress);

   375

}

   376

   377

static int32 EstimateShipCost(EngineID engine_type)

   378

{

   379

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

   380

}

   381

   382

static void ShipEnterDepot(Vehicle *v)

   383

{

   384

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

   385

	v->vehstatus |= VS_HIDDEN;

   386

	v->cur_speed = 0;

   387

	RecalcShipStuff(v);

   388

   389

	VehicleServiceInDepot(v);

   390

   391

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   392

   393

	TriggerVehicle(v, VEHICLE_TRIGGER_DEPOT);

   394

   395

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

   396

		Order t;

   397

   398

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   399

   400

		t = v->current_order;

   401

		v->current_order.type = OT_DUMMY;

   402

		v->current_order.flags = 0;

   403

   404

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

   405

			v->cur_order_index++;

   406

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

   407

			v->vehstatus |= VS_STOPPED;

   408

			if (v->owner == _local_player) {

   409

				SetDParam(0, v->unitnumber);

   410

				AddNewsItem(

   411

					STR_981C_SHIP_IS_WAITING_IN_DEPOT,

   412

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

   413

					v->index,

   414

					0);

   415

			}

   416

		}

   417

	}

   418

	InvalidateWindowClasses(WC_SHIPS_LIST);

   419

}

   420

   421

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

   422

{

   423

	/* Check if station was ever visited before */

   424

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

   425

		uint32 flags;

   426

   427

		st->had_vehicle_of_type |= HVOT_SHIP;

   428

   429

		SetDParam(0, st->index);

   430

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

   431

		AddNewsItem(

   432

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   433

			flags,

   434

			v->index,

   435

			0);

   436

	}

   437

}

   438

   439

typedef struct {

   440

	TileIndex skiptile;

   441

	TileIndex dest_coords;

   442

	uint best_bird_dist;

   443

	uint best_length;

   444

} PathFindShip;

   445

   446

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

   447

{

   448

	// Found dest?

   449

	if (tile == pfs->dest_coords) {

   450

		pfs->best_bird_dist = 0;

   451

   452

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

   453

		return true;

   454

	}

   455

   456

	// Skip this tile in the calculation

   457

	if (tile != pfs->skiptile) {

   458

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

   459

	}

   460

   461

	return false;

   462

}

   463

   464

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

   465

	{ 0, 9, 2, 9 },

   466

	{ 9, 1, 9, 3 },

   467

	{ 9, 0, 3, 9 },

   468

	{ 1, 9, 9, 2 },

   469

	{ 3, 2, 9, 9 },

   470

	{ 9, 9, 1, 0 },

   471

};

   472

   473

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

   474

   475

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

   476

{

   477

	PathFindShip pfs;

   478

	int i, best_track;

   479

	uint best_bird_dist = 0;

   480

	uint best_length    = 0;

   481

	uint r;

   482

	byte ship_dir = v->direction & 3;

   483

   484

	pfs.dest_coords = v->dest_tile;

   485

	pfs.skiptile = skiptile;

   486

   487

	best_track = -1;

   488

   489

	do {

   490

		i = FIND_FIRST_BIT(bits);

   491

		bits = KILL_FIRST_BIT(bits);

   492

   493

		pfs.best_bird_dist = (uint)-1;

   494

		pfs.best_length = (uint)-1;

   495

   496

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

   497

   498

		if (best_track >= 0) {

   499

			if (pfs.best_bird_dist != 0) {

   500

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

   501

				if (pfs.best_bird_dist > best_bird_dist) goto bad;

   502

				if (pfs.best_bird_dist < best_bird_dist) goto good;