OpenTTD
ship_cmd.cpp
Go to the documentation of this file.
1 /* $Id: ship_cmd.cpp 27858 2017-04-23 09:19:32Z peter1138 $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #include "stdafx.h"
13 #include "ship.h"
14 #include "landscape.h"
15 #include "timetable.h"
16 #include "news_func.h"
17 #include "company_func.h"
19 #include "depot_base.h"
20 #include "station_base.h"
21 #include "newgrf_engine.h"
22 #include "pathfinder/yapf/yapf.h"
23 #include "newgrf_sound.h"
24 #include "spritecache.h"
25 #include "strings_func.h"
26 #include "window_func.h"
27 #include "date_func.h"
28 #include "vehicle_func.h"
29 #include "sound_func.h"
30 #include "ai/ai.hpp"
31 #include "game/game.hpp"
33 #include "engine_base.h"
34 #include "company_base.h"
35 #include "tunnelbridge_map.h"
36 #include "zoom_func.h"
37 
38 #include "table/strings.h"
39 
40 #include "safeguards.h"
41 
48 {
49  if (HasTileWaterClass(tile)) return GetWaterClass(tile);
50  if (IsTileType(tile, MP_TUNNELBRIDGE)) {
52  return WATER_CLASS_CANAL;
53  }
54  if (IsTileType(tile, MP_RAILWAY)) {
55  assert(GetRailGroundType(tile) == RAIL_GROUND_WATER);
56  return WATER_CLASS_SEA;
57  }
58  NOT_REACHED();
59 }
60 
61 static const uint16 _ship_sprites[] = {0x0E5D, 0x0E55, 0x0E65, 0x0E6D};
62 
63 template <>
64 bool IsValidImageIndex<VEH_SHIP>(uint8 image_index)
65 {
66  return image_index < lengthof(_ship_sprites);
67 }
68 
69 static inline TrackBits GetTileShipTrackStatus(TileIndex tile)
70 {
72 }
73 
74 static void GetShipIcon(EngineID engine, EngineImageType image_type, VehicleSpriteSeq *result)
75 {
76  const Engine *e = Engine::Get(engine);
77  uint8 spritenum = e->u.ship.image_index;
78 
79  if (is_custom_sprite(spritenum)) {
80  GetCustomVehicleIcon(engine, DIR_W, image_type, result);
81  if (result->IsValid()) return;
82 
83  spritenum = e->original_image_index;
84  }
85 
86  assert(IsValidImageIndex<VEH_SHIP>(spritenum));
87  result->Set(DIR_W + _ship_sprites[spritenum]);
88 }
89 
90 void DrawShipEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
91 {
92  VehicleSpriteSeq seq;
93  GetShipIcon(engine, image_type, &seq);
94 
95  Rect rect;
96  seq.GetBounds(&rect);
97  preferred_x = Clamp(preferred_x,
98  left - UnScaleGUI(rect.left),
99  right - UnScaleGUI(rect.right));
100 
101  seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
102 }
103 
113 void GetShipSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
114 {
115  VehicleSpriteSeq seq;
116  GetShipIcon(engine, image_type, &seq);
117 
118  Rect rect;
119  seq.GetBounds(&rect);
120 
121  width = UnScaleGUI(rect.right - rect.left + 1);
122  height = UnScaleGUI(rect.bottom - rect.top + 1);
123  xoffs = UnScaleGUI(rect.left);
124  yoffs = UnScaleGUI(rect.top);
125 }
126 
127 void Ship::GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
128 {
129  uint8 spritenum = this->spritenum;
130 
131  if (is_custom_sprite(spritenum)) {
132  GetCustomVehicleSprite(this, direction, image_type, result);
133  if (result->IsValid()) return;
134 
135  spritenum = this->GetEngine()->original_image_index;
136  }
137 
138  assert(IsValidImageIndex<VEH_SHIP>(spritenum));
139  result->Set(_ship_sprites[spritenum] + direction);
140 }
141 
142 static const Depot *FindClosestShipDepot(const Vehicle *v, uint max_distance)
143 {
144  /* Find the closest depot */
145  const Depot *depot;
146  const Depot *best_depot = NULL;
147  /* If we don't have a maximum distance, i.e. distance = 0,
148  * we want to find any depot so the best distance of no
149  * depot must be more than any correct distance. On the
150  * other hand if we have set a maximum distance, any depot
151  * further away than max_distance can safely be ignored. */
152  uint best_dist = max_distance == 0 ? UINT_MAX : max_distance + 1;
153 
154  FOR_ALL_DEPOTS(depot) {
155  TileIndex tile = depot->xy;
156  if (IsShipDepotTile(tile) && IsTileOwner(tile, v->owner)) {
157  uint dist = DistanceManhattan(tile, v->tile);
158  if (dist < best_dist) {
159  best_dist = dist;
160  best_depot = depot;
161  }
162  }
163  }
164 
165  return best_depot;
166 }
167 
168 static void CheckIfShipNeedsService(Vehicle *v)
169 {
170  if (Company::Get(v->owner)->settings.vehicle.servint_ships == 0 || !v->NeedsAutomaticServicing()) return;
171  if (v->IsChainInDepot()) {
173  return;
174  }
175 
176  uint max_distance;
178  case VPF_OPF: max_distance = 12; break;
181  default: NOT_REACHED();
182  }
183 
184  const Depot *depot = FindClosestShipDepot(v, max_distance);
185 
186  if (depot == NULL) {
187  if (v->current_order.IsType(OT_GOTO_DEPOT)) {
190  }
191  return;
192  }
193 
195  v->dest_tile = depot->xy;
197 }
198 
203 {
204  const ShipVehicleInfo *svi = ShipVehInfo(this->engine_type);
205 
206  /* Get speed fraction for the current water type. Aqueducts are always canals. */
207  bool is_ocean = GetEffectiveWaterClass(this->tile) == WATER_CLASS_SEA;
208  uint raw_speed = GetVehicleProperty(this, PROP_SHIP_SPEED, svi->max_speed);
209  this->vcache.cached_max_speed = svi->ApplyWaterClassSpeedFrac(raw_speed, is_ocean);
210 
211  /* Update cargo aging period. */
212  this->vcache.cached_cargo_age_period = GetVehicleProperty(this, PROP_SHIP_CARGO_AGE_PERIOD, EngInfo(this->engine_type)->cargo_age_period);
213 
214  this->UpdateVisualEffect();
215 }
216 
218 {
219  const Engine *e = this->GetEngine();
220  uint cost_factor = GetVehicleProperty(this, PROP_SHIP_RUNNING_COST_FACTOR, e->u.ship.running_cost);
221  return GetPrice(PR_RUNNING_SHIP, cost_factor, e->GetGRF());
222 }
223 
225 {
226  if ((++this->day_counter & 7) == 0) {
227  DecreaseVehicleValue(this);
228  }
229 
230  CheckVehicleBreakdown(this);
231  AgeVehicle(this);
232  CheckIfShipNeedsService(this);
233 
234  CheckOrders(this);
235 
236  if (this->running_ticks == 0) return;
237 
239 
240  this->profit_this_year -= cost.GetCost();
241  this->running_ticks = 0;
242 
244 
246  /* we need this for the profit */
248 }
249 
251 {
252  if (this->vehstatus & VS_CRASHED) return INVALID_TRACKDIR;
253 
254  if (this->IsInDepot()) {
255  /* We'll assume the ship is facing outwards */
256  return DiagDirToDiagTrackdir(GetShipDepotDirection(this->tile));
257  }
258 
259  if (this->state == TRACK_BIT_WORMHOLE) {
260  /* ship on aqueduct, so just use his direction and assume a diagonal track */
262  }
263 
265 }
266 
268 {
269  this->colourmap = PAL_NONE;
270  this->UpdateViewport(true, false);
271  this->UpdateCache();
272 }
273 
274 static void PlayShipSound(const Vehicle *v)
275 {
276  if (!PlayVehicleSound(v, VSE_START)) {
277  SndPlayVehicleFx(ShipVehInfo(v->engine_type)->sfx, v);
278  }
279 }
280 
282 {
283  PlayShipSound(this);
284 }
285 
287 {
288  if (station == this->last_station_visited) this->last_station_visited = INVALID_STATION;
289 
290  const Station *st = Station::Get(station);
291  if (st->dock_tile != INVALID_TILE) {
293  } else {
294  this->IncrementRealOrderIndex();
295  return 0;
296  }
297 }
298 
300 {
301  static const int8 _delta_xy_table[8][4] = {
302  /* y_extent, x_extent, y_offs, x_offs */
303  { 6, 6, -3, -3}, // N
304  { 6, 32, -3, -16}, // NE
305  { 6, 6, -3, -3}, // E
306  {32, 6, -16, -3}, // SE
307  { 6, 6, -3, -3}, // S
308  { 6, 32, -3, -16}, // SW
309  { 6, 6, -3, -3}, // W
310  {32, 6, -16, -3}, // NW
311  };
312 
313  const int8 *bb = _delta_xy_table[direction];
314  this->x_offs = bb[3];
315  this->y_offs = bb[2];
316  this->x_extent = bb[1];
317  this->y_extent = bb[0];
318  this->z_extent = 6;
319 }
320 
321 static bool CheckShipLeaveDepot(Ship *v)
322 {
323  if (!v->IsChainInDepot()) return false;
324 
325  /* We are leaving a depot, but have to go to the exact same one; re-enter */
326  if (v->current_order.IsType(OT_GOTO_DEPOT) &&
329  return true;
330  }
331 
332  TileIndex tile = v->tile;
333  Axis axis = GetShipDepotAxis(tile);
334 
335  DiagDirection north_dir = ReverseDiagDir(AxisToDiagDir(axis));
336  TileIndex north_neighbour = TILE_ADD(tile, TileOffsByDiagDir(north_dir));
337  DiagDirection south_dir = AxisToDiagDir(axis);
338  TileIndex south_neighbour = TILE_ADD(tile, 2 * TileOffsByDiagDir(south_dir));
339 
340  TrackBits north_tracks = DiagdirReachesTracks(north_dir) & GetTileShipTrackStatus(north_neighbour);
341  TrackBits south_tracks = DiagdirReachesTracks(south_dir) & GetTileShipTrackStatus(south_neighbour);
342  if (north_tracks && south_tracks) {
343  /* Ask pathfinder for best direction */
344  bool reverse = false;
345  bool path_found;
347  case VPF_OPF: reverse = OPFShipChooseTrack(v, north_neighbour, north_dir, north_tracks, path_found) == INVALID_TRACK; break; // OPF always allows reversing
348  case VPF_NPF: reverse = NPFShipCheckReverse(v); break;
349  case VPF_YAPF: reverse = YapfShipCheckReverse(v); break;
350  default: NOT_REACHED();
351  }
352  if (reverse) north_tracks = TRACK_BIT_NONE;
353  }
354 
355  if (north_tracks) {
356  /* Leave towards north */
357  v->direction = DiagDirToDir(north_dir);
358  } else if (south_tracks) {
359  /* Leave towards south */
360  v->direction = DiagDirToDir(south_dir);
361  } else {
362  /* Both ways blocked */
363  return false;
364  }
365 
366  v->state = AxisToTrackBits(axis);
367  v->vehstatus &= ~VS_HIDDEN;
368 
369  v->cur_speed = 0;
370  v->UpdateViewport(true, true);
372 
373  PlayShipSound(v);
377 
378  return false;
379 }
380 
381 static bool ShipAccelerate(Vehicle *v)
382 {
383  uint spd;
384  byte t;
385 
386  spd = min(v->cur_speed + 1, v->vcache.cached_max_speed);
387  spd = min(spd, v->current_order.GetMaxSpeed() * 2);
388 
389  /* updates statusbar only if speed have changed to save CPU time */
390  if (spd != v->cur_speed) {
391  v->cur_speed = spd;
393  }
394 
395  /* Convert direction-independent speed into direction-dependent speed. (old movement method) */
396  spd = v->GetOldAdvanceSpeed(spd);
397 
398  if (spd == 0) return false;
399  if ((byte)++spd == 0) return true;
400 
401  v->progress = (t = v->progress) - (byte)spd;
402 
403  return (t < v->progress);
404 }
405 
411 static void ShipArrivesAt(const Vehicle *v, Station *st)
412 {
413  /* Check if station was ever visited before */
414  if (!(st->had_vehicle_of_type & HVOT_SHIP)) {
415  st->had_vehicle_of_type |= HVOT_SHIP;
416 
417  SetDParam(0, st->index);
419  STR_NEWS_FIRST_SHIP_ARRIVAL,
421  v->index,
422  st->index
423  );
424  AI::NewEvent(v->owner, new ScriptEventStationFirstVehicle(st->index, v->index));
425  Game::NewEvent(new ScriptEventStationFirstVehicle(st->index, v->index));
426  }
427 }
428 
429 
439 static Track ChooseShipTrack(Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks)
440 {
441  assert(IsValidDiagDirection(enterdir));
442 
443  bool path_found = true;
444  Track track;
446  case VPF_OPF: track = OPFShipChooseTrack(v, tile, enterdir, tracks, path_found); break;
447  case VPF_NPF: track = NPFShipChooseTrack(v, tile, enterdir, tracks, path_found); break;
448  case VPF_YAPF: track = YapfShipChooseTrack(v, tile, enterdir, tracks, path_found); break;
449  default: NOT_REACHED();
450  }
451 
452  v->HandlePathfindingResult(path_found);
453  return track;
454 }
455 
456 static inline TrackBits GetAvailShipTracks(TileIndex tile, DiagDirection dir)
457 {
458  return GetTileShipTrackStatus(tile) & DiagdirReachesTracks(dir);
459 }
460 
461 static const byte _ship_subcoord[4][6][3] = {
462  {
463  {15, 8, 1},
464  { 0, 0, 0},
465  { 0, 0, 0},
466  {15, 8, 2},
467  {15, 7, 0},
468  { 0, 0, 0},
469  },
470  {
471  { 0, 0, 0},
472  { 8, 0, 3},
473  { 7, 0, 2},
474  { 0, 0, 0},
475  { 8, 0, 4},
476  { 0, 0, 0},
477  },
478  {
479  { 0, 8, 5},
480  { 0, 0, 0},
481  { 0, 7, 6},
482  { 0, 0, 0},
483  { 0, 0, 0},
484  { 0, 8, 4},
485  },
486  {
487  { 0, 0, 0},
488  { 8, 15, 7},
489  { 0, 0, 0},
490  { 8, 15, 6},
491  { 0, 0, 0},
492  { 7, 15, 0},
493  }
494 };
495 
496 static void ShipController(Ship *v)
497 {
498  uint32 r;
499  const byte *b;
500  Direction dir;
501  Track track;
502  TrackBits tracks;
503 
504  v->tick_counter++;
505  v->current_order_time++;
506 
507  if (v->HandleBreakdown()) return;
508 
509  if (v->vehstatus & VS_STOPPED) return;
510 
511  ProcessOrders(v);
512  v->HandleLoading();
513 
514  if (v->current_order.IsType(OT_LOADING)) return;
515 
516  if (CheckShipLeaveDepot(v)) return;
517 
518  v->ShowVisualEffect();
519 
520  if (!ShipAccelerate(v)) return;
521 
523  if (v->state != TRACK_BIT_WORMHOLE) {
524  /* Not on a bridge */
525  if (gp.old_tile == gp.new_tile) {
526  /* Staying in tile */
527  if (v->IsInDepot()) {
528  gp.x = v->x_pos;
529  gp.y = v->y_pos;
530  } else {
531  /* Not inside depot */
532  r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
533  if (HasBit(r, VETS_CANNOT_ENTER)) goto reverse_direction;
534 
535  /* A leave station order only needs one tick to get processed, so we can
536  * always skip ahead. */
537  if (v->current_order.IsType(OT_LEAVESTATION)) {
538  v->current_order.Free();
540  } else if (v->dest_tile != 0) {
541  /* We have a target, let's see if we reached it... */
542  if (v->current_order.IsType(OT_GOTO_WAYPOINT) &&
543  DistanceManhattan(v->dest_tile, gp.new_tile) <= 3) {
544  /* We got within 3 tiles of our target buoy, so let's skip to our
545  * next order */
546  UpdateVehicleTimetable(v, true);
549  } else {
550  /* Non-buoy orders really need to reach the tile */
551  if (v->dest_tile == gp.new_tile) {
552  if (v->current_order.IsType(OT_GOTO_DEPOT)) {
553  if ((gp.x & 0xF) == 8 && (gp.y & 0xF) == 8) {
555  return;
556  }
557  } else if (v->current_order.IsType(OT_GOTO_STATION)) {
559 
560  /* Process station in the orderlist. */
562  if (st->facilities & FACIL_DOCK) { // ugly, ugly workaround for problem with ships able to drop off cargo at wrong stations
563  ShipArrivesAt(v, st);
564  v->BeginLoading();
565  } else { // leave stations without docks right aways
568  }
569  }
570  }
571  }
572  }
573  }
574  } else {
575  /* New tile */
576  if (!IsValidTile(gp.new_tile)) goto reverse_direction;
577 
579  assert(diagdir != INVALID_DIAGDIR);
580  tracks = GetAvailShipTracks(gp.new_tile, diagdir);
581  if (tracks == TRACK_BIT_NONE) goto reverse_direction;
582 
583  /* Choose a direction, and continue if we find one */
584  track = ChooseShipTrack(v, gp.new_tile, diagdir, tracks);
585  if (track == INVALID_TRACK) goto reverse_direction;
586 
587  b = _ship_subcoord[diagdir][track];
588 
589  gp.x = (gp.x & ~0xF) | b[0];
590  gp.y = (gp.y & ~0xF) | b[1];
591 
592  /* Call the landscape function and tell it that the vehicle entered the tile */
593  r = VehicleEnterTile(v, gp.new_tile, gp.x, gp.y);
594  if (HasBit(r, VETS_CANNOT_ENTER)) goto reverse_direction;
595 
596  if (!HasBit(r, VETS_ENTERED_WORMHOLE)) {
597  v->tile = gp.new_tile;
598  v->state = TrackToTrackBits(track);
599 
600  /* Update ship cache when the water class changes. Aqueducts are always canals. */
603  if (old_wc != new_wc) v->UpdateCache();
604  }
605 
606  v->direction = (Direction)b[2];
607  }
608  } else {
609  /* On a bridge */
611  v->x_pos = gp.x;
612  v->y_pos = gp.y;
613  v->UpdatePosition();
614  if ((v->vehstatus & VS_HIDDEN) == 0) v->Vehicle::UpdateViewport(true);
615  return;
616  }
617  }
618 
619  /* update image of ship, as well as delta XY */
620  v->x_pos = gp.x;
621  v->y_pos = gp.y;
622  v->z_pos = GetSlopePixelZ(gp.x, gp.y);
623 
624 getout:
625  v->UpdatePosition();
626  v->UpdateViewport(true, true);
627  return;
628 
629 reverse_direction:
630  dir = ReverseDir(v->direction);
631  v->direction = dir;
632  goto getout;
633 }
634 
636 {
637  if (!(this->vehstatus & VS_STOPPED)) this->running_ticks++;
638 
639  ShipController(this);
640 
641  return true;
642 }
643 
653 CommandCost CmdBuildShip(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **ret)
654 {
655  tile = GetShipDepotNorthTile(tile);
656  if (flags & DC_EXEC) {
657  int x;
658  int y;
659 
660  const ShipVehicleInfo *svi = &e->u.ship;
661 
662  Ship *v = new Ship();
663  *ret = v;
664 
665  v->owner = _current_company;
666  v->tile = tile;
667  x = TileX(tile) * TILE_SIZE + TILE_SIZE / 2;
668  y = TileY(tile) * TILE_SIZE + TILE_SIZE / 2;
669  v->x_pos = x;
670  v->y_pos = y;
671  v->z_pos = GetSlopePixelZ(x, y);
672 
673  v->UpdateDeltaXY(v->direction);
675 
676  v->spritenum = svi->image_index;
678  v->cargo_cap = svi->capacity;
679  v->refit_cap = 0;
680 
681  v->last_station_visited = INVALID_STATION;
682  v->last_loading_station = INVALID_STATION;
683  v->engine_type = e->index;
684 
685  v->reliability = e->reliability;
687  v->max_age = e->GetLifeLengthInDays();
688  _new_vehicle_id = v->index;
689 
690  v->state = TRACK_BIT_DEPOT;
691 
692  v->SetServiceInterval(Company::Get(_current_company)->settings.vehicle.servint_ships);
694  v->build_year = _cur_year;
695  v->sprite_seq.Set(SPR_IMG_QUERY);
697 
698  v->UpdateCache();
699 
701  v->SetServiceIntervalIsPercent(Company::Get(_current_company)->settings.vehicle.servint_ispercent);
702 
704 
705  v->cargo_cap = e->DetermineCapacity(v);
706 
708 
709  v->UpdatePosition();
710  }
711 
712  return CommandCost();
713 }
714 
715 bool Ship::FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
716 {
717  const Depot *depot = FindClosestShipDepot(this, 0);
718 
719  if (depot == NULL) return false;
720 
721  if (location != NULL) *location = depot->xy;
722  if (destination != NULL) *destination = depot->index;
723 
724  return true;
725 }