OpenTTD Source 20250328-master-gc3457cd4c0
aircraft_cmd.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
7
13#include "stdafx.h"
14#include "aircraft.h"
15#include "landscape.h"
16#include "news_func.h"
17#include "newgrf_engine.h"
18#include "newgrf_sound.h"
19#include "spritecache.h"
20#include "error_func.h"
21#include "strings_func.h"
22#include "command_func.h"
23#include "window_func.h"
26#include "vehicle_func.h"
27#include "sound_func.h"
28#include "cheat_type.h"
29#include "company_base.h"
30#include "ai/ai.hpp"
31#include "game/game.hpp"
32#include "company_func.h"
33#include "effectvehicle_func.h"
34#include "station_base.h"
35#include "engine_base.h"
36#include "core/random_func.hpp"
37#include "core/backup_type.hpp"
38#include "zoom_func.h"
39#include "disaster_vehicle.h"
40#include "newgrf_airporttiles.h"
41#include "framerate_type.h"
42#include "aircraft_cmd.h"
43#include "vehicle_cmd.h"
44
45#include "table/strings.h"
46
47#include "safeguards.h"
48
50{
51 this->x_offs = -1;
52 this->y_offs = -1;
53 this->x_extent = 2;
54 this->y_extent = 2;
55
56 switch (this->subtype) {
57 default: NOT_REACHED();
58
59 case AIR_AIRCRAFT:
60 case AIR_HELICOPTER:
61 switch (this->state) {
62 default: break;
63 case ENDTAKEOFF:
64 case LANDING:
65 case HELILANDING:
66 case FLYING:
67 this->x_extent = 24;
68 this->y_extent = 24;
69 break;
70 }
71 this->z_extent = 5;
72 break;
73
74 case AIR_SHADOW:
75 this->z_extent = 1;
76 this->x_offs = 0;
77 this->y_offs = 0;
78 break;
79
80 case AIR_ROTOR:
81 this->z_extent = 1;
82 break;
83 }
84}
85
86static bool AirportMove(Aircraft *v, const AirportFTAClass *apc);
87static bool AirportSetBlocks(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc);
88static bool AirportHasBlock(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc);
89static bool AirportFindFreeTerminal(Aircraft *v, const AirportFTAClass *apc);
90static bool AirportFindFreeHelipad(Aircraft *v, const AirportFTAClass *apc);
91static void CrashAirplane(Aircraft *v);
92
93static const SpriteID _aircraft_sprite[] = {
94 0x0EB5, 0x0EBD, 0x0EC5, 0x0ECD,
95 0x0ED5, 0x0EDD, 0x0E9D, 0x0EA5,
96 0x0EAD, 0x0EE5, 0x0F05, 0x0F0D,
97 0x0F15, 0x0F1D, 0x0F25, 0x0F2D,
98 0x0EED, 0x0EF5, 0x0EFD, 0x0F35,
99 0x0E9D, 0x0EA5, 0x0EAD, 0x0EB5,
100 0x0EBD, 0x0EC5
101};
102
103template <>
104bool IsValidImageIndex<VEH_AIRCRAFT>(uint8_t image_index)
105{
106 return image_index < lengthof(_aircraft_sprite);
107}
108
110enum HelicopterRotorStates : uint8_t {
111 HRS_ROTOR_STOPPED,
112 HRS_ROTOR_MOVING_1,
113 HRS_ROTOR_MOVING_2,
114 HRS_ROTOR_MOVING_3,
115};
116
125{
126 uint best = 0;
127 StationID index = StationID::Invalid();
128 TileIndex vtile = TileVirtXY(v->x_pos, v->y_pos);
129 const AircraftVehicleInfo *avi = AircraftVehInfo(v->engine_type);
130 uint max_range = v->acache.cached_max_range_sqr;
131
132 /* Determine destinations where it's coming from and where it's heading to */
133 const Station *last_dest = nullptr;
134 const Station *next_dest = nullptr;
135 if (max_range != 0) {
136 if (v->current_order.IsType(OT_GOTO_STATION) ||
137 (v->current_order.IsType(OT_GOTO_DEPOT) && (v->current_order.GetDepotActionType() & ODATFB_NEAREST_DEPOT) == 0)) {
139 next_dest = Station::GetIfValid(v->current_order.GetDestination().ToStationID());
140 } else {
141 last_dest = GetTargetAirportIfValid(v);
143 }
144 }
145
146 for (const Station *st : Station::Iterate()) {
147 if (st->owner != v->owner || !st->facilities.Test(StationFacility::Airport) || !st->airport.HasHangar()) continue;
148
149 const AirportFTAClass *afc = st->airport.GetFTA();
150
151 /* don't crash the plane if we know it can't land at the airport */
152 if (afc->flags.Test(AirportFTAClass::Flag::ShortStrip) && (avi->subtype & AIR_FAST) && !_cheats.no_jetcrash.value) continue;
153
154 /* the plane won't land at any helicopter station */
155 if (!afc->flags.Test(AirportFTAClass::Flag::Airplanes) && (avi->subtype & AIR_CTOL)) continue;
156
157 /* Check if our last and next destinations can be reached from the depot airport. */
158 if (max_range != 0) {
159 uint last_dist = (last_dest != nullptr && last_dest->airport.tile != INVALID_TILE) ? DistanceSquare(st->airport.tile, last_dest->airport.tile) : 0;
160 uint next_dist = (next_dest != nullptr && next_dest->airport.tile != INVALID_TILE) ? DistanceSquare(st->airport.tile, next_dest->airport.tile) : 0;
161 if (last_dist > max_range || next_dist > max_range) continue;
162 }
163
164 /* v->tile can't be used here, when aircraft is flying v->tile is set to 0 */
165 uint distance = DistanceSquare(vtile, st->airport.tile);
166 if (distance < best || index == StationID::Invalid()) {
167 best = distance;
168 index = st->index;
169 }
170 }
171 return index;
172}
173
174void Aircraft::GetImage(Direction direction, EngineImageType image_type, VehicleSpriteSeq *result) const
175{
176 uint8_t spritenum = this->spritenum;
177
178 if (is_custom_sprite(spritenum)) {
179 GetCustomVehicleSprite(this, direction, image_type, result);
180 if (result->IsValid()) return;
181
183 }
184
185 assert(IsValidImageIndex<VEH_AIRCRAFT>(spritenum));
186 result->Set(direction + _aircraft_sprite[spritenum]);
187}
188
189void GetRotorImage(const Aircraft *v, EngineImageType image_type, VehicleSpriteSeq *result)
190{
191 assert(v->subtype == AIR_HELICOPTER);
192
193 const Aircraft *w = v->Next()->Next();
194 if (is_custom_sprite(v->spritenum)) {
195 GetCustomRotorSprite(v, image_type, result);
196 if (result->IsValid()) return;
197 }
198
199 /* Return standard rotor sprites if there are no custom sprites for this helicopter */
200 result->Set(SPR_ROTOR_STOPPED + w->state);
201}
202
203static void GetAircraftIcon(EngineID engine, EngineImageType image_type, VehicleSpriteSeq *result)
204{
205 const Engine *e = Engine::Get(engine);
206 uint8_t spritenum = e->u.air.image_index;
207
208 if (is_custom_sprite(spritenum)) {
209 GetCustomVehicleIcon(engine, DIR_W, image_type, result);
210 if (result->IsValid()) return;
211
212 spritenum = e->original_image_index;
213 }
214
215 assert(IsValidImageIndex<VEH_AIRCRAFT>(spritenum));
216 result->Set(DIR_W + _aircraft_sprite[spritenum]);
217}
218
219void DrawAircraftEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
220{
222 GetAircraftIcon(engine, image_type, &seq);
223
224 Rect rect;
225 seq.GetBounds(&rect);
226 preferred_x = Clamp(preferred_x,
227 left - UnScaleGUI(rect.left),
228 right - UnScaleGUI(rect.right));
229
230 seq.Draw(preferred_x, y, pal, pal == PALETTE_CRASH);
231
232 if (!(AircraftVehInfo(engine)->subtype & AIR_CTOL)) {
233 VehicleSpriteSeq rotor_seq;
234 GetCustomRotorIcon(engine, image_type, &rotor_seq);
235 if (!rotor_seq.IsValid()) rotor_seq.Set(SPR_ROTOR_STOPPED);
236 rotor_seq.Draw(preferred_x, y - ScaleSpriteTrad(5), PAL_NONE, false);
237 }
238}
239
249void GetAircraftSpriteSize(EngineID engine, uint &width, uint &height, int &xoffs, int &yoffs, EngineImageType image_type)
250{
252 GetAircraftIcon(engine, image_type, &seq);
253
254 Rect rect;
255 seq.GetBounds(&rect);
256
257 width = UnScaleGUI(rect.Width());
258 height = UnScaleGUI(rect.Height());
259 xoffs = UnScaleGUI(rect.left);
260 yoffs = UnScaleGUI(rect.top);
261}
262
272{
273 const AircraftVehicleInfo *avi = &e->u.air;
274 const Station *st = Station::GetByTile(tile);
275
276 /* Prevent building aircraft types at places which can't handle them */
277 if (!CanVehicleUseStation(e->index, st)) return CMD_ERROR;
278
279 /* Make sure all aircraft end up in the first tile of the hangar. */
280 tile = st->airport.GetHangarTile(st->airport.GetHangarNum(tile));
281
282 if (flags.Test(DoCommandFlag::Execute)) {
283 Aircraft *v = new Aircraft(); // aircraft
284 Aircraft *u = new Aircraft(); // shadow
285 *ret = v;
286
287 v->direction = DIR_SE;
288
289 v->owner = u->owner = _current_company;
290
291 v->tile = tile;
292
293 uint x = TileX(tile) * TILE_SIZE + 5;
294 uint y = TileY(tile) * TILE_SIZE + 3;
295
296 v->x_pos = u->x_pos = x;
297 v->y_pos = u->y_pos = y;
298
299 u->z_pos = GetSlopePixelZ(x, y);
300 v->z_pos = u->z_pos + 1;
301
304
305 v->spritenum = avi->image_index;
306
308 v->refit_cap = 0;
309 u->refit_cap = 0;
310
312 assert(IsValidCargoType(v->cargo_type));
313
314 CargoType mail = GetCargoTypeByLabel(CT_MAIL);
315 if (IsValidCargoType(mail)) {
316 u->cargo_type = mail;
317 u->cargo_cap = avi->mail_capacity;
318 }
319
320 v->name.clear();
321 v->last_station_visited = StationID::Invalid();
322 v->last_loading_station = StationID::Invalid();
323
324 v->acceleration = avi->acceleration;
325 v->engine_type = e->index;
326 u->engine_type = e->index;
327
329 v->UpdateDeltaXY();
330
331 u->subtype = AIR_SHADOW;
332 u->UpdateDeltaXY();
333
334 v->reliability = e->reliability;
337
338 v->pos = GetVehiclePosOnBuild(tile);
339
340 v->state = HANGAR;
341 v->previous_pos = v->pos;
343 v->SetNext(u);
344
345 v->SetServiceInterval(Company::Get(_current_company)->settings.vehicle.servint_aircraft);
346
350
351 v->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
352 u->sprite_cache.sprite_seq.Set(SPR_IMG_QUERY);
353
354 v->random_bits = Random();
355 u->random_bits = Random();
356
357 v->vehicle_flags = {};
359 v->SetServiceIntervalIsPercent(Company::Get(_current_company)->settings.vehicle.servint_ispercent);
360
362
363 v->cargo_cap = e->DetermineCapacity(v, &u->cargo_cap);
364
366
367 UpdateAircraftCache(v, true);
368
369 v->UpdatePosition();
370 u->UpdatePosition();
371
372 /* Aircraft with 3 vehicles (chopper)? */
373 if (v->subtype == AIR_HELICOPTER) {
374 Aircraft *w = new Aircraft();
375 w->engine_type = e->index;
376 w->direction = DIR_N;
378 w->x_pos = v->x_pos;
379 w->y_pos = v->y_pos;
380 w->z_pos = v->z_pos + ROTOR_Z_OFFSET;
382 w->spritenum = 0xFF;
383 w->subtype = AIR_ROTOR;
384 w->sprite_cache.sprite_seq.Set(SPR_ROTOR_STOPPED);
385 w->random_bits = Random();
386 /* Use rotor's air.state to store the rotor animation frame */
387 w->state = HRS_ROTOR_STOPPED;
388 w->UpdateDeltaXY();
389
390 u->SetNext(w);
391 w->UpdatePosition();
392 }
393 }
394
395 return CommandCost();
396}
397
398
400{
401 const Station *st = GetTargetAirportIfValid(this);
402 /* If the station is not a valid airport or if it has no hangars */
403 if (st == nullptr || !CanVehicleUseStation(this, st) || !st->airport.HasHangar()) {
404 /* the aircraft has to search for a hangar on its own */
405 StationID station = FindNearestHangar(this);
406
407 if (station == StationID::Invalid()) return ClosestDepot();
408
409 st = Station::Get(station);
410 }
411
412 return ClosestDepot(st->xy, st->index);
413}
414
415static void CheckIfAircraftNeedsService(Aircraft *v)
416{
417 if (Company::Get(v->owner)->settings.vehicle.servint_aircraft == 0 || !v->NeedsAutomaticServicing()) return;
418 if (v->IsChainInDepot()) {
420 return;
421 }
422
423 /* When we're parsing conditional orders and the like
424 * we don't want to consider going to a depot too. */
425 if (!v->current_order.IsType(OT_GOTO_DEPOT) && !v->current_order.IsType(OT_GOTO_STATION)) return;
426
427 const Station *st = Station::Get(v->current_order.GetDestination().ToStationID());
428
429 assert(st != nullptr);
430
431 /* only goto depot if the target airport has a depot */
432 if (st->airport.HasHangar() && CanVehicleUseStation(v, st)) {
435 } else if (v->current_order.IsType(OT_GOTO_DEPOT)) {
438 }
439}
440
442{
443 const Engine *e = this->GetEngine();
444 uint cost_factor = GetVehicleProperty(this, PROP_AIRCRAFT_RUNNING_COST_FACTOR, e->u.air.running_cost);
445 return GetPrice(PR_RUNNING_AIRCRAFT, cost_factor, e->GetGRF());
446}
447
450{
451 if (!this->IsNormalAircraft()) return;
452 AgeVehicle(this);
453}
454
457{
458 if (!this->IsNormalAircraft()) return;
459 EconomyAgeVehicle(this);
460
461 if ((++this->day_counter & 7) == 0) DecreaseVehicleValue(this);
462
463 CheckOrders(this);
464
465 CheckVehicleBreakdown(this);
466 CheckIfAircraftNeedsService(this);
467
468 if (this->running_ticks == 0) return;
469
471
472 this->profit_this_year -= cost.GetCost();
473 this->running_ticks = 0;
474
476
479}
480
481static void HelicopterTickHandler(Aircraft *v)
482{
483 Aircraft *u = v->Next()->Next();
484
485 if (u->vehstatus.Test(VehState::Hidden)) return;
486
487 /* if true, helicopter rotors do not rotate. This should only be the case if a helicopter is
488 * loading/unloading at a terminal or stopped */
489 if (v->current_order.IsType(OT_LOADING) || v->vehstatus.Test(VehState::Stopped)) {
490 if (u->cur_speed != 0) {
491 u->cur_speed++;
492 if (u->cur_speed >= 0x80 && u->state == HRS_ROTOR_MOVING_3) {
493 u->cur_speed = 0;
494 }
495 }
496 } else {
497 if (u->cur_speed == 0) {
498 u->cur_speed = 0x70;
499 }
500 if (u->cur_speed >= 0x50) {
501 u->cur_speed--;
502 }
503 }
504
505 int tick = ++u->tick_counter;
506 int spd = u->cur_speed >> 4;
507
509 if (spd == 0) {
510 u->state = HRS_ROTOR_STOPPED;
511 GetRotorImage(v, EIT_ON_MAP, &seq);
512 if (u->sprite_cache.sprite_seq == seq) return;
513 } else if (tick >= spd) {
514 u->tick_counter = 0;
515 u->state++;
516 if (u->state > HRS_ROTOR_MOVING_3) u->state = HRS_ROTOR_MOVING_1;
517 GetRotorImage(v, EIT_ON_MAP, &seq);
518 } else {
519 return;
520 }
521
522 u->sprite_cache.sprite_seq = seq;
523
525}
526
534void SetAircraftPosition(Aircraft *v, int x, int y, int z)
535{
536 v->x_pos = x;
537 v->y_pos = y;
538 v->z_pos = z;
539
540 v->UpdatePosition();
541 v->UpdateViewport(true, false);
542 if (v->subtype == AIR_HELICOPTER) {
543 GetRotorImage(v, EIT_ON_MAP, &v->Next()->Next()->sprite_cache.sprite_seq);
544 }
545
546 Aircraft *u = v->Next();
547
548 int safe_x = Clamp(x, 0, Map::MaxX() * TILE_SIZE);
549 int safe_y = Clamp(y - 1, 0, Map::MaxY() * TILE_SIZE);
550 u->x_pos = x;
551 u->y_pos = y - ((v->z_pos - GetSlopePixelZ(safe_x, safe_y)) >> 3);
552
553 safe_y = Clamp(u->y_pos, 0, Map::MaxY() * TILE_SIZE);
554 u->z_pos = GetSlopePixelZ(safe_x, safe_y);
555 u->sprite_cache.sprite_seq.CopyWithoutPalette(v->sprite_cache.sprite_seq); // the shadow is never coloured
556
558
559 u = u->Next();
560 if (u != nullptr) {
561 u->x_pos = x;
562 u->y_pos = y;
563 u->z_pos = z + ROTOR_Z_OFFSET;
564
566 }
567}
568
574{
575 v->subspeed = 0;
576 v->progress = 0;
577
578 Aircraft *u = v->Next();
580 u = u->Next();
581 if (u != nullptr) {
583 u->cur_speed = 0;
584 }
585
586 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
587}
588
589static void PlayAircraftSound(const Vehicle *v)
590{
591 if (!PlayVehicleSound(v, VSE_START)) {
592 SndPlayVehicleFx(AircraftVehInfo(v->engine_type)->sfx, v);
593 }
594}
595
596
603void UpdateAircraftCache(Aircraft *v, bool update_range)
604{
605 uint max_speed = GetVehicleProperty(v, PROP_AIRCRAFT_SPEED, 0);
606 if (max_speed != 0) {
607 /* Convert from original units to km-ish/h */
608 max_speed = (max_speed * 128) / 10;
609
610 v->vcache.cached_max_speed = max_speed;
611 } else {
612 /* Use the default max speed of the vehicle. */
613 v->vcache.cached_max_speed = AircraftVehInfo(v->engine_type)->max_speed;
614 }
615
616 /* Update cargo aging period. */
618 Aircraft *u = v->Next(); // Shadow for mail
620
621 /* Update aircraft range. */
622 if (update_range) {
623 v->acache.cached_max_range = GetVehicleProperty(v, PROP_AIRCRAFT_RANGE, AircraftVehInfo(v->engine_type)->max_range);
624 /* Squared it now so we don't have to do it later all the time. */
625 v->acache.cached_max_range_sqr = v->acache.cached_max_range * v->acache.cached_max_range;
626 }
627}
628
629
633static constexpr uint16_t SPEED_LIMIT_TAXI = 50;
634static constexpr uint16_t SPEED_LIMIT_APPROACH = 230;
635static constexpr uint16_t SPEED_LIMIT_BROKEN = 320;
636static constexpr uint16_t SPEED_LIMIT_HOLD = 425;
637static constexpr uint16_t SPEED_LIMIT_NONE = UINT16_MAX;
638
646static int UpdateAircraftSpeed(Aircraft *v, uint speed_limit = SPEED_LIMIT_NONE, bool hard_limit = true)
647{
655 uint spd = v->acceleration * 77;
656 uint8_t t;
657
658 /* Adjust speed limits by plane speed factor to prevent taxiing
659 * and take-off speeds being too low. */
660 speed_limit *= _settings_game.vehicle.plane_speed;
661
662 /* adjust speed for broken vehicles */
664 if (SPEED_LIMIT_BROKEN < speed_limit) hard_limit = false;
665 speed_limit = std::min<uint>(speed_limit, SPEED_LIMIT_BROKEN);
666 }
667
668 if (v->vcache.cached_max_speed < speed_limit) {
669 if (v->cur_speed < speed_limit) hard_limit = false;
670 speed_limit = v->vcache.cached_max_speed;
671 }
672
673 v->subspeed = (t = v->subspeed) + (uint8_t)spd;
674
675 /* Aircraft's current speed is used twice so that very fast planes are
676 * forced to slow down rapidly in the short distance needed. The magic
677 * value 16384 was determined to give similar results to the old speed/48
678 * method at slower speeds. This also results in less reduction at slow
679 * speeds to that aircraft do not get to taxi speed straight after
680 * touchdown. */
681 if (!hard_limit && v->cur_speed > speed_limit) {
682 speed_limit = v->cur_speed - std::max(1, ((v->cur_speed * v->cur_speed) / 16384) / _settings_game.vehicle.plane_speed);
683 }
684
685 spd = std::min(v->cur_speed + (spd >> 8) + (v->subspeed < t), speed_limit);
686
687 /* updates statusbar only if speed have changed to save CPU time */
688 if (spd != v->cur_speed) {
689 v->cur_speed = spd;
691 }
692
693 /* Adjust distance moved by plane speed setting */
695
696 /* Convert direction-independent speed into direction-dependent speed. (old movement method) */
697 spd = v->GetOldAdvanceSpeed(spd);
698
699 spd += v->progress;
700 v->progress = (uint8_t)spd;
701 return spd >> 8;
702}
703
712{
713 int safe_x = Clamp(v->x_pos, 0, Map::MaxX() * TILE_SIZE);
714 int safe_y = Clamp(v->y_pos, 0, Map::MaxY() * TILE_SIZE);
715 return TileHeight(TileVirtXY(safe_x, safe_y)) * TILE_HEIGHT;
716}
717
728void GetAircraftFlightLevelBounds(const Vehicle *v, int *min_level, int *max_level)
729{
730 int base_altitude = GetTileHeightBelowAircraft(v);
733 }
734
735 /* Make sure eastbound and westbound planes do not "crash" into each
736 * other by providing them with vertical separation
737 */
738 switch (v->direction) {
739 case DIR_N:
740 case DIR_NE:
741 case DIR_E:
742 case DIR_SE:
743 base_altitude += 10;
744 break;
745
746 default: break;
747 }
748
749 /* Make faster planes fly higher so that they can overtake slower ones */
750 base_altitude += std::min(20 * (v->vcache.cached_max_speed / 200) - 90, 0);
751
752 if (min_level != nullptr) *min_level = base_altitude + AIRCRAFT_MIN_FLYING_ALTITUDE;
753 if (max_level != nullptr) *max_level = base_altitude + AIRCRAFT_MAX_FLYING_ALTITUDE;
754}
755
764{
765 int tile_height = GetTileHeightBelowAircraft(v);
766
768}
769
770template <class T>
771int GetAircraftFlightLevel(T *v, bool takeoff)
772{
773 /* Aircraft is in flight. We want to enforce it being somewhere
774 * between the minimum and the maximum allowed altitude. */
775 int aircraft_min_altitude;
776 int aircraft_max_altitude;
777 GetAircraftFlightLevelBounds(v, &aircraft_min_altitude, &aircraft_max_altitude);
778 int aircraft_middle_altitude = (aircraft_min_altitude + aircraft_max_altitude) / 2;
779
780 /* If those assumptions would be violated, aircraft would behave fairly strange. */
781 assert(aircraft_min_altitude < aircraft_middle_altitude);
782 assert(aircraft_middle_altitude < aircraft_max_altitude);
783
784 int z = v->z_pos;
785 if (z < aircraft_min_altitude ||
786 (HasBit(v->flags, VAF_IN_MIN_HEIGHT_CORRECTION) && z < aircraft_middle_altitude)) {
787 /* Ascend. And don't fly into that mountain right ahead.
788 * And avoid our aircraft become a stairclimber, so if we start
789 * correcting altitude, then we stop correction not too early. */
791 z += takeoff ? 2 : 1;
792 } else if (!takeoff && (z > aircraft_max_altitude ||
793 (HasBit(v->flags, VAF_IN_MAX_HEIGHT_CORRECTION) && z > aircraft_middle_altitude))) {
794 /* Descend lower. You are an aircraft, not an space ship.
795 * And again, don't stop correcting altitude too early. */
797 z--;
798 } else if (HasBit(v->flags, VAF_IN_MIN_HEIGHT_CORRECTION) && z >= aircraft_middle_altitude) {
799 /* Now, we have corrected altitude enough. */
801 } else if (HasBit(v->flags, VAF_IN_MAX_HEIGHT_CORRECTION) && z <= aircraft_middle_altitude) {
802 /* Now, we have corrected altitude enough. */
804 }
805
806 return z;
807}
808
809template int GetAircraftFlightLevel(DisasterVehicle *v, bool takeoff);
810template int GetAircraftFlightLevel(Aircraft *v, bool takeoff);
811
826static uint8_t AircraftGetEntryPoint(const Aircraft *v, const AirportFTAClass *apc, Direction rotation)
827{
828 assert(v != nullptr);
829 assert(apc != nullptr);
830
831 /* In the case the station doesn't exit anymore, set target tile 0.
832 * It doesn't hurt much, aircraft will go to next order, nearest hangar
833 * or it will simply crash in next tick */
834 TileIndex tile{};
835
837 if (st != nullptr) {
838 /* Make sure we don't go to INVALID_TILE if the airport has been removed. */
839 tile = (st->airport.tile != INVALID_TILE) ? st->airport.tile : st->xy;
840 }
841
842 int delta_x = v->x_pos - TileX(tile) * TILE_SIZE;
843 int delta_y = v->y_pos - TileY(tile) * TILE_SIZE;
844
845 DiagDirection dir;
846 if (abs(delta_y) < abs(delta_x)) {
847 /* We are northeast or southwest of the airport */
848 dir = delta_x < 0 ? DIAGDIR_NE : DIAGDIR_SW;
849 } else {
850 /* We are northwest or southeast of the airport */
851 dir = delta_y < 0 ? DIAGDIR_NW : DIAGDIR_SE;
852 }
854 return apc->entry_points[dir];
855}
856
857
858static void MaybeCrashAirplane(Aircraft *v);
859
868{
869 /* nullptr if station is invalid */
871 /* INVALID_TILE if there is no station */
872 TileIndex tile = INVALID_TILE;
873 Direction rotation = DIR_N;
874 uint size_x = 1, size_y = 1;
875 if (st != nullptr) {
876 if (st->airport.tile != INVALID_TILE) {
877 tile = st->airport.tile;
878 rotation = st->airport.rotation;
879 size_x = st->airport.w;
880 size_y = st->airport.h;
881 } else {
882 tile = st->xy;
883 }
884 }
885 /* DUMMY if there is no station or no airport */
886 const AirportFTAClass *afc = tile == INVALID_TILE ? GetAirport(AT_DUMMY) : st->airport.GetFTA();
887
888 /* prevent going to INVALID_TILE if airport is deleted. */
889 if (st == nullptr || st->airport.tile == INVALID_TILE) {
890 /* Jump into our "holding pattern" state machine if possible */
891 if (v->pos >= afc->nofelements) {
892 v->pos = v->previous_pos = AircraftGetEntryPoint(v, afc, DIR_N);
893 } else if (v->targetairport != v->current_order.GetDestination()) {
894 /* If not possible, just get out of here fast */
895 v->state = FLYING;
898 /* get aircraft back on running altitude */
899 SetAircraftPosition(v, v->x_pos, v->y_pos, GetAircraftFlightLevel(v));
900 return false;
901 }
902 }
903
904 /* get airport moving data */
905 const AirportMovingData amd = RotateAirportMovingData(afc->MovingData(v->pos), rotation, size_x, size_y);
906
907 int x = TileX(tile) * TILE_SIZE;
908 int y = TileY(tile) * TILE_SIZE;
909
910 /* Helicopter raise */
912 Aircraft *u = v->Next()->Next();
913
914 /* Make sure the rotors don't rotate too fast */
915 if (u->cur_speed > 32) {
916 v->cur_speed = 0;
917 if (--u->cur_speed == 32) {
918 if (!PlayVehicleSound(v, VSE_START)) {
919 SoundID sfx = AircraftVehInfo(v->engine_type)->sfx;
920 /* For compatibility with old NewGRF we ignore the sfx property, unless a NewGRF-defined sound is used.
921 * The baseset has only one helicopter sound, so this only limits using plane or cow sounds. */
923 SndPlayVehicleFx(sfx, v);
924 }
925 }
926 } else {
927 u->cur_speed = 32;
928 int count = UpdateAircraftSpeed(v);
929 if (count > 0) {
930 v->tile = TileIndex{};
931
932 int z_dest;
933 GetAircraftFlightLevelBounds(v, &z_dest, nullptr);
934
935 /* Reached altitude? */
936 if (v->z_pos >= z_dest) {
937 v->cur_speed = 0;
938 return true;
939 }
940 SetAircraftPosition(v, v->x_pos, v->y_pos, std::min(v->z_pos + count, z_dest));
941 }
942 }
943 return false;
944 }
945
946 /* Helicopter landing. */
949
950 if (st == nullptr) {
951 v->state = FLYING;
954 return false;
955 }
956
957 /* Vehicle is now at the airport.
958 * Helicopter has arrived at the target landing pad, so the current position is also where it should land.
959 * Except for Oilrigs which are special due to being a 1x1 station, and helicopters land outside it. */
960 if (st->airport.type != AT_OILRIG) {
961 x = v->x_pos;
962 y = v->y_pos;
963 tile = TileVirtXY(x, y);
964 }
965 v->tile = tile;
966
967 /* Find altitude of landing position. */
968 int z = GetSlopePixelZ(x, y) + 1 + afc->delta_z;
969
970 if (z == v->z_pos) {
971 Vehicle *u = v->Next()->Next();
972
973 /* Increase speed of rotors. When speed is 80, we've landed. */
974 if (u->cur_speed >= 80) {
976 return true;
977 }
978 u->cur_speed += 4;
979 } else {
980 int count = UpdateAircraftSpeed(v);
981 if (count > 0) {
982 if (v->z_pos > z) {
983 SetAircraftPosition(v, v->x_pos, v->y_pos, std::max(v->z_pos - count, z));
984 } else {
985 SetAircraftPosition(v, v->x_pos, v->y_pos, std::min(v->z_pos + count, z));
986 }
987 }
988 }
989 return false;
990 }
991
992 /* Get distance from destination pos to current pos. */
993 uint dist = abs(x + amd.x - v->x_pos) + abs(y + amd.y - v->y_pos);
994
995 /* Need exact position? */
996 if (!amd.flags.Test(AirportMovingDataFlag::ExactPosition) && dist <= (amd.flags.Test(AirportMovingDataFlag::SlowTurn) ? 8U : 4U)) return true;
997
998 /* At final pos? */
999 if (dist == 0) {
1000 /* Change direction smoothly to final direction. */
1001 DirDiff dirdiff = DirDifference(amd.direction, v->direction);
1002 /* if distance is 0, and plane points in right direction, no point in calling
1003 * UpdateAircraftSpeed(). So do it only afterwards */
1004 if (dirdiff == DIRDIFF_SAME) {
1005 v->cur_speed = 0;
1006 return true;
1007 }
1008
1009 if (!UpdateAircraftSpeed(v, SPEED_LIMIT_TAXI)) return false;
1010
1012 v->cur_speed >>= 1;
1013
1014 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1015 return false;
1016 }
1017
1020 if (v->vehstatus.Test(VehState::Crashed)) return false;
1021 }
1022
1023 uint speed_limit = SPEED_LIMIT_TAXI;
1024 bool hard_limit = true;
1025
1027 if (amd.flags.Test(AirportMovingDataFlag::Hold)) { speed_limit = SPEED_LIMIT_HOLD; hard_limit = false; }
1028 if (amd.flags.Test(AirportMovingDataFlag::Land)) { speed_limit = SPEED_LIMIT_APPROACH; hard_limit = false; }
1029 if (amd.flags.Test(AirportMovingDataFlag::Brake)) { speed_limit = SPEED_LIMIT_TAXI; hard_limit = false; }
1030
1031 int count = UpdateAircraftSpeed(v, speed_limit, hard_limit);
1032 if (count == 0) return false;
1033
1034 /* If the plane will be a few subpixels away from the destination after
1035 * this movement loop, start nudging it towards the exact position for
1036 * the whole loop. Otherwise, heavily depending on the speed of the plane,
1037 * it is possible we totally overshoot the target, causing the plane to
1038 * make a loop, and trying again, and again, and again .. */
1039 bool nudge_towards_target = static_cast<uint>(count) + 3 > dist;
1040
1041 if (v->turn_counter != 0) v->turn_counter--;
1042
1043 do {
1044
1046
1047 if (nudge_towards_target || amd.flags.Test(AirportMovingDataFlag::Land)) {
1048 /* move vehicle one pixel towards target */
1049 gp.x = (v->x_pos != (x + amd.x)) ?
1050 v->x_pos + ((x + amd.x > v->x_pos) ? 1 : -1) :
1051 v->x_pos;
1052 gp.y = (v->y_pos != (y + amd.y)) ?
1053 v->y_pos + ((y + amd.y > v->y_pos) ? 1 : -1) :
1054 v->y_pos;
1055
1056 /* Oilrigs must keep v->tile as st->airport.tile, since the landing pad is in a non-airport tile */
1057 gp.new_tile = (st->airport.type == AT_OILRIG) ? st->airport.tile : TileVirtXY(gp.x, gp.y);
1058
1059 } else {
1060
1061 /* Turn. Do it slowly if in the air. */
1062 Direction newdir = GetDirectionTowards(v, x + amd.x, y + amd.y);
1063 if (newdir != v->direction) {
1065 if (v->turn_counter == 0 || newdir == v->last_direction) {
1066 if (newdir == v->last_direction) {
1068 } else {
1070 }
1072 v->last_direction = v->direction;
1073 v->direction = newdir;
1074 }
1075
1076 /* Move vehicle. */
1077 gp = GetNewVehiclePos(v);
1078 } else {
1079 v->cur_speed >>= 1;
1080 v->direction = newdir;
1081
1082 /* When leaving a terminal an aircraft often goes to a position
1083 * directly in front of it. If it would move while turning it
1084 * would need an two extra turns to end up at the correct position.
1085 * To make it easier just disallow all moving while turning as
1086 * long as an aircraft is on the ground. */
1087 gp.x = v->x_pos;
1088 gp.y = v->y_pos;
1089 gp.new_tile = gp.old_tile = v->tile;
1090 }
1091 } else {
1093 /* Move vehicle. */
1094 gp = GetNewVehiclePos(v);
1095 }
1096 }
1097
1098 v->tile = gp.new_tile;
1099 /* If vehicle is in the air, use tile coordinate 0. */
1100 if (amd.flags.Any({AirportMovingDataFlag::Takeoff, AirportMovingDataFlag::SlowTurn, AirportMovingDataFlag::Land})) v->tile = TileIndex{};
1101
1102 /* Adjust Z for land or takeoff? */
1103 int z = v->z_pos;
1104
1106 z = GetAircraftFlightLevel(v, true);
1107 } else if (amd.flags.Test(AirportMovingDataFlag::Hold)) {
1108 /* Let the plane drop from normal flight altitude to holding pattern altitude */
1109 if (z > GetAircraftHoldMaxAltitude(v)) z--;
1110 } else if (amd.flags.All({AirportMovingDataFlag::SlowTurn, AirportMovingDataFlag::NoSpeedClamp})) {
1111 z = GetAircraftFlightLevel(v);
1112 }
1113
1114 /* NewGRF airports (like a rotated intercontinental from OpenGFX+Airports) can be non-rectangular
1115 * and their primary (north-most) tile does not have to be part of the airport.
1116 * As such, the height of the primary tile can be different from the rest of the airport.
1117 * Given we are landing/breaking, and as such are not a helicopter, we know that there has to be a hangar.
1118 * We also know that the airport itself has to be completely flat (otherwise it is not a valid airport).
1119 * Therefore, use the height of this hangar to calculate our z-value. */
1120 int airport_z = v->z_pos;
1121 if (amd.flags.Any({AirportMovingDataFlag::Land, AirportMovingDataFlag::Brake}) && st != nullptr) {
1122 assert(st->airport.HasHangar());
1123 TileIndex hangar_tile = st->airport.GetHangarTile(0);
1124 airport_z = GetTileMaxPixelZ(hangar_tile) + 1; // To avoid clashing with the shadow
1125 }
1126
1128 if (st->airport.tile == INVALID_TILE) {
1129 /* Airport has been removed, abort the landing procedure */
1130 v->state = FLYING;
1133 /* get aircraft back on running altitude */
1134 SetAircraftPosition(v, gp.x, gp.y, GetAircraftFlightLevel(v));
1135 continue;
1136 }
1137
1138 /* We're not flying below our destination, right? */
1139 assert(airport_z <= z);
1140 int t = std::max(1U, dist - 4);
1141 int delta = z - airport_z;
1142
1143 /* Only start lowering when we're sufficiently close for a 1:1 glide */
1144 if (delta >= t) {
1145 z -= CeilDiv(z - airport_z, t);
1146 }
1147 if (z < airport_z) z = airport_z;
1148 }
1149
1150 /* We've landed. Decrease speed when we're reaching end of runway. */
1152
1153 if (z > airport_z) {
1154 z--;
1155 } else if (z < airport_z) {
1156 z++;
1157 }
1158
1159 }
1160
1161 SetAircraftPosition(v, gp.x, gp.y, z);
1162 } while (--count != 0);
1163 return false;
1164}
1165
1171{
1172 v->crashed_counter += 3;
1173
1175
1176 /* make aircraft crash down to the ground */
1177 if (v->crashed_counter < 500 && st == nullptr && ((v->crashed_counter % 3) == 0) ) {
1178 int z = GetSlopePixelZ(Clamp(v->x_pos, 0, Map::MaxX() * TILE_SIZE), Clamp(v->y_pos, 0, Map::MaxY() * TILE_SIZE));
1179 v->z_pos -= 1;
1180 if (v->z_pos <= z) {
1181 v->crashed_counter = 500;
1182 v->z_pos = z + 1;
1183 } else {
1184 v->crashed_counter = 0;
1185 }
1186 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1187 }
1188
1189 if (v->crashed_counter < 650) {
1190 uint32_t r;
1191 if (Chance16R(1, 32, r)) {
1192 static const DirDiff delta[] = {
1194 };
1195
1196 v->direction = ChangeDir(v->direction, delta[GB(r, 16, 2)]);
1197 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1198 r = Random();
1200 GB(r, 0, 4) - 4,
1201 GB(r, 4, 4) - 4,
1202 GB(r, 8, 4),
1204 }
1205 } else if (v->crashed_counter >= 10000) {
1206 /* remove rubble of crashed airplane */
1207
1208 /* clear runway-in on all airports, set by crashing plane
1209 * small airports use AIRPORT_BUSY, city airports use AirportBlock::RunwayInOut, etc.
1210 * but they all share the same number */
1211 if (st != nullptr) {
1212 st->airport.blocks.Reset(AirportBlock::RunwayIn);
1213 st->airport.blocks.Reset(AirportBlock::RunwayInOut); // commuter airport
1214 st->airport.blocks.Reset(AirportBlock::RunwayIn2); // intercontinental
1215 }
1216
1217 delete v;
1218
1219 return false;
1220 }
1221
1222 return true;
1223}
1224
1225
1231static void HandleAircraftSmoke(Aircraft *v, bool mode)
1232{
1233 static const struct {
1234 int8_t x;
1235 int8_t y;
1236 } smoke_pos[] = {
1237 { 5, 5 },
1238 { 6, 0 },
1239 { 5, -5 },
1240 { 0, -6 },
1241 { -5, -5 },
1242 { -6, 0 },
1243 { -5, 5 },
1244 { 0, 6 }
1245 };
1246
1247 if (!v->vehstatus.Test(VehState::AircraftBroken)) return;
1248
1249 /* Stop smoking when landed */
1250 if (v->cur_speed < 10) {
1252 v->breakdown_ctr = 0;
1253 return;
1254 }
1255
1256 /* Spawn effect et most once per Tick, i.e. !mode */
1257 if (!mode && (v->tick_counter & 0x0F) == 0) {
1259 smoke_pos[v->direction].x,
1260 smoke_pos[v->direction].y,
1261 2,
1263 );
1264 }
1265}
1266
1267void HandleMissingAircraftOrders(Aircraft *v)
1268{
1269 /*
1270 * We do not have an order. This can be divided into two cases:
1271 * 1) we are heading to an invalid station. In this case we must
1272 * find another airport to go to. If there is nowhere to go,
1273 * we will destroy the aircraft as it otherwise will enter
1274 * the holding pattern for the first airport, which can cause
1275 * the plane to go into an undefined state when building an
1276 * airport with the same StationID.
1277 * 2) we are (still) heading to a (still) valid airport, then we
1278 * can continue going there. This can happen when you are
1279 * changing the aircraft's orders while in-flight or in for
1280 * example a depot. However, when we have a current order to
1281 * go to a depot, we have to keep that order so the aircraft
1282 * actually stops.
1283 */
1284 const Station *st = GetTargetAirportIfValid(v);
1285 if (st == nullptr) {
1286 Backup<CompanyID> cur_company(_current_company, v->owner);
1288 cur_company.Restore();
1289
1290 if (ret.Failed()) CrashAirplane(v);
1291 } else if (!v->current_order.IsType(OT_GOTO_DEPOT)) {
1292 v->current_order.Free();
1293 }
1294}
1295
1296
1298{
1299 /* Orders are changed in flight, ensure going to the right station. */
1300 if (this->state == FLYING) {
1302 }
1303
1304 /* Aircraft do not use dest-tile */
1305 return TileIndex{};
1306}
1307
1309{
1310 this->colourmap = PAL_NONE;
1311 this->UpdateViewport(true, false);
1312 if (this->subtype == AIR_HELICOPTER) {
1313 GetRotorImage(this, EIT_ON_MAP, &this->Next()->Next()->sprite_cache.sprite_seq);
1314 }
1315}
1316
1317
1318uint Aircraft::Crash(bool flooded)
1319{
1320 uint victims = Vehicle::Crash(flooded) + 2; // pilots
1321 this->crashed_counter = flooded ? 9000 : 0; // max 10000, disappear pretty fast when flooded
1322
1323 return victims;
1324}
1325
1331{
1333
1334 uint victims = v->Crash();
1335
1336 v->cargo.Truncate();
1337 v->Next()->cargo.Truncate();
1338 const Station *st = GetTargetAirportIfValid(v);
1339 TileIndex vt = TileVirtXY(v->x_pos, v->y_pos);
1340
1341 EncodedString headline;
1342 if (st == nullptr) {
1343 headline = GetEncodedString(STR_NEWS_PLANE_CRASH_OUT_OF_FUEL, victims);
1344 } else {
1345 headline = GetEncodedString(STR_NEWS_AIRCRAFT_CRASH, victims, st->index);
1346 }
1347
1348 AI::NewEvent(v->owner, new ScriptEventVehicleCrashed(v->index, vt, st == nullptr ? ScriptEventVehicleCrashed::CRASH_AIRCRAFT_NO_AIRPORT : ScriptEventVehicleCrashed::CRASH_PLANE_LANDING, victims, v->owner));
1349 Game::NewEvent(new ScriptEventVehicleCrashed(v->index, vt, st == nullptr ? ScriptEventVehicleCrashed::CRASH_AIRCRAFT_NO_AIRPORT : ScriptEventVehicleCrashed::CRASH_PLANE_LANDING, victims, v->owner));
1350
1351 NewsType newstype = NewsType::Accident;
1352 if (v->owner != _local_company) {
1353 newstype = NewsType::AccidentOther;
1354 }
1355
1356 AddTileNewsItem(std::move(headline), newstype, vt, st != nullptr ? st->index : StationID::Invalid());
1357
1358 ModifyStationRatingAround(vt, v->owner, -160, 30);
1359 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, v);
1360}
1361
1367{
1368
1370
1371 uint32_t prob;
1373 (AircraftVehInfo(v->engine_type)->subtype & AIR_FAST) &&
1375 prob = 3276;
1376 } else {
1377 if (_settings_game.vehicle.plane_crashes == 0) return;
1378 prob = (0x4000 << _settings_game.vehicle.plane_crashes) / 1500;
1379 }
1380
1381 if (GB(Random(), 0, 22) > prob) return;
1382
1383 /* Crash the airplane. Remove all goods stored at the station. */
1384 for (GoodsEntry &ge : st->goods) {
1385 ge.rating = 1;
1386 if (ge.HasData()) ge.GetData().cargo.Truncate();
1387 }
1388
1389 CrashAirplane(v);
1390}
1391
1398{
1399 if (v->current_order.IsType(OT_GOTO_DEPOT)) return;
1400
1403
1404 /* Check if station was ever visited before */
1405 if (!(st->had_vehicle_of_type & HVOT_AIRCRAFT)) {
1406 st->had_vehicle_of_type |= HVOT_AIRCRAFT;
1407 /* show newsitem of celebrating citizens */
1409 GetEncodedString(STR_NEWS_FIRST_AIRCRAFT_ARRIVAL, st->index),
1411 v->index,
1412 st->index
1413 );
1414 AI::NewEvent(v->owner, new ScriptEventStationFirstVehicle(st->index, v->index));
1415 Game::NewEvent(new ScriptEventStationFirstVehicle(st->index, v->index));
1416 }
1417
1418 v->BeginLoading();
1419}
1420
1426{
1428
1429 TileIndex vt = TileVirtXY(v->x_pos, v->y_pos);
1430
1431 v->UpdateDeltaXY();
1432
1433 AirportTileAnimationTrigger(st, vt, AAT_STATION_AIRPLANE_LAND);
1434
1436 SndPlayVehicleFx(SND_17_SKID_PLANE, v);
1437 }
1438}
1439
1440
1443{
1444 if (v->current_order.IsType(OT_GOTO_STATION) || v->current_order.IsType(OT_GOTO_DEPOT)) {
1445 v->targetairport = v->current_order.GetDestination().ToStationID();
1446 }
1447
1448 const Station *st = GetTargetAirportIfValid(v);
1449 const AirportFTAClass *apc = st == nullptr ? GetAirport(AT_DUMMY) : st->airport.GetFTA();
1450 Direction rotation = st == nullptr ? DIR_N : st->airport.rotation;
1451 v->pos = v->previous_pos = AircraftGetEntryPoint(v, apc, rotation);
1452}
1453
1463{
1464 v->cur_speed = 0;
1465 v->subspeed = 0;
1466 v->progress = 0;
1467 v->direction = exit_dir;
1469 {
1470 Vehicle *u = v->Next();
1472
1473 /* Rotor blades */
1474 u = u->Next();
1475 if (u != nullptr) {
1477 u->cur_speed = 80;
1478 }
1479 }
1480
1483 SetAircraftPosition(v, v->x_pos, v->y_pos, v->z_pos);
1486}
1487
1491static void AircraftEventHandler_EnterTerminal(Aircraft *v, const AirportFTAClass *apc)
1492{
1494 v->state = apc->layout[v->pos].heading;
1495}
1496
1503{
1505 v->state = apc->layout[v->pos].heading;
1506}
1507
1514{
1515 /* if we just arrived, execute EnterHangar first */
1516 if (v->previous_pos != v->pos) {
1518 return;
1519 }
1520
1521 /* if we were sent to the depot, stay there */
1522 if (v->current_order.IsType(OT_GOTO_DEPOT) && v->vehstatus.Test(VehState::Stopped)) {
1523 v->current_order.Free();
1524 return;
1525 }
1526
1527 /* Check if we should wait here for unbunching. */
1528 if (v->IsWaitingForUnbunching()) return;
1529
1530 if (!v->current_order.IsType(OT_GOTO_STATION) &&
1531 !v->current_order.IsType(OT_GOTO_DEPOT))
1532 return;
1533
1534 /* We are leaving a hangar, but have to go to the exact same one; re-enter */
1535 if (v->current_order.IsType(OT_GOTO_DEPOT) && v->current_order.GetDestination() == v->targetairport) {
1537 return;
1538 }
1539
1540 /* if the block of the next position is busy, stay put */
1541 if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1542
1543 /* We are already at the target airport, we need to find a terminal */
1545 /* FindFreeTerminal:
1546 * 1. Find a free terminal, 2. Occupy it, 3. Set the vehicle's state to that terminal */
1547 if (v->subtype == AIR_HELICOPTER) {
1548 if (!AirportFindFreeHelipad(v, apc)) return; // helicopter
1549 } else {
1550 if (!AirportFindFreeTerminal(v, apc)) return; // airplane
1551 }
1552 } else { // Else prepare for launch.
1553 /* airplane goto state takeoff, helicopter to helitakeoff */
1555 }
1556 const Station *st = Station::GetByTile(v->tile);
1558 AirportMove(v, apc);
1559}
1560
1563{
1564 /* if we just arrived, execute EnterTerminal first */
1565 if (v->previous_pos != v->pos) {
1566 AircraftEventHandler_EnterTerminal(v, apc);
1567 /* on an airport with helipads, a helicopter will always land there
1568 * and get serviced at the same time - setting */
1570 if (v->subtype == AIR_HELICOPTER && apc->num_helipads > 0) {
1571 /* an excerpt of ServiceAircraft, without the invisibility stuff */
1577 }
1578 }
1579 return;
1580 }
1581
1582 if (v->current_order.IsType(OT_NOTHING)) return;
1583
1584 /* if the block of the next position is busy, stay put */
1585 if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1586
1587 /* airport-road is free. We either have to go to another airport, or to the hangar
1588 * ---> start moving */
1589
1590 bool go_to_hangar = false;
1591 switch (v->current_order.GetType()) {
1592 case OT_GOTO_STATION: // ready to fly to another airport
1593 break;
1594 case OT_GOTO_DEPOT: // visit hangar for servicing, sale, etc.
1595 go_to_hangar = v->current_order.GetDestination() == v->targetairport;
1596 break;
1597 case OT_CONDITIONAL:
1598 /* In case of a conditional order we just have to wait a tick
1599 * longer, so the conditional order can actually be processed;
1600 * we should not clear the order as that makes us go nowhere. */
1601 return;
1602 default: // orders have been deleted (no orders), goto depot and don't bother us
1603 v->current_order.Free();
1604 go_to_hangar = true;
1605 }
1606
1607 if (go_to_hangar && Station::Get(v->targetairport)->airport.HasHangar()) {
1608 v->state = HANGAR;
1609 } else {
1610 /* airplane goto state takeoff, helicopter to helitakeoff */
1612 }
1613 AirportMove(v, apc);
1614}
1615
1616static void AircraftEventHandler_General(Aircraft *, const AirportFTAClass *)
1617{
1618 FatalError("OK, you shouldn't be here, check your Airport Scheme!");
1619}
1620
1621static void AircraftEventHandler_TakeOff(Aircraft *v, const AirportFTAClass *)
1622{
1623 PlayAircraftSound(v); // play takeoffsound for airplanes
1624 v->state = STARTTAKEOFF;
1625}
1626
1627static void AircraftEventHandler_StartTakeOff(Aircraft *v, const AirportFTAClass *)
1628{
1629 v->state = ENDTAKEOFF;
1630 v->UpdateDeltaXY();
1631}
1632
1633static void AircraftEventHandler_EndTakeOff(Aircraft *v, const AirportFTAClass *)
1634{
1635 v->state = FLYING;
1636 /* get the next position to go to, differs per airport */
1638}
1639
1640static void AircraftEventHandler_HeliTakeOff(Aircraft *v, const AirportFTAClass *)
1641{
1642 v->state = FLYING;
1643 v->UpdateDeltaXY();
1644
1645 /* get the next position to go to, differs per airport */
1647
1648 /* Send the helicopter to a hangar if needed for replacement */
1649 if (v->NeedsAutomaticServicing()) {
1650 Backup<CompanyID> cur_company(_current_company, v->owner);
1652 cur_company.Restore();
1653 }
1654}
1655
1656static void AircraftEventHandler_Flying(Aircraft *v, const AirportFTAClass *apc)
1657{
1659
1660 /* Runway busy, not allowed to use this airstation or closed, circle. */
1661 if (CanVehicleUseStation(v, st) && (st->owner == OWNER_NONE || st->owner == v->owner) && !st->airport.blocks.Test(AirportBlock::AirportClosed)) {
1662 /* {32,FLYING,AirportBlock::Nothing,37}, {32,LANDING,N,33}, {32,HELILANDING,N,41},
1663 * if it is an airplane, look for LANDING, for helicopter HELILANDING
1664 * it is possible to choose from multiple landing runways, so loop until a free one is found */
1665 uint8_t landingtype = (v->subtype == AIR_HELICOPTER) ? HELILANDING : LANDING;
1666 const AirportFTA *current = apc->layout[v->pos].next.get();
1667 while (current != nullptr) {
1668 if (current->heading == landingtype) {
1669 /* save speed before, since if AirportHasBlock is false, it resets them to 0
1670 * we don't want that for plane in air
1671 * hack for speed thingie */
1672 uint16_t tcur_speed = v->cur_speed;
1673 uint16_t tsubspeed = v->subspeed;
1674 if (!AirportHasBlock(v, current, apc)) {
1675 v->state = landingtype; // LANDING / HELILANDING
1677 /* it's a bit dirty, but I need to set position to next position, otherwise
1678 * if there are multiple runways, plane won't know which one it took (because
1679 * they all have heading LANDING). And also occupy that block! */
1680 v->pos = current->next_position;
1681 st->airport.blocks.Set(apc->layout[v->pos].blocks);
1682 return;
1683 }
1684 v->cur_speed = tcur_speed;
1685 v->subspeed = tsubspeed;
1686 }
1687 current = current->next.get();
1688 }
1689 }
1690 v->state = FLYING;
1691 v->pos = apc->layout[v->pos].next_position;
1692}
1693
1694static void AircraftEventHandler_Landing(Aircraft *v, const AirportFTAClass *)
1695{
1696 v->state = ENDLANDING;
1697 AircraftLandAirplane(v); // maybe crash airplane
1698
1699 /* check if the aircraft needs to be replaced or renewed and send it to a hangar if needed */
1700 if (v->NeedsAutomaticServicing()) {
1701 Backup<CompanyID> cur_company(_current_company, v->owner);
1703 cur_company.Restore();
1704 }
1705}
1706
1707static void AircraftEventHandler_HeliLanding(Aircraft *v, const AirportFTAClass *)
1708{
1709 v->state = HELIENDLANDING;
1710 v->UpdateDeltaXY();
1711}
1712
1713static void AircraftEventHandler_EndLanding(Aircraft *v, const AirportFTAClass *apc)
1714{
1715 /* next block busy, don't do a thing, just wait */
1716 if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1717
1718 /* if going to terminal (OT_GOTO_STATION) choose one
1719 * 1. in case all terminals are busy AirportFindFreeTerminal() returns false or
1720 * 2. not going for terminal (but depot, no order),
1721 * --> get out of the way to the hangar. */
1722 if (v->current_order.IsType(OT_GOTO_STATION)) {
1723 if (AirportFindFreeTerminal(v, apc)) return;
1724 }
1725 v->state = HANGAR;
1726
1727}
1728
1729static void AircraftEventHandler_HeliEndLanding(Aircraft *v, const AirportFTAClass *apc)
1730{
1731 /* next block busy, don't do a thing, just wait */
1732 if (AirportHasBlock(v, &apc->layout[v->pos], apc)) return;
1733
1734 /* if going to helipad (OT_GOTO_STATION) choose one. If airport doesn't have helipads, choose terminal
1735 * 1. in case all terminals/helipads are busy (AirportFindFreeHelipad() returns false) or
1736 * 2. not going for terminal (but depot, no order),
1737 * --> get out of the way to the hangar IF there are terminals on the airport.
1738 * --> else TAKEOFF
1739 * the reason behind this is that if an airport has a terminal, it also has a hangar. Airplanes
1740 * must go to a hangar. */
1741 if (v->current_order.IsType(OT_GOTO_STATION)) {
1742 if (AirportFindFreeHelipad(v, apc)) return;
1743 }
1745}
1746
1752typedef void AircraftStateHandler(Aircraft *v, const AirportFTAClass *apc);
1755 AircraftEventHandler_General, // TO_ALL = 0
1756 AircraftEventHandler_InHangar, // HANGAR = 1
1763 AircraftEventHandler_AtTerminal, // HELIPAD1 = 8
1764 AircraftEventHandler_AtTerminal, // HELIPAD2 = 9
1765 AircraftEventHandler_TakeOff, // TAKEOFF = 10
1766 AircraftEventHandler_StartTakeOff, // STARTTAKEOFF = 11
1767 AircraftEventHandler_EndTakeOff, // ENDTAKEOFF = 12
1768 AircraftEventHandler_HeliTakeOff, // HELITAKEOFF = 13
1769 AircraftEventHandler_Flying, // FLYING = 14
1770 AircraftEventHandler_Landing, // LANDING = 15
1771 AircraftEventHandler_EndLanding, // ENDLANDING = 16
1772 AircraftEventHandler_HeliLanding, // HELILANDING = 17
1773 AircraftEventHandler_HeliEndLanding, // HELIENDLANDING = 18
1774 AircraftEventHandler_AtTerminal, // TERM7 = 19
1775 AircraftEventHandler_AtTerminal, // TERM8 = 20
1776 AircraftEventHandler_AtTerminal, // HELIPAD3 = 21
1777};
1778
1779static void AirportClearBlock(const Aircraft *v, const AirportFTAClass *apc)
1780{
1781 /* we have left the previous block, and entered the new one. Free the previous block */
1782 if (apc->layout[v->previous_pos].blocks != apc->layout[v->pos].blocks) {
1784
1785 st->airport.blocks.Reset(apc->layout[v->previous_pos].blocks);
1786 }
1787}
1788
1789static void AirportGoToNextPosition(Aircraft *v)
1790{
1791 /* if aircraft is not in position, wait until it is */
1792 if (!AircraftController(v)) return;
1793
1795
1796 AirportClearBlock(v, apc);
1797 AirportMove(v, apc); // move aircraft to next position
1798}
1799
1800/* gets pos from vehicle and next orders */
1801static bool AirportMove(Aircraft *v, const AirportFTAClass *apc)
1802{
1803 /* error handling */
1804 if (v->pos >= apc->nofelements) {
1805 Debug(misc, 0, "[Ap] position {} is not valid for current airport. Max position is {}", v->pos, apc->nofelements-1);
1806 assert(v->pos < apc->nofelements);
1807 }
1808
1809 const AirportFTA *current = &apc->layout[v->pos];
1810 /* we have arrived in an important state (eg terminal, hangar, etc.) */
1811 if (current->heading == v->state) {
1812 uint8_t prev_pos = v->pos; // location could be changed in state, so save it before-hand
1813 uint8_t prev_state = v->state;
1814 _aircraft_state_handlers[v->state](v, apc);
1815 if (v->state != FLYING) v->previous_pos = prev_pos;
1816 if (v->state != prev_state || v->pos != prev_pos) UpdateAircraftCache(v);
1817 return true;
1818 }
1819
1820 v->previous_pos = v->pos; // save previous location
1821
1822 /* there is only one choice to move to */
1823 if (current->next == nullptr) {
1824 if (AirportSetBlocks(v, current, apc)) {
1825 v->pos = current->next_position;
1827 } // move to next position
1828 return false;
1829 }
1830
1831 /* there are more choices to choose from, choose the one that
1832 * matches our heading */
1833 do {
1834 if (v->state == current->heading || current->heading == TO_ALL) {
1835 if (AirportSetBlocks(v, current, apc)) {
1836 v->pos = current->next_position;
1838 } // move to next position
1839 return false;
1840 }
1841 current = current->next.get();
1842 } while (current != nullptr);
1843
1844 Debug(misc, 0, "[Ap] cannot move further on Airport! (pos {} state {}) for vehicle {}", v->pos, v->state, v->index);
1845 NOT_REACHED();
1846}
1847
1849static bool AirportHasBlock(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc)
1850{
1851 const AirportFTA *reference = &apc->layout[v->pos];
1852 const AirportFTA *next = &apc->layout[current_pos->next_position];
1853
1854 /* same block, then of course we can move */
1855 if (apc->layout[current_pos->position].blocks != next->blocks) {
1856 const Station *st = Station::Get(v->targetairport);
1857 AirportBlocks blocks = next->blocks;
1858
1859 /* check additional possible extra blocks */
1860 if (current_pos != reference && current_pos->blocks != AirportBlock::Nothing) {
1861 blocks.Set(current_pos->blocks);
1862 }
1863
1864 if (st->airport.blocks.Any(blocks)) {
1865 v->cur_speed = 0;
1866 v->subspeed = 0;
1867 return true;
1868 }
1869 }
1870 return false;
1871}
1872
1880static bool AirportSetBlocks(Aircraft *v, const AirportFTA *current_pos, const AirportFTAClass *apc)
1881{
1882 const AirportFTA *next = &apc->layout[current_pos->next_position];
1883 const AirportFTA *reference = &apc->layout[v->pos];
1884
1885 /* if the next position is in another block, check it and wait until it is free */
1886 if (!apc->layout[current_pos->position].blocks.All(next->blocks)) {
1887 AirportBlocks blocks = next->blocks;
1888 /* search for all all elements in the list with the same state, and blocks != N
1889 * this means more blocks should be checked/set */
1890 const AirportFTA *current = current_pos;
1891 if (current == reference) current = current->next.get();
1892 while (current != nullptr) {
1893 if (current->heading == current_pos->heading && current->blocks.Any()) {
1894 blocks.Set(current->blocks);
1895 break;
1896 }
1897 current = current->next.get();
1898 }
1899
1900 /* if the block to be checked is in the next position, then exclude that from
1901 * checking, because it has been set by the airplane before */
1902 if (current_pos->blocks == next->blocks) blocks.Flip(next->blocks);
1903
1905 if (st->airport.blocks.Any(blocks)) {
1906 v->cur_speed = 0;
1907 v->subspeed = 0;
1908 return false;
1909 }
1910
1911 if (next->blocks != AirportBlock::Nothing) {
1912 st->airport.blocks.Set(blocks); // occupy next block
1913 }
1914 }
1915 return true;
1916}
1917
1926
1941
1949static bool FreeTerminal(Aircraft *v, uint8_t i, uint8_t last_terminal)
1950{
1951 assert(last_terminal <= lengthof(_airport_terminal_mapping));
1953 for (; i < last_terminal; i++) {
1955 /* TERMINAL# HELIPAD# */
1956 v->state = _airport_terminal_mapping[i].state; // start moving to that terminal/helipad
1957 st->airport.blocks.Set(_airport_terminal_mapping[i].blocks); // occupy terminal/helipad
1958 return true;
1959 }
1960 }
1961 return false;
1962}
1963
1969static uint GetNumTerminals(const AirportFTAClass *apc)
1970{
1971 uint num = 0;
1972
1973 for (uint i = apc->terminals[0]; i > 0; i--) num += apc->terminals[i];
1974
1975 return num;
1976}
1977
1985{
1986 /* example of more terminalgroups
1987 * {0,HANGAR,AirportBlock::Nothing,1}, {0,TERMGROUP,AirportBlock::TermGroup1,0}, {0,TERMGROUP,TERM_GROUP2_ENTER_block,1}, {0,0,N,1},
1988 * Heading TERMGROUP denotes a group. We see 2 groups here:
1989 * 1. group 0 -- AirportBlock::TermGroup1 (check block)
1990 * 2. group 1 -- TERM_GROUP2_ENTER_block (check block)
1991 * First in line is checked first, group 0. If the block (AirportBlock::TermGroup1) is free, it
1992 * looks at the corresponding terminals of that group. If no free ones are found, other
1993 * possible groups are checked (in this case group 1, since that is after group 0). If that
1994 * fails, then attempt fails and plane waits
1995 */
1996 if (apc->terminals[0] > 1) {
1997 const Station *st = Station::Get(v->targetairport);
1998 const AirportFTA *temp = apc->layout[v->pos].next.get();
1999
2000 while (temp != nullptr) {
2001 if (temp->heading == TERMGROUP) {
2002 if (!st->airport.blocks.Any(temp->blocks)) {
2003 /* read which group do we want to go to?
2004 * (the first free group) */
2005 uint target_group = temp->next_position + 1;
2006
2007 /* at what terminal does the group start?
2008 * that means, sum up all terminals of
2009 * groups with lower number */
2010 uint group_start = 0;
2011 for (uint i = 1; i < target_group; i++) {
2012 group_start += apc->terminals[i];
2013 }
2014
2015 uint group_end = group_start + apc->terminals[target_group];
2016 if (FreeTerminal(v, group_start, group_end)) return true;
2017 }
2018 } else {
2019 /* once the heading isn't 255, we've exhausted the possible blocks.
2020 * So we cannot move */
2021 return false;
2022 }
2023 temp = temp->next.get();
2024 }
2025 }
2026
2027 /* if there is only 1 terminalgroup, all terminals are checked (starting from 0 to max) */
2028 return FreeTerminal(v, 0, GetNumTerminals(apc));
2029}
2030
2038{
2039 /* if an airport doesn't have helipads, use terminals */
2040 if (apc->num_helipads == 0) return AirportFindFreeTerminal(v, apc);
2041
2042 /* only 1 helicoptergroup, check all helipads
2043 * The blocks for helipads start after the last terminal (MAX_TERMINALS) */
2045}
2046
2052static void AircraftHandleDestTooFar(Aircraft *v, bool too_far)
2053{
2054 if (too_far) {
2055 if (!HasBit(v->flags, VAF_DEST_TOO_FAR)) {
2058 AI::NewEvent(v->owner, new ScriptEventAircraftDestTooFar(v->index));
2059 if (v->owner == _local_company) {
2060 /* Post a news message. */
2062 }
2063 }
2064 return;
2065 }
2066
2067 if (HasBit(v->flags, VAF_DEST_TOO_FAR)) {
2068 /* Not too far anymore, clear flag and message. */
2072 }
2073}
2074
2075static bool AircraftEventHandler(Aircraft *v, int loop)
2076{
2078 return HandleCrashedAircraft(v);
2079 }
2080
2081 if (v->vehstatus.Test(VehState::Stopped)) return true;
2082
2083 v->HandleBreakdown();
2084
2085 HandleAircraftSmoke(v, loop != 0);
2086 ProcessOrders(v);
2087 v->HandleLoading(loop != 0);
2088
2089 if (v->current_order.IsType(OT_LOADING) || v->current_order.IsType(OT_LEAVESTATION)) return true;
2090
2091 if (v->state >= ENDTAKEOFF && v->state <= HELIENDLANDING) {
2092 /* If we are flying, unconditionally clear the 'dest too far' state. */
2093 AircraftHandleDestTooFar(v, false);
2094 } else if (v->acache.cached_max_range_sqr != 0) {
2095 /* Check the distance to the next destination. This code works because the target
2096 * airport is only updated after take off and not on the ground. */
2098 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;
2099
2100 if (cur_st != nullptr && cur_st->airport.tile != INVALID_TILE && next_st != nullptr && next_st->airport.tile != INVALID_TILE) {
2101 uint dist = DistanceSquare(cur_st->airport.tile, next_st->airport.tile);
2103 }
2104 }
2105
2106 if (!HasBit(v->flags, VAF_DEST_TOO_FAR)) AirportGoToNextPosition(v);
2107
2108 return true;
2109}
2110
2112{
2113 if (!this->IsNormalAircraft()) return true;
2114
2116
2117 this->tick_counter++;
2118
2119 if (!this->vehstatus.Test(VehState::Stopped)) this->running_ticks++;
2120
2121 if (this->subtype == AIR_HELICOPTER) HelicopterTickHandler(this);
2122
2123 this->current_order_time++;
2124
2125 for (uint i = 0; i != 2; i++) {
2126 /* stop if the aircraft was deleted */
2127 if (!AircraftEventHandler(this, i)) return false;
2128 }
2129
2130 return true;
2131}
2132
2133
2141{
2142 assert(v->type == VEH_AIRCRAFT);
2143
2145 if (st == nullptr) return nullptr;
2146
2147 return st->airport.tile == INVALID_TILE ? nullptr : st;
2148}
2149
2155{
2156 /* only 1 station is updated per function call, so it is enough to get entry_point once */
2157 const AirportFTAClass *ap = st->airport.GetFTA();
2158 Direction rotation = st->airport.tile == INVALID_TILE ? DIR_N : st->airport.rotation;
2159
2160 for (Aircraft *v : Aircraft::Iterate()) {
2161 if (!v->IsNormalAircraft() || v->targetairport != st->index) continue;
2162 assert(v->state == FLYING);
2163
2164 Order *o = &v->current_order;
2165 /* The aircraft is heading to a hangar, but the new station doesn't have one,
2166 * or the aircraft can't land on the new station. Cancel current order. */
2167 if (o->IsType(OT_GOTO_DEPOT) && !(o->GetDepotOrderType() & ODTFB_PART_OF_ORDERS) && o->GetDestination() == st->index &&
2168 (!st->airport.HasHangar() || !CanVehicleUseStation(v, st))) {
2169 o->MakeDummy();
2171 }
2172 v->pos = v->previous_pos = AircraftGetEntryPoint(v, ap, rotation);
2174 }
2175
2176 /* Heliports don't have a hangar. Invalidate all go to hangar orders from all aircraft. */
2177 if (!st->airport.HasHangar()) RemoveOrderFromAllVehicles(OT_GOTO_DEPOT, st->index, true);
2178}
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
@ 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.
@ SlowTurn
Turn slowly (mostly used in the air).
Definition airport.h:50
@ Takeoff
Takeoff movement.
Definition airport.h:49
@ Land
Landing onto landing strip.
Definition airport.h:51
@ HeliLower
Helicopter landing.
Definition airport.h:55
@ Hold
Holding pattern movement (above the airport).
Definition airport.h:56
@ NoSpeedClamp
No speed restrictions.
Definition airport.h:48
@ Brake
Taxiing at the airport.
Definition airport.h:53
@ HeliRaise
Helicopter take-off.
Definition airport.h:54
@ ExactPosition
Go exactly to the destination coordinates.
Definition airport.h:52
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 & 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.
constexpr Timpl & Reset(Tvalue_type value)
Reset the value-th bit.
Common return value for all commands.
Money GetCost() const
The costs as made up to this moment.
bool Failed() const
Did this command fail?
Container for an encoded string, created by GetEncodedString.
Enum-as-bit-set wrapper.
static void NewEvent(class ScriptEvent *event)
Queue a new event for a Game Script.
RAII class for measuring multi-step elements of performance.
static constexpr TimerGameTick::Ticks DAY_TICKS
1 day is 74 ticks; TimerGameCalendar::date_fract used to be uint16_t and incremented by 885.
static Date date
Current date in days (day counter).
static Year year
Current year, starting at 0.
static constexpr int DAYS_IN_YEAR
days per year
static Date date
Current date in days (day counter).
uint Truncate(uint max_move=UINT_MAX)
Truncates the cargo in this list to the given amount.
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Execute
execute the given command
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
CompanyID _current_company
Company currently doing an action.
void SubtractMoneyFromCompanyFract(CompanyID company, const CommandCost &cst)
Subtract money from a company, including the money fraction.
Functions related to companies.
static constexpr Owner OWNER_NONE
The tile has no ownership.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
DirDiff DirDifference(Direction d0, Direction d1)
Calculate the difference between two directions.
Direction ChangeDir(Direction d, DirDiff delta)
Change a direction by a given difference.
DiagDirection ChangeDiagDir(DiagDirection d, DiagDirDiff delta)
Applies a difference on a DiagDirection.
DiagDirDiff DiagDirDifference(DiagDirection d0, DiagDirection d1)
Calculate the difference between two DiagDirection values.
DiagDirection DirToDiagDir(Direction dir)
Convert a Direction to a DiagDirection.
DirDiff
Allow incrementing of Direction variables.
@ 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:952
@ 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.
Definition engine_type.h:99
@ 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.
@ AAT_STATION_AIRPLANE_LAND
Triggered when an airplane (not a helicopter) touches down at the airport (for single tile).
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:28
@ 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:112
@ ODTFB_SERVICE
This depot order is because of the servicing limit.
Definition order_type.h:111
@ ODATFB_NEAREST_DEPOT
Send the vehicle to the nearest depot.
Definition order_type.h:121
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:59
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:58
Functions related to sound.
static const uint ORIGINAL_SAMPLE_COUNT
The number of sounds in the original sample.cat.
Definition sound_type.h:124
@ SND_18_TAKEOFF_HELICOPTER
22 == 0x16 Takeoff: helicopter
Definition sound_type.h:69
@ SND_17_SKID_PLANE
21 == 0x15 Plane landing / touching ground
Definition sound_type.h:68
@ SND_12_EXPLOSION
16 == 0x10 Destruction, crashes, disasters, ...
Definition sound_type.h:63
Functions to cache sprites in memory.
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition sprites.h:1609
Base classes/functions for stations.
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
@ HVOT_AIRCRAFT
Station has seen an aircraft.
@ Airport
Station with an airport.
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:277
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:158
const uint8_t num_helipads
Number of helipads on this airport. When 0 helicopters will go to normal terminals.
Definition airport.h:192
const AirportMovingData * MovingData(uint8_t position) const
Get movement data at a position.
Definition airport.h:183
@ 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:196
std::vector< AirportFTA > layout
state machine for airport
Definition airport.h:190
const uint8_t * terminals
Array with the number of terminal groups, followed by the number of terminals in each group.
Definition airport.h:191
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:195
uint8_t nofelements
number of positions the airport consists of
Definition airport.h:194
Flags flags
Flags for this airport type.
Definition airport.h:193
Internal structure used in openttd - Finite sTate mAchine --> FTA.
Definition airport.h:147
std::unique_ptr< AirportFTA > next
possible extra movement choices from this position
Definition airport.h:150
uint8_t heading
heading (current orders), guiding an airplane to its target on an airport
Definition airport.h:154
AirportBlocks blocks
bitmap of blocks that could be reserved
Definition airport.h:151
uint8_t position
the position that an airplane is at
Definition airport.h:152
uint8_t next_position
next position from this position
Definition airport.h:153
A single location on an airport where aircraft can move to.
Definition airport.h:135
int16_t x
x-coordinate of the destination.
Definition airport.h:136
AirportMovingDataFlags flags
special flags when moving towards the destination.
Definition airport.h:138
int16_t y
y-coordinate of the destination.
Definition airport.h:137
Direction direction
Direction to turn the aircraft after reaching the destination.
Definition airport.h:139
AirportBlocks blocks
stores which blocks on the airport are taken. was 16 bit earlier on, then 32
bool HasHangar() const
Check if this airport has at least one hangar.
uint GetHangarNum(TileIndex tile) const
Get the hangar number of the hangar at a specific tile.
Direction rotation
How this airport is rotated.
uint8_t type
Type of this airport,.
Direction GetHangarExitDirection(TileIndex tile) const
Get the exit direction of the hangar at a specific tile.
const AirportFTAClass * GetFTA() const
Get the finite-state machine for this airport or the finite-state machine for the dummy airport in ca...
TileIndex GetHangarTile(uint hangar_num) const
Get the first tile of the given hangar.
Class to backup a specific variable and restore it later.
std::string name
Name of vehicle.
TimerGameTick::Ticks current_order_time
How many ticks have passed since this order started.
VehicleFlags vehicle_flags
Used for gradual loading and other miscellaneous things (.
TileIndex xy
Base tile of the station.
Owner owner
The owner of this station.
static BaseStation * GetByTile(TileIndex tile)
Get the base station belonging to a specific tile.
VehicleType type
Type of vehicle.
bool value
tells if the bool cheat is active or not
Definition cheat_type.h:18
Cheat no_jetcrash
no jet will crash on small airports anymore
Definition cheat_type.h:31
SoundSettings sound
sound effect settings
Structure to return information about the closest depot location, and whether it could be found.
Disasters, like submarines, skyrangers and their shadows, belong to this class.
uint16_t cargo_age_period
Number of ticks before carried cargo is aged.
uint16_t reliability_spd_dec
Speed of reliability decay between services (per day).
Definition engine_base.h:49
const GRFFile * GetGRF() const
Retrieve the NewGRF the engine is tied to.
uint DetermineCapacity(const Vehicle *v, uint16_t *mail_capacity=nullptr) const
Determines capacity of a given vehicle from scratch.
Definition engine.cpp:201
EngineFlags flags
Flags of the engine.
Definition engine_base.h:56
uint8_t original_image_index
Original vehicle image index, thus the image index of the overridden vehicle.
Definition engine_base.h:60
TimerGameCalendar::Date GetLifeLengthInDays() const
Returns the vehicle's (not model's!) life length in days.
Definition engine.cpp:443
CargoType GetDefaultCargoType() const
Determines the default cargo type of an engine.
uint16_t reliability
Current reliability of the engine.
Definition engine_base.h:48
VehicleSettings vehicle
options for vehicles
OrderSettings order
settings related to orders
Position information of a vehicle after it moved.
TileIndex new_tile
Tile of the vehicle after moving.
int y
x and y position of the vehicle after moving
TileIndex old_tile
Current tile of the vehicle.
Stores station stats for a single cargo.
static uint MaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition map_func.h:305
static debug_inline uint MaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition map_func.h:296
Combination of aircraft state for going to a certain terminal and the airport flag for that terminal ...
AirportBlock blocks
Bitmask in the airport flags that need to be free for this terminal.
AirportMovementStates state
Aircraft movement state when going to this terminal.
VehicleSpriteSeq sprite_seq
Vehicle appearance.
bool serviceathelipad
service helicopters at helipads automatically (no need to send to depot)
OrderDepotTypeFlags GetDepotOrderType() const
What caused us going to the depot?
Definition order_base.h:144
DestinationID GetDestination() const
Gets the destination of this order.
Definition order_base.h:103
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition order_base.h:70
OrderType GetType() const
Get the type of order of this order.
Definition order_base.h:76
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:146
void Free()
'Free' the order
Definition order_cmd.cpp:63
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:90
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.
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:103
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:131
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:744
virtual uint Crash(bool flooded=false)
Crash the (whole) vehicle chain.
Definition vehicle.cpp:280
virtual bool IsChainInDepot() const
Check whether the whole vehicle chain is in the depot.
VehicleCargoList cargo
The cargo this vehicle is carrying.
uint8_t x_extent
x-extent of vehicle bounding box
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:2421
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.
uint8_t z_extent
z-extent of vehicle bounding box
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:2505
int8_t y_offs
y offset for vehicle sprite
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.
int8_t x_offs
x offset for vehicle sprite
int32_t y_pos
y coordinate.
int32_t x_pos
x coordinate.
uint8_t y_extent
y-extent of vehicle bounding box
uint16_t refit_cap
Capacity left over from before last refit.
VehicleCache vcache
Cache of often used vehicle values.
void BeginLoading()
Prepare everything to begin the loading when arriving at a station.
Definition vehicle.cpp:2194
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:2552
void SetNext(Vehicle *next)
Set the next vehicle of this vehicle.
Definition vehicle.cpp:2928
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:1357
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:1755
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:1684
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:272
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
static const uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in ZOOM_BASE.
Definition tile_type.h:18
static const uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
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:1545
void VehicleServiceInDepot(Vehicle *v)
Service a vehicle and all subsequent vehicles in the consist.
Definition vehicle.cpp:167
GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v)
Get position information of a vehicle when moving one pixel in the direction it is facing.
Definition vehicle.cpp:1775
void DecreaseVehicleValue(Vehicle *v)
Decrease the value of a vehicle.
Definition vehicle.cpp:1295
void EconomyAgeVehicle(Vehicle *v)
Update economy age of a vehicle.
Definition vehicle.cpp:1423
bool CanVehicleUseStation(EngineID engine_type, const Station *st)
Can this station be used by the given engine type?
Definition vehicle.cpp:3047
void AgeVehicle(Vehicle *v)
Update age of a vehicle.
Definition vehicle.cpp:1435
@ 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:3134
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:3226
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:3121
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3108
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