OpenTTD Source 20251005-master-ga617d009cc
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 "error_func.h"
20#include "strings_func.h"
21#include "command_func.h"
22#include "window_func.h"
25#include "vehicle_func.h"
26#include "sound_func.h"
27#include "cheat_type.h"
28#include "company_base.h"
29#include "ai/ai.hpp"
30#include "game/game.hpp"
31#include "company_func.h"
32#include "effectvehicle_func.h"
33#include "station_base.h"
34#include "engine_base.h"
35#include "core/random_func.hpp"
36#include "core/backup_type.hpp"
37#include "zoom_func.h"
38#include "disaster_vehicle.h"
39#include "newgrf_airporttiles.h"
40#include "framerate_type.h"
41#include "aircraft_cmd.h"
42#include "vehicle_cmd.h"
43
44#include "table/strings.h"
45
46#include "safeguards.h"
47
49{
50 this->bounds = {{-1, -1, 0}, {2, 2, 0}, {}};
51
52 switch (this->subtype) {
53 default: NOT_REACHED();
54
55 case AIR_AIRCRAFT:
56 case AIR_HELICOPTER:
57 switch (this->state) {
58 default: break;
59 case ENDTAKEOFF:
60 case LANDING:
61 case HELILANDING:
62 case FLYING:
63 /* Bounds are not centred on the aircraft. */
64 this->bounds.extent.x = 24;
65 this->bounds.extent.y = 24;
66 break;
67 }
68 this->bounds.extent.z = 5;
69 break;
70
71 case AIR_SHADOW:
72 this->bounds.extent.z = 1;
73 this->bounds.origin = {};
74 break;
75
76 case AIR_ROTOR:
77 this->bounds.extent.z = 1;
78 break;
79 }
80}
81
82static bool AirportMove(Aircraft *v, const AirportFTAClass *apc);
83static bool AirportSetBlocks(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc);
84static bool AirportHasBlock(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc);
85static bool AirportFindFreeTerminal(Aircraft *v, const AirportFTAClass *apc);
86static bool AirportFindFreeHelipad(Aircraft *v, const AirportFTAClass *apc);
87static void CrashAirplane(Aircraft *v);
88
89static const SpriteID _aircraft_sprite[] = {
90 0x0EB5, 0x0EBD, 0x0EC5, 0x0ECD,
91 0x0ED5, 0x0EDD, 0x0E9D, 0x0EA5,
92 0x0EAD, 0x0EE5, 0x0F05, 0x0F0D,
93 0x0F15, 0x0F1D, 0x0F25, 0x0F2D,
94 0x0EED, 0x0EF5, 0x0EFD, 0x0F35,
95 0x0E9D, 0x0EA5, 0x0EAD, 0x0EB5,
96 0x0EBD, 0x0EC5
97};
98
99template <>
100bool IsValidImageIndex<VEH_AIRCRAFT>(uint8_t image_index)
101{
102 return image_index < lengthof(_aircraft_sprite);
103}
104
106enum HelicopterRotorStates : uint8_t {
107 HRS_ROTOR_STOPPED,
108 HRS_ROTOR_MOVING_1,
109 HRS_ROTOR_MOVING_2,
110 HRS_ROTOR_MOVING_3,
111};
112
121{
122 uint best = 0;
123 StationID index = StationID::Invalid();
124 TileIndex vtile = TileVirtXY(v->x_pos, v->y_pos);
125 const AircraftVehicleInfo *avi = AircraftVehInfo(v->engine_type);
126 uint max_range = v->acache.cached_max_range_sqr;
127
128 /* Determine destinations where it's coming from and where it's heading to */
129 const Station *last_dest = nullptr;
130 const Station *next_dest = nullptr;
131 if (max_range != 0) {
132 if (v->current_order.IsType(OT_GOTO_STATION) ||
133 (v->current_order.IsType(OT_GOTO_DEPOT) && (v->current_order.GetDepotActionType() & ODATFB_NEAREST_DEPOT) == 0)) {
135 next_dest = Station::GetIfValid(v->current_order.GetDestination().ToStationID());
136 } else {
137 last_dest = GetTargetAirportIfValid(v);
139 }
140 }
141
142 for (const Station *st : Station::Iterate()) {
143 if (st->owner != v->owner || !st->facilities.Test(StationFacility::Airport) || !st->airport.HasHangar()) continue;
144
145 const AirportFTAClass *afc = st->airport.GetFTA();
146
147 /* don't crash the plane if we know it can't land at the airport */
148 if (afc->flags.Test(AirportFTAClass::Flag::ShortStrip) && (avi->subtype & AIR_FAST) && !_cheats.no_jetcrash.value) continue;
149
150 /* the plane won't land at any helicopter station */
151 if (!afc->flags.Test(AirportFTAClass::Flag::Airplanes) && (avi->subtype & AIR_CTOL)) continue;
152
153 /* Check if our last and next destinations can be reached from the depot airport. */
154 if (max_range != 0) {
155 uint last_dist = (last_dest != nullptr && last_dest->airport.tile != INVALID_TILE) ? DistanceSquare(st->airport.tile, last_dest->airport.tile) : 0;
156 uint next_dist = (next_dest != nullptr && next_dest->airport.tile != INVALID_TILE) ? DistanceSquare(st->airport.tile, next_dest->airport.tile) : 0;
157 if (last_dist > max_range || next_dist > max_range) continue;
158 }
159
160 /* v->tile can't be used here, when aircraft is flying v->tile is set to 0 */
161 uint distance = DistanceSquare(vtile, st->airport.tile);
162 if (distance < best || index == StationID::Invalid()) {
163 best = distance;
164 index = st->index;
165 }
166 }
167 return index;
168}
169
170void Aircraft::GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
171{
172 uint8_t spritenum = this->spritenum;
173
174 if (IsCustomVehicleSpriteNum(spritenum)) {
175 GetCustomVehicleSprite(this, direction, image_type, result);
176 if (result->IsValid()) return;
177
179 }
180
181 assert(IsValidImageIndex<VEH_AIRCRAFT>(spritenum));
182 result->Set(direction + _aircraft_sprite[spritenum]);
183}
184
185void GetRotorImage(const Aircraft *v, EngineImageType image_type, VehicleSpriteSeq *result)
186{
187 assert(v->subtype == AIR_HELICOPTER);
188
189 const Aircraft *w = v->Next()->Next();
190 if (IsCustomVehicleSpriteNum(v->spritenum)) {
191 GetCustomRotorSprite(v, image_type, result);
192 if (result->IsValid()) return;
193 }
194
195 /* Return standard rotor sprites if there are no custom sprites for this helicopter */
196 result->Set(SPR_ROTOR_STOPPED + w->state);
197}
198
199static void GetAircraftIcon(EngineID engine, EngineImageType image_type, VehicleSpriteSeq *result)
200{
201 const Engine *e = Engine::Get(engine);
202 uint8_t spritenum = e->VehInfo<AircraftVehicleInfo>().image_index;
203
204 if (IsCustomVehicleSpriteNum(spritenum)) {
205 GetCustomVehicleIcon(engine, DIR_W, image_type, result);
206 if (result->IsValid()) return;
207
208 spritenum = e->original_image_index;
209 }
210
211 assert(IsValidImageIndex<VEH_AIRCRAFT>(spritenum));
212 result->Set(DIR_W + _aircraft_sprite[spritenum]);
213}
214
215void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
216{
218 GetAircraftIcon(engine, image_type, &seq);
219
220 Rect rect;
221 seq.GetBounds(&rect);
222 preferred_x = Clamp(preferred_x,
223 left - UnScaleGUI(rect.left),
224 right - UnScaleGUI(rect.right));
225
226 seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
227
228 if (!(AircraftVehInfo(engine)->subtype & AIR_CTOL)) {
229 VehicleSpriteSeq rotor_seq;
230 GetCustomRotorIcon(engine, image_type, &rotor_seq);
231 if (!rotor_seq.IsValid()) rotor_seq.Set(SPR_ROTOR_STOPPED);
232 rotor_seq.Draw(preferred_x, y - ScaleSpriteTrad(5), PAL_NONE, false);
233 }
234}
235
245void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
246{
248 GetAircraftIcon(engine, image_type, &seq);
249
250 Rect rect;
251 seq.GetBounds(&rect);
252
253 width = UnScaleGUI(rect.Width());
254 height = UnScaleGUI(rect.Height());
255 xoffs = UnScaleGUI(rect.left);
256 yoffs = UnScaleGUI(rect.top);
257}
258
268{
269 const AircraftVehicleInfo *avi = &e->VehInfo<AircraftVehicleInfo>();
270 const Station *st = Station::GetByTile(tile);
271
272 /* Prevent building aircraft types at places which can't handle them */
273 if (!CanVehicleUseStation(e->index, st)) return CMD_ERROR;
274
275 /* Make sure all aircraft end up in the first tile of the hangar. */
276 tile = st->airport.GetHangarTile(st->airport.GetHangarNum(tile));
277
278 if (flags.Test(DoCommandFlag::Execute)) {
279 Aircraft *v = new Aircraft(); // aircraft
280 Aircraft *u = new Aircraft(); // shadow
281 *ret = v;
282
283 v->direction = DIR_SE;
284
285 v->owner = u->owner = _current_company;
286
287 v->tile = tile;
288
289 uint x = TileX(tile) * TILE_SIZE + 5;
290 uint y = TileY(tile) * TILE_SIZE + 3;
291
292 v->x_pos = u->x_pos = x;
293 v->y_pos = u->y_pos = y;
294
295 u->z_pos = GetSlopePixelZ(x, y);
296 v->z_pos = u->z_pos + 1;
297
300
301 v->spritenum = avi->image_index;
302
304 v->refit_cap = 0;
305 u->refit_cap = 0;
306
308 assert(IsValidCargoType(v->cargo_type));
309
310 CargoType mail = GetCargoTypeByLabel(CT_MAIL);
311 if (IsValidCargoType(mail)) {
312 u->cargo_type = mail;
313 u->cargo_cap = avi->mail_capacity;
314 }
315
316 v->name.clear();
317 v->last_station_visited = StationID::Invalid();
318 v->last_loading_station = StationID::Invalid();
319
320 v->acceleration = avi->acceleration;
321 v->engine_type = e->index;
322 u->engine_type = e->index;
323
325 v->UpdateDeltaXY();
326
327 u->subtype = AIR_SHADOW;
328 u->UpdateDeltaXY();
329
330 v->reliability = e->reliability;
333
334 v->pos = GetVehiclePosOnBuild(tile);
335
336 v->state = HANGAR;
337 v->previous_pos = v->pos;
339 v->SetNext(u);
340
341 v->SetServiceInterval(Company::Get(_current_company)->settings.vehicle.servint_aircraft);
342
346
347 v->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
348 u->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
349
350 v->random_bits = Random();
351 u->random_bits = Random();
352
353 v->vehicle_flags = {};
355 v->SetServiceIntervalIsPercent(Company::Get(_current_company)->settings.vehicle.servint_ispercent);
356
358
359 v->cargo_cap = e->DetermineCapacity(v, &u->cargo_cap);
360
362
363 UpdateAircraftCache(v, true);
364
365 v->UpdatePosition();
366 u->UpdatePosition();
367
368 /* Aircraft with 3 vehicles (chopper)? */
369 if (v->subtype == AIR_HELICOPTER) {
370 Aircraft *w = new Aircraft();
371 w->engine_type = e->index;
372 w->direction = DIR_N;
374 w->x_pos = v->x_pos;
375 w->y_pos = v->y_pos;
376 w->z_pos = v->z_pos + ROTOR_Z_OFFSET;
378 w->spritenum = 0xFF;
379 w->subtype = AIR_ROTOR;
380 w->sprite_cache.sprite_seq.Set(SPR_ROTOR_STOPPED);
381 w->random_bits = Random();
382 /* Use rotor's air.state to store the rotor animation frame */
383 w->state = HRS_ROTOR_STOPPED;
384 w->UpdateDeltaXY();
385
386 u->SetNext(w);
387 w->UpdatePosition();
388 }
389 }
390
391 return CommandCost();
392}
393
394
396{
397 const Station *st = GetTargetAirportIfValid(this);
398 /* If the station is not a valid airport or if it has no hangars */
399 if (st == nullptr || !CanVehicleUseStation(this, st) || !st->airport.HasHangar()) {
400 /* the aircraft has to search for a hangar on its own */
401 StationID station = FindNearestHangar(this);
402
403 if (station == StationID::Invalid()) return ClosestDepot();
404
405 st = Station::Get(station);
406 }
407
408 return ClosestDepot(st->xy, st->index);
409}
410
411static void CheckIfAircraftNeedsService(Aircraft *v)
412{
413 if (Company::Get(v->owner)->settings.vehicle.servint_aircraft == 0 || !v->NeedsAutomaticServicing()) return;
414 if (v->IsChainInDepot()) {
416 return;
417 }
418
419 /* When we're parsing conditional orders and the like
420 * we don't want to consider going to a depot too. */
421 if (!v->current_order.IsType(OT_GOTO_DEPOT) && !v->current_order.IsType(OT_GOTO_STATION)) return;
422
423 const Station *st = Station::Get(v->current_order.GetDestination().ToStationID());
424
425 assert(st != nullptr);
426
427 /* only goto depot if the target airport has a depot */
428 if (st->airport.HasHangar() && CanVehicleUseStation(v, st)) {
431 } else if (v->current_order.IsType(OT_GOTO_DEPOT)) {
434 }
435}
436
438{
439 const Engine *e = this->GetEngine();
440 uint cost_factor = GetVehicleProperty(this, PROP_AIRCRAFT_RUNNING_COST_FACTOR, e->VehInfo<AircraftVehicleInfo>().running_cost);
441 return GetPrice(PR_RUNNING_AIRCRAFT, cost_factor, e->GetGRF());
442}
443
446{
447 if (!this->IsNormalAircraft()) return;
448 AgeVehicle(this);
449}
450
453{
454 if (!this->IsNormalAircraft()) return;
455 EconomyAgeVehicle(this);
456
457 if ((++this->day_counter & 7) == 0) DecreaseVehicleValue(this);
458
459 CheckOrders(this);
460
461 CheckVehicleBreakdown(this);
462 CheckIfAircraftNeedsService(this);
463
464 if (this->running_ticks == 0) return;
465
467
468 this->profit_this_year -= cost.GetCost();
469 this->running_ticks = 0;
470
472
475}
476
477static void HelicopterTickHandler(Aircraft *v)
478{
479 Aircraft *u = v->Next()->Next();
480
481 if (u->vehstatus.Test(VehState::Hidden)) return;
482
483 /* if true, helicopter rotors do not rotate. This should only be the case if a helicopter is
484 * loading/unloading at a terminal or stopped */
485 if (v->current_order.IsType(OT_LOADING) || v->vehstatus.Test(VehState::Stopped)) {
486 if (u->cur_speed != 0) {
487 u->cur_speed++;
488 if (u->cur_speed >= 0x80 && u->state == HRS_ROTOR_MOVING_3) {
489 u->cur_speed = 0;
490 }
491 }
492 } else {
493 if (u->cur_speed == 0) {
494 u->cur_speed = 0x70;
495 }
496 if (u->cur_speed >= 0x50) {
497 u->cur_speed--;
498 }
499 }
500
501 int tick = ++u->tick_counter;
502 int spd = u->cur_speed >> 4;
503
505 if (spd == 0) {
506 u->state = HRS_ROTOR_STOPPED;
507 GetRotorImage(v, EIT_ON_MAP, &seq);
508 if (u->sprite_cache.sprite_seq == seq) return;
509 } else if (tick >= spd) {
510 u->tick_counter = 0;
511 u->state++;
512 if (u->state > HRS_ROTOR_MOVING_3) u->state = HRS_ROTOR_MOVING_1;
513 GetRotorImage(v, EIT_ON_MAP, &seq);
514 } else {
515 return;
516 }
517
518 u->sprite_cache.sprite_seq = seq;
519
521}
522
530void SetAircraftPosition(Aircraft *v, int x, int y, int z)
531{
532 v->x_pos = x;
533 v->y_pos = y;
534 v->z_pos = z;
535
536 v->UpdatePosition();
537 v->UpdateViewport(true, false);
538 if (v->subtype == AIR_HELICOPTER) {
539 GetRotorImage(v, EIT_ON_MAP, &v->Next()->Next()->sprite_cache.sprite_seq);
540 }
541
542 Aircraft *u = v->Next();
543
544 int safe_x = Clamp(x, 0, Map::MaxX() * TILE_SIZE);
545 int safe_y = Clamp(y - 1, 0, Map::MaxY() * TILE_SIZE);
546 u->x_pos = x;
547 u->y_pos = y - ((v->z_pos - GetSlopePixelZ(safe_x, safe_y)) >> 3);
548
549 safe_y = Clamp(u->y_pos, 0, Map::MaxY() * TILE_SIZE);
550 u->z_pos = GetSlopePixelZ(safe_x, safe_y);
551 u->sprite_cache.sprite_seq.CopyWithoutPalette(v->sprite_cache.sprite_seq); // the shadow is never coloured
552
554
555 u = u->Next();
556 if (u != nullptr) {
557 u->x_pos = x;
558 u->y_pos = y;
559 u->z_pos = z + ROTOR_Z_OFFSET;
560
562 }
563}
564
570{
571 v->subspeed = 0;
572 v->progress = 0;
573
574 Aircraft *u = v->Next();
576 u = u->Next();
577 if (u != nullptr) {
579 u->cur_speed = 0;
580 }
581
582 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
583}
584
585static void PlayAircraftSound(const Vehicle *v)
586{
587 if (!PlayVehicleSound(v, VSE_START)) {
588 SndPlayVehicleFx(AircraftVehInfo(v->engine_type)->sfx, v);
589 }
590}
591
592
599void UpdateAircraftCache(Aircraft *v, bool update_range)
600{
601 uint max_speed = GetVehicleProperty(v, PROP_AIRCRAFT_SPEED, 0);
602 if (max_speed != 0) {
603 /* Convert from original units to km-ish/h */
604 max_speed = (max_speed * 128) / 10;
605
606 v->vcache.cached_max_speed = max_speed;
607 } else {
608 /* Use the default max speed of the vehicle. */
609 v->vcache.cached_max_speed = AircraftVehInfo(v->engine_type)->max_speed;
610 }
611
612 /* Update cargo aging period. */
614 Aircraft *u = v->Next(); // Shadow for mail
616
617 /* Update aircraft range. */
618 if (update_range) {
619 v->acache.cached_max_range = GetVehicleProperty(v, PROP_AIRCRAFT_RANGE, AircraftVehInfo(v->engine_type)->max_range);
620 /* Squared it now so we don't have to do it later all the time. */
621 v->acache.cached_max_range_sqr = v->acache.cached_max_range * v->acache.cached_max_range;
622 }
623}
624
625
629static constexpr uint16_t SPEED_LIMIT_TAXI = 50;
630static constexpr uint16_t SPEED_LIMIT_APPROACH = 230;
631static constexpr uint16_t SPEED_LIMIT_BROKEN = 320;
632static constexpr uint16_t SPEED_LIMIT_HOLD = 425;
633static constexpr uint16_t SPEED_LIMIT_NONE = UINT16_MAX;
634
642static int UpdateAircraftSpeed(Aircraft *v, uint speed_limit = SPEED_LIMIT_NONE, bool hard_limit = true)
643{
651 uint spd = v->acceleration * 77;
652 uint8_t t;
653
654 /* Adjust speed limits by plane speed factor to prevent taxiing
655 * and take-off speeds being too low. */
656 speed_limit *= _settings_game.vehicle.plane_speed;
657
658 /* adjust speed for broken vehicles */
660 if (SPEED_LIMIT_BROKEN < speed_limit) hard_limit = false;
661 speed_limit = std::min<uint>(speed_limit, SPEED_LIMIT_BROKEN);
662 }
663
664 if (v->vcache.cached_max_speed < speed_limit) {
665 if (v->cur_speed < speed_limit) hard_limit = false;
666 speed_limit = v->vcache.cached_max_speed;
667 }
668
669 v->subspeed = (t = v->subspeed) + (uint8_t)spd;
670
671 /* Aircraft's current speed is used twice so that very fast planes are
672 * forced to slow down rapidly in the short distance needed. The magic
673 * value 16384 was determined to give similar results to the old speed/48
674 * method at slower speeds. This also results in less reduction at slow
675 * speeds to that aircraft do not get to taxi speed straight after
676 * touchdown. */
677 if (!hard_limit && v->cur_speed > speed_limit) {
678 speed_limit = v->cur_speed - std::max(1, ((v->cur_speed * v->cur_speed) / 16384) / _settings_game.vehicle.plane_speed);
679 }
680
681 spd = std::min(v->cur_speed + (spd >> 8) + (v->subspeed < t), speed_limit);
682
683 /* updates statusbar only if speed have changed to save CPU time */
684 if (spd != v->cur_speed) {
685 v->cur_speed = spd;
687 }
688
689 /* Adjust distance moved by plane speed setting */
691
692 /* Convert direction-independent speed into direction-dependent speed. (old movement method) */
693 spd = v->GetOldAdvanceSpeed(spd);
694
695 spd += v->progress;
696 v->progress = (uint8_t)spd;
697 return spd >> 8;
698}
699
708{
709 int safe_x = Clamp(v->x_pos, 0, Map::MaxX() * TILE_SIZE);
710 int safe_y = Clamp(v->y_pos, 0, Map::MaxY() * TILE_SIZE);
711 return TileHeight(TileVirtXY(safe_x, safe_y)) * TILE_HEIGHT;
712}
713
724void GetAircraftFlightLevelBounds(const Vehicle *v, int *min_level, int *max_level)
725{
726 int base_altitude = GetTileHeightBelowAircraft(v);
729 }
730
731 /* Make sure eastbound and westbound planes do not "crash" into each
732 * other by providing them with vertical separation
733 */
734 switch (v->direction) {
735 case DIR_N:
736 case DIR_NE:
737 case DIR_E:
738 case DIR_SE:
739 base_altitude += 10;
740 break;
741
742 default: break;
743 }
744
745 /* Make faster planes fly higher so that they can overtake slower ones */
746 base_altitude += std::min(20 * (v->vcache.cached_max_speed / 200) - 90, 0);
747
748 if (min_level != nullptr) *min_level = base_altitude + AIRCRAFT_MIN_FLYING_ALTITUDE;
749 if (max_level != nullptr) *max_level = base_altitude + AIRCRAFT_MAX_FLYING_ALTITUDE;
750}
751
760{
761 int tile_height = GetTileHeightBelowAircraft(v);
762
764}
765
766template <class T>
767int GetAircraftFlightLevel(T *v, bool takeoff)
768{
769 /* Aircraft is in flight. We want to enforce it being somewhere
770 * between the minimum and the maximum allowed altitude. */
771 int aircraft_min_altitude;
772 int aircraft_max_altitude;
773 GetAircraftFlightLevelBounds(v, &aircraft_min_altitude, &aircraft_max_altitude);
774 int aircraft_middle_altitude = (aircraft_min_altitude + aircraft_max_altitude) / 2;
775
776 /* If those assumptions would be violated, aircraft would behave fairly strange. */
777 assert(aircraft_min_altitude < aircraft_middle_altitude);
778 assert(aircraft_middle_altitude < aircraft_max_altitude);
779
780 int z = v->z_pos;
781 if (z < aircraft_min_altitude ||
782 (HasBit(v->flags, VAF_IN_MIN_HEIGHT_CORRECTION) && z < aircraft_middle_altitude)) {
783 /* Ascend. And don't fly into that mountain right ahead.
784 * And avoid our aircraft become a stairclimber, so if we start
785 * correcting altitude, then we stop correction not too early. */
787 z += takeoff ? 2 : 1;
788 } else if (!takeoff && (z > aircraft_max_altitude ||
789 (HasBit(v->flags, VAF_IN_MAX_HEIGHT_CORRECTION) && z > aircraft_middle_altitude))) {
790 /* Descend lower. You are an aircraft, not an space ship.
791 * And again, don't stop correcting altitude too early. */
793 z--;
794 } else if (HasBit(v->flags, VAF_IN_MIN_HEIGHT_CORRECTION) && z >= aircraft_middle_altitude) {
795 /* Now, we have corrected altitude enough. */
797 } else if (HasBit(v->flags, VAF_IN_MAX_HEIGHT_CORRECTION) && z <= aircraft_middle_altitude) {
798 /* Now, we have corrected altitude enough. */
800 }
801
802 return z;
803}
804
805template int GetAircraftFlightLevel(DisasterVehicle *v, bool takeoff);
806template int GetAircraftFlightLevel(Aircraft *v, bool takeoff);
807
822static uint8_t AircraftGetEntryPoint(const Aircraft *v, const AirportFTAClass *apc, Direction rotation)
823{
824 assert(v != nullptr);
825 assert(apc != nullptr);
826
827 /* In the case the station doesn't exit anymore, set target tile 0.
828 * It doesn't hurt much, aircraft will go to next order, nearest hangar
829 * or it will simply crash in next tick */
830 TileIndex tile{};
831
833 if (st != nullptr) {
834 /* Make sure we don't go to INVALID_TILE if the airport has been removed. */
835 tile = (st->airport.tile != INVALID_TILE) ? st->airport.tile : st->xy;
836 }
837
838 int delta_x = v->x_pos - TileX(tile) * TILE_SIZE;
839 int delta_y = v->y_pos - TileY(tile) * TILE_SIZE;
840
841 DiagDirection dir;
842 if (abs(delta_y) < abs(delta_x)) {
843 /* We are northeast or southwest of the airport */
844 dir = delta_x < 0 ? DIAGDIR_NE : DIAGDIR_SW;
845 } else {
846 /* We are northwest or southeast of the airport */
847 dir = delta_y < 0 ? DIAGDIR_NW : DIAGDIR_SE;
848 }
850 return apc->entry_points[dir];
851}
852
853
854static void MaybeCrashAirplane(Aircraft *v);
855
864{
865 /* nullptr if station is invalid */
867 /* INVALID_TILE if there is no station */
868 TileIndex tile = INVALID_TILE;
869 Direction rotation = DIR_N;
870 uint size_x = 1, size_y = 1;
871 if (st != nullptr) {
872 if (st->airport.tile != INVALID_TILE) {
873 tile = st->airport.tile;
874 rotation = st->airport.rotation;
875 size_x = st->airport.w;
876 size_y = st->airport.h;
877 } else {
878 tile = st->xy;
879 }
880 }
881 /* DUMMY if there is no station or no airport */
882 const AirportFTAClass *afc = tile == INVALID_TILE ? GetAirport(AT_DUMMY) : st->airport.GetFTA();
883
884 /* prevent going to INVALID_TILE if airport is deleted. */
885 if (st == nullptr || st->airport.tile == INVALID_TILE) {
886 /* Jump into our "holding pattern" state machine if possible */
887 if (v->pos >= afc->nofelements) {
888 v->pos = v->previous_pos = AircraftGetEntryPoint(v, afc, DIR_N);
889 } else if (v->targetairport != v->current_order.GetDestination()) {
890 /* If not possible, just get out of here fast */
891 v->state = FLYING;
894 /* get aircraft back on running altitude */
895 SetAircraftPosition(v, v->x_pos, v->y_pos, GetAircraftFlightLevel(v));
896 return false;
897 }
898 }
899
900 /* get airport moving data */
901 const AirportMovingData amd = RotateAirportMovingData(afc->MovingData(v->pos), rotation, size_x, size_y);
902
903 int x = TileX(tile) * TILE_SIZE;
904 int y = TileY(tile) * TILE_SIZE;
905
906 /* Helicopter raise */
908 Aircraft *u = v->Next()->Next();
909
910 /* Make sure the rotors don't rotate too fast */
911 if (u->cur_speed > 32) {
912 v->cur_speed = 0;
913 if (--u->cur_speed == 32) {
914 if (!PlayVehicleSound(v, VSE_START)) {
915 SoundID sfx = AircraftVehInfo(v->engine_type)->sfx;
916 /* For compatibility with old NewGRF we ignore the sfx property, unless a NewGRF-defined sound is used.
917 * The baseset has only one helicopter sound, so this only limits using plane or cow sounds. */
919 SndPlayVehicleFx(sfx, v);
920 }
921 }
922 } else {
923 u->cur_speed = 32;
924 int count = UpdateAircraftSpeed(v);
925 if (count > 0) {
926 v->tile = TileIndex{};
927
928 int z_dest;
929 GetAircraftFlightLevelBounds(v, &z_dest, nullptr);
930
931 /* Reached altitude? */
932 if (v->z_pos >= z_dest) {
933 v->cur_speed = 0;
934 return true;
935 }
936 SetAircraftPosition(v, v->x_pos, v->y_pos, std::min(v->z_pos + count, z_dest));
937 }
938 }
939 return false;
940 }
941
942 /* Helicopter landing. */
945
946 if (st == nullptr) {
947 v->state = FLYING;
950 return false;
951 }
952
953 /* Vehicle is now at the airport.
954 * Helicopter has arrived at the target landing pad, so the current position is also where it should land.
955 * Except for Oilrigs which are special due to being a 1x1 station, and helicopters land outside it. */
956 if (st->airport.type != AT_OILRIG) {
957 x = v->x_pos;
958 y = v->y_pos;
959 tile = TileVirtXY(x, y);
960 }
961 v->tile = tile;
962
963 /* Find altitude of landing position. */
964 int z = GetSlopePixelZ(x, y) + 1 + afc->delta_z;
965
966 if (z == v->z_pos) {
967 Vehicle *u = v->Next()->Next();
968
969 /* Increase speed of rotors. When speed is 80, we've landed. */
970 if (u->cur_speed >= 80) {
972 return true;
973 }
974 u->cur_speed += 4;
975 } else {
976 int count = UpdateAircraftSpeed(v);
977 if (count > 0) {
978 if (v->z_pos > z) {
979 SetAircraftPosition(v, v->x_pos, v->y_pos, std::max(v->z_pos - count, z));
980 } else {
981 SetAircraftPosition(v, v->x_pos, v->y_pos, std::min(v->z_pos + count, z));
982 }
983 }
984 }
985 return false;
986 }
987
988 /* Get distance from destination pos to current pos. */
989 uint dist = abs(x + amd.x - v->x_pos) + abs(y + amd.y - v->y_pos);
990
991 /* Need exact position? */
992 if (!amd.flags.Test(AirportMovingDataFlag::ExactPosition) && dist <= (amd.flags.Test(AirportMovingDataFlag::SlowTurn) ? 8U : 4U)) return true;
993
994 /* At final pos? */
995 if (dist == 0) {
996 /* Change direction smoothly to final direction. */
997 DirDiff dirdiff = DirDifference(amd.direction, v->direction);
998 /* if distance is 0, and plane points in right direction, no point in calling
999 * UpdateAircraftSpeed(). So do it only afterwards */
1000 if (dirdiff == DIRDIFF_SAME) {
1001 v->cur_speed = 0;
1002 return true;
1003 }
1004
1005 if (!UpdateAircraftSpeed(v, SPEED_LIMIT_TAXI)) return false;
1006
1008 v->cur_speed >>= 1;
1009
1010 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1011 return false;
1012 }
1013
1016 if (v->vehstatus.Test(VehState::Crashed)) return false;
1017 }
1018
1019 uint speed_limit = SPEED_LIMIT_TAXI;
1020 bool hard_limit = true;
1021
1023 if (amd.flags.Test(AirportMovingDataFlag::Hold)) { speed_limit = SPEED_LIMIT_HOLD; hard_limit = false; }
1024 if (amd.flags.Test(AirportMovingDataFlag::Land)) { speed_limit = SPEED_LIMIT_APPROACH; hard_limit = false; }
1025 if (amd.flags.Test(AirportMovingDataFlag::Brake)) { speed_limit = SPEED_LIMIT_TAXI; hard_limit = false; }
1026
1027 int count = UpdateAircraftSpeed(v, speed_limit, hard_limit);
1028 if (count == 0) return false;
1029
1030 /* If the plane will be a few subpixels away from the destination after
1031 * this movement loop, start nudging it towards the exact position for
1032 * the whole loop. Otherwise, heavily depending on the speed of the plane,
1033 * it is possible we totally overshoot the target, causing the plane to
1034 * make a loop, and trying again, and again, and again .. */
1035 bool nudge_towards_target = static_cast<uint>(count) + 3 > dist;
1036
1037 if (v->turn_counter != 0) v->turn_counter--;
1038
1039 do {
1040
1042
1043 if (nudge_towards_target || amd.flags.Test(AirportMovingDataFlag::Land)) {
1044 /* move vehicle one pixel towards target */
1045 gp.x = (v->x_pos != (x + amd.x)) ?
1046 v->x_pos + ((x + amd.x > v->x_pos) ? 1 : -1) :
1047 v->x_pos;
1048 gp.y = (v->y_pos != (y + amd.y)) ?
1049 v->y_pos + ((y + amd.y > v->y_pos) ? 1 : -1) :
1050 v->y_pos;
1051
1052 /* Oilrigs must keep v->tile as st->airport.tile, since the landing pad is in a non-airport tile */
1053 gp.new_tile = (st->airport.type == AT_OILRIG) ? st->airport.tile : TileVirtXY(gp.x, gp.y);
1054
1055 } else {
1056
1057 /* Turn. Do it slowly if in the air. */
1058 Direction newdir = GetDirectionTowards(v, x + amd.x, y + amd.y);
1059 if (newdir != v->direction) {
1061 if (v->turn_counter == 0 || newdir == v->last_direction) {
1062 if (newdir == v->last_direction) {
1064 } else {
1066 }
1068 v->last_direction = v->direction;
1069 v->direction = newdir;
1070 }
1071
1072 /* Move vehicle. */
1073 gp = GetNewVehiclePos(v);
1074 } else {
1075 v->cur_speed >>= 1;
1076 v->direction = newdir;
1077
1078 /* When leaving a terminal an aircraft often goes to a position
1079 * directly in front of it. If it would move while turning it
1080 * would need an two extra turns to end up at the correct position.
1081 * To make it easier just disallow all moving while turning as
1082 * long as an aircraft is on the ground. */
1083 gp.x = v->x_pos;
1084 gp.y = v->y_pos;
1085 gp.new_tile = gp.old_tile = v->tile;
1086 }
1087 } else {
1089 /* Move vehicle. */
1090 gp = GetNewVehiclePos(v);
1091 }
1092 }
1093
1094 v->tile = gp.new_tile;
1095 /* If vehicle is in the air, use tile coordinate 0. */
1096 if (amd.flags.Any({AirportMovingDataFlag::Takeoff, AirportMovingDataFlag::SlowTurn, AirportMovingDataFlag::Land})) v->tile = TileIndex{};
1097
1098 /* Adjust Z for land or takeoff? */
1099 int z = v->z_pos;
1100
1102 z = GetAircraftFlightLevel(v, true);
1103 } else if (amd.flags.Test(AirportMovingDataFlag::Hold)) {
1104 /* Let the plane drop from normal flight altitude to holding pattern altitude */
1105 if (z > GetAircraftHoldMaxAltitude(v)) z--;
1106 } else if (amd.flags.All({AirportMovingDataFlag::SlowTurn, AirportMovingDataFlag::NoSpeedClamp})) {
1107 z = GetAircraftFlightLevel(v);
1108 }
1109
1110 /* NewGRF airports (like a rotated intercontinental from OpenGFX+Airports) can be non-rectangular
1111 * and their primary (north-most) tile does not have to be part of the airport.
1112 * As such, the height of the primary tile can be different from the rest of the airport.
1113 * Given we are landing/breaking, and as such are not a helicopter, we know that there has to be a hangar.
1114 * We also know that the airport itself has to be completely flat (otherwise it is not a valid airport).
1115 * Therefore, use the height of this hangar to calculate our z-value. */
1116 int airport_z = v->z_pos;
1117 if (amd.flags.Any({AirportMovingDataFlag::Land, AirportMovingDataFlag::Brake}) && st != nullptr) {
1118 assert(st->airport.HasHangar());
1119 TileIndex hangar_tile = st->airport.GetHangarTile(0);
1120 airport_z = GetTileMaxPixelZ(hangar_tile) + 1; // To avoid clashing with the shadow
1121 }
1122
1125 /* Zeppeliner blocked the runway, abort landing */
1126 v->state = FLYING;
1128 SetAircraftPosition(v, gp.x, gp.y, GetAircraftFlightLevel(v));
1129 v->pos = v->previous_pos;
1130 continue;
1131 }
1132
1133 if (st->airport.tile == INVALID_TILE) {
1134 /* Airport has been removed, abort the landing procedure */
1135 v->state = FLYING;
1138 /* get aircraft back on running altitude */
1139 SetAircraftPosition(v, gp.x, gp.y, GetAircraftFlightLevel(v));
1140 continue;
1141 }
1142
1143 /* We're not flying below our destination, right? */
1144 assert(airport_z <= z);
1145 int t = std::max(1U, dist - 4);
1146 int delta = z - airport_z;
1147
1148 /* Only start lowering when we're sufficiently close for a 1:1 glide */
1149 if (delta >= t) {
1150 z -= CeilDiv(z - airport_z, t);
1151 }
1152 if (z < airport_z) z = airport_z;
1153 }
1154
1155 /* We've landed. Decrease speed when we're reaching end of runway. */
1157
1158 if (z > airport_z) {
1159 z--;
1160 } else if (z < airport_z) {
1161 z++;
1162 }
1163
1164 }
1165
1166 SetAircraftPosition(v, gp.x, gp.y, z);
1167 } while (--count != 0);
1168 return false;
1169}
1170
1176{
1177 v->crashed_counter += 3;
1178
1180
1181 /* make aircraft crash down to the ground */
1182 if (v->crashed_counter < 500 && st == nullptr && ((v->crashed_counter % 3) == 0) ) {
1183 int z = GetSlopePixelZ(Clamp(v->x_pos, 0, Map::MaxX() * TILE_SIZE), Clamp(v->y_pos, 0, Map::MaxY() * TILE_SIZE));
1184 v->z_pos -= 1;
1185 if (v->z_pos <= z) {
1186 v->crashed_counter = 500;
1187 v->z_pos = z + 1;
1188 } else {
1189 v->crashed_counter = 0;
1190 }
1191 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1192 }
1193
1194 if (v->crashed_counter < 650) {
1195 uint32_t r;
1196 if (Chance16R(1, 32, r)) {
1197 static const DirDiff delta[] = {
1199 };
1200
1201 v->direction = ChangeDir(v->direction, delta[GB(r, 16, 2)]);
1202 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1203 r = Random();
1205 GB(r, 0, 4) - 4,
1206 GB(r, 4, 4) - 4,
1207 GB(r, 8, 4),
1209 }
1210 } else if (v->crashed_counter >= 10000) {
1211 /* remove rubble of crashed airplane */
1212
1213 /* clear runway-in on all airports, set by crashing plane
1214 * small airports use AIRPORT_BUSY, city airports use AirportBlock::RunwayInOut, etc.
1215 * but they all share the same number */
1216 if (st != nullptr) {
1217 st->airport.blocks.Reset(AirportBlock::RunwayIn);
1218 st->airport.blocks.Reset(AirportBlock::RunwayInOut); // commuter airport
1219 st->airport.blocks.Reset(AirportBlock::RunwayIn2); // intercontinental
1220 }
1221
1222 delete v;
1223
1224 return false;
1225 }
1226
1227 return true;
1228}
1229
1230
1236static void HandleAircraftSmoke(Aircraft *v, bool mode)
1237{
1238 static const struct {
1239 int8_t x;
1240 int8_t y;
1241 } smoke_pos[] = {
1242 { 5, 5 },
1243 { 6, 0 },
1244 { 5, -5 },
1245 { 0, -6 },
1246 { -5, -5 },
1247 { -6, 0 },
1248 { -5, 5 },
1249 { 0, 6 }
1250 };
1251
1252 if (!v->vehstatus.Test(VehState::AircraftBroken)) return;
1253
1254 /* Stop smoking when landed */
1255 if (v->cur_speed < 10) {
1257 v->breakdown_ctr = 0;
1258 return;
1259 }
1260
1261 /* Spawn effect et most once per Tick, i.e. !mode */
1262 if (!mode && (v->tick_counter & 0x0F) == 0) {
1264 smoke_pos[v->direction].x,
1265 smoke_pos[v->direction].y,
1266 2,
1268 );
1269 }
1270}
1271
1272void HandleMissingAircraftOrders(Aircraft *v)
1273{
1274 /*
1275 * We do not have an order. This can be divided into two cases:
1276 * 1) we are heading to an invalid station. In this case we must
1277 * find another airport to go to. If there is nowhere to go,
1278 * we will destroy the aircraft as it otherwise will enter
1279 * the holding pattern for the first airport, which can cause
1280 * the plane to go into an undefined state when building an
1281 * airport with the same StationID.
1282 * 2) we are (still) heading to a (still) valid airport, then we
1283 * can continue going there. This can happen when you are
1284 * changing the aircraft's orders while in-flight or in for
1285 * example a depot. However, when we have a current order to
1286 * go to a depot, we have to keep that order so the aircraft
1287 * actually stops.
1288 */
1289 const Station *st = GetTargetAirportIfValid(v);
1290 if (st == nullptr) {
1291 Backup<CompanyID> cur_company(_current_company, v->owner);
1293 cur_company.Restore();
1294
1295 if (ret.Failed()) CrashAirplane(v);
1296 } else if (!v->current_order.IsType(OT_GOTO_DEPOT)) {
1297 v->current_order.Free();
1298 }
1299}
1300
1301
1303{
1304 /* Orders are changed in flight, ensure going to the right station. */
1305 if (this->state == FLYING) {
1307 }
1308
1309 /* Aircraft do not use dest-tile */
1310 return TileIndex{};
1311}
1312
1314{
1315 this->colourmap = PAL_NONE;
1316 this->UpdateViewport(true, false);
1317 if (this->subtype == AIR_HELICOPTER) {
1318 GetRotorImage(this, EIT_ON_MAP, &this->Next()->Next()->sprite_cache.sprite_seq);
1319 }
1320}
1321
1322
1323uint Aircraft::Crash(bool flooded)
1324{
1325 uint victims = Vehicle::Crash(flooded) + 2; // pilots
1326 this->crashed_counter = flooded ? 9000 : 0; // max 10000, disappear pretty fast when flooded
1327
1328 return victims;
1329}
1330
1336{
1338
1339 uint victims = v->Crash();
1340
1341 v->cargo.Truncate();
1342 v->Next()->cargo.Truncate();
1343 const Station *st = GetTargetAirportIfValid(v);
1344 TileIndex vt = TileVirtXY(v->x_pos, v->y_pos);
1345
1346 EncodedString headline;
1347 if (st == nullptr) {
1348 headline = GetEncodedString(STR_NEWS_PLANE_CRASH_OUT_OF_FUEL, victims);
1349 } else {
1350 headline = GetEncodedString(STR_NEWS_AIRCRAFT_CRASH, victims, st->index);
1351 }
1352
1353 AI::NewEvent(v->owner, new ScriptEventVehicleCrashed(v->index, vt, st == nullptr ? ScriptEventVehicleCrashed::CRASH_AIRCRAFT_NO_AIRPORT : ScriptEventVehicleCrashed::CRASH_PLANE_LANDING, victims, v->owner));
1354 Game::NewEvent(new ScriptEventVehicleCrashed(v->index, vt, st == nullptr ? ScriptEventVehicleCrashed::CRASH_AIRCRAFT_NO_AIRPORT : ScriptEventVehicleCrashed::CRASH_PLANE_LANDING, victims, v->owner));
1355
1356 NewsType newstype = NewsType::Accident;
1357 if (v->owner != _local_company) {
1358 newstype = NewsType::AccidentOther;
1359 }
1360
1361 AddTileNewsItem(std::move(headline), newstype, vt, st != nullptr ? st->index : StationID::Invalid());
1362
1363 ModifyStationRatingAround(vt, v->owner, -160, 30);
1364 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, v);
1365}
1366
1372{
1373
1375
1376 uint32_t prob;
1378 (AircraftVehInfo(v->engine_type)->subtype & AIR_FAST) &&
1380 prob = 3276;
1381 } else {
1382 if (_settings_game.vehicle.plane_crashes == 0) return;
1383 prob = (0x4000 << _settings_game.vehicle.plane_crashes) / 1500;
1384 }
1385
1386 if (GB(Random(), 0, 22) > prob) return;
1387
1388 /* Crash the airplane. Remove all goods stored at the station. */
1389 for (GoodsEntry &ge : st->goods) {
1390 ge.rating = 1;
1391 if (ge.HasData()) ge.GetData().cargo.Truncate();
1392 }
1393
1394 CrashAirplane(v);
1395}
1396
1403{
1404 if (v->current_order.IsType(OT_GOTO_DEPOT)) return;
1405
1408
1409 /* Check if station was ever visited before */
1410 if (!(st->had_vehicle_of_type & HVOT_AIRCRAFT)) {
1411 st->had_vehicle_of_type |= HVOT_AIRCRAFT;
1412 /* show newsitem of celebrating citizens */
1414 GetEncodedString(STR_NEWS_FIRST_AIRCRAFT_ARRIVAL, st->index),
1416 v->index,
1417 st->index
1418 );
1419 AI::NewEvent(v->owner, new ScriptEventStationFirstVehicle(st->index, v->index));
1420 Game::NewEvent(new ScriptEventStationFirstVehicle(st->index, v->index));
1421 }
1422
1423 v->BeginLoading();
1424}
1425
1431{
1433
1434 TileIndex vt = TileVirtXY(v->x_pos, v->y_pos);
1435
1436 v->UpdateDeltaXY();
1437
1438 TriggerAirportTileAnimation(st, vt, AirportAnimationTrigger::AirplaneTouchdown);
1439
1441 SndPlayVehicleFx(SND_17_SKID_PLANE, v);
1442 }
1443}
1444
1445
1448{
1449 if (v->current_order.IsType(OT_GOTO_STATION) || v->current_order.IsType(OT_GOTO_DEPOT)) {
1450 v->targetairport = v->current_order.GetDestination().ToStationID();
1451 }
1452
1453 const Station *st = GetTargetAirportIfValid(v);
1454 const AirportFTAClass *apc = st == nullptr ? GetAirport(AT_DUMMY) : st->airport.GetFTA();
1455 Direction rotation = st == nullptr ? DIR_N : st->airport.rotation;
1456 v->pos = v->previous_pos = AircraftGetEntryPoint(v, apc, rotation);
1457}
1458
1468{
1469 v->cur_speed = 0;
1470 v->subspeed = 0;
1471 v->progress = 0;
1472 v->direction = exit_dir;
1474 {
1475 Vehicle *u = v->Next();
1477
1478 /* Rotor blades */
1479 u = u->Next();
1480 if (u != nullptr) {
1482 u->cur_speed = 80;
1483 }
1484 }
1485
1488 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1491}
1492
1496static void AircraftEventHandler_EnterTerminal(Aircraft *v, const AirportFTAClass *apc)
1497{
1499 v->state = apc->layout[v->pos].heading;
1500}
1501
1508{
1510 v->state = apc->layout[v->pos].heading;
1511}
1512
1519{
1520 /* if we just arrived, execute EnterHangar first */
1521 if (v->previous_pos != v->pos) {
1523 return;
1524 }
1525
1526 /* if we were sent to the depot, stay there */
1527 if (v->current_order.IsType(OT_GOTO_DEPOT) && v->vehstatus.Test(VehState::Stopped)) {
1528 v->current_order.Free();
1529 return;
1530 }
1531
1532 /* Check if we should wait here for unbunching. */
1533 if (v->IsWaitingForUnbunching()) return;
1534
1535 if (!v->current_order.IsType(OT_GOTO_STATION) &&
1536 !v->current_order.IsType(OT_GOTO_DEPOT))
1537 return;
1538
1539 /* We are leaving a hangar, but have to go to the exact same one; re-enter */
1540 if (v->current_order.IsType(OT_GOTO_DEPOT) && v->current_order.GetDestination() == v->targetairport) {
1542 return;
1543 }
1544
1545 /* if the block of the next position is busy, stay put */
1546 if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1547
1548 /* We are already at the target airport, we need to find a terminal */
1550 /* FindFreeTerminal:
1551 * 1. Find a free terminal, 2. Occupy it, 3. Set the vehicle's state to that terminal */
1552 if (v->subtype == AIR_HELICOPTER) {
1553 if (!AirportFindFreeHelipad(v, apc)) return; // helicopter
1554 } else {
1555 if (!AirportFindFreeTerminal(v, apc)) return; // airplane
1556 }
1557 } else { // Else prepare for launch.
1558 /* airplane goto state takeoff, helicopter to helitakeoff */
1560 }
1561 const Station *st = Station::GetByTile(v->tile);
1563 AirportMove(v, apc);
1564}
1565
1568{
1569 /* if we just arrived, execute EnterTerminal first */
1570 if (v->previous_pos != v->pos) {
1571 AircraftEventHandler_EnterTerminal(v, apc);
1572 /* on an airport with helipads, a helicopter will always land there
1573 * and get serviced at the same time - setting */
1575 if (v->subtype == AIR_HELICOPTER && apc->num_helipads > 0) {
1576 /* an excerpt of ServiceAircraft, without the invisibility stuff */
1582 }
1583 }
1584 return;
1585 }
1586
1587 if (v->current_order.IsType(OT_NOTHING)) return;
1588
1589 /* if the block of the next position is busy, stay put */
1590 if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1591
1592 /* airport-road is free. We either have to go to another airport, or to the hangar
1593 * ---> start moving */
1594
1595 bool go_to_hangar = false;
1596 switch (v->current_order.GetType()) {
1597 case OT_GOTO_STATION: // ready to fly to another airport
1598 break;
1599 case OT_GOTO_DEPOT: // visit hangar for servicing, sale, etc.
1600 go_to_hangar = v->current_order.GetDestination() == v->targetairport;
1601 break;
1602 case OT_CONDITIONAL:
1603 /* In case of a conditional order we just have to wait a tick
1604 * longer, so the conditional order can actually be processed;
1605 * we should not clear the order as that makes us go nowhere. */
1606 return;
1607 default: // orders have been deleted (no orders), goto depot and don't bother us
1608 v->current_order.Free();
1609 go_to_hangar = true;
1610 }
1611
1612 if (go_to_hangar && Station::Get(v->targetairport)->airport.HasHangar()) {
1613 v->state = HANGAR;
1614 } else {
1615 /* airplane goto state takeoff, helicopter to helitakeoff */
1617 }
1618 AirportMove(v, apc);
1619}
1620
1621static void AircraftEventHandler_General(Aircraft *, const AirportFTAClass *)
1622{
1623 FatalError("OK, you shouldn't be here, check your Airport Scheme!");
1624}
1625
1626static void AircraftEventHandler_TakeOff(Aircraft *v, const AirportFTAClass *)
1627{
1628 PlayAircraftSound(v); // play takeoffsound for airplanes
1629 v->state = STARTTAKEOFF;
1630}
1631
1632static void AircraftEventHandler_StartTakeOff(Aircraft *v, const AirportFTAClass *)
1633{
1634 v->state = ENDTAKEOFF;
1635 v->UpdateDeltaXY();
1636}
1637
1638static void AircraftEventHandler_EndTakeOff(Aircraft *v, const AirportFTAClass *)
1639{
1640 v->state = FLYING;
1641 /* get the next position to go to, differs per airport */
1643}
1644
1645static void AircraftEventHandler_HeliTakeOff(Aircraft *v, const AirportFTAClass *)
1646{
1647 v->state = FLYING;
1648 v->UpdateDeltaXY();
1649
1650 /* get the next position to go to, differs per airport */
1652
1653 /* Send the helicopter to a hangar if needed for replacement */
1654 if (v->NeedsAutomaticServicing()) {
1655 Backup<CompanyID> cur_company(_current_company, v->owner);
1657 cur_company.Restore();
1658 }
1659}
1660
1661static void AircraftEventHandler_Flying(Aircraft *v, const AirportFTAClass *apc)
1662{
1664
1665 /* Runway busy, not allowed to use this airstation or closed, circle. */
1666 if (CanVehicleUseStation(v, st) && (st->owner == OWNER_NONE || st->owner == v->owner) && !st->airport.blocks.Test(AirportBlock::AirportClosed)) {
1667 /* {32,FLYING,AirportBlock::Nothing,37}, {32,LANDING,N,33}, {32,HELILANDING,N,41},
1668 * if it is an airplane, look for LANDING, for helicopter HELILANDING
1669 * it is possible to choose from multiple landing runways, so loop until a free one is found */
1670 uint8_t landingtype = (v->subtype == AIR_HELICOPTER) ? HELILANDING : LANDING;
1671 const AirportFTA *current = apc->layout[v->pos].next.get();
1672 while (current != nullptr) {
1673 if (current->heading == landingtype) {
1674 /* save speed before, since if AirportHasBlock is false, it resets them to 0
1675 * we don't want that for plane in air
1676 * hack for speed thingy */
1677 uint16_t tcur_speed = v->cur_speed;
1678 uint16_t tsubspeed = v->subspeed;
1679 if (!AirportHasBlock(v, current, apc)) {
1680 v->state = landingtype; // LANDING / HELILANDING
1682 /* it's a bit dirty, but I need to set position to next position, otherwise
1683 * if there are multiple runways, plane won't know which one it took (because
1684 * they all have heading LANDING). And also occupy that block! */
1685 v->pos = current->next_position;
1686 st->airport.blocks.Set(apc->layout[v->pos].blocks);
1687 return;
1688 }
1689 v->cur_speed = tcur_speed;
1690 v->subspeed = tsubspeed;
1691 }
1692 current = current->next.get();
1693 }
1694 }
1695 v->state = FLYING;
1696 v->pos = apc->layout[v->pos].next_position;
1697}
1698
1699static void AircraftEventHandler_Landing(Aircraft *v, const AirportFTAClass *)
1700{
1701 v->state = ENDLANDING;
1702 AircraftLandAirplane(v); // maybe crash airplane
1703
1704 /* check if the aircraft needs to be replaced or renewed and send it to a hangar if needed */
1705 if (v->NeedsAutomaticServicing()) {
1706 Backup<CompanyID> cur_company(_current_company, v->owner);
1708 cur_company.Restore();
1709 }
1710}
1711
1712static void AircraftEventHandler_HeliLanding(Aircraft *v, const AirportFTAClass *)
1713{
1714 v->state = HELIENDLANDING;
1715 v->UpdateDeltaXY();
1716}
1717
1718static void AircraftEventHandler_EndLanding(Aircraft *v, const AirportFTAClass *apc)
1719{
1720 /* next block busy, don't do a thing, just wait */
1721 if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1722
1723 /* if going to terminal (OT_GOTO_STATION) choose one
1724 * 1. in case all terminals are busy AirportFindFreeTerminal() returns false or
1725 * 2. not going for terminal (but depot, no order),
1726 * --> get out of the way to the hangar. */
1727 if (v->current_order.IsType(OT_GOTO_STATION)) {
1728 if (AirportFindFreeTerminal(v, apc)) return;
1729 }
1730 v->state = HANGAR;
1731
1732}
1733
1734static void AircraftEventHandler_HeliEndLanding(Aircraft *v, const AirportFTAClass *apc)
1735{
1736 /* next block busy, don't do a thing, just wait */
1737 if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1738
1739 /* if going to helipad (OT_GOTO_STATION) choose one. If airport doesn't have helipads, choose terminal
1740 * 1. in case all terminals/helipads are busy (AirportFindFreeHelipad() returns false) or
1741 * 2. not going for terminal (but depot, no order),
1742 * --> get out of the way to the hangar IF there are terminals on the airport.
1743 * --> else TAKEOFF
1744 * the reason behind this is that if an airport has a terminal, it also has a hangar. Airplanes
1745 * must go to a hangar. */
1746 if (v->current_order.IsType(OT_GOTO_STATION)) {
1747 if (AirportFindFreeHelipad(v, apc)) return;
1748 }
1750}
1751
1757typedef void AircraftStateHandler(Aircraft *v, const AirportFTAClass *apc);
1760 AircraftEventHandler_General, // TO_ALL = 0
1761 AircraftEventHandler_InHangar, // HANGAR = 1
1768 AircraftEventHandler_AtTerminal, // HELIPAD1 = 8
1769 AircraftEventHandler_AtTerminal, // HELIPAD2 = 9
1770 AircraftEventHandler_TakeOff, // TAKEOFF = 10
1771 AircraftEventHandler_StartTakeOff, // STARTTAKEOFF = 11
1772 AircraftEventHandler_EndTakeOff, // ENDTAKEOFF = 12
1773 AircraftEventHandler_HeliTakeOff, // HELITAKEOFF = 13
1774 AircraftEventHandler_Flying, // FLYING = 14
1775 AircraftEventHandler_Landing, // LANDING = 15
1776 AircraftEventHandler_EndLanding, // ENDLANDING = 16
1777 AircraftEventHandler_HeliLanding, // HELILANDING = 17
1778 AircraftEventHandler_HeliEndLanding, // HELIENDLANDING = 18
1779 AircraftEventHandler_AtTerminal, // TERM7 = 19
1780 AircraftEventHandler_AtTerminal, // TERM8 = 20
1781 AircraftEventHandler_AtTerminal, // HELIPAD3 = 21
1782};
1783
1784static void AirportClearBlock(const Aircraft *v, const AirportFTAClass *apc)
1785{
1786 /* we have left the previous block, and entered the new one. Free the previous block */
1787 if (apc->layout[v->previous_pos].blocks != apc->layout[v->pos].blocks) {
1789
1791 apc->layout[v->previous_pos].blocks == AirportBlock::RunwayIn) {
1792 return;
1793 }
1794
1795 st->airport.blocks.Reset(apc->layout[v->previous_pos].blocks);
1796 }
1797}
1798
1799static void AirportGoToNextPosition(Aircraft *v)
1800{
1801 /* if aircraft is not in position, wait until it is */
1802 if (!AircraftController(v)) return;
1803
1805
1806 AirportClearBlock(v, apc);
1807 AirportMove(v, apc); // move aircraft to next position
1808}
1809
1810/* gets pos from vehicle and next orders */
1811static bool AirportMove(Aircraft *v, const AirportFTAClass *apc)
1812{
1813 /* error handling */
1814 if (v->pos >= apc->nofelements) {
1815 Debug(misc, 0, "[Ap] position {} is not valid for current airport. Max position is {}", v->pos, apc->nofelements-1);
1816 assert(v->pos < apc->nofelements);
1817 }
1818
1819 const AirportFTA *current = &apc->layout[v->pos];
1820 /* we have arrived in an important state (eg terminal, hangar, etc.) */
1821 if (current->heading == v->state) {
1822 uint8_t prev_pos = v->pos; // location could be changed in state, so save it before-hand
1823 uint8_t prev_state = v->state;
1824 _aircraft_state_handlers[v->state](v, apc);
1825 if (v->state != FLYING) v->previous_pos = prev_pos;
1826 if (v->state != prev_state || v->pos != prev_pos) UpdateAircraftCache(v);
1827 return true;
1828 }
1829
1830 v->previous_pos = v->pos; // save previous location
1831
1832 /* there is only one choice to move to */
1833 if (current->next == nullptr) {
1834 if (AirportSetBlocks(v, current, apc)) {
1835 v->pos = current->next_position;
1837 } // move to next position
1838 return false;
1839 }
1840
1841 /* there are more choices to choose from, choose the one that
1842 * matches our heading */
1843 do {
1844 if (v->state == current->heading || current->heading == TO_ALL) {
1845 if (AirportSetBlocks(v, current, apc)) {
1846 v->pos = current->next_position;
1848 } // move to next position
1849 return false;
1850 }
1851 current = current->next.get();
1852 } while (current != nullptr);
1853
1854 Debug(misc, 0, "[Ap] cannot move further on Airport! (pos {} state {}) for vehicle {}", v->pos, v->state, v->index);
1855 NOT_REACHED();
1856}
1857
1859static bool AirportHasBlock(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc)
1860{
1861 const AirportFTA *reference = &apc->layout[v->pos];
1862 const AirportFTA *next = &apc->layout[current_pos->next_position];
1863
1864 /* same block, then of course we can move */
1865 if (apc->layout[current_pos->position].blocks != next->blocks) {
1866 const Station *st = Station::Get(v->targetairport);
1867 AirportBlocks blocks = next->blocks;
1868
1869 /* check additional possible extra blocks */
1870 if (current_pos != reference && current_pos->blocks != AirportBlock::Nothing) {
1871 blocks.Set(current_pos->blocks);
1872 }
1873
1874 if (st->airport.blocks.Any(blocks)) {
1875 v->cur_speed = 0;
1876 v->subspeed = 0;
1877 return true;
1878 }
1879 }
1880 return false;
1881}
1882
1890static bool AirportSetBlocks(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc)
1891{
1892 const AirportFTA *next = &apc->layout[current_pos->next_position];
1893 const AirportFTA *reference = &apc->layout[v->pos];
1894
1895 /* if the next position is in another block, check it and wait until it is free */
1896 if (!apc->layout[current_pos->position].blocks.All(next->blocks)) {
1897 AirportBlocks blocks = next->blocks;
1898 /* search for all all elements in the list with the same state, and blocks != N
1899 * this means more blocks should be checked/set */
1900 const AirportFTA *current = current_pos;
1901 if (current == reference) current = current->next.get();
1902 while (current != nullptr) {
1903 if (current->heading == current_pos->heading && current->blocks.Any()) {
1904 blocks.Set(current->blocks);
1905 break;
1906 }
1907 current = current->next.get();
1908 }
1909
1910 /* if the block to be checked is in the next position, then exclude that from
1911 * checking, because it has been set by the airplane before */
1912 if (current_pos->blocks == next->blocks) blocks.Flip(next->blocks);
1913
1915 if (st->airport.blocks.Any(blocks)) {
1916 v->cur_speed = 0;
1917 v->subspeed = 0;
1918 return false;
1919 }
1920
1921 if (next->blocks != AirportBlock::Nothing) {
1922 st->airport.blocks.Set(blocks); // occupy next block
1923 }
1924 }
1925 return true;
1926}
1927
1936
1951
1959static bool FreeTerminal(Aircraft *v, uint8_t i, uint8_t last_terminal)
1960{
1961 assert(last_terminal <= lengthof(_airport_terminal_mapping));
1963 for (; i < last_terminal; i++) {
1965 /* TERMINAL# HELIPAD# */
1966 v->state = _airport_terminal_mapping[i].state; // start moving to that terminal/helipad
1967 st->airport.blocks.Set(_airport_terminal_mapping[i].blocks); // occupy terminal/helipad
1968 return true;
1969 }
1970 }
1971 return false;
1972}
1973
1979static uint GetNumTerminals(const AirportFTAClass *apc)
1980{
1981 uint num = 0;
1982
1983 for (uint i = apc->terminals[0]; i > 0; i--) num += apc->terminals[i];
1984
1985 return num;
1986}
1987
1995{
1996 /* example of more terminalgroups
1997 * {0,HANGAR,AirportBlock::Nothing,1}, {0,TERMGROUP,AirportBlock::TermGroup1,0}, {0,TERMGROUP,TERM_GROUP2_ENTER_block,1}, {0,0,N,1},
1998 * Heading TERMGROUP denotes a group. We see 2 groups here:
1999 * 1. group 0 -- AirportBlock::TermGroup1 (check block)
2000 * 2. group 1 -- TERM_GROUP2_ENTER_block (check block)
2001 * First in line is checked first, group 0. If the block (AirportBlock::TermGroup1) is free, it
2002 * looks at the corresponding terminals of that group. If no free ones are found, other
2003 * possible groups are checked (in this case group 1, since that is after group 0). If that
2004 * fails, then attempt fails and plane waits
2005 */
2006 if (apc->terminals[0] > 1) {
2007 const Station *st = Station::Get(v->targetairport);
2008 const AirportFTA *temp = apc->layout[v->pos].next.get();
2009
2010 while (temp != nullptr) {
2011 if (temp->heading == TERMGROUP) {
2012 if (!st->airport.blocks.Any(temp->blocks)) {
2013 /* read which group do we want to go to?
2014 * (the first free group) */
2015 uint target_group = temp->next_position + 1;
2016
2017 /* at what terminal does the group start?
2018 * that means, sum up all terminals of
2019 * groups with lower number */
2020 uint group_start = 0;
2021 for (uint i = 1; i < target_group; i++) {
2022 group_start += apc->terminals[i];
2023 }
2024
2025 uint group_end = group_start + apc->terminals[target_group];
2026 if (FreeTerminal(v, group_start, group_end)) return true;
2027 }
2028 } else {
2029 /* once the heading isn't 255, we've exhausted the possible blocks.
2030 * So we cannot move */
2031 return false;
2032 }
2033 temp = temp->next.get();
2034 }
2035 }
2036
2037 /* if there is only 1 terminalgroup, all terminals are checked (starting from 0 to max) */
2038 return FreeTerminal(v, 0, GetNumTerminals(apc));
2039}
2040
2048{
2049 /* if an airport doesn't have helipads, use terminals */
2050 if (apc->num_helipads == 0) return AirportFindFreeTerminal(v, apc);
2051
2052 /* only 1 helicoptergroup, check all helipads
2053 * The blocks for helipads start after the last terminal (MAX_TERMINALS) */
2055}
2056
2062static void AircraftHandleDestTooFar(Aircraft *v, bool too_far)
2063{
2064 if (too_far) {
2065 if (!HasBit(v->flags, VAF_DEST_TOO_FAR)) {
2068 AI::NewEvent(v->owner, new ScriptEventAircraftDestTooFar(v->index));
2069 if (v->owner == _local_company) {
2070 /* Post a news message. */
2072 }
2073 }
2074 return;
2075 }
2076
2077 if (HasBit(v->flags, VAF_DEST_TOO_FAR)) {
2078 /* Not too far anymore, clear flag and message. */
2082 }
2083}
2084
2085static bool AircraftEventHandler(Aircraft *v, int loop)
2086{
2088 return HandleCrashedAircraft(v);
2089 }
2090
2091 if (v->vehstatus.Test(VehState::Stopped)) return true;
2092
2093 v->HandleBreakdown();
2094
2095 HandleAircraftSmoke(v, loop != 0);
2096 ProcessOrders(v);
2097 v->HandleLoading(loop != 0);
2098
2099 if (v->current_order.IsType(OT_LOADING) || v->current_order.IsType(OT_LEAVESTATION)) return true;
2100
2101 if (v->state >= ENDTAKEOFF && v->state <= HELIENDLANDING) {
2102 /* If we are flying, unconditionally clear the 'dest too far' state. */
2103 AircraftHandleDestTooFar(v, false);
2104 } else if (v->acache.cached_max_range_sqr != 0) {
2105 /* Check the distance to the next destination. This code works because the target
2106 * airport is only updated after take off and not on the ground. */
2108 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;
2109
2110 if (cur_st != nullptr && cur_st->airport.tile != INVALID_TILE && next_st != nullptr && next_st->airport.tile != INVALID_TILE) {
2111 uint dist = DistanceSquare(cur_st->airport.tile, next_st->airport.tile);
2113 }
2114 }
2115
2116 if (!HasBit(v->flags, VAF_DEST_TOO_FAR)) AirportGoToNextPosition(v);
2117
2118 return true;
2119}
2120
2122{
2123 if (!this->IsNormalAircraft()) return true;
2124
2126
2127 this->tick_counter++;
2128
2129 if (!this->vehstatus.Test(VehState::Stopped)) this->running_ticks++;
2130
2131 if (this->subtype == AIR_HELICOPTER) HelicopterTickHandler(this);
2132
2133 this->current_order_time++;
2134
2135 for (uint i = 0; i != 2; i++) {
2136 /* stop if the aircraft was deleted */
2137 if (!AircraftEventHandler(this, i)) return false;
2138 }
2139
2140 return true;
2141}
2142
2143
2151{
2152 assert(v->type == VEH_AIRCRAFT);
2153
2155 if (st == nullptr) return nullptr;
2156
2157 return st->airport.tile == INVALID_TILE ? nullptr : st;
2158}
2159
2165{
2166 /* only 1 station is updated per function call, so it is enough to get entry_point once */
2167 const AirportFTAClass *ap = st->airport.GetFTA();
2168 Direction rotation = st->airport.tile == INVALID_TILE ? DIR_N : st->airport.rotation;
2169
2170 for (Aircraft *v : Aircraft::Iterate()) {
2171 if (!v->IsNormalAircraft() || v->targetairport != st->index) continue;
2172 assert(v->state == FLYING);
2173
2174 Order *o = &v->current_order;
2175 /* The aircraft is heading to a hangar, but the new station doesn't have one,
2176 * or the aircraft can't land on the new station. Cancel current order. */
2177 if (o->IsType(OT_GOTO_DEPOT) && !(o->GetDepotOrderType() & ODTFB_PART_OF_ORDERS) && o->GetDestination() == st->index &&
2178 (!st->airport.HasHangar() || !CanVehicleUseStation(v, st))) {
2179 o->MakeDummy();
2181 }
2182 v->pos = v->previous_pos = AircraftGetEntryPoint(v, ap, rotation);
2184 }
2185
2186 /* Heliports don't have a hangar. Invalidate all go to hangar orders from all aircraft. */
2187 if (!st->airport.HasHangar()) RemoveOrderFromAllVehicles(OT_GOTO_DEPOT, st->index, true);
2188}
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.
uint16_t reliability_spd_dec
Speed of reliability decay between services (per day).
Definition engine_base.h:50
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:200
EngineFlags flags
Flags of the engine.
Definition engine_base.h:57
uint8_t original_image_index
Original vehicle image index, thus the image index of the overridden vehicle.
Definition engine_base.h:61
TimerGameCalendar::Date GetLifeLengthInDays() const
Returns the vehicle's (not model's!) life length in days.
Definition engine.cpp:442
CargoType GetDefaultCargoType() const
Determines the default cargo type of an engine.
Definition engine_base.h:95
uint16_t reliability
Current reliability of the engine.
Definition engine_base.h:49
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
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition sprites.h:1619
Base classes/functions for stations.
void ModifyStationRatingAround(TileIndex tile, Owner owner, int amount, uint radius)
Forcibly modify station ratings near a given tile.
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.
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.
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:2927
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:3046
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:3184
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:3276
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:3171
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3158
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