OpenTTD Source 20260108-master-g8ba1860eaa
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
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)) {
64 case MP_RAILWAY:
65 if (Company::IsHumanID(GetTileOwner(tile)) && !IsRailDepot(tile)) {
68 cur_company.Restore();
69
70 /* update signals in buffer */
72 }
73 break;
74
75 case MP_HOUSE: {
78 cur_company.Restore();
79 break;
80 }
81
82 case MP_TREES:
83 case MP_CLEAR:
84 DoClearSquare(tile);
85 break;
86
87 default:
88 break;
89 }
90}
91
92static const SpriteID _disaster_images_1[] = {SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP, SPR_BLIMP};
93static 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};
94static 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};
95static 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};
96static 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};
97static 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};
98static 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};
99static 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};
100static 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};
101
102static const SpriteID * const _disaster_images[] = {
103 _disaster_images_1, _disaster_images_1,
104 _disaster_images_2, _disaster_images_2,
105 _disaster_images_3, _disaster_images_3,
106 _disaster_images_8, _disaster_images_8, _disaster_images_9,
107 _disaster_images_6, _disaster_images_6,
108 _disaster_images_7, _disaster_images_7,
109 _disaster_images_4, _disaster_images_5,
110};
111
112void DisasterVehicle::UpdateImage()
113{
114 SpriteID img = this->image_override;
115 if (img == 0) img = _disaster_images[this->subtype][this->direction];
116 this->sprite_cache.sprite_seq.Set(img);
117}
118
128DisasterVehicle::DisasterVehicle(VehicleID index, int x, int y, Direction direction, DisasterSubType subtype, VehicleID big_ufo_destroyer_target) :
129 SpecializedVehicleBase(index), big_ufo_destroyer_target(big_ufo_destroyer_target)
130{
132
133 this->x_pos = x;
134 this->y_pos = y;
135 switch (subtype) {
136 case ST_ZEPPELINER:
137 case ST_SMALL_UFO:
138 case ST_AIRPLANE:
139 case ST_HELICOPTER:
140 case ST_BIG_UFO:
142 GetAircraftFlightLevelBounds(this, &this->z_pos, nullptr);
143 break;
144
146 GetAircraftFlightLevelBounds(this, &this->z_pos, nullptr);
147 this->z_pos += ROTOR_Z_OFFSET;
148 break;
149
151 case ST_BIG_SUBMARINE:
152 this->z_pos = 0;
153 break;
154
161 this->z_pos = 0;
163 break;
164 }
165
166 this->direction = direction;
167 this->tile = TileVirtXY(x, y);
168 this->subtype = subtype;
169 this->UpdateDeltaXY();
170 this->owner = OWNER_NONE;
171 this->image_override = 0;
172 this->state = 0;
173
174 this->UpdateImage();
176}
177
184void DisasterVehicle::UpdatePosition(int x, int y, int z)
185{
186 this->x_pos = x;
187 this->y_pos = y;
188 this->z_pos = z;
189 this->tile = TileVirtXY(x, y);
190
191 this->UpdateImage();
193
194 DisasterVehicle *u = this->Next();
195 if (u != nullptr) {
196 int safe_x = Clamp(x, 0, Map::MaxX() * TILE_SIZE);
197 int safe_y = Clamp(y - 1, 0, Map::MaxY() * TILE_SIZE);
198
199 u->x_pos = x;
200 u->y_pos = y - 1 - (std::max(z - GetSlopePixelZ(safe_x, safe_y), 0) >> 3);
201 safe_y = Clamp(u->y_pos, 0, Map::MaxY() * TILE_SIZE);
202 u->z_pos = GetSlopePixelZ(safe_x, safe_y);
203 u->direction = this->direction;
204
205 u->UpdateImage();
207
208 if ((u = u->Next()) != nullptr) {
209 u->x_pos = x;
210 u->y_pos = y;
211 u->z_pos = z + ROTOR_Z_OFFSET;
213 }
214 }
215}
216
226{
227 v->tick_counter++;
228
229 if (v->state < 2) {
230 if (HasBit(v->tick_counter, 0)) return true;
231
233
234 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
235
236 if (v->state == 1) {
237 if (++v->age == 38) {
238 v->state = 2;
240 }
241
242 if (GB(v->tick_counter, 0, 3) == 0) CreateEffectVehicleRel(v, 0, -17, 2, EV_CRASH_SMOKE);
243
244 } else if (v->state == 0) {
245 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
246 v->state = 1;
248
249 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_ZEPPELIN, GetStationIndex(v->tile)), NewsType::Accident, v->tile);
250 AI::NewEvent(GetTileOwner(v->tile), new ScriptEventDisasterZeppelinerCrashed(GetStationIndex(v->tile)));
251 }
252 }
253
254 if (v->y_pos >= (int)((Map::SizeY() + 9) * TILE_SIZE - 1)) {
255 delete v;
256 return false;
257 }
258
259 return true;
260 }
261
262 if (v->state > 2) {
263 if (++v->age <= 13320) return true;
264
265 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
267 st->airport.blocks.Reset({AirportBlock::Zeppeliner, AirportBlock::RunwayIn});
268 AI::NewEvent(GetTileOwner(v->tile), new ScriptEventDisasterZeppelinerCleared(st->index));
269 }
270
271 v->UpdatePosition(v->x_pos, v->y_pos, GetAircraftFlightLevel(v));
272 delete v;
273 return false;
274 }
275
276 int x = v->x_pos;
277 int y = v->y_pos;
278 int z = GetSlopePixelZ(x, y);
279 if (z < v->z_pos) z = v->z_pos - 1;
280 v->UpdatePosition(x, y, z);
281
282 if (++v->age == 1) {
284 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, v);
285 v->image_override = SPR_BLIMP_CRASHING;
286 } else if (v->age == 70) {
287 v->image_override = SPR_BLIMP_CRASHED;
288 } else if (v->age <= 300) {
289 if (GB(v->tick_counter, 0, 3) == 0) {
290 uint32_t r = Random();
291
293 GB(r, 0, 4) - 7,
294 GB(r, 4, 4) - 7,
295 GB(r, 8, 3) + 5,
297 }
298 } else if (v->age == 350) {
299 v->state = 3;
301 }
302
303 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
304 Station::GetByTile(v->tile)->airport.blocks.Reset({AirportBlock::Zeppeliner, AirportBlock::RunwayIn});
305 }
306
307 return true;
308}
309
319{
320 ufo->image_override = (HasBit(++ufo->tick_counter, 3)) ? SPR_UFO_SMALL_SCOUT_DARKER : SPR_UFO_SMALL_SCOUT;
321
322 if (ufo->state == 0) {
323 /* Fly around randomly */
324 int x = TileX(ufo->dest_tile) * TILE_SIZE;
325 int y = TileY(ufo->dest_tile) * TILE_SIZE;
326 if (Delta(x, ufo->x_pos) + Delta(y, ufo->y_pos) >= (int)TILE_SIZE) {
327 ufo->direction = GetDirectionTowards(ufo, x, y);
329 ufo->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(ufo));
330 return true;
331 }
332 if (++ufo->age < 6) {
333 ufo->dest_tile = RandomTile();
334 return true;
335 }
336 ufo->state = 1;
337
338 uint n = 0; // Total number of targetable road vehicles.
339 for (const Company *c : Company::Iterate()) {
340 n += c->group_all[VEH_ROAD].num_vehicle;
341 }
342
343 if (n == 0) {
344 /* If there are no targetable road vehicles, destroy the UFO. */
345 delete ufo;
346 return false;
347 }
348
349 n = RandomRange(n); // Choose one of them.
350 for (RoadVehicle *u : RoadVehicle::Iterate()) {
351 /* Find (n+1)-th road vehicle. */
352 if (u->IsFrontEngine() && (n-- == 0)) {
353 if (u->crashed_ctr != 0 || u->disaster_vehicle != VehicleID::Invalid()) {
354 /* Targetted vehicle is crashed or already a target, destroy the UFO. */
355 delete ufo;
356 return false;
357 }
358 /* Target it. */
359 ufo->dest_tile = TileIndex{u->index.base()};
361 u->disaster_vehicle = ufo->index;
362 break;
363 }
364 }
365
366 return true;
367 } else {
368 /* Target a vehicle */
369 RoadVehicle *target = RoadVehicle::Get(ufo->dest_tile.base());
370 assert(target != nullptr && target->type == VEH_ROAD && target->IsFrontEngine());
371
372 uint dist = Delta(ufo->x_pos, target->x_pos) + Delta(ufo->y_pos, target->y_pos);
373
374 if (dist < TILE_SIZE && !target->vehstatus.Test(VehState::Hidden) && target->breakdown_ctr == 0) {
375 target->breakdown_ctr = 3;
376 target->breakdown_delay = 140;
377 }
378
379 ufo->direction = GetDirectionTowards(ufo, target->x_pos, target->y_pos);
381
382 int z = ufo->z_pos;
383 if (dist <= TILE_SIZE && z > target->z_pos) z--;
384 ufo->UpdatePosition(gp.x, gp.y, z);
385
386 /* If the vehicle is hidden in a depot or similar treat it as having "escaped" being crashed to avoid the Ufo looping forever,
387 * but we'll still explode the surrounding area ;) */
388 if (z <= target->z_pos) {
389 ufo->age++;
390 if (!target->vehstatus.Test(VehState::Hidden) && target->crashed_ctr == 0) {
391 uint victims = target->Crash();
392 target->disaster_vehicle = VehicleID::Invalid();
393
394 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_SMALL_UFO), NewsType::Accident, target->tile);
395
396 AI::NewEvent(target->owner, new ScriptEventVehicleCrashed(target->index, target->tile, ScriptEventVehicleCrashed::CRASH_RV_UFO, victims, target->owner));
397 Game::NewEvent(new ScriptEventVehicleCrashed(target->index, target->tile, ScriptEventVehicleCrashed::CRASH_RV_UFO, victims, target->owner));
398 }
399 }
400
401 /* Destroy? */
402 if (ufo->age > 50) {
404 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, ufo);
405 delete ufo;
406 return false;
407 }
408 }
409
410 return true;
411}
412
413static void DestructIndustry(Industry *i)
414{
415 for (const auto tile : Map::Iterate()) {
416 if (i->TileBelongsToIndustry(tile)) {
419 }
420 }
421}
422
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);
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, MP_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
529{
530 v->tick_counter++;
531
532 if (v->state == 1) {
533 int x = TileX(v->dest_tile) * TILE_SIZE + TILE_SIZE / 2;
534 int y = TileY(v->dest_tile) * TILE_SIZE + TILE_SIZE / 2;
535 if (Delta(v->x_pos, x) + Delta(v->y_pos, y) >= 8) {
536 v->direction = GetDirectionTowards(v, x, y);
537
539 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
540 return true;
541 }
542
543 if (!IsValidTile(v->dest_tile)) {
544 /* Make sure we don't land outside the map. */
545 delete v;
546 return false;
547 }
548
549 int z = GetSlopePixelZ(v->x_pos, v->y_pos);
550 if (z < v->z_pos) {
551 v->UpdatePosition(v->x_pos, v->y_pos, v->z_pos - 1);
552 return true;
553 }
554
555 v->state = 2;
556
557 for (Vehicle *target : Vehicle::Iterate()) {
558 if (target->IsGroundVehicle()) {
559 if (Delta(target->x_pos, v->x_pos) + Delta(target->y_pos, v->y_pos) <= 12 * (int)TILE_SIZE) {
560 target->breakdown_ctr = 5;
561 target->breakdown_delay = 0xF0;
562 }
563 }
564 }
565
566 Town *t = ClosestTownFromTile(v->dest_tile, UINT_MAX);
567 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_BIG_UFO, t->index), NewsType::Accident, v->tile);
568
569 if (!Vehicle::CanAllocateItem(2)) {
570 delete v;
571 return false;
572 }
575 u->SetNext(w);
576 } else if (v->state == 0) {
577 int x = TileX(v->dest_tile) * TILE_SIZE;
578 int y = TileY(v->dest_tile) * TILE_SIZE;
579 if (Delta(x, v->x_pos) + Delta(y, v->y_pos) >= (int)TILE_SIZE) {
580 v->direction = GetDirectionTowards(v, x, y);
582 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
583 return true;
584 }
585
586 if (++v->age < 6) {
587 v->dest_tile = RandomTile();
588 return true;
589 }
590 v->state = 1;
591
592 const auto is_valid_target = [](const Train *t) {
593 return t->IsFrontEngine() // Only the engines
594 && Company::IsHumanID(t->owner) // Don't break AIs
595 && IsPlainRailTile(t->tile) // No tunnels
596 && !t->vehstatus.Test(VehState::Crashed); // Not crashed
597 };
598
599 uint n = 0; // Total number of targetable trains.
600 for (const Train *t : Train::Iterate()) {
601 if (is_valid_target(t)) n++;
602 }
603
604 if (n == 0) {
605 /* If there are no targetable trains, destroy the UFO. */
606 delete v;
607 return false;
608 }
609
610 n = RandomRange(n); // Choose one of them.
611 for (const Train *t : Train::Iterate()) {
612 /* Find (n+1)-th train. */
613 if (is_valid_target(t) && (n-- == 0)) {
614 /* Target it. */
615 v->dest_tile = t->tile;
617 break;
618 }
619 }
620 }
621
622 return true;
623}
624
630{
631 v->tick_counter++;
632
634 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
635
636 if (gp.x > (int)(Map::SizeX() * TILE_SIZE + 9 * TILE_SIZE) - 1) {
637 delete v;
638 return false;
639 }
640
641 if (v->state == 0) {
643 if (Delta(v->x_pos, u->x_pos) > (int)TILE_SIZE) return true;
644 v->state = 1;
645
647 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, u);
648
649 delete u;
650
651 for (int i = 0; i != 80; i++) {
652 uint32_t r = Random();
654 GB(r, 0, 6) + v->x_pos - 32,
655 GB(r, 5, 6) + v->y_pos - 32,
656 0,
658 }
659
660 for (int dy = -3; dy < 3; dy++) {
661 for (int dx = -3; dx < 3; dx++) {
662 TileIndex tile = TileAddWrap(v->tile, dx, dy);
663 if (tile != INVALID_TILE) DisasterClearSquare(tile);
664 }
665 }
666 }
667
668 return true;
669}
670
676{
677 v->tick_counter++;
678
679 if (++v->age > 8880) {
680 delete v;
681 return false;
682 }
683
684 if (!HasBit(v->tick_counter, 0)) return true;
685
687 if (IsValidTile(tile)) {
689 if (trackbits == TRACK_BIT_ALL && !Chance16(1, 90)) {
691 v->UpdatePosition(gp.x, gp.y, v->z_pos);
692 return true;
693 }
694 }
695
697
698 return true;
699}
700
701
702static bool DisasterTick_NULL(DisasterVehicle *)
703{
704 return true;
705}
706
707typedef bool DisasterVehicleTickProc(DisasterVehicle *v);
708
709static DisasterVehicleTickProc * const _disastervehicle_tick_procs[] = {
710 DisasterTick_Zeppeliner, DisasterTick_NULL,
711 DisasterTick_Ufo, DisasterTick_NULL,
712 DisasterTick_Airplane, DisasterTick_NULL,
715 DisasterTick_NULL,
718};
719
720
722{
723 return _disastervehicle_tick_procs[this->subtype](this);
724}
725
726typedef void DisasterInitProc();
727
728
734{
735 if (!Vehicle::CanAllocateItem(2)) return;
736
737 /* Pick a random place, unless we find an airport */
738 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
739
740 for (const Station *st : Station::Iterate()) {
741 if (st->airport.tile != INVALID_TILE && (st->airport.type == AT_SMALL || st->airport.type == AT_LARGE)) {
742 x = (TileX(st->airport.tile) + 2) * TILE_SIZE;
743 break;
744 }
745 }
746
748 /* Allocate shadow */
750 v->SetNext(u);
751}
752
753
759{
760 if (!Vehicle::CanAllocateItem(2)) return;
761
762 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
764 v->dest_tile = TileXY(Map::SizeX() / 2, Map::SizeY() / 2);
765
766 /* Allocate shadow */
768 v->SetNext(u);
769}
770
771
772/* Combat airplane which destroys an oil refinery */
773static void Disaster_Airplane_Init()
774{
775 if (!Vehicle::CanAllocateItem(2)) return;
776
777 Industry *found = nullptr;
778
779 for (Industry *i : Industry::Iterate()) {
781 (found == nullptr || Chance16(1, 2))) {
782 found = i;
783 }
784 }
785
786 if (found == nullptr) return;
787
788 /* Start from the bottom (south side) of the map */
789 int x = (Map::SizeX() + 9) * TILE_SIZE - 1;
790 int y = TileY(found->location.tile) * TILE_SIZE + 37;
791
794 v->SetNext(u);
795}
796
797
800{
801 if (!Vehicle::CanAllocateItem(3)) return;
802
803 Industry *found = nullptr;
804
805 for (Industry *i : Industry::Iterate()) {
807 (found == nullptr || Chance16(1, 2))) {
808 found = i;
809 }
810 }
811
812 if (found == nullptr) return;
813
814 int x = -16 * (int)TILE_SIZE;
815 int y = TileY(found->location.tile) * TILE_SIZE + 37;
816
819 v->SetNext(u);
820
822 u->SetNext(w);
823}
824
825
826/* Big Ufo which lands on a piece of rail and will consequently be shot
827 * down by a combat airplane, destroying the surroundings */
828static void Disaster_Big_Ufo_Init()
829{
830 if (!Vehicle::CanAllocateItem(2)) return;
831
832 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
833 int y = Map::MaxX() * TILE_SIZE - 1;
834
836 v->dest_tile = TileXY(Map::SizeX() / 2, Map::SizeY() / 2);
837
838 /* Allocate shadow */
840 v->SetNext(u);
841}
842
843
844static void Disaster_Submarine_Init(DisasterSubType subtype)
845{
846 if (!Vehicle::CanAllocateItem()) return;
847
848 int y;
849 Direction dir;
850 uint32_t r = Random();
851 int x = TileX(RandomTileSeed(r)) * TILE_SIZE + TILE_SIZE / 2;
852
853 if (HasBit(r, 31)) {
854 y = Map::MaxY() * TILE_SIZE - TILE_SIZE / 2 - 1;
855 dir = DIR_NW;
856 } else {
857 y = TILE_SIZE / 2;
859 dir = DIR_SE;
860 }
861 if (!IsWaterTile(TileVirtXY(x, y))) return;
862
863 DisasterVehicle::Create(x, y, dir, subtype);
864}
865
866/* Curious submarine #1, just floats around */
867static void Disaster_Small_Submarine_Init()
868{
869 Disaster_Submarine_Init(ST_SMALL_SUBMARINE);
870}
871
872
873/* Curious submarine #2, just floats around */
874static void Disaster_Big_Submarine_Init()
875{
876 Disaster_Submarine_Init(ST_BIG_SUBMARINE);
877}
878
879
885{
886 int index = GB(Random(), 0, 4);
887 uint m;
888
889 for (m = 0; m < 15; m++) {
890 for (const Industry *i : Industry::Iterate()) {
892 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
893
894 {
895 TileIndex tile = i->location.tile;
897
898 for (uint n = 0; n < 30; n++) {
899 DisasterClearSquare(tile);
900 tile += step;
901 if (!IsValidTile(tile)) break;
902 }
903 }
904 return;
905 }
906 }
907 }
908}
909
915
916static const Disaster _disasters[] = {
919 {Disaster_Airplane_Init, TimerGameCalendar::Year{1960}, TimerGameCalendar::Year{1990}}, // airplane
921 {Disaster_Big_Ufo_Init, TimerGameCalendar::Year{2000}, TimerGameCalendar::Year{2100}}, // ufo {big}
922 {Disaster_Small_Submarine_Init, TimerGameCalendar::Year{1940}, TimerGameCalendar::Year{1965}}, // submarine {small}
923 {Disaster_Big_Submarine_Init, TimerGameCalendar::Year{1975}, TimerGameCalendar::Year{2010}}, // submarine {big}
925};
926
927static void DoDisaster()
928{
929 std::vector<DisasterInitProc *> available_disasters;
930
931 for (auto &disaster : _disasters) {
932 if (TimerGameCalendar::year >= disaster.min_year && TimerGameCalendar::year < disaster.max_year) {
933 available_disasters.push_back(disaster.init_proc);
934 }
935 }
936
937 if (available_disasters.empty()) return;
938
939 available_disasters[RandomRange(static_cast<uint32_t>(available_disasters.size()))]();
940}
941
942
943static void ResetDisasterDelay()
944{
945 _disaster_delay = GB(Random(), 0, 9) + 730;
946}
947
948static const IntervalTimer<TimerGameEconomy> _economy_disaster_daily({TimerGameEconomy::DAY, TimerGameEconomy::Priority::DISASTER}, [](auto)
949{
950 if (--_disaster_delay != 0) return;
951
952 ResetDisasterDelay();
953
954 if (_settings_game.difficulty.disasters != 0) DoDisaster();
955});
956
957void StartupDisasters()
958{
959 ResetDisasterDelay();
960}
961
968{
970 /* primary disaster vehicles that have chosen target */
971 if (v->subtype == ST_AIRPLANE || v->subtype == ST_HELICOPTER) {
972 /* if it has chosen target, and it is this industry (yes, dest_tile is IndustryID here), set order to "leaving map peacefully" */
973 if (v->state > 0 && v->dest_tile == i.base()) v->state = 3;
974 }
975 }
976}
977
983{
985 if (v == nullptr) return;
986
987 /* primary disaster vehicles that have chosen target */
988 assert(v->subtype == ST_SMALL_UFO);
989 assert(v->state != 0);
990
991 /* Revert to target-searching */
992 v->state = 0;
993 v->dest_tile = RandomTile();
994 GetAircraftFlightLevelBounds(v, &v->z_pos, nullptr);
996}
997
999{
1000 this->bounds = {{-1, -1, 0}, {2, 2, 5}, {}};
1001}
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:48
@ Zeppeliner
Block for the zeppeliner disaster vehicle.
@ 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:235
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Set()
Set all bits.
static void NewEvent(class ScriptEvent *event)
Queue a new event for a 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
The date on January 1, year 0.
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_Small_Ufo_Init()
Ufo which flies around aimlessly from the middle of the map a bit until it locates a road vehicle whi...
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 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.
uint16_t _disaster_delay
Delay counter for considering the next disaster.
void ReleaseDisasterVehicle(VehicleID vehicle)
Notify disasters that we are about to delete a vehicle.
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 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_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, uint 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.).
@ Random
Randomise borders.
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:109
static TileIndex TileVirtXY(uint x, uint y)
Get a tile from the virtual XY-coordinate.
Definition map_func.h:416
TileIndex RandomTileSeed(uint32_t r)
Get a random tile out of a given seed.
Definition map_func.h:653
TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition map_func.h:401
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition map_func.h:385
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:437
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:427
#define RandomTile()
Get a valid random tile.
Definition map_func.h:664
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:582
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.
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.
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:573
Functions related to sound.
@ SND_12_EXPLOSION
16 == 0x10 Destruction, crashes, disasters, ...
Definition sound_type.h:63
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 later.
void Restore()
Restore the variable.
static BaseStation * GetByTile(TileIndex tile)
Get the base station belonging to a specific tile.
VehicleType type
Type of vehicle.
SoundSettings sound
sound effect settings
static bool IsHumanID(auto index)
Is this company a company not controlled by a NoAI program?
bool freeform_edges
allow terraforming the tiles at the map edges
bool disasters
are disasters enabled
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.
DisasterInitProc * init_proc
The init function for this disaster.
TimerGameCalendar::Year min_year
The first year this disaster will occur.
TimerGameCalendar::Year max_year
The last year this disaster will occur.
ConstructionSettings construction
construction of things in-game
DifficultySettings difficulty
settings related to the difficulty
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
Size related data of the map.
Definition map_func.h:206
static uint SizeX()
Get the size of the map along the X.
Definition map_func.h:272
static uint SizeY()
Get the size of the map along the Y.
Definition map_func.h:281
static uint MaxY()
Gets the maximum Y coordinate within the map, including MP_VOID.
Definition map_func.h:308
static uint MaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition map_func.h:299
VehicleSpriteSeq sprite_seq
Vehicle appearance.
TileIndex tile
The base tile of the area.
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
static T * Create(Targs &&... args)
Creates a new T-object in the associated pool.
static Titem * Get(auto index)
Returns Titem with given index.
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
const Tindex index
Index of this pool item.
static Titem * GetIfValid(auto index)
Returns Titem with given index.
Buses, trucks and trams belong to this class.
Definition roadveh.h:98
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:105
VehicleID disaster_vehicle
NOSAVE: Disaster vehicle targetting this vehicle.
Definition roadveh.h:109
bool disaster
Play disaster and accident sounds.
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
Class defining several overloaded accessors so we don't have to cast vehicle types that often.
DisasterVehicle * Next() const
Get next vehicle in the chain.
static Pool::IterateWrapper< T > Iterate(size_t from=0)
Returns an iterable ensemble of all valid vehicles of type T.
static T * Get(auto index)
Gets vehicle with given index.
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:91
void Set(SpriteID sprite)
Assign a single sprite to the sequence.
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:2928
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:1746
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:1663
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
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
@ MP_TREES
Tile got trees.
Definition tile_type.h:52
@ MP_CLEAR
A tile without any structures, i.e. grass, rocks, farm fields etc.
Definition tile_type.h:48
@ MP_HOUSE
A house by a town.
Definition tile_type.h:51
@ MP_RAILWAY
A railway.
Definition tile_type.h:49
@ MP_INDUSTRY
Part of an industry.
Definition tile_type.h:56
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:363
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:528
GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v)
Get position information of a vehicle when moving one pixel in the direction it is facing.
Definition vehicle.cpp:1766
@ 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.
@ VEH_ROAD
Road 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