OpenTTD Source 15.3
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
127DisasterVehicle::DisasterVehicle(int x, int y, Direction direction, DisasterSubType subtype, VehicleID big_ufo_destroyer_target) :
128 SpecializedVehicleBase(), big_ufo_destroyer_target(big_ufo_destroyer_target)
129{
131
132 this->x_pos = x;
133 this->y_pos = y;
134 switch (subtype) {
135 case ST_ZEPPELINER:
136 case ST_SMALL_UFO:
137 case ST_AIRPLANE:
138 case ST_HELICOPTER:
139 case ST_BIG_UFO:
141 GetAircraftFlightLevelBounds(this, &this->z_pos, nullptr);
142 break;
143
145 GetAircraftFlightLevelBounds(this, &this->z_pos, nullptr);
146 this->z_pos += ROTOR_Z_OFFSET;
147 break;
148
150 case ST_BIG_SUBMARINE:
151 this->z_pos = 0;
152 break;
153
160 this->z_pos = 0;
162 break;
163 }
164
165 this->direction = direction;
166 this->tile = TileVirtXY(x, y);
167 this->subtype = subtype;
168 this->UpdateDeltaXY();
169 this->owner = OWNER_NONE;
170 this->image_override = 0;
171 this->state = 0;
172
173 this->UpdateImage();
175}
176
183void DisasterVehicle::UpdatePosition(int x, int y, int z)
184{
185 this->x_pos = x;
186 this->y_pos = y;
187 this->z_pos = z;
188 this->tile = TileVirtXY(x, y);
189
190 this->UpdateImage();
192
193 DisasterVehicle *u = this->Next();
194 if (u != nullptr) {
195 int safe_x = Clamp(x, 0, Map::MaxX() * TILE_SIZE);
196 int safe_y = Clamp(y - 1, 0, Map::MaxY() * TILE_SIZE);
197
198 u->x_pos = x;
199 u->y_pos = y - 1 - (std::max(z - GetSlopePixelZ(safe_x, safe_y), 0) >> 3);
200 safe_y = Clamp(u->y_pos, 0, Map::MaxY() * TILE_SIZE);
201 u->z_pos = GetSlopePixelZ(safe_x, safe_y);
202 u->direction = this->direction;
203
204 u->UpdateImage();
206
207 if ((u = u->Next()) != nullptr) {
208 u->x_pos = x;
209 u->y_pos = y;
210 u->z_pos = z + ROTOR_Z_OFFSET;
212 }
213 }
214}
215
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)) {
262 Station::GetByTile(v->tile)->airport.blocks.Set({AirportBlock::Zeppeliner, AirportBlock::RunwayIn});
263 }
264
265 if (v->state > 2) {
266 if (++v->age <= 13320) return true;
267
268 if (IsValidTile(v->tile) && IsAirportTile(v->tile)) {
270 st->airport.blocks.Reset({AirportBlock::Zeppeliner, AirportBlock::RunwayIn});
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[VEH_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 == VEH_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
435static bool DisasterTick_Aircraft(DisasterVehicle *v, uint16_t image_override, bool leave_at_top, StringID news_message, IndustryBehaviour behaviour)
436{
437 v->tick_counter++;
438 v->image_override = (v->state == 1 && HasBit(v->tick_counter, 2)) ? image_override : 0;
439
441 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
442
443 if ((leave_at_top && gp.x < (-10 * (int)TILE_SIZE)) || (!leave_at_top && gp.x > (int)(Map::SizeX() * TILE_SIZE + 9 * TILE_SIZE) - 1)) {
444 delete v;
445 return false;
446 }
447
448 if (v->state == 2) {
449 if (GB(v->tick_counter, 0, 2) == 0) {
450 Industry *i = Industry::Get(v->dest_tile.base()); // Industry destructor calls ReleaseDisastersTargetingIndustry, so this is valid
451 int x = TileX(i->location.tile) * TILE_SIZE;
452 int y = TileY(i->location.tile) * TILE_SIZE;
453 uint32_t r = Random();
454
456 GB(r, 0, 6) + x,
457 GB(r, 6, 6) + y,
458 GB(r, 12, 4),
460
461 if (++v->age >= 55) v->state = 3;
462 }
463 } else if (v->state == 1) {
464 if (++v->age == 112) {
465 v->state = 2;
467
468 Industry *i = Industry::Get(v->dest_tile.base()); // Industry destructor calls ReleaseDisastersTargetingIndustry, so this is valid
469 DestructIndustry(i);
470
471 AddIndustryNewsItem(GetEncodedString(news_message, i->town->index), NewsType::Accident, i->index);
473 }
474 } else if (v->state == 0) {
475 int x = v->x_pos + ((leave_at_top ? -15 : 15) * TILE_SIZE);
476 int y = v->y_pos;
477
478 if ((uint)x > Map::MaxX() * TILE_SIZE - 1) return true;
479
480 TileIndex tile = TileVirtXY(x, y);
481 if (!IsTileType(tile, MP_INDUSTRY)) return true;
482
483 IndustryID ind = GetIndustryIndex(tile);
484 v->dest_tile = TileIndex{ind.base()};
485
486 if (GetIndustrySpec(Industry::Get(ind)->type)->behaviour.Test(behaviour)) {
487 v->state = 1;
489 }
490 }
491
492 return true;
493}
494
497{
498 return DisasterTick_Aircraft(v, SPR_F_15_FIRING, true, STR_NEWS_DISASTER_AIRPLANE_OIL_REFINERY, IndustryBehaviour::AirplaneAttacks);
499}
500
503{
504 return DisasterTick_Aircraft(v, SPR_AH_64A_FIRING, false, STR_NEWS_DISASTER_HELICOPTER_FACTORY, IndustryBehaviour::ChopperAttacks);
505}
506
509{
510 v->tick_counter++;
511 if (HasBit(v->tick_counter, 0)) return true;
512
513 SpriteID &cur_image = v->sprite_cache.sprite_seq.seq[0].sprite;
514 if (++cur_image > SPR_ROTOR_MOVING_3) cur_image = SPR_ROTOR_MOVING_1;
515
517
518 return true;
519}
520
528{
529 v->tick_counter++;
530
531 if (v->state == 1) {
532 int x = TileX(v->dest_tile) * TILE_SIZE + TILE_SIZE / 2;
533 int y = TileY(v->dest_tile) * TILE_SIZE + TILE_SIZE / 2;
534 if (Delta(v->x_pos, x) + Delta(v->y_pos, y) >= 8) {
535 v->direction = GetDirectionTowards(v, x, y);
536
538 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
539 return true;
540 }
541
542 if (!IsValidTile(v->dest_tile)) {
543 /* Make sure we don't land outside the map. */
544 delete v;
545 return false;
546 }
547
548 int z = GetSlopePixelZ(v->x_pos, v->y_pos);
549 if (z < v->z_pos) {
550 v->UpdatePosition(v->x_pos, v->y_pos, v->z_pos - 1);
551 return true;
552 }
553
554 v->state = 2;
555
556 for (Vehicle *target : Vehicle::Iterate()) {
557 if (target->IsGroundVehicle()) {
558 if (Delta(target->x_pos, v->x_pos) + Delta(target->y_pos, v->y_pos) <= 12 * (int)TILE_SIZE) {
559 target->breakdown_ctr = 5;
560 target->breakdown_delay = 0xF0;
561 }
562 }
563 }
564
565 Town *t = ClosestTownFromTile(v->dest_tile, UINT_MAX);
566 AddTileNewsItem(GetEncodedString(STR_NEWS_DISASTER_BIG_UFO, t->index), NewsType::Accident, v->tile);
567
568 if (!Vehicle::CanAllocateItem(2)) {
569 delete v;
570 return false;
571 }
574 u->SetNext(w);
575 } else if (v->state == 0) {
576 int x = TileX(v->dest_tile) * TILE_SIZE;
577 int y = TileY(v->dest_tile) * TILE_SIZE;
578 if (Delta(x, v->x_pos) + Delta(y, v->y_pos) >= (int)TILE_SIZE) {
579 v->direction = GetDirectionTowards(v, x, y);
581 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
582 return true;
583 }
584
585 if (++v->age < 6) {
586 v->dest_tile = RandomTile();
587 return true;
588 }
589 v->state = 1;
590
591 const auto is_valid_target = [](const Train *t) {
592 return t->IsFrontEngine() // Only the engines
593 && Company::IsHumanID(t->owner) // Don't break AIs
594 && IsPlainRailTile(t->tile) // No tunnels
595 && !t->vehstatus.Test(VehState::Crashed); // Not crashed
596 };
597
598 uint n = 0; // Total number of targetable trains.
599 for (const Train *t : Train::Iterate()) {
600 if (is_valid_target(t)) n++;
601 }
602
603 if (n == 0) {
604 /* If there are no targetable trains, destroy the UFO. */
605 delete v;
606 return false;
607 }
608
609 n = RandomRange(n); // Choose one of them.
610 for (const Train *t : Train::Iterate()) {
611 /* Find (n+1)-th train. */
612 if (is_valid_target(t) && (n-- == 0)) {
613 /* Target it. */
614 v->dest_tile = t->tile;
616 break;
617 }
618 }
619 }
620
621 return true;
622}
623
629{
630 v->tick_counter++;
631
633 v->UpdatePosition(gp.x, gp.y, GetAircraftFlightLevel(v));
634
635 if (gp.x > (int)(Map::SizeX() * TILE_SIZE + 9 * TILE_SIZE) - 1) {
636 delete v;
637 return false;
638 }
639
640 if (v->state == 0) {
642 if (Delta(v->x_pos, u->x_pos) > (int)TILE_SIZE) return true;
643 v->state = 1;
644
646 if (_settings_client.sound.disaster) SndPlayVehicleFx(SND_12_EXPLOSION, u);
647
648 delete u;
649
650 for (int i = 0; i != 80; i++) {
651 uint32_t r = Random();
653 GB(r, 0, 6) + v->x_pos - 32,
654 GB(r, 5, 6) + v->y_pos - 32,
655 0,
657 }
658
659 for (int dy = -3; dy < 3; dy++) {
660 for (int dx = -3; dx < 3; dx++) {
661 TileIndex tile = TileAddWrap(v->tile, dx, dy);
662 if (tile != INVALID_TILE) DisasterClearSquare(tile);
663 }
664 }
665 }
666
667 return true;
668}
669
675{
676 v->tick_counter++;
677
678 if (++v->age > 8880) {
679 delete v;
680 return false;
681 }
682
683 if (!HasBit(v->tick_counter, 0)) return true;
684
686 if (IsValidTile(tile)) {
688 if (trackbits == TRACK_BIT_ALL && !Chance16(1, 90)) {
690 v->UpdatePosition(gp.x, gp.y, v->z_pos);
691 return true;
692 }
693 }
694
696
697 return true;
698}
699
700
701static bool DisasterTick_NULL(DisasterVehicle *)
702{
703 return true;
704}
705
706typedef bool DisasterVehicleTickProc(DisasterVehicle *v);
707
708static DisasterVehicleTickProc * const _disastervehicle_tick_procs[] = {
709 DisasterTick_Zeppeliner, DisasterTick_NULL,
710 DisasterTick_Ufo, DisasterTick_NULL,
711 DisasterTick_Airplane, DisasterTick_NULL,
714 DisasterTick_NULL,
717};
718
719
721{
722 return _disastervehicle_tick_procs[this->subtype](this);
723}
724
725typedef void DisasterInitProc();
726
727
733{
734 if (!Vehicle::CanAllocateItem(2)) return;
735
736 /* Pick a random place, unless we find an airport */
737 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
738
739 for (const Station *st : Station::Iterate()) {
740 if (st->airport.tile != INVALID_TILE && (st->airport.type == AT_SMALL || st->airport.type == AT_LARGE)) {
741 x = (TileX(st->airport.tile) + 2) * TILE_SIZE;
742 break;
743 }
744 }
745
747 /* Allocate shadow */
749 v->SetNext(u);
750}
751
752
758{
759 if (!Vehicle::CanAllocateItem(2)) return;
760
761 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
763 v->dest_tile = TileXY(Map::SizeX() / 2, Map::SizeY() / 2);
764
765 /* Allocate shadow */
767 v->SetNext(u);
768}
769
770
771/* Combat airplane which destroys an oil refinery */
772static void Disaster_Airplane_Init()
773{
774 if (!Vehicle::CanAllocateItem(2)) return;
775
776 Industry *found = nullptr;
777
778 for (Industry *i : Industry::Iterate()) {
780 (found == nullptr || Chance16(1, 2))) {
781 found = i;
782 }
783 }
784
785 if (found == nullptr) return;
786
787 /* Start from the bottom (south side) of the map */
788 int x = (Map::SizeX() + 9) * TILE_SIZE - 1;
789 int y = TileY(found->location.tile) * TILE_SIZE + 37;
790
793 v->SetNext(u);
794}
795
796
799{
800 if (!Vehicle::CanAllocateItem(3)) return;
801
802 Industry *found = nullptr;
803
804 for (Industry *i : Industry::Iterate()) {
806 (found == nullptr || Chance16(1, 2))) {
807 found = i;
808 }
809 }
810
811 if (found == nullptr) return;
812
813 int x = -16 * (int)TILE_SIZE;
814 int y = TileY(found->location.tile) * TILE_SIZE + 37;
815
818 v->SetNext(u);
819
821 u->SetNext(w);
822}
823
824
825/* Big Ufo which lands on a piece of rail and will consequently be shot
826 * down by a combat airplane, destroying the surroundings */
827static void Disaster_Big_Ufo_Init()
828{
829 if (!Vehicle::CanAllocateItem(2)) return;
830
831 int x = TileX(RandomTile()) * TILE_SIZE + TILE_SIZE / 2;
832 int y = Map::MaxX() * TILE_SIZE - 1;
833
835 v->dest_tile = TileXY(Map::SizeX() / 2, Map::SizeY() / 2);
836
837 /* Allocate shadow */
839 v->SetNext(u);
840}
841
842
843static void Disaster_Submarine_Init(DisasterSubType subtype)
844{
845 if (!Vehicle::CanAllocateItem()) return;
846
847 int y;
848 Direction dir;
849 uint32_t r = Random();
850 int x = TileX(RandomTileSeed(r)) * TILE_SIZE + TILE_SIZE / 2;
851
852 if (HasBit(r, 31)) {
853 y = Map::MaxY() * TILE_SIZE - TILE_SIZE / 2 - 1;
854 dir = DIR_NW;
855 } else {
856 y = TILE_SIZE / 2;
858 dir = DIR_SE;
859 }
860 if (!IsWaterTile(TileVirtXY(x, y))) return;
861
862 new DisasterVehicle(x, y, dir, subtype);
863}
864
865/* Curious submarine #1, just floats around */
866static void Disaster_Small_Submarine_Init()
867{
868 Disaster_Submarine_Init(ST_SMALL_SUBMARINE);
869}
870
871
872/* Curious submarine #2, just floats around */
873static void Disaster_Big_Submarine_Init()
874{
875 Disaster_Submarine_Init(ST_BIG_SUBMARINE);
876}
877
878
884{
885 int index = GB(Random(), 0, 4);
886 uint m;
887
888 for (m = 0; m < 15; m++) {
889 for (const Industry *i : Industry::Iterate()) {
891 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
892
893 {
894 TileIndex tile = i->location.tile;
896
897 for (uint n = 0; n < 30; n++) {
898 DisasterClearSquare(tile);
899 tile += step;
900 if (!IsValidTile(tile)) break;
901 }
902 }
903 return;
904 }
905 }
906 }
907}
908
914
915static const Disaster _disasters[] = {
918 {Disaster_Airplane_Init, TimerGameCalendar::Year{1960}, TimerGameCalendar::Year{1990}}, // airplane
920 {Disaster_Big_Ufo_Init, TimerGameCalendar::Year{2000}, TimerGameCalendar::Year{2100}}, // ufo {big}
921 {Disaster_Small_Submarine_Init, TimerGameCalendar::Year{1940}, TimerGameCalendar::Year{1965}}, // submarine {small}
922 {Disaster_Big_Submarine_Init, TimerGameCalendar::Year{1975}, TimerGameCalendar::Year{2010}}, // submarine {big}
924};
925
926static void DoDisaster()
927{
928 std::vector<DisasterInitProc *> available_disasters;
929
930 for (auto &disaster : _disasters) {
931 if (TimerGameCalendar::year >= disaster.min_year && TimerGameCalendar::year < disaster.max_year) {
932 available_disasters.push_back(disaster.init_proc);
933 }
934 }
935
936 if (available_disasters.empty()) return;
937
938 available_disasters[RandomRange(static_cast<uint32_t>(available_disasters.size()))]();
939}
940
941
942static void ResetDisasterDelay()
943{
944 _disaster_delay = GB(Random(), 0, 9) + 730;
945}
946
947static const IntervalTimer<TimerGameEconomy> _economy_disaster_daily({TimerGameEconomy::DAY, TimerGameEconomy::Priority::DISASTER}, [](auto)
948{
949 if (--_disaster_delay != 0) return;
950
951 ResetDisasterDelay();
952
953 if (_settings_game.difficulty.disasters != 0) DoDisaster();
954});
955
956void StartupDisasters()
957{
958 ResetDisasterDelay();
959}
960
967{
969 /* primary disaster vehicles that have chosen target */
970 if (v->subtype == ST_AIRPLANE || v->subtype == ST_HELICOPTER) {
971 /* if it has chosen target, and it is this industry (yes, dest_tile is IndustryID here), set order to "leaving map peacefully" */
972 if (v->state > 0 && v->dest_tile == i.base()) v->state = 3;
973 }
974 }
975}
976
982{
984 if (v == nullptr) return;
985
986 /* primary disaster vehicles that have chosen target */
987 assert(v->subtype == ST_SMALL_UFO);
988 assert(v->state != 0);
989
990 /* Revert to target-searching */
991 v->state = 0;
992 v->dest_tile = RandomTile();
993 GetAircraftFlightLevelBounds(v, &v->z_pos, nullptr);
995}
996
998{
999 this->bounds = {{-1, -1, 0}, {2, 2, 5}, {}};
1000}
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:120
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:654
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:438
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:428
#define RandomTile()
Get a valid random tile.
Definition map_func.h:665
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:583
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.
void UpdatePosition(int x, int y, int z)
Update the position of the vehicle.
DisasterVehicle()
For use by saveload.
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 Titem * Get(auto index)
Returns Titem with given index.
Tindex index
Index of this pool item.
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
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:2927
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:1745
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:1662
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:527
GetNewVehiclePosResult GetNewVehiclePos(const Vehicle *v)
Get position information of a vehicle when moving one pixel in the direction it is facing.
Definition vehicle.cpp:1765
@ 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