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 const TileIndexDiffC _dock_offs[] = {

   194

	{ 2,  0},

   195

	{-2,  0},

   196

	{ 0,  2},

   197

	{ 2,  0},

   198

	{ 0, -2},

   199

	{ 0,  0},

   200

	{ 0,  0},

   201

	{ 0,  0}

   202

};

   203

   204

static void ProcessShipOrder(Vehicle *v)

   205

{

   206

	const Order *order;

   207

   208

	switch (v->current_order.type) {

   209

		case OT_GOTO_DEPOT:

   210

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

   211

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

   212

					!VehicleNeedsService(v)) {

   213

				v->cur_order_index++;

   214

			}

   215

			break;

   216

   217

		case OT_LOADING:

   218

		case OT_LEAVESTATION:

   219

			return;

   220

	}

   221

   222

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

   223

   224

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

   225

   226

	if (order == NULL) {

   227

		v->current_order.type  = OT_NOTHING;

   228

		v->current_order.flags = 0;

   229

		v->dest_tile = 0;

   230

		return;

   231

	}

   232

   233

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

   234

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

   235

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

   236

		return;

   237

   238

	v->current_order = *order;

   239

   240

	if (order->type == OT_GOTO_STATION) {

   241

		const Station *st;

   242

   243

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

   244

			v->last_station_visited = INVALID_STATION;

   245

   246

		st = GetStation(order->station);

   247

		if (st->dock_tile != 0) {

   248

			v->dest_tile = TILE_ADD(st->dock_tile, ToTileIndexDiff(_dock_offs[_m[st->dock_tile].m5-0x4B]));

   249

		}

   250

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

   251

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

   252

	} else {

   253

		v->dest_tile = 0;

   254

	}

   255

   256

	InvalidateVehicleOrder(v);

   257

   258

	InvalidateWindowClasses(WC_SHIPS_LIST);

   259

}

   260

   261

static void HandleShipLoading(Vehicle *v)

   262

{

   263

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

   264

   265

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

   266

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

   267

		if (--v->load_unload_time_rem) return;

   268

   269

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

   270

			SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   271

			if (LoadUnloadVehicle(v)) {

   272

				InvalidateWindow(WC_SHIPS_LIST, v->owner);

   273

				MarkShipDirty(v);

   274

			}

   275

			return;

   276

		}

   277

		PlayShipSound(v);

   278

   279

		{

   280

			Order b = v->current_order;

   281

			v->current_order.type = OT_LEAVESTATION;

   282

			v->current_order.flags = 0;

   283

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

   284

		}

   285

	}

   286

   287

	v->cur_order_index++;

   288

	InvalidateVehicleOrder(v);

   289

}

   290

   291

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   292

{

   293

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

   294

	static const uint32 _delta_xy_table[8] = {

   295

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

   296

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

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

	};

   304

#undef MKIT

   305

	uint32 x = _delta_xy_table[dir];

   306

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

   307

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

   308

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

   309

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

   310

}

   311

   312

static void RecalcShipStuff(Vehicle *v)

   313

{

   314

	UpdateShipDeltaXY(v, v->direction);

   315

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

   316

	MarkShipDirty(v);

   317

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   318

}

   319

   320

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   321

	{-1,  0},

   322

	{ 0, -1}

   323

};

   324

   325

static void CheckShipLeaveDepot(Vehicle *v)

   326

{

   327

	TileIndex tile;

   328

	Axis axis;

   329

	uint m;

   330

   331

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

   332

   333

	tile = v->tile;

   334

	axis = GetShipDepotAxis(tile);

   335

   336

	// Check first side

   337

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

   338

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

   339

	// Check second side

   340

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

   341

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

   342

	} else {

   343

		return;

   344

	}

   345

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

   346

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

   347

	v->vehstatus &= ~VS_HIDDEN;

   348

   349

	v->cur_speed = 0;

   350

	RecalcShipStuff(v);

   351

   352

	PlayShipSound(v);

   353

	VehicleServiceInDepot(v);

   354

	InvalidateWindowClasses(WC_SHIPS_LIST);

   355

}

   356

   357

static bool ShipAccelerate(Vehicle *v)

   358

{

   359

	uint spd;

   360

	byte t;

   361

   362

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

   363

   364

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

   365

	if (spd != v->cur_speed) {

   366

		v->cur_speed = spd;

   367

		if (_patches.vehicle_speed)

   368

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

   369

	}

   370

   371

	// Decrease somewhat when turning

   372

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

   373

   374

	if (spd == 0) return false;

   375

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

   376

   377

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

   378

   379

	return (t < v->progress);

   380

}

   381

   382

static int32 EstimateShipCost(EngineID engine_type)

   383

{

   384

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

   385

}

   386

   387

static void ShipEnterDepot(Vehicle *v)

   388

{

   389

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

   390

	v->vehstatus |= VS_HIDDEN;

   391

	v->cur_speed = 0;

   392

	RecalcShipStuff(v);

   393

   394

	VehicleServiceInDepot(v);

   395

   396

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   397

   398

	TriggerVehicle(v, VEHICLE_TRIGGER_DEPOT);

   399

   400

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

   401

		Order t;

   402

   403

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   404

   405

		t = v->current_order;

   406

		v->current_order.type = OT_DUMMY;

   407

		v->current_order.flags = 0;

   408

   409

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

   410

			v->cur_order_index++;

   411

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

   412

			v->vehstatus |= VS_STOPPED;

   413

			if (v->owner == _local_player) {

   414

				SetDParam(0, v->unitnumber);

   415

				AddNewsItem(

   416

					STR_981C_SHIP_IS_WAITING_IN_DEPOT,

   417

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

   418

					v->index,

   419

					0);

   420

			}

   421

		}

   422

	}

   423

	InvalidateWindowClasses(WC_SHIPS_LIST);

   424

}

   425

   426

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

   427

{

   428

	/* Check if station was ever visited before */

   429

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

   430

		uint32 flags;

   431

   432

		st->had_vehicle_of_type |= HVOT_SHIP;

   433

   434

		SetDParam(0, st->index);

   435

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

   436

		AddNewsItem(

   437

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   438

			flags,

   439

			v->index,

   440

			0);

   441

	}

   442

}

   443

   444

typedef struct {

   445

	TileIndex skiptile;

   446

	TileIndex dest_coords;

   447

	uint best_bird_dist;

   448

	uint best_length;

   449

} PathFindShip;

   450

   451

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

   452

{

   453

	// Found dest?

   454

	if (tile == pfs->dest_coords) {

   455

		pfs->best_bird_dist = 0;

   456

   457

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

   458

		return true;

   459

	}

   460

   461

	// Skip this tile in the calculation

   462

	if (tile != pfs->skiptile) {

   463

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

   464

	}

   465

   466

	return false;

   467

}

   468

   469

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

   470

	{ 0, 9, 2, 9 },

   471

	{ 9, 1, 9, 3 },

   472

	{ 9, 0, 3, 9 },

   473

	{ 1, 9, 9, 2 },

   474

	{ 3, 2, 9, 9 },

   475

	{ 9, 9, 1, 0 },

   476

};

   477

   478

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

   479

   480

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

   481

{

   482

	PathFindShip pfs;

   483

	int i, best_track;

   484

	uint best_bird_dist = 0;

   485

	uint best_length    = 0;

   486

	uint r;

   487

	byte ship_dir = v->direction & 3;

   488

   489

	pfs.dest_coords = v->dest_tile;

   490

	pfs.skiptile = skiptile;

   491

   492

	best_track = -1;

   493

   494

	do {

   495

		i = FIND_FIRST_BIT(bits);

   496

		bits = KILL_FIRST_BIT(bits);

   497

   498

		pfs.best_bird_dist = (uint)-1;

   499

		pfs.best_length = (uint)-1;

   500

   501

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

   502