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

	if (IsShipInDepot(v)) {

   116

		VehicleServiceInDepot(v);

   117

		return;

   118

	}

   119

   120

	depot = FindClosestShipDepot(v);

   121

   122

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

   123

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

   124

			v->current_order.type = OT_DUMMY;

   125

			v->current_order.flags = 0;

   126

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

   127

		}

   128

		return;

   129

	}

   130

   131

	v->current_order.type = OT_GOTO_DEPOT;

   132

	v->current_order.flags = OF_NON_STOP;

   133

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

   134

	v->dest_tile = depot->xy;

   135

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

   136

}

   137

   138

void OnNewDay_Ship(Vehicle *v)

   139

{

   140

	int32 cost;

   141

   142

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

   143

		DecreaseVehicleValue(v);

   144

   145

	CheckVehicleBreakdown(v);

   146

	AgeVehicle(v);

   147

	CheckIfShipNeedsService(v);

   148

   149

	CheckOrders(v);

   150

   151

	if (v->vehstatus & VS_STOPPED) return;

   152

   153

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

   154

	v->profit_this_year -= cost >> 8;

   155

   156

	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);

   157

	SubtractMoneyFromPlayerFract(v->owner, cost);

   158

   159

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   160

	//we need this for the profit

   161

	InvalidateWindowClasses(WC_SHIPS_LIST);

   162

}

   163

   164

static void HandleBrokenShip(Vehicle *v)

   165

{

   166

	if (v->breakdown_ctr != 1) {

   167

		v->breakdown_ctr = 1;

   168

		v->cur_speed = 0;

   169

   170

		if (v->breakdowns_since_last_service != 255)

   171

			v->breakdowns_since_last_service++;

   172

   173

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   174

		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   175

   176

		SndPlayVehicleFx((_opt.landscape != LT_CANDY) ?

   177

			SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);

   178

   179

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

   180

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

   181

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

   182

		}

   183

	}

   184

   185

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

   186

		if (!--v->breakdown_delay) {

   187

			v->breakdown_ctr = 0;

   188

			InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   189

		}

   190

	}

   191

}

   192

   193

static void MarkShipDirty(Vehicle *v)

   194

{

   195

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

   196

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

   197

}

   198

   199

static void PlayShipSound(Vehicle *v)

   200

{

   201

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

   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

		default: break;

   222

	}

   223

   224

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

   225

   226

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

   227

   228

	if (order == NULL) {

   229

		v->current_order.type  = OT_NOTHING;

   230

		v->current_order.flags = 0;

   231

		v->dest_tile = 0;

   232

		return;

   233

	}

   234

   235

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

   236

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

   237

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

   238

		return;

   239

   240

	v->current_order = *order;

   241

   242

	if (order->type == OT_GOTO_STATION) {

   243

		const Station *st;

   244

   245

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

   246

			v->last_station_visited = INVALID_STATION;

   247

   248

		st = GetStation(order->dest);

   249

		if (st->dock_tile != 0) {

   250

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

   251

		}

   252

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

   253

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

   254

	} else {

   255

		v->dest_tile = 0;

   256

	}

   257

   258

	InvalidateVehicleOrder(v);

   259

   260

	InvalidateWindowClasses(WC_SHIPS_LIST);

   261

}

   262

   263

static void HandleShipLoading(Vehicle *v)

   264

{

   265

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

   266

   267

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

   268

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

   269

		if (--v->load_unload_time_rem) return;

   270

   271

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

   272

			SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);

   273

			if (LoadUnloadVehicle(v)) {

   274

				InvalidateWindow(WC_SHIPS_LIST, v->owner);

   275

				MarkShipDirty(v);

   276

			}

   277

			return;

   278

		}

   279

		PlayShipSound(v);

   280

   281

		{

   282

			Order b = v->current_order;

   283

			v->current_order.type = OT_LEAVESTATION;

   284

			v->current_order.flags = 0;

   285

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

   286

		}

   287

	}

   288

   289

	v->cur_order_index++;

   290

	InvalidateVehicleOrder(v);

   291

}

   292

   293

static void UpdateShipDeltaXY(Vehicle *v, int dir)

   294

{

   295

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

   296

	static const uint32 _delta_xy_table[8] = {

   297

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

   298

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

   299

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

   300

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

   301

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

   302

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

   303

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

   304

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

   305

	};

   306

#undef MKIT

   307

	uint32 x = _delta_xy_table[dir];

   308

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

   309

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

   310

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

   311

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

   312

}

   313

   314

static void RecalcShipStuff(Vehicle *v)

   315

{

   316

	UpdateShipDeltaXY(v, v->direction);

   317

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

   318

	MarkShipDirty(v);

   319

	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);

   320

}

   321

   322

static const TileIndexDiffC _ship_leave_depot_offs[] = {

   323

	{-1,  0},

   324

	{ 0, -1}

   325

};

   326

   327

static void CheckShipLeaveDepot(Vehicle *v)

   328

{

   329

	TileIndex tile;

   330

	Axis axis;

   331

	uint m;

   332

   333

	if (!IsShipInDepot(v)) return;

   334

   335

	tile = v->tile;

   336

	axis = GetShipDepotAxis(tile);

   337

   338

	// Check first side

   339

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

   340

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

   341

	// Check second side

   342

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

   343

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

   344

	} else {

   345

		return;

   346

	}

   347

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

   348

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

   349

	v->vehstatus &= ~VS_HIDDEN;

   350

   351

	v->cur_speed = 0;

   352

	RecalcShipStuff(v);

   353

   354

	PlayShipSound(v);

   355

	VehicleServiceInDepot(v);

   356

	InvalidateWindowClasses(WC_SHIPS_LIST);

   357

}

   358

   359

static bool ShipAccelerate(Vehicle *v)

   360

{

   361

	uint spd;

   362

	byte t;

   363

   364

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

   365

   366

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

   367

	if (spd != v->cur_speed) {

   368

		v->cur_speed = spd;

   369

		if (_patches.vehicle_speed)

   370

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

   371

	}

   372

   373

	// Decrease somewhat when turning

   374

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

   375

   376

	if (spd == 0) return false;

   377

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

   378

   379

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

   380

   381

	return (t < v->progress);

   382

}

   383

   384

static int32 EstimateShipCost(EngineID engine_type)

   385

{

   386

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

   387

}

   388

   389

static void ShipEnterDepot(Vehicle *v)

   390

{

   391

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

   392

	v->vehstatus |= VS_HIDDEN;

   393

	v->cur_speed = 0;

   394

	RecalcShipStuff(v);

   395

   396

	VehicleServiceInDepot(v);

   397

   398

	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);

   399

   400

	TriggerVehicle(v, VEHICLE_TRIGGER_DEPOT);

   401

   402

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

   403

		Order t;

   404

   405

		InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   406

   407

		t = v->current_order;

   408

		v->current_order.type = OT_DUMMY;

   409

		v->current_order.flags = 0;

   410

   411

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

   412

			v->cur_order_index++;

   413

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

   414

			v->vehstatus |= VS_STOPPED;

   415

			if (v->owner == _local_player) {

   416

				SetDParam(0, v->unitnumber);

   417

				AddNewsItem(

   418

					STR_981C_SHIP_IS_WAITING_IN_DEPOT,

   419

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

   420

					v->index,

   421

					0);

   422

			}

   423

		}

   424

	}

   425

	InvalidateWindowClasses(WC_SHIPS_LIST);

   426

}

   427

   428

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

   429

{

   430

	/* Check if station was ever visited before */

   431

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

   432

		uint32 flags;

   433

   434

		st->had_vehicle_of_type |= HVOT_SHIP;

   435

   436

		SetDParam(0, st->index);

   437

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

   438

		AddNewsItem(

   439

			STR_9833_CITIZENS_CELEBRATE_FIRST,

   440

			flags,

   441

			v->index,

   442

			0);

   443

	}

   444

}

   445

   446

typedef struct {

   447

	TileIndex skiptile;

   448

	TileIndex dest_coords;

   449

	uint best_bird_dist;

   450

	uint best_length;

   451

} PathFindShip;

   452

   453

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

   454

{

   455

	// Found dest?

   456

	if (tile == pfs->dest_coords) {

   457

		pfs->best_bird_dist = 0;

   458

   459

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

   460

		return true;

   461

	}

   462

   463

	// Skip this tile in the calculation

   464

	if (tile != pfs->skiptile) {

   465

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

   466

	}

   467

   468

	return false;

   469

}

   470

   471

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

   472

	{ 0, 9, 2, 9 },

   473

	{ 9, 1, 9, 3 },

   474

	{ 9, 0, 3, 9 },

   475

	{ 1, 9, 9, 2 },

   476

	{ 3, 2, 9, 9 },

   477

	{ 9, 9, 1, 0 },

   478

};

   479

   480

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

   481

   482

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

   483

{

   484

	PathFindShip pfs;

   485

	int i, best_track;

   486

	uint best_bird_dist = 0;

   487

	uint best_length    = 0;

   488

	uint r;

   489

	byte ship_dir = v->direction & 3;

   490

   491

	pfs.dest_coords = v->dest_tile;

   492

	pfs.skiptile = skiptile;

   493

   494

	best_track = -1;

   495

   496

	do {

   497

		i = FIND_FIRST_BIT(bits);

   498

		bits = KILL_FIRST_BIT(bits);

   499

   500

		pfs.best_bird_dist = (uint)-1;

   501

		pfs.best_length = (uint)-1;