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