tron@2186: /* $Id$ */
tron@2186: 
rubidium@9111: /** @file ship_cmd.cpp Handling of ships. */
belugas@6420: 
truelight@0: #include "stdafx.h"
Darkvater@1891: #include "openttd.h"
tron@3961: #include "ship.h"
rubidium@8119: #include "tile_cmd.h"
maedhros@6453: #include "landscape.h"
maedhros@6980: #include "timetable.h"
rubidium@8116: #include "command_func.h"
truelight@0: #include "pathfind.h"
celestar@3442: #include "station_map.h"
rubidium@8785: #include "station_base.h"
rubidium@8763: #include "news_func.h"
rubidium@8786: #include "engine_func.h"
peter1138@9070: #include "engine_base.h"
rubidium@10208: #include "company_func.h"
rubidium@10208: #include "company_base.h"
matthijs@1247: #include "npf.h"
rubidium@8962: #include "depot_base.h"
rubidium@8962: #include "depot_func.h"
tron@2159: #include "vehicle_gui.h"
peter1138@2962: #include "newgrf_engine.h"
celestar@3454: #include "water_map.h"
KUDr@3900: #include "yapf/yapf.h"
KUDr@3900: #include "debug.h"
peter1138@3989: #include "newgrf_callbacks.h"
peter1138@4244: #include "newgrf_text.h"
peter1138@4656: #include "newgrf_sound.h"
bjarni@5972: #include "spritecache.h"
rubidium@8114: #include "strings_func.h"
rubidium@8131: #include "functions.h"
rubidium@8131: #include "window_func.h"
rubidium@8140: #include "date_func.h"
rubidium@8144: #include "vehicle_func.h"
rubidium@8157: #include "sound_func.h"
rubidium@8211: #include "variables.h"
rubidium@8212: #include "autoreplace_gui.h"
rubidium@8224: #include "gfx_func.h"
rubidium@8270: #include "settings_type.h"
rubidium@8784: #include "order_func.h"
rubidium@9009: #include "effectvehicle_func.h"
rubidium@8211: 
rubidium@8264: #include "table/strings.h"
truelight@0: 
truelight@0: static const uint16 _ship_sprites[] = {0x0E5D, 0x0E55, 0x0E65, 0x0E6D};
truelight@0: 
rubidium@5587: static const TrackBits _ship_sometracks[4] = {
rubidium@5587: 	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_LEFT,  // 0x19, // DIAGDIR_NE
rubidium@5587: 	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_LEFT,  // 0x16, // DIAGDIR_SE
rubidium@5587: 	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_RIGHT, // 0x25, // DIAGDIR_SW
rubidium@5587: 	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_RIGHT, // 0x2A, // DIAGDIR_NW
rubidium@5587: };
rubidium@5587: 
frosch@8616: static inline TrackBits GetTileShipTrackStatus(TileIndex tile)
tron@1977: {
frosch@8616: 	return TrackStatusToTrackBits(GetTileTrackStatus(tile, TRANSPORT_WATER, 0));
truelight@0: }
truelight@0: 
peter1138@9022: static SpriteID GetShipIcon(EngineID engine)
truelight@0: {
peter1138@9022: 	uint8 spritenum = ShipVehInfo(engine)->image_index;
truelight@0: 
truelight@0: 	if (is_custom_sprite(spritenum)) {
peter1138@9022: 		SpriteID sprite = GetCustomVehicleIcon(engine, DIR_W);
peter1138@9022: 		if (sprite != 0) return sprite;
truelight@0: 
peter1138@9070: 		spritenum = GetEngine(engine)->image_index;
truelight@0: 	}
peter1138@9022: 
peter1138@9022: 	return 6 + _ship_sprites[spritenum];
peter1138@9022: }
peter1138@9022: 
peter1138@9022: void DrawShipEngine(int x, int y, EngineID engine, SpriteID pal)
peter1138@9022: {
peter1138@9022: 	DrawSprite(GetShipIcon(engine), pal, x, y);
truelight@0: }
truelight@0: 
bjarni@5972: /** Get the size of the sprite of a ship sprite heading west (used for lists)
bjarni@5972:  * @param engine The engine to get the sprite from
belugas@6420:  * @param width The width of the sprite
belugas@6420:  * @param height The height of the sprite
bjarni@5972:  */
bjarni@5972: void GetShipSpriteSize(EngineID engine, uint &width, uint &height)
bjarni@5972: {
rubidium@10056: 	const Sprite *spr = GetSprite(GetShipIcon(engine), ST_NORMAL);
bjarni@5972: 
bjarni@5972: 	width  = spr->width;
bjarni@5972: 	height = spr->height;
bjarni@5972: }
bjarni@5972: 
peter1138@9022: SpriteID Ship::GetImage(Direction direction) const
truelight@0: {
peter1138@9022: 	uint8 spritenum = this->spritenum;
truelight@0: 
truelight@0: 	if (is_custom_sprite(spritenum)) {
peter1138@9022: 		SpriteID sprite = GetCustomVehicleSprite(this, direction);
peter1138@9022: 		if (sprite != 0) return sprite;
truelight@0: 
peter1138@9070: 		spritenum = GetEngine(this->engine_type)->image_index;
truelight@0: 	}
peter1138@9022: 
truelight@0: 	return _ship_sprites[spritenum] + direction;
truelight@0: }
truelight@0: 
tron@2630: static const Depot* FindClosestShipDepot(const Vehicle* v)
truelight@0: {
rubidium@9413: 	if (_settings_game.pf.pathfinder_for_ships == VPF_NPF) { /* NPF is used */
smatz@8554: 		Trackdir trackdir = GetVehicleTrackdir(v);
smatz@8554: 		NPFFoundTargetData ftd = NPFRouteToDepotTrialError(v->tile, trackdir, false, TRANSPORT_WATER, 0, v->owner, INVALID_RAILTYPES);
smatz@8554: 
smatz@8554: 		if (ftd.best_bird_dist == 0) return GetDepotByTile(ftd.node.tile); /* Found target */
smatz@8554: 
smatz@8554: 		return NULL; /* Did not find target */
smatz@8554: 	}
smatz@8554: 
smatz@8554: 	/* OPF or YAPF - find the closest depot */
smatz@8554: 
tron@2630: 	const Depot* depot;
tron@2630: 	const Depot* best_depot = NULL;
smatz@8554: 	uint best_dist = UINT_MAX;
truelight@0: 
smatz@8554: 	FOR_ALL_DEPOTS(depot) {
smatz@8554: 		TileIndex tile = depot->xy;
smatz@8961: 		if (IsShipDepotTile(tile) && IsTileOwner(tile, v->owner)) {
smatz@8554: 			uint dist = DistanceManhattan(tile, v->tile);
smatz@8554: 			if (dist < best_dist) {
smatz@8554: 				best_dist = dist;
smatz@8554: 				best_depot = depot;
truelight@0: 			}
truelight@0: 		}
truelight@0: 	}
smatz@8554: 
truelight@0: 	return best_depot;
truelight@0: }
truelight@0: 
truelight@0: static void CheckIfShipNeedsService(Vehicle *v)
truelight@0: {
rubidium@9413: 	if (_settings_game.vehicle.servint_ships == 0 || !v->NeedsAutomaticServicing()) return;
rubidium@7490: 	if (v->IsInDepot()) {
bjarni@4529: 		VehicleServiceInDepot(v);
bjarni@4529: 		return;
bjarni@4529: 	}
bjarni@4529: 
rubidium@7502: 	const Depot *depot = FindClosestShipDepot(v);
truelight@0: 
truelight@1313: 	if (depot == NULL || DistanceManhattan(v->tile, depot->xy) > 12) {
rubidium@8836: 		if (v->current_order.IsType(OT_GOTO_DEPOT)) {
rubidium@8836: 			v->current_order.MakeDummy();
smatz@8350: 			InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
truelight@0: 		}
truelight@0: 		return;
truelight@0: 	}
truelight@0: 
rubidium@8853: 	v->current_order.MakeGoToDepot(depot->index, ODTFB_SERVICE);
truelight@1313: 	v->dest_tile = depot->xy;
smatz@8350: 	InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
truelight@0: }
truelight@0: 
glx@8467: void Ship::OnNewDay()
truelight@0: {
glx@8467: 	if ((++this->day_counter & 7) == 0)
glx@8467: 		DecreaseVehicleValue(this);
truelight@0: 
glx@8467: 	CheckVehicleBreakdown(this);
glx@8467: 	AgeVehicle(this);
glx@8467: 	CheckIfShipNeedsService(this);
dominik@19: 
glx@8467: 	CheckOrders(this);
truelight@0: 
smatz@8556: 	if (this->running_ticks == 0) return;
truelight@0: 
smatz@8556: 	CommandCost cost(EXPENSES_SHIP_RUN, GetVehicleProperty(this, 0x0F, ShipVehInfo(this->engine_type)->running_cost) * _price.ship_running * this->running_ticks / (364 * DAY_TICKS));
smatz@8556: 
smatz@8556: 	this->profit_this_year -= cost.GetCost();
smatz@8556: 	this->running_ticks = 0;
glx@8467: 
rubidium@10207: 	SubtractMoneyFromCompanyFract(this->owner, cost);
glx@8467: 
glx@8467: 	InvalidateWindow(WC_VEHICLE_DETAILS, this->index);
belugas@6420: 	/* we need this for the profit */
Celestar@1055: 	InvalidateWindowClasses(WC_SHIPS_LIST);
truelight@0: }
truelight@0: 
truelight@0: static void HandleBrokenShip(Vehicle *v)
truelight@0: {
truelight@0: 	if (v->breakdown_ctr != 1) {
truelight@0: 		v->breakdown_ctr = 1;
truelight@0: 		v->cur_speed = 0;
truelight@0: 
truelight@0: 		if (v->breakdowns_since_last_service != 255)
truelight@0: 			v->breakdowns_since_last_service++;
truelight@193: 
truelight@0: 		InvalidateWindow(WC_VEHICLE_VIEW, v->index);
truelight@0: 		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);
truelight@193: 
peter1138@4656: 		if (!PlayVehicleSound(v, VSE_BREAKDOWN)) {
rubidium@9413: 			SndPlayVehicleFx((_settings_game.game_creation.landscape != LT_TOYLAND) ?
peter1138@4656: 				SND_10_TRAIN_BREAKDOWN : SND_3A_COMEDY_BREAKDOWN_2, v);
peter1138@4656: 		}
truelight@0: 
truelight@0: 		if (!(v->vehstatus & VS_HIDDEN)) {
truelight@0: 			Vehicle *u = CreateEffectVehicleRel(v, 4, 4, 5, EV_BREAKDOWN_SMOKE);
rubidium@9008: 			if (u != NULL) u->u.effect.animation_state = v->breakdown_delay * 2;
truelight@0: 		}
truelight@0: 	}
truelight@0: 
truelight@0: 	if (!(v->tick_counter & 1)) {
truelight@0: 		if (!--v->breakdown_delay) {
truelight@0: 			v->breakdown_ctr = 0;
bjarni@1151: 			InvalidateWindow(WC_VEHICLE_VIEW, v->index);
truelight@0: 		}
truelight@0: 	}
truelight@0: }
truelight@0: 
rubidium@6553: void Ship::MarkDirty()
truelight@0: {
rubidium@7134: 	this->cur_image = this->GetImage(this->direction);
smatz@8317: 	MarkSingleVehicleDirty(this);
truelight@0: }
truelight@0: 
rubidium@6593: static void PlayShipSound(const Vehicle *v)
truelight@0: {
peter1138@4656: 	if (!PlayVehicleSound(v, VSE_START)) {
peter1138@4656: 		SndPlayVehicleFx(ShipVehInfo(v->engine_type)->sfx, v);
peter1138@4656: 	}
truelight@0: }
truelight@0: 
rubidium@6593: void Ship::PlayLeaveStationSound() const
rubidium@6593: {
rubidium@6593: 	PlayShipSound(this);
rubidium@6593: }
rubidium@6593: 
rubidium@8827: TileIndex Ship::GetOrderStationLocation(StationID station)
truelight@0: {
rubidium@8830: 	if (station == this->last_station_visited) this->last_station_visited = INVALID_STATION;
rubidium@8830: 
rubidium@8928: 	const Station *st = GetStation(station);
rubidium@8827: 	if (st->dock_tile != 0) {
rubidium@8827: 		return TILE_ADD(st->dock_tile, ToTileIndexDiff(GetDockOffset(st->dock_tile)));
rubidium@8827: 	} else {
rubidium@8827: 		this->cur_order_index++;
rubidium@8827: 		return 0;
truelight@0: 	}
truelight@0: }
truelight@0: 
rubidium@6558: void Ship::UpdateDeltaXY(Direction direction)
truelight@0: {
rubidium@6558: #define MKIT(a, b, c, d) ((a & 0xFF) << 24) | ((b & 0xFF) << 16) | ((c & 0xFF) << 8) | ((d & 0xFF) << 0)
truelight@0: 	static const uint32 _delta_xy_table[8] = {
rubidium@6558: 		MKIT( 6,  6,  -3,  -3),
rubidium@6558: 		MKIT( 6, 32,  -3, -16),
rubidium@6558: 		MKIT( 6,  6,  -3,  -3),
rubidium@6558: 		MKIT(32,  6, -16,  -3),
rubidium@6558: 		MKIT( 6,  6,  -3,  -3),
rubidium@6558: 		MKIT( 6, 32,  -3, -16),
rubidium@6558: 		MKIT( 6,  6,  -3,  -3),
rubidium@6558: 		MKIT(32,  6, -16,  -3),
truelight@0: 	};
truelight@0: #undef MKIT
rubidium@6558: 
rubidium@6558: 	uint32 x = _delta_xy_table[direction];
rubidium@6558: 	this->x_offs        = GB(x,  0, 8);
rubidium@6558: 	this->y_offs        = GB(x,  8, 8);
frosch@8793: 	this->x_extent      = GB(x, 16, 8);
frosch@8793: 	this->y_extent      = GB(x, 24, 8);
frosch@8793: 	this->z_extent      = 6;
truelight@0: }
truelight@0: 
bjarni@4725: void RecalcShipStuff(Vehicle *v)
truelight@0: {
rubidium@6558: 	v->UpdateDeltaXY(v->direction);
rubidium@7134: 	v->cur_image = v->GetImage(v->direction);
rubidium@6553: 	v->MarkDirty();
truelight@0: 	InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);
truelight@0: }
truelight@0: 
tron@909: static const TileIndexDiffC _ship_leave_depot_offs[] = {
tron@909: 	{-1,  0},
tron@909: 	{ 0, -1}
truelight@0: };
truelight@0: 
truelight@0: static void CheckShipLeaveDepot(Vehicle *v)
truelight@0: {
rubidium@7490: 	if (!v->IsInDepot()) return;
truelight@0: 
smatz@9045: 	TileIndex tile = v->tile;
smatz@9045: 	Axis axis = GetShipDepotAxis(tile);
truelight@0: 
smatz@9045: 	/* Check first (north) side */
celestar@3454: 	if (_ship_sometracks[axis] & GetTileShipTrackStatus(TILE_ADD(tile, ToTileIndexDiff(_ship_leave_depot_offs[axis])))) {
smatz@9045: 		v->direction = ReverseDir(AxisToDirection(axis));
smatz@9045: 	/* Check second (south) side */
celestar@3454: 	} else if (_ship_sometracks[axis + 2] & GetTileShipTrackStatus(TILE_ADD(tile, -2 * ToTileIndexDiff(_ship_leave_depot_offs[axis])))) {
smatz@9045: 		v->direction = AxisToDirection(axis);
truelight@0: 	} else {
truelight@0: 		return;
truelight@0: 	}
smatz@9045: 
smatz@9045: 	v->u.ship.state = AxisToTrackBits(axis);
truelight@0: 	v->vehstatus &= ~VS_HIDDEN;
truelight@0: 
truelight@0: 	v->cur_speed = 0;
truelight@0: 	RecalcShipStuff(v);
truelight@0: 
truelight@0: 	PlayShipSound(v);
bjarni@578: 	VehicleServiceInDepot(v);
bjarni@4739: 	InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
Celestar@1055: 	InvalidateWindowClasses(WC_SHIPS_LIST);
truelight@0: }
truelight@0: 
truelight@0: static bool ShipAccelerate(Vehicle *v)
truelight@0: {
truelight@0: 	uint spd;
truelight@0: 	byte t;
truelight@0: 
peter1138@6490: 	spd = min(v->cur_speed + 1, GetVehicleProperty(v, 0x0B, v->max_speed));
truelight@0: 
belugas@6420: 	/*updates statusbar only if speed have changed to save CPU time */
truelight@0: 	if (spd != v->cur_speed) {
truelight@193: 		v->cur_speed = spd;
rubidium@9413: 		if (_settings_client.gui.vehicle_speed)
smatz@8350: 			InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
truelight@0: 	}
truelight@0: 
belugas@6420: 	/* Decrease somewhat when turning */
tron@2639: 	if (!(v->direction & 1)) spd = spd * 3 / 4;
truelight@0: 
tron@2639: 	if (spd == 0) return false;
tron@2639: 	if ((byte)++spd == 0) return true;
truelight@0: 
truelight@0: 	v->progress = (t = v->progress) - (byte)spd;
truelight@0: 
truelight@0: 	return (t < v->progress);
truelight@0: }
truelight@0: 
rubidium@6943: static CommandCost EstimateShipCost(EngineID engine_type)
Darkvater@1793: {
peter1138@9923: 	return CommandCost(EXPENSES_NEW_VEHICLES, GetEngineProperty(engine_type, 0x0A, ShipVehInfo(engine_type)->cost_factor) * (_price.ship_base >> 3) >> 5);
Darkvater@1793: }
truelight@0: 
tron@2630: static void ShipArrivesAt(const Vehicle* v, Station* st)
truelight@0: {
truelight@0: 	/* Check if station was ever visited before */
truelight@0: 	if (!(st->had_vehicle_of_type & HVOT_SHIP)) {
truelight@0: 		st->had_vehicle_of_type |= HVOT_SHIP;
tron@2639: 
tron@534: 		SetDParam(0, st->index);
truelight@0: 		AddNewsItem(
truelight@0: 			STR_9833_CITIZENS_CELEBRATE_FIRST,
rubidium@10207: 			(v->owner == _local_company) ? NS_ARRIVAL_COMPANY : NS_ARRIVAL_OTHER,
truelight@0: 			v->index,
smatz@10123: 			st->index
smatz@10123: 		);
truelight@0: 	}
truelight@0: }
truelight@0: 
rubidium@6248: struct PathFindShip {
tron@1977: 	TileIndex skiptile;
tron@1977: 	TileIndex dest_coords;
truelight@0: 	uint best_bird_dist;
truelight@0: 	uint best_length;
rubidium@6248: };
truelight@0: 
frosch@8611: static bool ShipTrackFollower(TileIndex tile, PathFindShip *pfs, int track, uint length)
truelight@0: {
belugas@6420: 	/* Found dest? */
truelight@0: 	if (tile == pfs->dest_coords) {
truelight@0: 		pfs->best_bird_dist = 0;
truelight@193: 
truelight@0: 		pfs->best_length = minu(pfs->best_length, length);
truelight@0: 		return true;
truelight@0: 	}
truelight@0: 
belugas@6420: 	/* Skip this tile in the calculation */
truelight@0: 	if (tile != pfs->skiptile) {
tron@1245: 		pfs->best_bird_dist = minu(pfs->best_bird_dist, DistanceMaxPlusManhattan(pfs->dest_coords, tile));
truelight@0: 	}
truelight@193: 
truelight@0: 	return false;
truelight@0: }
truelight@0: 
truelight@0: static const byte _ship_search_directions[6][4] = {
truelight@0: 	{ 0, 9, 2, 9 },
truelight@0: 	{ 9, 1, 9, 3 },
truelight@0: 	{ 9, 0, 3, 9 },
truelight@0: 	{ 1, 9, 9, 2 },
truelight@0: 	{ 3, 2, 9, 9 },
truelight@0: 	{ 9, 9, 1, 0 },
truelight@0: };
truelight@0: 
truelight@0: static const byte _pick_shiptrack_table[6] = {1, 3, 2, 2, 0, 0};
truelight@0: 
rubidium@5587: static uint FindShipTrack(Vehicle *v, TileIndex tile, DiagDirection dir, TrackBits bits, TileIndex skiptile, Track *track)
truelight@0: {
truelight@0: 	PathFindShip pfs;
rubidium@5587: 	Track i, best_track;
truelight@0: 	uint best_bird_dist = 0;
truelight@0: 	uint best_length    = 0;
truelight@0: 	uint r;
truelight@0: 	byte ship_dir = v->direction & 3;
truelight@0: 
truelight@0: 	pfs.dest_coords = v->dest_tile;
truelight@0: 	pfs.skiptile = skiptile;
truelight@0: 
rubidium@5587: 	best_track = INVALID_TRACK;
truelight@0: 
truelight@0: 	do {
KUDr@5598: 		i = RemoveFirstTrack(&bits);
truelight@193: 
rubidium@10236: 		pfs.best_bird_dist = UINT_MAX;
rubidium@10236: 		pfs.best_length = UINT_MAX;
truelight@0: 
frosch@8800: 		FollowTrack(tile, PATHFIND_FLAGS_SHIP_MODE | PATHFIND_FLAGS_DISABLE_TILE_HASH, TRANSPORT_WATER, 0, (DiagDirection)_ship_search_directions[i][dir], (TPFEnumProc*)ShipTrackFollower, NULL, &pfs);
truelight@193: 
rubidium@5587: 		if (best_track != INVALID_TRACK) {
truelight@0: 			if (pfs.best_bird_dist != 0) {
truelight@0: 				/* neither reached the destination, pick the one with the smallest bird dist */
truelight@0: 				if (pfs.best_bird_dist > best_bird_dist) goto bad;
truelight@0: 				if (pfs.best_bird_dist < best_bird_dist) goto good;
truelight@0: 			} else {
truelight@0: 				if (pfs.best_length > best_length) goto bad;
truelight@0: 				if (pfs.best_length < best_length) goto good;
truelight@0: 			}
truelight@193: 
truelight@193: 			/* if we reach this position, there's two paths of equal value so far.
truelight@0: 			 * pick one randomly. */
tron@2150: 			r = GB(Random(), 0, 8);
truelight@0: 			if (_pick_shiptrack_table[i] == ship_dir) r += 80;
truelight@0: 			if (_pick_shiptrack_table[best_track] == ship_dir) r -= 80;
truelight@0: 			if (r <= 127) goto bad;
truelight@0: 		}
truelight@0: good:;
truelight@0: 		best_track = i;
truelight@0: 		best_bird_dist = pfs.best_bird_dist;
truelight@0: 		best_length = pfs.best_length;
truelight@0: bad:;
truelight@0: 
truelight@0: 	} while (bits != 0);
truelight@0: 
truelight@0: 	*track = best_track;
truelight@0: 	return best_bird_dist;
truelight@0: }
truelight@0: 
frosch@8510: static inline NPFFoundTargetData PerfNPFRouteToStationOrTile(TileIndex tile, Trackdir trackdir, bool ignore_start_tile, NPFFindStationOrTileData* target, TransportType type, Owner owner, RailTypes railtypes)
KUDr@3900: {
KUDr@3900: 
KUDr@3900: 	void* perf = NpfBeginInterval();
frosch@8510: 	NPFFoundTargetData ret = NPFRouteToStationOrTile(tile, trackdir, ignore_start_tile, target, type, 0, owner, railtypes);
KUDr@3900: 	int t = NpfEndInterval(perf);
Darkvater@5380: 	DEBUG(yapf, 4, "[NPFW] %d us - %d rounds - %d open - %d closed -- ", t, 0, _aystar_stats_open_size, _aystar_stats_closed_size);
KUDr@3900: 	return ret;
KUDr@3900: }
KUDr@3900: 
belugas@6420: /** returns the track to choose on the next tile, or -1 when it's better to
matthijs@1247:  * reverse. The tile given is the tile we are about to enter, enterdir is the
matthijs@1247:  * direction in which we are entering the tile */
rubidium@5587: static Track ChooseShipTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks)
truelight@0: {
smatz@8554: 	assert(IsValidDiagDirection(enterdir));
truelight@0: 
rubidium@9413: 	switch (_settings_game.pf.pathfinder_for_ships) {
smatz@8554: 		case VPF_YAPF: { /* YAPF */
smatz@8554: 			Trackdir trackdir = YapfChooseShipTrack(v, tile, enterdir, tracks);
smatz@8554: 			if (trackdir != INVALID_TRACKDIR) return TrackdirToTrack(trackdir);
smatz@8554: 		} break;
matthijs@1247: 
smatz@8554: 		case VPF_NPF: { /* NPF */
smatz@8554: 			NPFFindStationOrTileData fstd;
smatz@8554: 			Trackdir trackdir = GetVehicleTrackdir(v);
smatz@8554: 			assert(trackdir != INVALID_TRACKDIR); // Check that we are not in a depot
matthijs@1247: 
smatz@8554: 			NPFFillWithOrderData(&fstd, v);
matthijs@1247: 
smatz@8554: 			NPFFoundTargetData ftd = PerfNPFRouteToStationOrTile(tile - TileOffsByDiagDir(enterdir), trackdir, true, &fstd, TRANSPORT_WATER, v->owner, INVALID_RAILTYPES);
smatz@8554: 
matthijs@1698: 			/* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains
smatz@8554: 			 * the direction we need to take to get there, if ftd.best_bird_dist is not 0,
smatz@8554: 			 * we did not find our target, but ftd.best_trackdir contains the direction leading
smatz@8554: 			 * to the tile closest to our target. */
smatz@8554: 			if (ftd.best_trackdir != 0xff) return TrackdirToTrack(ftd.best_trackdir); /* TODO: Wrapper function? */
smatz@8554: 		} break;
matthijs@1247: 
smatz@8554: 		default:
smatz@8554: 		case VPF_OPF: { /* OPF */
smatz@8554: 			TileIndex tile2 = TILE_ADD(tile, -TileOffsByDiagDir(enterdir));
smatz@8554: 			Track track;
matthijs@1247: 
smatz@8554: 			/* Let's find out how far it would be if we would reverse first */
smatz@8554: 			TrackBits b = GetTileShipTrackStatus(tile2) & _ship_sometracks[ReverseDiagDir(enterdir)] & v->u.ship.state;
smatz@8554: 
smatz@8554: 			uint distr = UINT_MAX; // distance if we reversed
smatz@8554: 			if (b != 0) {
smatz@8554: 				distr = FindShipTrack(v, tile2, ReverseDiagDir(enterdir), b, tile, &track);
smatz@8554: 				if (distr != UINT_MAX) distr++; // penalty for reversing
smatz@8554: 			}
smatz@8554: 
smatz@8554: 			/* And if we would not reverse? */
smatz@8554: 			uint dist = FindShipTrack(v, tile, enterdir, tracks, 0, &track);
smatz@8554: 
smatz@8554: 			if (dist <= distr) return track;
smatz@8554: 		} break;
truelight@0: 	}
smatz@8554: 
smatz@8554: 	return INVALID_TRACK; /* We could better reverse */
truelight@0: }
truelight@0: 
tron@3157: static const Direction _new_vehicle_direction_table[] = {
rubidium@5587: 	DIR_N , DIR_NW, DIR_W , INVALID_DIR,
rubidium@5587: 	DIR_NE, DIR_N , DIR_SW, INVALID_DIR,
tron@3157: 	DIR_E , DIR_SE, DIR_S
truelight@0: };
truelight@0: 
rubidium@5587: static Direction ShipGetNewDirectionFromTiles(TileIndex new_tile, TileIndex old_tile)
truelight@0: {
tron@926: 	uint offs = (TileY(new_tile) - TileY(old_tile) + 1) * 4 +
tron@926: 							TileX(new_tile) - TileX(old_tile) + 1;
truelight@0: 	assert(offs < 11 && offs != 3 && offs != 7);
truelight@0: 	return _new_vehicle_direction_table[offs];
truelight@0: }
truelight@0: 
rubidium@5587: static Direction ShipGetNewDirection(Vehicle *v, int x, int y)
truelight@0: {
truelight@0: 	uint offs = (y - v->y_pos + 1) * 4 + (x - v->x_pos + 1);
truelight@0: 	assert(offs < 11 && offs != 3 && offs != 7);
truelight@0: 	return _new_vehicle_direction_table[offs];
truelight@0: }
truelight@0: 
frosch@8616: static inline TrackBits GetAvailShipTracks(TileIndex tile, int dir)
truelight@0: {
frosch@8616: 	return GetTileShipTrackStatus(tile) & _ship_sometracks[dir];
truelight@0: }
truelight@0: 
truelight@0: static const byte _ship_subcoord[4][6][3] = {
truelight@0: 	{
truelight@0: 		{15, 8, 1},
truelight@0: 		{ 0, 0, 0},
truelight@0: 		{ 0, 0, 0},
truelight@0: 		{15, 8, 2},
truelight@0: 		{15, 7, 0},
truelight@0: 		{ 0, 0, 0},
truelight@0: 	},
truelight@0: 	{
truelight@0: 		{ 0, 0, 0},
truelight@0: 		{ 8, 0, 3},
truelight@0: 		{ 7, 0, 2},
truelight@0: 		{ 0, 0, 0},
truelight@0: 		{ 8, 0, 4},
truelight@0: 		{ 0, 0, 0},
truelight@0: 	},
truelight@0: 	{
truelight@0: 		{ 0, 8, 5},
truelight@0: 		{ 0, 0, 0},
truelight@0: 		{ 0, 7, 6},
truelight@0: 		{ 0, 0, 0},
truelight@0: 		{ 0, 0, 0},
truelight@0: 		{ 0, 8, 4},
truelight@0: 	},
truelight@0: 	{
truelight@0: 		{ 0, 0, 0},
rubidium@6491: 		{ 8, 15, 7},
truelight@0: 		{ 0, 0, 0},
rubidium@6491: 		{ 8, 15, 6},
truelight@0: 		{ 0, 0, 0},
rubidium@6491: 		{ 7, 15, 0},
truelight@0: 	}
truelight@0: };
truelight@0: 
truelight@0: static void ShipController(Vehicle *v)
truelight@0: {
truelight@0: 	uint32 r;
truelight@0: 	const byte *b;
tron@3157: 	Direction dir;
rubidium@5587: 	Track track;
rubidium@5587: 	TrackBits tracks;
truelight@0: 
truelight@0: 	v->tick_counter++;
maedhros@6980: 	v->current_order_time++;
truelight@0: 
truelight@0: 	if (v->breakdown_ctr != 0) {
truelight@0: 		if (v->breakdown_ctr <= 2) {
truelight@0: 			HandleBrokenShip(v);
truelight@0: 			return;
truelight@0: 		}
rubidium@9000: 		if (!v->current_order.IsType(OT_LOADING)) v->breakdown_ctr--;
truelight@0: 	}
truelight@0: 
tron@2639: 	if (v->vehstatus & VS_STOPPED) return;
truelight@0: 
rubidium@8827: 	ProcessOrders(v);
rubidium@6594: 	v->HandleLoading();
truelight@0: 
rubidium@8836: 	if (v->current_order.IsType(OT_LOADING)) return;
truelight@0: 
truelight@0: 	CheckShipLeaveDepot(v);
truelight@0: 
tron@2639: 	if (!ShipAccelerate(v)) return;
truelight@0: 
truelight@0: 	BeginVehicleMove(v);
truelight@0: 
tron@6153: 	GetNewVehiclePosResult gp = GetNewVehiclePos(v);
rubidium@9490: 	if (v->u.ship.state != TRACK_BIT_WORMHOLE) {
rubidium@9490: 		/* Not on a bridge */
rubidium@9490: 		if (gp.old_tile == gp.new_tile) {
rubidium@9490: 			/* Staying in tile */
rubidium@9490: 			if (v->IsInDepot()) {
rubidium@9490: 				gp.x = v->x_pos;
rubidium@9490: 				gp.y = v->y_pos;
rubidium@9490: 			} else {
rubidium@9490: 				/* Not inside depot */
rubidium@9490: 				r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
rubidium@9490: 				if (HasBit(r, VETS_CANNOT_ENTER)) goto reverse_direction;
truelight@0: 
rubidium@9490: 				/* A leave station order only needs one tick to get processed, so we can
rubidium@9490: 				* always skip ahead. */
rubidium@9490: 				if (v->current_order.IsType(OT_LEAVESTATION)) {
rubidium@9490: 					v->current_order.Free();
rubidium@9490: 					InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
rubidium@9490: 				} else if (v->dest_tile != 0) {
rubidium@9490: 					/* We have a target, let's see if we reached it... */
rubidium@9490: 					if (v->current_order.IsType(OT_GOTO_STATION) &&
rubidium@9490: 							IsBuoyTile(v->dest_tile) &&
rubidium@9490: 							DistanceManhattan(v->dest_tile, gp.new_tile) <= 3) {
rubidium@9490: 						/* We got within 3 tiles of our target buoy, so let's skip to our
rubidium@9490: 						* next order */
rubidium@9490: 						UpdateVehicleTimetable(v, true);
rubidium@9490: 						v->cur_order_index++;
rubidium@9490: 						v->current_order.MakeDummy();
smatz@10184: 						InvalidateVehicleOrder(v, 0);
rubidium@9490: 					} else {
rubidium@9490: 						/* Non-buoy orders really need to reach the tile */
rubidium@9490: 						if (v->dest_tile == gp.new_tile) {
rubidium@9490: 							if (v->current_order.IsType(OT_GOTO_DEPOT)) {
rubidium@9490: 								if ((gp.x & 0xF) == 8 && (gp.y & 0xF) == 8) {
rubidium@9490: 									VehicleEnterDepot(v);
rubidium@9490: 									return;
rubidium@9490: 								}
rubidium@9490: 							} else if (v->current_order.IsType(OT_GOTO_STATION)) {
rubidium@9490: 								v->last_station_visited = v->current_order.GetDestination();
matthijs@1751: 
rubidium@9490: 								/* Process station in the orderlist. */
rubidium@9490: 								Station *st = GetStation(v->current_order.GetDestination());
rubidium@9490: 								if (st->facilities & FACIL_DOCK) { // ugly, ugly workaround for problem with ships able to drop off cargo at wrong stations
rubidium@9490: 									ShipArrivesAt(v, st);
rubidium@9490: 									v->BeginLoading();
rubidium@9490: 								} else { // leave stations without docks right aways
rubidium@9490: 									v->current_order.MakeLeaveStation();
rubidium@9490: 									v->cur_order_index++;
smatz@10184: 									InvalidateVehicleOrder(v, 0);
rubidium@9490: 								}
matthijs@1751: 							}
matthijs@1751: 						}
matthijs@1751: 					}
matthijs@1751: 				}
truelight@0: 			}
rubidium@9490: 		} else {
rubidium@9490: 			DiagDirection diagdir;
rubidium@9490: 			/* New tile */
rubidium@9490: 			if (TileX(gp.new_tile) >= MapMaxX() || TileY(gp.new_tile) >= MapMaxY()) {
rubidium@9490: 				goto reverse_direction;
rubidium@9490: 			}
rubidium@9490: 
rubidium@9490: 			dir = ShipGetNewDirectionFromTiles(gp.new_tile, gp.old_tile);
rubidium@9490: 			assert(dir == DIR_NE || dir == DIR_SE || dir == DIR_SW || dir == DIR_NW);
rubidium@9490: 			diagdir = DirToDiagDir(dir);
rubidium@9490: 			tracks = GetAvailShipTracks(gp.new_tile, diagdir);
rubidium@9490: 			if (tracks == TRACK_BIT_NONE) goto reverse_direction;
rubidium@9490: 
rubidium@9490: 			/* Choose a direction, and continue if we find one */
rubidium@9490: 			track = ChooseShipTrack(v, gp.new_tile, diagdir, tracks);
rubidium@9490: 			if (track == INVALID_TRACK) goto reverse_direction;
rubidium@9490: 
rubidium@9490: 			b = _ship_subcoord[diagdir][track];
rubidium@9490: 
rubidium@9490: 			gp.x = (gp.x & ~0xF) | b[0];
rubidium@9490: 			gp.y = (gp.y & ~0xF) | b[1];
rubidium@9490: 
rubidium@9490: 			/* Call the landscape function and tell it that the vehicle entered the tile */
rubidium@9490: 			r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
rubidium@9490: 			if (HasBit(r, VETS_CANNOT_ENTER)) goto reverse_direction;
rubidium@9490: 
rubidium@9490: 			if (!HasBit(r, VETS_ENTERED_WORMHOLE)) {
rubidium@9490: 				v->tile = gp.new_tile;
rubidium@9490: 				v->u.ship.state = TrackToTrackBits(track);
rubidium@9490: 			}
rubidium@9490: 
rubidium@9490: 			v->direction = (Direction)b[2];
truelight@0: 		}
truelight@0: 	} else {
rubidium@9490: 		/* On a bridge */
rubidium@9490: 		if (!IsTileType(gp.new_tile, MP_TUNNELBRIDGE) || !HasBit(VehicleEnterTile(v, gp.new_tile, gp.x, gp.y), VETS_ENTERED_WORMHOLE)) {
rubidium@9490: 			v->x_pos = gp.x;
rubidium@9490: 			v->y_pos = gp.y;
rubidium@9490: 			VehiclePositionChanged(v);
rubidium@9490: 			if (!(v->vehstatus & VS_HIDDEN)) EndVehicleMove(v);
rubidium@9490: 			return;
rubidium@5994: 		}
truelight@0: 	}
truelight@0: 
truelight@0: 	/* update image of ship, as well as delta XY */
truelight@0: 	dir = ShipGetNewDirection(v, gp.x, gp.y);
truelight@0: 	v->x_pos = gp.x;
truelight@0: 	v->y_pos = gp.y;
truelight@0: 	v->z_pos = GetSlopeZ(gp.x, gp.y);
truelight@0: 
truelight@0: getout:
rubidium@6558: 	v->UpdateDeltaXY(dir);
rubidium@7134: 	v->cur_image = v->GetImage(dir);
truelight@0: 	VehiclePositionChanged(v);
truelight@0: 	EndVehicleMove(v);
truelight@0: 	return;
truelight@0: 
truelight@0: reverse_direction:
tron@3157: 	dir = ReverseDir(v->direction);
truelight@0: 	v->direction = dir;
truelight@0: 	goto getout;
truelight@0: }
truelight@0: 
truelight@0: static void AgeShipCargo(Vehicle *v)
truelight@0: {
tron@2639: 	if (_age_cargo_skip_counter != 0) return;
rubidium@7010: 	v->cargo.AgeCargo();
truelight@0: }
truelight@0: 
rubidium@7135: void Ship::Tick()
truelight@0: {
smatz@8556: 	if (!(this->vehstatus & VS_STOPPED)) this->running_ticks++;
smatz@8556: 
rubidium@7135: 	AgeShipCargo(this);
rubidium@7135: 	ShipController(this);
truelight@0: }
truelight@0: 
truelight@0: 
rubidium@6247: void ShipsYearlyLoop()
truelight@0: {
truelight@0: 	Vehicle *v;
truelight@0: 
truelight@0: 	FOR_ALL_VEHICLES(v) {
rubidium@6259: 		if (v->type == VEH_SHIP) {
truelight@0: 			v->profit_last_year = v->profit_this_year;
truelight@0: 			v->profit_this_year = 0;
truelight@0: 			InvalidateWindow(WC_VEHICLE_DETAILS, v->index);
truelight@0: 		}
truelight@0: 	}
truelight@0: }
truelight@0: 
Darkvater@1793: /** Build a ship.
tron@3491:  * @param tile tile of depot where ship is built
belugas@6420:  * @param flags type of operation
Darkvater@1793:  * @param p1 ship type being built (engine)
smatz@9628:  * @param p2 unused
Darkvater@1793:  */
rubidium@6943: CommandCost CmdBuildShip(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
rubidium@6943: 	CommandCost value;
truelight@1282: 	UnitID unit_num;
truelight@0: 	Engine *e;
truelight@193: 
rubidium@10207: 	if (!IsEngineBuildable(p1, VEH_SHIP, _current_company)) return_cmd_error(STR_SHIP_NOT_AVAILABLE);
bjarni@1196: 
truelight@0: 	value = EstimateShipCost(p1);
Darkvater@1793: 	if (flags & DC_QUERY_COST) return value;
truelight@0: 
pasky@1443: 	/* The ai_new queries the vehicle cost before building the route,
pasky@1443: 	 * so we must check against cheaters no sooner than now. --pasky */
smatz@8961: 	if (!IsShipDepotTile(tile)) return CMD_ERROR;
rubidium@10207: 	if (!IsTileOwner(tile, _current_company)) return CMD_ERROR;
pasky@1443: 
smatz@9628: 	unit_num = (flags & DC_AUTOREPLACE) ? 0 : GetFreeUnitNumber(VEH_SHIP);
bjarni@3816: 
rubidium@9413: 	if (!Vehicle::AllocateList(NULL, 1) || unit_num > _settings_game.vehicle.max_ships)
truelight@0: 		return_cmd_error(STR_00E1_TOO_MANY_VEHICLES_IN_GAME);
truelight@193: 
truelight@0: 	if (flags & DC_EXEC) {
tron@3491: 		int x;
tron@3491: 		int y;
tron@3491: 
tron@538: 		const ShipVehicleInfo *svi = ShipVehInfo(p1);
tron@538: 
rubidium@8045: 		Vehicle *v = new Ship();
truelight@0: 		v->unitnumber = unit_num;
truelight@0: 
rubidium@10207: 		v->owner = _current_company;
truelight@0: 		v->tile = tile;
tron@3645: 		x = TileX(tile) * TILE_SIZE + TILE_SIZE / 2;
tron@3645: 		y = TileY(tile) * TILE_SIZE + TILE_SIZE / 2;
truelight@0: 		v->x_pos = x;
truelight@0: 		v->y_pos = y;
rubidium@6491: 		v->z_pos = GetSlopeZ(x, y);
truelight@0: 
smatz@8556: 		v->running_ticks = 0;
smatz@8556: 
rubidium@6558: 		v->UpdateDeltaXY(v->direction);
truelight@0: 		v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;
truelight@193: 
tron@538: 		v->spritenum = svi->image_index;
tron@538: 		v->cargo_type = svi->cargo_type;
peter1138@3870: 		v->cargo_subtype = 0;
tron@538: 		v->cargo_cap = svi->capacity;
rubidium@6950: 		v->value = value.GetCost();
truelight@193: 
truelight@1266: 		v->last_station_visited = INVALID_STATION;
tron@538: 		v->max_speed = svi->max_speed;
tron@2477: 		v->engine_type = p1;
truelight@0: 
tron@1926: 		e = GetEngine(p1);
truelight@0: 		v->reliability = e->reliability;
truelight@0: 		v->reliability_spd_dec = e->reliability_spd_dec;
truelight@0: 		v->max_age = e->lifelength * 366;
bjarni@2564: 		_new_vehicle_id = v->index;
truelight@0: 
peter1138@8258: 		v->name = NULL;
rubidium@5993: 		v->u.ship.state = TRACK_BIT_DEPOT;
truelight@0: 
rubidium@9413: 		v->service_interval = _settings_game.vehicle.servint_ships;
truelight@0: 		v->date_of_last_service = _date;
rubidium@4329: 		v->build_year = _cur_year;
truelight@0: 		v->cur_image = 0x0E5E;
peter1138@2804: 		v->random_bits = VehicleRandomBits();
truelight@0: 
maedhros@6176: 		v->vehicle_flags = 0;
skidd13@7931: 		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) SetBit(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE);
maedhros@6176: 
peter1138@6608: 		v->cargo_cap = GetVehicleProperty(v, 0x0D, svi->capacity);
peter1138@6608: 
truelight@0: 		VehiclePositionChanged(v);
truelight@0: 
bjarni@4739: 		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
rubidium@9297: 		InvalidateWindowClassesData(WC_SHIPS_LIST, 0);
truelight@0: 		InvalidateWindow(WC_COMPANY, v->owner);
rubidium@10207: 		if (IsLocalCompany())
bjarni@7425: 			InvalidateAutoreplaceWindow(v->engine_type, v->group_id); // updates the replace Ship window
bjarni@5944: 
rubidium@10207: 		GetCompany(_current_company)->num_engines[p1]++;
truelight@0: 	}
truelight@193: 
truelight@0: 	return value;
truelight@0: }
truelight@0: 
Darkvater@1793: /** Sell a ship.
tron@3491:  * @param tile unused
belugas@6420:  * @param flags type of operation
Darkvater@1793:  * @param p1 vehicle ID to be sold
Darkvater@1793:  * @param p2 unused
Darkvater@1793:  */
rubidium@6943: CommandCost CmdSellShip(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
truelight@0: 	Vehicle *v;
truelight@0: 
truelight@4352: 	if (!IsValidVehicleID(p1)) return CMD_ERROR;
truelight@193: 
truelight@919: 	v = GetVehicle(p1);
truelight@0: 
rubidium@6259: 	if (v->type != VEH_SHIP || !CheckOwnership(v->owner)) return CMD_ERROR;
truelight@0: 
rubidium@7695: 	if (HASBITS(v->vehstatus, VS_CRASHED)) return_cmd_error(STR_CAN_T_SELL_DESTROYED_VEHICLE);
rubidium@7695: 
rubidium@7490: 	if (!v->IsStoppedInDepot()) {
truelight@0: 		return_cmd_error(STR_980B_SHIP_MUST_BE_STOPPED_IN);
tron@3961: 	}
truelight@193: 
rubidium@8230: 	CommandCost ret(EXPENSES_NEW_VEHICLES, -v->value);
rubidium@7782: 
truelight@0: 	if (flags & DC_EXEC) {
truelight@0: 		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);
rubidium@9297: 		InvalidateWindowClassesData(WC_SHIPS_LIST, 0);
truelight@0: 		InvalidateWindow(WC_COMPANY, v->owner);
truelight@0: 		DeleteWindowById(WC_VEHICLE_VIEW, v->index);
bjarni@5256: 		DeleteDepotHighlightOfVehicle(v);
rubidium@7398: 		delete v;
truelight@0: 	}
truelight@193: 
rubidium@7782: 	return ret;
truelight@0: }
truelight@0: 
rubidium@8890: bool Ship::FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
rubidium@8890: {
rubidium@8890: 	const Depot *depot = FindClosestShipDepot(this);
rubidium@8890: 
rubidium@8890: 	if (depot == NULL) return false;
rubidium@8890: 
rubidium@8890: 	if (location    != NULL) *location    = depot->xy;
rubidium@8890: 	if (destination != NULL) *destination = depot->index;
rubidium@8890: 
rubidium@8890: 	return true;
rubidium@8890: }
rubidium@8890: 
Darkvater@1793: /** Send a ship to the depot.
tron@3491:  * @param tile unused
belugas@6420:  * @param flags type of operation
Darkvater@1793:  * @param p1 vehicle ID to send to the depot
bjarni@4451:  * @param p2 various bitmasked elements
bjarni@4506:  * - p2 bit 0-3 - DEPOT_ flags (see vehicle.h)
bjarni@4506:  * - p2 bit 8-10 - VLW flag (for mass goto depot)
Darkvater@1793:  */
rubidium@6943: CommandCost CmdSendShipToDepot(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
bjarni@4506: 	if (p2 & DEPOT_MASS_SEND) {
bjarni@4506: 		/* Mass goto depot requested */
Darkvater@4546: 		if (!ValidVLWFlags(p2 & VLW_MASK)) return CMD_ERROR;
rubidium@10207: 		return SendAllVehiclesToDepot(VEH_SHIP, flags, p2 & DEPOT_SERVICE, _current_company, (p2 & VLW_MASK), p1);
bjarni@4463: 	}
bjarni@4463: 
bjarni@4506: 	if (!IsValidVehicleID(p1)) return CMD_ERROR;
bjarni@1237: 
rubidium@8891: 	Vehicle *v = GetVehicle(p1);
bjarni@4510: 
rubidium@8891: 	if (v->type != VEH_SHIP) return CMD_ERROR;
truelight@0: 
rubidium@8891: 	return v->SendToDepot(flags, (DepotCommand)(p2 & DEPOT_COMMAND_MASK));
truelight@0: }
truelight@0: 
truelight@0: 
Darkvater@1802: /** Refits a ship to the specified cargo type.
tron@3491:  * @param tile unused
belugas@6420:  * @param flags type of operation
Darkvater@1802:  * @param p1 vehicle ID of the ship to refit
Darkvater@1802:  * @param p2 various bitstuffed elements
Darkvater@1802:  * - p2 = (bit 0-7) - the new cargo type to refit to (p2 & 0xFF)
peter1138@3954:  * - p2 = (bit 8-15) - the new cargo subtype to refit to
maedhros@6546:  * - p2 = (bit 16) - refit only this vehicle (ignored)
maedhros@6546:  * @return cost of refit or error
Darkvater@1802:  */
rubidium@6943: CommandCost CmdRefitShip(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
truelight@0: 	Vehicle *v;
rubidium@8230: 	CommandCost cost(EXPENSES_SHIP_RUN);
peter1138@3954: 	CargoID new_cid = GB(p2, 0, 8); //gets the cargo number
peter1138@3954: 	byte new_subtype = GB(p2, 8, 8);
peter1138@3989: 	uint16 capacity = CALLBACK_FAILED;
bjarni@1237: 
truelight@4352: 	if (!IsValidVehicleID(p1)) return CMD_ERROR;
truelight@193: 
truelight@919: 	v = GetVehicle(p1);
bjarni@1237: 
rubidium@6259: 	if (v->type != VEH_SHIP || !CheckOwnership(v->owner)) return CMD_ERROR;
smatz@8145: 	if (!v->IsStoppedInDepot()) return_cmd_error(STR_980B_SHIP_MUST_BE_STOPPED_IN);
smatz@8145: 	if (v->vehstatus & VS_CRASHED) return_cmd_error(STR_CAN_T_REFIT_DESTROYED_VEHICLE);
truelight@0: 
Darkvater@1802: 	/* Check cargo */
Darkvater@1802: 	if (!ShipVehInfo(v->engine_type)->refittable) return CMD_ERROR;
peter1138@6316: 	if (new_cid >= NUM_CARGO || !CanRefitTo(v->engine_type, new_cid)) return CMD_ERROR;
tron@915: 
peter1138@3989: 	/* Check the refit capacity callback */
skidd13@7928: 	if (HasBit(EngInfo(v->engine_type)->callbackmask, CBM_VEHICLE_REFIT_CAPACITY)) {
peter1138@3989: 		/* Back up the existing cargo type */
peter1138@3989: 		CargoID temp_cid = v->cargo_type;
peter1138@3989: 		byte temp_subtype = v->cargo_subtype;
peter1138@3989: 		v->cargo_type = new_cid;
peter1138@3989: 		v->cargo_subtype = new_subtype;
peter1138@3989: 
peter1138@3989: 		capacity = GetVehicleCallback(CBID_VEHICLE_REFIT_CAPACITY, 0, 0, v->engine_type, v);
peter1138@3989: 
peter1138@3989: 		/* Restore the cargo type */
peter1138@3989: 		v->cargo_type = temp_cid;
peter1138@3989: 		v->cargo_subtype = temp_subtype;
peter1138@3989: 	}
peter1138@3989: 
peter1138@3989: 	if (capacity == CALLBACK_FAILED) {
peter1138@6608: 		capacity = GetVehicleProperty(v, 0x0D, ShipVehInfo(v->engine_type)->capacity);
peter1138@3989: 	}
peter1138@3989: 	_returned_refit_capacity = capacity;
peter1138@3989: 
rubidium@10207: 	if (IsHumanCompany(v->owner) && new_cid != v->cargo_type) {
bjarni@4544: 		cost = GetRefitCost(v->engine_type);
truelight@0: 	}
truelight@0: 
truelight@0: 	if (flags & DC_EXEC) {
peter1138@3989: 		v->cargo_cap = capacity;
rubidium@7010: 		v->cargo.Truncate((v->cargo_type == new_cid) ? capacity : 0);
Darkvater@1802: 		v->cargo_type = new_cid;
peter1138@3954: 		v->cargo_subtype = new_subtype;
truelight@0: 		InvalidateWindow(WC_VEHICLE_DETAILS, v->index);
peter1138@3954: 		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);
rubidium@9297: 		InvalidateWindowClassesData(WC_SHIPS_LIST, 0);
truelight@0: 	}
truelight@0: 
truelight@0: 	return cost;
truelight@0: 
truelight@0: }