OpenTTD Source: src/aircraft_cmd.cpp Source File

OpenTTD Source 14.1

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