tron@2186: /* $Id$ */
tron@2186: 
celestar@9908: /** @file ship_cmd.cpp */
celestar@9908: 
truelight@0: #include "stdafx.h"
Darkvater@1891: #include "openttd.h"
tron@3961: #include "ship.h"
tron@507: #include "table/strings.h"
tron@2163: #include "functions.h"
celestar@9908: #include "landscape.h"
tron@679: #include "map.h"
tron@1209: #include "tile.h"
truelight@0: #include "vehicle.h"
truelight@0: #include "command.h"
truelight@0: #include "pathfind.h"
celestar@3442: #include "station_map.h"
truelight@0: #include "station.h"
truelight@0: #include "news.h"
truelight@0: #include "engine.h"
truelight@0: #include "player.h"
tron@337: #include "sound.h"
matthijs@1247: #include "npf.h"
truelight@1313: #include "depot.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"
rubidium@4261: #include "date.h"
bjarni@6223: #include "spritecache.h"
truelight@0: 
truelight@0: static const uint16 _ship_sprites[] = {0x0E5D, 0x0E55, 0x0E65, 0x0E6D};
truelight@0: 
rubidium@5838: static const TrackBits _ship_sometracks[4] = {
rubidium@5838: 	TRACK_BIT_X | TRACK_BIT_LOWER | TRACK_BIT_LEFT,  // 0x19, // DIAGDIR_NE
rubidium@5838: 	TRACK_BIT_Y | TRACK_BIT_UPPER | TRACK_BIT_LEFT,  // 0x16, // DIAGDIR_SE
rubidium@5838: 	TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_RIGHT, // 0x25, // DIAGDIR_SW
rubidium@5838: 	TRACK_BIT_Y | TRACK_BIT_LOWER | TRACK_BIT_RIGHT, // 0x2A, // DIAGDIR_NW
rubidium@5838: };
rubidium@5838: 
rubidium@5838: static TrackBits GetTileShipTrackStatus(TileIndex tile)
tron@1977: {
truelight@159: 	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);
rubidium@5838: 	return TrackdirBitsToTrackBits((TrackdirBits)(TRACKDIR_BIT_MASK & (r | r >> 8)));
truelight@0: }
truelight@0: 
peter1138@5919: void DrawShipEngine(int x, int y, EngineID engine, SpriteID pal)
truelight@0: {
tron@538: 	int spritenum = ShipVehInfo(engine)->image_index;
truelight@0: 
truelight@0: 	if (is_custom_sprite(spritenum)) {
tron@3186: 		int sprite = GetCustomVehicleIcon(engine, DIR_W);
truelight@0: 
tron@2639: 		if (sprite != 0) {
peter1138@5919: 			DrawSprite(sprite, pal, x, y);
truelight@0: 			return;
truelight@0: 		}
peter1138@2464: 		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;
truelight@0: 	}
peter1138@5919: 	DrawSprite(6 + _ship_sprites[spritenum], pal, x, y);
truelight@0: }
truelight@0: 
bjarni@6223: /** Get the size of the sprite of a ship sprite heading west (used for lists)
bjarni@6223:  * @param engine The engine to get the sprite from
celestar@9908:  * @param width The width of the sprite
celestar@9908:  * @param height The height of the sprite
bjarni@6223:  */
bjarni@6223: void GetShipSpriteSize(EngineID engine, uint &width, uint &height)
bjarni@6223: {
bjarni@6223: 	SpriteID spritenum = ShipVehInfo(engine)->image_index;
bjarni@6223: 	SpriteID custom_sprite = 0;
bjarni@6223: 
bjarni@6223: 	if (is_custom_sprite(spritenum)) {
bjarni@6223: 		custom_sprite = GetCustomVehicleIcon(engine, DIR_W);
bjarni@6223: 		spritenum = orig_ship_vehicle_info[engine - SHIP_ENGINES_INDEX].image_index;
bjarni@6223: 	}
bjarni@6223: 	if (custom_sprite == 0) {
bjarni@6223: 		spritenum = 6 + _ship_sprites[spritenum];
bjarni@6223: 	} else {
bjarni@6223: 		spritenum = custom_sprite;
bjarni@6223: 	}
bjarni@6223: 
bjarni@6223: 	const Sprite *spr = GetSprite(spritenum);
bjarni@6223: 
bjarni@6223: 	width  = spr->width;
bjarni@6223: 	height = spr->height;
bjarni@6223: }
bjarni@6223: 
tron@3157: int GetShipImage(const Vehicle* v, Direction direction)
truelight@0: {
truelight@0: 	int spritenum = v->spritenum;
truelight@0: 
truelight@0: 	if (is_custom_sprite(spritenum)) {
truelight@0: 		int sprite = GetCustomVehicleSprite(v, direction);
truelight@0: 
tron@2639: 		if (sprite != 0) return sprite;
peter1138@2464: 		spritenum = orig_ship_vehicle_info[v->engine_type - SHIP_ENGINES_INDEX].image_index;
truelight@0: 	}
truelight@0: 	return _ship_sprites[spritenum] + direction;
truelight@0: }
truelight@0: 
tron@2630: static const Depot* FindClosestShipDepot(const Vehicle* v)
truelight@0: {
tron@2630: 	const Depot* depot;
tron@2630: 	const Depot* best_depot = NULL;
tron@1977: 	uint dist;
tron@1977: 	uint best_dist = (uint)-1;
tron@1977: 	TileIndex tile;
tron@1977: 	TileIndex tile2 = v->tile;
truelight@0: 
matthijs@1247: 	if (_patches.new_pathfinding_all) {
matthijs@1247: 		NPFFoundTargetData ftd;
rubidium@5838: 		Trackdir trackdir = GetVehicleTrackdir(v);
matthijs@2006: 		ftd = NPFRouteToDepotTrialError(v->tile, trackdir, TRANSPORT_WATER, v->owner, INVALID_RAILTYPE);
tron@2639: 		if (ftd.best_bird_dist == 0) {
truelight@1313: 			best_depot = GetDepotByTile(ftd.node.tile); /* Found target */
tron@2639: 		} else {
truelight@1313: 			best_depot = NULL; /* Did not find target */
tron@2639: 		}
matthijs@1247: 	} else {
truelight@1313: 		FOR_ALL_DEPOTS(depot) {
truelight@1313: 			tile = depot->xy;
truelight@4346: 			if (IsTileDepotType(tile, TRANSPORT_WATER) && IsTileOwner(tile, v->owner)) {
matthijs@1247: 				dist = DistanceManhattan(tile, tile2);
matthijs@1247: 				if (dist < best_dist) {
matthijs@1247: 					best_dist = dist;
truelight@1313: 					best_depot = depot;
matthijs@1247: 				}
truelight@0: 			}
truelight@0: 		}
truelight@0: 	}
truelight@0: 	return best_depot;
truelight@0: }
truelight@0: 
truelight@0: static void CheckIfShipNeedsService(Vehicle *v)
truelight@0: {
tron@2630: 	const Depot* depot;
truelight@0: 
tron@2639: 	if (_patches.servint_ships == 0) return;
tron@2639: 	if (!VehicleNeedsService(v))     return;
tron@2639: 	if (v->vehstatus & VS_STOPPED)   return;
truelight@193: 
tron@555: 	if (v->current_order.type == OT_GOTO_DEPOT &&
celestar@1530: 			v->current_order.flags & OF_HALT_IN_DEPOT)
truelight@0: 		return;
truelight@0: 
tron@2639: 	if (_patches.gotodepot && VehicleHasDepotOrders(v)) return;
truelight@0: 
bjarni@4529: 	if (IsShipInDepot(v)) {
bjarni@4529: 		VehicleServiceInDepot(v);
bjarni@4529: 		return;
bjarni@4529: 	}
bjarni@4529: 
truelight@1313: 	depot = FindClosestShipDepot(v);
truelight@0: 
truelight@1313: 	if (depot == NULL || DistanceManhattan(v->tile, depot->xy) > 12) {
tron@555: 		if (v->current_order.type == OT_GOTO_DEPOT) {
tron@555: 			v->current_order.type = OT_DUMMY;
tron@555: 			v->current_order.flags = 0;
darkvater@755: 			InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
truelight@0: 		}
truelight@0: 		return;
truelight@0: 	}
truelight@0: 
tron@555: 	v->current_order.type = OT_GOTO_DEPOT;
tron@555: 	v->current_order.flags = OF_NON_STOP;
tron@4527: 	v->current_order.dest = depot->index;
truelight@1313: 	v->dest_tile = depot->xy;
darkvater@755: 	InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
truelight@0: }
truelight@0: 
truelight@0: void OnNewDay_Ship(Vehicle *v)
truelight@0: {
truelight@0: 	int32 cost;
truelight@0: 
truelight@0: 	if ((++v->day_counter & 7) == 0)
truelight@0: 		DecreaseVehicleValue(v);
truelight@0: 
truelight@0: 	CheckVehicleBreakdown(v);
truelight@0: 	AgeVehicle(v);
truelight@0: 	CheckIfShipNeedsService(v);
truelight@0: 
tron@3140: 	CheckOrders(v);
truelight@193: 
tron@2639: 	if (v->vehstatus & VS_STOPPED) return;
dominik@19: 
celestar@9903: 	cost = ShipVehInfo(v->engine_type)->running_cost * _eco->GetPrice(CEconomy::SHIP_RUNNING) / 364;
truelight@0: 	v->profit_this_year -= cost >> 8;
truelight@0: 
truelight@0: 	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);
truelight@0: 	SubtractMoneyFromPlayerFract(v->owner, cost);
truelight@0: 
truelight@0: 	InvalidateWindow(WC_VEHICLE_DETAILS, v->index);
celestar@9908: 	/* 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)) {
celestar@9906: 			SndPlayVehicleFx((_opt.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);
tron@2639: 			if (u != NULL) u->u.special.unk0 = 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: 
truelight@0: static void MarkShipDirty(Vehicle *v)
truelight@0: {
truelight@0: 	v->cur_image = GetShipImage(v, v->direction);
truelight@0: 	MarkAllViewportsDirty(v->left_coord, v->top_coord, v->right_coord + 1, v->bottom_coord + 1);
truelight@0: }
truelight@0: 
truelight@0: static void PlayShipSound(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: 
truelight@0: static void ProcessShipOrder(Vehicle *v)
truelight@0: {
truelight@1024: 	const Order *order;
truelight@0: 
tron@3005: 	switch (v->current_order.type) {
tron@3005: 		case OT_GOTO_DEPOT:
tron@3005: 			if (!(v->current_order.flags & OF_PART_OF_ORDERS)) return;
tron@3005: 			if (v->current_order.flags & OF_SERVICE_IF_NEEDED &&
tron@3005: 					!VehicleNeedsService(v)) {
tron@3005: 				v->cur_order_index++;
tron@3005: 			}
tron@3005: 			break;
tron@3005: 
tron@3005: 		case OT_LOADING:
tron@3005: 		case OT_LEAVESTATION:
truelight@0: 			return;
truelight@4351: 
truelight@4351: 		default: break;
truelight@0: 	}
truelight@0: 
tron@3005: 	if (v->cur_order_index >= v->num_orders) v->cur_order_index = 0;
truelight@0: 
truelight@1024: 	order = GetVehicleOrder(v, v->cur_order_index);
truelight@0: 
truelight@1024: 	if (order == NULL) {
celestar@9895: 		v->current_order.Free();
truelight@0: 		v->dest_tile = 0;
truelight@0: 		return;
truelight@0: 	}
truelight@0: 
tron@4527: 	if (order->type  == v->current_order.type &&
tron@4527: 			order->flags == v->current_order.flags &&
tron@4527: 			order->dest  == v->current_order.dest)
truelight@0: 		return;
truelight@0: 
truelight@1024: 	v->current_order = *order;
truelight@0: 
truelight@1024: 	if (order->type == OT_GOTO_STATION) {
truelight@1024: 		const Station *st;
truelight@1024: 
tron@4527: 		if (order->dest == v->last_station_visited)
truelight@1266: 			v->last_station_visited = INVALID_STATION;
truelight@193: 
tron@4527: 		st = GetStation(order->dest);
truelight@0: 		if (st->dock_tile != 0) {
celestar@3472: 			v->dest_tile = TILE_ADD(st->dock_tile, ToTileIndexDiff(GetDockOffset(st->dock_tile)));
truelight@0: 		}
truelight@1024: 	} else if (order->type == OT_GOTO_DEPOT) {
tron@4527: 		v->dest_tile = GetDepot(order->dest)->xy;
truelight@0: 	} else {
truelight@0: 		v->dest_tile = 0;
truelight@0: 	}
truelight@1024: 
truelight@1024: 	InvalidateVehicleOrder(v);
celestar@1020: 
Celestar@1055: 	InvalidateWindowClasses(WC_SHIPS_LIST);
truelight@0: }
truelight@0: 
truelight@0: static void HandleShipLoading(Vehicle *v)
truelight@0: {
tron@6107: 	switch (v->current_order.type) {
peter1138@6109: 		case OT_LOADING: {
tron@6107: 			if (--v->load_unload_time_rem) return;
truelight@0: 
tron@6107: 			if (CanFillVehicle(v) && (
tron@6107: 						v->current_order.flags & OF_FULL_LOAD ||
maedhros@6501: 						(_patches.gradual_loading && !HASBIT(v->vehicle_flags, VF_LOADING_FINISHED))
tron@6107: 					)) {
tron@6107: 				SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);
tron@6107: 				if (LoadUnloadVehicle(v, false)) {
tron@6107: 					InvalidateWindow(WC_SHIPS_LIST, v->owner);
tron@6107: 					MarkShipDirty(v);
tron@6107: 				}
tron@6107: 				return;
truelight@0: 			}
tron@6107: 			PlayShipSound(v);
truelight@193: 
tron@555: 			Order b = v->current_order;
KUDr@5902: 			v->LeaveStation();
tron@2639: 			if (!(b.flags & OF_NON_STOP)) return;
tron@6107: 			break;
peter1138@6109: 		}
tron@6107: 
tron@6107: 		case OT_DUMMY: break;
tron@6107: 
tron@6107: 		default: return;
truelight@0: 	}
truelight@0: 
truelight@0: 	v->cur_order_index++;
truelight@1024: 	InvalidateVehicleOrder(v);
truelight@0: }
truelight@0: 
truelight@0: static void UpdateShipDeltaXY(Vehicle *v, int dir)
truelight@0: {
truelight@0: #define MKIT(d,c,b,a) ((a&0xFF)<<24) | ((b&0xFF)<<16) | ((c&0xFF)<<8) | ((d&0xFF)<<0)
truelight@0: 	static const uint32 _delta_xy_table[8] = {
rubidium@4344: 		MKIT( -3,  -3,  6,  6),
rubidium@4344: 		MKIT(-16,  -3, 32,  6),
rubidium@4344: 		MKIT( -3,  -3,  6,  6),
rubidium@4344: 		MKIT( -3, -16,  6, 32),
rubidium@4344: 		MKIT( -3,  -3,  6,  6),
rubidium@4344: 		MKIT(-16,  -3, 32,  6),
rubidium@4344: 		MKIT( -3,  -3,  6,  6),
rubidium@4344: 		MKIT( -3, -16,  6, 32),
truelight@0: 	};
truelight@0: #undef MKIT
truelight@0: 	uint32 x = _delta_xy_table[dir];
tron@2150: 	v->x_offs        = GB(x,  0, 8);
tron@2150: 	v->y_offs        = GB(x,  8, 8);
tron@2150: 	v->sprite_width  = GB(x, 16, 8);
tron@2150: 	v->sprite_height = GB(x, 24, 8);
truelight@0: }
truelight@0: 
bjarni@4725: void RecalcShipStuff(Vehicle *v)
truelight@0: {
truelight@0: 	UpdateShipDeltaXY(v, v->direction);
truelight@0: 	v->cur_image = GetShipImage(v, v->direction);
truelight@0: 	MarkShipDirty(v);
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: {
tron@1977: 	TileIndex tile;
celestar@3454: 	Axis axis;
truelight@0: 	uint m;
truelight@0: 
tron@3961: 	if (!IsShipInDepot(v)) return;
truelight@0: 
truelight@0: 	tile = v->tile;
celestar@3454: 	axis = GetShipDepotAxis(tile);
truelight@0: 
celestar@9908: 	/* Check first side */
celestar@3454: 	if (_ship_sometracks[axis] & GetTileShipTrackStatus(TILE_ADD(tile, ToTileIndexDiff(_ship_leave_depot_offs[axis])))) {
celestar@3454: 		m = (axis == AXIS_X) ? 0x101 : 0x207;
celestar@9908: 	/* Check second side */
celestar@3454: 	} else if (_ship_sometracks[axis + 2] & GetTileShipTrackStatus(TILE_ADD(tile, -2 * ToTileIndexDiff(_ship_leave_depot_offs[axis])))) {
celestar@3454: 		m = (axis == AXIS_X) ? 0x105 : 0x203;
truelight@0: 	} else {
truelight@0: 		return;
truelight@0: 	}
rubidium@5838: 	v->direction    = (Direction)GB(m, 0, 8);
rubidium@5838: 	v->u.ship.state = (TrackBits)GB(m, 8, 8);
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: 
celestar@9910: 	spd = min(v->cur_speed + 1, GetVehicleProperty(v, 0x0B, v->max_speed));
truelight@0: 
celestar@9908: 	/*updates statusbar only if speed have changed to save CPU time */
truelight@0: 	if (spd != v->cur_speed) {
truelight@193: 		v->cur_speed = spd;
truelight@0: 		if (_patches.vehicle_speed)
darkvater@755: 			InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
truelight@0: 	}
truelight@0: 
celestar@9908: 	/* 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: 
tron@2817: static int32 EstimateShipCost(EngineID engine_type)
Darkvater@1793: {
celestar@9903: 	return ShipVehInfo(engine_type)->base_cost * (_eco->GetPrice(CEconomy::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: 		uint32 flags;
tron@2639: 
truelight@0: 		st->had_vehicle_of_type |= HVOT_SHIP;
tron@2639: 
tron@534: 		SetDParam(0, st->index);
truelight@0: 		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);
truelight@0: 		AddNewsItem(
truelight@0: 			STR_9833_CITIZENS_CELEBRATE_FIRST,
truelight@0: 			flags,
truelight@0: 			v->index,
truelight@0: 			0);
truelight@0: 	}
truelight@0: }
truelight@0: 
celestar@9895: struct PathFindShip {
tron@1977: 	TileIndex skiptile;
tron@1977: 	TileIndex dest_coords;
truelight@0: 	uint best_bird_dist;
truelight@0: 	uint best_length;
celestar@9895: };
truelight@0: 
tron@1977: static bool ShipTrackFollower(TileIndex tile, PathFindShip *pfs, int track, uint length, byte *state)
truelight@0: {
celestar@9908: 	/* 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: 
celestar@9908: 	/* 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@5838: static uint FindShipTrack(Vehicle *v, TileIndex tile, DiagDirection dir, TrackBits bits, TileIndex skiptile, Track *track)
truelight@0: {
truelight@0: 	PathFindShip pfs;
rubidium@5838: 	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@5838: 	best_track = INVALID_TRACK;
truelight@0: 
truelight@0: 	do {
KUDr@5849: 		i = RemoveFirstTrack(&bits);
truelight@193: 
truelight@0: 		pfs.best_bird_dist = (uint)-1;
truelight@0: 		pfs.best_length = (uint)-1;
truelight@0: 
rubidium@5838: 		FollowTrack(tile, 0x3800 | TRANSPORT_WATER, (DiagDirection)_ship_search_directions[i][dir], (TPFEnumProc*)ShipTrackFollower, NULL, &pfs);
truelight@193: 
rubidium@5838: 		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: 
KUDr@3900: static inline NPFFoundTargetData PerfNPFRouteToStationOrTile(TileIndex tile, Trackdir trackdir, NPFFindStationOrTileData* target, TransportType type, Owner owner, RailTypeMask railtypes)
KUDr@3900: {
KUDr@3900: 
KUDr@3900: 	void* perf = NpfBeginInterval();
KUDr@3900: 	NPFFoundTargetData ret = NPFRouteToStationOrTile(tile, trackdir, target, type, owner, railtypes);
KUDr@3900: 	int t = NpfEndInterval(perf);
Darkvater@5568: 	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: 
celestar@9908: /** 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@5838: static Track ChooseShipTrack(Vehicle *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks)
truelight@0: {
celestar@9910: 	assert(enterdir >= 0 && enterdir <= 3);
truelight@0: 
KUDr@3900: 	if (_patches.yapf.ship_use_yapf) {
KUDr@3900: 		Trackdir trackdir = YapfChooseShipTrack(v, tile, enterdir, tracks);
rubidium@5838: 		return (trackdir != INVALID_TRACKDIR) ? TrackdirToTrack(trackdir) : INVALID_TRACK;
KUDr@3900: 	} else if (_patches.new_pathfinding_all) {
matthijs@1247: 		NPFFindStationOrTileData fstd;
matthijs@1247: 		NPFFoundTargetData ftd;
Darkvater@4559: 		TileIndex src_tile = TILE_ADD(tile, TileOffsByDiagDir(ReverseDiagDir(enterdir)));
rubidium@5838: 		Trackdir trackdir = GetVehicleTrackdir(v);
celestar@9908: 		assert(trackdir != INVALID_TRACKDIR); // Check that we are not in a depot
matthijs@1247: 
matthijs@1247: 		NPFFillWithOrderData(&fstd, v);
matthijs@1247: 
KUDr@3900: 		ftd = PerfNPFRouteToStationOrTile(src_tile, trackdir, &fstd, TRANSPORT_WATER, v->owner, INVALID_RAILTYPE);
matthijs@1247: 
tron@2639: 		if (ftd.best_trackdir != 0xff) {
matthijs@1698: 			/* If ftd.best_bird_dist is 0, we found our target and ftd.best_trackdir contains
matthijs@1698: 			the direction we need to take to get there, if ftd.best_bird_dist is not 0,
matthijs@1698: 			we did not find our target, but ftd.best_trackdir contains the direction leading
matthijs@1698: 			to the tile closest to our target. */
rubidium@5838: 			return TrackdirToTrack(ftd.best_trackdir); /* TODO: Wrapper function? */
tron@2639: 		} else {
rubidium@5838: 			return INVALID_TRACK; /* Already at target, reverse? */
tron@2639: 		}
matthijs@1247: 	} else {
matthijs@1247: 		uint tot_dist, dist;
rubidium@5838: 		Track track;
tron@1977: 		TileIndex tile2;
matthijs@1247: 
Darkvater@4559: 		tile2 = TILE_ADD(tile, -TileOffsByDiagDir(enterdir));
matthijs@1247: 		tot_dist = (uint)-1;
matthijs@1247: 
matthijs@1247: 		/* Let's find out how far it would be if we would reverse first */
rubidium@5838: 		TrackBits b = GetTileShipTrackStatus(tile2) & _ship_sometracks[ReverseDiagDir(enterdir)] & v->u.ship.state;
matthijs@1247: 		if (b != 0) {
tron@3147: 			dist = FindShipTrack(v, tile2, ReverseDiagDir(enterdir), b, tile, &track);
matthijs@1247: 			if (dist != (uint)-1)
matthijs@1247: 				tot_dist = dist + 1;
matthijs@1247: 		}
matthijs@1247: 		/* And if we would not reverse? */
matthijs@1247: 		dist = FindShipTrack(v, tile, enterdir, tracks, 0, &track);
matthijs@1247: 		if (dist > tot_dist)
matthijs@1247: 			/* We could better reverse */
rubidium@5838: 			return INVALID_TRACK;
matthijs@1247: 		return track;
truelight@0: 	}
truelight@0: }
truelight@0: 
tron@3157: static const Direction _new_vehicle_direction_table[] = {
rubidium@5838: 	DIR_N , DIR_NW, DIR_W , INVALID_DIR,
rubidium@5838: 	DIR_NE, DIR_N , DIR_SW, INVALID_DIR,
tron@3157: 	DIR_E , DIR_SE, DIR_S
truelight@0: };
truelight@0: 
rubidium@5838: 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@5838: 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: 
rubidium@5838: static TrackBits GetAvailShipTracks(TileIndex tile, int dir)
truelight@0: {
truelight@159: 	uint32 r = GetTileTrackStatus(tile, TRANSPORT_WATER);
rubidium@5838: 	return (TrackBits)((r | r >> 8) & _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},
celestar@9910: 		{ 8, 15, 7},
truelight@0: 		{ 0, 0, 0},
celestar@9910: 		{ 8, 15, 6},
truelight@0: 		{ 0, 0, 0},
celestar@9910: 		{ 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@5838: 	Track track;
rubidium@5838: 	TrackBits tracks;
truelight@0: 
truelight@0: 	v->tick_counter++;
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: 		}
truelight@0: 		v->breakdown_ctr--;
truelight@0: 	}
truelight@0: 
tron@2639: 	if (v->vehstatus & VS_STOPPED) return;
truelight@0: 
truelight@0: 	ProcessShipOrder(v);
truelight@0: 	HandleShipLoading(v);
truelight@0: 
tron@2639: 	if (v->current_order.type == 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@6479: 	GetNewVehiclePosResult gp = GetNewVehiclePos(v);
tron@6478: 	if (gp.old_tile == gp.new_tile) {
rubidium@6320: 		/* Staying in tile */
tron@3961: 		if (IsShipInDepot(v)) {
truelight@0: 			gp.x = v->x_pos;
truelight@0: 			gp.y = v->y_pos;
truelight@0: 		} else {
rubidium@6320: 			/* Not inside depot */
truelight@0: 			r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
rubidium@6317: 			if (HASBIT(r, VETS_CANNOT_ENTER)) goto reverse_direction;
truelight@0: 
matthijs@1751: 			/* A leave station order only needs one tick to get processed, so we can
matthijs@1751: 			 * always skip ahead. */
tron@555: 			if (v->current_order.type == OT_LEAVESTATION) {
celestar@9895: 				v->current_order.Free();
darkvater@755: 				InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
matthijs@1751: 			} else if (v->dest_tile != 0) {
matthijs@1751: 				/* We have a target, let's see if we reached it... */
matthijs@1751: 				if (v->current_order.type == OT_GOTO_STATION &&
matthijs@1751: 						IsBuoyTile(v->dest_tile) &&
matthijs@1751: 						DistanceManhattan(v->dest_tile, gp.new_tile) <= 3) {
matthijs@1751: 					/* We got within 3 tiles of our target buoy, so let's skip to our
matthijs@1751: 					 * next order */
matthijs@1751: 					v->cur_order_index++;
matthijs@1751: 					v->current_order.type = OT_DUMMY;
matthijs@1751: 					InvalidateVehicleOrder(v);
matthijs@1751: 				} else {
matthijs@1751: 					/* Non-buoy orders really need to reach the tile */
matthijs@1751: 					if (v->dest_tile == gp.new_tile) {
matthijs@1751: 						if (v->current_order.type == OT_GOTO_DEPOT) {
rubidium@6320: 							if ((gp.x & 0xF) == 8 && (gp.y & 0xF) == 8) {
bjarni@4725: 								VehicleEnterDepot(v);
matthijs@1751: 								return;
matthijs@1751: 							}
matthijs@1751: 						} else if (v->current_order.type == OT_GOTO_STATION) {
matthijs@1751: 							Station *st;
matthijs@1751: 
tron@4527: 							v->last_station_visited = v->current_order.dest;
matthijs@1751: 
matthijs@1751: 							/* Process station in the orderlist. */
tron@4527: 							st = GetStation(v->current_order.dest);
celestar@9908: 							if (st->facilities & FACIL_DOCK) { // ugly, ugly workaround for problem with ships able to drop off cargo at wrong stations
KUDr@5902: 								v->BeginLoading();
celestar@3610: 								v->current_order.flags &= OF_FULL_LOAD | OF_UNLOAD | OF_TRANSFER;
matthijs@1751: 								v->current_order.flags |= OF_NON_STOP;
matthijs@1751: 								ShipArrivesAt(v, st);
matthijs@1751: 
matthijs@1751: 								SET_EXPENSES_TYPE(EXPENSES_SHIP_INC);
peter1138@5211: 								if (LoadUnloadVehicle(v, true)) {
matthijs@1751: 									InvalidateWindow(WC_SHIPS_LIST, v->owner);
matthijs@1751: 									MarkShipDirty(v);
matthijs@1751: 								}
matthijs@1751: 								InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
celestar@9908: 							} else { // leave stations without docks right aways
matthijs@1751: 								v->current_order.type = OT_LEAVESTATION;
matthijs@1751: 								v->cur_order_index++;
matthijs@1751: 								InvalidateVehicleOrder(v);
matthijs@1751: 							}
matthijs@1751: 						}
matthijs@1751: 					}
matthijs@1751: 				}
truelight@0: 			}
truelight@0: 		}
truelight@0: 	} else {
tron@3157: 		DiagDirection diagdir;
rubidium@6320: 		/* New tile */
rubidium@6320: 		if (TileX(gp.new_tile) >= MapMaxX() || TileY(gp.new_tile) >= MapMaxY()) {
tron@926: 			goto reverse_direction;
rubidium@6320: 		}
truelight@0: 
truelight@0: 		dir = ShipGetNewDirectionFromTiles(gp.new_tile, gp.old_tile);
tron@3157: 		assert(dir == DIR_NE || dir == DIR_SE || dir == DIR_SW || dir == DIR_NW);
tron@3157: 		diagdir = DirToDiagDir(dir);
tron@3157: 		tracks = GetAvailShipTracks(gp.new_tile, diagdir);
rubidium@6320: 		if (tracks == TRACK_BIT_NONE) goto reverse_direction;
truelight@0: 
rubidium@6320: 		/* Choose a direction, and continue if we find one */
tron@3157: 		track = ChooseShipTrack(v, gp.new_tile, diagdir, tracks);
rubidium@6320: 		if (track == INVALID_TRACK) goto reverse_direction;
truelight@0: 
tron@3157: 		b = _ship_subcoord[diagdir][track];
truelight@193: 
rubidium@6320: 		gp.x = (gp.x & ~0xF) | b[0];
rubidium@6320: 		gp.y = (gp.y & ~0xF) | b[1];
truelight@0: 
truelight@0: 		/* Call the landscape function and tell it that the vehicle entered the tile */
truelight@0: 		r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
rubidium@6317: 		if (HASBIT(r, VETS_CANNOT_ENTER)) goto reverse_direction;
truelight@0: 
rubidium@6317: 		if (!HASBIT(r, VETS_ENTERED_WORMHOLE)) {
truelight@0: 			v->tile = gp.new_tile;
rubidium@5838: 			v->u.ship.state = TrackToTrackBits(track);
truelight@0: 		}
truelight@0: 
rubidium@5838: 		v->direction = (Direction)b[2];
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:
truelight@0: 	UpdateShipDeltaXY(v, dir);
truelight@0: 	v->cur_image = GetShipImage(v, 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;
tron@2639: 	if (v->cargo_days != 255) v->cargo_days++;
truelight@0: }
truelight@0: 
truelight@0: void Ship_Tick(Vehicle *v)
truelight@0: {
truelight@0: 	AgeShipCargo(v);
truelight@0: 	ShipController(v);
truelight@0: }
truelight@0: 
truelight@0: 
celestar@9895: void ShipsYearlyLoop()
truelight@0: {
truelight@0: 	Vehicle *v;
truelight@0: 
truelight@0: 	FOR_ALL_VEHICLES(v) {
celestar@9895: 		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
celestar@9908:  * @param flags type of operation
Darkvater@1793:  * @param p1 ship type being built (engine)
bjarni@3816:  * @param p2 bit 0 when set, the unitnumber will be 0, otherwise it will be a free number
Darkvater@1793:  */
tron@3491: int32 CmdBuildShip(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
truelight@0: 	int32 value;
truelight@0: 	Vehicle *v;
truelight@1282: 	UnitID unit_num;
truelight@0: 	Engine *e;
truelight@193: 
celestar@9908: 	if (!IsEngineBuildable(p1, VEH_SHIP, _current_player)) return_cmd_error(STR_SHIP_NOT_AVAILABLE);
bjarni@1196: 
truelight@0: 	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);
truelight@0: 
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 */
pasky@1443: 	if (!IsTileDepotType(tile, TRANSPORT_WATER)) return CMD_ERROR;
tron@1901: 	if (!IsTileOwner(tile, _current_player)) return CMD_ERROR;
pasky@1443: 
truelight@0: 	v = AllocateVehicle();
celestar@9895: 	unit_num = HASBIT(p2, 0) ? 0 : GetFreeUnitNumber(VEH_SHIP);
bjarni@3816: 
tron@6173: 	if (v == NULL || unit_num > _patches.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: 
truelight@0: 		v->unitnumber = unit_num;
truelight@0: 
truelight@0: 		v->owner = _current_player;
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;
celestar@9910: 		v->z_pos = GetSlopeZ(x, y);
truelight@0: 
truelight@0: 		v->z_height = 6;
truelight@0: 		v->sprite_width = 6;
truelight@0: 		v->sprite_height = 6;
truelight@0: 		v->x_offs = -3;
truelight@0: 		v->y_offs = -3;
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;
truelight@0: 		v->value = value;
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: 
truelight@0: 		v->string_id = STR_SV_SHIP_NAME;
rubidium@6319: 		v->u.ship.state = TRACK_BIT_DEPOT;
truelight@0: 
truelight@0: 		v->service_interval = _patches.servint_ships;
truelight@0: 		v->date_of_last_service = _date;
rubidium@4329: 		v->build_year = _cur_year;
truelight@0: 		v->cur_image = 0x0E5E;
celestar@9895: 		v->type = VEH_SHIP;
peter1138@2804: 		v->random_bits = VehicleRandomBits();
truelight@0: 
maedhros@6502: 		v->vehicle_flags = 0;
maedhros@6502: 		if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) SETBIT(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE);
maedhros@6502: 
truelight@0: 		VehiclePositionChanged(v);
truelight@0: 
bjarni@4739: 		InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
tron@588: 		RebuildVehicleLists();
truelight@0: 		InvalidateWindow(WC_COMPANY, v->owner);
bjarni@2618: 		if (IsLocalPlayer())
celestar@9895: 			InvalidateAutoreplaceWindow(VEH_SHIP); // updates the replace Ship window
bjarni@6195: 
bjarni@6195: 		GetPlayer(_current_player)->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
celestar@9908:  * @param flags type of operation
Darkvater@1793:  * @param p1 vehicle ID to be sold
Darkvater@1793:  * @param p2 unused
Darkvater@1793:  */
tron@3491: int32 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: 
celestar@9895: 	if (v->type != VEH_SHIP || !CheckOwnership(v->owner)) return CMD_ERROR;
truelight@0: 
bjarni@1237: 	SET_EXPENSES_TYPE(EXPENSES_NEW_VEHICLES);
bjarni@1237: 
tron@3961: 	if (!IsShipInDepotStopped(v)) {
truelight@0: 		return_cmd_error(STR_980B_SHIP_MUST_BE_STOPPED_IN);
tron@3961: 	}
truelight@193: 
truelight@0: 	if (flags & DC_EXEC) {
truelight@0: 		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);
tron@588: 		RebuildVehicleLists();
truelight@0: 		InvalidateWindow(WC_COMPANY, v->owner);
truelight@0: 		DeleteWindowById(WC_VEHICLE_VIEW, v->index);
bjarni@5256: 		DeleteDepotHighlightOfVehicle(v);
truelight@0: 		DeleteVehicle(v);
truelight@0: 	}
truelight@193: 
truelight@0: 	return -(int32)v->value;
truelight@0: }
truelight@0: 
Darkvater@1793: /** Start/Stop a ship.
tron@3491:  * @param tile unused
celestar@9908:  * @param flags type of operation
Darkvater@1793:  * @param p1 ship ID to start/stop
Darkvater@1793:  * @param p2 unused
Darkvater@1793:  */
tron@3491: int32 CmdStartStopShip(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
truelight@0: 	Vehicle *v;
peter1138@4244: 	uint16 callback;
truelight@0: 
truelight@4352: 	if (!IsValidVehicleID(p1)) return CMD_ERROR;
bjarni@1237: 
truelight@919: 	v = GetVehicle(p1);
truelight@0: 
celestar@9895: 	if (v->type != VEH_SHIP || !CheckOwnership(v->owner)) return CMD_ERROR;
truelight@0: 
peter1138@4244: 	/* Check if this ship can be started/stopped. The callback will fail or
peter1138@4244: 	 * return 0xFF if it can. */
peter1138@4244: 	callback = GetVehicleCallback(CBID_VEHICLE_START_STOP_CHECK, 0, 0, v->engine_type, v);
peter1138@4244: 	if (callback != CALLBACK_FAILED && callback != 0xFF) {
peter1138@4244: 		StringID error = GetGRFStringID(GetEngineGRFID(v->engine_type), 0xD000 + callback);
peter1138@4244: 		return_cmd_error(error);
peter1138@4244: 	}
peter1138@4244: 
truelight@0: 	if (flags & DC_EXEC) {
tron@3961: 		if (IsShipInDepotStopped(v)) {
tron@3139: 			DeleteVehicleNews(p1, STR_981C_SHIP_IS_WAITING_IN_DEPOT);
tron@3139: 		}
tron@3139: 
truelight@0: 		v->vehstatus ^= VS_STOPPED;
darkvater@755: 		InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
truelight@0: 		InvalidateWindow(WC_VEHICLE_DEPOT, v->tile);
Darkvater@1793: 		InvalidateWindowClasses(WC_SHIPS_LIST);
truelight@0: 	}
truelight@0: 
truelight@0: 	return 0;
truelight@0: }
truelight@0: 
Darkvater@1793: /** Send a ship to the depot.
tron@3491:  * @param tile unused
celestar@9908:  * @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:  */
tron@3491: int32 CmdSendShipToDepot(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
truelight@0: 	Vehicle *v;
Darkvater@1793: 	const Depot *dep;
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;
celestar@9895: 		return SendAllVehiclesToDepot(VEH_SHIP, flags, p2 & DEPOT_SERVICE, _current_player, (p2 & VLW_MASK), p1);
bjarni@4463: 	}
bjarni@4463: 
bjarni@4506: 	if (!IsValidVehicleID(p1)) return CMD_ERROR;
bjarni@1237: 
truelight@919: 	v = GetVehicle(p1);
truelight@0: 
celestar@9895: 	if (v->type != VEH_SHIP || !CheckOwnership(v->owner)) return CMD_ERROR;
truelight@0: 
bjarni@4506: 	if (v->vehstatus & VS_CRASHED) return CMD_ERROR;
matthijs@1757: 
bjarni@4526: 	if (IsShipInDepot(v)) return CMD_ERROR;
bjarni@4526: 
Darkvater@1793: 	/* If the current orders are already goto-depot */
tron@555: 	if (v->current_order.type == OT_GOTO_DEPOT) {
bjarni@4519: 		if (!!(p2 & DEPOT_SERVICE) == HASBIT(v->current_order.flags, OFB_HALT_IN_DEPOT)) {
bjarni@4510: 			/* We called with a different DEPOT_SERVICE setting.
bjarni@4510: 			 * Now we change the setting to apply the new one and let the vehicle head for the same depot.
bjarni@4510: 			 * Note: the if is (true for requesting service == true for ordered to stop in depot)          */
bjarni@4510: 			if (flags & DC_EXEC) {
bjarni@4510: 				TOGGLEBIT(v->current_order.flags, OFB_HALT_IN_DEPOT);
bjarni@4510: 				InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
bjarni@4510: 			}
bjarni@4510: 			return 0;
bjarni@4510: 		}
bjarni@4510: 
bjarni@4506: 		if (p2 & DEPOT_DONT_CANCEL) return CMD_ERROR; // Requested no cancelation of depot orders
truelight@0: 		if (flags & DC_EXEC) {
Darkvater@1793: 			/* If the orders to 'goto depot' are in the orders list (forced servicing),
Darkvater@1793: 			 * then skip to the next order; effectively cancelling this forced service */
celestar@1530: 			if (HASBIT(v->current_order.flags, OFB_PART_OF_ORDERS))
celestar@1530: 				v->cur_order_index++;
celestar@1530: 
tron@555: 			v->current_order.type = OT_DUMMY;
tron@555: 			v->current_order.flags = 0;
darkvater@755: 			InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
truelight@0: 		}
Darkvater@1793: 		return 0;
Darkvater@1793: 	}
truelight@0: 
Darkvater@1793: 	dep = FindClosestShipDepot(v);
bjarni@4506: 	if (dep == NULL) return_cmd_error(STR_981A_UNABLE_TO_FIND_LOCAL_DEPOT);
Darkvater@1793: 
Darkvater@1793: 	if (flags & DC_EXEC) {
celestar@9910: 		if (v->current_order.type == OT_LOADING) v->LeaveStation();
celestar@9910: 
Darkvater@1793: 		v->dest_tile = dep->xy;
Darkvater@1793: 		v->current_order.type = OT_GOTO_DEPOT;
bjarni@4412: 		v->current_order.flags = OF_NON_STOP;
bjarni@4506: 		if (!(p2 & DEPOT_SERVICE)) SETBIT(v->current_order.flags, OFB_HALT_IN_DEPOT);
bjarni@5259: 		v->current_order.refit_cargo = CT_INVALID;
tron@4527: 		v->current_order.dest = dep->index;
Darkvater@1793: 		InvalidateWindowWidget(WC_VEHICLE_VIEW, v->index, STATUS_BAR);
truelight@0: 	}
truelight@0: 
truelight@0: 	return 0;
truelight@0: }
truelight@0: 
truelight@0: 
Darkvater@1802: /** Refits a ship to the specified cargo type.
tron@3491:  * @param tile unused
celestar@9908:  * @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
Darkvater@1802:  */
tron@3491: int32 CmdRefitShip(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)
truelight@0: {
truelight@0: 	Vehicle *v;
truelight@0: 	int32 cost;
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: 
celestar@9895: 	if (v->type != VEH_SHIP || !CheckOwnership(v->owner)) return CMD_ERROR;
bjarni@2567: 
tron@3961: 	if (!IsShipInDepotStopped(v)) {
tron@3961: 		return_cmd_error(STR_980B_SHIP_MUST_BE_STOPPED_IN);
tron@3961: 	}
truelight@0: 
Darkvater@1802: 	/* Check cargo */
Darkvater@1802: 	if (!ShipVehInfo(v->engine_type)->refittable) return CMD_ERROR;
celestar@9895: 	if (new_cid >= NUM_CARGO || !CanRefitTo(v->engine_type, new_cid)) return CMD_ERROR;
tron@915: 
bjarni@1237: 	SET_EXPENSES_TYPE(EXPENSES_SHIP_RUN);
bjarni@1237: 
peter1138@3989: 	/* Check the refit capacity callback */
peter1138@3989: 	if (HASBIT(EngInfo(v->engine_type)->callbackmask, CBM_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@3989: 		capacity = ShipVehInfo(v->engine_type)->capacity;
peter1138@3989: 	}
peter1138@3989: 	_returned_refit_capacity = capacity;
peter1138@3989: 
truelight@0: 	cost = 0;
Darkvater@4845: 	if (IsHumanPlayer(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;
peter1138@3955: 		v->cargo_count = (v->cargo_type == new_cid) ? min(v->cargo_cap, v->cargo_count) : 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);
peter1138@3954: 		RebuildVehicleLists();
truelight@0: 	}
truelight@0: 
truelight@0: 	return cost;
truelight@0: 
truelight@0: }