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