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

    13

#include "news.h"

    14

#include "engine.h"

    15

#include "gui.h"

    16

#include "player.h"

    17

#include "sound.h"

    18

#include "npf.h"

    19

#include "depot.h"

    20

#include "vehicle_gui.h"

    21

    22

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

    23

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

    24

    25

static byte GetTileShipTrackStatus(TileIndex tile)

    26

{

    27

	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);

    28

	return r | r >> 8;

    29

}

    30

    31

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

    32

{

    33

	int spritenum = ShipVehInfo(engine)->image_index;

    34

    35

	if (is_custom_sprite(spritenum)) {

    36

		int sprite = GetCustomVehicleIcon(engine, 6);

    37

    38

		if (sprite) {

    39

			DrawSprite(sprite | image_ormod, x, y);

    40

			return;

    41

		}

    42

		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;

    43

	}

    44

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

    45

}

    46

    47

int GetShipImage(const Vehicle *v, byte direction)

    48

{

    49

	int spritenum = v->spritenum;

    50

    51

	if (is_custom_sprite(spritenum)) {

    52

		int sprite = GetCustomVehicleSprite(v, direction);

    53

    54

		if (sprite) return sprite;

    55

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

    56

	}

    57

	return _ship_sprites[spritenum] + direction;

    58

}

    59

    60

static Depot *FindClosestShipDepot(Vehicle *v)

    61

{

    62

	Depot *depot;

    63

	Depot *best_depot = NULL;

    64

	uint dist;

    65

	uint best_dist = (uint)-1;

    66

	TileIndex tile;

    67

	TileIndex tile2 = v->tile;

    68

    69

	if (_patches.new_pathfinding_all) {

    70

		NPFFoundTargetData ftd;

    71

		byte trackdir = GetVehicleTrackdir(v);

    72

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

    73

		if (ftd.best_bird_dist == 0)

    74

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

    75

		else

    76

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

    77

	} else {

    78

		FOR_ALL_DEPOTS(depot) {

    79

			tile = depot->xy;

    80

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

    81

				dist = DistanceManhattan(tile, tile2);

    82

				if (dist < best_dist) {

    83

					best_dist = dist;

    84

					best_depot = depot;

    85

				}

    86

			}

    87

		}

    88

	}

    89

	return best_depot;

    90

}

    91

    92

static void CheckIfShipNeedsService(Vehicle *v)

    93

{

    94

	Depot *depot;

    95

    96

	if (_patches.servint_ships == 0)

    97

		return;

    98

    99

	if (!VehicleNeedsService(v))

   100

		return;

   101

   102

	if (v->vehstatus & VS_STOPPED)

   103

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

   110

		return;

   111

   112

	depot = FindClosestShipDepot(v);

   113

   114

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

   115

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

   116

			v->current_order.type = OT_DUMMY;

   117

			v->current_order.flags = 0;

   118

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

   119

		}

   120

		return;

   121

	}

   122

   123

	v->current_order.type = OT_GOTO_DEPOT;

   124

	v->current_order.flags = OF_NON_STOP;

   125

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

   126

	v->dest_tile = depot->xy;

   127

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

   128

}

   129

   130

void OnNewDay_Ship(Vehicle *v)

   131

{

   132

	int32 cost;

   133

   134

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

   135

		DecreaseVehicleValue(v);

   136

   137

	CheckVehicleBreakdown(v);

   138

	AgeVehicle(v);

   139

	CheckIfShipNeedsService(v);

   140

   141

	CheckOrders(v->index, OC_INIT);

   142

   143

	if (v->vehstatus & VS_STOPPED)

   144

		return;

   145

   146

   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)

   177

				u->u.special.unk0 = v->breakdown_delay * 2;

   178

		}

   179

	}

   180

   181

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

   182

		if (!--v->breakdown_delay) {

   183

			v->breakdown_ctr = 0;

   184

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   185

		}

   186

	}

   187

}

   188

   189

static void MarkShipDirty(Vehicle *v)

   190

{

   191

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

   192

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

   193

}

   194

   195

static void PlayShipSound(Vehicle *v)

   196

{

   197

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

   198

}

   199

   200

static const TileIndexDiffC _dock_offs[] = {

   201

	{ 2,  0},

   202

	{-2,  0},

   203

	{ 0,  2},

   204

	{ 2,  0},

   205

	{ 0, -2},

   206

	{ 0,  0},

   207

	{ 0,  0},

   208

	{ 0,  0}

   209

};

   210

   211

static void ProcessShipOrder(Vehicle *v)

   212

{

   213

	const Order *order;

   214

   215

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

   216

			v->current_order.type <= OT_LEAVESTATION) {

   217

		if (v->current_order.type != OT_GOTO_DEPOT ||

   218

				!(v->current_order.flags & OF_UNLOAD))

   219

			return;

   220

	}

   221

   222

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

   223

			(v->current_order.flags & (OF_PART_OF_ORDERS | OF_SERVICE_IF_NEEDED)) == (OF_PART_OF_ORDERS | OF_SERVICE_IF_NEEDED) &&

   224

			!VehicleNeedsService(v)) {

   225

		v->cur_order_index++;

   226

	}

   227

   228

   229

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

   230

		v->cur_order_index = 0;

   231

   232

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

   233

   234

	if (order == NULL) {

   235

		v->current_order.type  = OT_NOTHING;

   236

		v->current_order.flags = 0;

   237

		v->dest_tile = 0;

   238

		return;

   239

	}

   240

   241

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

   242

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

   243

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

   244

		return;

   245

   246

	v->current_order = *order;

   247

   248

	if (order->type == OT_GOTO_STATION) {

   249

		const Station *st;

   250

   251

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

   252

			v->last_station_visited = INVALID_STATION;

   253

   254

		st = GetStation(order->station);

   255

		if (st->dock_tile != 0) {

   256

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

   257

		}

   258

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

   259

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

   260

	} else {

   261

		v->dest_tile = 0;

   262

	}

   263

   264

	InvalidateVehicleOrder(v);

   265

   266

	InvalidateWindowClasses(WC_SHIPS_LIST);

   267

}

   268

   269

static void HandleShipLoading(Vehicle *v)

   270

{

   271

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

   272

		return;

   273

   274

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

   275

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

   276

			return;

   277

   278

		if (--v->load_unload_time_rem)

   279

			return;

   280

   281

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

   282

			SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   283

			if (LoadUnloadVehicle(v)) {

   284

				InvalidateWindow(WC_SHIPS_LIST, v->owner);

   285

				MarkShipDirty(v);

   286

			}

   287

			return;

   288

		}

   289

		PlayShipSound(v);

   290

   291

		{

   292

			Order b = v->current_order;

   293

			v->current_order.type = OT_LEAVESTATION;

   294

			v->current_order.flags = 0;

   295

			if (!(b.flags & OF_NON_STOP))

   296

				return;

   297

		}

   298

	}

   299

   300

	v->cur_order_index++;

   301

	InvalidateVehicleOrder(v);

   302

}

   303

   304

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   305

{

   306

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

   307

	static const uint32 _delta_xy_table[8] = {

   308

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

   309

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

   310

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

   311

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

   312

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

   313

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

   314

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

   315

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

   316

	};

   317

#undef MKIT

   318

	uint32 x = _delta_xy_table[dir];

   319

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

   320

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

   321

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

   322

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

   323

}

   324

   325

static void RecalcShipStuff(Vehicle *v)

   326

{

   327

	UpdateShipDeltaXY(v, v->direction);

   328

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

   329

	MarkShipDirty(v);

   330

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   331

}

   332

   333

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   334

	{-1,  0},

   335

	{ 0, -1}

   336

};

   337

   338

static void CheckShipLeaveDepot(Vehicle *v)

   339

{

   340

	TileIndex tile;

   341

	int d;

   342

	uint m;

   343

   344

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

   345

		return;

   346

   347

	tile = v->tile;

   348

	d = (_m[tile].m5&2) ? 1 : 0;

   349

   350

	// Check first side

   351

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

   352

		m = (d==0) ? 0x101 : 0x207;

   353

	// Check second side

   354

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

   355

		m = (d==0) ? 0x105 : 0x203;

   356

	} else {

   357

		return;

   358

	}

   359

	v->direction = (byte)m;

   360

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

   361

	v->vehstatus &= ~VS_HIDDEN;

   362

   363

	v->cur_speed = 0;

   364

	RecalcShipStuff(v);

   365

   366

	PlayShipSound(v);

   367

	VehicleServiceInDepot(v);

   368

	InvalidateWindowClasses(WC_SHIPS_LIST);

   369

}

   370

   371

static bool ShipAccelerate(Vehicle *v)

   372

{

   373

	uint spd;

   374

	byte t;

   375

   376

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

   377

   378

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

   379

	if (spd != v->cur_speed) {

   380

		v->cur_speed = spd;

   381

		if (_patches.vehicle_speed)

   382

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

   383

	}

   384

   385

	// Decrease somewhat when turning

   386

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

   387

		spd = spd * 3 >> 2;

   388

	}

   389

   390

	if (spd == 0)

   391

		return false;

   392

   393

	if ((byte)++spd == 0)

   394

		return true;

   395

   396

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

   397

   398

	return (t < v->progress);

   399

}

   400

   401

int32 EstimateShipCost(EngineID engine_type)

   402

{

   403

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

   404

}

   405

   406

static void ShipEnterDepot(Vehicle *v)

   407

{

   408

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

   409

	v->vehstatus |= VS_HIDDEN;

   410

	v->cur_speed = 0;

   411

	RecalcShipStuff(v);

   412

   413

	VehicleServiceInDepot(v);

   414

   415

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   416

   417

	TriggerVehicle(v, VEHICLE_TRIGGER_DEPOT);

   418

   419

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

   420

		Order t;

   421

   422

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   423

   424

		t = v->current_order;

   425

		v->current_order.type = OT_DUMMY;

   426

		v->current_order.flags = 0;

   427

   428

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

   429

			v->cur_order_index++;

   430

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

   431

			v->vehstatus |= VS_STOPPED;

   432

			if (v->owner == _local_player) {

   433

				SetDParam(0, v->unitnumber);

   434

				AddNewsItem(

   435

					STR_981C_SHIP_IS_WAITING_IN_DEPOT,

   436

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

   437

					v->index,

   438

					0);

   439

			}

   440

		}

   441

	}

   442

	InvalidateWindowClasses(WC_SHIPS_LIST);

   443

}

   444

   445

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

   446

{

   447

	/* Check if station was ever visited before */

   448

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

   449

		uint32 flags;

   450

		st->had_vehicle_of_type |= HVOT_SHIP;

   451

		SetDParam(0, st->index);

   452

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

   453

		AddNewsItem(

   454

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   455

			flags,

   456

			v->index,

   457

			0);

   458

	}

   459

}

   460

   461

typedef struct {

   462

	TileIndex skiptile;

   463

	TileIndex dest_coords;

   464

	uint best_bird_dist;

   465

	uint best_length;

   466

} PathFindShip;

   467

   468

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

   469

{

   470

	// Found dest?

   471

	if (tile == pfs->dest_coords) {

   472

		pfs->best_bird_dist = 0;

   473

   474

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

   475

		return true;

   476

	}

   477

   478

	// Skip this tile in the calculation

   479

	if (tile != pfs->skiptile) {

   480

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

   481

	}

   482

   483

	return false;

   484

}

   485

   486

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

   487

	{ 0, 9, 2, 9 },

   488

	{ 9, 1, 9, 3 },

   489

	{ 9, 0, 3, 9 },

   490

	{ 1, 9, 9, 2 },

   491

	{ 3, 2, 9, 9 },

   492

	{ 9, 9, 1, 0 },

   493

};

   494

   495

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

   496

   497

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

   498

{

   499

	PathFindShip pfs;

   500

	int i, best_track;

   501

	uint best_bird_dist = 0;

   502

	uint best_length    = 0;

   503

	uint r;

   504

	byte ship_dir = v->direction & 3;

   505

   506

	pfs.dest_coords = v->dest_tile;