OpenTTD Source 20260531-master-g0e951f3528
disaster_vehicle.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
24
25
26#include "stdafx.h"
27
28#include "aircraft.h"
29#include "disaster_vehicle.h"
30#include "industry.h"
31#include "station_base.h"
32#include "command_func.h"
33#include "news_func.h"
34#include "town.h"
35#include "company_func.h"
36#include "strings_func.h"
37#include "viewport_func.h"
38#include "vehicle_func.h"
39#include "sound_func.h"
40#include "effectvehicle_func.h"
41#include "roadveh.h"
42#include "train.h"
43#include "ai/ai.hpp"
44#include "game/game.hpp"
45#include "company_base.h"
46#include "core/random_func.hpp"
47#include "core/backup_type.hpp"
48#include "landscape_cmd.h"
49#include "timer/timer.h"
51
52#include "table/strings.h"
53
54#include "safeguards.h"
55
58
59static void DisasterClearSquare(TileIndex tile)
60{
61 if (EnsureNoVehicleOnGround(tile).Failed()) return;
62
63 switch (GetTileType(tile)) {
65 if (Company::IsHumanID(GetTileOwner(tile)) && !IsRailDepot(tile)) {
67 Command<Commands::LandscapeClear>::Do(DoCommandFlag::Execute, tile);
68
69 /* update signals in buffer */
71 }
72 break;
73
74 case TileType::House: {
76 Command<Commands::LandscapeClear>::Do(DoCommandFlag::Execute, tile);
77 break;
78 }
79
80 case TileType::Trees:
81 case TileType::Clear:
82 DoClearSquare(tile);
83 break;
84
85 default:
86 break;
87 }
88}
89
91static constexpr DirectionIndexArray<SpriteID> _disaster_images_1{SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP};
93static constexpr DirectionIndexArray<SpriteID> _disaster_images_2{SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT, SPR_UFO_SMALL_SCOUT};
95static constexpr DirectionIndexArray<SpriteID> _disaster_images_3{SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15, SPR_F_15};
97static constexpr DirectionIndexArray<SpriteID> _disaster_images_4{SPR_SUB_SMALL_NE, SPR_SUB_SMALL_NE, SPR_SUB_SMALL_SE, SPR_SUB_SMALL_SE, SPR_SUB_SMALL_SW, SPR_SUB_SMALL_SW, SPR_SUB_SMALL_NW, SPR_SUB_SMALL_NW};
99static constexpr DirectionIndexArray<SpriteID> _disaster_images_5{SPR_SUB_LARGE_NE, SPR_SUB_LARGE_NE, SPR_SUB_LARGE_SE, SPR_SUB_LARGE_SE, SPR_SUB_LARGE_SW, SPR_SUB_LARGE_SW, SPR_SUB_LARGE_NW, SPR_SUB_LARGE_NW};
101static constexpr DirectionIndexArray<SpriteID> _disaster_images_6{SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER, SPR_UFO_HARVESTER};
103static constexpr DirectionIndexArray<SpriteID> _disaster_images_7{SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER, SPR_XCOM_SKYRANGER};
105static constexpr DirectionIndexArray<SpriteID> _disaster_images_8{SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A, SPR_AH_64A};
107static constexpr DirectionIndexArray<SpriteID> _disaster_images_9{SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1, SPR_ROTOR_MOVING_1};
108
119
120void DisasterVehicle::UpdateImage()
121{
122 SpriteID img = this->image_override;
123 if (img == 0) img = _disaster_images[this->subtype][this->direction];
124 this->sprite_cache.sprite_seq.Set(img);
125}
126
138{
140
141 this->x_pos = x;
142 this->y_pos = y;
143 switch (subtype) {
144 case ST_ZEPPELINER:
145 case ST_SMALL_UFO:
146 case ST_AIRPLANE:
147 case ST_HELICOPTER:
148 case ST_BIG_UFO:
150 GetAircraftFlightLevelBounds(this, &this->z_pos, nullptr);
151 break;
152
154 GetAircraftFlightLevelBounds(this, &this->z_pos, nullptr);
155 this->z_pos += ROTOR_Z_OFFSET;
156 break;
157
159 case ST_BIG_SUBMARINE:
160 this->z_pos = 0;
161 break;
162
169 this->z_pos = 0;
170 this->vehstatus.Set(VehState::Shadow);
171 break;
172 }
173
174 this->direction = direction;
175 this->tile = TileVirtXY(x, y);
176 this->subtype = subtype;
177 this->UpdateDeltaXY();
178 this->owner = OWNER_NONE;
179 this->image_override = 0;
180 this->state = 0;
181
182 this->UpdateImage();
184}
185
192void DisasterVehicle::UpdatePosition(int x, int y, int z)
193{
194 this->x_pos = x;
195 this->y_pos = y;
196 this->z_pos = z;
197 this->tile = TileVirtXY(x, y);
198
199 this->UpdateImage();
201
202 DisasterVehicle *u = this->Next();
203 if (u != nullptr) {
204 int safe_x = Clamp(x, 0, Map::MaxX() * TILE_SIZE);
205 int safe_y = Clamp(y - 1, 0, Map::MaxY() * TILE_SIZE);
206
207 u->x_pos = x;
208 u->y_pos = y - 1 - (std::max(z - GetSlopePixelZ(safe_x, safe_y), 0) >> 3);
209 safe_y = Clamp(u->y_pos, 0, Map::MaxY() * TILE_SIZE);
210 u->z_pos = GetSlopePixelZ(safe_x, safe_y);
211 u->direction = this->direction;
212
213 u->UpdateImage();
215
216 if ((u = u->Next()) != nullptr) {
217 u->x_pos = x;
218 u->y_pos = y;
219 u->z_pos = z + ROTOR_Z_OFFSET;
221 }
222 }
223}
224
235{
236 v->tick_counter++;
237
238 if (v->state < 2) {
239 if (HasBit(v->tick_counter, 0)) return true;
240
242
243 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
244
245 if (v->state == 1) {
246 if (++v->age == 38) {
247 v->state = 2;
249 }
250
251 if (GB(v->tick_counter, 0, 3) == 0) CreateEffectVehicleRel(v, 0, -17, 2, EV_CRASH_SMOKE);
252
253 } else if (v->state == 0) {
254 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
255 v->state = 1;
257
258 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_ZEPPELIN, GetStationIndex(v->tile)), NewsType::Accident, v->tile);
259 AI::NewEvent(GetTileOwner(v->tile), new ScriptEventDisasterZeppelinerCrashed(GetStationIndex(v->tile)));
260 }
261 }
262
263 if (v->y_pos >= (int)((Map::SizeY() + 9) * TILE_SIZE - 1)) {
264 delete v;
265 return false;
266 }
267
268 return true;
269 }
270
271 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
273 }
274
275 if (v->state > 2) {
276 if (++v->age <= 13320) return true;
277
278 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
281 AI::NewEvent(GetTileOwner(v->tile), new ScriptEventDisasterZeppelinerCleared(st->index));
282 }
283
284 v->UpdatePosition(v->x_pos, v->y_pos, GetAircraftFlightLevel(v));
285 delete v;
286 return false;
287 }
288
289 int x = v->x_pos;
290 int y = v->y_pos;
291 int z = GetSlopePixelZ(x, y);
292 if (z < v->z_pos) z = v->z_pos - 1;
293 v->UpdatePosition(x, y, z);
294
295 if (++v->age == 1) {
297 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, v);
298 v->image_override = SPR_BLIMP_CRASHING;
299 } else if (v->age == 70) {
300 v->image_override = SPR_BLIMP_CRASHED;
301 } else if (v->age <= 300) {
302 if (GB(v->tick_counter, 0, 3) == 0) {
303 uint32_t r = Random();
304
306 GB(r, 0, 4) - 7,
307 GB(r, 4, 4) - 7,
308 GB(r, 8, 3) + 5,
310 }
311 } else if (v->age == 350) {
312 v->state = 3;
314 }
315
316 return true;
317}
318
328{
329 ufo->image_override = (HasBit(++ufo->tick_counter, 3)) ? SPR_UFO_SMALL_SCOUT_DARKER : SPR_UFO_SMALL_SCOUT;
330
331 if (ufo->state == 0) {
332 /* Fly around randomly */
333 int x = TileX(ufo->dest_tile) * TILE_SIZE;
334 int y = TileY(ufo->dest_tile) * TILE_SIZE;
335 if (Delta(x, ufo->x_pos) + Delta(y, ufo->y_pos) >= (int)TILE_SIZE) {
336 ufo->direction = GetDirectionTowards(ufo, x, y);
338 ufo->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(ufo));
339 return true;
340 }
341 if (++ufo->age < 6) {
342 ufo->dest_tile = RandomTile();
343 return true;
344 }
345 ufo->state = 1;
346
347 uint n = 0; // Total number of targetable road vehicles.
348 for (const Company *c : Company::Iterate()) {
349 n += c->group_all[VehicleType::Road].num_vehicle;
350 }
351
352 if (n == 0) {
353 /* If there are no targetable road vehicles, destroy the UFO. */
354 delete ufo;
355 return false;
356 }
357
358 n = RandomRange(n); // Choose one of them.
359 for (RoadVehicle *u : RoadVehicle::Iterate()) {
360 /* Find (n+1)-th road vehicle. */
361 if (u->IsFrontEngine() && (n-- == 0)) {
362 if (u->crashed_ctr != 0 || u->disaster_vehicle != VehicleID::Invalid()) {
363 /* Targetted vehicle is crashed or already a target, destroy the UFO. */
364 delete ufo;
365 return false;
366 }
367 /* Target it. */
368 ufo->dest_tile = TileIndex{u->index.base()};
370 u->disaster_vehicle = ufo->index;
371 break;
372 }
373 }
374
375 return true;
376 } else {
377 /* Target a vehicle */
378 RoadVehicle *target = RoadVehicle::Get(ufo->dest_tile.base());
379 assert(target != nullptr && target->type == VehicleType::Road && target->IsFrontEngine());
380
381 uint dist = Delta(ufo->x_pos, target->x_pos) + Delta(ufo->y_pos, target->y_pos);
382
383 if (dist < TILE_SIZE && !target->vehstatus.Test(VehState::Hidden) && target->breakdown_ctr == 0) {
384 target->breakdown_ctr = 3;
385 target->breakdown_delay = 140;
386 }
387
388 ufo->direction = GetDirectionTowards(ufo, target->x_pos, target->y_pos);
390
391 int z = ufo->z_pos;
392 if (dist <= TILE_SIZE && z > target->z_pos) z--;
393 ufo->UpdatePosition(gp.x, gp.y, z);
394
395 /* If the vehicle is hidden in a depot or similar treat it as having "escaped" being crashed to avoid the Ufo looping forever,
396 * but we'll still explode the surrounding area ;) */
397 if (z <= target->z_pos) {
398 ufo->age++;
399 if (!target->vehstatus.Test(VehState::Hidden) && target->crashed_ctr == 0) {
400 uint victims = target->Crash();
401 target->disaster_vehicle = VehicleID::Invalid();
402
403 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_SMALL_UFO), NewsType::Accident, target->tile);
404
405 AI::NewEvent(target->owner, new ScriptEventVehicleCrashed(target->index, target->tile, ScriptEventVehicleCrashed::CRASH_RV_UFO, victims, target->owner));
406 Game::NewEvent(new ScriptEventVehicleCrashed(target->index, target->tile, ScriptEventVehicleCrashed::CRASH_RV_UFO, victims, target->owner));
407 }
408 }
409
410 /* Destroy? */
411 if (ufo->age > 50) {
413 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, ufo);
414 delete ufo;
415 return false;
416 }
417 }
418
419 return true;
420}
421
422static void DestructIndustry(Industry *i)
423{
424 for (const auto tile : Map::Iterate()) {
425 if (i->TileBelongsToIndustry(tile)) {
428 }
429 }
430}
431
446static bool DisasterTick_Aircraft(DisasterVehicle *v, uint16_t image_override, bool leave_at_top, StringID news_message, IndustryBehaviour behaviour)
447{
448 v->tick_counter++;
449 v->image_override = (v->state == 1 && HasBit(v->tick_counter, 2)) ? image_override : 0;
450
452 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
453
454 if ((leave_at_top && gp.x < (-10 * (int)TILE_SIZE)) || (!leave_at_top && gp.x > (int)(Map::SizeX() * TILE_SIZE + 9 * TILE_SIZE) - 1)) {
455 delete v;
456 return false;
457 }
458
459 if (v->state == 2) {
460 if (GB(v->tick_counter, 0, 2) == 0) {
461 Industry *i = Industry::Get(v->dest_tile.base()); // Industry destructor calls ReleaseDisastersTargetingIndustry, so this is valid
462 int x = TileX(i->location.tile) * TILE_SIZE;
463 int y = TileY(i->location.tile) * TILE_SIZE;
464 uint32_t r = Random();
465
467 GB(r, 0, 6) + x,
468 GB(r, 6, 6) + y,
469 GB(r, 12, 4),
471
472 if (++v->age >= 55) v->state = 3;
473 }
474 } else if (v->state == 1) {
475 if (++v->age == 112) {
476 v->state = 2;
478
479 Industry *i = Industry::Get(v->dest_tile.base()); // Industry destructor calls ReleaseDisastersTargetingIndustry, so this is valid
480 DestructIndustry(i);
481
482 AddIndustryNewsItem(GetEncodedString(news_message, i->town->index), NewsType::Accident, i->index);
483 if (_settings_client.sound.disaster) SndPlayTileFx(SND_12_EXPLOSION, i->location.tile);
484 }
485 } else if (v->state == 0) {
486 int x = v->x_pos + ((leave_at_top ? -15 : 15) * TILE_SIZE);
487 int y = v->y_pos;
488
489 if ((uint)x > Map::MaxX() * TILE_SIZE - 1) return true;
490
491 TileIndex tile = TileVirtXY(x, y);
492 if (!IsTileType(tile, TileType::Industry)) return true;
493
494 IndustryID ind = GetIndustryIndex(tile);
495 v->dest_tile = TileIndex{ind.base()};
496
497 if (GetIndustrySpec(Industry::Get(ind)->type)->behaviour.Test(behaviour)) {
498 v->state = 1;
500 }
501 }
502
503 return true;
504}
505
508{
509 return DisasterTick_Aircraft(v, SPR_F_15_FIRING, true, STR_NEWS_DISASTER_AIRPLANE_OIL_REFINERY, IndustryBehaviour::AirplaneAttacks);
510}
511
514{
515 return DisasterTick_Aircraft(v, SPR_AH_64A_FIRING, false, STR_NEWS_DISASTER_HELICOPTER_FACTORY, IndustryBehaviour::ChopperAttacks);
516}
517
520{
521 v->tick_counter++;
522 if (HasBit(v->tick_counter, 0)) return true;
523
524 SpriteID &cur_image = v->sprite_cache.sprite_seq.seq[0].sprite;
525 if (++cur_image > SPR_ROTOR_MOVING_3) cur_image = SPR_ROTOR_MOVING_1;
526
528
529 return true;
530}
531
540{
541 v->tick_counter++;
542
543 if (v->state == 1) {
544 int x = TileX(v->dest_tile) * TILE_SIZE + TILE_SIZE / 2;
545 int y = TileY(v->dest_tile) * TILE_SIZE + TILE_SIZE / 2;
546 if (Delta(v->x_pos, x) + Delta(v->y_pos, y) >= 8) {
547 v->direction = GetDirectionTowards(v, x, y);
548
550 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
551 return true;
552 }
553
554 if (!IsValidTile(v->dest_tile)) {
555 /* Make sure we don't land outside the map. */
556 delete v;
557 return false;
558 }
559
560 int z = GetSlopePixelZ(v->x_pos, v->y_pos);
561 if (z < v->z_pos) {
562 v->UpdatePosition(v->x_pos, v->y_pos, v->z_pos - 1);
563 return true;
564 }
565
566 v->state = 2;
567
568 for (Vehicle *target : Vehicle::Iterate()) {
569 if (target->IsGroundVehicle()) {
570 if (Delta(target->x_pos, v->x_pos) + Delta(target->y_pos, v->y_pos) <= 12 * (int)TILE_SIZE) {
571 target->breakdown_ctr = 5;
572 target->breakdown_delay = 0xF0;
573 }
574 }
575 }
576
577 Town *t = ClosestTownFromTile(v->dest_tile, UINT_MAX);
578 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_BIG_UFO, t->index), NewsType::Accident, v->tile);
579
580 if (!Vehicle::CanAllocateItem(2)) {
581 delete v;
582 return false;
583 }
586 u->SetNext(w);
587 } else if (v->state == 0) {
588 int x = TileX(v->dest_tile) * TILE_SIZE;
589 int y = TileY(v->dest_tile) * TILE_SIZE;
590 if (Delta(x, v->x_pos) + Delta(y, v->y_pos) >= (int)TILE_SIZE) {
591 v->direction = GetDirectionTowards(v, x, y);
593 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
594 return true;
595 }
596
597 if (++v->age < 6) {
598 v->dest_tile = RandomTile();
599 return true;
600 }
601 v->state = 1;
602
603 const auto is_valid_target = [](const Train *t) {
604 return t->IsFrontEngine() // Only the engines
605 && Company::IsHumanID(t->owner) // Don't break AIs
606 && IsPlainRailTile(t->tile) // No tunnels
607 && !t->vehstatus.Test(VehState::Crashed); // Not crashed
608 };
609
610 uint n = 0; // Total number of targetable trains.
611 for (const Train *t : Train::Iterate()) {
612 if (is_valid_target(t)) n++;
613 }
614
615 if (n == 0) {
616 /* If there are no targetable trains, destroy the UFO. */
617 delete v;
618 return false;
619 }
620
621 n = RandomRange(n); // Choose one of them.
622 for (const Train *t : Train::Iterate()) {
623 /* Find (n+1)-th train. */
624 if (is_valid_target(t) && (n-- == 0)) {
625 /* Target it. */
626 v->dest_tile = t->tile;
628 break;
629 }
630 }
631 }
632
633 return true;
634}
635
642{
643 v->tick_counter++;
644
646 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
647
648 if (gp.x > (int)(Map::SizeX() * TILE_SIZE + 9 * TILE_SIZE) - 1) {
649 delete v;
650 return false;
651 }
652
653 if (v->state == 0) {
655 if (Delta(v->x_pos, u->x_pos) > (int)TILE_SIZE) return true;
656 v->state = 1;
657
659 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, u);
660
661 delete u;
662
663 for (int i = 0; i != 80; i++) {
664 uint32_t r = Random();
666 GB(r, 0, 6) + v->x_pos - 32,
667 GB(r, 5, 6) + v->y_pos - 32,
668 0,
670 }
671
672 for (int dy = -3; dy < 3; dy++) {
673 for (int dx = -3; dx < 3; dx++) {
674 TileIndex tile = TileAddWrap(v->tile, dx, dy);
675 if (tile != INVALID_TILE) DisasterClearSquare(tile);
676 }
677 }
678 }
679
680 return true;
681}
682
689{
690 v->tick_counter++;
691
692 if (++v->age > 8880) {
693 delete v;
694 return false;
695 }
696
697 if (!HasBit(v->tick_counter, 0)) return true;
698
700 if (IsValidTile(tile)) {
702 if (trackbits == TRACK_BIT_ALL && !Chance16(1, 90)) {
704 v->UpdatePosition(gp.x, gp.y, v->z_pos);
705 return true;
706 }
707 }
708
709 v->direction = ChangeDir(v->direction, GB(Random(), 0, 1) ? DirDiff::Right90 : DirDiff::Left90);
710
711 return true;
712}
713
714
716static bool DisasterTick_NULL([[maybe_unused]] DisasterVehicle *v)
717{
718 return true;
719}
720
727
728static DisasterVehicleTickProc * const _disastervehicle_tick_procs[] = {
737};
738
739
741{
742 return _disastervehicle_tick_procs[this->subtype](this);
743}
744
745typedef void DisasterInitProc();
746
747
753{
754 if (!Vehicle::CanAllocateItem(2)) return;
755
756 /* Pick a random place, unless we find an airport */
757 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
758
759 for (const Station *st : Station::Iterate()) {
760 if (st->airport.tile != INVALID_TILE && (st->airport.type == AT_SMALL || st->airport.type == AT_LARGE)) {
761 x = (TileX(st->airport.tile) + 2) * TILE_SIZE;
762 break;
763 }
764 }
765
767 /* Allocate shadow */
769 v->SetNext(u);
770}
771
772
778{
779 if (!Vehicle::CanAllocateItem(2)) return;
780
781 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
783 v->dest_tile = TileXY(Map::SizeX() / 2, Map::SizeY() / 2);
784
785 /* Allocate shadow */
787 v->SetNext(u);
788}
789
790
793{
794 if (!Vehicle::CanAllocateItem(2)) return;
795
796 Industry *found = nullptr;
797
798 for (Industry *i : Industry::Iterate()) {
800 (found == nullptr || Chance16(1, 2))) {
801 found = i;
802 }
803 }
804
805 if (found == nullptr) return;
806
807 /* Start from the bottom (south side) of the map */
808 int x = (Map::SizeX() + 9) * TILE_SIZE - 1;
809 int y = TileY(found->location.tile) * TILE_SIZE + 37;
810
813 v->SetNext(u);
814}
815
816
819{
820 if (!Vehicle::CanAllocateItem(3)) return;
821
822 Industry *found = nullptr;
823
824 for (Industry *i : Industry::Iterate()) {
826 (found == nullptr || Chance16(1, 2))) {
827 found = i;
828 }
829 }
830
831 if (found == nullptr) return;
832
833 int x = -16 * (int)TILE_SIZE;
834 int y = TileY(found->location.tile) * TILE_SIZE + 37;
835
838 v->SetNext(u);
839
841 u->SetNext(w);
842}
843
844
847{
848 if (!Vehicle::CanAllocateItem(2)) return;
849
850 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
851 int y = Map::MaxX() * TILE_SIZE - 1;
852
854 v->dest_tile = TileXY(Map::SizeX() / 2, Map::SizeY() / 2);
855
856 /* Allocate shadow */
858 v->SetNext(u);
859}
860
861
867{
868 if (!Vehicle::CanAllocateItem()) return;
869
870 int y;
871 Direction dir;
872 uint32_t r = Random();
873 int x = TileX(RandomTileSeed(r)) * TILE_SIZE + TILE_SIZE / 2;
874
875 if (HasBit(r, 31)) {
876 y = Map::MaxY() * TILE_SIZE - TILE_SIZE / 2 - 1;
877 dir = Direction::NW;
878 } else {
879 y = TILE_SIZE / 2;
880 if (_settings_game.construction.freeform_edges) y += TILE_SIZE;
881 dir = Direction::SE;
882 }
883 if (!IsWaterTile(TileVirtXY(x, y))) return;
884
885 DisasterVehicle::Create(x, y, dir, subtype);
886}
887
893
894
900
901
907{
908 int index = GB(Random(), 0, 4);
909
910 for (uint m = 0; m < 15; m++) {
911 for (const Industry *i : Industry::Iterate()) {
913 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_COAL_MINE_SUBSIDENCE, i->town->index), NewsType::Accident, i->location.tile + TileDiffXY(1, 1)); // keep the news, even when the mine closes
914
915 {
916 TileIndex tile = i->location.tile;
917 TileIndexDiff step = TileOffsByDiagDir((DiagDirection)GB(Random(), 0, 2));
918
919 for (uint n = 0; n < 30; n++) {
920 DisasterClearSquare(tile);
921 tile += step;
922 if (!IsValidTile(tile)) break;
923 }
924 }
925 return;
926 }
927 }
928 }
929}
930
937
949
951static void DoDisaster()
952{
953 std::vector<DisasterInitProc *> available_disasters;
954
955 for (auto &disaster : _disasters) {
956 if (TimerGameCalendar::year >= disaster.min_year && TimerGameCalendar::year < disaster.max_year) {
957 available_disasters.push_back(disaster.init_proc);
958 }
959 }
960
961 if (available_disasters.empty()) return;
962
963 available_disasters[RandomRange(static_cast<uint32_t>(available_disasters.size()))]();
964}
965
968{
969 _disaster_delay = GB(Random(), 0, 9) + 730;
970}
971
973static const IntervalTimer<TimerGameEconomy> _economy_disaster_daily({TimerGameEconomy::Trigger::Day, TimerGameEconomy::Priority::Disaster}, [](auto)
974{
975 if (--_disaster_delay != 0) return;
976
978
979 if (_settings_game.difficulty.disasters != 0) DoDisaster();
980});
981
984{
986}
987
994{
996 /* primary disaster vehicles that have chosen target */
997 if (v->subtype == ST_AIRPLANE || v->subtype == ST_HELICOPTER) {
998 /* if it has chosen target, and it is this industry (yes, dest_tile is IndustryID here), set order to "leaving map peacefully" */
999 if (v->state > 0 && v->dest_tile == i.base()) v->state = 3;
1000 }
1001 }
1002}
1003
1009{
1011 if (v == nullptr) return;
1012
1013 /* primary disaster vehicles that have chosen target */
1014 assert(v->type == VehicleType::Disaster);
1015 assert(v->subtype == ST_SMALL_UFO);
1016 assert(v->state != 0);
1017
1018 /* Revert to target-searching */
1019 v->state = 0;
1020 v->dest_tile = RandomTile();
1021 GetAircraftFlightLevelBounds(v, &v->z_pos, nullptr);
1023}
1024
1026{
1027 this->bounds = {{-1, -1, 0}, {2, 2, 5}, {}};
1028}
Base functions for all AIs.
Base for aircraft.
void GetAircraftFlightLevelBounds(const Vehicle *v, int *min, int *max)
Get the 'flight level' bounds, in pixels from 'z_pos' 0 for a particular vehicle for normal flight si...
static const int ROTOR_Z_OFFSET
Z Offset between helicopter- and rotorsprite.
Definition aircraft.h:49
@ Zeppeliner
Block for the zeppeliner disaster vehicle.
Definition airport.h:129
@ RunwayIn
Runway used for landing (metropolitan / international / intercontinental airports).
Definition airport.h:100
@ AT_SMALL
Small airport.
Definition airport.h:29
@ AT_LARGE
Large airport.
Definition airport.h:30
Class for backupping variables and making sure they are restored later.
static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
static void NewEvent(CompanyID company, ScriptEvent *event)
Queue a new event for an AI.
Definition ai_core.cpp:221
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
static void NewEvent(class ScriptEvent *event)
Queue a new event for the game script.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
static Year year
Current year, starting at 0.
static constexpr TimerGame< struct Calendar >::Date MIN_DATE
StrongType::Typedef< int32_t, struct YearTag< struct Calendar >, StrongType::Compare, StrongType::Integer > Year
Functions related to commands.
@ Execute
execute the given command
Definition of stuff that is very close to a company, like the company struct itself.
CompanyID _current_company
Company currently doing an action.
Functions related to companies.
static constexpr Owner OWNER_NONE
The tile has no ownership.
static constexpr Owner OWNER_WATER
The tile/execution is done by "water".
Direction ChangeDir(Direction d, DirDiff delta)
Change a direction by a given difference.
DiagDirection DirToDiagDir(Direction dir)
Convert a Direction to a DiagDirection.
@ Left90
Angle of 90 degrees left.
@ Right90
Angle of 90 degrees right.
Direction
Defines the 8 directions on the map.
@ SW
Southwest.
@ NW
Northwest.
@ NE
Northeast.
@ SE
Southeast.
EnumIndexArray< T, Direction, Direction::End > DirectionIndexArray
Array with Direction as index.
DiagDirection
Enumeration for diagonal directions.
static bool DisasterTick_Big_Ufo_Destroyer(DisasterVehicle *v)
Skyranger destroying (Big) Ufo handling, v->state states: 0: Home in on landed Ufo and shoot it down.
static void Disaster_Airplane_Init()
Combat airplane which destroys an oil refinery.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_2
Sprites for small UFO.
static void Disaster_Small_Ufo_Init()
Ufo which flies around aimlessly from the middle of the map a bit until it locates a road vehicle whi...
static const DisasterCreation _disasters[]
Table per disaster subtype when to create disasters, and how to create them.
static void ResetDisasterDelay()
Resets the introduction of the next disaster.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_7
Sprites for large UFO destroyer.
static void DoDisaster()
Create a random disaster, if there is one available.
static bool DisasterTick_Big_Ufo(DisasterVehicle *v)
(Big) Ufo handling, v->state states: 0: Fly around to the middle of the map, then randomly for a whil...
static void Disaster_Helicopter_Init()
Combat helicopter that destroys a factory.
static bool DisasterTick_Zeppeliner(DisasterVehicle *v)
Zeppeliner handling, v->state states: 0: Zeppeliner initialization has found an airport,...
static bool DisasterTick_Helicopter_Rotors(DisasterVehicle *v)
Helicopter rotor blades; keep these spinning.
static void Disaster_Big_Submarine_Init()
Curious submarine #2, just floats around.
static const IntervalTimer< TimerGameEconomy > _economy_disaster_daily({TimerGameEconomy::Trigger::Day, TimerGameEconomy::Priority::Disaster}, [](auto) { if(--_disaster_delay !=0) return;ResetDisasterDelay();if(_settings_game.difficulty.disasters !=0) DoDisaster();})
Daily trigger to check whether to add a new disaster.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_8
Sprites for combat helicopter.
static void Disaster_Small_Submarine_Init()
Curious submarine #1, just floats around.
static bool DisasterTick_Airplane(DisasterVehicle *v)
Airplane handling.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_1
Sprites for blimp.
static void Disaster_Zeppeliner_Init()
Zeppeliner which crashes on an airport if one found, otherwise crashes on a random tile.
static void Disaster_Submarine_Init(DisasterSubType subtype)
Initialise a submarine.
uint16_t _disaster_delay
Delay counter for considering the next disaster.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_4
Sprites for small submarine.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_5
Sprites for large submarine.
bool(DisasterVehicle *v) DisasterVehicleTickProc
Perform any actions for a given vehicle.
void ReleaseDisasterVehicle(VehicleID vehicle)
Notify disasters that we are about to delete a vehicle.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_6
Sprites for large UFO.
static bool DisasterTick_NULL(DisasterVehicle *v)
No-op vehicle tick.
static bool DisasterTick_Aircraft(DisasterVehicle *v, uint16_t image_override, bool leave_at_top, StringID news_message, IndustryBehaviour behaviour)
Aircraft handling, v->state states: 0: Fly towards the targeted industry 1: If within 15 tiles,...
static bool DisasterTick_Ufo(DisasterVehicle *ufo)
(Small) Ufo handling, v->state states: 0: Fly around to the middle of the map, then randomly,...
static constexpr DirectionIndexArray< SpriteID > _disaster_images[]
Sprites for each disaster vehicle.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_9
Sprites for combat helicopter rotor.
void StartupDisasters()
Starts up disasters.
static bool DisasterTick_Submarine(DisasterVehicle *v)
Submarine, v->state states: Unused, just float around aimlessly and pop up at different places,...
static bool DisasterTick_Helicopter(DisasterVehicle *v)
Helicopter handling.
void ReleaseDisastersTargetingIndustry(IndustryID i)
Marks all disasters targeting this industry in such a way they won't call Industry::Get(v->dest_tile)...
static void Disaster_Big_Ufo_Init()
Big Ufo which lands on a piece of rail and will consequently be shot down by a combat airplane,...
static void Disaster_CoalMine_Init()
Coal mine catastrophe, destroys a stretch of 30 tiles of land in a certain direction.
static constexpr DirectionIndexArray< SpriteID > _disaster_images_3
Sprites for combat aircraft.
All disaster vehicles.
DisasterSubType
Different sub types of disaster vehicles.
@ ST_ZEPPELINER_SHADOW
Shadow of the zeppelin.
@ ST_HELICOPTER_SHADOW
Shadow of helicopter.
@ ST_SMALL_UFO_SHADOW
Shadow of small UFO.
@ ST_SMALL_UFO
Small UFO, tries to find a road vehicle to destroy.
@ ST_BIG_UFO
Big UFO, finds a piece of railroad to "park" on.
@ ST_BIG_UFO_SHADOW
Shadow of the big UFO.
@ ST_ZEPPELINER
Zeppelin, crashes at airports.
@ ST_BIG_UFO_DESTROYER_SHADOW
Shadow of the aircraft.
@ ST_BIG_UFO_DESTROYER
Aircraft the will bomb the big UFO.
@ ST_BIG_SUBMARINE
Big submarine, pops up in the oceans but doesn't do anything.
@ ST_SMALL_SUBMARINE
Small submarine, pops up in the oceans but doesn't do anything.
@ ST_HELICOPTER
Helicopter destroying a factory.
@ ST_AIRPLANE
Airplane destroying an oil refinery.
@ ST_HELICOPTER_ROTORS
Rotors of helicopter.
@ ST_AIRPLANE_SHADOW
Shadow of airplane.
EffectVehicle * CreateEffectVehicleRel(const Vehicle *v, int x, int y, int z, EffectVehicleType type)
Create an effect vehicle above a particular vehicle.
EffectVehicle * CreateEffectVehicleAbove(int x, int y, int z, EffectVehicleType type)
Create an effect vehicle above a particular location.
Functions related to effect vehicles.
@ EV_CRASH_SMOKE
Smoke of disasters.
@ EV_EXPLOSION_SMALL
Various explosions.
@ EV_EXPLOSION_LARGE
Various explosions.
Base functions for all Games.
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
Base of all industries.
const IndustrySpec * GetIndustrySpec(IndustryType thistype)
Accessor for array _industry_specs.
void ResetIndustryConstructionStage(Tile tile)
Reset the construction stage counter of the industry, as well as the completion bit.
IndustryID GetIndustryIndex(Tile t)
Get the industry ID of the given tile.
IndustryBehaviour
Various industry behaviours mostly to represent original TTD specialities.
@ AirplaneAttacks
can be exploded by a military airplane (oil refinery)
@ CanSubsidence
can cause a subsidence (coal mine, shaft that collapses)
@ ChopperAttacks
can be exploded by a military helicopter (factory)
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, RoadTramType sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
int GetSlopePixelZ(int x, int y, bool ground_vehicle)
Return world Z coordinate of a given point of a tile.
Command definitions related to landscape (slopes etc.).
TileIndex TileAddWrap(TileIndex tile, int addx, int addy)
This function checks if we add addx/addy to tile, if we do wrap around the edges.
Definition map.cpp:120
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:407
TileIndex RandomTileSeed(uint32_t r)
Get a random tile out of a given seed.
Definition map_func.h:645
TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition map_func.h:392
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition map_func.h:376
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:429
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:419
#define RandomTile()
Get a valid random tile.
Definition map_func.h:656
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:574
int32_t TileIndexDiff
An offset value between two tiles.
Definition map_type.h:23
constexpr T Delta(const T a, const T b)
Returns the (absolute) difference between two (scalar) variables.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
Functions related to news.
@ Accident
An accident or disaster has occurred.
Definition news_type.h:32
static bool IsRailDepot(Tile t)
Is this rail tile a rail depot?
Definition rail_map.h:95
static bool IsPlainRailTile(Tile t)
Checks whether the tile is a rail tile or rail tile with signals.
Definition rail_map.h:60
Pseudo random number generator.
uint32_t RandomRange(uint32_t limit, const std::source_location location=std::source_location::current())
Pick a random number between 0 and limit - 1, inclusive.
bool Chance16(const uint32_t a, const uint32_t b, const std::source_location location=std::source_location::current())
Flips a coin with given probability.
@ Invalid
Invalid marker.
Definition road_type.h:41
Road vehicle states.
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
void UpdateSignalsInBuffer()
Update signals in buffer Called from 'outside'.
Definition signal.cpp:580
Functions related to sound.
@ SND_12_EXPLOSION
16 == 0x10 Destruction, crashes, disasters, ...
Definition sound_type.h:64
Base classes/functions for stations.
bool IsAirportTile(Tile t)
Is this tile a station tile and an airport tile?
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
Definition of base types and functions in a cross-platform compatible way.
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
Functions related to OTTD's strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
AirportBlocks blocks
stores which blocks on the airport are taken. was 16 bit earlier on, then 32
Class to backup a specific variable and restore it upon destruction of this object to prevent stack v...
static BaseStation * GetByTile(TileIndex tile)
Get the base station belonging to a specific tile.
VehicleType type
Type of vehicle.
static bool IsHumanID(auto index)
Is this company a company not controlled by a NoAI program?
Initialisation function and time period to run the different disasters.
TimerGameCalendar::Year min_year
The first year this disaster will occur.
DisasterInitProc * init_proc
The init function for this disaster.
TimerGameCalendar::Year max_year
The last year this disaster will occur.
Disasters, like submarines, skyrangers and their shadows, belong to this class.
void UpdateDeltaXY() override
Updates the x and y offsets and the size of the sprite used for this vehicle.
SpriteID image_override
Override for the default disaster vehicle sprite.
DisasterVehicle(VehicleID index)
For use by saveload.
void UpdatePosition(int x, int y, int z)
Update the position of the vehicle.
VehicleID big_ufo_destroyer_target
The big UFO that this destroyer is supposed to bomb.
bool Tick() override
Calls the tick handler of the vehicle.
uint16_t state
Action stage of the disaster vehicle.
Position information of a vehicle after it moved.
int y
x and y position of the vehicle after moving
IndustryBehaviours behaviour
How this industry will behave, and how others entities can use it.
Defines the internal data of a functional industry.
Definition industry.h:62
IndustryType type
type of industry.
Definition industry.h:115
Town * town
Nearest town.
Definition industry.h:107
TileArea location
Location of the industry.
Definition industry.h:106
bool TileBelongsToIndustry(TileIndex tile) const
Check if a given tile belongs to this industry.
Definition industry.h:148
static uint SizeX()
Get the size of the map along the X.
Definition map_func.h:262
static uint SizeY()
Get the size of the map along the Y.
Definition map_func.h:271
static IterateWrapper Iterate()
Returns an iterable ensemble of all Tiles.
Definition map_func.h:366
static uint MaxY()
Gets the maximum Y coordinate within the map, including TileType::Void.
Definition map_func.h:298
static uint MaxX()
Gets the maximum X coordinate within the map, including TileType::Void.
Definition map_func.h:289
VehicleSpriteSeq sprite_seq
Vehicle appearance.
TileIndex tile
The base tile of the area.
static Pool::IterateWrapper< Company > Iterate(size_t from=0)
static Vehicle * Get(auto index)
static bool CanAllocateItem(size_t n=1)
static T * Create(Targs &&... args)
static Vehicle * GetIfValid(auto index)
Buses, trucks and trams belong to this class.
Definition roadveh.h:105
uint Crash(bool flooded=false) override
Common code executed for crashed ground vehicles.
uint16_t crashed_ctr
Animation counter when the vehicle has crashed.
Definition roadveh.h:112
VehicleID disaster_vehicle
NOSAVE: Disaster vehicle targetting this vehicle.
Definition roadveh.h:116
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
SpecializedVehicle< DisasterVehicle, Type > SpecializedVehicleBase
Station data structure.
Airport airport
Tile area the airport covers.
Town data structure.
Definition town.h:63
'Train' is either a loco or a wagon.
Definition train.h:97
Vehicle data structure.
int32_t z_pos
z coordinate.
Direction direction
facing
uint8_t subtype
subtype (Filled with values from AircraftSubType/DisasterSubType/EffectVehicleType/GroundVehicleSubty...
uint8_t breakdown_ctr
Counter for managing breakdown events.
uint8_t breakdown_delay
Counter for managing breakdown length.
VehStates vehstatus
Status.
int32_t y_pos
y coordinate.
int32_t x_pos
x coordinate.
SpriteBounds bounds
Bounding box of vehicle.
bool IsFrontEngine() const
Check if the vehicle is a front engine.
TimerGameCalendar::Date age
Age in calendar days.
void SetNext(Vehicle *next)
Set the next vehicle of this vehicle.
Definition vehicle.cpp:2987
MutableSpriteCache sprite_cache
Cache of sprites and values related to recalculating them, see MutableSpriteCache.
void UpdatePositionAndViewport()
Update the position of the vehicle, and update the viewport.
Definition vehicle.cpp:1782
uint8_t tick_counter
Increased by one for each tick.
TileIndex tile
Current tile index.
TileIndex dest_tile
Heading for this tile.
void UpdatePosition()
Update the position of the vehicle.
Definition vehicle.cpp:1699
Owner owner
Which company owns the vehicle?
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition tile_map.h:161
static TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:100
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
@ Industry
Part of an industry.
Definition tile_type.h:57
@ Railway
A tile with railway.
Definition tile_type.h:50
@ Trees
Tile with one or more trees.
Definition tile_type.h:53
@ House
A house by a town.
Definition tile_type.h:52
@ Clear
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition tile_type.h:49
Definition of Interval and OneShot timers.
Definition of the game-economy-timer.
Base of the town class.
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold.
TrackBits TrackdirBitsToTrackBits(TrackdirBits bits)
Discards all directional information from a TrackdirBits value.
Definition track_func.h:308
TrackBits
Bitfield corresponding to Track.
Definition track_type.h:42
@ TRACK_BIT_ALL
All possible tracks.
Definition track_type.h:57
Base for the train class.
@ TRANSPORT_WATER
Transport over water.
CommandCost EnsureNoVehicleOnGround(TileIndex tile)
Ensure there is no vehicle at the ground at the given position.
Definition vehicle.cpp:557
GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v)
Get position information of a vehicle when moving one pixel in the direction it is facing.
Definition vehicle.cpp:1802
@ Unclickable
Vehicle is not clickable by the user (shadow vehicles).
@ Crashed
Vehicle is crashed.
@ Shadow
Vehicle is a shadow vehicle.
@ Hidden
Vehicle is not visible.
Functions related to vehicles.
PoolID< uint32_t, struct VehicleIDTag, 0xFF000, 0xFFFFF > VehicleID
The type all our vehicle IDs have.
@ Road
Road vehicle type.
@ Disaster
Disaster vehicle type.
Functions related to (drawing on) viewports.
bool IsWaterTile(Tile t)
Is it a water tile with plain water?
Definition water_map.h:192