OpenTTD Source 20260512-master-g20b387b91f
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
90static const SpriteID _disaster_images_1[] = {SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP};
91static const 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};
92static const 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};
93static const 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};
94static const 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};
95static const 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};
96static const 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};
97static const 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};
98static const 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};
99
100static const SpriteID * const _disaster_images[] = {
101 _disaster_images_1, _disaster_images_1,
102 _disaster_images_2, _disaster_images_2,
103 _disaster_images_3, _disaster_images_3,
104 _disaster_images_8, _disaster_images_8, _disaster_images_9,
105 _disaster_images_6, _disaster_images_6,
106 _disaster_images_7, _disaster_images_7,
107 _disaster_images_4, _disaster_images_5,
108};
109
110void DisasterVehicle::UpdateImage()
111{
112 SpriteID img = this->image_override;
113 if (img == 0) img = _disaster_images[this->subtype][this->direction];
114 this->sprite_cache.sprite_seq.Set(img);
115}
116
128{
130
131 this->x_pos = x;
132 this->y_pos = y;
133 switch (subtype) {
134 case ST_ZEPPELINER:
135 case ST_SMALL_UFO:
136 case ST_AIRPLANE:
137 case ST_HELICOPTER:
138 case ST_BIG_UFO:
140 GetAircraftFlightLevelBounds(this, &this->z_pos, nullptr);
141 break;
142
144 GetAircraftFlightLevelBounds(this, &this->z_pos, nullptr);
145 this->z_pos += ROTOR_Z_OFFSET;
146 break;
147
149 case ST_BIG_SUBMARINE:
150 this->z_pos = 0;
151 break;
152
159 this->z_pos = 0;
160 this->vehstatus.Set(VehState::Shadow);
161 break;
162 }
163
164 this->direction = direction;
165 this->tile = TileVirtXY(x, y);
166 this->subtype = subtype;
167 this->UpdateDeltaXY();
168 this->owner = OWNER_NONE;
169 this->image_override = 0;
170 this->state = 0;
171
172 this->UpdateImage();
174}
175
182void DisasterVehicle::UpdatePosition(int x, int y, int z)
183{
184 this->x_pos = x;
185 this->y_pos = y;
186 this->z_pos = z;
187 this->tile = TileVirtXY(x, y);
188
189 this->UpdateImage();
191
192 DisasterVehicle *u = this->Next();
193 if (u != nullptr) {
194 int safe_x = Clamp(x, 0, Map::MaxX() * TILE_SIZE);
195 int safe_y = Clamp(y - 1, 0, Map::MaxY() * TILE_SIZE);
196
197 u->x_pos = x;
198 u->y_pos = y - 1 - (std::max(z - GetSlopePixelZ(safe_x, safe_y), 0) >> 3);
199 safe_y = Clamp(u->y_pos, 0, Map::MaxY() * TILE_SIZE);
200 u->z_pos = GetSlopePixelZ(safe_x, safe_y);
201 u->direction = this->direction;
202
203 u->UpdateImage();
205
206 if ((u = u->Next()) != nullptr) {
207 u->x_pos = x;
208 u->y_pos = y;
209 u->z_pos = z + ROTOR_Z_OFFSET;
211 }
212 }
213}
214
225{
226 v->tick_counter++;
227
228 if (v->state < 2) {
229 if (HasBit(v->tick_counter, 0)) return true;
230
232
233 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
234
235 if (v->state == 1) {
236 if (++v->age == 38) {
237 v->state = 2;
239 }
240
241 if (GB(v->tick_counter, 0, 3) == 0) CreateEffectVehicleRel(v, 0, -17, 2, EV_CRASH_SMOKE);
242
243 } else if (v->state == 0) {
244 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
245 v->state = 1;
247
248 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_ZEPPELIN, GetStationIndex(v->tile)), NewsType::Accident, v->tile);
249 AI::NewEvent(GetTileOwner(v->tile), new ScriptEventDisasterZeppelinerCrashed(GetStationIndex(v->tile)));
250 }
251 }
252
253 if (v->y_pos >= (int)((Map::SizeY() + 9) * TILE_SIZE - 1)) {
254 delete v;
255 return false;
256 }
257
258 return true;
259 }
260
261 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
263 }
264
265 if (v->state > 2) {
266 if (++v->age <= 13320) return true;
267
268 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
271 AI::NewEvent(GetTileOwner(v->tile), new ScriptEventDisasterZeppelinerCleared(st->index));
272 }
273
274 v->UpdatePosition(v->x_pos, v->y_pos, GetAircraftFlightLevel(v));
275 delete v;
276 return false;
277 }
278
279 int x = v->x_pos;
280 int y = v->y_pos;
281 int z = GetSlopePixelZ(x, y);
282 if (z < v->z_pos) z = v->z_pos - 1;
283 v->UpdatePosition(x, y, z);
284
285 if (++v->age == 1) {
287 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, v);
288 v->image_override = SPR_BLIMP_CRASHING;
289 } else if (v->age == 70) {
290 v->image_override = SPR_BLIMP_CRASHED;
291 } else if (v->age <= 300) {
292 if (GB(v->tick_counter, 0, 3) == 0) {
293 uint32_t r = Random();
294
296 GB(r, 0, 4) - 7,
297 GB(r, 4, 4) - 7,
298 GB(r, 8, 3) + 5,
300 }
301 } else if (v->age == 350) {
302 v->state = 3;
304 }
305
306 return true;
307}
308
318{
319 ufo->image_override = (HasBit(++ufo->tick_counter, 3)) ? SPR_UFO_SMALL_SCOUT_DARKER : SPR_UFO_SMALL_SCOUT;
320
321 if (ufo->state == 0) {
322 /* Fly around randomly */
323 int x = TileX(ufo->dest_tile) * TILE_SIZE;
324 int y = TileY(ufo->dest_tile) * TILE_SIZE;
325 if (Delta(x, ufo->x_pos) + Delta(y, ufo->y_pos) >= (int)TILE_SIZE) {
326 ufo->direction = GetDirectionTowards(ufo, x, y);
328 ufo->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(ufo));
329 return true;
330 }
331 if (++ufo->age < 6) {
332 ufo->dest_tile = RandomTile();
333 return true;
334 }
335 ufo->state = 1;
336
337 uint n = 0; // Total number of targetable road vehicles.
338 for (const Company *c : Company::Iterate()) {
339 n += c->group_all[VehicleType::Road].num_vehicle;
340 }
341
342 if (n == 0) {
343 /* If there are no targetable road vehicles, destroy the UFO. */
344 delete ufo;
345 return false;
346 }
347
348 n = RandomRange(n); // Choose one of them.
349 for (RoadVehicle *u : RoadVehicle::Iterate()) {
350 /* Find (n+1)-th road vehicle. */
351 if (u->IsFrontEngine() && (n-- == 0)) {
352 if (u->crashed_ctr != 0 || u->disaster_vehicle != VehicleID::Invalid()) {
353 /* Targetted vehicle is crashed or already a target, destroy the UFO. */
354 delete ufo;
355 return false;
356 }
357 /* Target it. */
358 ufo->dest_tile = TileIndex{u->index.base()};
360 u->disaster_vehicle = ufo->index;
361 break;
362 }
363 }
364
365 return true;
366 } else {
367 /* Target a vehicle */
368 RoadVehicle *target = RoadVehicle::Get(ufo->dest_tile.base());
369 assert(target != nullptr && target->type == VehicleType::Road && target->IsFrontEngine());
370
371 uint dist = Delta(ufo->x_pos, target->x_pos) + Delta(ufo->y_pos, target->y_pos);
372
373 if (dist < TILE_SIZE && !target->vehstatus.Test(VehState::Hidden) && target->breakdown_ctr == 0) {
374 target->breakdown_ctr = 3;
375 target->breakdown_delay = 140;
376 }
377
378 ufo->direction = GetDirectionTowards(ufo, target->x_pos, target->y_pos);
380
381 int z = ufo->z_pos;
382 if (dist <= TILE_SIZE && z > target->z_pos) z--;
383 ufo->UpdatePosition(gp.x, gp.y, z);
384
385 /* If the vehicle is hidden in a depot or similar treat it as having "escaped" being crashed to avoid the Ufo looping forever,
386 * but we'll still explode the surrounding area ;) */
387 if (z <= target->z_pos) {
388 ufo->age++;
389 if (!target->vehstatus.Test(VehState::Hidden) && target->crashed_ctr == 0) {
390 uint victims = target->Crash();
391 target->disaster_vehicle = VehicleID::Invalid();
392
393 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_SMALL_UFO), NewsType::Accident, target->tile);
394
395 AI::NewEvent(target->owner, new ScriptEventVehicleCrashed(target->index, target->tile, ScriptEventVehicleCrashed::CRASH_RV_UFO, victims, target->owner));
396 Game::NewEvent(new ScriptEventVehicleCrashed(target->index, target->tile, ScriptEventVehicleCrashed::CRASH_RV_UFO, victims, target->owner));
397 }
398 }
399
400 /* Destroy? */
401 if (ufo->age > 50) {
403 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, ufo);
404 delete ufo;
405 return false;
406 }
407 }
408
409 return true;
410}
411
412static void DestructIndustry(Industry *i)
413{
414 for (const auto tile : Map::Iterate()) {
415 if (i->TileBelongsToIndustry(tile)) {
418 }
419 }
420}
421
436static bool DisasterTick_Aircraft(DisasterVehicle *v, uint16_t image_override, bool leave_at_top, StringID news_message, IndustryBehaviour behaviour)
437{
438 v->tick_counter++;
439 v->image_override = (v->state == 1 && HasBit(v->tick_counter, 2)) ? image_override : 0;
440
442 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
443
444 if ((leave_at_top && gp.x < (-10 * (int)TILE_SIZE)) || (!leave_at_top && gp.x > (int)(Map::SizeX() * TILE_SIZE + 9 * TILE_SIZE) - 1)) {
445 delete v;
446 return false;
447 }
448
449 if (v->state == 2) {
450 if (GB(v->tick_counter, 0, 2) == 0) {
451 Industry *i = Industry::Get(v->dest_tile.base()); // Industry destructor calls ReleaseDisastersTargetingIndustry, so this is valid
452 int x = TileX(i->location.tile) * TILE_SIZE;
453 int y = TileY(i->location.tile) * TILE_SIZE;
454 uint32_t r = Random();
455
457 GB(r, 0, 6) + x,
458 GB(r, 6, 6) + y,
459 GB(r, 12, 4),
461
462 if (++v->age >= 55) v->state = 3;
463 }
464 } else if (v->state == 1) {
465 if (++v->age == 112) {
466 v->state = 2;
468
469 Industry *i = Industry::Get(v->dest_tile.base()); // Industry destructor calls ReleaseDisastersTargetingIndustry, so this is valid
470 DestructIndustry(i);
471
472 AddIndustryNewsItem(GetEncodedString(news_message, i->town->index), NewsType::Accident, i->index);
473 if (_settings_client.sound.disaster) SndPlayTileFx(SND_12_EXPLOSION, i->location.tile);
474 }
475 } else if (v->state == 0) {
476 int x = v->x_pos + ((leave_at_top ? -15 : 15) * TILE_SIZE);
477 int y = v->y_pos;
478
479 if ((uint)x > Map::MaxX() * TILE_SIZE - 1) return true;
480
481 TileIndex tile = TileVirtXY(x, y);
482 if (!IsTileType(tile, TileType::Industry)) return true;
483
484 IndustryID ind = GetIndustryIndex(tile);
485 v->dest_tile = TileIndex{ind.base()};
486
487 if (GetIndustrySpec(Industry::Get(ind)->type)->behaviour.Test(behaviour)) {
488 v->state = 1;
490 }
491 }
492
493 return true;
494}
495
498{
499 return DisasterTick_Aircraft(v, SPR_F_15_FIRING, true, STR_NEWS_DISASTER_AIRPLANE_OIL_REFINERY, IndustryBehaviour::AirplaneAttacks);
500}
501
504{
505 return DisasterTick_Aircraft(v, SPR_AH_64A_FIRING, false, STR_NEWS_DISASTER_HELICOPTER_FACTORY, IndustryBehaviour::ChopperAttacks);
506}
507
510{
511 v->tick_counter++;
512 if (HasBit(v->tick_counter, 0)) return true;
513
514 SpriteID &cur_image = v->sprite_cache.sprite_seq.seq[0].sprite;
515 if (++cur_image > SPR_ROTOR_MOVING_3) cur_image = SPR_ROTOR_MOVING_1;
516
518
519 return true;
520}
521
530{
531 v->tick_counter++;
532
533 if (v->state == 1) {
534 int x = TileX(v->dest_tile) * TILE_SIZE + TILE_SIZE / 2;
535 int y = TileY(v->dest_tile) * TILE_SIZE + TILE_SIZE / 2;
536 if (Delta(v->x_pos, x) + Delta(v->y_pos, y) >= 8) {
537 v->direction = GetDirectionTowards(v, x, y);
538
540 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
541 return true;
542 }
543
544 if (!IsValidTile(v->dest_tile)) {
545 /* Make sure we don't land outside the map. */
546 delete v;
547 return false;
548 }
549
550 int z = GetSlopePixelZ(v->x_pos, v->y_pos);
551 if (z < v->z_pos) {
552 v->UpdatePosition(v->x_pos, v->y_pos, v->z_pos - 1);
553 return true;
554 }
555
556 v->state = 2;
557
558 for (Vehicle *target : Vehicle::Iterate()) {
559 if (target->IsGroundVehicle()) {
560 if (Delta(target->x_pos, v->x_pos) + Delta(target->y_pos, v->y_pos) <= 12 * (int)TILE_SIZE) {
561 target->breakdown_ctr = 5;
562 target->breakdown_delay = 0xF0;
563 }
564 }
565 }
566
567 Town *t = ClosestTownFromTile(v->dest_tile, UINT_MAX);
568 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_BIG_UFO, t->index), NewsType::Accident, v->tile);
569
570 if (!Vehicle::CanAllocateItem(2)) {
571 delete v;
572 return false;
573 }
576 u->SetNext(w);
577 } else if (v->state == 0) {
578 int x = TileX(v->dest_tile) * TILE_SIZE;
579 int y = TileY(v->dest_tile) * TILE_SIZE;
580 if (Delta(x, v->x_pos) + Delta(y, v->y_pos) >= (int)TILE_SIZE) {
581 v->direction = GetDirectionTowards(v, x, y);
583 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
584 return true;
585 }
586
587 if (++v->age < 6) {
588 v->dest_tile = RandomTile();
589 return true;
590 }
591 v->state = 1;
592
593 const auto is_valid_target = [](const Train *t) {
594 return t->IsFrontEngine() // Only the engines
595 && Company::IsHumanID(t->owner) // Don't break AIs
596 && IsPlainRailTile(t->tile) // No tunnels
597 && !t->vehstatus.Test(VehState::Crashed); // Not crashed
598 };
599
600 uint n = 0; // Total number of targetable trains.
601 for (const Train *t : Train::Iterate()) {
602 if (is_valid_target(t)) n++;
603 }
604
605 if (n == 0) {
606 /* If there are no targetable trains, destroy the UFO. */
607 delete v;
608 return false;
609 }
610
611 n = RandomRange(n); // Choose one of them.
612 for (const Train *t : Train::Iterate()) {
613 /* Find (n+1)-th train. */
614 if (is_valid_target(t) && (n-- == 0)) {
615 /* Target it. */
616 v->dest_tile = t->tile;
618 break;
619 }
620 }
621 }
622
623 return true;
624}
625
632{
633 v->tick_counter++;
634
636 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
637
638 if (gp.x > (int)(Map::SizeX() * TILE_SIZE + 9 * TILE_SIZE) - 1) {
639 delete v;
640 return false;
641 }
642
643 if (v->state == 0) {
645 if (Delta(v->x_pos, u->x_pos) > (int)TILE_SIZE) return true;
646 v->state = 1;
647
649 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, u);
650
651 delete u;
652
653 for (int i = 0; i != 80; i++) {
654 uint32_t r = Random();
656 GB(r, 0, 6) + v->x_pos - 32,
657 GB(r, 5, 6) + v->y_pos - 32,
658 0,
660 }
661
662 for (int dy = -3; dy < 3; dy++) {
663 for (int dx = -3; dx < 3; dx++) {
664 TileIndex tile = TileAddWrap(v->tile, dx, dy);
665 if (tile != INVALID_TILE) DisasterClearSquare(tile);
666 }
667 }
668 }
669
670 return true;
671}
672
679{
680 v->tick_counter++;
681
682 if (++v->age > 8880) {
683 delete v;
684 return false;
685 }
686
687 if (!HasBit(v->tick_counter, 0)) return true;
688
690 if (IsValidTile(tile)) {
692 if (trackbits == TRACK_BIT_ALL && !Chance16(1, 90)) {
694 v->UpdatePosition(gp.x, gp.y, v->z_pos);
695 return true;
696 }
697 }
698
699 v->direction = ChangeDir(v->direction, GB(Random(), 0, 1) ? DIRDIFF_90RIGHT : DIRDIFF_90LEFT);
700
701 return true;
702}
703
704
706static bool DisasterTick_NULL([[maybe_unused]] DisasterVehicle *v)
707{
708 return true;
709}
710
717
718static DisasterVehicleTickProc * const _disastervehicle_tick_procs[] = {
727};
728
729
731{
732 return _disastervehicle_tick_procs[this->subtype](this);
733}
734
735typedef void DisasterInitProc();
736
737
743{
744 if (!Vehicle::CanAllocateItem(2)) return;
745
746 /* Pick a random place, unless we find an airport */
747 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
748
749 for (const Station *st : Station::Iterate()) {
750 if (st->airport.tile != INVALID_TILE && (st->airport.type == AT_SMALL || st->airport.type == AT_LARGE)) {
751 x = (TileX(st->airport.tile) + 2) * TILE_SIZE;
752 break;
753 }
754 }
755
757 /* Allocate shadow */
759 v->SetNext(u);
760}
761
762
768{
769 if (!Vehicle::CanAllocateItem(2)) return;
770
771 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
773 v->dest_tile = TileXY(Map::SizeX() / 2, Map::SizeY() / 2);
774
775 /* Allocate shadow */
777 v->SetNext(u);
778}
779
780
783{
784 if (!Vehicle::CanAllocateItem(2)) return;
785
786 Industry *found = nullptr;
787
788 for (Industry *i : Industry::Iterate()) {
790 (found == nullptr || Chance16(1, 2))) {
791 found = i;
792 }
793 }
794
795 if (found == nullptr) return;
796
797 /* Start from the bottom (south side) of the map */
798 int x = (Map::SizeX() + 9) * TILE_SIZE - 1;
799 int y = TileY(found->location.tile) * TILE_SIZE + 37;
800
803 v->SetNext(u);
804}
805
806
809{
810 if (!Vehicle::CanAllocateItem(3)) return;
811
812 Industry *found = nullptr;
813
814 for (Industry *i : Industry::Iterate()) {
816 (found == nullptr || Chance16(1, 2))) {
817 found = i;
818 }
819 }
820
821 if (found == nullptr) return;
822
823 int x = -16 * (int)TILE_SIZE;
824 int y = TileY(found->location.tile) * TILE_SIZE + 37;
825
828 v->SetNext(u);
829
831 u->SetNext(w);
832}
833
834
837{
838 if (!Vehicle::CanAllocateItem(2)) return;
839
840 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
841 int y = Map::MaxX() * TILE_SIZE - 1;
842
844 v->dest_tile = TileXY(Map::SizeX() / 2, Map::SizeY() / 2);
845
846 /* Allocate shadow */
848 v->SetNext(u);
849}
850
851
857{
858 if (!Vehicle::CanAllocateItem()) return;
859
860 int y;
861 Direction dir;
862 uint32_t r = Random();
863 int x = TileX(RandomTileSeed(r)) * TILE_SIZE + TILE_SIZE / 2;
864
865 if (HasBit(r, 31)) {
866 y = Map::MaxY() * TILE_SIZE - TILE_SIZE / 2 - 1;
867 dir = DIR_NW;
868 } else {
869 y = TILE_SIZE / 2;
870 if (_settings_game.construction.freeform_edges) y += TILE_SIZE;
871 dir = DIR_SE;
872 }
873 if (!IsWaterTile(TileVirtXY(x, y))) return;
874
875 DisasterVehicle::Create(x, y, dir, subtype);
876}
877
883
884
890
891
897{
898 int index = GB(Random(), 0, 4);
899
900 for (uint m = 0; m < 15; m++) {
901 for (const Industry *i : Industry::Iterate()) {
903 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
904
905 {
906 TileIndex tile = i->location.tile;
907 TileIndexDiff step = TileOffsByDiagDir((DiagDirection)GB(Random(), 0, 2));
908
909 for (uint n = 0; n < 30; n++) {
910 DisasterClearSquare(tile);
911 tile += step;
912 if (!IsValidTile(tile)) break;
913 }
914 }
915 return;
916 }
917 }
918 }
919}
920
927
939
941static void DoDisaster()
942{
943 std::vector<DisasterInitProc *> available_disasters;
944
945 for (auto &disaster : _disasters) {
946 if (TimerGameCalendar::year >= disaster.min_year && TimerGameCalendar::year < disaster.max_year) {
947 available_disasters.push_back(disaster.init_proc);
948 }
949 }
950
951 if (available_disasters.empty()) return;
952
953 available_disasters[RandomRange(static_cast<uint32_t>(available_disasters.size()))]();
954}
955
958{
959 _disaster_delay = GB(Random(), 0, 9) + 730;
960}
961
963static const IntervalTimer<TimerGameEconomy> _economy_disaster_daily({TimerGameEconomy::Trigger::Day, TimerGameEconomy::Priority::Disaster}, [](auto)
964{
965 if (--_disaster_delay != 0) return;
966
968
969 if (_settings_game.difficulty.disasters != 0) DoDisaster();
970});
971
974{
976}
977
984{
986 /* primary disaster vehicles that have chosen target */
987 if (v->subtype == ST_AIRPLANE || v->subtype == ST_HELICOPTER) {
988 /* if it has chosen target, and it is this industry (yes, dest_tile is IndustryID here), set order to "leaving map peacefully" */
989 if (v->state > 0 && v->dest_tile == i.base()) v->state = 3;
990 }
991 }
992}
993
999{
1001 if (v == nullptr) return;
1002
1003 /* primary disaster vehicles that have chosen target */
1004 assert(v->type == VehicleType::Disaster);
1005 assert(v->subtype == ST_SMALL_UFO);
1006 assert(v->state != 0);
1007
1008 /* Revert to target-searching */
1009 v->state = 0;
1010 v->dest_tile = RandomTile();
1011 GetAircraftFlightLevelBounds(v, &v->z_pos, nullptr);
1013}
1014
1016{
1017 this->bounds = {{-1, -1, 0}, {2, 2, 5}, {}};
1018}
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.
@ DIRDIFF_90LEFT
Angle of 90 degrees left.
@ DIRDIFF_90RIGHT
Angle of 90 degrees right.
Direction
Defines the 8 directions on the map.
@ DIR_SW
Southwest.
@ DIR_NW
Northwest.
@ DIR_SE
Southeast.
@ DIR_NE
Northeast.
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 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 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 void Disaster_Small_Submarine_Init()
Curious submarine #1, just floats around.
static bool DisasterTick_Airplane(DisasterVehicle *v)
Airplane handling.
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.
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 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,...
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.
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:2968
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 TrackStatusToTrackBits(TrackStatus ts)
Returns the present-track-information of a TrackStatus.
Definition track_func.h:365
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
@ TRACK_BIT_ALL
All possible tracks.
Definition track_type.h:50
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