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 */
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 
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 }
Information about a ship vehicle.
Definition: engine_type.h:66
Functions related to OTTD&#39;s strings.
This vehicle is in the exclusive preview stage, either being used or being offered to a company...
Definition: engine_type.h:169
uint16 reliability
Current reliability of the engine.
Definition: engine_base.h:27
Date max_age
Maximum age.
Definition: vehicle_base.h:259
uint32 PaletteID
The number of the palette.
Definition: gfx_type.h:20
Vehicle is stopped by the player.
Definition: vehicle_base.h:33
First vehicle arrived for competitor.
Definition: news_type.h:38
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:134
Definition of stuff that is very close to a company, like the company struct itself.
Functions for NewGRF engines.
void DecreaseVehicleValue(Vehicle *v)
Decrease the value of a vehicle.
Definition: vehicle.cpp:1195
static const int DAYS_IN_YEAR
days per year
Definition: date_type.h:31
static TransportType GetTunnelBridgeTransportType(TileIndex t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
void ShowVisualEffect() const
Draw visual effects (smoke and/or sparks) for a vehicle chain.
Definition: vehicle.cpp:2481
Track NPFShipChooseTrack(const Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found)
Finds the best path for given ship using NPF.
Definition: npf.cpp:1158
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3120
static DiagDirection DirToDiagDir(Direction dir)
Convert a Direction to a DiagDirection.
static Axis GetShipDepotAxis(TileIndex t)
Get the axis of the ship depot.
Definition: water_map.h:237
DirectionByte direction
facing
Definition: vehicle_base.h:271
static int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition: zoom_func.h:72
Yet Another PathFinder.
Definition: vehicle_type.h:63
uint32 maximum_go_to_depot_penalty
What is the maximum penalty that may be endured for going to a depot.
void CheckOrders(const Vehicle *v)
Check the orders of a vehicle, to see if there are invalid orders and stuff.
Definition: order_cmd.cpp:1762
Functions related to time tabling.
Flag for an invalid DiagDirection.
Track YapfShipChooseTrack(const Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found)
Finds the best path for given ship using YAPF.
Definition: yapf_ship.cpp:225
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
Functions related to dates.
static WaterClass GetWaterClass(TileIndex t)
Get the water class at a tile.
Definition: water_map.h:106
void PlayLeaveStationSound() const
Play the sound associated with leaving the station.
Definition: ship_cmd.cpp:281
static TileIndex GetShipDepotNorthTile(TileIndex t)
Get the most northern tile of a ship depot.
Definition: water_map.h:283
Use default vehicle palette.
Definition: vehicle_base.h:35
void GetShipSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of a ship sprite heading west (used for lists).
Definition: ship_cmd.cpp:113
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
bool Tick()
Calls the tick handler of the vehicle.
Definition: ship_cmd.cpp:635
Track
These are used to specify a single track.
Definition: track_type.h:21
uint16 cur_speed
current speed
Definition: vehicle_base.h:293
uint16 cached_cargo_age_period
Number of ticks before carried cargo is aged.
Definition: vehicle_base.h:124
static TrackBits AxisToTrackBits(Axis a)
Maps an Axis to the corresponding TrackBits value.
Definition: track_func.h:98
Depot view; Window numbers:
Definition: window_type.h:346
byte spritenum
currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == res...
Definition: vehicle_base.h:279
void UpdateDeltaXY(Direction direction)
Updates the x and y offsets and the size of the sprite used for this vehicle.
Definition: ship_cmd.cpp:299
Station has seen a ship.
Definition: station_type.h:72
The Original PathFinder (only for ships)
Definition: vehicle_type.h:61
uint ApplyWaterClassSpeedFrac(uint raw_speed, bool is_ocean) const
Apply ocean/canal speed fraction to a velocity.
Definition: engine_type.h:79
TileIndex dock_tile
The location of the dock.
Definition: station_base.h:461
StationID last_loading_station
Last station the vehicle has stopped at and could possibly leave from with any cargo loaded...
Definition: vehicle_base.h:303
bool IsInDepot() const
Check whether the vehicle is in the depot.
Definition: ship.h:42
TileIndex dest_tile
Heading for this tile.
Definition: vehicle_base.h:237
Transport over water.
NPFSettings npf
pathfinder settings for the new pathfinder
Functions related to vehicles.
void IncrementRealOrderIndex()
Advanced cur_real_order_index to the next real order, keeps care of the wrap-around and invalidates t...
Definition: vehicle_base.h:823
uint32 current_order_time
How many ticks have passed since this order started.
Definition: base_consist.h:23
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:207
void VehicleEnterDepot(Vehicle *v)
Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it...
Definition: vehicle.cpp:1426
void Draw(int x, int y, PaletteID default_pal, bool force_pal) const
Draw the sprite sequence.
Definition: vehicle.cpp:127
PathfinderSettings pf
settings for all pathfinders
Vehicle data structure.
Definition: vehicle_base.h:212
static void ShipArrivesAt(const Vehicle *v, Station *st)
Ship arrives at a dock.
Definition: ship_cmd.cpp:411
Base for all depots (except hangars)
void Set(SpriteID sprite)
Assign a single sprite to the sequence.
Definition: vehicle_base.h:163
TrackBitsByte state
The "track" the ship is following.
Definition: ship.h:25
Start or stop this vehicle, and show information about the current state.
Tindex index
Index of this pool item.
Definition: pool_type.hpp:147
static const int DAY_TICKS
1 day is 74 ticks; _date_fract used to be uint16 and incremented by 885.
Definition: date_type.h:30
void UpdateViewport(bool force_update, bool update_delta)
Update vehicle sprite- and position caches.
StationID last_station_visited
The last station we stopped at.
Definition: vehicle_base.h:302
uint16 reliability_spd_dec
Reliability decrease speed.
Definition: vehicle_base.h:262
A railway.
Definition: tile_type.h:44
Money GetCost() const
The costs as made up to this moment.
Definition: command_type.h:84
void HandlePathfindingResult(bool path_found)
Handle the pathfinding result, especially the lost status.
Definition: vehicle.cpp:775
Common return value for all commands.
Definition: command_type.h:25
byte vehstatus
Status.
Definition: vehicle_base.h:317
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:87
byte flags
Flags of the engine.
Definition: engine_base.h:35
Year _cur_year
Current year, starting at 0.
Definition: date.cpp:26
uint16 cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Definition: vehicle_base.h:123
bool NeedsAutomaticServicing() const
Checks if the current order should be interrupted for a service-in-depot order.
Definition: vehicle.cpp:252
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition: vehicle.cpp:743
CargoID GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition: engine_base.h:81
void OnNewDay()
Calls the new day handler of the vehicle.
Definition: ship_cmd.cpp:224
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:15
Entry point for OpenTTD to YAPF.
byte VehicleRandomBits()
Get a value for a vehicle&#39;s random_bits.
Definition: vehicle.cpp:362
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition: economy.cpp:958
VehicleSpriteSeq sprite_seq
Vehicle appearance.
Definition: vehicle_base.h:280
Direction
Defines the 8 directions on the map.
uint16 max_speed
Maximum speed (1 unit = 1/3.2 mph = 0.5 km-ish/h)
Definition: engine_type.h:69
CompanyByte _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:154
bool YapfShipCheckReverse(const Ship *v)
Returns true if it is better to reverse the ship before leaving depot using YAPF. ...
Definition: yapf_ship.cpp:242
TrackBits
Bitfield corresponding to Track.
Definition: track_type.h:41
uint16 cargo_cap
total capacity
Definition: vehicle_base.h:307
static bool IsTileOwner(TileIndex tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition: tile_map.h:207
Vehicle is crashed.
Definition: vehicle_base.h:39
Vehicle is a prototype (accepted as exclusive preview).
Definition: vehicle_base.h:46
static DiagDirection DiagdirBetweenTiles(TileIndex tile_from, TileIndex tile_to)
Determines the DiagDirection to get from one tile to another.
Definition: map_func.h:384
static TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition: map_func.h:343
void UpdateCache()
Update the caches of this ship.
Definition: ship_cmd.cpp:202
uint16 reliability_spd_dec
Speed of reliability decay between services (per day).
Definition: engine_base.h:28
void SubtractMoneyFromCompanyFract(CompanyID company, CommandCost cst)
Subtract money from a company, including the money fraction.
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a give tiletype.
Definition: tile_map.h:143
void MarkDirty()
Marks the vehicles to be redrawn and updates cached variables.
Definition: ship_cmd.cpp:267
int y
x and y position of the vehicle after moving
Definition: vehicle_func.h:78
void AgeVehicle(Vehicle *v)
Update age of a vehicle.
Definition: vehicle.cpp:1320
bool IsValid() const
Check whether the sequence contains any sprites.
Definition: vehicle_base.h:147
West.
YAPFSettings yapf
pathfinder settings for the yet another pathfinder
void MakeDummy()
Makes this order a Dummy order.
Definition: order_cmd.cpp:134
int8 y_offs
y offset for vehicle sprite
Definition: vehicle_base.h:287
WaterClass
classes of water (for WATER_TILE_CLEAR water tile type).
Definition: water_map.h:49
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:63
static DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
DoCommandFlag
List of flags for a command.
Definition: command_type.h:340
The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/...
Definition: tile_cmd.h:24
Definition of base types and functions in a cross-platform compatible way.
A number of safeguards to prevent using unsafe methods.
byte x_extent
x-extent of vehicle bounding box
Definition: vehicle_base.h:281
void InvalidateNewGRFCacheOfChain()
Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle) ...
Definition: vehicle_base.h:461
bool ProcessOrders(Vehicle *v)
Handle the orders of a vehicle and determine the next place to go to if needed.
Definition: order_cmd.cpp:2160
WaterClass GetEffectiveWaterClass(TileIndex tile)
Determine the effective WaterClass for a ship travelling on a tile.
Definition: ship_cmd.cpp:47
static const int YAPF_TILE_LENGTH
Length (penalty) of one tile with YAPF.
byte z_extent
z-extent of vehicle bounding box
Definition: vehicle_base.h:283
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:74
Vehicle starting, i.e. leaving, the station.
Definition: newgrf_sound.h:21
Track OPFShipChooseTrack(const Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks, bool &path_found)
returns the track to choose on the next tile, or -1 when it&#39;s better to reverse.
Definition: opf_ship.cpp:190
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:305
static bool IsValidDiagDirection(DiagDirection d)
Checks if an integer value is a valid DiagDirection.
Vehicle view; Window numbers:
Definition: window_type.h:334
Number of ticks before carried cargo is aged.
TileIndex tile
Current tile index.
Definition: vehicle_base.h:230
New PathFinder.
Definition: vehicle_type.h:62
Grass with a fence and shore or water on the free halftile.
Definition: rail_map.h:500
Functions to access the new pathfinder.
static Trackdir TrackDirectionToTrackdir(Track track, Direction dir)
Maps a track and a full (8-way) direction to the trackdir that represents the track running in the gi...
Definition: track_func.h:486
void GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
Gets the sprite to show for the given direction.
Definition: ship_cmd.cpp:127
static Trackdir DiagDirToDiagTrackdir(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal trackdir that runs in that direction.
Definition: track_func.h:525
VehicleEnterTileStatus VehicleEnterTile(Vehicle *v, TileIndex tile, int x, int y)
Call the tile callback function for a vehicle entering a tile.
Definition: vehicle.cpp:1662
int8 x_offs
x offset for vehicle sprite
Definition: vehicle_base.h:286
StationFacilityByte facilities
The facilities that this station has.
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:130
DiagDirection
Enumeration for diagonal directions.
#define lengthof(x)
Return the length of an fixed size array.
Definition: depend.cpp:42
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:42
static bool IsShipDepotTile(TileIndex t)
Is it a ship depot tile?
Definition: water_map.h:226
Station with a dock.
Definition: station_type.h:59
uint16 refit_cap
Capacity left over from before last refit.
Definition: vehicle_base.h:308
byte random_bits
Bits used for determining which randomized variational spritegroups to use when drawing.
Definition: vehicle_base.h:299
Functions related to sound.
uint16 reliability
Reliability.
Definition: vehicle_base.h:261
Functions to cache sprites in memory.
Running costs ships.
Definition: economy_type.h:156
byte tick_counter
Increased by one for each tick.
Definition: vehicle_base.h:314
All ships have this type.
Definition: ship.h:24
static DepotID GetDepotIndex(TileIndex t)
Get the index of which depot is attached to the tile.
Definition: depot_map.h:54
Year build_year
Year the vehicle has been built.
Definition: vehicle_base.h:257
bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event)
Checks whether a NewGRF wants to play a different vehicle sound effect.
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
Definition: landscape.cpp:509
uint DetermineCapacity(const Vehicle *v, uint16 *mail_capacity=NULL) const
Determines capacity of a given vehicle from scratch.
Definition: engine.cpp:206
static void NewEvent(CompanyID company, ScriptEvent *event)
Queue a new event for an AI.
Definition: ai_core.cpp:233
static T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:139
static TrackBits DiagdirReachesTracks(DiagDirection diagdir)
Returns all tracks that can be reached when entering a tile from a given (diagonal) direction...
Definition: track_func.h:561
TileIndex GetOrderStationLocation(StationID station)
Determine the location for the station where the vehicle goes to next.
Definition: ship_cmd.cpp:286
TileIndex old_tile
Current tile of the vehicle.
Definition: vehicle_func.h:79
static TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
Return the offset between to tiles from a TileIndexDiffC struct.
Definition: map_func.h:232
Bitflag for a wormhole (used for tunnels)
Definition: track_type.h:58
execute the given command
Definition: command_type.h:342
static TrackBits TrackToTrackBits(Track track)
Maps a Track to the corresponding TrackBits value.
Definition: track_func.h:87
Functions related to companies.
static DiagDirection GetShipDepotDirection(TileIndex t)
Get the direction of the ship depot.
Definition: water_map.h:261
GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v)
Get position information of a vehicle when moving one pixel in the direction it is facing...
Definition: vehicle.cpp:1608
void UpdatePosition()
Update the position of the vehicle.
Definition: vehicle.cpp:1547
Base class for engines.
Flag for an invalid track.
Definition: track_type.h:30
Tunnel entry/exit and bridge heads.
Definition: tile_type.h:52
DestinationID GetDestination() const
Gets the destination of this order.
Definition: order_base.h:96
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition: engine_base.h:140
void VehicleServiceInDepot(Vehicle *v)
Service a vehicle and all subsequent vehicles in the consist.
Definition: vehicle.cpp:163
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, byte widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
Definition: window.cpp:3134
void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type=ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action=ODATF_SERVICE_ONLY, CargoID cargo=CT_NO_REFIT)
Makes this order a Go To Depot order.
Definition: order_cmd.cpp:91
bool HandleBreakdown()
Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds, and ending the breakdown when appropriate.
Definition: vehicle.cpp:1254
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:22
void UpdateVehicleTimetable(Vehicle *v, bool travelling)
Update the timetable for the vehicle.
CompanyByte _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
Ships list; Window numbers:
Definition: window_type.h:315
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1569
Bitflag for a depot.
Definition: track_type.h:59
Max. speed: 1 unit = 1/3.2 mph = 0.5 km-ish/h.
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition: map.cpp:159
void BeginLoading()
Prepare everything to begin the loading when arriving at a station.
Definition: vehicle.cpp:2005
void MakeLeaveStation()
Makes this order a Leave Station order.
Definition: order_cmd.cpp:125
Date date_of_last_service
Last date the vehicle had a service at a depot.
Definition: vehicle_base.h:260
Position information of a vehicle after it moved.
Definition: vehicle_func.h:77
First vehicle arrived for company.
Definition: news_type.h:37
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:217
void Free()
&#39;Free&#39; the order
Definition: order_cmd.cpp:64
OwnerByte owner
Which company owns the vehicle?
Definition: vehicle_base.h:273
Functions related to zooming.
Trackdir GetVehicleTrackdir() const
Returns the Trackdir on which the vehicle is currently located.
Definition: ship_cmd.cpp:250
static Track FindFirstTrack(TrackBits tracks)
Returns first Track from TrackBits or INVALID_TRACK.
Definition: track_func.h:187
static TrackBits TrackStatusToTrackBits(TrackStatus ts)
Returns the present-track-information of a TrackStatus.
Definition: track_func.h:351
Functions related to OTTD&#39;s landscape.
static const int NPF_TILE_LENGTH
Length (penalty) of one tile with NPF.
int32 z_pos
z coordinate.
Definition: vehicle_base.h:270
Vehicle is not visible.
Definition: vehicle_base.h:32
Vehicle details; Window numbers:
Definition: window_type.h:195
Base functions for all Games.
uint32 maximum_go_to_depot_penalty
What is the maximum penalty that may be endured for going to a depot.
Base for ships.
Original pathfinder for ships; very simple.
Functions that have tunnels and bridges in common.
uint8 original_image_index
Original vehicle image index, thus the image index of the overridden vehicle.
Definition: engine_base.h:41
byte running_ticks
Number of ticks this vehicle was not stopped this day.
Definition: vehicle_base.h:315
byte y_extent
y-extent of vehicle bounding box
Definition: vehicle_base.h:282
static TileIndexDiffC GetDockOffset(TileIndex t)
Get the tileoffset from this tile a ship should target to get to this dock.
Definition: station_map.h:444
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:288
int32 x_pos
x coordinate.
Definition: vehicle_base.h:268
uint16 vehicle_flags
Used for gradual loading and other miscellaneous things (.
Definition: base_consist.h:32
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
static bool HasTileWaterClass(TileIndex t)
Checks whether the tile has an waterclass associated.
Definition: water_map.h:95
Functions related to NewGRF provided sounds.
Base functions for all AIs.
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:85
byte progress
The percentage (if divided by 256) this vehicle already crossed the tile unit.
Definition: vehicle_base.h:297
The vehicle cannot enter the tile.
Definition: tile_cmd.h:25
Specification of a rectangle with absolute coordinates of all edges.
int32 y_pos
y coordinate.
Definition: vehicle_base.h:269
uint16 GetMaxSpeed() const
Get the maxmimum speed in km-ish/h a vehicle is allowed to reach on the way to the destination...
Definition: order_base.h:194
virtual bool IsChainInDepot() const
Check whether the whole vehicle chain is in the depot.
Definition: vehicle_base.h:511
Window functions not directly related to making/drawing windows.
Flag for an invalid trackdir.
Definition: track_type.h:93
static DiagDirection AxisToDiagDir(Axis a)
Converts an Axis to a DiagDirection.
uint8 pathfinder_for_ships
the pathfinder to use for ships
#define TILE_ADD(x, y)
Adds to tiles together.
Definition: map_func.h:246
Money profit_this_year
Profit this year << 8, low 8 bits are fract.
Definition: vehicle_base.h:239
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3148
Functions related to news.
Base classes/functions for stations.
CommandCost CmdBuildShip(TileIndex tile, DoCommandFlag flags, const Engine *e, uint16 data, Vehicle **ret)
Build a ship.
Definition: ship_cmd.cpp:653
VehicleCache vcache
Cache of often used vehicle values.
Definition: vehicle_base.h:330
static Station * Get(size_t index)
Gets station with given index.
Date _date
Current date in days (day counter)
Definition: date.cpp:28
static Direction ReverseDir(Direction d)
Return the reverse of a direction.
TileIndex new_tile
Tile of the vehicle after moving.
Definition: vehicle_func.h:80
bool FindClosestDepot(TileIndex *location, DestinationID *destination, bool *reverse)
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Definition: ship_cmd.cpp:715
This depot order is because of the servicing limit.
Definition: order_type.h:101
void HandleLoading(bool mode=false)
Handle the loading of the vehicle; when not it skips through dummy orders and does nothing in all oth...
Definition: vehicle.cpp:2214
bool NPFShipCheckReverse(const Ship *v)
Returns true if it is better to reverse the ship before leaving depot using NPF.
Definition: npf.cpp:1178
Station data structure.
Definition: station_base.h:446
No track.
Definition: track_type.h:42
Axis
Allow incrementing of DiagDirDiff variables.
uint GetOldAdvanceSpeed(uint speed)
Determines the effective direction-specific vehicle movement speed.
Definition: vehicle_base.h:386
void GetBounds(Rect *bounds) const
Determine shared bounds of all sprites.
Definition: vehicle.cpp:99
Date GetLifeLengthInDays() const
Returns the vehicle&#39;s (not model&#39;s!) life length in days.
Definition: engine.cpp:446
byte day_counter
Increased by one for each day.
Definition: vehicle_base.h:313
Order current_order
The current order (+ status, like: loading)
Definition: vehicle_base.h:318
static Direction DiagDirToDir(DiagDirection dir)
Convert a DiagDirection to a Direction.
void UpdateVisualEffect(bool allow_power_change=true)
Update the cached visual effect.
Definition: vehicle.cpp:2358
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3220
Money GetRunningCost() const
Gets the running cost of a vehicle.
Definition: ship_cmd.cpp:217
SpriteID colourmap
NOSAVE: cached colour mapping.
Definition: vehicle_base.h:254
static Track ChooseShipTrack(Ship *v, TileIndex tile, DiagDirection enterdir, TrackBits tracks)
Runs the pathfinder to choose a track to continue along.
Definition: ship_cmd.cpp:439
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:201
Ship()
We don&#39;t want GCC to zero our struct! It already is zeroed and has an index!
Definition: ship.h:28
static void AddVehicleNewsItem(StringID string, NewsType type, VehicleID vehicle, StationID station=INVALID_STATION)
Adds a newsitem referencing a vehicle.
Definition: news_func.h:32