OpenTTD Source  14.0-beta3
aircraft_cmd.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
13 #include "stdafx.h"
14 #include "aircraft.h"
15 #include "landscape.h"
16 #include "news_func.h"
17 #include "newgrf_engine.h"
18 #include "newgrf_sound.h"
19 #include "spritecache.h"
20 #include "error_func.h"
21 #include "strings_func.h"
22 #include "command_func.h"
23 #include "window_func.h"
26 #include "vehicle_func.h"
27 #include "sound_func.h"
28 #include "cheat_type.h"
29 #include "company_base.h"
30 #include "ai/ai.hpp"
31 #include "game/game.hpp"
32 #include "company_func.h"
33 #include "effectvehicle_func.h"
34 #include "station_base.h"
35 #include "engine_base.h"
36 #include "core/random_func.hpp"
37 #include "core/backup_type.hpp"
38 #include "zoom_func.h"
39 #include "disaster_vehicle.h"
40 #include "newgrf_airporttiles.h"
41 #include "framerate_type.h"
42 #include "aircraft_cmd.h"
43 #include "vehicle_cmd.h"
44 
45 #include "table/strings.h"
46 
47 #include "safeguards.h"
48 
50 {
51  this->x_offs = -1;
52  this->y_offs = -1;
53  this->x_extent = 2;
54  this->y_extent = 2;
55 
56  switch (this->subtype) {
57  default: NOT_REACHED();
58 
59  case AIR_AIRCRAFT:
60  case AIR_HELICOPTER:
61  switch (this->state) {
62  default: break;
63  case ENDTAKEOFF:
64  case LANDING:
65  case HELILANDING:
66  case FLYING:
67  this->x_extent = 24;
68  this->y_extent = 24;
69  break;
70  }
71  this->z_extent = 5;
72  break;
73 
74  case AIR_SHADOW:
75  this->z_extent = 1;
76  this->x_offs = 0;
77  this->y_offs = 0;
78  break;
79 
80  case AIR_ROTOR:
81  this->z_extent = 1;
82  break;
83  }
84 }
85 
86 static bool AirportMove(Aircraft *v, const AirportFTAClass *apc);
87 static bool AirportSetBlocks(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc);
88 static bool AirportHasBlock(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc);
89 static bool AirportFindFreeTerminal(Aircraft *v, const AirportFTAClass *apc);
90 static bool AirportFindFreeHelipad(Aircraft *v, const AirportFTAClass *apc);
91 static void CrashAirplane(Aircraft *v);
92 
93 static const SpriteID _aircraft_sprite[] = {
94  0x0EB5, 0x0EBD, 0x0EC5, 0x0ECD,
95  0x0ED5, 0x0EDD, 0x0E9D, 0x0EA5,
96  0x0EAD, 0x0EE5, 0x0F05, 0x0F0D,
97  0x0F15, 0x0F1D, 0x0F25, 0x0F2D,
98  0x0EED, 0x0EF5, 0x0EFD, 0x0F35,
99  0x0E9D, 0x0EA5, 0x0EAD, 0x0EB5,
100  0x0EBD, 0x0EC5
101 };
102 
103 template <>
104 bool IsValidImageIndex<VEH_AIRCRAFT>(uint8_t image_index)
105 {
106  return image_index < lengthof(_aircraft_sprite);
107 }
108 
111  HRS_ROTOR_STOPPED,
112  HRS_ROTOR_MOVING_1,
113  HRS_ROTOR_MOVING_2,
114  HRS_ROTOR_MOVING_3,
115 };
116 
124 static StationID FindNearestHangar(const Aircraft *v)
125 {
126  uint best = 0;
127  StationID index = INVALID_STATION;
128  TileIndex vtile = TileVirtXY(v->x_pos, v->y_pos);
129  const AircraftVehicleInfo *avi = AircraftVehInfo(v->engine_type);
130  uint max_range = v->acache.cached_max_range_sqr;
131 
132  /* Determine destinations where it's coming from and where it's heading to */
133  const Station *last_dest = nullptr;
134  const Station *next_dest = nullptr;
135  if (max_range != 0) {
136  if (v->current_order.IsType(OT_GOTO_STATION) ||
140  } else {
141  last_dest = GetTargetAirportIfValid(v);
143  }
144  }
145 
146  for (const Station *st : Station::Iterate()) {
147  if (st->owner != v->owner || !(st->facilities & FACIL_AIRPORT) || !st->airport.HasHangar()) continue;
148 
149  const AirportFTAClass *afc = st->airport.GetFTA();
150 
151  /* don't crash the plane if we know it can't land at the airport */
152  if ((afc->flags & AirportFTAClass::SHORT_STRIP) && (avi->subtype & AIR_FAST) && !_cheats.no_jetcrash.value) continue;
153 
154  /* the plane won't land at any helicopter station */
155  if (!(afc->flags & AirportFTAClass::AIRPLANES) && (avi->subtype & AIR_CTOL)) continue;
156 
157  /* Check if our last and next destinations can be reached from the depot airport. */
158  if (max_range != 0) {
159  uint last_dist = (last_dest != nullptr && last_dest->airport.tile != INVALID_TILE) ? DistanceSquare(st->airport.tile, last_dest->airport.tile) : 0;
160  uint next_dist = (next_dest != nullptr && next_dest->airport.tile != INVALID_TILE) ? DistanceSquare(st->airport.tile, next_dest->airport.tile) : 0;
161  if (last_dist > max_range || next_dist > max_range) continue;
162  }
163 
164  /* v->tile can't be used here, when aircraft is flying v->tile is set to 0 */
165  uint distance = DistanceSquare(vtile, st->airport.tile);
166  if (distance < best || index == INVALID_STATION) {
167  best = distance;
168  index = st->index;
169  }
170  }
171  return index;
172 }
173 
174 void Aircraft::GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
175 {
176  uint8_t spritenum = this->spritenum;
177 
178  if (is_custom_sprite(spritenum)) {
179  GetCustomVehicleSprite(this, direction, image_type, result);
180  if (result->IsValid()) return;
181 
183  }
184 
185  assert(IsValidImageIndex<VEH_AIRCRAFT>(spritenum));
186  result->Set(direction + _aircraft_sprite[spritenum]);
187 }
188 
189 void GetRotorImage(const Aircraft *v, EngineImageType image_type, VehicleSpriteSeq *result)
190 {
191  assert(v->subtype == AIR_HELICOPTER);
192 
193  const Aircraft *w = v->Next()->Next();
194  if (is_custom_sprite(v->spritenum)) {
195  GetCustomRotorSprite(v, image_type, result);
196  if (result->IsValid()) return;
197  }
198 
199  /* Return standard rotor sprites if there are no custom sprites for this helicopter */
200  result->Set(SPR_ROTOR_STOPPED + w->state);
201 }
202 
203 static void GetAircraftIcon(EngineID engine, EngineImageType image_type, VehicleSpriteSeq *result)
204 {
205  const Engine *e = Engine::Get(engine);
206  uint8_t spritenum = e->u.air.image_index;
207 
208  if (is_custom_sprite(spritenum)) {
209  GetCustomVehicleIcon(engine, DIR_W, image_type, result);
210  if (result->IsValid()) return;
211 
212  spritenum = e->original_image_index;
213  }
214 
215  assert(IsValidImageIndex<VEH_AIRCRAFT>(spritenum));
216  result->Set(DIR_W + _aircraft_sprite[spritenum]);
217 }
218 
219 void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
220 {
221  VehicleSpriteSeq seq;
222  GetAircraftIcon(engine, image_type, &seq);
223 
224  Rect rect;
225  seq.GetBounds(&rect);
226  preferred_x = Clamp(preferred_x,
227  left - UnScaleGUI(rect.left),
228  right - UnScaleGUI(rect.right));
229 
230  seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
231 
232  if (!(AircraftVehInfo(engine)->subtype & AIR_CTOL)) {
233  VehicleSpriteSeq rotor_seq;
234  GetCustomRotorIcon(engine, image_type, &rotor_seq);
235  if (!rotor_seq.IsValid()) rotor_seq.Set(SPR_ROTOR_STOPPED);
236  rotor_seq.Draw(preferred_x, y - ScaleSpriteTrad(5), PAL_NONE, false);
237  }
238 }
239 
249 void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
250 {
251  VehicleSpriteSeq seq;
252  GetAircraftIcon(engine, image_type, &seq);
253 
254  Rect rect;
255  seq.GetBounds(&rect);
256 
257  width = UnScaleGUI(rect.Width());
258  height = UnScaleGUI(rect.Height());
259  xoffs = UnScaleGUI(rect.left);
260  yoffs = UnScaleGUI(rect.top);
261 }
262 
272 {
273  const AircraftVehicleInfo *avi = &e->u.air;
274  const Station *st = Station::GetByTile(tile);
275 
276  /* Prevent building aircraft types at places which can't handle them */
277  if (!CanVehicleUseStation(e->index, st)) return CMD_ERROR;
278 
279  /* Make sure all aircraft end up in the first tile of the hangar. */
280  tile = st->airport.GetHangarTile(st->airport.GetHangarNum(tile));
281 
282  if (flags & DC_EXEC) {
283  Aircraft *v = new Aircraft(); // aircraft
284  Aircraft *u = new Aircraft(); // shadow
285  *ret = v;
286 
287  v->direction = DIR_SE;
288 
289  v->owner = u->owner = _current_company;
290 
291  v->tile = tile;
292 
293  uint x = TileX(tile) * TILE_SIZE + 5;
294  uint y = TileY(tile) * TILE_SIZE + 3;
295 
296  v->x_pos = u->x_pos = x;
297  v->y_pos = u->y_pos = y;
298 
299  u->z_pos = GetSlopePixelZ(x, y);
300  v->z_pos = u->z_pos + 1;
301 
304 
305  v->spritenum = avi->image_index;
306 
307  v->cargo_cap = avi->passenger_capacity;
308  v->refit_cap = 0;
309  u->refit_cap = 0;
310 
312  assert(IsValidCargoID(v->cargo_type));
313 
314  CargoID mail = GetCargoIDByLabel(CT_MAIL);
315  if (IsValidCargoID(mail)) {
316  u->cargo_type = mail;
317  u->cargo_cap = avi->mail_capacity;
318  }
319 
320  v->name.clear();
321  v->last_station_visited = INVALID_STATION;
322  v->last_loading_station = INVALID_STATION;
323 
324  v->acceleration = avi->acceleration;
325  v->engine_type = e->index;
326  u->engine_type = e->index;
327 
329  v->UpdateDeltaXY();
330 
331  u->subtype = AIR_SHADOW;
332  u->UpdateDeltaXY();
333 
334  v->reliability = e->reliability;
336  v->max_age = e->GetLifeLengthInDays();
337 
338  v->pos = GetVehiclePosOnBuild(tile);
339 
340  v->state = HANGAR;
341  v->previous_pos = v->pos;
342  v->targetairport = GetStationIndex(tile);
343  v->SetNext(u);
344 
345  v->SetServiceInterval(Company::Get(_current_company)->settings.vehicle.servint_aircraft);
346 
350 
351  v->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
352  u->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
353 
354  v->random_bits = Random();
355  u->random_bits = Random();
356 
357  v->vehicle_flags = 0;
359  v->SetServiceIntervalIsPercent(Company::Get(_current_company)->settings.vehicle.servint_ispercent);
360 
362 
363  v->cargo_cap = e->DetermineCapacity(v, &u->cargo_cap);
364 
366 
367  UpdateAircraftCache(v, true);
368 
369  v->UpdatePosition();
370  u->UpdatePosition();
371 
372  /* Aircraft with 3 vehicles (chopper)? */
373  if (v->subtype == AIR_HELICOPTER) {
374  Aircraft *w = new Aircraft();
375  w->engine_type = e->index;
376  w->direction = DIR_N;
377  w->owner = _current_company;
378  w->x_pos = v->x_pos;
379  w->y_pos = v->y_pos;
380  w->z_pos = v->z_pos + ROTOR_Z_OFFSET;
382  w->spritenum = 0xFF;
383  w->subtype = AIR_ROTOR;
384  w->sprite_cache.sprite_seq.Set(SPR_ROTOR_STOPPED);
385  w->random_bits = Random();
386  /* Use rotor's air.state to store the rotor animation frame */
387  w->state = HRS_ROTOR_STOPPED;
388  w->UpdateDeltaXY();
389 
390  u->SetNext(w);
391  w->UpdatePosition();
392  }
393  }
394 
395  return CommandCost();
396 }
397 
398 
400 {
401  const Station *st = GetTargetAirportIfValid(this);
402  /* If the station is not a valid airport or if it has no hangars */
403  if (st == nullptr || !CanVehicleUseStation(this, st) || !st->airport.HasHangar()) {
404  /* the aircraft has to search for a hangar on its own */
405  StationID station = FindNearestHangar(this);
406 
407  if (station == INVALID_STATION) return ClosestDepot();
408 
409  st = Station::Get(station);
410  }
411 
412  return ClosestDepot(st->xy, st->index);
413 }
414 
415 static void CheckIfAircraftNeedsService(Aircraft *v)
416 {
417  if (Company::Get(v->owner)->settings.vehicle.servint_aircraft == 0 || !v->NeedsAutomaticServicing()) return;
418  if (v->IsChainInDepot()) {
420  return;
421  }
422 
423  /* When we're parsing conditional orders and the like
424  * we don't want to consider going to a depot too. */
425  if (!v->current_order.IsType(OT_GOTO_DEPOT) && !v->current_order.IsType(OT_GOTO_STATION)) return;
426 
428 
429  assert(st != nullptr);
430 
431  /* only goto depot if the target airport has a depot */
432  if (st->airport.HasHangar() && CanVehicleUseStation(v, st)) {
435  } else if (v->current_order.IsType(OT_GOTO_DEPOT)) {
438  }
439 }
440 
442 {
443  const Engine *e = this->GetEngine();
444  uint cost_factor = GetVehicleProperty(this, PROP_AIRCRAFT_RUNNING_COST_FACTOR, e->u.air.running_cost);
445  return GetPrice(PR_RUNNING_AIRCRAFT, cost_factor, e->GetGRF());
446 }
447 
450 {
451  if (!this->IsNormalAircraft()) return;
452  AgeVehicle(this);
453 }
454 
457 {
458  if (!this->IsNormalAircraft()) return;
459 
460  if ((++this->day_counter & 7) == 0) DecreaseVehicleValue(this);
461 
462  CheckOrders(this);
463 
464  CheckVehicleBreakdown(this);
465  CheckIfAircraftNeedsService(this);
466 
467  if (this->running_ticks == 0) return;
468 
470 
471  this->profit_this_year -= cost.GetCost();
472  this->running_ticks = 0;
473 
475 
478 }
479 
480 static void HelicopterTickHandler(Aircraft *v)
481 {
482  Aircraft *u = v->Next()->Next();
483 
484  if (u->vehstatus & VS_HIDDEN) return;
485 
486  /* if true, helicopter rotors do not rotate. This should only be the case if a helicopter is
487  * loading/unloading at a terminal or stopped */
488  if (v->current_order.IsType(OT_LOADING) || (v->vehstatus & VS_STOPPED)) {
489  if (u->cur_speed != 0) {
490  u->cur_speed++;
491  if (u->cur_speed >= 0x80 && u->state == HRS_ROTOR_MOVING_3) {
492  u->cur_speed = 0;
493  }
494  }
495  } else {
496  if (u->cur_speed == 0) {
497  u->cur_speed = 0x70;
498  }
499  if (u->cur_speed >= 0x50) {
500  u->cur_speed--;
501  }
502  }
503 
504  int tick = ++u->tick_counter;
505  int spd = u->cur_speed >> 4;
506 
507  VehicleSpriteSeq seq;
508  if (spd == 0) {
509  u->state = HRS_ROTOR_STOPPED;
510  GetRotorImage(v, EIT_ON_MAP, &seq);
511  if (u->sprite_cache.sprite_seq == seq) return;
512  } else if (tick >= spd) {
513  u->tick_counter = 0;
514  u->state++;
515  if (u->state > HRS_ROTOR_MOVING_3) u->state = HRS_ROTOR_MOVING_1;
516  GetRotorImage(v, EIT_ON_MAP, &seq);
517  } else {
518  return;
519  }
520 
521  u->sprite_cache.sprite_seq = seq;
522 
524 }
525 
533 void SetAircraftPosition(Aircraft *v, int x, int y, int z)
534 {
535  v->x_pos = x;
536  v->y_pos = y;
537  v->z_pos = z;
538 
539  v->UpdatePosition();
540  v->UpdateViewport(true, false);
541  if (v->subtype == AIR_HELICOPTER) {
542  GetRotorImage(v, EIT_ON_MAP, &v->Next()->Next()->sprite_cache.sprite_seq);
543  }
544 
545  Aircraft *u = v->Next();
546 
547  int safe_x = Clamp(x, 0, Map::MaxX() * TILE_SIZE);
548  int safe_y = Clamp(y - 1, 0, Map::MaxY() * TILE_SIZE);
549  u->x_pos = x;
550  u->y_pos = y - ((v->z_pos - GetSlopePixelZ(safe_x, safe_y)) >> 3);
551 
552  safe_y = Clamp(u->y_pos, 0, Map::MaxY() * TILE_SIZE);
553  u->z_pos = GetSlopePixelZ(safe_x, safe_y);
554  u->sprite_cache.sprite_seq.CopyWithoutPalette(v->sprite_cache.sprite_seq); // the shadow is never coloured
555 
557 
558  u = u->Next();
559  if (u != nullptr) {
560  u->x_pos = x;
561  u->y_pos = y;
562  u->z_pos = z + ROTOR_Z_OFFSET;
563 
565  }
566 }
567 
573 {
574  v->subspeed = 0;
575  v->progress = 0;
576 
577  Aircraft *u = v->Next();
578  u->vehstatus |= VS_HIDDEN;
579  u = u->Next();
580  if (u != nullptr) {
581  u->vehstatus |= VS_HIDDEN;
582  u->cur_speed = 0;
583  }
584 
585  SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
586 }
587 
588 static void PlayAircraftSound(const Vehicle *v)
589 {
590  if (!PlayVehicleSound(v, VSE_START)) {
591  SndPlayVehicleFx(AircraftVehInfo(v->engine_type)->sfx, v);
592  }
593 }
594 
595 
602 void UpdateAircraftCache(Aircraft *v, bool update_range)
603 {
604  uint max_speed = GetVehicleProperty(v, PROP_AIRCRAFT_SPEED, 0);
605  if (max_speed != 0) {
606  /* Convert from original units to km-ish/h */
607  max_speed = (max_speed * 128) / 10;
608 
609  v->vcache.cached_max_speed = max_speed;
610  } else {
611  /* Use the default max speed of the vehicle. */
612  v->vcache.cached_max_speed = AircraftVehInfo(v->engine_type)->max_speed;
613  }
614 
615  /* Update cargo aging period. */
617  Aircraft *u = v->Next(); // Shadow for mail
619 
620  /* Update aircraft range. */
621  if (update_range) {
622  v->acache.cached_max_range = GetVehicleProperty(v, PROP_AIRCRAFT_RANGE, AircraftVehInfo(v->engine_type)->max_range);
623  /* Squared it now so we don't have to do it later all the time. */
624  v->acache.cached_max_range_sqr = v->acache.cached_max_range * v->acache.cached_max_range;
625  }
626 }
627 
628 
637  SPEED_LIMIT_NONE = 0xFFFF,
638 };
639 
647 static int UpdateAircraftSpeed(Aircraft *v, uint speed_limit = SPEED_LIMIT_NONE, bool hard_limit = true)
648 {
656  uint spd = v->acceleration * 77;
657  byte t;
658 
659  /* Adjust speed limits by plane speed factor to prevent taxiing
660  * and take-off speeds being too low. */
661  speed_limit *= _settings_game.vehicle.plane_speed;
662 
663  /* adjust speed for broken vehicles */
664  if (v->vehstatus & VS_AIRCRAFT_BROKEN) {
665  if (SPEED_LIMIT_BROKEN < speed_limit) hard_limit = false;
666  speed_limit = std::min<uint>(speed_limit, SPEED_LIMIT_BROKEN);
667  }
668 
669  if (v->vcache.cached_max_speed < speed_limit) {
670  if (v->cur_speed < speed_limit) hard_limit = false;
671  speed_limit = v->vcache.cached_max_speed;
672  }
673 
674  v->subspeed = (t = v->subspeed) + (byte)spd;
675 
676  /* Aircraft's current speed is used twice so that very fast planes are
677  * forced to slow down rapidly in the short distance needed. The magic
678  * value 16384 was determined to give similar results to the old speed/48
679  * method at slower speeds. This also results in less reduction at slow
680  * speeds to that aircraft do not get to taxi speed straight after
681  * touchdown. */
682  if (!hard_limit && v->cur_speed > speed_limit) {
683  speed_limit = v->cur_speed - std::max(1, ((v->cur_speed * v->cur_speed) / 16384) / _settings_game.vehicle.plane_speed);
684  }
685 
686  spd = std::min(v->cur_speed + (spd >> 8) + (v->subspeed < t), speed_limit);
687 
688  /* updates statusbar only if speed have changed to save CPU time */
689  if (spd != v->cur_speed) {
690  v->cur_speed = spd;
692  }
693 
694  /* Adjust distance moved by plane speed setting */
696 
697  /* Convert direction-independent speed into direction-dependent speed. (old movement method) */
698  spd = v->GetOldAdvanceSpeed(spd);
699 
700  spd += v->progress;
701  v->progress = (byte)spd;
702  return spd >> 8;
703 }
704 
713 {
714  int safe_x = Clamp(v->x_pos, 0, Map::MaxX() * TILE_SIZE);
715  int safe_y = Clamp(v->y_pos, 0, Map::MaxY() * TILE_SIZE);
716  return TileHeight(TileVirtXY(safe_x, safe_y)) * TILE_HEIGHT;
717 }
718 
729 void GetAircraftFlightLevelBounds(const Vehicle *v, int *min_level, int *max_level)
730 {
731  int base_altitude = GetTileHeightBelowAircraft(v);
732  if (v->type == VEH_AIRCRAFT && Aircraft::From(v)->subtype == AIR_HELICOPTER) {
734  }
735 
736  /* Make sure eastbound and westbound planes do not "crash" into each
737  * other by providing them with vertical separation
738  */
739  switch (v->direction) {
740  case DIR_N:
741  case DIR_NE:
742  case DIR_E:
743  case DIR_SE:
744  base_altitude += 10;
745  break;
746 
747  default: break;
748  }
749 
750  /* Make faster planes fly higher so that they can overtake slower ones */
751  base_altitude += std::min(20 * (v->vcache.cached_max_speed / 200) - 90, 0);
752 
753  if (min_level != nullptr) *min_level = base_altitude + AIRCRAFT_MIN_FLYING_ALTITUDE;
754  if (max_level != nullptr) *max_level = base_altitude + AIRCRAFT_MAX_FLYING_ALTITUDE;
755 }
756 
765 {
766  int tile_height = GetTileHeightBelowAircraft(v);
767 
769 }
770 
771 template <class T>
772 int GetAircraftFlightLevel(T *v, bool takeoff)
773 {
774  /* Aircraft is in flight. We want to enforce it being somewhere
775  * between the minimum and the maximum allowed altitude. */
776  int aircraft_min_altitude;
777  int aircraft_max_altitude;
778  GetAircraftFlightLevelBounds(v, &aircraft_min_altitude, &aircraft_max_altitude);
779  int aircraft_middle_altitude = (aircraft_min_altitude + aircraft_max_altitude) / 2;
780 
781  /* If those assumptions would be violated, aircraft would behave fairly strange. */
782  assert(aircraft_min_altitude < aircraft_middle_altitude);
783  assert(aircraft_middle_altitude < aircraft_max_altitude);
784 
785  int z = v->z_pos;
786  if (z < aircraft_min_altitude ||
787  (HasBit(v->flags, VAF_IN_MIN_HEIGHT_CORRECTION) && z < aircraft_middle_altitude)) {
788  /* Ascend. And don't fly into that mountain right ahead.
789  * And avoid our aircraft become a stairclimber, so if we start
790  * correcting altitude, then we stop correction not too early. */
792  z += takeoff ? 2 : 1;
793  } else if (!takeoff && (z > aircraft_max_altitude ||
794  (HasBit(v->flags, VAF_IN_MAX_HEIGHT_CORRECTION) && z > aircraft_middle_altitude))) {
795  /* Descend lower. You are an aircraft, not an space ship.
796  * And again, don't stop correcting altitude too early. */
798  z--;
799  } else if (HasBit(v->flags, VAF_IN_MIN_HEIGHT_CORRECTION) && z >= aircraft_middle_altitude) {
800  /* Now, we have corrected altitude enough. */
802  } else if (HasBit(v->flags, VAF_IN_MAX_HEIGHT_CORRECTION) && z <= aircraft_middle_altitude) {
803  /* Now, we have corrected altitude enough. */
805  }
806 
807  return z;
808 }
809 
810 template int GetAircraftFlightLevel(DisasterVehicle *v, bool takeoff);
811 template int GetAircraftFlightLevel(Aircraft *v, bool takeoff);
812 
827 static byte AircraftGetEntryPoint(const Aircraft *v, const AirportFTAClass *apc, Direction rotation)
828 {
829  assert(v != nullptr);
830  assert(apc != nullptr);
831 
832  /* In the case the station doesn't exit anymore, set target tile 0.
833  * It doesn't hurt much, aircraft will go to next order, nearest hangar
834  * or it will simply crash in next tick */
835  TileIndex tile = 0;
836 
837  const Station *st = Station::GetIfValid(v->targetairport);
838  if (st != nullptr) {
839  /* Make sure we don't go to INVALID_TILE if the airport has been removed. */
840  tile = (st->airport.tile != INVALID_TILE) ? st->airport.tile : st->xy;
841  }
842 
843  int delta_x = v->x_pos - TileX(tile) * TILE_SIZE;
844  int delta_y = v->y_pos - TileY(tile) * TILE_SIZE;
845 
846  DiagDirection dir;
847  if (abs(delta_y) < abs(delta_x)) {
848  /* We are northeast or southwest of the airport */
849  dir = delta_x < 0 ? DIAGDIR_NE : DIAGDIR_SW;
850  } else {
851  /* We are northwest or southeast of the airport */
852  dir = delta_y < 0 ? DIAGDIR_NW : DIAGDIR_SE;
853  }
854  dir = ChangeDiagDir(dir, DiagDirDifference(DIAGDIR_NE, DirToDiagDir(rotation)));
855  return apc->entry_points[dir];
856 }
857 
858 
859 static void MaybeCrashAirplane(Aircraft *v);
860 
869 {
870  /* nullptr if station is invalid */
871  const Station *st = Station::GetIfValid(v->targetairport);
872  /* INVALID_TILE if there is no station */
873  TileIndex tile = INVALID_TILE;
874  Direction rotation = DIR_N;
875  uint size_x = 1, size_y = 1;
876  if (st != nullptr) {
877  if (st->airport.tile != INVALID_TILE) {
878  tile = st->airport.tile;
879  rotation = st->airport.rotation;
880  size_x = st->airport.w;
881  size_y = st->airport.h;
882  } else {
883  tile = st->xy;
884  }
885  }
886  /* DUMMY if there is no station or no airport */
887  const AirportFTAClass *afc = tile == INVALID_TILE ? GetAirport(AT_DUMMY) : st->airport.GetFTA();
888 
889  /* prevent going to INVALID_TILE if airport is deleted. */
890  if (st == nullptr || st->airport.tile == INVALID_TILE) {
891  /* Jump into our "holding pattern" state machine if possible */
892  if (v->pos >= afc->nofelements) {
893  v->pos = v->previous_pos = AircraftGetEntryPoint(v, afc, DIR_N);
894  } else if (v->targetairport != v->current_order.GetDestination()) {
895  /* If not possible, just get out of here fast */
896  v->state = FLYING;
899  /* get aircraft back on running altitude */
900  SetAircraftPosition(v, v->x_pos, v->y_pos, GetAircraftFlightLevel(v));
901  return false;
902  }
903  }
904 
905  /* get airport moving data */
906  const AirportMovingData amd = RotateAirportMovingData(afc->MovingData(v->pos), rotation, size_x, size_y);
907 
908  int x = TileX(tile) * TILE_SIZE;
909  int y = TileY(tile) * TILE_SIZE;
910 
911  /* Helicopter raise */
912  if (amd.flag & AMED_HELI_RAISE) {
913  Aircraft *u = v->Next()->Next();
914 
915  /* Make sure the rotors don't rotate too fast */
916  if (u->cur_speed > 32) {
917  v->cur_speed = 0;
918  if (--u->cur_speed == 32) {
919  if (!PlayVehicleSound(v, VSE_START)) {
920  SoundID sfx = AircraftVehInfo(v->engine_type)->sfx;
921  /* For compatibility with old NewGRF we ignore the sfx property, unless a NewGRF-defined sound is used.
922  * The baseset has only one helicopter sound, so this only limits using plane or cow sounds. */
924  SndPlayVehicleFx(sfx, v);
925  }
926  }
927  } else {
928  u->cur_speed = 32;
929  int count = UpdateAircraftSpeed(v);
930  if (count > 0) {
931  v->tile = 0;
932 
933  int z_dest;
934  GetAircraftFlightLevelBounds(v, &z_dest, nullptr);
935 
936  /* Reached altitude? */
937  if (v->z_pos >= z_dest) {
938  v->cur_speed = 0;
939  return true;
940  }
941  SetAircraftPosition(v, v->x_pos, v->y_pos, std::min(v->z_pos + count, z_dest));
942  }
943  }
944  return false;
945  }
946 
947  /* Helicopter landing. */
948  if (amd.flag & AMED_HELI_LOWER) {
950 
951  if (st == nullptr) {
952  /* FIXME - AircraftController -> if station no longer exists, do not land
953  * helicopter will circle until sign disappears, then go to next order
954  * what to do when it is the only order left, right now it just stays in 1 place */
955  v->state = FLYING;
958  return false;
959  }
960 
961  /* Vehicle is now at the airport.
962  * Helicopter has arrived at the target landing pad, so the current position is also where it should land.
963  * Except for Oilrigs which are special due to being a 1x1 station, and helicopters land outside it. */
964  if (st->airport.type != AT_OILRIG) {
965  x = v->x_pos;
966  y = v->y_pos;
967  tile = TileVirtXY(x, y);
968  }
969  v->tile = tile;
970 
971  /* Find altitude of landing position. */
972  int z = GetSlopePixelZ(x, y) + 1 + afc->delta_z;
973 
974  if (z == v->z_pos) {
975  Vehicle *u = v->Next()->Next();
976 
977  /* Increase speed of rotors. When speed is 80, we've landed. */
978  if (u->cur_speed >= 80) {
980  return true;
981  }
982  u->cur_speed += 4;
983  } else {
984  int count = UpdateAircraftSpeed(v);
985  if (count > 0) {
986  if (v->z_pos > z) {
987  SetAircraftPosition(v, v->x_pos, v->y_pos, std::max(v->z_pos - count, z));
988  } else {
989  SetAircraftPosition(v, v->x_pos, v->y_pos, std::min(v->z_pos + count, z));
990  }
991  }
992  }
993  return false;
994  }
995 
996  /* Get distance from destination pos to current pos. */
997  uint dist = abs(x + amd.x - v->x_pos) + abs(y + amd.y - v->y_pos);
998 
999  /* Need exact position? */
1000  if (!(amd.flag & AMED_EXACTPOS) && dist <= (amd.flag & AMED_SLOWTURN ? 8U : 4U)) return true;
1001 
1002  /* At final pos? */
1003  if (dist == 0) {
1004  /* Change direction smoothly to final direction. */
1005  DirDiff dirdiff = DirDifference(amd.direction, v->direction);
1006  /* if distance is 0, and plane points in right direction, no point in calling
1007  * UpdateAircraftSpeed(). So do it only afterwards */
1008  if (dirdiff == DIRDIFF_SAME) {
1009  v->cur_speed = 0;
1010  return true;
1011  }
1012 
1013  if (!UpdateAircraftSpeed(v, SPEED_LIMIT_TAXI)) return false;
1014 
1016  v->cur_speed >>= 1;
1017 
1018  SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1019  return false;
1020  }
1021 
1023  MaybeCrashAirplane(v);
1024  if ((v->vehstatus & VS_CRASHED) != 0) return false;
1025  }
1026 
1027  uint speed_limit = SPEED_LIMIT_TAXI;
1028  bool hard_limit = true;
1029 
1030  if (amd.flag & AMED_NOSPDCLAMP) speed_limit = SPEED_LIMIT_NONE;
1031  if (amd.flag & AMED_HOLD) { speed_limit = SPEED_LIMIT_HOLD; hard_limit = false; }
1032  if (amd.flag & AMED_LAND) { speed_limit = SPEED_LIMIT_APPROACH; hard_limit = false; }
1033  if (amd.flag & AMED_BRAKE) { speed_limit = SPEED_LIMIT_TAXI; hard_limit = false; }
1034 
1035  int count = UpdateAircraftSpeed(v, speed_limit, hard_limit);
1036  if (count == 0) return false;
1037 
1038  /* If the plane will be a few subpixels away from the destination after
1039  * this movement loop, start nudging it towards the exact position for
1040  * the whole loop. Otherwise, heavily depending on the speed of the plane,
1041  * it is possible we totally overshoot the target, causing the plane to
1042  * make a loop, and trying again, and again, and again .. */
1043  bool nudge_towards_target = static_cast<uint>(count) + 3 > dist;
1044 
1045  if (v->turn_counter != 0) v->turn_counter--;
1046 
1047  do {
1048 
1050 
1051  if (nudge_towards_target || (amd.flag & AMED_LAND)) {
1052  /* move vehicle one pixel towards target */
1053  gp.x = (v->x_pos != (x + amd.x)) ?
1054  v->x_pos + ((x + amd.x > v->x_pos) ? 1 : -1) :
1055  v->x_pos;
1056  gp.y = (v->y_pos != (y + amd.y)) ?
1057  v->y_pos + ((y + amd.y > v->y_pos) ? 1 : -1) :
1058  v->y_pos;
1059 
1060  /* Oilrigs must keep v->tile as st->airport.tile, since the landing pad is in a non-airport tile */
1061  gp.new_tile = (st->airport.type == AT_OILRIG) ? st->airport.tile : TileVirtXY(gp.x, gp.y);
1062 
1063  } else {
1064 
1065  /* Turn. Do it slowly if in the air. */
1066  Direction newdir = GetDirectionTowards(v, x + amd.x, y + amd.y);
1067  if (newdir != v->direction) {
1068  if (amd.flag & AMED_SLOWTURN && v->number_consecutive_turns < 8 && v->subtype == AIR_AIRCRAFT) {
1069  if (v->turn_counter == 0 || newdir == v->last_direction) {
1070  if (newdir == v->last_direction) {
1071  v->number_consecutive_turns = 0;
1072  } else {
1074  }
1076  v->last_direction = v->direction;
1077  v->direction = newdir;
1078  }
1079 
1080  /* Move vehicle. */
1081  gp = GetNewVehiclePos(v);
1082  } else {
1083  v->cur_speed >>= 1;
1084  v->direction = newdir;
1085 
1086  /* When leaving a terminal an aircraft often goes to a position
1087  * directly in front of it. If it would move while turning it
1088  * would need an two extra turns to end up at the correct position.
1089  * To make it easier just disallow all moving while turning as
1090  * long as an aircraft is on the ground. */
1091  gp.x = v->x_pos;
1092  gp.y = v->y_pos;
1093  gp.new_tile = gp.old_tile = v->tile;
1094  }
1095  } else {
1096  v->number_consecutive_turns = 0;
1097  /* Move vehicle. */
1098  gp = GetNewVehiclePos(v);
1099  }
1100  }
1101 
1102  v->tile = gp.new_tile;
1103  /* If vehicle is in the air, use tile coordinate 0. */
1104  if (amd.flag & (AMED_TAKEOFF | AMED_SLOWTURN | AMED_LAND)) v->tile = 0;
1105 
1106  /* Adjust Z for land or takeoff? */
1107  int z = v->z_pos;
1108 
1109  if (amd.flag & AMED_TAKEOFF) {
1110  z = GetAircraftFlightLevel(v, true);
1111  } else if (amd.flag & AMED_HOLD) {
1112  /* Let the plane drop from normal flight altitude to holding pattern altitude */
1113  if (z > GetAircraftHoldMaxAltitude(v)) z--;
1114  } else if ((amd.flag & AMED_SLOWTURN) && (amd.flag & AMED_NOSPDCLAMP)) {
1115  z = GetAircraftFlightLevel(v);
1116  }
1117 
1118  /* NewGRF airports (like a rotated intercontinental from OpenGFX+Airports) can be non-rectangular
1119  * and their primary (north-most) tile does not have to be part of the airport.
1120  * As such, the height of the primary tile can be different from the rest of the airport.
1121  * Given we are landing/breaking, and as such are not a helicopter, we know that there has to be a hangar.
1122  * We also know that the airport itself has to be completely flat (otherwise it is not a valid airport).
1123  * Therefore, use the height of this hangar to calculate our z-value. */
1124  int airport_z = v->z_pos;
1125  if ((amd.flag & (AMED_LAND | AMED_BRAKE)) && st != nullptr) {
1126  assert(st->airport.HasHangar());
1127  TileIndex hangar_tile = st->airport.GetHangarTile(0);
1128  airport_z = GetTileMaxPixelZ(hangar_tile) + 1; // To avoid clashing with the shadow
1129  }
1130 
1131  if (amd.flag & AMED_LAND) {
1132  if (st->airport.tile == INVALID_TILE) {
1133  /* Airport has been removed, abort the landing procedure */
1134  v->state = FLYING;
1137  /* get aircraft back on running altitude */
1138  SetAircraftPosition(v, gp.x, gp.y, GetAircraftFlightLevel(v));
1139  continue;
1140  }
1141 
1142  /* We're not flying below our destination, right? */
1143  assert(airport_z <= z);
1144  int t = std::max(1U, dist - 4);
1145  int delta = z - airport_z;
1146 
1147  /* Only start lowering when we're sufficiently close for a 1:1 glide */
1148  if (delta >= t) {
1149  z -= CeilDiv(z - airport_z, t);
1150  }
1151  if (z < airport_z) z = airport_z;
1152  }
1153 
1154  /* We've landed. Decrease speed when we're reaching end of runway. */
1155  if (amd.flag & AMED_BRAKE) {
1156 
1157  if (z > airport_z) {
1158  z--;
1159  } else if (z < airport_z) {
1160  z++;
1161  }
1162 
1163  }
1164 
1165  SetAircraftPosition(v, gp.x, gp.y, z);
1166  } while (--count != 0);
1167  return false;
1168 }
1169 
1175 {
1176  v->crashed_counter += 3;
1177 
1179 
1180  /* make aircraft crash down to the ground */
1181  if (v->crashed_counter < 500 && st == nullptr && ((v->crashed_counter % 3) == 0) ) {
1182  int z = GetSlopePixelZ(Clamp(v->x_pos, 0, Map::MaxX() * TILE_SIZE), Clamp(v->y_pos, 0, Map::MaxY() * TILE_SIZE));
1183  v->z_pos -= 1;
1184  if (v->z_pos == z) {
1185  v->crashed_counter = 500;
1186  v->z_pos++;
1187  }
1188  }
1189 
1190  if (v->crashed_counter < 650) {
1191  uint32_t r;
1192  if (Chance16R(1, 32, r)) {
1193  static const DirDiff delta[] = {
1195  };
1196 
1197  v->direction = ChangeDir(v->direction, delta[GB(r, 16, 2)]);
1198  SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1199  r = Random();
1201  GB(r, 0, 4) - 4,
1202  GB(r, 4, 4) - 4,
1203  GB(r, 8, 4),
1205  }
1206  } else if (v->crashed_counter >= 10000) {
1207  /* remove rubble of crashed airplane */
1208 
1209  /* clear runway-in on all airports, set by crashing plane
1210  * small airports use AIRPORT_BUSY, city airports use RUNWAY_IN_OUT_block, etc.
1211  * but they all share the same number */
1212  if (st != nullptr) {
1213  CLRBITS(st->airport.flags, RUNWAY_IN_block);
1214  CLRBITS(st->airport.flags, RUNWAY_IN_OUT_block); // commuter airport
1215  CLRBITS(st->airport.flags, RUNWAY_IN2_block); // intercontinental
1216  }
1217 
1218  delete v;
1219 
1220  return false;
1221  }
1222 
1223  return true;
1224 }
1225 
1226 
1232 static void HandleAircraftSmoke(Aircraft *v, bool mode)
1233 {
1234  static const struct {
1235  int8_t x;
1236  int8_t y;
1237  } smoke_pos[] = {
1238  { 5, 5 },
1239  { 6, 0 },
1240  { 5, -5 },
1241  { 0, -6 },
1242  { -5, -5 },
1243  { -6, 0 },
1244  { -5, 5 },
1245  { 0, 6 }
1246  };
1247 
1248  if (!(v->vehstatus & VS_AIRCRAFT_BROKEN)) return;
1249 
1250  /* Stop smoking when landed */
1251  if (v->cur_speed < 10) {
1253  v->breakdown_ctr = 0;
1254  return;
1255  }
1256 
1257  /* Spawn effect et most once per Tick, i.e. !mode */
1258  if (!mode && (v->tick_counter & 0x0F) == 0) {
1260  smoke_pos[v->direction].x,
1261  smoke_pos[v->direction].y,
1262  2,
1264  );
1265  }
1266 }
1267 
1268 void HandleMissingAircraftOrders(Aircraft *v)
1269 {
1270  /*
1271  * We do not have an order. This can be divided into two cases:
1272  * 1) we are heading to an invalid station. In this case we must
1273  * find another airport to go to. If there is nowhere to go,
1274  * we will destroy the aircraft as it otherwise will enter
1275  * the holding pattern for the first airport, which can cause
1276  * the plane to go into an undefined state when building an
1277  * airport with the same StationID.
1278  * 2) we are (still) heading to a (still) valid airport, then we
1279  * can continue going there. This can happen when you are
1280  * changing the aircraft's orders while in-flight or in for
1281  * example a depot. However, when we have a current order to
1282  * go to a depot, we have to keep that order so the aircraft
1283  * actually stops.
1284  */
1285  const Station *st = GetTargetAirportIfValid(v);
1286  if (st == nullptr) {
1287  Backup<CompanyID> cur_company(_current_company, v->owner, FILE_LINE);
1289  cur_company.Restore();
1290 
1291  if (ret.Failed()) CrashAirplane(v);
1292  } else if (!v->current_order.IsType(OT_GOTO_DEPOT)) {
1293  v->current_order.Free();
1294  }
1295 }
1296 
1297 
1298 TileIndex Aircraft::GetOrderStationLocation(StationID)
1299 {
1300  /* Orders are changed in flight, ensure going to the right station. */
1301  if (this->state == FLYING) {
1303  }
1304 
1305  /* Aircraft do not use dest-tile */
1306  return 0;
1307 }
1308 
1310 {
1311  this->colourmap = PAL_NONE;
1312  this->UpdateViewport(true, false);
1313  if (this->subtype == AIR_HELICOPTER) {
1314  GetRotorImage(this, EIT_ON_MAP, &this->Next()->Next()->sprite_cache.sprite_seq);
1315  }
1316 }
1317 
1318 
1319 uint Aircraft::Crash(bool flooded)
1320 {
1321  uint pass = Vehicle::Crash(flooded) + 2; // pilots
1322  this->crashed_counter = flooded ? 9000 : 0; // max 10000, disappear pretty fast when flooded
1323 
1324  return pass;
1325 }
1326 
1331 static void CrashAirplane(Aircraft *v)
1332 {
1334 
1335  uint pass = v->Crash();
1336  SetDParam(0, pass);
1337 
1338  v->cargo.Truncate();
1339  v->Next()->cargo.Truncate();
1340  const Station *st = GetTargetAirportIfValid(v);
1341  StringID newsitem;
1342  TileIndex vt = TileVirtXY(v->x_pos, v->y_pos);
1343  if (st == nullptr) {
1344  newsitem = STR_NEWS_PLANE_CRASH_OUT_OF_FUEL;
1345  } else {
1346  SetDParam(1, st->index);
1347  newsitem = STR_NEWS_AIRCRAFT_CRASH;
1348  }
1349 
1350  AI::NewEvent(v->owner, new ScriptEventVehicleCrashed(v->index, vt, st == nullptr ? ScriptEventVehicleCrashed::CRASH_AIRCRAFT_NO_AIRPORT : ScriptEventVehicleCrashed::CRASH_PLANE_LANDING));
1351  Game::NewEvent(new ScriptEventVehicleCrashed(v->index, vt, st == nullptr ? ScriptEventVehicleCrashed::CRASH_AIRCRAFT_NO_AIRPORT : ScriptEventVehicleCrashed::CRASH_PLANE_LANDING));
1352 
1353  NewsType newstype = NT_ACCIDENT;
1354  if (v->owner != _local_company) {
1355  newstype = NT_ACCIDENT_OTHER;
1356  }
1357 
1358  AddTileNewsItem(newsitem, newstype, vt, nullptr, st != nullptr ? st->index : INVALID_STATION);
1359 
1360  ModifyStationRatingAround(vt, v->owner, -160, 30);
1361  if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, v);
1362 }
1363 
1369 {
1370 
1372 
1373  uint32_t prob;
1375  (AircraftVehInfo(v->engine_type)->subtype & AIR_FAST) &&
1377  prob = 3276;
1378  } else {
1379  if (_settings_game.vehicle.plane_crashes == 0) return;
1380  prob = (0x4000 << _settings_game.vehicle.plane_crashes) / 1500;
1381  }
1382 
1383  if (GB(Random(), 0, 22) > prob) return;
1384 
1385  /* Crash the airplane. Remove all goods stored at the station. */
1386  for (GoodsEntry &ge : st->goods) {
1387  ge.rating = 1;
1388  ge.cargo.Truncate();
1389  }
1390 
1391  CrashAirplane(v);
1392 }
1393 
1400 {
1401  if (v->current_order.IsType(OT_GOTO_DEPOT)) return;
1402 
1405 
1406  /* Check if station was ever visited before */
1407  if (!(st->had_vehicle_of_type & HVOT_AIRCRAFT)) {
1408  st->had_vehicle_of_type |= HVOT_AIRCRAFT;
1409  SetDParam(0, st->index);
1410  /* show newsitem of celebrating citizens */
1412  STR_NEWS_FIRST_AIRCRAFT_ARRIVAL,
1414  v->index,
1415  st->index
1416  );
1417  AI::NewEvent(v->owner, new ScriptEventStationFirstVehicle(st->index, v->index));
1418  Game::NewEvent(new ScriptEventStationFirstVehicle(st->index, v->index));
1419  }
1420 
1421  v->BeginLoading();
1422 }
1423 
1429 {
1431 
1432  TileIndex vt = TileVirtXY(v->x_pos, v->y_pos);
1433 
1434  v->UpdateDeltaXY();
1435 
1436  AirportTileAnimationTrigger(st, vt, AAT_STATION_AIRPLANE_LAND);
1437 
1438  if (!PlayVehicleSound(v, VSE_TOUCHDOWN)) {
1439  SndPlayVehicleFx(SND_17_SKID_PLANE, v);
1440  }
1441 }
1442 
1443 
1446 {
1447  if (v->current_order.IsType(OT_GOTO_STATION) || v->current_order.IsType(OT_GOTO_DEPOT)) {
1449  }
1450 
1451  const Station *st = GetTargetAirportIfValid(v);
1452  const AirportFTAClass *apc = st == nullptr ? GetAirport(AT_DUMMY) : st->airport.GetFTA();
1453  Direction rotation = st == nullptr ? DIR_N : st->airport.rotation;
1454  v->pos = v->previous_pos = AircraftGetEntryPoint(v, apc, rotation);
1455 }
1456 
1466 {
1467  v->cur_speed = 0;
1468  v->subspeed = 0;
1469  v->progress = 0;
1470  v->direction = exit_dir;
1471  v->vehstatus &= ~VS_HIDDEN;
1472  {
1473  Vehicle *u = v->Next();
1474  u->vehstatus &= ~VS_HIDDEN;
1475 
1476  /* Rotor blades */
1477  u = u->Next();
1478  if (u != nullptr) {
1479  u->vehstatus &= ~VS_HIDDEN;
1480  u->cur_speed = 80;
1481  }
1482  }
1483 
1485  v->LeaveUnbunchingDepot();
1486  SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1489 }
1490 
1494 static void AircraftEventHandler_EnterTerminal(Aircraft *v, const AirportFTAClass *apc)
1495 {
1497  v->state = apc->layout[v->pos].heading;
1498 }
1499 
1506 {
1507  VehicleEnterDepot(v);
1508  v->state = apc->layout[v->pos].heading;
1509 }
1510 
1517 {
1518  /* if we just arrived, execute EnterHangar first */
1519  if (v->previous_pos != v->pos) {
1521  return;
1522  }
1523 
1524  /* if we were sent to the depot, stay there */
1525  if (v->current_order.IsType(OT_GOTO_DEPOT) && (v->vehstatus & VS_STOPPED)) {
1526  v->current_order.Free();
1527  return;
1528  }
1529 
1530  /* Check if we should wait here for unbunching. */
1531  if (v->IsWaitingForUnbunching()) return;
1532 
1533  if (!v->current_order.IsType(OT_GOTO_STATION) &&
1534  !v->current_order.IsType(OT_GOTO_DEPOT))
1535  return;
1536 
1537  /* We are leaving a hangar, but have to go to the exact same one; re-enter */
1538  if (v->current_order.IsType(OT_GOTO_DEPOT) && v->current_order.GetDestination() == v->targetairport) {
1539  VehicleEnterDepot(v);
1540  return;
1541  }
1542 
1543  /* if the block of the next position is busy, stay put */
1544  if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1545 
1546  /* We are already at the target airport, we need to find a terminal */
1547  if (v->current_order.GetDestination() == v->targetairport) {
1548  /* FindFreeTerminal:
1549  * 1. Find a free terminal, 2. Occupy it, 3. Set the vehicle's state to that terminal */
1550  if (v->subtype == AIR_HELICOPTER) {
1551  if (!AirportFindFreeHelipad(v, apc)) return; // helicopter
1552  } else {
1553  if (!AirportFindFreeTerminal(v, apc)) return; // airplane
1554  }
1555  } else { // Else prepare for launch.
1556  /* airplane goto state takeoff, helicopter to helitakeoff */
1557  v->state = (v->subtype == AIR_HELICOPTER) ? HELITAKEOFF : TAKEOFF;
1558  }
1559  const Station *st = Station::GetByTile(v->tile);
1561  AirportMove(v, apc);
1562 }
1563 
1566 {
1567  /* if we just arrived, execute EnterTerminal first */
1568  if (v->previous_pos != v->pos) {
1569  AircraftEventHandler_EnterTerminal(v, apc);
1570  /* on an airport with helipads, a helicopter will always land there
1571  * and get serviced at the same time - setting */
1573  if (v->subtype == AIR_HELICOPTER && apc->num_helipads > 0) {
1574  /* an excerpt of ServiceAircraft, without the invisibility stuff */
1578  v->reliability = v->GetEngine()->reliability;
1580  }
1581  }
1582  return;
1583  }
1584 
1585  if (v->current_order.IsType(OT_NOTHING)) return;
1586 
1587  /* if the block of the next position is busy, stay put */
1588  if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1589 
1590  /* airport-road is free. We either have to go to another airport, or to the hangar
1591  * ---> start moving */
1592 
1593  bool go_to_hangar = false;
1594  switch (v->current_order.GetType()) {
1595  case OT_GOTO_STATION: // ready to fly to another airport
1596  break;
1597  case OT_GOTO_DEPOT: // visit hangar for servicing, sale, etc.
1598  go_to_hangar = v->current_order.GetDestination() == v->targetairport;
1599  break;
1600  case OT_CONDITIONAL:
1601  /* In case of a conditional order we just have to wait a tick
1602  * longer, so the conditional order can actually be processed;
1603  * we should not clear the order as that makes us go nowhere. */
1604  return;
1605  default: // orders have been deleted (no orders), goto depot and don't bother us
1606  v->current_order.Free();
1607  go_to_hangar = true;
1608  }
1609 
1610  if (go_to_hangar && Station::Get(v->targetairport)->airport.HasHangar()) {
1611  v->state = HANGAR;
1612  } else {
1613  /* airplane goto state takeoff, helicopter to helitakeoff */
1614  v->state = (v->subtype == AIR_HELICOPTER) ? HELITAKEOFF : TAKEOFF;
1615  }
1616  AirportMove(v, apc);
1617 }
1618 
1619 static void AircraftEventHandler_General(Aircraft *, const AirportFTAClass *)
1620 {
1621  FatalError("OK, you shouldn't be here, check your Airport Scheme!");
1622 }
1623 
1624 static void AircraftEventHandler_TakeOff(Aircraft *v, const AirportFTAClass *)
1625 {
1626  PlayAircraftSound(v); // play takeoffsound for airplanes
1627  v->state = STARTTAKEOFF;
1628 }
1629 
1630 static void AircraftEventHandler_StartTakeOff(Aircraft *v, const AirportFTAClass *)
1631 {
1632  v->state = ENDTAKEOFF;
1633  v->UpdateDeltaXY();
1634 }
1635 
1636 static void AircraftEventHandler_EndTakeOff(Aircraft *v, const AirportFTAClass *)
1637 {
1638  v->state = FLYING;
1639  /* get the next position to go to, differs per airport */
1641 }
1642 
1643 static void AircraftEventHandler_HeliTakeOff(Aircraft *v, const AirportFTAClass *)
1644 {
1645  v->state = FLYING;
1646  v->UpdateDeltaXY();
1647 
1648  /* get the next position to go to, differs per airport */
1650 
1651  /* Send the helicopter to a hangar if needed for replacement */
1652  if (v->NeedsAutomaticServicing()) {
1653  Backup<CompanyID> cur_company(_current_company, v->owner, FILE_LINE);
1655  cur_company.Restore();
1656  }
1657 }
1658 
1659 static void AircraftEventHandler_Flying(Aircraft *v, const AirportFTAClass *apc)
1660 {
1662 
1663  /* Runway busy, not allowed to use this airstation or closed, circle. */
1664  if (CanVehicleUseStation(v, st) && (st->owner == OWNER_NONE || st->owner == v->owner) && !(st->airport.flags & AIRPORT_CLOSED_block)) {
1665  /* {32,FLYING,NOTHING_block,37}, {32,LANDING,N,33}, {32,HELILANDING,N,41},
1666  * if it is an airplane, look for LANDING, for helicopter HELILANDING
1667  * it is possible to choose from multiple landing runways, so loop until a free one is found */
1668  byte landingtype = (v->subtype == AIR_HELICOPTER) ? HELILANDING : LANDING;
1669  const AirportFTA *current = apc->layout[v->pos].next;
1670  while (current != nullptr) {
1671  if (current->heading == landingtype) {
1672  /* save speed before, since if AirportHasBlock is false, it resets them to 0
1673  * we don't want that for plane in air
1674  * hack for speed thingie */
1675  uint16_t tcur_speed = v->cur_speed;
1676  uint16_t tsubspeed = v->subspeed;
1677  if (!AirportHasBlock(v, current, apc)) {
1678  v->state = landingtype; // LANDING / HELILANDING
1680  /* it's a bit dirty, but I need to set position to next position, otherwise
1681  * if there are multiple runways, plane won't know which one it took (because
1682  * they all have heading LANDING). And also occupy that block! */
1683  v->pos = current->next_position;
1684  SETBITS(st->airport.flags, apc->layout[v->pos].block);
1685  return;
1686  }
1687  v->cur_speed = tcur_speed;
1688  v->subspeed = tsubspeed;
1689  }
1690  current = current->next;
1691  }
1692  }
1693  v->state = FLYING;
1694  v->pos = apc->layout[v->pos].next_position;
1695 }
1696 
1697 static void AircraftEventHandler_Landing(Aircraft *v, const AirportFTAClass *)
1698 {
1699  v->state = ENDLANDING;
1700  AircraftLandAirplane(v); // maybe crash airplane
1701 
1702  /* check if the aircraft needs to be replaced or renewed and send it to a hangar if needed */
1703  if (v->NeedsAutomaticServicing()) {
1704  Backup<CompanyID> cur_company(_current_company, v->owner, FILE_LINE);
1706  cur_company.Restore();
1707  }
1708 }
1709 
1710 static void AircraftEventHandler_HeliLanding(Aircraft *v, const AirportFTAClass *)
1711 {
1712  v->state = HELIENDLANDING;
1713  v->UpdateDeltaXY();
1714 }
1715 
1716 static void AircraftEventHandler_EndLanding(Aircraft *v, const AirportFTAClass *apc)
1717 {
1718  /* next block busy, don't do a thing, just wait */
1719  if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1720 
1721  /* if going to terminal (OT_GOTO_STATION) choose one
1722  * 1. in case all terminals are busy AirportFindFreeTerminal() returns false or
1723  * 2. not going for terminal (but depot, no order),
1724  * --> get out of the way to the hangar. */
1725  if (v->current_order.IsType(OT_GOTO_STATION)) {
1726  if (AirportFindFreeTerminal(v, apc)) return;
1727  }
1728  v->state = HANGAR;
1729 
1730 }
1731 
1732 static void AircraftEventHandler_HeliEndLanding(Aircraft *v, const AirportFTAClass *apc)
1733 {
1734  /* next block busy, don't do a thing, just wait */
1735  if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1736 
1737  /* if going to helipad (OT_GOTO_STATION) choose one. If airport doesn't have helipads, choose terminal
1738  * 1. in case all terminals/helipads are busy (AirportFindFreeHelipad() returns false) or
1739  * 2. not going for terminal (but depot, no order),
1740  * --> get out of the way to the hangar IF there are terminals on the airport.
1741  * --> else TAKEOFF
1742  * the reason behind this is that if an airport has a terminal, it also has a hangar. Airplanes
1743  * must go to a hangar. */
1744  if (v->current_order.IsType(OT_GOTO_STATION)) {
1745  if (AirportFindFreeHelipad(v, apc)) return;
1746  }
1748 }
1749 
1755 typedef void AircraftStateHandler(Aircraft *v, const AirportFTAClass *apc);
1758  AircraftEventHandler_General, // TO_ALL = 0
1759  AircraftEventHandler_InHangar, // HANGAR = 1
1760  AircraftEventHandler_AtTerminal, // TERM1 = 2
1761  AircraftEventHandler_AtTerminal, // TERM2 = 3
1762  AircraftEventHandler_AtTerminal, // TERM3 = 4
1763  AircraftEventHandler_AtTerminal, // TERM4 = 5
1764  AircraftEventHandler_AtTerminal, // TERM5 = 6
1765  AircraftEventHandler_AtTerminal, // TERM6 = 7
1766  AircraftEventHandler_AtTerminal, // HELIPAD1 = 8
1767  AircraftEventHandler_AtTerminal, // HELIPAD2 = 9
1768  AircraftEventHandler_TakeOff, // TAKEOFF = 10
1769  AircraftEventHandler_StartTakeOff, // STARTTAKEOFF = 11
1770  AircraftEventHandler_EndTakeOff, // ENDTAKEOFF = 12
1771  AircraftEventHandler_HeliTakeOff, // HELITAKEOFF = 13
1772  AircraftEventHandler_Flying, // FLYING = 14
1773  AircraftEventHandler_Landing, // LANDING = 15
1774  AircraftEventHandler_EndLanding, // ENDLANDING = 16
1775  AircraftEventHandler_HeliLanding, // HELILANDING = 17
1776  AircraftEventHandler_HeliEndLanding, // HELIENDLANDING = 18
1777  AircraftEventHandler_AtTerminal, // TERM7 = 19
1778  AircraftEventHandler_AtTerminal, // TERM8 = 20
1779  AircraftEventHandler_AtTerminal, // HELIPAD3 = 21
1780 };
1781 
1782 static void AirportClearBlock(const Aircraft *v, const AirportFTAClass *apc)
1783 {
1784  /* we have left the previous block, and entered the new one. Free the previous block */
1785  if (apc->layout[v->previous_pos].block != apc->layout[v->pos].block) {
1787 
1788  CLRBITS(st->airport.flags, apc->layout[v->previous_pos].block);
1789  }
1790 }
1791 
1792 static void AirportGoToNextPosition(Aircraft *v)
1793 {
1794  /* if aircraft is not in position, wait until it is */
1795  if (!AircraftController(v)) return;
1796 
1798 
1799  AirportClearBlock(v, apc);
1800  AirportMove(v, apc); // move aircraft to next position
1801 }
1802 
1803 /* gets pos from vehicle and next orders */
1804 static bool AirportMove(Aircraft *v, const AirportFTAClass *apc)
1805 {
1806  /* error handling */
1807  if (v->pos >= apc->nofelements) {
1808  Debug(misc, 0, "[Ap] position {} is not valid for current airport. Max position is {}", v->pos, apc->nofelements-1);
1809  assert(v->pos < apc->nofelements);
1810  }
1811 
1812  const AirportFTA *current = &apc->layout[v->pos];
1813  /* we have arrived in an important state (eg terminal, hangar, etc.) */
1814  if (current->heading == v->state) {
1815  byte prev_pos = v->pos; // location could be changed in state, so save it before-hand
1816  byte prev_state = v->state;
1817  _aircraft_state_handlers[v->state](v, apc);
1818  if (v->state != FLYING) v->previous_pos = prev_pos;
1819  if (v->state != prev_state || v->pos != prev_pos) UpdateAircraftCache(v);
1820  return true;
1821  }
1822 
1823  v->previous_pos = v->pos; // save previous location
1824 
1825  /* there is only one choice to move to */
1826  if (current->next == nullptr) {
1827  if (AirportSetBlocks(v, current, apc)) {
1828  v->pos = current->next_position;
1830  } // move to next position
1831  return false;
1832  }
1833 
1834  /* there are more choices to choose from, choose the one that
1835  * matches our heading */
1836  do {
1837  if (v->state == current->heading || current->heading == TO_ALL) {
1838  if (AirportSetBlocks(v, current, apc)) {
1839  v->pos = current->next_position;
1841  } // move to next position
1842  return false;
1843  }
1844  current = current->next;
1845  } while (current != nullptr);
1846 
1847  Debug(misc, 0, "[Ap] cannot move further on Airport! (pos {} state {}) for vehicle {}", v->pos, v->state, v->index);
1848  NOT_REACHED();
1849 }
1850 
1852 static bool AirportHasBlock(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc)
1853 {
1854  const AirportFTA *reference = &apc->layout[v->pos];
1855  const AirportFTA *next = &apc->layout[current_pos->next_position];
1856 
1857  /* same block, then of course we can move */
1858  if (apc->layout[current_pos->position].block != next->block) {
1859  const Station *st = Station::Get(v->targetairport);
1860  uint64_t airport_flags = next->block;
1861 
1862  /* check additional possible extra blocks */
1863  if (current_pos != reference && current_pos->block != NOTHING_block) {
1864  airport_flags |= current_pos->block;
1865  }
1866 
1867  if (st->airport.flags & airport_flags) {
1868  v->cur_speed = 0;
1869  v->subspeed = 0;
1870  return true;
1871  }
1872  }
1873  return false;
1874 }
1875 
1883 static bool AirportSetBlocks(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc)
1884 {
1885  const AirportFTA *next = &apc->layout[current_pos->next_position];
1886  const AirportFTA *reference = &apc->layout[v->pos];
1887 
1888  /* if the next position is in another block, check it and wait until it is free */
1889  if ((apc->layout[current_pos->position].block & next->block) != next->block) {
1890  uint64_t airport_flags = next->block;
1891  /* search for all all elements in the list with the same state, and blocks != N
1892  * this means more blocks should be checked/set */
1893  const AirportFTA *current = current_pos;
1894  if (current == reference) current = current->next;
1895  while (current != nullptr) {
1896  if (current->heading == current_pos->heading && current->block != 0) {
1897  airport_flags |= current->block;
1898  break;
1899  }
1900  current = current->next;
1901  }
1902 
1903  /* if the block to be checked is in the next position, then exclude that from
1904  * checking, because it has been set by the airplane before */
1905  if (current_pos->block == next->block) airport_flags ^= next->block;
1906 
1908  if (st->airport.flags & airport_flags) {
1909  v->cur_speed = 0;
1910  v->subspeed = 0;
1911  return false;
1912  }
1913 
1914  if (next->block != NOTHING_block) {
1915  SETBITS(st->airport.flags, airport_flags); // occupy next block
1916  }
1917  }
1918  return true;
1919 }
1920 
1927  uint64_t airport_flag;
1928 };
1929 
1932  {TERM1, TERM1_block},
1933  {TERM2, TERM2_block},
1934  {TERM3, TERM3_block},
1935  {TERM4, TERM4_block},
1936  {TERM5, TERM5_block},
1937  {TERM6, TERM6_block},
1938  {TERM7, TERM7_block},
1939  {TERM8, TERM8_block},
1943 };
1944 
1952 static bool FreeTerminal(Aircraft *v, byte i, byte last_terminal)
1953 {
1954  assert(last_terminal <= lengthof(_airport_terminal_mapping));
1956  for (; i < last_terminal; i++) {
1957  if ((st->airport.flags & _airport_terminal_mapping[i].airport_flag) == 0) {
1958  /* TERMINAL# HELIPAD# */
1959  v->state = _airport_terminal_mapping[i].state; // start moving to that terminal/helipad
1960  SETBITS(st->airport.flags, _airport_terminal_mapping[i].airport_flag); // occupy terminal/helipad
1961  return true;
1962  }
1963  }
1964  return false;
1965 }
1966 
1972 static uint GetNumTerminals(const AirportFTAClass *apc)
1973 {
1974  uint num = 0;
1975 
1976  for (uint i = apc->terminals[0]; i > 0; i--) num += apc->terminals[i];
1977 
1978  return num;
1979 }
1980 
1988 {
1989  /* example of more terminalgroups
1990  * {0,HANGAR,NOTHING_block,1}, {0,TERMGROUP,TERM_GROUP1_block,0}, {0,TERMGROUP,TERM_GROUP2_ENTER_block,1}, {0,0,N,1},
1991  * Heading TERMGROUP denotes a group. We see 2 groups here:
1992  * 1. group 0 -- TERM_GROUP1_block (check block)
1993  * 2. group 1 -- TERM_GROUP2_ENTER_block (check block)
1994  * First in line is checked first, group 0. If the block (TERM_GROUP1_block) is free, it
1995  * looks at the corresponding terminals of that group. If no free ones are found, other
1996  * possible groups are checked (in this case group 1, since that is after group 0). If that
1997  * fails, then attempt fails and plane waits
1998  */
1999  if (apc->terminals[0] > 1) {
2000  const Station *st = Station::Get(v->targetairport);
2001  const AirportFTA *temp = apc->layout[v->pos].next;
2002 
2003  while (temp != nullptr) {
2004  if (temp->heading == TERMGROUP) {
2005  if (!(st->airport.flags & temp->block)) {
2006  /* read which group do we want to go to?
2007  * (the first free group) */
2008  uint target_group = temp->next_position + 1;
2009 
2010  /* at what terminal does the group start?
2011  * that means, sum up all terminals of
2012  * groups with lower number */
2013  uint group_start = 0;
2014  for (uint i = 1; i < target_group; i++) {
2015  group_start += apc->terminals[i];
2016  }
2017 
2018  uint group_end = group_start + apc->terminals[target_group];
2019  if (FreeTerminal(v, group_start, group_end)) return true;
2020  }
2021  } else {
2022  /* once the heading isn't 255, we've exhausted the possible blocks.
2023  * So we cannot move */
2024  return false;
2025  }
2026  temp = temp->next;
2027  }
2028  }
2029 
2030  /* if there is only 1 terminalgroup, all terminals are checked (starting from 0 to max) */
2031  return FreeTerminal(v, 0, GetNumTerminals(apc));
2032 }
2033 
2041 {
2042  /* if an airport doesn't have helipads, use terminals */
2043  if (apc->num_helipads == 0) return AirportFindFreeTerminal(v, apc);
2044 
2045  /* only 1 helicoptergroup, check all helipads
2046  * The blocks for helipads start after the last terminal (MAX_TERMINALS) */
2048 }
2049 
2055 static void AircraftHandleDestTooFar(Aircraft *v, bool too_far)
2056 {
2057  if (too_far) {
2058  if (!HasBit(v->flags, VAF_DEST_TOO_FAR)) {
2061  AI::NewEvent(v->owner, new ScriptEventAircraftDestTooFar(v->index));
2062  if (v->owner == _local_company) {
2063  /* Post a news message. */
2064  SetDParam(0, v->index);
2065  AddVehicleAdviceNewsItem(STR_NEWS_AIRCRAFT_DEST_TOO_FAR, v->index);
2066  }
2067  }
2068  return;
2069  }
2070 
2071  if (HasBit(v->flags, VAF_DEST_TOO_FAR)) {
2072  /* Not too far anymore, clear flag and message. */
2075  DeleteVehicleNews(v->index, STR_NEWS_AIRCRAFT_DEST_TOO_FAR);
2076  }
2077 }
2078 
2079 static bool AircraftEventHandler(Aircraft *v, int loop)
2080 {
2081  if (v->vehstatus & VS_CRASHED) {
2082  return HandleCrashedAircraft(v);
2083  }
2084 
2085  if (v->vehstatus & VS_STOPPED) return true;
2086 
2087  v->HandleBreakdown();
2088 
2089  HandleAircraftSmoke(v, loop != 0);
2090  ProcessOrders(v);
2091  v->HandleLoading(loop != 0);
2092 
2093  if (v->current_order.IsType(OT_LOADING) || v->current_order.IsType(OT_LEAVESTATION)) return true;
2094 
2095  if (v->state >= ENDTAKEOFF && v->state <= HELIENDLANDING) {
2096  /* If we are flying, unconditionally clear the 'dest too far' state. */
2097  AircraftHandleDestTooFar(v, false);
2098  } else if (v->acache.cached_max_range_sqr != 0) {
2099  /* Check the distance to the next destination. This code works because the target
2100  * airport is only updated after take off and not on the ground. */
2102  Station *next_st = v->current_order.IsType(OT_GOTO_STATION) || v->current_order.IsType(OT_GOTO_DEPOT) ? Station::GetIfValid(v->current_order.GetDestination()) : nullptr;
2103 
2104  if (cur_st != nullptr && cur_st->airport.tile != INVALID_TILE && next_st != nullptr && next_st->airport.tile != INVALID_TILE) {
2105  uint dist = DistanceSquare(cur_st->airport.tile, next_st->airport.tile);
2106  AircraftHandleDestTooFar(v, dist > v->acache.cached_max_range_sqr);
2107  }
2108  }
2109 
2110  if (!HasBit(v->flags, VAF_DEST_TOO_FAR)) AirportGoToNextPosition(v);
2111 
2112  return true;
2113 }
2114 
2116 {
2117  if (!this->IsNormalAircraft()) return true;
2118 
2120 
2121  this->tick_counter++;
2122 
2123  if (!(this->vehstatus & VS_STOPPED)) this->running_ticks++;
2124 
2125  if (this->subtype == AIR_HELICOPTER) HelicopterTickHandler(this);
2126 
2127  this->current_order_time++;
2128 
2129  for (uint i = 0; i != 2; i++) {
2130  /* stop if the aircraft was deleted */
2131  if (!AircraftEventHandler(this, i)) return false;
2132  }
2133 
2134  return true;
2135 }
2136 
2137 
2145 {
2146  assert(v->type == VEH_AIRCRAFT);
2147 
2149  if (st == nullptr) return nullptr;
2150 
2151  return st->airport.tile == INVALID_TILE ? nullptr : st;
2152 }
2153 
2159 {
2160  /* only 1 station is updated per function call, so it is enough to get entry_point once */
2161  const AirportFTAClass *ap = st->airport.GetFTA();
2162  Direction rotation = st->airport.tile == INVALID_TILE ? DIR_N : st->airport.rotation;
2163 
2164  for (Aircraft *v : Aircraft::Iterate()) {
2165  if (!v->IsNormalAircraft() || v->targetairport != st->index) continue;
2166  assert(v->state == FLYING);
2167 
2168  Order *o = &v->current_order;
2169  /* The aircraft is heading to a hangar, but the new station doesn't have one,
2170  * or the aircraft can't land on the new station. Cancel current order. */
2171  if (o->IsType(OT_GOTO_DEPOT) && !(o->GetDepotOrderType() & ODTFB_PART_OF_ORDERS) && o->GetDestination() == st->index &&
2172  (!st->airport.HasHangar() || !CanVehicleUseStation(v, st))) {
2173  o->MakeDummy();
2175  }
2176  v->pos = v->previous_pos = AircraftGetEntryPoint(v, ap, rotation);
2178  }
2179 
2180  /* Heliports don't have a hangar. Invalidate all go to hangar orders from all aircraft. */
2181  if (!st->airport.HasHangar()) RemoveOrderFromAllVehicles(OT_GOTO_DEPOT, st->index, true);
2182 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
VSE_START
@ VSE_START
Vehicle starting, i.e. leaving, the station.
Definition: newgrf_sound.h:19
game.hpp
CrashAirplane
static void CrashAirplane(Aircraft *v)
Bring the aircraft in a crashed state, create the explosion animation, and create a news item about t...
Definition: aircraft_cmd.cpp:1331
TileY
static debug_inline uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:437
Vehicle::IsChainInDepot
virtual bool IsChainInDepot() const
Check whether the whole vehicle chain is in the depot.
Definition: vehicle_base.h:549
Aircraft::targetairport
StationID targetairport
Airport to go to next.
Definition: aircraft.h:78
AircraftEventHandler_EnterHangar
static void AircraftEventHandler_EnterHangar(Aircraft *v, const AirportFTAClass *apc)
Aircraft arrived in an airport hangar.
Definition: aircraft_cmd.cpp:1505
DIAGDIR_SE
@ DIAGDIR_SE
Southeast.
Definition: direction_type.h:76
AirportFTA::heading
byte heading
heading (current orders), guiding an airplane to its target on an airport
Definition: airport.h:195
HELILANDING
@ HELILANDING
Helicopter wants to land.
Definition: airport.h:78
AircraftHandleDestTooFar
static void AircraftHandleDestTooFar(Aircraft *v, bool too_far)
Handle the 'dest too far' flag and the corresponding news message for aircraft.
Definition: aircraft_cmd.cpp:2055
Cheats::no_jetcrash
Cheat no_jetcrash
no jet will crash on small airports anymore
Definition: cheat_type.h:31
UpdateAircraftSpeed
static int UpdateAircraftSpeed(Aircraft *v, uint speed_limit=SPEED_LIMIT_NONE, bool hard_limit=true)
Sets the new speed for an aircraft.
Definition: aircraft_cmd.cpp:647
AIRPORT_CLOSED_block
static const uint64_t AIRPORT_CLOSED_block
Dummy block for indicating a closed airport.
Definition: airport.h:128
InvalidateWindowData
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:3200
Order::MakeDummy
void MakeDummy()
Makes this order a Dummy order.
Definition: order_cmd.cpp:133
sound_func.h
Airport::GetHangarExitDirection
Direction GetHangarExitDirection(TileIndex tile) const
Get the exit direction of the hangar at a specific tile.
Definition: station_base.h:375
Airport::flags
uint64_t flags
stores which blocks on the airport are taken. was 16 bit earlier on, then 32
Definition: station_base.h:293
Station::goods
GoodsEntry goods[NUM_CARGO]
Goods at this station.
Definition: station_base.h:471
DIRDIFF_REVERSE
@ DIRDIFF_REVERSE
One direction is the opposite of the other one.
Definition: direction_type.h:62
VehicleCache::cached_cargo_age_period
uint16_t cached_cargo_age_period
Number of ticks before carried cargo is aged.
Definition: vehicle_base.h:125
GoodsEntry::rating
uint8_t rating
Station rating for this cargo.
Definition: station_base.h:226
SetBit
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
Definition: bitmath_func.hpp:121
Order::IsType
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition: order_base.h:71
Rect::Height
int Height() const
Get height of Rect.
Definition: geometry_type.hpp:91
Pool::PoolItem<&_engine_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:335
SND_18_TAKEOFF_HELICOPTER
@ SND_18_TAKEOFF_HELICOPTER
22 == 0x16 Takeoff: helicopter
Definition: sound_type.h:61
AircraftVehicleInfo::max_range
uint16_t max_range
Maximum range of this aircraft.
Definition: engine_type.h:110
Direction
Direction
Defines the 8 directions on the map.
Definition: direction_type.h:24
ENDTAKEOFF
@ ENDTAKEOFF
Airplane has reached end-point of the take-off runway.
Definition: airport.h:73
Airport::GetHangarNum
uint GetHangarNum(TileIndex tile) const
Get the hangar number of the hangar at a specific tile.
Definition: station_base.h:388
AircraftVehicleInfo::max_speed
uint16_t max_speed
Maximum speed (1 unit = 8 mph = 12.8 km-ish/h)
Definition: engine_type.h:107
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3082
MutableSpriteCache::sprite_seq
VehicleSpriteSeq sprite_seq
Vehicle appearance.
Definition: vehicle_base.h:196
VehicleSpriteSeq::CopyWithoutPalette
void CopyWithoutPalette(const VehicleSpriteSeq &src)
Copy data from another sprite sequence, while dropping all recolouring information.
Definition: vehicle_base.h:174
AirportMovingData
A single location on an airport where aircraft can move to.
Definition: airport.h:131
GetPrice
Money GetPrice(Price index, uint cost_factor, const GRFFile *grf_file, int shift)
Determine a certain price.
Definition: economy.cpp:970
Vehicle::reliability_spd_dec
uint16_t reliability_spd_dec
Reliability decrease speed.
Definition: vehicle_base.h:293
NT_ARRIVAL_OTHER
@ NT_ARRIVAL_OTHER
First vehicle arrived for competitor.
Definition: news_type.h:25
DIRDIFF_45LEFT
@ DIRDIFF_45LEFT
Angle of 45 degrees left.
Definition: direction_type.h:64
AircraftVehicleInfo::subtype
byte subtype
Type of aircraft.
Definition: engine_type.h:104
command_func.h
DIR_SE
@ DIR_SE
Southeast.
Definition: direction_type.h:29
GetAircraftHoldMaxAltitude
int GetAircraftHoldMaxAltitude(const Aircraft *v)
Gets the maximum 'flight level' for the holding pattern of the aircraft, in pixels 'z_pos' 0,...
Definition: aircraft_cmd.cpp:764
RotateAirportMovingData
AirportMovingData RotateAirportMovingData(const AirportMovingData *orig, Direction rotation, uint num_tiles_x, uint num_tiles_y)
Rotate the airport moving data to another rotation.
Definition: airport.cpp:80
ODTFB_SERVICE
@ ODTFB_SERVICE
This depot order is because of the servicing limit.
Definition: order_type.h:95
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:28
GetTileHeightBelowAircraft
int GetTileHeightBelowAircraft(const Vehicle *v)
Get the tile height below the aircraft.
Definition: aircraft_cmd.cpp:712
Vehicle::cargo_cap
uint16_t cargo_cap
total capacity
Definition: vehicle_base.h:338
_airport_terminal_mapping
static const MovementTerminalMapping _airport_terminal_mapping[]
A list of all valid terminals and their associated blocks.
Definition: aircraft_cmd.cpp:1931
CheckOrders
void CheckOrders(const Vehicle *v)
Check the orders of a vehicle, to see if there are invalid orders and stuff.
Definition: order_cmd.cpp:1711
Backup
Class to backup a specific variable and restore it later.
Definition: backup_type.hpp:21
Map::MaxX
static debug_inline uint MaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition: map_func.h:297
AMED_LAND
@ AMED_LAND
Landing onto landing strip.
Definition: airport.h:51
company_base.h
Engine::reliability_spd_dec
uint16_t reliability_spd_dec
Speed of reliability decay between services (per day).
Definition: engine_base.h:42
Vehicle::Next
Vehicle * Next() const
Get the next vehicle of this vehicle.
Definition: vehicle_base.h:627
HELIENDLANDING
@ HELIENDLANDING
Helicopter wants to finish landing.
Definition: airport.h:79
SpecializedVehicle::Next
T * Next() const
Get next vehicle in the chain.
Definition: vehicle_base.h:1116
timer_game_calendar.h
DIRDIFF_SAME
@ DIRDIFF_SAME
Both directions faces to the same direction.
Definition: direction_type.h:59
Vehicle::y_extent
byte y_extent
y-extent of vehicle bounding box
Definition: vehicle_base.h:312
Station
Station data structure.
Definition: station_base.h:442
Order::GetDestination
DestinationID GetDestination() const
Gets the destination of this order.
Definition: order_base.h:104
Vehicle::NeedsAutomaticServicing
bool NeedsAutomaticServicing() const
Checks if the current order should be interrupted for a service-in-depot order.
Definition: vehicle.cpp:272
Engine::GetLifeLengthInDays
TimerGameCalendar::Date GetLifeLengthInDays() const
Returns the vehicle's (not model's!) life length in days.
Definition: engine.cpp:443
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
VehicleSpriteSeq::Set
void Set(SpriteID sprite)
Assign a single sprite to the sequence.
Definition: vehicle_base.h:164
PLANE_HOLD_MAX_FLYING_ALTITUDE
@ PLANE_HOLD_MAX_FLYING_ALTITUDE
holding flying altitude above tile of planes.
Definition: aircraft.h:23
AircraftCache::cached_max_range
uint16_t cached_max_range
Cached maximum range.
Definition: aircraft.h:68
VSE_TOUCHDOWN
@ VSE_TOUCHDOWN
Whenever a plane touches down.
Definition: newgrf_sound.h:23
HandleAircraftSmoke
static void HandleAircraftSmoke(Aircraft *v, bool mode)
Handle smoke of broken aircraft.
Definition: aircraft_cmd.cpp:1232
HELIPAD1_block
static const uint64_t HELIPAD1_block
Block belonging to helipad 1.
Definition: airport.h:95
Vehicle::vehstatus
byte vehstatus
Status.
Definition: vehicle_base.h:348
BaseConsist::name
std::string name
Name of vehicle.
Definition: base_consist.h:18
GB
constexpr static debug_inline uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
VS_DEFPAL
@ VS_DEFPAL
Use default vehicle palette.
Definition: vehicle_base.h:36
Pool::PoolItem::index
Tindex index
Index of this pool item.
Definition: pool_type.hpp:234
Vehicle::SetNext
void SetNext(Vehicle *next)
Set the next vehicle of this vehicle.
Definition: vehicle.cpp:2862
AddVehicleAdviceNewsItem
void AddVehicleAdviceNewsItem(StringID string, VehicleID vehicle)
Adds a vehicle-advice news item.
Definition: news_func.h:40
Vehicle::Crash
virtual uint Crash(bool flooded=false)
Crash the (whole) vehicle chain.
Definition: vehicle.cpp:280
AirportFTAClass::SHORT_STRIP
@ SHORT_STRIP
This airport has a short landing strip, dangerous for fast aircraft.
Definition: airport.h:150
Vehicle::acceleration
byte acceleration
used by train & aircraft
Definition: vehicle_base.h:325
AMED_TAKEOFF
@ AMED_TAKEOFF
Takeoff movement.
Definition: airport.h:49
PROP_AIRCRAFT_RUNNING_COST_FACTOR
@ PROP_AIRCRAFT_RUNNING_COST_FACTOR
Yearly runningcost.
Definition: newgrf_properties.h:51
Order::Free
void Free()
'Free' the order
Definition: order_cmd.cpp:63
DeleteVehicleNews
void DeleteVehicleNews(VehicleID vid, StringID news)
Delete a news item type about a vehicle.
Definition: news_gui.cpp:919
INVALID_TILE
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:95
TERM1
@ TERM1
Heading for terminal 1.
Definition: airport.h:63
AircraftStateHandler
void AircraftStateHandler(Aircraft *v, const AirportFTAClass *apc)
Signature of the aircraft handler function.
Definition: aircraft_cmd.cpp:1755
VehicleSettings::plane_crashes
uint8_t plane_crashes
number of plane crashes, 0 = none, 1 = reduced, 2 = normal
Definition: settings_type.h:534
SND_12_EXPLOSION
@ SND_12_EXPLOSION
16 == 0x10 Destruction, crashes, disasters, ...
Definition: sound_type.h:55
BaseConsist::vehicle_flags
uint16_t vehicle_flags
Used for gradual loading and other miscellaneous things (.
Definition: base_consist.h:34
VAF_IN_MAX_HEIGHT_CORRECTION
@ VAF_IN_MAX_HEIGHT_CORRECTION
The vehicle is currently lowering its altitude because it hit the upper bound.
Definition: aircraft.h:44
AirportFTAClass::num_helipads
const byte num_helipads
Number of helipads on this airport. When 0 helicopters will go to normal terminals.
Definition: airport.h:179
EXPENSES_AIRCRAFT_RUN
@ EXPENSES_AIRCRAFT_RUN
Running costs aircraft.
Definition: economy_type.h:177
Aircraft::number_consecutive_turns
byte number_consecutive_turns
Protection to prevent the aircraft of making a lot of turns in order to reach a specific point.
Definition: aircraft.h:81
ENDLANDING
@ ENDLANDING
Airplane wants to finish landing.
Definition: airport.h:77
zoom_func.h
HandleAircraftEnterHangar
void HandleAircraftEnterHangar(Aircraft *v)
Handle Aircraft specific tasks when an Aircraft enters a hangar.
Definition: aircraft_cmd.cpp:572
WID_VV_START_STOP
@ WID_VV_START_STOP
Start or stop this vehicle, and show information about the current state.
Definition: vehicle_widget.h:17
aircraft.h
TILE_SIZE
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:15
MovementTerminalMapping::airport_flag
uint64_t airport_flag
Bitmask in the airport flags that need to be free for this terminal.
Definition: aircraft_cmd.cpp:1927
Vehicle::running_ticks
byte running_ticks
Number of ticks this vehicle was not stopped this day.
Definition: vehicle_base.h:346
CeilDiv
constexpr uint CeilDiv(uint a, uint b)
Computes ceil(a / b) for non-negative a and b.
Definition: math_func.hpp:320
SpecializedStation< Station, false >::Get
static Station * Get(size_t index)
Gets station with given index.
Definition: base_station_base.h:259
Aircraft::FindClosestDepot
ClosestDepot FindClosestDepot() override
Find the closest depot for this vehicle and tell us the location, DestinationID and whether we should...
Definition: aircraft_cmd.cpp:399
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:54
VehicleEnterDepot
void VehicleEnterDepot(Vehicle *v)
Vehicle entirely entered the depot, update its status, orders, vehicle windows, service it,...
Definition: vehicle.cpp:1534
BaseConsist::current_order_time
TimerGameTick::Ticks current_order_time
How many ticks have passed since this order started.
Definition: base_consist.h:21
GetAircraftSpriteSize
void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
Get the size of the sprite of an aircraft sprite heading west (used for lists).
Definition: aircraft_cmd.cpp:249
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > >
DepotCommand::LocateHangar
@ LocateHangar
Find another airport if the target one lacks a hangar.
DIAGDIR_NW
@ DIAGDIR_NW
Northwest.
Definition: direction_type.h:78
DIR_W
@ DIR_W
West.
Definition: direction_type.h:32
EV_EXPLOSION_SMALL
@ EV_EXPLOSION_SMALL
Various explosions.
Definition: effectvehicle_func.h:24
ChangeDir
Direction ChangeDir(Direction d, DirDiff delta)
Change a direction by a given difference.
Definition: direction_func.h:104
EngineImageType
EngineImageType
Visualisation contexts of vehicles and engines.
Definition: vehicle_type.h:85
GetTargetAirportIfValid
Station * GetTargetAirportIfValid(const Aircraft *v)
Returns aircraft's target station if v->target_airport is a valid station with airport.
Definition: aircraft_cmd.cpp:2144
Engine
Definition: engine_base.h:37
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:240
Engine::GetDefaultCargoType
CargoID GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition: engine_base.h:96
VehicleSpriteSeq::Draw
void Draw(int x, int y, PaletteID default_pal, bool force_pal) const
Draw the sprite sequence.
Definition: vehicle.cpp:131
Vehicle::owner
Owner owner
Which company owns the vehicle?
Definition: vehicle_base.h:304
EV_EXPLOSION_LARGE
@ EV_EXPLOSION_LARGE
Various explosions.
Definition: effectvehicle_func.h:22
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:371
GetSlopePixelZ
int GetSlopePixelZ(int x, int y, bool ground_vehicle)
Return world Z coordinate of a given point of a tile.
Definition: landscape.cpp:299
PaletteID
uint32_t PaletteID
The number of the palette.
Definition: gfx_type.h:18
aircraft_cmd.h
BaseStation::owner
Owner owner
The owner of this station.
Definition: base_station_base.h:74
DIR_N
@ DIR_N
North.
Definition: direction_type.h:26
AIR_AIRCRAFT
@ AIR_AIRCRAFT
an airplane
Definition: aircraft.h:32
VS_AIRCRAFT_BROKEN
@ VS_AIRCRAFT_BROKEN
Aircraft is broken down.
Definition: vehicle_base.h:39
HANGAR
@ HANGAR
Heading for hangar.
Definition: airport.h:62
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:369
VehicleServiceInDepot
void VehicleServiceInDepot(Vehicle *v)
Service a vehicle and all subsequent vehicles in the consist.
Definition: vehicle.cpp:167
SPEED_LIMIT_APPROACH
@ SPEED_LIMIT_APPROACH
Maximum speed of an aircraft on finals.
Definition: aircraft_cmd.cpp:634
OrthogonalTileArea::h
uint16_t h
The height of the area.
Definition: tilearea_type.h:21
Vehicle::breakdowns_since_last_service
byte breakdowns_since_last_service
Counter for the amount of breakdowns.
Definition: vehicle_base.h:296
AIR_SHADOW
@ AIR_SHADOW
shadow of the aircraft
Definition: aircraft.h:33
SETBITS
#define SETBITS(x, y)
Sets several bits in a variable.
Definition: bitmath_func.hpp:136
GetAirport
const AirportFTAClass * GetAirport(const byte airport_type)
Get the finite state machine of an airport type.
Definition: airport.cpp:207
Debug
#define Debug(category, level, format_string,...)
Ouptut a line of debugging information.
Definition: debug.h:37
TERM7
@ TERM7
Heading for terminal 7.
Definition: airport.h:80
Vehicle::x_pos
int32_t x_pos
x coordinate.
Definition: vehicle_base.h:299
AirportMovingData::x
int16_t x
x-coordinate of the destination.
Definition: airport.h:132
AirportMovingData::direction
Direction direction
Direction to turn the aircraft after reaching the destination.
Definition: airport.h:135
TERM3
@ TERM3
Heading for terminal 3.
Definition: airport.h:65
effectvehicle_func.h
SpecializedStation< Station, false >::Iterate
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
Definition: base_station_base.h:310
AMED_EXACTPOS
@ AMED_EXACTPOS
Go exactly to the destination coordinates.
Definition: airport.h:52
Airport::GetFTA
const AirportFTAClass * GetFTA() const
Get the finite-state machine for this airport or the finite-state machine for the dummy airport in ca...
Definition: station_base.h:317
AircraftEventHandler_InHangar
static void AircraftEventHandler_InHangar(Aircraft *v, const AirportFTAClass *apc)
Handle aircraft movement/decision making in an airport hangar.
Definition: aircraft_cmd.cpp:1516
ai.hpp
Order::GetType
OrderType GetType() const
Get the type of order of this order.
Definition: order_base.h:77
Aircraft::GetRunningCost
Money GetRunningCost() const override
Gets the running cost of a vehicle.
Definition: aircraft_cmd.cpp:441
DepotCommand::Service
@ Service
The vehicle will leave the depot right after arrival (service only)
Aircraft
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition: aircraft.h:74
Engine::GetGRF
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
Definition: engine_base.h:167
GoodsEntry::cargo
StationCargoList cargo
The cargo packets of cargo waiting in this station.
Definition: station_base.h:210
Vehicle::date_of_last_service
TimerGameEconomy::Date date_of_last_service
Last economy date the vehicle had a service at a depot.
Definition: vehicle_base.h:290
NT_ARRIVAL_COMPANY
@ NT_ARRIVAL_COMPANY
First vehicle arrived for company.
Definition: news_type.h:24
ENGINE_EXCLUSIVE_PREVIEW
@ ENGINE_EXCLUSIVE_PREVIEW
This vehicle is in the exclusive preview stage, either being used or being offered to a company.
Definition: engine_type.h:184
VehicleCache::cached_max_speed
uint16_t cached_max_speed
Maximum speed of the consist (minimum of the max speed of all vehicles in the consist).
Definition: vehicle_base.h:124
Engine::DetermineCapacity
uint DetermineCapacity(const Vehicle *v, uint16_t *mail_capacity=nullptr) const
Determines capacity of a given vehicle from scratch.
Definition: engine.cpp:201
newgrf_airporttiles.h
GameSettings::order
OrderSettings order
settings related to orders
Definition: settings_type.h:626
Airport::HasHangar
bool HasHangar() const
Check if this airport has at least one hangar.
Definition: station_base.h:323
Aircraft::crashed_counter
uint16_t crashed_counter
Timer for handling crash animations.
Definition: aircraft.h:75
Vehicle::BeginLoading
void BeginLoading()
Prepare everything to begin the loading when arriving at a station.
Definition: vehicle.cpp:2174
AirportMovingData::y
int16_t y
y-coordinate of the destination.
Definition: airport.h:133
DIAGDIR_SW
@ DIAGDIR_SW
Southwest.
Definition: direction_type.h:77
Airport::rotation
Direction rotation
How this airport is rotated.
Definition: station_base.h:296
Vehicle::breakdown_ctr
byte breakdown_ctr
Counter for managing breakdown events.
Definition: vehicle_base.h:294
VS_HIDDEN
@ VS_HIDDEN
Vehicle is not visible.
Definition: vehicle_base.h:33
SND_17_SKID_PLANE
@ SND_17_SKID_PLANE
21 == 0x15 Plane landing / touching ground
Definition: sound_type.h:60
DirDifference
DirDiff DirDifference(Direction d0, Direction d1)
Calculate the difference between two directions.
Definition: direction_func.h:68
AAT_STATION_AIRPLANE_LAND
@ AAT_STATION_AIRPLANE_LAND
Triggered when an airplane (not a helicopter) touches down at the airport (for single tile).
Definition: newgrf_animation_type.h:52
error_func.h
VehicleSpriteSeq::IsValid
bool IsValid() const
Check whether the sequence contains any sprites.
Definition: vehicle_base.h:148
AirportSetBlocks
static bool AirportSetBlocks(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc)
"reserve" a block for the plane
Definition: aircraft_cmd.cpp:1883
AIRCRAFT_MAX_FLYING_ALTITUDE
@ AIRCRAFT_MAX_FLYING_ALTITUDE
Maximum flying altitude above tile.
Definition: aircraft.h:22
AI::NewEvent
static void NewEvent(CompanyID company, ScriptEvent *event)
Queue a new event for an AI.
Definition: ai_core.cpp:235
CommandCost
Common return value for all commands.
Definition: command_type.h:23
VAF_HELI_DIRECT_DESCENT
@ VAF_HELI_DIRECT_DESCENT
The helicopter is descending directly at its destination (helipad or in front of hangar)
Definition: aircraft.h:47
PROP_AIRCRAFT_CARGO_AGE_PERIOD
@ PROP_AIRCRAFT_CARGO_AGE_PERIOD
Number of ticks before carried cargo is aged.
Definition: newgrf_properties.h:54
VehicleCargoList::Truncate
uint Truncate(uint max_move=UINT_MAX)
Truncates the cargo in this list to the given amount.
Definition: cargopacket.cpp:648
AMED_SLOWTURN
@ AMED_SLOWTURN
Turn slowly (mostly used in the air).
Definition: airport.h:50
WC_VEHICLE_VIEW
@ WC_VEHICLE_VIEW
Vehicle view; Window numbers:
Definition: window_type.h:339
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:639
newgrf_engine.h
ChangeDiagDir
DiagDirection ChangeDiagDir(DiagDirection d, DiagDirDiff delta)
Applies a difference on a DiagDirection.
Definition: direction_func.h:149
Vehicle::IsWaitingForUnbunching
bool IsWaitingForUnbunching() const
Check whether a vehicle inside a depot is waiting for unbunching.
Definition: vehicle.cpp:2481
DIR_E
@ DIR_E
East.
Definition: direction_type.h:28
Aircraft::turn_counter
byte turn_counter
Ticks between each turn to prevent > 45 degree turns.
Definition: aircraft.h:82
AirportFTAClass::nofelements
byte nofelements
number of positions the airport consists of
Definition: airport.h:181
EV_BREAKDOWN_SMOKE_AIRCRAFT
@ EV_BREAKDOWN_SMOKE_AIRCRAFT
Smoke of broken aircraft.
Definition: effectvehicle_func.h:27
NewsType
NewsType
Type of news.
Definition: news_type.h:23
SubtractMoneyFromCompanyFract
void SubtractMoneyFromCompanyFract(CompanyID company, const CommandCost &cst)
Subtract money from a company, including the money fraction.
Definition: company_cmd.cpp:297
Vehicle::tile
TileIndex tile
Current tile index.
Definition: vehicle_base.h:260
AircraftGetEntryPoint
static byte AircraftGetEntryPoint(const Aircraft *v, const AirportFTAClass *apc, Direction rotation)
Find the entry point to an airport depending on direction which the airport is being approached from.
Definition: aircraft_cmd.cpp:827
EIT_ON_MAP
@ EIT_ON_MAP
Vehicle drawn in viewport.
Definition: vehicle_type.h:86
DiagDirDifference
DiagDirDiff DiagDirDifference(DiagDirection d0, DiagDirection d1)
Calculate the difference between two DiagDirection values.
Definition: direction_func.h:131
Vehicle::random_bits
uint16_t random_bits
Bits used for randomized variational spritegroups.
Definition: vehicle_base.h:329
Vehicle::engine_type
EngineID engine_type
The type of engine used for this vehicle.
Definition: vehicle_base.h:318
VS_CRASHED
@ VS_CRASHED
Vehicle is crashed.
Definition: vehicle_base.h:40
_cheats
Cheats _cheats
All the cheats.
Definition: cheat.cpp:16
VehicleSpriteSeq
Sprite sequence for a vehicle part.
Definition: vehicle_base.h:131
Vehicle::last_station_visited
StationID last_station_visited
The last station we stopped at.
Definition: vehicle_base.h:332
AMED_HOLD
@ AMED_HOLD
Holding pattern movement (above the airport).
Definition: airport.h:56
Vehicle::cargo
VehicleCargoList cargo
The cargo this vehicle is carrying.
Definition: vehicle_base.h:340
Vehicle::GetOldAdvanceSpeed
uint GetOldAdvanceSpeed(uint speed)
Determines the effective direction-specific vehicle movement speed.
Definition: vehicle_base.h:423
CommandCost::Failed
bool Failed() const
Did this command fail?
Definition: command_type.h:171
SPEED_LIMIT_TAXI
@ SPEED_LIMIT_TAXI
Maximum speed of an aircraft while taxiing.
Definition: aircraft_cmd.cpp:633
Vehicle::current_order
Order current_order
The current order (+ status, like: loading)
Definition: vehicle_base.h:349
Airport::GetHangarTile
TileIndex GetHangarTile(uint hangar_num) const
Get the first tile of the given hangar.
Definition: station_base.h:358
AirportFindFreeHelipad
static bool AirportFindFreeHelipad(Aircraft *v, const AirportFTAClass *apc)
Find a free helipad, and assign it if available.
Definition: aircraft_cmd.cpp:2040
Station::airport
Airport airport
Tile area the airport covers.
Definition: station_base.h:456
HelicopterRotorStates
HelicopterRotorStates
Helicopter rotor animation states.
Definition: aircraft_cmd.cpp:110
AirportFTAClass::layout
struct AirportFTA * layout
state machine for airport
Definition: airport.h:177
DIR_NE
@ DIR_NE
Northeast.
Definition: direction_type.h:27
Vehicle::cur_speed
uint16_t cur_speed
current speed
Definition: vehicle_base.h:323
AirportFTAClass::flags
Flags flags
Flags for this airport type.
Definition: airport.h:180
ODATFB_NEAREST_DEPOT
@ ODATFB_NEAREST_DEPOT
Send the vehicle to the nearest depot.
Definition: order_type.h:105
_settings_game
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:55
Vehicle::build_year
TimerGameCalendar::Year build_year
Year the vehicle has been built.
Definition: vehicle_base.h:287
WC_VEHICLE_DETAILS
@ WC_VEHICLE_DETAILS
Vehicle details; Window numbers:
Definition: window_type.h:200
AirportFTA
Internal structure used in openttd - Finite sTate mAchine --> FTA.
Definition: airport.h:190
Game::NewEvent
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
Definition: game_core.cpp:147
VS_STOPPED
@ VS_STOPPED
Vehicle is stopped by the player.
Definition: vehicle_base.h:34
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:49
Vehicle::GetEngine
const Engine * GetEngine() const
Retrieves the engine of the vehicle.
Definition: vehicle.cpp:747
safeguards.h
GetNewVehiclePosResult::new_tile
TileIndex new_tile
Tile of the vehicle after moving.
Definition: vehicle_func.h:78
Vehicle::last_loading_station
StationID last_loading_station
Last station the vehicle has stopped at and could possibly leave from with any cargo loaded.
Definition: vehicle_base.h:333
vehicle_cmd.h
CommandCost::GetCost
Money GetCost() const
The costs as made up to this moment.
Definition: command_type.h:83
TERM2_block
static const uint64_t TERM2_block
Block belonging to terminal 2.
Definition: airport.h:90
DirToDiagDir
DiagDirection DirToDiagDir(Direction dir)
Convert a Direction to a DiagDirection.
Definition: direction_func.h:166
AirportFTA::block
uint64_t block
64 bit blocks (st->airport.flags), should be enough for the most complex airports
Definition: airport.h:192
Vehicle::profit_this_year
Money profit_this_year
Profit this year << 8, low 8 bits are fract.
Definition: vehicle_base.h:269
TERM1_block
static const uint64_t TERM1_block
Movement Blocks on Airports blocks (eg_airport_flags).
Definition: airport.h:89
AircraftSpeedLimits
AircraftSpeedLimits
Special velocities for aircraft.
Definition: aircraft_cmd.cpp:632
ODTFB_PART_OF_ORDERS
@ ODTFB_PART_OF_ORDERS
This depot order is because of a regular order.
Definition: order_type.h:96
settings
fluid_settings_t * settings
FluidSynth settings handle.
Definition: fluidsynth.cpp:21
SPEED_LIMIT_HOLD
@ SPEED_LIMIT_HOLD
Maximum speed of an aircraft that flies the holding pattern.
Definition: aircraft_cmd.cpp:636
VAF_IN_MIN_HEIGHT_CORRECTION
@ VAF_IN_MIN_HEIGHT_CORRECTION
The vehicle is currently raising its altitude because it hit the lower bound.
Definition: aircraft.h:45
MovementTerminalMapping
Combination of aircraft state for going to a certain terminal and the airport flag for that terminal ...
Definition: aircraft_cmd.cpp:1925
OrderSettings::serviceathelipad
bool serviceathelipad
service helicopters at helipads automatically (no need to send to depot)
Definition: settings_type.h:510
AirportFTAClass
Finite sTate mAchine (FTA) of an airport.
Definition: airport.h:143
SoundSettings::disaster
bool disaster
Play disaster and accident sounds.
Definition: settings_type.h:242
CargoID
byte CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
GetVehiclePosOnBuild
byte GetVehiclePosOnBuild(TileIndex hangar_tile)
Get the vehicle position when an aircraft is build at the given tile.
Definition: airport.cpp:218
HVOT_AIRCRAFT
@ HVOT_AIRCRAFT
Station has seen an aircraft.
Definition: station_type.h:67
MaybeCrashAirplane
static void MaybeCrashAirplane(Aircraft *v)
Decide whether aircraft v should crash.
Definition: aircraft_cmd.cpp:1368
GetNumTerminals
static uint GetNumTerminals(const AirportFTAClass *apc)
Get the number of terminals at the airport.
Definition: aircraft_cmd.cpp:1972
DirDiff
DirDiff
Allow incrementing of Direction variables.
Definition: direction_type.h:58
DiagDirection
DiagDirection
Enumeration for diagonal directions.
Definition: direction_type.h:73
NT_ACCIDENT_OTHER
@ NT_ACCIDENT_OTHER
An accident or disaster has occurred.
Definition: news_type.h:27
Vehicle::HandleLoading
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:2392
PFE_GL_AIRCRAFT
@ PFE_GL_AIRCRAFT
Time spent processing aircraft.
Definition: framerate_type.h:54
CreateEffectVehicleRel
EffectVehicle * CreateEffectVehicleRel(const Vehicle *v, int x, int y, int z, EffectVehicleType type)
Create an effect vehicle above a particular vehicle.
Definition: effectvehicle.cpp:638
stdafx.h
TERM5
@ TERM5
Heading for terminal 5.
Definition: airport.h:67
Vehicle::sprite_cache
MutableSpriteCache sprite_cache
Cache of sprites and values related to recalculating them, see MutableSpriteCache.
Definition: vehicle_base.h:363
landscape.h
SpriteID
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
AddVehicleNewsItem
void AddVehicleNewsItem(StringID string, NewsType type, VehicleID vehicle, StationID station=INVALID_STATION)
Adds a newsitem referencing a vehicle.
Definition: news_func.h:30
Cheat::value
bool value
tells if the bool cheat is active or not
Definition: cheat_type.h:18
Engine::reliability
uint16_t reliability
Current reliability of the engine.
Definition: engine_base.h:41
HELIPAD3
@ HELIPAD3
Heading for helipad 3.
Definition: airport.h:82
AirportHasBlock
static bool AirportHasBlock(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc)
returns true if the road ahead is busy, eg.
Definition: aircraft_cmd.cpp:1852
HELIPAD3_block
static const uint64_t HELIPAD3_block
Block belonging to helipad 3.
Definition: airport.h:117
Vehicle::colourmap
SpriteID colourmap
NOSAVE: cached colour mapping.
Definition: vehicle_base.h:284
Aircraft::OnNewCalendarDay
void OnNewCalendarDay() override
Calendar day handler.
Definition: aircraft_cmd.cpp:449
AircraftLeaveHangar
void AircraftLeaveHangar(Aircraft *v, Direction exit_dir)
Aircraft is about to leave the hangar.
Definition: aircraft_cmd.cpp:1465
VehicleSettings::plane_speed
uint8_t plane_speed
divisor for speed of aircraft
Definition: settings_type.h:528
DisasterVehicle
Disasters, like submarines, skyrangers and their shadows, belong to this class.
Definition: disaster_vehicle.h:37
Vehicle::z_pos
int32_t z_pos
z coordinate.
Definition: vehicle_base.h:301
VF_BUILT_AS_PROTOTYPE
@ VF_BUILT_AS_PROTOTYPE
Vehicle is a prototype (accepted as exclusive preview).
Definition: vehicle_base.h:47
Vehicle::direction
Direction direction
facing
Definition: vehicle_base.h:302
TERM8_block
static const uint64_t TERM8_block
Block belonging to terminal 8.
Definition: airport.h:116
MAX_TERMINALS
static const uint MAX_TERMINALS
Some airport-related constants.
Definition: airport.h:17
TERM2
@ TERM2
Heading for terminal 2.
Definition: airport.h:64
DistanceSquare
uint DistanceSquare(TileIndex t0, TileIndex t1)
Gets the 'Square' distance between the two given tiles.
Definition: map.cpp:176
AirportFTAClass::delta_z
byte delta_z
Z adjustment for helicopter pads.
Definition: airport.h:183
TERM7_block
static const uint64_t TERM7_block
Block belonging to terminal 7.
Definition: airport.h:115
PerformanceAccumulator
RAII class for measuring multi-step elements of performance.
Definition: framerate_type.h:114
ProcessOrders
bool ProcessOrders(Vehicle *v)
Handle the orders of a vehicle and determine the next place to go to if needed.
Definition: order_cmd.cpp:2127
VAF_DEST_TOO_FAR
@ VAF_DEST_TOO_FAR
Next destination is too far away.
Definition: aircraft.h:39
spritecache.h
Vehicle::x_extent
byte x_extent
x-extent of vehicle bounding box
Definition: vehicle_base.h:311
HandleCrashedAircraft
static bool HandleCrashedAircraft(Aircraft *v)
Handle crashed aircraft v.
Definition: aircraft_cmd.cpp:1174
Vehicle::vcache
VehicleCache vcache
Cache of often used vehicle values.
Definition: vehicle_base.h:361
GoodsEntry
Stores station stats for a single cargo.
Definition: station_base.h:166
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:50
vehicle_func.h
NT_ACCIDENT
@ NT_ACCIDENT
An accident or disaster has occurred.
Definition: news_type.h:26
station_base.h
newgrf_sound.h
AirportFTA::next
AirportFTA * next
possible extra movement choices from this position
Definition: airport.h:191
PALETTE_CRASH
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition: sprites.h:1602
Map::MaxY
static uint MaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition: map_func.h:306
strings_func.h
SmallStackItem::value
Titem value
Value of current item.
Definition: smallstack_type.hpp:96
AirportMovementStates
AirportMovementStates
Movement States on Airports (headings target)
Definition: airport.h:60
Vehicle::max_age
TimerGameCalendar::Date max_age
Maximum age.
Definition: vehicle_base.h:289
Vehicle::tick_counter
byte tick_counter
Increased by one for each tick.
Definition: vehicle_base.h:345
HELICOPTER_HOLD_MAX_FLYING_ALTITUDE
@ HELICOPTER_HOLD_MAX_FLYING_ALTITUDE
holding flying altitude above tile of helicopters.
Definition: aircraft.h:24
Vehicle::subspeed
byte subspeed
fractional speed
Definition: vehicle_base.h:324
AircraftCache::cached_max_range_sqr
uint32_t cached_max_range_sqr
Cached squared maximum range.
Definition: aircraft.h:67
SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::From
static Aircraft * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1201
Vehicle::x_offs
int8_t x_offs
x offset for vehicle sprite
Definition: vehicle_base.h:316
DIRDIFF_45RIGHT
@ DIRDIFF_45RIGHT
Angle of 45 degrees right.
Definition: direction_type.h:60
abs
constexpr T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition: math_func.hpp:23
Vehicle::z_extent
byte z_extent
z-extent of vehicle bounding box
Definition: vehicle_base.h:313
Vehicle::date_of_last_service_newgrf
TimerGameCalendar::Date date_of_last_service_newgrf
Last calendar date the vehicle had a service at a depot, unchanged by the date cheat to protect again...
Definition: vehicle_base.h:291
Vehicle::InvalidateNewGRFCacheOfChain
void InvalidateNewGRFCacheOfChain()
Invalidates cached NewGRF variables of all vehicles in the chain (after the current vehicle)
Definition: vehicle_base.h:499
SetDParam
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings.cpp:104
GetStationIndex
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition: station_map.h:28
TERM6_block
static const uint64_t TERM6_block
Block belonging to terminal 6.
Definition: airport.h:94
OrthogonalTileArea::tile
TileIndex tile
The base tile of the area.
Definition: tilearea_type.h:19
AIR_HELICOPTER
@ AIR_HELICOPTER
an helicopter
Definition: aircraft.h:31
RemoveOrderFromAllVehicles
void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination, bool hangar)
Removes an order from all vehicles.
Definition: order_cmd.cpp:1787
framerate_type.h
Aircraft::IsNormalAircraft
bool IsNormalAircraft() const
Check if the aircraft type is a normal flying device; eg not a rotor or a shadow.
Definition: aircraft.h:122
cheat_type.h
Aircraft::OnNewEconomyDay
void OnNewEconomyDay() override
Economy day handler.
Definition: aircraft_cmd.cpp:456
AircraftEntersTerminal
static void AircraftEntersTerminal(Aircraft *v)
Aircraft arrives at a terminal.
Definition: aircraft_cmd.cpp:1399
FreeTerminal
static bool FreeTerminal(Aircraft *v, byte i, byte last_terminal)
Find a free terminal or helipad, and if available, assign it.
Definition: aircraft_cmd.cpp:1952
Vehicle::reliability
uint16_t reliability
Reliability.
Definition: vehicle_base.h:292
OWNER_NONE
@ OWNER_NONE
The tile has no ownership.
Definition: company_type.h:25
UpdateAircraftCache
void UpdateAircraftCache(Aircraft *v, bool update_range)
Update cached values of an aircraft.
Definition: aircraft_cmd.cpp:602
GetNewVehiclePosResult
Position information of a vehicle after it moved.
Definition: vehicle_func.h:75
WC_VEHICLE_DEPOT
@ WC_VEHICLE_DEPOT
Depot view; Window numbers:
Definition: window_type.h:351
ScaleSpriteTrad
int ScaleSpriteTrad(int value)
Scale traditional pixel dimensions to GUI zoom level, for drawing sprites.
Definition: zoom_func.h:107
SpecializedStation< Station, false >::GetByTile
static Station * GetByTile(TileIndex tile)
Get the station belonging to a specific tile.
Definition: base_station_base.h:278
Aircraft::previous_pos
byte previous_pos
Previous desired position of the aircraft.
Definition: aircraft.h:77
AircraftEventHandler_AtTerminal
static void AircraftEventHandler_AtTerminal(Aircraft *v, const AirportFTAClass *apc)
At one of the Airport's Terminals.
Definition: aircraft_cmd.cpp:1565
HELIPAD1
@ HELIPAD1
Heading for helipad 1.
Definition: airport.h:69
UpdateAirplanesOnNewStation
void UpdateAirplanesOnNewStation(const Station *st)
Updates the status of the Aircraft heading or in the station.
Definition: aircraft_cmd.cpp:2158
EngineInfo::cargo_age_period
uint16_t cargo_age_period
Number of ticks before carried cargo is aged.
Definition: engine_type.h:159
HELITAKEOFF
@ HELITAKEOFF
Helicopter wants to leave the airport.
Definition: airport.h:74
HELIPAD2_block
static const uint64_t HELIPAD2_block
Block belonging to helipad 2.
Definition: airport.h:96
AircraftNextAirportPos_and_Order
void AircraftNextAirportPos_and_Order(Aircraft *v)
set the right pos when heading to other airports after takeoff
Definition: aircraft_cmd.cpp:1445
SPEED_LIMIT_NONE
@ SPEED_LIMIT_NONE
No environmental speed limit. Speed limit is type dependent.
Definition: aircraft_cmd.cpp:637
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition: base_station_base.h:65
FindNearestHangar
static StationID FindNearestHangar(const Aircraft *v)
Find the nearest hangar to v INVALID_STATION is returned, if the company does not have any suitable a...
Definition: aircraft_cmd.cpp:124
company_func.h
ORIGINAL_SAMPLE_COUNT
static const uint ORIGINAL_SAMPLE_COUNT
The number of sounds in the original sample.cat.
Definition: sound_type.h:116
AircraftVehicleInfo::mail_capacity
byte mail_capacity
Mail capacity (bags).
Definition: engine_type.h:108
TERM4_block
static const uint64_t TERM4_block
Block belonging to terminal 4.
Definition: airport.h:92
SpecializedVehicle< Aircraft, VEH_AIRCRAFT >::Iterate
static Pool::IterateWrapper< Aircraft > Iterate(size_t from=0)
Returns an iterable ensemble of all valid vehicles of type T.
Definition: vehicle_base.h:1270
GetNewVehiclePosResult::old_tile
TileIndex old_tile
Current tile of the vehicle.
Definition: vehicle_func.h:77
Vehicle::y_pos
int32_t y_pos
y coordinate.
Definition: vehicle_base.h:300
ClosestDepot
Structure to return information about the closest depot location, and whether it could be found.
Definition: vehicle_base.h:226
PlayVehicleSound
bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event, bool force)
Checks whether a NewGRF wants to play a different vehicle sound effect.
Definition: newgrf_sound.cpp:187
OrthogonalTileArea::w
uint16_t w
The width of the area.
Definition: tilearea_type.h:20
Order::GetDepotOrderType
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
Definition: order_base.h:145
Aircraft::pos
byte pos
Next desired position of the aircraft.
Definition: aircraft.h:76
AIR_CTOL
@ AIR_CTOL
Conventional Take Off and Landing, i.e. planes.
Definition: engine_type.h:95
Vehicle::subtype
byte subtype
subtype (Filled with values from AircraftSubType/DisasterSubType/EffectVehicleType/GroundVehicleSubty...
Definition: vehicle_base.h:358
CommandHelper
Definition: command_func.h:93
UnScaleGUI
int UnScaleGUI(int value)
Short-hand to apply GUI zoom level.
Definition: zoom_func.h:77
Vehicle::day_counter
byte day_counter
Increased by one for each day.
Definition: vehicle_base.h:344
VS_UNCLICKABLE
@ VS_UNCLICKABLE
Vehicle is not clickable by the user (shadow vehicles).
Definition: vehicle_base.h:35
TERMGROUP
@ TERMGROUP
Aircraft is looking for a free terminal in a terminalgroup.
Definition: airport.h:84
window_func.h
TO_ALL
@ TO_ALL
Go in this direction for every target.
Definition: airport.h:61
AircraftController
static bool AircraftController(Aircraft *v)
Controls the movement of an aircraft.
Definition: aircraft_cmd.cpp:868
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:300
random_func.hpp
GetTileMaxPixelZ
int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
Definition: tile_map.h:304
AircraftVehicleInfo::passenger_capacity
uint16_t passenger_capacity
Passenger capacity (persons).
Definition: engine_type.h:109
TileHeight
static debug_inline uint TileHeight(Tile tile)
Returns the height of a tile.
Definition: tile_map.h:29
AgeVehicle
void AgeVehicle(Vehicle *v)
Update age of a vehicle.
Definition: vehicle.cpp:1423
SpecializedStation< Station, false >::GetIfValid
static Station * GetIfValid(size_t index)
Returns station if the index is a valid index for this station type.
Definition: base_station_base.h:268
Vehicle::progress
byte progress
The percentage (if divided by 256) this vehicle already crossed the tile unit.
Definition: vehicle_base.h:327
AirportFTAClass::terminals
const byte * terminals
Array with the number of terminal groups, followed by the number of terminals in each group.
Definition: airport.h:178
STARTTAKEOFF
@ STARTTAKEOFF
Airplane has arrived at a runway for take-off.
Definition: airport.h:72
TILE_HEIGHT
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in #ZOOM_LVL_BASE.
Definition: tile_type.h:18
OverflowSafeInt< int64_t >
Airport::type
byte type
Type of this airport,.
Definition: station_base.h:294
engine_base.h
Vehicle::cargo_type
CargoID cargo_type
type of cargo this vehicle is carrying
Definition: vehicle_base.h:336
Engine::original_image_index
uint8_t original_image_index
Original vehicle image index, thus the image index of the overridden vehicle.
Definition: engine_base.h:55
TileVirtXY
static debug_inline TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition: map_func.h:416
IsValidCargoID
bool IsValidCargoID(CargoID t)
Test whether cargo type is not INVALID_CARGO.
Definition: cargo_type.h:103
Vehicle::spritenum
byte spritenum
currently displayed sprite index 0xfd == custom sprite, 0xfe == custom second head sprite 0xff == res...
Definition: vehicle_base.h:310
Aircraft::Crash
uint Crash(bool flooded=false) override
Crash the (whole) vehicle chain.
Definition: aircraft_cmd.cpp:1319
AMED_HELI_RAISE
@ AMED_HELI_RAISE
Helicopter take-off.
Definition: airport.h:54
LANDING
@ LANDING
Airplane wants to land.
Definition: airport.h:76
TimerGameCalendar::date
static Date date
Current date in days (day counter).
Definition: timer_game_calendar.h:34
Aircraft::state
byte state
State of the airport.
Definition: aircraft.h:79
AirportFTA::position
byte position
the position that an airplane is at
Definition: airport.h:193
TERM6
@ TERM6
Heading for terminal 6.
Definition: airport.h:68
GameSettings::vehicle
VehicleSettings vehicle
options for vehicles
Definition: settings_type.h:627
EngineID
uint16_t EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
Ticks::DAY_TICKS
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
Definition: timer_game_tick.h:48
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:51
AirportFTAClass::entry_points
const byte * entry_points
when an airplane arrives at this airport, enter it at position entry_point, index depends on directio...
Definition: airport.h:182
Clamp
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition: math_func.hpp:79
Vehicle::UpdatePositionAndViewport
void UpdatePositionAndViewport()
Update the position of the vehicle, and update the viewport.
Definition: vehicle.cpp:1739
FACIL_AIRPORT
@ FACIL_AIRPORT
Station with an airport.
Definition: station_type.h:55
TileX
static debug_inline uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:427
PROP_AIRCRAFT_SPEED
@ PROP_AIRCRAFT_SPEED
Max. speed: 1 unit = 8 mph = 12.8 km-ish/h.
Definition: newgrf_properties.h:50
MovementTerminalMapping::state
AirportMovementStates state
Aircraft movement state when going to this terminal.
Definition: aircraft_cmd.cpp:1926
TERM8
@ TERM8
Heading for terminal 8.
Definition: airport.h:81
TERM3_block
static const uint64_t TERM3_block
Block belonging to terminal 3.
Definition: airport.h:91
Vehicle::UpdatePosition
void UpdatePosition()
Update the position of the vehicle.
Definition: vehicle.cpp:1668
GetAircraftFlightLevelBounds
void GetAircraftFlightLevelBounds(const Vehicle *v, int *min_level, int *max_level)
Get the 'flight level' bounds, in pixels from 'z_pos' 0 for a particular vehicle for normal flight si...
Definition: aircraft_cmd.cpp:729
Engine::flags
byte flags
Flags of the engine.
Definition: engine_base.h:49
AirportFindFreeTerminal
static bool AirportFindFreeTerminal(Aircraft *v, const AirportFTAClass *apc)
Find a free terminal, and assign it if available.
Definition: aircraft_cmd.cpp:1987
Rect::Width
int Width() const
Get width of Rect.
Definition: geometry_type.hpp:85
CanVehicleUseStation
bool CanVehicleUseStation(EngineID engine_type, const Station *st)
Can this station be used by the given engine type?
Definition: vehicle.cpp:2983
AircraftLandAirplane
static void AircraftLandAirplane(Aircraft *v)
Aircraft touched down at the landing strip.
Definition: aircraft_cmd.cpp:1428
Vehicle::HandleBreakdown
bool HandleBreakdown()
Handle all of the aspects of a vehicle breakdown This includes adding smoke and sounds,...
Definition: vehicle.cpp:1357
AircraftVehicleInfo
Information about a aircraft vehicle.
Definition: engine_type.h:100
DecreaseVehicleValue
void DecreaseVehicleValue(Vehicle *v)
Decrease the value of a vehicle.
Definition: vehicle.cpp:1295
GetNewVehiclePosResult::y
int y
x and y position of the vehicle after moving
Definition: vehicle_func.h:76
disaster_vehicle.h
Chance16R
bool Chance16R(const uint a, const uint b, uint32_t &r)
Flips a coin with a given probability and saves the randomize-number in a variable.
Definition: random_func.hpp:155
Aircraft::Tick
bool Tick() override
Calls the tick handler of the vehicle.
Definition: aircraft_cmd.cpp:2115
DIAGDIR_NE
@ DIAGDIR_NE
Northeast, upper right on your monitor.
Definition: direction_type.h:75
TAKEOFF
@ TAKEOFF
Airplane wants to leave the airport.
Definition: airport.h:71
TERM5_block
static const uint64_t TERM5_block
Block belonging to terminal 5.
Definition: airport.h:93
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:75
AirportFTAClass::AIRPLANES
@ AIRPLANES
Can planes land on this airport type?
Definition: airport.h:147
DepotCommand::None
@ None
No special flags.
TimerGameConst< struct Calendar >::DAYS_IN_YEAR
static constexpr int DAYS_IN_YEAR
days per year
Definition: timer_game_common.h:149
SPEED_LIMIT_BROKEN
@ SPEED_LIMIT_BROKEN
Maximum speed of an aircraft that is broken.
Definition: aircraft_cmd.cpp:635
ClrBit
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
Definition: bitmath_func.hpp:151
SetWindowClassesDirty
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition: window.cpp:3108
VehicleSpriteSeq::GetBounds
void GetBounds(Rect *bounds) const
Determine shared bounds of all sprites.
Definition: vehicle.cpp:103
Order::GetDepotActionType
OrderDepotActionFlags GetDepotActionType() const
What are we going to do when in the depot.
Definition: order_base.h:147
WC_AIRCRAFT_LIST
@ WC_AIRCRAFT_LIST
Aircraft list; Window numbers:
Definition: window_type.h:326
SetWindowWidgetDirty
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, WidgetID widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting)
Definition: window.cpp:3095
Order::MakeGoToDepot
void MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, OrderNonStopFlags non_stop_type=ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS, OrderDepotActionFlags action=ODATF_SERVICE_ONLY, CargoID cargo=CARGO_NO_REFIT)
Makes this order a Go To Depot order.
Definition: order_cmd.cpp:90
CLRBITS
#define CLRBITS(x, y)
Clears several bits in a variable.
Definition: bitmath_func.hpp:166
PROP_AIRCRAFT_RANGE
@ PROP_AIRCRAFT_RANGE
Aircraft range.
Definition: newgrf_properties.h:55
AirportFTAClass::MovingData
const AirportMovingData * MovingData(byte position) const
Get movement data at a position.
Definition: airport.h:170
HELIPAD2
@ HELIPAD2
Heading for helipad 2.
Definition: airport.h:70
SpecializedVehicle::UpdateViewport
void UpdateViewport(bool force_update, bool update_delta)
Update vehicle sprite- and position caches.
Definition: vehicle_base.h:1223
Order
Definition: order_base.h:36
VS_SHADOW
@ VS_SHADOW
Vehicle is a shadow vehicle.
Definition: vehicle_base.h:38
AirportFTA::next_position
byte next_position
next position from this position
Definition: airport.h:194
Aircraft::flags
byte flags
Aircraft flags.
Definition: aircraft.h:83
Aircraft::UpdateDeltaXY
void UpdateDeltaXY() override
Updates the x and y offsets and the size of the sprite used for this vehicle.
Definition: aircraft_cmd.cpp:49
Vehicle::LeaveUnbunchingDepot
void LeaveUnbunchingDepot()
Leave an unbunching depot and calculate the next departure time for shared order vehicles.
Definition: vehicle.cpp:2438
StationCargoList::Truncate
uint Truncate(uint max_move=UINT_MAX, StationCargoAmountMap *cargo_per_source=nullptr)
Truncates where each destination loses roughly the same percentage of its cargo.
Definition: cargopacket.cpp:763
Aircraft::MarkDirty
void MarkDirty() override
Marks the vehicles to be redrawn and updates cached variables.
Definition: aircraft_cmd.cpp:1309
AT_DUMMY
@ AT_DUMMY
Dummy airport.
Definition: airport.h:43
FLYING
@ FLYING
Vehicle is flying in the air.
Definition: airport.h:75
AMED_HELI_LOWER
@ AMED_HELI_LOWER
Helicopter landing.
Definition: airport.h:55
AIRCRAFT_MIN_FLYING_ALTITUDE
@ AIRCRAFT_MIN_FLYING_ALTITUDE
Minimum flying altitude above tile.
Definition: aircraft.h:21
CmdBuildAircraft
CommandCost CmdBuildAircraft(DoCommandFlag flags, TileIndex tile, const Engine *e, Vehicle **ret)
Build an aircraft.
Definition: aircraft_cmd.cpp:271
_aircraft_state_handlers
static AircraftStateHandler *const _aircraft_state_handlers[]
Array of handler functions for each target of the aircraft.
Definition: aircraft_cmd.cpp:1757
timer_game_economy.h
Vehicle::y_offs
int8_t y_offs
y offset for vehicle sprite
Definition: vehicle_base.h:317
AT_OILRIG
@ AT_OILRIG
Oilrig airport.
Definition: airport.h:38
AirportMovingData::flag
uint16_t flag
special flags when moving towards the destination.
Definition: airport.h:134
Vehicle::refit_cap
uint16_t refit_cap
Capacity left over from before last refit.
Definition: vehicle_base.h:339
GetNewVehiclePos
GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v)
Get position information of a vehicle when moving one pixel in the direction it is facing.
Definition: vehicle.cpp:1759
SetAircraftPosition
void SetAircraftPosition(Aircraft *v, int x, int y, int z)
Set aircraft position.
Definition: aircraft_cmd.cpp:533
AMED_BRAKE
@ AMED_BRAKE
Taxiing at the airport.
Definition: airport.h:53
TERM4
@ TERM4
Heading for terminal 4.
Definition: airport.h:66
AIR_ROTOR
@ AIR_ROTOR
rotor of an helicopter
Definition: aircraft.h:34
Vehicle::GetNextStoppingStation
StationIDStack GetNextStoppingStation() const
Get the next station the vehicle will stop at.
Definition: vehicle_base.h:745
news_func.h
AMED_NOSPDCLAMP
@ AMED_NOSPDCLAMP
No speed restrictions.
Definition: airport.h:48
ROTOR_Z_OFFSET
static const int ROTOR_Z_OFFSET
Z Offset between helicopter- and rotorsprite.
Definition: aircraft.h:50
TimerGameCalendar::year
static Year year
Current year, starting at 0.
Definition: timer_game_calendar.h:32
backup_type.hpp
TimerGameEconomy::date
static Date date
Current date in days (day counter).
Definition: timer_game_economy.h:37
HasBit
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition: bitmath_func.hpp:103