00001
00002
00003
00004
00005
00006
00007
00008
00009
00012 #include "stdafx.h"
00013 #include "ship.h"
00014 #include "landscape.h"
00015 #include "timetable.h"
00016 #include "news_func.h"
00017 #include "company_func.h"
00018 #include "pathfinder/npf/npf_func.h"
00019 #include "depot_base.h"
00020 #include "station_base.h"
00021 #include "vehicle_gui.h"
00022 #include "newgrf_engine.h"
00023 #include "pathfinder/yapf/yapf.h"
00024 #include "newgrf_sound.h"
00025 #include "spritecache.h"
00026 #include "strings_func.h"
00027 #include "window_func.h"
00028 #include "date_func.h"
00029 #include "vehicle_func.h"
00030 #include "sound_func.h"
00031 #include "ai/ai.hpp"
00032 #include "pathfinder/opf/opf_ship.h"
00033 #include "engine_base.h"
00034 #include "company_base.h"
00035 #include "cargotype.h"
00036
00037 #include "table/strings.h"
00038
00039 static const uint16 _ship_sprites[] = {0x0E5D, 0x0E55, 0x0E65, 0x0E6D};
00040
00041 static inline TrackBits GetTileShipTrackStatus(TileIndex tile)
00042 {
00043 return TrackStatusToTrackBits(GetTileTrackStatus(tile, TRANSPORT_WATER, 0));
00044 }
00045
00046 static SpriteID GetShipIcon(EngineID engine)
00047 {
00048 const Engine *e = Engine::Get(engine);
00049 uint8 spritenum = e->u.ship.image_index;
00050
00051 if (is_custom_sprite(spritenum)) {
00052 SpriteID sprite = GetCustomVehicleIcon(engine, DIR_W);
00053 if (sprite != 0) return sprite;
00054
00055 spritenum = e->original_image_index;
00056 }
00057
00058 return DIR_W + _ship_sprites[spritenum];
00059 }
00060
00061 void DrawShipEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal)
00062 {
00063 SpriteID sprite = GetShipIcon(engine);
00064 const Sprite *real_sprite = GetSprite(sprite, ST_NORMAL);
00065 preferred_x = Clamp(preferred_x, left - real_sprite->x_offs, right - real_sprite->width - real_sprite->x_offs);
00066 DrawSprite(sprite, pal, preferred_x, y);
00067 }
00068
00075 void GetShipSpriteSize(EngineID engine, uint &width, uint &height)
00076 {
00077 const Sprite *spr = GetSprite(GetShipIcon(engine), ST_NORMAL);
00078
00079 width = spr->width;
00080 height = spr->height;
00081 }
00082
00083 SpriteID Ship::GetImage(Direction direction) const
00084 {
00085 uint8 spritenum = this->spritenum;
00086
00087 if (is_custom_sprite(spritenum)) {
00088 SpriteID sprite = GetCustomVehicleSprite(this, direction);
00089 if (sprite != 0) return sprite;
00090
00091 spritenum = Engine::Get(this->engine_type)->original_image_index;
00092 }
00093
00094 return _ship_sprites[spritenum] + direction;
00095 }
00096
00097 static const Depot *FindClosestShipDepot(const Vehicle *v, uint max_distance)
00098 {
00099
00100 const Depot *depot;
00101 const Depot *best_depot = NULL;
00102
00103
00104
00105
00106
00107 uint best_dist = max_distance == 0 ? UINT_MAX : max_distance + 1;
00108
00109 FOR_ALL_DEPOTS(depot) {
00110 TileIndex tile = depot->xy;
00111 if (IsShipDepotTile(tile) && IsTileOwner(tile, v->owner)) {
00112 uint dist = DistanceManhattan(tile, v->tile);
00113 if (dist < best_dist) {
00114 best_dist = dist;
00115 best_depot = depot;
00116 }
00117 }
00118 }
00119
00120 return best_depot;
00121 }
00122
00123 static void CheckIfShipNeedsService(Vehicle *v)
00124 {
00125 if (Company::Get(v->owner)->settings.vehicle.servint_ships == 0 || !v->NeedsAutomaticServicing()) return;
00126 if (v->IsInDepot()) {
00127 VehicleServiceInDepot(v);
00128 return;
00129 }
00130
00131 uint max_distance;
00132 switch (_settings_game.pf.pathfinder_for_ships) {
00133 case VPF_OPF: max_distance = 12; break;
00134 case VPF_NPF: max_distance = _settings_game.pf.npf.maximum_go_to_depot_penalty / NPF_TILE_LENGTH; break;
00135 case VPF_YAPF: max_distance = _settings_game.pf.yapf.maximum_go_to_depot_penalty / YAPF_TILE_LENGTH; break;
00136 default: NOT_REACHED();
00137 }
00138
00139 const Depot *depot = FindClosestShipDepot(v, max_distance);
00140
00141 if (depot == NULL) {
00142 if (v->current_order.IsType(OT_GOTO_DEPOT)) {
00143 v->current_order.MakeDummy();
00144 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
00145 }
00146 return;
00147 }
00148
00149 v->current_order.MakeGoToDepot(depot->index, ODTFB_SERVICE);
00150 v->dest_tile = depot->xy;
00151 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
00152 }
00153
00157 void Ship::UpdateCache()
00158 {
00159 this->vcache.cached_max_speed = GetVehicleProperty(this, PROP_SHIP_SPEED, ShipVehInfo(this->engine_type)->max_speed);
00160 this->vcache.cached_cargo_mask = (this->cargo_type != INVALID_CARGO && this->cargo_cap > 0) ? 1 << this->cargo_type : 0;
00161
00162 this->UpdateVisualEffect();
00163 }
00164
00165 Money Ship::GetRunningCost() const
00166 {
00167 const Engine *e = Engine::Get(this->engine_type);
00168 uint cost_factor = GetVehicleProperty(this, PROP_SHIP_RUNNING_COST_FACTOR, e->u.ship.running_cost);
00169 return GetPrice(PR_RUNNING_SHIP, cost_factor, e->grf_prop.grffile);
00170 }
00171
00172 void Ship::OnNewDay()
00173 {
00174 if ((++this->day_counter & 7) == 0) {
00175 DecreaseVehicleValue(this);
00176 }
00177
00178 CheckVehicleBreakdown(this);
00179 AgeVehicle(this);
00180 CheckIfShipNeedsService(this);
00181
00182 CheckOrders(this);
00183
00184 if (this->running_ticks == 0) return;
00185
00186 CommandCost cost(EXPENSES_SHIP_RUN, this->GetRunningCost() * this->running_ticks / (DAYS_IN_YEAR * DAY_TICKS));
00187
00188 this->profit_this_year -= cost.GetCost();
00189 this->running_ticks = 0;
00190
00191 SubtractMoneyFromCompanyFract(this->owner, cost);
00192
00193 SetWindowDirty(WC_VEHICLE_DETAILS, this->index);
00194
00195 SetWindowClassesDirty(WC_SHIPS_LIST);
00196 }
00197
00198 Trackdir Ship::GetVehicleTrackdir() const
00199 {
00200 if (this->vehstatus & VS_CRASHED) return INVALID_TRACKDIR;
00201
00202 if (this->IsInDepot()) {
00203
00204 return DiagDirToDiagTrackdir(GetShipDepotDirection(this->tile));
00205 }
00206
00207 if (this->state == TRACK_BIT_WORMHOLE) {
00208
00209 return DiagDirToDiagTrackdir(DirToDiagDir(this->direction));
00210 }
00211
00212 return TrackDirectionToTrackdir(FindFirstTrack(this->state), this->direction);
00213 }
00214
00215 void Ship::MarkDirty()
00216 {
00217 this->UpdateViewport(false, false);
00218 this->UpdateCache();
00219 }
00220
00221 static void PlayShipSound(const Vehicle *v)
00222 {
00223 if (!PlayVehicleSound(v, VSE_START)) {
00224 SndPlayVehicleFx(ShipVehInfo(v->engine_type)->sfx, v);
00225 }
00226 }
00227
00228 void Ship::PlayLeaveStationSound() const
00229 {
00230 PlayShipSound(this);
00231 }
00232
00233 TileIndex Ship::GetOrderStationLocation(StationID station)
00234 {
00235 if (station == this->last_station_visited) this->last_station_visited = INVALID_STATION;
00236
00237 const Station *st = Station::Get(station);
00238 if (st->dock_tile != INVALID_TILE) {
00239 return TILE_ADD(st->dock_tile, ToTileIndexDiff(GetDockOffset(st->dock_tile)));
00240 } else {
00241 this->IncrementRealOrderIndex();
00242 return 0;
00243 }
00244 }
00245
00246 void Ship::UpdateDeltaXY(Direction direction)
00247 {
00248 #define MKIT(a, b, c, d) ((a & 0xFF) << 24) | ((b & 0xFF) << 16) | ((c & 0xFF) << 8) | ((d & 0xFF) << 0)
00249 static const uint32 _delta_xy_table[8] = {
00250 MKIT( 6, 6, -3, -3),
00251 MKIT( 6, 32, -3, -16),
00252 MKIT( 6, 6, -3, -3),
00253 MKIT(32, 6, -16, -3),
00254 MKIT( 6, 6, -3, -3),
00255 MKIT( 6, 32, -3, -16),
00256 MKIT( 6, 6, -3, -3),
00257 MKIT(32, 6, -16, -3),
00258 };
00259 #undef MKIT
00260
00261 uint32 x = _delta_xy_table[direction];
00262 this->x_offs = GB(x, 0, 8);
00263 this->y_offs = GB(x, 8, 8);
00264 this->x_extent = GB(x, 16, 8);
00265 this->y_extent = GB(x, 24, 8);
00266 this->z_extent = 6;
00267 }
00268
00269 static const TileIndexDiffC _ship_leave_depot_offs[] = {
00270 {-1, 0},
00271 { 0, -1}
00272 };
00273
00274 static bool CheckShipLeaveDepot(Ship *v)
00275 {
00276 if (!v->IsInDepot()) return false;
00277
00278
00279 if (v->current_order.IsType(OT_GOTO_DEPOT) &&
00280 IsShipDepotTile(v->tile) && GetDepotIndex(v->tile) == v->current_order.GetDestination()) {
00281 VehicleEnterDepot(v);
00282 return true;
00283 }
00284
00285 TileIndex tile = v->tile;
00286 Axis axis = GetShipDepotAxis(tile);
00287
00288
00289 if (DiagdirReachesTracks((DiagDirection)axis) & GetTileShipTrackStatus(TILE_ADD(tile, ToTileIndexDiff(_ship_leave_depot_offs[axis])))) {
00290 v->direction = ReverseDir(AxisToDirection(axis));
00291
00292 } else if (DiagdirReachesTracks((DiagDirection)(axis + 2)) & GetTileShipTrackStatus(TILE_ADD(tile, -2 * ToTileIndexDiff(_ship_leave_depot_offs[axis])))) {
00293 v->direction = AxisToDirection(axis);
00294 } else {
00295 return false;
00296 }
00297
00298 v->state = AxisToTrackBits(axis);
00299 v->vehstatus &= ~VS_HIDDEN;
00300
00301 v->cur_speed = 0;
00302 v->UpdateViewport(false, true);
00303 SetWindowDirty(WC_VEHICLE_DEPOT, v->tile);
00304
00305 PlayShipSound(v);
00306 VehicleServiceInDepot(v);
00307 InvalidateWindowData(WC_VEHICLE_DEPOT, v->tile);
00308 SetWindowClassesDirty(WC_SHIPS_LIST);
00309
00310 return false;
00311 }
00312
00313 static bool ShipAccelerate(Vehicle *v)
00314 {
00315 uint spd;
00316 byte t;
00317
00318 spd = min(v->cur_speed + 1, v->vcache.cached_max_speed);
00319
00320
00321 if (spd != v->cur_speed) {
00322 v->cur_speed = spd;
00323 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
00324 }
00325
00326
00327 spd = v->GetOldAdvanceSpeed(spd);
00328
00329 if (spd == 0) return false;
00330 if ((byte)++spd == 0) return true;
00331
00332 v->progress = (t = v->progress) - (byte)spd;
00333
00334 return (t < v->progress);
00335 }
00336
00342 static void ShipArrivesAt(const Vehicle *v, Station *st)
00343 {
00344
00345 if (!(st->had_vehicle_of_type & HVOT_SHIP)) {
00346 st->had_vehicle_of_type |= HVOT_SHIP;
00347
00348 SetDParam(0, st->index);
00349 AddVehicleNewsItem(
00350 STR_NEWS_FIRST_SHIP_ARRIVAL,
00351 (v->owner == _local_company) ? NS_ARRIVAL_COMPANY : NS_ARRIVAL_OTHER,
00352 v->index,
00353 st->index
00354 );
00355 AI::NewEvent(v->owner, new AIEventStationFirstVehicle(st->index, v->index));
00356 }
00357 }
00358
00359
00365 static Track ChooseShipTrack(Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks)
00366 {
00367 assert(IsValidDiagDirection(enterdir));
00368
00369 bool path_found = true;
00370 Track track;
00371 switch (_settings_game.pf.pathfinder_for_ships) {
00372 case VPF_OPF: track = OPFShipChooseTrack(v, tile, enterdir, tracks, path_found); break;
00373 case VPF_NPF: track = NPFShipChooseTrack(v, tile, enterdir, tracks, path_found); break;
00374 case VPF_YAPF: track = YapfShipChooseTrack(v, tile, enterdir, tracks, path_found); break;
00375 default: NOT_REACHED();
00376 }
00377
00378 v->HandlePathfindingResult(path_found);
00379 return track;
00380 }
00381
00382 static const Direction _new_vehicle_direction_table[] = {
00383 DIR_N , DIR_NW, DIR_W , INVALID_DIR,
00384 DIR_NE, DIR_N , DIR_SW, INVALID_DIR,
00385 DIR_E , DIR_SE, DIR_S
00386 };
00387
00388 static Direction ShipGetNewDirectionFromTiles(TileIndex new_tile, TileIndex old_tile)
00389 {
00390 uint offs = (TileY(new_tile) - TileY(old_tile) + 1) * 4 +
00391 TileX(new_tile) - TileX(old_tile) + 1;
00392 assert(offs < 11 && offs != 3 && offs != 7);
00393 return _new_vehicle_direction_table[offs];
00394 }
00395
00396 static Direction ShipGetNewDirection(Vehicle *v, int x, int y)
00397 {
00398 uint offs = (y - v->y_pos + 1) * 4 + (x - v->x_pos + 1);
00399 assert(offs < 11 && offs != 3 && offs != 7);
00400 return _new_vehicle_direction_table[offs];
00401 }
00402
00403 static inline TrackBits GetAvailShipTracks(TileIndex tile, DiagDirection dir)
00404 {
00405 return GetTileShipTrackStatus(tile) & DiagdirReachesTracks(dir);
00406 }
00407
00408 static const byte _ship_subcoord[4][6][3] = {
00409 {
00410 {15, 8, 1},
00411 { 0, 0, 0},
00412 { 0, 0, 0},
00413 {15, 8, 2},
00414 {15, 7, 0},
00415 { 0, 0, 0},
00416 },
00417 {
00418 { 0, 0, 0},
00419 { 8, 0, 3},
00420 { 7, 0, 2},
00421 { 0, 0, 0},
00422 { 8, 0, 4},
00423 { 0, 0, 0},
00424 },
00425 {
00426 { 0, 8, 5},
00427 { 0, 0, 0},
00428 { 0, 7, 6},
00429 { 0, 0, 0},
00430 { 0, 0, 0},
00431 { 0, 8, 4},
00432 },
00433 {
00434 { 0, 0, 0},
00435 { 8, 15, 7},
00436 { 0, 0, 0},
00437 { 8, 15, 6},
00438 { 0, 0, 0},
00439 { 7, 15, 0},
00440 }
00441 };
00442
00443 static void ShipController(Ship *v)
00444 {
00445 uint32 r;
00446 const byte *b;
00447 Direction dir;
00448 Track track;
00449 TrackBits tracks;
00450
00451 v->tick_counter++;
00452 v->current_order_time++;
00453
00454 if (v->HandleBreakdown()) return;
00455
00456 if (v->vehstatus & VS_STOPPED) return;
00457
00458 ProcessOrders(v);
00459 v->HandleLoading();
00460
00461 if (v->current_order.IsType(OT_LOADING)) return;
00462
00463 if (CheckShipLeaveDepot(v)) return;
00464
00465 v->ShowVisualEffect();
00466
00467 if (!ShipAccelerate(v)) return;
00468
00469 GetNewVehiclePosResult gp = GetNewVehiclePos(v);
00470 if (v->state != TRACK_BIT_WORMHOLE) {
00471
00472 if (gp.old_tile == gp.new_tile) {
00473
00474 if (v->IsInDepot()) {
00475 gp.x = v->x_pos;
00476 gp.y = v->y_pos;
00477 } else {
00478
00479 r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
00480 if (HasBit(r, VETS_CANNOT_ENTER)) goto reverse_direction;
00481
00482
00483
00484 if (v->current_order.IsType(OT_LEAVESTATION)) {
00485 v->current_order.Free();
00486 SetWindowWidgetDirty(WC_VEHICLE_VIEW, v->index, VVW_WIDGET_START_STOP_VEH);
00487 } else if (v->dest_tile != 0) {
00488
00489 if (v->current_order.IsType(OT_GOTO_WAYPOINT) &&
00490 DistanceManhattan(v->dest_tile, gp.new_tile) <= 3) {
00491
00492
00493 UpdateVehicleTimetable(v, true);
00494 v->IncrementRealOrderIndex();
00495 v->current_order.MakeDummy();
00496 } else {
00497
00498 if (v->dest_tile == gp.new_tile) {
00499 if (v->current_order.IsType(OT_GOTO_DEPOT)) {
00500 if ((gp.x & 0xF) == 8 && (gp.y & 0xF) == 8) {
00501 VehicleEnterDepot(v);
00502 return;
00503 }
00504 } else if (v->current_order.IsType(OT_GOTO_STATION)) {
00505
00506 Station *st = Station::Get(v->current_order.GetDestination());
00507 if (st->facilities & FACIL_DOCK) {
00508 ShipArrivesAt(v, st);
00509 v->BeginLoading(st->index);
00510 } else {
00511 v->last_station_visited = v->current_order.GetDestination();
00512 v->current_order.MakeLeaveStation();
00513 v->IncrementRealOrderIndex();
00514 }
00515 }
00516 }
00517 }
00518 }
00519 }
00520 } else {
00521 DiagDirection diagdir;
00522
00523 if (TileX(gp.new_tile) >= MapMaxX() || TileY(gp.new_tile) >= MapMaxY()) {
00524 goto reverse_direction;
00525 }
00526
00527 dir = ShipGetNewDirectionFromTiles(gp.new_tile, gp.old_tile);
00528 assert(dir == DIR_NE || dir == DIR_SE || dir == DIR_SW || dir == DIR_NW);
00529 diagdir = DirToDiagDir(dir);
00530 tracks = GetAvailShipTracks(gp.new_tile, diagdir);
00531 if (tracks == TRACK_BIT_NONE) goto reverse_direction;
00532
00533
00534 track = ChooseShipTrack(v, gp.new_tile, diagdir, tracks);
00535 if (track == INVALID_TRACK) goto reverse_direction;
00536
00537 b = _ship_subcoord[diagdir][track];
00538
00539 gp.x = (gp.x & ~0xF) | b[0];
00540 gp.y = (gp.y & ~0xF) | b[1];
00541
00542
00543 r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
00544 if (HasBit(r, VETS_CANNOT_ENTER)) goto reverse_direction;
00545
00546 if (!HasBit(r, VETS_ENTERED_WORMHOLE)) {
00547 v->tile = gp.new_tile;
00548 v->state = TrackToTrackBits(track);
00549 }
00550
00551 v->direction = (Direction)b[2];
00552 }
00553 } else {
00554
00555 if (!IsTileType(gp.new_tile, MP_TUNNELBRIDGE) || !HasBit(VehicleEnterTile(v, gp.new_tile, gp.x, gp.y), VETS_ENTERED_WORMHOLE)) {
00556 v->x_pos = gp.x;
00557 v->y_pos = gp.y;
00558 VehicleMove(v, !(v->vehstatus & VS_HIDDEN));
00559 return;
00560 }
00561 }
00562
00563
00564 dir = ShipGetNewDirection(v, gp.x, gp.y);
00565 v->x_pos = gp.x;
00566 v->y_pos = gp.y;
00567 v->z_pos = GetSlopeZ(gp.x, gp.y);
00568
00569 getout:
00570 v->UpdateViewport(true, true);
00571 return;
00572
00573 reverse_direction:
00574 dir = ReverseDir(v->direction);
00575 v->direction = dir;
00576 goto getout;
00577 }
00578
00579 bool Ship::Tick()
00580 {
00581 if (!(this->vehstatus & VS_STOPPED)) this->running_ticks++;
00582
00583 ShipController(this);
00584
00585 return true;
00586 }
00587
00597 CommandCost CmdBuildShip(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **ret)
00598 {
00599 tile = GetShipDepotNorthTile(tile);
00600 if (flags & DC_EXEC) {
00601 int x;
00602 int y;
00603
00604 const ShipVehicleInfo *svi = &e->u.ship;
00605
00606 Ship *v = new Ship();
00607 *ret = v;
00608
00609 v->owner = _current_company;
00610 v->tile = tile;
00611 x = TileX(tile) * TILE_SIZE + TILE_SIZE / 2;
00612 y = TileY(tile) * TILE_SIZE + TILE_SIZE / 2;
00613 v->x_pos = x;
00614 v->y_pos = y;
00615 v->z_pos = GetSlopeZ(x, y);
00616
00617 v->UpdateDeltaXY(v->direction);
00618 v->vehstatus = VS_HIDDEN | VS_STOPPED | VS_DEFPAL;
00619
00620 v->spritenum = svi->image_index;
00621 v->cargo_type = e->GetDefaultCargoType();
00622 v->cargo_cap = svi->capacity;
00623
00624 v->last_station_visited = INVALID_STATION;
00625 v->engine_type = e->index;
00626
00627 v->reliability = e->reliability;
00628 v->reliability_spd_dec = e->reliability_spd_dec;
00629 v->max_age = e->GetLifeLengthInDays();
00630 _new_vehicle_id = v->index;
00631
00632 v->state = TRACK_BIT_DEPOT;
00633
00634 v->service_interval = Company::Get(_current_company)->settings.vehicle.servint_ships;
00635 v->date_of_last_service = _date;
00636 v->build_year = _cur_year;
00637 v->cur_image = SPR_IMG_QUERY;
00638 v->random_bits = VehicleRandomBits();
00639
00640 v->UpdateCache();
00641
00642 if (e->flags & ENGINE_EXCLUSIVE_PREVIEW) SetBit(v->vehicle_flags, VF_BUILT_AS_PROTOTYPE);
00643
00644 v->InvalidateNewGRFCacheOfChain();
00645
00646 v->cargo_cap = GetVehicleCapacity(v);
00647
00648 v->InvalidateNewGRFCacheOfChain();
00649
00650 VehicleMove(v, false);
00651 }
00652
00653 return CommandCost();
00654 }
00655
00656 bool Ship::FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
00657 {
00658 const Depot *depot = FindClosestShipDepot(this, 0);
00659
00660 if (depot == NULL) return false;
00661
00662 if (location != NULL) *location = depot->xy;
00663 if (destination != NULL) *destination = depot->index;
00664
00665 return true;
00666 }