OpenTTD Source 20260711-master-g3fb3006dff
station_cmd.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
9
10#include "stdafx.h"
11#include "core/flatset_type.hpp"
12#include "aircraft.h"
13#include "bridge_map.h"
14#include "vehiclelist_func.h"
15#include "viewport_func.h"
16#include "viewport_kdtree.h"
17#include "command_func.h"
18#include "town.h"
19#include "news_func.h"
20#include "train.h"
21#include "ship.h"
22#include "roadveh.h"
23#include "industry.h"
24#include "newgrf_cargo.h"
25#include "newgrf_debug.h"
26#include "newgrf_station.h"
27#include "newgrf_canal.h" /* For the buoy */
29#include "road_internal.h" /* For drawing catenary/checking road removal */
30#include "autoslope.h"
31#include "water.h"
32#include "tilehighlight_func.h"
33#include "strings_func.h"
34#include "clear_func.h"
36#include "vehicle_func.h"
37#include "string_func.h"
38#include "animated_tile_func.h"
39#include "elrail_func.h"
40#include "station_base.h"
41#include "station_func.h"
42#include "station_kdtree.h"
43#include "roadstop_base.h"
44#include "newgrf_railtype.h"
45#include "newgrf_roadtype.h"
46#include "waypoint_base.h"
47#include "waypoint_func.h"
48#include "pbs.h"
49#include "debug.h"
50#include "core/random_func.hpp"
52#include "company_base.h"
54#include "newgrf_airporttiles.h"
55#include "order_backup.h"
56#include "newgrf_house.h"
57#include "company_gui.h"
59#include "linkgraph/refresh.h"
60#include "tunnelbridge_map.h"
61#include "station_cmd.h"
62#include "waypoint_cmd.h"
63#include "landscape_cmd.h"
64#include "rail_cmd.h"
65#include "newgrf_roadstop.h"
66#include "timer/timer.h"
70#include "cheat_type.h"
71#include "road_func.h"
72#include "station_layout_type.h"
73
75#include "widgets/misc_widget.h"
76
77#include "table/strings.h"
78#include "table/station_land.h"
79
80#include <bitset>
81
82#include "safeguards.h"
83
89/* static */ const FlowStat::SharesMap FlowStat::empty_sharesmap;
90
98{
99 assert(IsTileType(t, TileType::Station));
100
101 /* If the tile isn't an airport there's no chance it's a hangar. */
102 if (!IsAirport(t)) return false;
103
104 const Station *st = Station::GetByTile(t);
105 const AirportSpec *as = st->airport.GetSpec();
106
107 for (const auto &depot : as->depots) {
108 if (st->airport.GetRotatedTileFromOffset(depot.ti) == TileIndex(t)) return true;
109 }
110
111 return false;
112}
113
123template <class T, class F>
124CommandCost GetStationAround(TileArea ta, StationID closest_station, CompanyID company, T **st, F filter)
125{
126 ta.Expand(1);
127
128 /* check around to see if there are any stations there owned by the company */
129 for (TileIndex tile_cur : ta) {
130 if (IsTileType(tile_cur, TileType::Station)) {
131 StationID t = GetStationIndex(tile_cur);
132 if (!T::IsValidID(t) || T::Get(t)->owner != company || !filter(T::Get(t))) continue;
133 if (closest_station == StationID::Invalid()) {
134 closest_station = t;
135 } else if (closest_station != t) {
136 return CommandCost(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
137 }
138 }
139 }
140 *st = (closest_station == StationID::Invalid()) ? nullptr : T::Get(closest_station);
141 return CommandCost();
142}
143
149typedef bool (*CMSAMatcher)(TileIndex tile);
150
158{
159 int num = 0;
160
161 for (int dx = -3; dx <= 3; dx++) {
162 for (int dy = -3; dy <= 3; dy++) {
163 TileIndex t = TileAddWrap(tile, dx, dy);
164 if (t != INVALID_TILE && cmp(t)) num++;
165 }
166 }
167
168 return num;
169}
170
176static bool CMSAMine(TileIndex tile)
177{
178 /* No industry */
179 if (!IsTileType(tile, TileType::Industry)) return false;
180
181 const Industry *ind = Industry::GetByTile(tile);
182
183 /* No extractive industry */
185
186 for (const auto &p : ind->produced) {
187 /* The industry extracts something non-liquid, i.e. no oil or plastic, so it is a mine.
188 * Also the production of passengers and mail is ignored. */
189 if (IsValidCargoType(p.cargo) &&
190 !CargoSpec::Get(p.cargo)->classes.Any({CargoClass::Liquid, CargoClass::Passengers, CargoClass::Mail})) {
191 return true;
192 }
193 }
194
195 return false;
196}
197
203static bool CMSAWater(TileIndex tile)
204{
205 return IsTileType(tile, TileType::Water) && IsWater(tile);
206}
207
213static bool CMSATree(TileIndex tile)
214{
215 return IsTileType(tile, TileType::Trees);
216}
217
227
230 std::bitset<STR_SV_STNAME_FALLBACK - STR_SV_STNAME> used_names;
231 std::bitset<NUM_INDUSTRYTYPES> indtypes;
232
238 bool IsAvailable(StringID str) const
239 {
240 assert(IsInsideMM(str, STR_SV_STNAME, STR_SV_STNAME_FALLBACK));
241 return !this->used_names.test(str - STR_SV_STNAME);
242 }
243
249 {
250 assert(IsInsideMM(str, STR_SV_STNAME, STR_SV_STNAME_FALLBACK));
251 this->used_names.set(str - STR_SV_STNAME);
252 }
253};
254
264{
265 const Town *t = st->town;
266
268
269 for (const Station *s : Station::Iterate()) {
270 if (s != st && s->town == t) {
271 if (s->indtype != IT_INVALID) {
272 sni.indtypes[s->indtype] = true;
273 StringID name = GetIndustrySpec(s->indtype)->station_name;
274 if (name != STR_UNDEFINED) {
275 /* Filter for other industrytypes with the same name */
276 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
277 const IndustrySpec *indsp = GetIndustrySpec(it);
278 if (indsp->enabled && indsp->station_name == name) sni.indtypes[it] = true;
279 }
280 }
281 continue;
282 }
283 if (IsInsideMM(s->string_id, STR_SV_STNAME, STR_SV_STNAME_FALLBACK)) {
284 auto str = s->string_id;
285 if (str == STR_SV_STNAME_FOREST) str = STR_SV_STNAME_WOODS;
286 sni.SetUsed(str);
287 }
288 }
289 }
290
291 for (auto indtile : SpiralTileSequence(tile, 7)) {
292 if (!IsTileType(indtile, TileType::Industry)) continue;
293
294 /* If the station name is undefined it means that it doesn't name a station */
295 IndustryType indtype = GetIndustryType(indtile);
296 const IndustrySpec *indsp = GetIndustrySpec(indtype);
297 if (indsp->station_name == STR_UNDEFINED) continue;
298
299 /* In all cases if an industry that provides a name is found two of
300 * the standard names will be disabled. */
301 sni.SetUsed(STR_SV_STNAME_OILFIELD);
302 sni.SetUsed(STR_SV_STNAME_MINES);
303 if (sni.indtypes[indtype]) continue;
304
305 /* STR_NULL means it only disables oil rig/mines */
306 if (indsp->station_name != STR_NULL) {
307 st->indtype = indtype;
308 return STR_SV_STNAME_FALLBACK;
309 }
310 break;
311 }
312
313 /* check default names
314 * Oil rigs/mines name could be marked not free by looking for a near by industry. */
315 switch (name_class) {
317 if (sni.IsAvailable(STR_SV_STNAME_AIRPORT)) return STR_SV_STNAME_AIRPORT;
318 break;
320 if (sni.IsAvailable(STR_SV_STNAME_OILFIELD)) return STR_SV_STNAME_OILFIELD;
321 break;
323 if (sni.IsAvailable(STR_SV_STNAME_DOCKS)) return STR_SV_STNAME_DOCKS;
324 break;
326 if (sni.IsAvailable(STR_SV_STNAME_HELIPORT)) return STR_SV_STNAME_HELIPORT;
327 break;
328 default:
329 break;
330 };
331
332 /* check mine? */
333 if (sni.IsAvailable(STR_SV_STNAME_MINES)) {
334 if (CountMapSquareAround(tile, CMSAMine) >= 2) {
335 return STR_SV_STNAME_MINES;
336 }
337 }
338
339 /* check close enough to town to get central as name? */
340 if (DistanceMax(tile, t->xy) < 8) {
341 if (sni.IsAvailable(STR_SV_STNAME)) return STR_SV_STNAME;
342 if (sni.IsAvailable(STR_SV_STNAME_CENTRAL)) return STR_SV_STNAME_CENTRAL;
343 }
344
345 /* Check lakeside */
346 if (sni.IsAvailable(STR_SV_STNAME_LAKESIDE) &&
347 DistanceFromEdge(tile) < 20 &&
348 CountMapSquareAround(tile, CMSAWater) >= 5) {
349 return STR_SV_STNAME_LAKESIDE;
350 }
351
352 /* Check woods */
353 if (sni.IsAvailable(STR_SV_STNAME_WOODS) && (
354 CountMapSquareAround(tile, CMSATree) >= 8 ||
356 ) {
357 return _settings_game.game_creation.landscape == LandscapeType::Tropic ? STR_SV_STNAME_FOREST : STR_SV_STNAME_WOODS;
358 }
359
360 /* check elevation compared to town */
361 int z = GetTileZ(tile);
362 int z2 = GetTileZ(t->xy);
363 if (z < z2) {
364 if (sni.IsAvailable(STR_SV_STNAME_VALLEY)) return STR_SV_STNAME_VALLEY;
365 } else if (z > z2) {
366 if (sni.IsAvailable(STR_SV_STNAME_HEIGHTS)) return STR_SV_STNAME_HEIGHTS;
367 }
368
369 /* check direction compared to town */
370 if (TileX(tile) < TileX(t->xy)) {
371 sni.SetUsed(STR_SV_STNAME_SOUTH);
372 sni.SetUsed(STR_SV_STNAME_WEST);
373 } else {
374 sni.SetUsed(STR_SV_STNAME_NORTH);
375 sni.SetUsed(STR_SV_STNAME_EAST);
376 }
377 if (TileY(tile) < TileY(t->xy)) {
378 sni.SetUsed(STR_SV_STNAME_SOUTH);
379 sni.SetUsed(STR_SV_STNAME_EAST);
380 } else {
381 sni.SetUsed(STR_SV_STNAME_NORTH);
382 sni.SetUsed(STR_SV_STNAME_WEST);
383 }
384
386 static const StringID fallback_names[] = {
387 STR_SV_STNAME_NORTH,
388 STR_SV_STNAME_SOUTH,
389 STR_SV_STNAME_EAST,
390 STR_SV_STNAME_WEST,
391 STR_SV_STNAME_TRANSFER,
392 STR_SV_STNAME_HALT,
393 STR_SV_STNAME_EXCHANGE,
394 STR_SV_STNAME_ANNEXE,
395 STR_SV_STNAME_SIDINGS,
396 STR_SV_STNAME_BRANCH,
397 STR_SV_STNAME_UPPER,
398 STR_SV_STNAME_LOWER,
399 };
400 for (auto str : fallback_names) {
401 if (sni.IsAvailable(str)) return str;
402 }
403 return STR_SV_STNAME_FALLBACK;
404}
405
412{
413 uint threshold = 8;
414
415 Station *best_station = nullptr;
416 ForAllStationsRadius(tile, threshold, [&](Station *st) {
417 if (!st->IsInUse() && st->owner == _current_company) {
418 uint cur_dist = DistanceManhattan(tile, st->xy);
419
420 if (cur_dist < threshold) {
421 threshold = cur_dist;
422 best_station = st;
423 } else if (cur_dist == threshold && best_station != nullptr) {
424 /* In case of a tie, lowest station ID wins */
425 if (st->index < best_station->index) best_station = st;
426 }
427 }
428 });
429
430 return best_station;
431}
432
433
435{
436 switch (type) {
437 case StationType::Rail: return this->train_station;
438 case StationType::Airport: return this->airport;
439 case StationType::Truck: return this->truck_station;
440 case StationType::Bus: return this->bus_station;
442 case StationType::Oilrig: return this->docking_station;
443 default: NOT_REACHED();
444 }
445}
446
451{
452 Point pt = RemapCoords2(TileX(this->xy) * TILE_SIZE, TileY(this->xy) * TILE_SIZE);
453
454 pt.y -= 32 * ZOOM_BASE;
455 if (this->facilities.Test(StationFacility::Airport) && this->airport.type == AT_OILRIG) pt.y -= 16 * ZOOM_BASE;
456
457 if (this->sign.kdtree_valid) _viewport_sign_kdtree.Remove(ViewportSignKdtreeItem::MakeStation(this->index));
458
459 this->sign.UpdatePosition(pt.x, pt.y, GetString(STR_VIEWPORT_STATION, this->index, this->facilities), GetString(STR_STATION_NAME, this->index, this->facilities));
460
461 _viewport_sign_kdtree.Insert(ViewportSignKdtreeItem::MakeStation(this->index));
462
463 SetWindowDirty(WindowClass::StationView, this->index);
464}
465
471{
472 if (this->xy == new_xy) return;
473
474 _station_kdtree.Remove(this->index);
475
476 this->BaseStation::MoveSign(new_xy);
477
478 _station_kdtree.Insert(this->index);
479}
480
483{
484 for (BaseStation *st : BaseStation::Iterate()) {
485 st->UpdateVirtCoord();
486 }
487}
488
489void BaseStation::FillCachedName() const
490{
491 auto tmp_params = MakeParameters(this->index);
492 this->cached_name = GetStringWithArgs(Waypoint::IsExpected(this) ? STR_WAYPOINT_NAME : STR_STATION_NAME, tmp_params);
493}
494
495void ClearAllStationCachedNames()
496{
497 for (BaseStation *st : BaseStation::Iterate()) {
498 st->cached_name.clear();
499 }
500}
501
508{
509 CargoTypes mask{};
510
511 for (auto it = std::begin(st->goods); it != std::end(st->goods); ++it) {
512 if (it->status.Test(GoodsEntry::State::Acceptance)) mask.Set(static_cast<CargoType>(std::distance(std::begin(st->goods), it)));
513 }
514 return mask;
515}
516
523{
524 CargoTypes mask{};
525
526 for (auto it = std::begin(st->goods); it != std::end(st->goods); ++it) {
527 if (it->TotalCount() > 0) mask.Set(static_cast<CargoType>(std::distance(std::begin(st->goods), it)));
528 }
529 return mask;
530}
531
538static void ShowRejectOrAcceptNews(const Station *st, CargoTypes cargoes, bool reject)
539{
540 StringID msg = reject ? STR_NEWS_STATION_NO_LONGER_ACCEPTS_CARGO_LIST : STR_NEWS_STATION_NOW_ACCEPTS_CARGO_LIST;
542}
543
552CargoArray GetProductionAroundTiles(TileIndex north_tile, int w, int h, int rad)
553{
554 CargoArray produced{};
555 FlatSet<IndustryID> industries;
556 TileArea ta = TileArea(north_tile, w, h).Expand(rad);
557
558 /* Loop over all tiles to get the produced cargo of
559 * everything except industries */
560 for (TileIndex tile : ta) {
561 if (IsTileType(tile, TileType::Industry)) industries.insert(GetIndustryIndex(tile));
562 AddProducedCargo(tile, produced);
563 }
564
565 /* Loop over the seen industries. They produce cargo for
566 * anything that is within 'rad' of any one of their tiles.
567 */
568 for (IndustryID industry : industries) {
569 const Industry *i = Industry::Get(industry);
570 /* Skip industry with neutral station */
571 if (i->neutral_station != nullptr && !_settings_game.station.serve_neutral_industries) continue;
572
573 for (const auto &p : i->produced) {
574 if (IsValidCargoType(p.cargo)) produced[p.cargo]++;
575 }
576 }
577
578 return produced;
579}
580
589std::pair<CargoArray, CargoTypes> GetAcceptanceAroundTiles(TileIndex center_tile, int w, int h, int rad)
590{
591 CargoArray acceptance{};
592 CargoTypes always_accepted{};
593
594 TileArea ta = TileArea(center_tile, w, h).Expand(rad);
595
596 for (TileIndex tile : ta) {
597 /* Ignore industry if it has a neutral station. */
598 if (!_settings_game.station.serve_neutral_industries && IsTileType(tile, TileType::Industry) && Industry::GetByTile(tile)->neutral_station != nullptr) continue;
599
600 AddAcceptedCargo(tile, acceptance, always_accepted);
601 }
602
603 return {acceptance, always_accepted};
604}
605
611static std::pair<CargoArray, CargoTypes> GetAcceptanceAroundStation(const Station *st)
612{
613 CargoArray acceptance{};
614 CargoTypes always_accepted{};
615
617 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
618 AddAcceptedCargo(tile, acceptance, always_accepted);
619 }
620
621 return {acceptance, always_accepted};
622}
623
629void UpdateStationAcceptance(Station *st, bool show_msg)
630{
631 /* old accepted goods types */
632 CargoTypes old_acc = GetAcceptanceMask(st);
633
634 /* And retrieve the acceptance. */
635 CargoArray acceptance{};
636 if (!st->rect.IsEmpty()) {
637 std::tie(acceptance, st->always_accepted) = GetAcceptanceAroundStation(st);
638 }
639
640 /* Adjust in case our station only accepts fewer kinds of goods */
641 for (CargoType cargo : EnumRange(NUM_CARGO)) {
642 uint amt = acceptance[cargo];
643
644 /* Make sure the station can accept the goods type. */
645 bool is_passengers = IsCargoInClass(cargo, CargoClass::Passengers);
646 if ((!is_passengers && !st->facilities.Any({StationFacility::Train, StationFacility::TruckStop, StationFacility::Airport, StationFacility::Dock})) ||
647 (is_passengers && !st->facilities.Any({StationFacility::Train, StationFacility::BusStop, StationFacility::Airport, StationFacility::Dock}))) {
648 amt = 0;
649 }
650
651 GoodsEntry &ge = st->goods[cargo];
654 (*LinkGraph::Get(ge.link_graph))[ge.node].SetDemand(amt / 8);
655 }
656 }
657
658 /* Only show a message in case the acceptance was actually changed. */
659 CargoTypes new_acc = GetAcceptanceMask(st);
660 if (old_acc == new_acc) return;
661
662 /* show a message to report that the acceptance was changed? */
663 if (show_msg && st->owner == _local_company && st->IsInUse()) {
664 /* Combine old and new masks to get changes */
665 CargoTypes accepts = new_acc & CargoTypes{old_acc}.Flip();
666 CargoTypes rejects = CargoTypes{new_acc}.Flip() & old_acc;
667
668 /* Show news message if there are any changes */
669 if (accepts.Any()) ShowRejectOrAcceptNews(st, accepts, false);
670 if (rejects.Any()) ShowRejectOrAcceptNews(st, rejects, true);
671 }
672
673 /* redraw the station view since acceptance changed */
674 SetWindowWidgetDirty(WindowClass::StationView, st->index, WID_SV_ACCEPT_RATING_LIST);
675}
676
677static void UpdateStationSignCoord(BaseStation *st)
678{
679 const StationRect *r = &st->rect;
680
681 if (r->IsEmpty()) return; // no tiles belong to this station
682
683 /* clamp sign coord to be inside the station rect */
684 TileIndex new_xy = TileXY(ClampU(TileX(st->xy), r->left, r->right), ClampU(TileY(st->xy), r->top, r->bottom));
685 st->MoveSign(new_xy);
686
687 if (!Station::IsExpected(st)) return;
688 Station *full_station = Station::From(st);
689 for (const GoodsEntry &ge : full_station->goods) {
690 LinkGraphID lg = ge.link_graph;
691 if (!LinkGraph::IsValidID(lg)) continue;
692 (*LinkGraph::Get(lg))[ge.node].UpdateLocation(st->xy);
693 }
694}
695
705static CommandCost BuildStationPart(Station **st, DoCommandFlags flags, bool reuse, TileArea area, StationNaming name_class)
706{
707 /* Find a deleted station close to us */
708 if (*st == nullptr && reuse) *st = GetClosestDeletedStation(area.tile);
709
710 if (*st != nullptr) {
711 if ((*st)->owner != _current_company) {
712 return CommandCost(CMD_ERROR);
713 }
714
715 CommandCost ret = (*st)->rect.BeforeAddRect(area.tile, area.w, area.h, StationRect::ADD_TEST);
716 if (ret.Failed()) return ret;
717 } else {
718 /* allocate and initialize new station */
719 if (!Station::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
720
721 if (flags.Test(DoCommandFlag::Execute)) {
722 *st = Station::Create(area.tile);
723 _station_kdtree.Insert((*st)->index);
724
725 (*st)->town = ClosestTownFromTile(area.tile, UINT_MAX);
726 (*st)->string_id = GenerateStationName(*st, area.tile, name_class);
727
729 (*st)->town->have_ratings.Set(_current_company);
730 }
731 }
732 }
733 return CommandCost();
734}
735
743{
744 if (!st->IsInUse()) {
745 st->delete_ctr = 0;
746 InvalidateWindowData(WindowClass::StationList, st->owner, 0);
747 }
748 /* station remains but it probably lost some parts - station sign should stay in the station boundaries */
749 UpdateStationSignCoord(st);
750}
751
758{
759 this->UpdateVirtCoord();
761
762 if (adding) {
763 this->RecomputeCatchment();
764 MarkCatchmentTilesDirty();
765 InvalidateWindowData(WindowClass::StationList, this->owner, 0);
766 } else {
767 MarkCatchmentTilesDirty();
768 }
769
770 switch (type) {
772 SetWindowWidgetDirty(WindowClass::StationView, this->index, WID_SV_TRAINS);
773 break;
775 break;
777 case StationType::Bus:
778 SetWindowWidgetDirty(WindowClass::StationView, this->index, WID_SV_ROADVEHS);
779 break;
781 SetWindowWidgetDirty(WindowClass::StationView, this->index, WID_SV_SHIPS);
782 break;
783 default: NOT_REACHED();
784 }
785
786 if (adding) {
787 UpdateStationAcceptance(this, false);
788 InvalidateWindowData(WindowClass::JoinStation, 0, 0);
789 } else {
791 this->RecomputeCatchment();
792 }
793
794}
795
797
807CommandCost CheckBuildableTile(TileIndex tile, DiagDirections invalid_dirs, int &allowed_z, bool allow_steep, bool check_bridge = true)
808{
809 if (check_bridge && IsBridgeAbove(tile)) {
810 return CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
811 }
812
814 if (ret.Failed()) return ret;
815
816 auto [tileh, z] = GetTileSlopeZ(tile);
817
818 /* Prohibit building if
819 * 1) The tile is "steep" (i.e. stretches two height levels).
820 * 2) The tile is non-flat and the build_on_slopes switch is disabled.
821 */
822 if ((!allow_steep && IsSteepSlope(tileh)) ||
823 ((!_settings_game.construction.build_on_slopes) && tileh != SLOPE_FLAT)) {
824 return CommandCost(STR_ERROR_FLAT_LAND_REQUIRED);
825 }
826
828 int flat_z = z + GetSlopeMaxZ(tileh);
829 if (tileh != SLOPE_FLAT) {
830 /* Forbid building if the tile faces a slope in a invalid direction. */
832 if (invalid_dirs.Test(dir) && !CanBuildDepotByTileh(dir, tileh)) {
833 return CommandCost(STR_ERROR_FLAT_LAND_REQUIRED);
834 }
835 }
837 }
838
839 /* The level of this tile must be equal to allowed_z. */
840 if (allowed_z < 0) {
841 /* First tile. */
842 allowed_z = flat_z;
843 } else if (allowed_z != flat_z) {
844 return CommandCost(STR_ERROR_FLAT_LAND_REQUIRED);
845 }
846
847 return cost;
848}
849
857{
859 int allowed_z = -1;
860
861 for (; tile_iter != INVALID_TILE; ++tile_iter) {
862 CommandCost ret = CheckBuildableTile(tile_iter, {}, allowed_z, true);
863 if (ret.Failed()) return ret;
864 cost.AddCost(ret.GetCost());
865
866 ret = Command<Commands::LandscapeClear>::Do(flags, tile_iter);
867 if (ret.Failed()) return ret;
868 cost.AddCost(ret.GetCost());
869 }
870
871 return cost;
872}
873
880{
882 STR_ERROR_BRIDGE_TOO_LOW_FOR_STATION, // Rail
883 INVALID_STRING_ID, // Airport
884 STR_ERROR_BRIDGE_TOO_LOW_FOR_ROADSTOP, // Truck
885 STR_ERROR_BRIDGE_TOO_LOW_FOR_ROADSTOP, // Bus
886 INVALID_STRING_ID, // Oilrig
887 STR_ERROR_BRIDGE_TOO_LOW_FOR_DOCK, // Dock
888 STR_ERROR_BRIDGE_TOO_LOW_FOR_BUOY, // Buoy
889 STR_ERROR_BRIDGE_TOO_LOW_FOR_RAIL_WAYPOINT, // RailWaypoint
890 STR_ERROR_BRIDGE_TOO_LOW_FOR_ROAD_WAYPOINT, // RoadWaypoint
891 };
892 return too_low_msgs[type];
893};
894
905static CommandCost IsStationBridgeAboveOk(TileIndex tile, std::span<const BridgeableTileInfo> bridgeable_info, StationType type, StationGfx layout, int bridge_height, StringID disallowed_msg = INVALID_STRING_ID)
906{
907 int height = layout < std::size(bridgeable_info) ? bridgeable_info[layout].height : 0;
908
909 if (height == 0) {
910 if (disallowed_msg != INVALID_STRING_ID) return CommandCost{disallowed_msg};
911 /* Get normal error message associated with clearing the tile. */
912 return Command<Commands::LandscapeClear>::Do(DoCommandFlag::Auto, tile);
913 }
914
915 int height_diff = GetTileMaxZ(tile) + height - bridge_height;
916 if (height_diff > 0) return CommandCostWithParam(GetBridgeTooLowMessageForStationType(type), height_diff * TILE_HEIGHT_STEP);
917 return CommandCost{};
918}
919
925static std::span<const BridgeableTileInfo> GetStationBridgeableTileInfo(StationType type)
926{
927 return _station_bridgeable_info[type];
928}
929
939{
940 if (!IsBridgeAbove(tile)) return CommandCost();
941
942 TileIndex rampsouth = GetSouthernBridgeEnd(tile);
943 auto bridgeable_info = spec == nullptr ? GetStationBridgeableTileInfo(type) : spec->bridgeable_info;
944 return IsStationBridgeAboveOk(tile, bridgeable_info, type, layout, GetBridgeHeight(rampsouth), STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
945}
946
956{
957 if (!IsBridgeAbove(tile)) return CommandCost();
958
959 TileIndex rampsouth = GetSouthernBridgeEnd(tile);
960 auto bridgeable_info = spec == nullptr ? GetStationBridgeableTileInfo(type) : spec->bridgeable_info;
961 return IsStationBridgeAboveOk(tile, bridgeable_info, type, layout, GetBridgeHeight(rampsouth), STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
962}
963
971{
972 if (!IsBridgeAbove(tile)) return CommandCost();
973
974 TileIndex rampsouth = GetSouthernBridgeEnd(tile);
975 auto bridgeable_info = GetStationBridgeableTileInfo(StationType::Dock);
976 return IsStationBridgeAboveOk(tile, bridgeable_info, StationType::Dock, layout, GetBridgeHeight(rampsouth), STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
977}
978
985{
986 if (!IsBridgeAbove(tile)) return CommandCost();
987
988 TileIndex rampsouth = GetSouthernBridgeEnd(tile);
989 auto bridgeable_info = GetStationBridgeableTileInfo(StationType::Buoy);
990 return IsStationBridgeAboveOk(tile, bridgeable_info, StationType::Buoy, 0, GetBridgeHeight(rampsouth), STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
991}
992
1009static CommandCost CheckFlatLandRailStation(TileIndex tile_cur, TileIndex north_tile, int &allowed_z, DoCommandFlags flags, Axis axis, StationID *station, RailType rt, std::vector<Train *> &affected_vehicles, StationClassID spec_class, uint16_t spec_index, uint8_t plat_len, uint8_t numtracks)
1010{
1012 DiagDirections invalid_dirs = AxisToDiagDirs(axis);
1013
1014 const StationSpec *statspec = StationClass::Get(spec_class)->GetSpec(spec_index);
1015 bool slope_cb = statspec != nullptr && statspec->callback_mask.Test(StationCallbackMask::SlopeCheck);
1016
1017 CommandCost ret = CheckBuildableTile(tile_cur, invalid_dirs, allowed_z, false, false);
1018 if (ret.Failed()) return ret;
1019 cost.AddCost(ret.GetCost());
1020
1021 if (slope_cb) {
1022 /* Do slope check if requested. */
1023 ret = PerformStationTileSlopeCheck(north_tile, tile_cur, statspec, axis, plat_len, numtracks);
1024 if (ret.Failed()) return ret;
1025 }
1026
1027 /* if station is set, then we have special handling to allow building on top of already existing stations.
1028 * so station points to StationID::Invalid() if we can build on any station.
1029 * Or it points to a station if we're only allowed to build on exactly that station. */
1030 if (station != nullptr && IsTileType(tile_cur, TileType::Station)) {
1031 if (!IsRailStation(tile_cur)) {
1032 return ClearTile_Station(tile_cur, DoCommandFlag::Auto); // get error message
1033 } else {
1034 StationID st = GetStationIndex(tile_cur);
1035 if (*station == StationID::Invalid()) {
1036 *station = st;
1037 } else if (*station != st) {
1038 return CommandCost(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
1039 }
1040 }
1041 } else {
1042 /* If we are building a station with a valid railtype, we may be able to overbuild an existing rail tile. */
1043 if (rt != INVALID_RAILTYPE && IsPlainRailTile(tile_cur)) {
1044 /* Don't overbuild signals. */
1045 if (HasSignals(tile_cur)) return CommandCost(STR_ERROR_MUST_REMOVE_SIGNALS_FIRST);
1046
1047 /* The current rail type must have power on the to-be-built type (e.g. convert normal rail to electrified rail). */
1048 if (HasPowerOnRail(GetRailType(tile_cur), rt)) {
1049 /* The existing track must align with the desired station axis. */
1050 Track track = AxisToTrack(axis);
1051 if (GetTrackBits(tile_cur) == track) {
1052 /* Check for trains having a reservation for this tile. */
1053 if (GetRailReservationTrackBits(tile_cur).Test(track)) {
1054 Train *v = GetTrainForReservation(tile_cur, track);
1055 if (v != nullptr) {
1056 affected_vehicles.push_back(v);
1057 }
1058 }
1059 ret = Command<Commands::RemoveRail>::Do(flags, tile_cur, track);
1060 if (ret.Failed()) return ret;
1061 cost.AddCost(ret.GetCost());
1062 /* With DoCommandFlags{flags}.Reset(DoCommandFlag::Execute) CmdLandscapeClear would fail since the rail still exists */
1063 return cost;
1064 }
1065 }
1066 }
1067 ret = Command<Commands::LandscapeClear>::Do(flags, tile_cur);
1068 if (ret.Failed()) return ret;
1069 cost.AddCost(ret.GetCost());
1070 }
1071
1072 return cost;
1073}
1074
1089static CommandCost CheckFlatLandRoadStop(TileIndex cur_tile, int &allowed_z, const RoadStopSpec *spec, DoCommandFlags flags, DiagDirections invalid_dirs, bool is_drive_through, StationType station_type, Axis axis, StationID *station, RoadType rt)
1090{
1092
1093 CommandCost ret = CheckBuildableTile(cur_tile, invalid_dirs, allowed_z, !is_drive_through, false);
1094 if (ret.Failed()) return ret;
1095 cost.AddCost(ret.GetCost());
1096
1097 ret = IsRoadStationBridgeAboveOk(cur_tile, spec, station_type, is_drive_through ? GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET + to_underlying(axis) : FindFirstBit(invalid_dirs.base()));
1098 if (ret.Failed()) return ret;
1099
1100 /* If station is set, then we have special handling to allow building on top of already existing stations.
1101 * Station points to StationID::Invalid() if we can build on any station.
1102 * Or it points to a station if we're only allowed to build on exactly that station. */
1103 if (station != nullptr && IsTileType(cur_tile, TileType::Station)) {
1104 if (!IsAnyRoadStop(cur_tile)) {
1105 return ClearTile_Station(cur_tile, DoCommandFlag::Auto); // Get error message.
1106 } else {
1107 if (station_type != GetStationType(cur_tile) ||
1108 is_drive_through != IsDriveThroughStopTile(cur_tile)) {
1109 return ClearTile_Station(cur_tile, DoCommandFlag::Auto); // Get error message.
1110 }
1111 /* Drive-through station in the wrong direction. */
1112 if (is_drive_through && IsDriveThroughStopTile(cur_tile) && GetDriveThroughStopAxis(cur_tile) != axis) {
1113 return CommandCost(STR_ERROR_DRIVE_THROUGH_DIRECTION);
1114 }
1115 StationID st = GetStationIndex(cur_tile);
1116 if (*station == StationID::Invalid()) {
1117 *station = st;
1118 } else if (*station != st) {
1119 return CommandCost(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
1120 }
1121 }
1122 } else {
1123 bool build_over_road = is_drive_through && IsNormalRoadTile(cur_tile);
1124 /* Road bits in the wrong direction. */
1125 RoadBits rb = IsNormalRoadTile(cur_tile) ? GetAllRoadBits(cur_tile) : RoadBits{};
1126 if (build_over_road && rb.Any(AxisToRoadBits(OtherAxis(axis)))) {
1127 /* Someone was pedantic and *NEEDED* three fracking different error messages. */
1128 switch (rb.Count()) {
1129 case 1:
1130 return CommandCost(STR_ERROR_DRIVE_THROUGH_DIRECTION);
1131
1132 case 2:
1133 if (rb == ROAD_X || rb == ROAD_Y) return CommandCost(STR_ERROR_DRIVE_THROUGH_DIRECTION);
1134 return CommandCost(STR_ERROR_DRIVE_THROUGH_CORNER);
1135
1136 default: // 3 or 4
1137 return CommandCost(STR_ERROR_DRIVE_THROUGH_JUNCTION);
1138 }
1139 }
1140
1141 if (build_over_road) {
1142 /* There is a road, check if we can build road+tram stop over it. */
1143 RoadType road_rt = GetRoadType(cur_tile, RoadTramType::Road);
1144 if (road_rt != INVALID_ROADTYPE) {
1145 Owner road_owner = GetRoadOwner(cur_tile, RoadTramType::Road);
1146 if (road_owner == OWNER_TOWN) {
1147 if (!_settings_game.construction.road_stop_on_town_road) return CommandCost(STR_ERROR_DRIVE_THROUGH_ON_TOWN_ROAD);
1148 } else if (!_settings_game.construction.road_stop_on_competitor_road && road_owner != OWNER_NONE) {
1149 ret = CheckOwnership(road_owner);
1150 if (ret.Failed()) return ret;
1151 }
1152 uint num_pieces = GetRoadBits(cur_tile, RoadTramType::Road).Count();
1153
1154 if (rt != INVALID_ROADTYPE && RoadTypeIsRoad(rt) && !HasPowerOnRoad(rt, road_rt)) return CommandCost(STR_ERROR_NO_SUITABLE_ROAD);
1155
1156 if (GetDisallowedRoadDirections(cur_tile).Any() && road_owner != OWNER_TOWN && road_owner != OWNER_NONE) {
1157 ret = CheckOwnership(road_owner);
1158 if (ret.Failed()) return ret;
1159 }
1160
1161 cost.AddCost(RoadBuildCost(road_rt) * (2 - num_pieces));
1162 } else if (rt != INVALID_ROADTYPE && RoadTypeIsRoad(rt)) {
1163 cost.AddCost(RoadBuildCost(rt) * 2);
1164 }
1165
1166 /* There is a tram, check if we can build road+tram stop over it. */
1167 RoadType tram_rt = GetRoadType(cur_tile, RoadTramType::Tram);
1168 if (tram_rt != INVALID_ROADTYPE) {
1169 Owner tram_owner = GetRoadOwner(cur_tile, RoadTramType::Tram);
1170 if (Company::IsValidID(tram_owner) &&
1171 (!_settings_game.construction.road_stop_on_competitor_road ||
1172 /* Disallow breaking end-of-line of someone else
1173 * so trams can still reverse on this tile. */
1174 GetRoadBits(cur_tile, RoadTramType::Tram).Count() == 1)) {
1175 ret = CheckOwnership(tram_owner);
1176 if (ret.Failed()) return ret;
1177 }
1178 uint num_pieces = GetRoadBits(cur_tile, RoadTramType::Tram).Count();
1179
1180 if (rt != INVALID_ROADTYPE && RoadTypeIsTram(rt) && !HasPowerOnRoad(rt, tram_rt)) return CommandCost(STR_ERROR_NO_SUITABLE_ROAD);
1181
1182 cost.AddCost(RoadBuildCost(tram_rt) * (2 - num_pieces));
1183 } else if (rt != INVALID_ROADTYPE && RoadTypeIsTram(rt)) {
1184 cost.AddCost(RoadBuildCost(rt) * 2);
1185 }
1186 } else if (rt == INVALID_ROADTYPE) {
1187 return CommandCost(STR_ERROR_THERE_IS_NO_ROAD);
1188 } else {
1189 ret = Command<Commands::LandscapeClear>::Do(flags, cur_tile);
1190 if (ret.Failed()) return ret;
1191 cost.AddCost(ret.GetCost());
1192 cost.AddCost(RoadBuildCost(rt) * 2);
1193 }
1194 }
1195
1196 return cost;
1197}
1198
1206{
1207 TileArea cur_ta = st->train_station;
1208
1209 /* determine new size of train station region.. */
1210 int x = std::min(TileX(cur_ta.tile), TileX(new_ta.tile));
1211 int y = std::min(TileY(cur_ta.tile), TileY(new_ta.tile));
1212 new_ta.w = std::max<uint16_t>(TileX(cur_ta.tile) + cur_ta.w, TileX(new_ta.tile) + new_ta.w) - x;
1213 new_ta.h = std::max<uint16_t>(TileY(cur_ta.tile) + cur_ta.h, TileY(new_ta.tile) + new_ta.h) - y;
1214 new_ta.tile = TileXY(x, y);
1215
1216 /* make sure the final size is not too big. */
1217 if (new_ta.w > _settings_game.station.station_spread || new_ta.h > _settings_game.station.station_spread) {
1218 return CommandCost(STR_ERROR_STATION_TOO_SPREAD_OUT);
1219 }
1220
1221 return CommandCost();
1222}
1223
1225template <>
1227{
1228 /* Use predefined layout if it exists. Mask bit zero which will indicate axis. */
1229 if (!stl.layout.empty()) return this->stl.layout[this->position] & ~1;
1230
1231 if (this->stl.length == 1) {
1232 /* Special case for 1-long platforms, all bare platforms except one small building. */
1233 return this->position == ((this->stl.platforms - 1) / 2) ? 2 : 0;
1234 }
1235
1236 if ((this->position < this->stl.length && (this->stl.platforms % 2 == 1))) {
1237 /* Number of tracks is odd, make the first platform bare with a small building. */
1238 return this->position == ((this->stl.length - 1) / 2) ? 2 : 0;
1239 }
1240
1241 if (this->stl.length > 4 && ((this->position % this->stl.length) == 0 || (this->position % this->stl.length) == this->stl.length - 1)) {
1242 /* Station is longer than 4 tiles, place bare platforms at either end. */
1243 return 0;
1244 }
1245
1246 /* None of the above so must be north or south part of larger station. */
1247 return (((this->position / this->stl.length) % 2) == (this->stl.platforms % 2)) ? 4 : 6;
1248}
1249
1263template <class T, StringID error_message, class F>
1264CommandCost FindJoiningBaseStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, T **st, F filter)
1265{
1266 assert(*st == nullptr);
1267 bool check_surrounding = true;
1268
1269 if (existing_station != StationID::Invalid()) {
1270 if (adjacent && existing_station != station_to_join) {
1271 /* You can't build an adjacent station over the top of one that
1272 * already exists. */
1273 return CommandCost(error_message);
1274 } else {
1275 /* Extend the current station, and don't check whether it will
1276 * be near any other stations. */
1277 T *candidate = T::GetIfValid(existing_station);
1278 if (candidate != nullptr && filter(candidate)) *st = candidate;
1279 check_surrounding = (*st == nullptr);
1280 }
1281 } else {
1282 /* There's no station here. Don't check the tiles surrounding this
1283 * one if the company wanted to build an adjacent station. */
1284 if (adjacent) check_surrounding = false;
1285 }
1286
1287 if (check_surrounding) {
1288 /* Make sure there is no more than one other station around us that is owned by us. */
1289 CommandCost ret = GetStationAround(ta, existing_station, _current_company, st, filter);
1290 if (ret.Failed()) return ret;
1291 }
1292
1293 /* Distant join */
1294 if (*st == nullptr && station_to_join != StationID::Invalid()) *st = T::GetIfValid(station_to_join);
1295
1296 return CommandCost();
1297}
1298
1308static CommandCost FindJoiningStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
1309{
1310 return FindJoiningBaseStation<Station, STR_ERROR_MUST_REMOVE_RAILWAY_STATION_FIRST>(existing_station, station_to_join, adjacent, ta, st, [](const Station *) -> bool { return true; });
1311}
1312
1323CommandCost FindJoiningWaypoint(StationID existing_waypoint, StationID waypoint_to_join, bool adjacent, TileArea ta, Waypoint **wp, bool is_road)
1324{
1325 if (is_road) {
1326 return FindJoiningBaseStation<Waypoint, STR_ERROR_MUST_REMOVE_ROADWAYPOINT_FIRST>(existing_waypoint, waypoint_to_join, adjacent, ta, wp, [](const Waypoint *wp) -> bool { return HasBit(wp->waypoint_flags, WPF_ROAD); });
1327 } else {
1328 return FindJoiningBaseStation<Waypoint, STR_ERROR_MUST_REMOVE_RAILWAYPOINT_FIRST>(existing_waypoint, waypoint_to_join, adjacent, ta, wp, [](const Waypoint *wp) -> bool { return !HasBit(wp->waypoint_flags, WPF_ROAD); });
1329 }
1330}
1331
1343
1355
1370static CommandCost CalculateRailStationCost(TileArea tile_area, DoCommandFlags flags, Axis axis, StationID *station, RailType rt, std::vector<Train *> &affected_vehicles, StationClassID spec_class, uint16_t spec_index, uint8_t plat_len, uint8_t numtracks)
1371{
1373 bool length_price_ready = true;
1374 uint8_t tracknum = 0;
1375 int allowed_z = -1;
1376 for (TileIndex cur_tile : tile_area) {
1377 /* Clear the land below the station. */
1378 CommandCost ret = CheckFlatLandRailStation(cur_tile, tile_area.tile, allowed_z, flags, axis, station, rt, affected_vehicles, spec_class, spec_index, plat_len, numtracks);
1379 if (ret.Failed()) return ret;
1380
1381 /* Only add _price[Price::BuildStationRailLength] once for each valid plat_len. */
1382 if (tracknum == numtracks) {
1383 length_price_ready = true;
1384 tracknum = 0;
1385 } else {
1386 tracknum++;
1387 }
1388
1389 /* AddCost for new or rotated rail stations. */
1390 if (!IsRailStationTile(cur_tile) || (IsRailStationTile(cur_tile) && GetRailStationAxis(cur_tile) != axis)) {
1391 cost.AddCost(ret.GetCost());
1393 cost.AddCost(RailBuildCost(rt));
1394
1395 if (length_price_ready) {
1397 length_price_ready = false;
1398 }
1399 }
1400 }
1401
1402 return cost;
1403}
1404
1412{
1413 /* Default stations do not draw pylons under roofs (gfx >= 4) */
1414 if (statspec == nullptr || gfx >= statspec->tileflags.size()) return gfx < 4 ? StationSpec::TileFlag::Pylons : StationSpec::TileFlags{};
1415 return statspec->tileflags[gfx];
1416}
1417
1424{
1425 const auto flags = GetStationTileFlags(GetStationGfx(tile), statspec);
1429}
1430
1445CommandCost CmdBuildRailStation(DoCommandFlags flags, TileIndex tile_org, RailType rt, Axis axis, uint8_t numtracks, uint8_t plat_len, StationClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
1446{
1447 /* Does the authority allow this? */
1448 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile_org, flags);
1449 if (ret.Failed()) return ret;
1450
1451 if (!ValParamRailType(rt) || !IsValidAxis(axis)) return CMD_ERROR;
1452
1453 /* Check if the given station class is valid */
1454 if (spec_class.base() >= StationClass::GetClassCount()) return CMD_ERROR;
1455 const StationClass *cls = StationClass::Get(spec_class);
1456 if (IsWaypointClass(*cls)) return CMD_ERROR;
1457 if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
1458 if (plat_len == 0 || numtracks == 0) return CMD_ERROR;
1459
1460 int w_org, h_org;
1461 if (axis == Axis::X) {
1462 w_org = plat_len;
1463 h_org = numtracks;
1464 } else {
1465 h_org = plat_len;
1466 w_org = numtracks;
1467 }
1468
1469 /* Check if the first tile and the last tile are valid */
1470 if (!IsValidTile(tile_org) || TileAddWrap(tile_org, w_org - 1, h_org - 1) == INVALID_TILE) return CMD_ERROR;
1471
1472 bool reuse = (station_to_join != NEW_STATION);
1473 if (!reuse) station_to_join = StationID::Invalid();
1474 bool distant_join = (station_to_join != StationID::Invalid());
1475
1476 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
1477
1478 if (h_org > _settings_game.station.station_spread || w_org > _settings_game.station.station_spread) return CMD_ERROR;
1479
1480 /* these values are those that will be stored in train_tile and station_platforms */
1481 TileArea new_location(tile_org, w_org, h_org);
1482
1483 /* Make sure the area below consists of clear tiles. (OR tiles belonging to a certain rail station) */
1484 StationID est = StationID::Invalid();
1485 std::vector<Train *> affected_vehicles;
1486 /* Add construction and clearing expenses. */
1487 CommandCost cost = CalculateRailStationCost(new_location, flags, axis, &est, rt, affected_vehicles, spec_class, spec_index, plat_len, numtracks);
1488 if (cost.Failed()) return cost;
1489
1490 Station *st = nullptr;
1491 ret = FindJoiningStation(est, station_to_join, adjacent, new_location, &st);
1492 if (ret.Failed()) return ret;
1493
1494 ret = BuildStationPart(&st, flags, reuse, new_location, StationNaming::Rail);
1495 if (ret.Failed()) return ret;
1496
1497 if (st != nullptr && st->train_station.tile != INVALID_TILE) {
1498 ret = CanExpandRailStation(st, new_location);
1499 if (ret.Failed()) return ret;
1500 }
1501
1502 const StationSpec *statspec = StationClass::Get(spec_class)->GetSpec(spec_index);
1503 TileIndexDiff tile_delta = TileOffsByAxis(axis); // offset to go to the next platform tile
1504 TileIndexDiff track_delta = TileOffsByAxis(OtherAxis(axis)); // offset to go to the next track
1505
1506 RailStationTileLayout<StationType::Rail> stl{statspec, numtracks, plat_len};
1507 for (auto [i, it, tile_track] = std::make_tuple(0, stl.begin(), tile_org); i != numtracks; ++i, tile_track += track_delta) {
1508 for (auto [j, tile] = std::make_tuple(0, tile_track); j != plat_len; ++j, tile += tile_delta, ++it) {
1509 /* Don't check the layout if there's no bridge above anyway. */
1510 if (!IsBridgeAbove(tile)) continue;
1511
1512 StationGfx gfx = *it + to_underlying(axis);
1513 if (statspec != nullptr) {
1514 uint32_t platinfo = GetPlatformInfo(gfx, numtracks, plat_len, i, j, false);
1515 /* As the station is not yet completely finished, the station does not yet exist. */
1516 uint16_t callback = GetStationCallback(CBID_STATION_BUILD_TILE_LAYOUT, platinfo, 0, statspec, nullptr, INVALID_TILE);
1517 if (callback != CALLBACK_FAILED && callback <= UINT8_MAX) gfx = (callback & ~1) + to_underlying(axis);
1518 }
1519
1520 ret = IsRailStationBridgeAboveOk(tile, statspec, StationType::Rail, gfx);
1521 if (ret.Failed()) return ret;
1522 }
1523 }
1524
1525 /* Check if we can allocate a custom stationspec to this station */
1526 auto specindex = AllocateSpecToStation(statspec, st);
1527 if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
1528
1529 if (statspec != nullptr) {
1530 /* Perform NewStation checks */
1531
1532 /* Check if the station size is permitted */
1533 if (HasBit(statspec->disallowed_platforms, std::min(numtracks - 1, 7))) return CommandCost(STR_ERROR_STATION_DISALLOWED_NUMBER_TRACKS);
1534 if (HasBit(statspec->disallowed_lengths, std::min(plat_len - 1, 7))) return CommandCost(STR_ERROR_STATION_DISALLOWED_LENGTH);
1535
1536 /* Check if the station is buildable */
1538 uint16_t cb_res = GetStationCallback(CBID_STATION_AVAILABILITY, 0, 0, statspec, nullptr, INVALID_TILE);
1540 }
1541 }
1542
1543 if (flags.Test(DoCommandFlag::Execute)) {
1544 st->train_station = new_location;
1545 st->AddFacility(StationFacility::Train, new_location.tile);
1546
1547 st->rect.BeforeAddRect(tile_org, w_org, h_org, StationRect::ADD_TRY);
1548
1549 if (specindex.has_value()) AssignSpecToStation(statspec, st, *specindex);
1550 if (statspec != nullptr) {
1551 /* Include this station spec's animation trigger bitmask
1552 * in the station's cached copy. */
1553 st->cached_anim_triggers.Set(statspec->animation.triggers);
1554 }
1555
1556 Track track = AxisToTrack(axis);
1557 Company *c = Company::Get(st->owner);
1558 for (auto [i, it, tile_track] = std::make_tuple(0, stl.begin(), tile_org); i != numtracks; ++i, tile_track += track_delta) {
1559 for (auto [j, tile] = std::make_tuple(0, tile_track); j != plat_len; ++j, tile += tile_delta, ++it) {
1560 if (IsRailStationTile(tile) && HasStationReservation(tile)) {
1561 /* Check for trains having a reservation for this tile. */
1563 if (v != nullptr) {
1564 affected_vehicles.push_back(v);
1566 }
1567 }
1568
1569 /* Railtype can change when overbuilding. */
1570 if (IsRailStationTile(tile)) {
1571 if (!IsStationTileBlocked(tile)) c->infrastructure.rail[GetRailType(tile)]--;
1573 }
1574
1575 /* Remove animation if overbuilding */
1576 DeleteAnimatedTile(tile);
1577 uint8_t old_specindex = HasStationTileRail(tile) ? GetCustomStationSpecIndex(tile) : 0;
1578
1579 MakeRailStation(tile, st->owner, st->index, axis, *it, rt);
1580 /* Free the spec if we overbuild something */
1581 DeallocateSpecFromStation(st, old_specindex);
1582 if (statspec == nullptr) DeleteNewGRFInspectWindow(GrfSpecFeature::Stations, tile);
1583
1584 SetCustomStationSpecIndex(tile, *specindex);
1585 SetStationTileRandomBits(tile, GB(Random(), 0, 4));
1586 SetAnimationFrame(tile, 0);
1587
1588 if (statspec != nullptr) {
1589 uint32_t platinfo = GetPlatformInfo(*it + to_underlying(axis), numtracks, plat_len, i, j, false);
1590
1591 /* As the station is not yet completely finished, the station does not yet exist. */
1592 uint16_t callback = GetStationCallback(CBID_STATION_BUILD_TILE_LAYOUT, platinfo, 0, statspec, nullptr, tile);
1593 if (callback != CALLBACK_FAILED) {
1594 if (callback <= UINT8_MAX) {
1595 SetStationGfx(tile, (callback & ~1) + to_underlying(axis));
1596 } else {
1598 }
1599 }
1600
1601 /* Trigger station animation -- after building? */
1602 TriggerStationAnimation(st, tile, StationAnimationTrigger::Built);
1603 }
1604
1605 SetRailStationTileFlags(tile, statspec);
1606
1607 if (!IsStationTileBlocked(tile)) c->infrastructure.rail[rt]++;
1609 }
1610 AddTrackToSignalBuffer(tile_track, track, _current_company);
1611 YapfNotifyTrackLayoutChange(tile_track, track);
1612 }
1613
1614 for (uint i = 0; i < affected_vehicles.size(); ++i) {
1615 /* Restore reservations of trains. */
1616 RestoreTrainReservation(affected_vehicles[i]);
1617 }
1618
1619 /* Check whether we need to expand the reservation of trains already on the station. */
1620 TileArea update_reservation_area;
1621 if (axis == Axis::X) {
1622 update_reservation_area = TileArea(tile_org, 1, numtracks);
1623 } else {
1624 update_reservation_area = TileArea(tile_org, numtracks, 1);
1625 }
1626
1627 for (TileIndex tile : update_reservation_area) {
1628 /* Don't even try to make eye candy parts reserved. */
1629 if (IsStationTileBlocked(tile)) continue;
1630
1631 DiagDirection dir = AxisToDiagDir(axis);
1632 TileIndexDiff tile_offset = TileOffsByDiagDir(dir);
1633 TileIndex platform_begin = tile;
1634 TileIndex platform_end = tile;
1635
1636 /* We can only account for tiles that are reachable from this tile, so ignore primarily blocked tiles while finding the platform begin and end. */
1637 for (TileIndex next_tile = platform_begin - tile_offset; IsCompatibleTrainStationTile(next_tile, platform_begin); next_tile -= tile_offset) {
1638 platform_begin = next_tile;
1639 }
1640 for (TileIndex next_tile = platform_end + tile_offset; IsCompatibleTrainStationTile(next_tile, platform_end); next_tile += tile_offset) {
1641 platform_end = next_tile;
1642 }
1643
1644 /* If there is at least on reservation on the platform, we reserve the whole platform. */
1645 bool reservation = false;
1646 for (TileIndex t = platform_begin; !reservation && t <= platform_end; t += tile_offset) {
1647 reservation = HasStationReservation(t);
1648 }
1649
1650 if (reservation) {
1651 SetRailStationPlatformReservation(platform_begin, dir, true);
1652 }
1653 }
1654
1655 st->MarkTilesDirty(false);
1657 }
1658
1659 return cost;
1660}
1661
1662static TileArea MakeStationAreaSmaller(BaseStation *st, TileArea ta, bool (*func)(BaseStation *, TileIndex))
1663{
1664restart:
1665
1666 /* too small? */
1667 if (ta.w != 0 && ta.h != 0) {
1668 /* check the left side, x = constant, y changes */
1669 for (uint i = 0; !func(st, ta.tile + TileDiffXY(0, i));) {
1670 /* the left side is unused? */
1671 if (++i == ta.h) {
1672 ta.tile += TileDiffXY(1, 0);
1673 ta.w--;
1674 goto restart;
1675 }
1676 }
1677
1678 /* check the right side, x = constant, y changes */
1679 for (uint i = 0; !func(st, ta.tile + TileDiffXY(ta.w - 1, i));) {
1680 /* the right side is unused? */
1681 if (++i == ta.h) {
1682 ta.w--;
1683 goto restart;
1684 }
1685 }
1686
1687 /* check the upper side, y = constant, x changes */
1688 for (uint i = 0; !func(st, ta.tile + TileDiffXY(i, 0));) {
1689 /* the left side is unused? */
1690 if (++i == ta.w) {
1691 ta.tile += TileDiffXY(0, 1);
1692 ta.h--;
1693 goto restart;
1694 }
1695 }
1696
1697 /* check the lower side, y = constant, x changes */
1698 for (uint i = 0; !func(st, ta.tile + TileDiffXY(i, ta.h - 1));) {
1699 /* the left side is unused? */
1700 if (++i == ta.w) {
1701 ta.h--;
1702 goto restart;
1703 }
1704 }
1705 } else {
1706 ta.Clear();
1707 }
1708
1709 return ta;
1710}
1711
1712static bool TileBelongsToRailStation(BaseStation *st, TileIndex tile)
1713{
1714 return st->TileBelongsToRailStation(tile);
1715}
1716
1717static void MakeRailStationAreaSmaller(BaseStation *st)
1718{
1719 st->train_station = MakeStationAreaSmaller(st, st->train_station, TileBelongsToRailStation);
1720}
1721
1722static bool TileBelongsToShipStation(BaseStation *st, TileIndex tile)
1723{
1724 return IsDockTile(tile) && GetStationIndex(tile) == st->index;
1725}
1726
1727static void MakeShipStationAreaSmaller(Station *st)
1728{
1729 st->ship_station = MakeStationAreaSmaller(st, st->ship_station, TileBelongsToShipStation);
1730 UpdateStationDockingTiles(st);
1731}
1732
1733static bool TileBelongsToRoadWaypointStation(BaseStation *st, TileIndex tile)
1734{
1735 return IsRoadWaypointTile(tile) && GetStationIndex(tile) == st->index;
1736}
1737
1738void MakeRoadWaypointStationAreaSmaller(BaseStation *st, TileArea &road_waypoint_area)
1739{
1740 road_waypoint_area = MakeStationAreaSmaller(st, road_waypoint_area, TileBelongsToRoadWaypointStation);
1741}
1742
1753template <class T>
1754CommandCost RemoveFromRailBaseStation(TileArea ta, std::vector<T *> &affected_stations, DoCommandFlags flags, Money removal_cost, bool keep_rail)
1755{
1756 /* Count of the number of tiles removed */
1757 int quantity = 0;
1759 /* Accumulator for the errors seen during clearing. If no errors happen,
1760 * and the quantity is 0 there is no station. Otherwise it will be one
1761 * of the other error that got accumulated. */
1762 CommandCost error;
1763
1764 /* Do the action for every tile into the area */
1765 for (TileIndex tile : ta) {
1766 /* Make sure the specified tile is a rail station */
1767 if (!HasStationTileRail(tile)) continue;
1768
1769 /* If there is a vehicle on ground, do not allow to remove (flood) the tile */
1771 error.AddCost(std::move(ret));
1772 if (error.Failed()) continue;
1773
1774 /* Check ownership of station */
1775 T *st = T::GetByTile(tile);
1776 if (st == nullptr) continue;
1777
1779 ret = CheckOwnership(st->owner);
1780 error.AddCost(std::move(ret));
1781 if (error.Failed()) continue;
1782 }
1783
1784 /* If we reached here, the tile is valid so increase the quantity of tiles we will remove */
1785 quantity++;
1786
1787 if (keep_rail || IsStationTileBlocked(tile)) {
1788 /* Don't refund the 'steel' of the track when we keep the
1789 * rail, or when the tile didn't have any rail at all. */
1790 total_cost.AddCost(-_price[Price::ClearRail]);
1791 }
1792
1793 if (flags.Test(DoCommandFlag::Execute)) {
1794 /* read variables before the station tile is removed */
1795 uint specindex = GetCustomStationSpecIndex(tile);
1796 Track track = GetRailStationTrack(tile);
1797 Owner owner = GetTileOwner(tile);
1798 RailType rt = GetRailType(tile);
1799 Train *v = nullptr;
1800
1801 if (HasStationReservation(tile)) {
1802 v = GetTrainForReservation(tile, track);
1803 if (v != nullptr) FreeTrainReservation(v);
1804 }
1805
1806 bool build_rail = keep_rail && !IsStationTileBlocked(tile);
1807 if (!build_rail && !IsStationTileBlocked(tile)) Company::Get(owner)->infrastructure.rail[rt]--;
1808
1809 DoClearSquare(tile);
1811 if (build_rail) MakeRailNormal(tile, owner, track, rt);
1812 Company::Get(owner)->infrastructure.station--;
1814
1815 st->tile_waiting_random_triggers.erase(tile);
1816 st->rect.AfterRemoveTile(st, tile);
1817 AddTrackToSignalBuffer(tile, track, owner);
1818 YapfNotifyTrackLayoutChange(tile, track);
1819
1820 DeallocateSpecFromStation(st, specindex);
1821
1822 include(affected_stations, st);
1823
1824 if (v != nullptr) RestoreTrainReservation(v);
1825 }
1826 }
1827
1828 if (quantity == 0) return error.Failed() ? error : CommandCost(STR_ERROR_THERE_IS_NO_STATION);
1829
1830 for (T *st : affected_stations) {
1831
1832 /* now we need to make the "spanned" area of the railway station smaller
1833 * if we deleted something at the edges.
1834 * we also need to adjust train_tile. */
1835 MakeRailStationAreaSmaller(st);
1836 UpdateStationSignCoord(st);
1837
1838 /* if we deleted the whole station, delete the train facility. */
1839 if (st->train_station.tile == INVALID_TILE) {
1841 SetWindowClassesDirty(WindowClass::VehicleOrders);
1842 SetWindowWidgetDirty(WindowClass::StationView, st->index, WID_SV_TRAINS);
1843 MarkCatchmentTilesDirty();
1844 st->UpdateVirtCoord();
1846 }
1847 }
1848
1849 total_cost.AddCost(quantity * removal_cost);
1850 return total_cost;
1851}
1852
1863{
1864 if (end == 0) end = start;
1865 if (start >= Map::Size() || end >= Map::Size()) return CMD_ERROR;
1866
1867 TileArea ta(start, end);
1868 std::vector<Station *> affected_stations;
1869
1870 CommandCost ret = RemoveFromRailBaseStation(ta, affected_stations, flags, _price[Price::ClearStationRail], keep_rail);
1871 if (ret.Failed()) return ret;
1872
1873 /* Do all station specific functions here. */
1874 for (Station *st : affected_stations) {
1875
1876 if (st->train_station.tile == INVALID_TILE) SetWindowWidgetDirty(WindowClass::StationView, st->index, WID_SV_TRAINS);
1877 st->MarkTilesDirty(false);
1878 MarkCatchmentTilesDirty();
1879 st->RecomputeCatchment();
1880 }
1881
1882 /* Now apply the rail cost to the number that we deleted */
1883 return ret;
1884}
1885
1896{
1897 if (end == 0) end = start;
1898 if (start >= Map::Size() || end >= Map::Size()) return CMD_ERROR;
1899
1900 TileArea ta(start, end);
1901 std::vector<Waypoint *> affected_stations;
1902
1903 return RemoveFromRailBaseStation(ta, affected_stations, flags, _price[Price::ClearWaypointRail], keep_rail);
1904}
1905
1906
1915template <class T>
1916CommandCost RemoveRailStation(T *st, DoCommandFlags flags, Money removal_cost)
1917{
1918 /* Current company owns the station? */
1920 CommandCost ret = CheckOwnership(st->owner);
1921 if (ret.Failed()) return ret;
1922 }
1923
1924 /* determine width and height of platforms */
1925 TileArea ta = st->train_station;
1926
1927 assert(ta.w != 0 && ta.h != 0);
1928
1930 /* clear all areas of the station */
1931 for (TileIndex tile : ta) {
1932 /* only remove tiles that are actually train station tiles */
1933 if (st->TileBelongsToRailStation(tile)) {
1934 std::vector<T*> affected_stations; // dummy
1935 CommandCost ret = RemoveFromRailBaseStation(TileArea(tile, 1, 1), affected_stations, flags, removal_cost, false);
1936 if (ret.Failed()) return ret;
1937 cost.AddCost(ret.GetCost());
1938 }
1939 }
1940
1941 return cost;
1942}
1943
1951{
1952 /* if there is flooding, remove platforms tile by tile */
1954 return Command<Commands::RemoveFromRailStation>::Do(DoCommandFlag::Execute, tile, TileIndex{}, false);
1955 }
1956
1957 Station *st = Station::GetByTile(tile);
1959
1961
1962 return cost;
1963}
1964
1972{
1973 /* if there is flooding, remove waypoints tile by tile */
1975 return Command<Commands::RemoveFromRailWaypoint>::Do(DoCommandFlag::Execute, tile, TileIndex{}, false);
1976 }
1977
1979}
1980
1981
1987static RoadStop **FindRoadStopSpot(bool truck_station, Station *st)
1988{
1989 RoadStop **primary_stop = (truck_station) ? &st->truck_stops : &st->bus_stops;
1990
1991 if (*primary_stop == nullptr) {
1992 /* we have no roadstop of the type yet, so write a "primary stop" */
1993 return primary_stop;
1994 } else {
1995 /* there are stops already, so append to the end of the list */
1996 RoadStop *stop = *primary_stop;
1997 while (stop->next != nullptr) stop = stop->next;
1998 return &stop->next;
1999 }
2000}
2001
2002static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index = -1);
2003CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index = -1);
2004
2014static CommandCost FindJoiningRoadStop(StationID existing_stop, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
2015{
2016 return FindJoiningBaseStation<Station, STR_ERROR_MUST_REMOVE_ROAD_STOP_FIRST>(existing_stop, station_to_join, adjacent, ta, st, [](const Station *) -> bool { return true; });
2017}
2018
2033CommandCost CalculateRoadStopCost(TileArea tile_area, DoCommandFlags flags, bool is_drive_through, StationType station_type, const RoadStopSpec *roadstopspec, Axis axis, DiagDirection ddir, StationID *station, RoadType rt, Money unit_cost)
2034{
2035 DiagDirections invalid_dirs = is_drive_through ? AxisToDiagDirs(axis) : ddir;
2036
2037 /* Check every tile in the area. */
2038 int allowed_z = -1;
2040 for (TileIndex cur_tile : tile_area) {
2041 CommandCost ret = CheckFlatLandRoadStop(cur_tile, allowed_z, roadstopspec, flags, invalid_dirs, is_drive_through, station_type, axis, station, rt);
2042 if (ret.Failed()) return ret;
2043
2044 bool is_preexisting_roadstop = IsTileType(cur_tile, TileType::Station) && IsAnyRoadStop(cur_tile);
2045
2046 /* Only add costs if a stop doesn't already exist in the location */
2047 if (!is_preexisting_roadstop) {
2048 cost.AddCost(ret.GetCost());
2049 cost.AddCost(unit_cost);
2050 }
2051 }
2052
2053 return cost;
2054}
2055
2072CommandCost CmdBuildRoadStop(DoCommandFlags flags, TileIndex tile, uint8_t width, uint8_t length, RoadStopType stop_type, bool is_drive_through,
2073 DiagDirection ddir, RoadType rt, RoadStopClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
2074{
2075 if (!ValParamRoadType(rt) || !IsValidDiagDirection(ddir) || stop_type >= RoadStopType::End) return CMD_ERROR;
2076 bool reuse = (station_to_join != NEW_STATION);
2077 if (!reuse) station_to_join = StationID::Invalid();
2078 bool distant_join = (station_to_join != StationID::Invalid());
2079
2080 /* Check if the given station class is valid */
2081 if (spec_class.base() >= RoadStopClass::GetClassCount()) return CMD_ERROR;
2082 const RoadStopClass *cls = RoadStopClass::Get(spec_class);
2083 if (IsWaypointClass(*cls)) return CMD_ERROR;
2084 if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
2085
2086 const RoadStopSpec *roadstopspec = cls->GetSpec(spec_index);
2087 if (roadstopspec != nullptr) {
2088 if (stop_type == RoadStopType::Truck && roadstopspec->stop_type != ROADSTOPTYPE_FREIGHT && roadstopspec->stop_type != ROADSTOPTYPE_ALL) return CMD_ERROR;
2089 if (stop_type == RoadStopType::Bus && roadstopspec->stop_type != ROADSTOPTYPE_PASSENGER && roadstopspec->stop_type != ROADSTOPTYPE_ALL) return CMD_ERROR;
2090 if (!is_drive_through && roadstopspec->flags.Test(RoadStopSpecFlag::DriveThroughOnly)) return CMD_ERROR;
2091 }
2092
2093 /* Check if the requested road stop is too big */
2094 if (width > _settings_game.station.station_spread || length > _settings_game.station.station_spread) return CommandCost(STR_ERROR_STATION_TOO_SPREAD_OUT);
2095 /* Check for incorrect width / length. */
2096 if (width == 0 || length == 0) return CMD_ERROR;
2097 /* Check if the first tile and the last tile are valid */
2098 if (!IsValidTile(tile) || TileAddWrap(tile, width - 1, length - 1) == INVALID_TILE) return CMD_ERROR;
2099
2100 TileArea roadstop_area(tile, width, length);
2101
2102 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2103
2104 /* Trams only have drive through stops */
2105 if (!is_drive_through && RoadTypeIsTram(rt)) return CMD_ERROR;
2106
2107 Axis axis = DiagDirToAxis(ddir);
2108
2110 if (ret.Failed()) return ret;
2111
2112 bool is_truck_stop = stop_type != RoadStopType::Bus;
2113
2114 /* Total road stop cost. */
2115 Money unit_cost;
2116 if (roadstopspec != nullptr) {
2117 unit_cost = roadstopspec->GetBuildCost(is_truck_stop ? Price::BuildStationTruck : Price::BuildStationBus);
2118 } else {
2119 unit_cost = _price[is_truck_stop ? Price::BuildStationTruck : Price::BuildStationBus];
2120 }
2121 StationID est = StationID::Invalid();
2122 CommandCost cost = CalculateRoadStopCost(roadstop_area, flags, is_drive_through, is_truck_stop ? StationType::Truck : StationType::Bus, roadstopspec, axis, ddir, &est, rt, unit_cost);
2123 if (cost.Failed()) return cost;
2124
2125 Station *st = nullptr;
2126 ret = FindJoiningRoadStop(est, station_to_join, adjacent, roadstop_area, &st);
2127 if (ret.Failed()) return ret;
2128
2129 /* Check if this number of road stops can be allocated. */
2130 if (!RoadStop::CanAllocateItem(static_cast<size_t>(roadstop_area.w) * roadstop_area.h)) return CommandCost(is_truck_stop ? STR_ERROR_TOO_MANY_TRUCK_STOPS : STR_ERROR_TOO_MANY_BUS_STOPS);
2131
2132 ret = BuildStationPart(&st, flags, reuse, roadstop_area, StationNaming::Road);
2133 if (ret.Failed()) return ret;
2134
2135 /* Check if we can allocate a custom stationspec to this station */
2136 auto specindex = AllocateSpecToRoadStop(roadstopspec, st);
2137 if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
2138
2139 if (roadstopspec != nullptr) {
2140 /* Perform NewGRF checks */
2141
2142 /* Check if the road stop is buildable */
2143 if (roadstopspec->callback_mask.Test(RoadStopCallbackMask::Avail)) {
2144 uint16_t cb_res = GetRoadStopCallback(CBID_STATION_AVAILABILITY, 0, 0, roadstopspec, nullptr, INVALID_TILE, rt, is_truck_stop ? StationType::Truck : StationType::Bus, 0);
2145 if (cb_res != CALLBACK_FAILED && !Convert8bitBooleanCallback(roadstopspec->grf_prop.grffile, CBID_STATION_AVAILABILITY, cb_res)) return CMD_ERROR;
2146 }
2147 }
2148
2149 if (flags.Test(DoCommandFlag::Execute)) {
2150 if (specindex.has_value()) AssignSpecToRoadStop(roadstopspec, st, *specindex);
2151 /* Check every tile in the area. */
2152 for (TileIndex cur_tile : roadstop_area) {
2153 /* Get existing road types and owners before any tile clearing */
2154 RoadType road_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RoadTramType::Road) : INVALID_ROADTYPE;
2155 RoadType tram_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RoadTramType::Tram) : INVALID_ROADTYPE;
2156 Owner road_owner = road_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RoadTramType::Road) : _current_company;
2157 Owner tram_owner = tram_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RoadTramType::Tram) : _current_company;
2158
2159 if (IsTileType(cur_tile, TileType::Station) && IsStationRoadStop(cur_tile)) {
2160 RemoveRoadStop(cur_tile, flags, *specindex);
2161 }
2162
2163 if (roadstopspec != nullptr) {
2164 /* Include this road stop spec's animation trigger bitmask
2165 * in the station's cached copy. */
2166 st->cached_roadstop_anim_triggers.Set(roadstopspec->animation.triggers);
2167 }
2168
2169 RoadStop *road_stop = RoadStop::Create(cur_tile);
2170 /* Insert into linked list of RoadStops. */
2171 RoadStop **currstop = FindRoadStopSpot(is_truck_stop, st);
2172 *currstop = road_stop;
2173
2174 if (is_truck_stop) {
2175 st->truck_station.Add(cur_tile);
2176 } else {
2177 st->bus_station.Add(cur_tile);
2178 }
2179
2180 /* Initialize an empty station. */
2181 st->AddFacility(is_truck_stop ? StationFacility::TruckStop : StationFacility::BusStop, cur_tile);
2182
2183 st->rect.BeforeAddTile(cur_tile, StationRect::ADD_TRY);
2184
2185 RoadStopType rs_type = is_truck_stop ? RoadStopType::Truck : RoadStopType::Bus;
2186 if (is_drive_through) {
2187 /* Update company infrastructure counts. If the current tile is a normal road tile, remove the old
2188 * bits first. */
2189 if (IsNormalRoadTile(cur_tile)) {
2190 UpdateCompanyRoadInfrastructure(road_rt, road_owner, -static_cast<int>(GetRoadBits(cur_tile, RoadTramType::Road).Count()));
2191 UpdateCompanyRoadInfrastructure(tram_rt, tram_owner, -static_cast<int>(GetRoadBits(cur_tile, RoadTramType::Tram).Count()));
2192 }
2193
2194 if (road_rt == INVALID_ROADTYPE && RoadTypeIsRoad(rt)) road_rt = rt;
2195 if (tram_rt == INVALID_ROADTYPE && RoadTypeIsTram(rt)) tram_rt = rt;
2196
2197 MakeDriveThroughRoadStop(cur_tile, st->owner, road_owner, tram_owner, st->index, (rs_type == RoadStopType::Bus ? StationType::Bus : StationType::Truck), road_rt, tram_rt, axis);
2198 road_stop->MakeDriveThrough();
2199 } else {
2200 if (road_rt == INVALID_ROADTYPE && RoadTypeIsRoad(rt)) road_rt = rt;
2201 if (tram_rt == INVALID_ROADTYPE && RoadTypeIsTram(rt)) tram_rt = rt;
2202 MakeRoadStop(cur_tile, st->owner, st->index, rs_type, road_rt, tram_rt, ddir);
2203 }
2206 Company::Get(st->owner)->infrastructure.station++;
2207
2208 SetCustomRoadStopSpecIndex(cur_tile, *specindex);
2209 if (roadstopspec != nullptr) {
2210 st->SetRoadStopRandomBits(cur_tile, GB(Random(), 0, 8));
2211 TriggerRoadStopAnimation(st, cur_tile, StationAnimationTrigger::Built);
2212 }
2213
2214 MarkTileDirtyByTile(cur_tile);
2215 }
2216
2217 if (st != nullptr) {
2219 }
2220 }
2221 return cost;
2222}
2223
2231static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index)
2232{
2233 Station *st = Station::GetByTile(tile);
2234
2236 CommandCost ret = CheckOwnership(st->owner);
2237 if (ret.Failed()) return ret;
2238 }
2239
2240 bool is_truck = IsTruckStop(tile);
2241
2242 RoadStop **primary_stop;
2243 RoadStop *cur_stop;
2244 if (is_truck) { // truck stop
2245 primary_stop = &st->truck_stops;
2246 cur_stop = RoadStop::GetByTile(tile, RoadStopType::Truck);
2247 } else {
2248 primary_stop = &st->bus_stops;
2249 cur_stop = RoadStop::GetByTile(tile, RoadStopType::Bus);
2250 }
2251
2252 assert(cur_stop != nullptr);
2253
2254 /* don't do the check for drive-through road stops when company bankrupts */
2256 /* remove the 'going through road stop' status from all vehicles on that tile */
2257 if (flags.Test(DoCommandFlag::Execute)) {
2258 for (Vehicle *v : VehiclesOnTile(tile)) {
2259 if (v->type != VehicleType::Road) continue;
2260 /* Okay... we are a road vehicle on a drive through road stop.
2261 * But that road stop has just been removed, so we need to make
2262 * sure we are in a valid state... however, vehicles can also
2263 * turn on road stop tiles, so only clear the 'road stop' state
2264 * bits and only when the state was 'in road stop', otherwise
2265 * we'll end up clearing the turn around bits. */
2268 }
2269 }
2270 } else {
2272 if (ret.Failed()) return ret;
2273 }
2274
2275 const RoadStopSpec *spec = GetRoadStopSpec(tile);
2276
2277 if (flags.Test(DoCommandFlag::Execute)) {
2278 if (*primary_stop == cur_stop) {
2279 /* removed the first stop in the list */
2280 *primary_stop = cur_stop->next;
2281 /* removed the only stop? */
2282 if (*primary_stop == nullptr) {
2284 SetWindowClassesDirty(WindowClass::VehicleOrders);
2285 }
2286 } else {
2287 /* tell the predecessor in the list to skip this stop */
2288 RoadStop *pred = *primary_stop;
2289 while (pred->next != cur_stop) pred = pred->next;
2290 pred->next = cur_stop->next;
2291 }
2292
2293 /* Update company infrastructure counts. */
2294 for (RoadTramType rtt : ROADTRAMTYPES_ALL) {
2295 RoadType rt = GetRoadType(tile, rtt);
2297 }
2298
2299 Company::Get(st->owner)->infrastructure.station--;
2301
2302 uint specindex = GetCustomRoadStopSpecIndex(tile);
2303
2305
2306 if (IsDriveThroughStopTile(tile)) {
2307 /* Clears the tile for us */
2308 cur_stop->ClearDriveThrough();
2309 DeleteAnimatedTile(tile);
2310 } else {
2311 DoClearSquare(tile);
2312 }
2313
2314 delete cur_stop;
2315
2316 /* Make sure no vehicle is going to the old roadstop. Narrow the search to any road vehicles with an order to
2317 * this station, then look for any currently heading to the tile. */
2318 StationID station_id = st->index;
2320 [](const Vehicle *v) { return v->type == VehicleType::Road; },
2321 [station_id](const Order *order) { return order->IsType(OT_GOTO_STATION) && order->GetDestination() == station_id; },
2322 [station_id, tile](Vehicle *v) {
2323 if (v->current_order.IsType(OT_GOTO_STATION) && v->dest_tile == tile) {
2324 v->SetDestTile(v->GetOrderStationLocation(station_id));
2325 }
2326 }
2327 );
2328
2329 st->rect.AfterRemoveTile(st, tile);
2330
2331 if (replacement_spec_index < 0) st->AfterStationTileSetChange(false, is_truck ? StationType::Truck: StationType::Bus);
2332
2333 st->tile_waiting_random_triggers.erase(tile);
2334 st->RemoveRoadStopTileData(tile);
2335 if ((int)specindex != replacement_spec_index) DeallocateSpecFromRoadStop(st, specindex);
2336
2337 /* Update the tile area of the truck/bus stop */
2338 if (is_truck) {
2339 st->truck_station.Clear();
2340 for (const RoadStop *rs = st->truck_stops; rs != nullptr; rs = rs->next) st->truck_station.Add(rs->xy);
2341 } else {
2342 st->bus_station.Clear();
2343 for (const RoadStop *rs = st->bus_stops; rs != nullptr; rs = rs->next) st->bus_station.Add(rs->xy);
2344 }
2345 }
2346
2348 return CommandCost(ExpensesType::Construction, spec != nullptr ? spec->GetClearCost(category) : _price[category]);
2349}
2350
2358CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index)
2359{
2360 Waypoint *wp = Waypoint::GetByTile(tile);
2361
2363 CommandCost ret = CheckOwnership(wp->owner);
2364 if (ret.Failed()) return ret;
2365 }
2366
2367 /* Ignore vehicles when the company goes bankrupt. The road will remain, any vehicles going to the waypoint will be removed. */
2368 if (!flags.Test(DoCommandFlag::Bankrupt)) {
2370 if (ret.Failed()) return ret;
2371 }
2372
2373 const RoadStopSpec *spec = GetRoadStopSpec(tile);
2374
2375 if (flags.Test(DoCommandFlag::Execute)) {
2376 /* Update company infrastructure counts. */
2377 for (RoadTramType rtt : ROADTRAMTYPES_ALL) {
2378 RoadType rt = GetRoadType(tile, rtt);
2380 }
2381
2382 Company::Get(wp->owner)->infrastructure.station--;
2384
2385 uint specindex = GetCustomRoadStopSpecIndex(tile);
2386
2388
2389 DoClearSquare(tile);
2390
2391 wp->rect.AfterRemoveTile(wp, tile);
2392
2393 wp->tile_waiting_random_triggers.erase(tile);
2394 wp->RemoveRoadStopTileData(tile);
2395 if ((int)specindex != replacement_spec_index) DeallocateSpecFromRoadStop(wp, specindex);
2396
2397 if (replacement_spec_index < 0) {
2398 MakeRoadWaypointStationAreaSmaller(wp, wp->road_waypoint_area);
2399
2400 UpdateStationSignCoord(wp);
2401
2402 /* if we deleted the whole waypoint, delete the road facility. */
2405 SetWindowWidgetDirty(WindowClass::StationView, wp->index, WID_SV_ROADVEHS);
2406 wp->UpdateVirtCoord();
2408 }
2409 }
2410 }
2411
2413}
2414
2423static CommandCost RemoveGenericRoadStop(DoCommandFlags flags, const TileArea &roadstop_area, bool road_waypoint, bool remove_road)
2424{
2426 CommandCost last_error(STR_ERROR_THERE_IS_NO_STATION);
2427 bool had_success = false;
2428
2429 for (TileIndex cur_tile : roadstop_area) {
2430 /* Make sure the specified tile is a road stop of the correct type */
2431 if (!IsTileType(cur_tile, TileType::Station) || !IsAnyRoadStop(cur_tile) || IsRoadWaypoint(cur_tile) != road_waypoint) continue;
2432
2433 /* Save information on to-be-restored roads before the stop is removed. */
2434 RoadBits road_bits{};
2437 if (IsDriveThroughStopTile(cur_tile)) {
2438 for (RoadTramType rtt : ROADTRAMTYPES_ALL) {
2439 road_type[rtt] = GetRoadType(cur_tile, rtt);
2440 if (road_type[rtt] == INVALID_ROADTYPE) continue;
2441 road_owner[rtt] = GetRoadOwner(cur_tile, rtt);
2442 /* If we don't want to preserve our roads then restore only roads of others. */
2443 if (remove_road && road_owner[rtt] == _current_company) road_type[rtt] = INVALID_ROADTYPE;
2444 }
2445 road_bits = AxisToRoadBits(GetDriveThroughStopAxis(cur_tile));
2446 }
2447
2448 CommandCost ret;
2449 if (road_waypoint) {
2450 ret = RemoveRoadWaypointStop(cur_tile, flags);
2451 } else {
2452 ret = RemoveRoadStop(cur_tile, flags);
2453 }
2454 if (ret.Failed()) {
2455 last_error = std::move(ret);
2456 continue;
2457 }
2458 cost.AddCost(ret.GetCost());
2459 had_success = true;
2460
2461 /* Restore roads. */
2463 MakeRoadNormal(cur_tile, road_bits, road_type[RoadTramType::Road], road_type[RoadTramType::Tram], ClosestTownFromTile(cur_tile, UINT_MAX)->index,
2464 road_owner[RoadTramType::Road], road_owner[RoadTramType::Tram]);
2465
2466 /* Update company infrastructure counts. */
2467 int count = road_bits.Count();
2470 }
2471 }
2472
2473 return had_success ? cost : last_error;
2474}
2475
2486CommandCost CmdRemoveRoadStop(DoCommandFlags flags, TileIndex tile, uint8_t width, uint8_t height, RoadStopType stop_type, bool remove_road)
2487{
2488 if (stop_type >= RoadStopType::End) return CMD_ERROR;
2489 /* Check for incorrect width / height. */
2490 if (width == 0 || height == 0) return CMD_ERROR;
2491 /* Check if the first tile and the last tile are valid */
2492 if (!IsValidTile(tile) || TileAddWrap(tile, width - 1, height - 1) == INVALID_TILE) return CMD_ERROR;
2493 /* Bankrupting company is not supposed to remove roads, there may be road vehicles. */
2494 if (remove_road && flags.Test(DoCommandFlag::Bankrupt)) return CMD_ERROR;
2495
2496 TileArea roadstop_area(tile, width, height);
2497
2498 return RemoveGenericRoadStop(flags, roadstop_area, false, remove_road);
2499}
2500
2509{
2510 if (end == 0) end = start;
2511 if (start >= Map::Size() || end >= Map::Size()) return CMD_ERROR;
2512
2513 TileArea roadstop_area(start, end);
2514
2515 return RemoveGenericRoadStop(flags, roadstop_area, true, false);
2516}
2517
2526uint8_t GetAirportNoiseLevelForDistance(const AirportSpec *as, uint distance)
2527{
2528 /* 0 cannot be accounted, and 1 is the lowest that can be reduced from town.
2529 * So no need to go any further*/
2530 if (as->noise_level < 2) return as->noise_level;
2531
2532 /* The steps for measuring noise reduction are based on the "magical" (and arbitrary) 8 base distance
2533 * adding the town_council_tolerance 4 times, as a way to graduate, depending of the tolerance.
2534 * Basically, it says that the less tolerant a town is, the bigger the distance before
2535 * an actual decrease can be granted */
2536 uint8_t town_tolerance_distance = 8 + (_settings_game.difficulty.town_council_tolerance * 4);
2537
2538 /* now, we want to have the distance segmented using the distance judged bareable by town
2539 * This will give us the coefficient of reduction the distance provides. */
2540 uint noise_reduction = distance / town_tolerance_distance;
2541
2542 /* If the noise reduction equals the airport noise itself, don't give it for free.
2543 * Otherwise, simply reduce the airport's level. */
2544 return noise_reduction >= as->noise_level ? 1 : as->noise_level - noise_reduction;
2545}
2546
2557Town *AirportGetNearestTown(const AirportSpec *as, Direction rotation, TileIndex tile, TileIterator &&it, uint &mindist)
2558{
2559 assert(Town::GetNumItems() > 0);
2560
2561 Town *nearest = nullptr;
2562
2563 auto width = as->size_x;
2564 auto height = as->size_y;
2565 if (rotation == Direction::E || rotation == Direction::W) std::swap(width, height);
2566
2567 uint perimeter_min_x = TileX(tile);
2568 uint perimeter_min_y = TileY(tile);
2569 uint perimeter_max_x = perimeter_min_x + width - 1;
2570 uint perimeter_max_y = perimeter_min_y + height - 1;
2571
2572 mindist = UINT_MAX - 1; // prevent overflow
2573
2574 for (TileIndex cur_tile = *it; cur_tile != INVALID_TILE; cur_tile = ++it) {
2575 assert(IsInsideBS(TileX(cur_tile), perimeter_min_x, width));
2576 assert(IsInsideBS(TileY(cur_tile), perimeter_min_y, height));
2577 if (TileX(cur_tile) == perimeter_min_x || TileX(cur_tile) == perimeter_max_x || TileY(cur_tile) == perimeter_min_y || TileY(cur_tile) == perimeter_max_y) {
2578 Town *t = CalcClosestTownFromTile(cur_tile, mindist + 1);
2579 if (t == nullptr) continue;
2580
2581 uint dist = DistanceManhattan(t->xy, cur_tile);
2582 if (dist == mindist && t->index < nearest->index) nearest = t;
2583 if (dist < mindist) {
2584 nearest = t;
2585 mindist = dist;
2586 }
2587 }
2588 }
2589
2590 return nearest;
2591}
2592
2600static Town *AirportGetNearestTown(const Station *st, uint &mindist)
2601{
2603}
2604
2605
2608{
2609 for (Town *t : Town::Iterate()) t->noise_reached = 0;
2610
2611 for (const Station *st : Station::Iterate()) {
2612 if (st->airport.tile != INVALID_TILE && st->airport.type != AT_OILRIG) {
2613 uint dist;
2614 Town *nearest = AirportGetNearestTown(st, dist);
2615 nearest->noise_reached += GetAirportNoiseLevelForDistance(st->airport.GetSpec(), dist);
2616 }
2617 }
2618}
2619
2630CommandCost CmdBuildAirport(DoCommandFlags flags, TileIndex tile, uint8_t airport_type, uint8_t layout, StationID station_to_join, bool allow_adjacent)
2631{
2632 bool reuse = (station_to_join != NEW_STATION);
2633 if (!reuse) station_to_join = StationID::Invalid();
2634 bool distant_join = (station_to_join != StationID::Invalid());
2635
2636 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2637
2638 if (airport_type >= NUM_AIRPORTS) return CMD_ERROR;
2639
2641 if (ret.Failed()) return ret;
2642
2643 /* Check if a valid, buildable airport was chosen for construction */
2644 const AirportSpec *as = AirportSpec::Get(airport_type);
2645 if (!as->IsAvailable() || layout >= as->layouts.size()) return CMD_ERROR;
2646 if (!as->IsWithinMapBounds(layout, tile)) return CMD_ERROR;
2647
2648 Direction rotation = as->layouts[layout].rotation;
2649 int w = as->size_x;
2650 int h = as->size_y;
2651 if (rotation == Direction::E || rotation == Direction::W) std::swap(w, h);
2652 TileArea airport_area = TileArea(tile, w, h);
2653
2654 if (w > _settings_game.station.station_spread || h > _settings_game.station.station_spread) {
2655 return CommandCost(STR_ERROR_STATION_TOO_SPREAD_OUT);
2656 }
2657
2658 AirportTileTableIterator tile_iter(as->layouts[layout].tiles, tile);
2659 CommandCost cost = CheckFlatLandAirport(tile_iter, flags);
2660 if (cost.Failed()) return cost;
2661
2662 /* The noise level is the noise from the airport and reduce it to account for the distance to the town center. */
2663 uint dist;
2664 Town *nearest = AirportGetNearestTown(as, rotation, tile, std::move(tile_iter), dist);
2665 uint newnoise_level = GetAirportNoiseLevelForDistance(as, dist);
2666
2667 /* Check if local auth would allow a new airport */
2668 StringID authority_refuse_message = STR_NULL;
2669 Town *authority_refuse_town = nullptr;
2670
2671 if (_settings_game.economy.station_noise_level) {
2672 /* do not allow to build a new airport if this raise the town noise over the maximum allowed by town */
2673 if ((nearest->noise_reached + newnoise_level) > nearest->MaxTownNoise()) {
2674 authority_refuse_message = STR_ERROR_LOCAL_AUTHORITY_REFUSES_NOISE;
2675 authority_refuse_town = nearest;
2676 }
2677 } else if (_settings_game.difficulty.town_council_tolerance != TOWN_COUNCIL_PERMISSIVE) {
2678 Town *t = ClosestTownFromTile(tile, UINT_MAX);
2679 uint num = 0;
2680 for (const Station *st : Station::Iterate()) {
2681 if (st->town == t && st->facilities.Test(StationFacility::Airport) && st->airport.type != AT_OILRIG) num++;
2682 }
2683 if (num >= 2) {
2684 authority_refuse_message = STR_ERROR_LOCAL_AUTHORITY_REFUSES_AIRPORT;
2685 authority_refuse_town = t;
2686 }
2687 }
2688
2689 if (authority_refuse_message != STR_NULL) {
2690 return CommandCostWithParam(authority_refuse_message, authority_refuse_town->index);
2691 }
2692
2693 Station *st = nullptr;
2694 ret = FindJoiningStation(StationID::Invalid(), station_to_join, allow_adjacent, airport_area, &st);
2695 if (ret.Failed()) return ret;
2696
2697 /* Distant join */
2698 if (st == nullptr && distant_join) st = Station::GetIfValid(station_to_join);
2699
2700 ret = BuildStationPart(&st, flags, reuse, airport_area, GetAirport(airport_type)->flags.Test(AirportFTAClass::Flag::Airplanes) ? StationNaming::Airport : StationNaming::Heliport);
2701 if (ret.Failed()) return ret;
2702
2703 if (st != nullptr && st->airport.tile != INVALID_TILE) {
2704 return CommandCost(STR_ERROR_TOO_CLOSE_TO_ANOTHER_AIRPORT);
2705 }
2706
2707 for (AirportTileTableIterator iter(as->layouts[layout].tiles, tile); iter != INVALID_TILE; ++iter) {
2709 }
2710
2711 if (flags.Test(DoCommandFlag::Execute)) {
2712 /* Always add the noise, so there will be no need to recalculate when option toggles */
2713 nearest->noise_reached += newnoise_level;
2714
2716 st->airport.type = airport_type;
2717 st->airport.layout = layout;
2718 st->airport.blocks = {};
2719 st->airport.rotation = rotation;
2720
2721 st->rect.BeforeAddRect(tile, w, h, StationRect::ADD_TRY);
2722
2723 for (AirportTileTableIterator iter(as->layouts[layout].tiles, tile); iter != INVALID_TILE; ++iter) {
2724 Tile t(iter);
2725 MakeAirport(t, st->owner, st->index, iter.GetStationGfx(), WaterClass::Invalid);
2726 SetStationTileRandomBits(t, GB(Random(), 0, 4));
2727 st->airport.Add(iter);
2728
2729 if (AirportTileSpec::Get(GetTranslatedAirportTileID(iter.GetStationGfx()))->animation.status != AnimationStatus::NoAnimation) AddAnimatedTile(t);
2730 }
2731
2732 /* Only call the animation trigger after all tiles have been built */
2733 for (AirportTileTableIterator iter(as->layouts[layout].tiles, tile); iter != INVALID_TILE; ++iter) {
2734 TriggerAirportTileAnimation(st, iter, AirportAnimationTrigger::Built);
2735 }
2736
2738
2739 Company::Get(st->owner)->infrastructure.airport++;
2740
2742 InvalidateWindowData(WindowClass::StationView, st->index, -1);
2743
2744 if (_settings_game.economy.station_noise_level) {
2745 SetWindowDirty(WindowClass::TownView, nearest->index);
2746 }
2747 }
2748
2749 return cost;
2750}
2751
2759{
2760 Station *st = Station::GetByTile(tile);
2761
2763 CommandCost ret = CheckOwnership(st->owner);
2764 if (ret.Failed()) return ret;
2765 }
2766
2767 tile = st->airport.tile;
2768
2770
2771 for (const Aircraft *a : Aircraft::Iterate()) {
2772 if (!a->IsNormalAircraft()) continue;
2773 if (a->targetairport == st->index && a->state != FLYING) {
2774 return CommandCost(STR_ERROR_AIRCRAFT_IN_THE_WAY);
2775 }
2776 }
2777
2778 if (flags.Test(DoCommandFlag::Execute)) {
2779 for (uint i = 0; i < st->airport.GetNumHangars(); ++i) {
2780 TileIndex tile_cur = st->airport.GetHangarTile(i);
2781 OrderBackup::Reset(tile_cur, false);
2782 CloseWindowById(WindowClass::VehicleDepot, tile_cur);
2783 }
2784
2785 /* The noise level is the noise from the airport and reduce it to account for the distance to the town center.
2786 * And as for construction, always remove it, even if the setting is not set, in order to avoid the
2787 * need of recalculation */
2788 uint dist;
2789 Town *nearest = AirportGetNearestTown(st, dist);
2791
2792 if (_settings_game.economy.station_noise_level) {
2793 SetWindowDirty(WindowClass::TownView, nearest->index);
2794 }
2795 }
2796
2797 for (TileIndex tile_cur : st->airport) {
2798 if (!st->TileBelongsToAirport(tile_cur)) continue;
2799
2800 CommandCost ret = EnsureNoVehicleOnGround(tile_cur);
2801 if (ret.Failed()) return ret;
2802
2804
2805 if (flags.Test(DoCommandFlag::Execute)) {
2806 DoClearSquare(tile_cur);
2808 }
2809 }
2810
2811 if (flags.Test(DoCommandFlag::Execute)) {
2812 /* Clear the persistent storage. */
2813 delete st->airport.psa;
2814
2815 st->rect.AfterRemoveRect(st, st->airport);
2816
2817 st->airport.Clear();
2819 SetWindowClassesDirty(WindowClass::VehicleOrders);
2820
2821 InvalidateWindowData(WindowClass::StationView, st->index, -1);
2822
2823 Company::Get(st->owner)->infrastructure.airport--;
2824
2826
2828 }
2829
2830 return cost;
2831}
2832
2840{
2841 if (!Station::IsValidID(station_id)) return CMD_ERROR;
2842 Station *st = Station::Get(station_id);
2843
2845
2846 CommandCost ret = CheckOwnership(st->owner);
2847 if (ret.Failed()) return ret;
2848
2849 if (flags.Test(DoCommandFlag::Execute)) {
2851 SetWindowWidgetDirty(WindowClass::StationView, st->index, WID_SV_CLOSE_AIRPORT);
2852 }
2853 return CommandCost();
2854}
2855
2863bool HasStationInUse(StationID station, bool include_company, CompanyID company)
2864{
2865 for (const OrderList *orderlist : OrderList::Iterate()) {
2866 const Vehicle *v = orderlist->GetFirstSharedVehicle();
2867 assert(v != nullptr);
2868 if ((v->owner == company) != include_company) continue;
2869
2870 for (const Order &order : orderlist->GetOrders()) {
2871 if (order.GetDestination() == station && (order.IsType(OT_GOTO_STATION) || order.IsType(OT_GOTO_WAYPOINT))) {
2872 return true;
2873 }
2874 }
2875 }
2876 return false;
2877}
2878
2881 {-1, 0},
2882 { 0, 0},
2883 { 0, 0},
2884 { 0, -1}
2885}}};
2886
2890
2899CommandCost CmdBuildDock(DoCommandFlags flags, TileIndex tile, StationID station_to_join, bool adjacent)
2900{
2901 bool reuse = (station_to_join != NEW_STATION);
2902 if (!reuse) station_to_join = StationID::Invalid();
2903 bool distant_join = (station_to_join != StationID::Invalid());
2904
2905 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2906
2908 if (direction == DiagDirection::Invalid) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
2909 direction = ReverseDiagDir(direction);
2910
2911 /* Docks cannot be placed on rapids */
2912 if (HasTileWaterGround(tile)) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
2913
2915 if (ret.Failed()) return ret;
2916
2917 ret = IsDockBridgeAboveOk(tile, to_underlying(direction));
2918 if (ret.Failed()) return ret;
2919
2921 ret = Command<Commands::LandscapeClear>::Do(flags, tile);
2922 if (ret.Failed()) return ret;
2923 cost.AddCost(ret.GetCost());
2924
2925 TileIndex tile_cur = tile + TileOffsByDiagDir(direction);
2926
2927 if (!HasTileWaterGround(tile_cur) || !IsTileFlat(tile_cur)) {
2928 return CommandCost(STR_ERROR_SITE_UNSUITABLE);
2929 }
2930
2932 if (ret.Failed()) return ret;
2933
2934 /* Get the water class of the water tile before it is cleared.*/
2935 WaterClass wc = GetWaterClass(tile_cur);
2936
2937 bool add_cost = !IsWaterTile(tile_cur);
2938 ret = Command<Commands::LandscapeClear>::Do(flags, tile_cur);
2939 if (ret.Failed()) return ret;
2940 if (add_cost) cost.AddCost(ret.GetCost());
2941
2942 tile_cur += TileOffsByDiagDir(direction);
2943 if (!IsTileType(tile_cur, TileType::Water) || !IsTileFlat(tile_cur)) {
2944 return CommandCost(STR_ERROR_SITE_UNSUITABLE);
2945 }
2946
2947 TileArea dock_area = TileArea(tile + ToTileIndexDiff(_dock_tileoffs_chkaround[direction]),
2948 _dock_w_chk[direction], _dock_h_chk[direction]);
2949
2950 /* middle */
2951 Station *st = nullptr;
2952 ret = FindJoiningStation(StationID::Invalid(), station_to_join, adjacent, dock_area, &st);
2953 if (ret.Failed()) return ret;
2954
2955 /* Distant join */
2956 if (st == nullptr && distant_join) st = Station::GetIfValid(station_to_join);
2957
2958 ret = BuildStationPart(&st, flags, reuse, dock_area, StationNaming::Dock);
2959 if (ret.Failed()) return ret;
2960
2961 if (flags.Test(DoCommandFlag::Execute)) {
2962 st->ship_station.Add(tile);
2963 TileIndex flat_tile = tile + TileOffsByDiagDir(direction);
2964 st->ship_station.Add(flat_tile);
2966
2967 st->rect.BeforeAddRect(dock_area.tile, dock_area.w, dock_area.h, StationRect::ADD_TRY);
2968
2969 /* If the water part of the dock is on a canal, update infrastructure counts.
2970 * This is needed as we've cleared that tile before.
2971 * Clearing object tiles may result in water tiles which are already accounted for in the water infrastructure total.
2972 * See: MakeWaterKeepingClass() */
2973 if (wc == WaterClass::Canal && !(HasTileWaterClass(flat_tile) && GetWaterClass(flat_tile) == WaterClass::Canal && IsTileOwner(flat_tile, _current_company))) {
2974 Company::Get(st->owner)->infrastructure.water++;
2975 }
2976 Company::Get(st->owner)->infrastructure.station += 2;
2977
2978 MakeDock(tile, st->owner, st->index, direction, wc);
2979 UpdateStationDockingTiles(st);
2980
2982 }
2983
2984 return cost;
2985}
2986
2987void RemoveDockingTile(TileIndex t)
2988{
2989 for (DiagDirection d : EnumRange(DiagDirection::End)) {
2990 TileIndex tile = t + TileOffsByDiagDir(d);
2991 if (!IsValidTile(tile)) continue;
2992
2993 if (IsTileType(tile, TileType::Station)) {
2994 Station *st = Station::GetByTile(tile);
2995 if (st != nullptr) UpdateStationDockingTiles(st);
2996 } else if (IsTileType(tile, TileType::Industry)) {
2998 if (neutral != nullptr) UpdateStationDockingTiles(neutral);
2999 }
3000 }
3001}
3002
3009{
3010 assert(IsValidTile(tile));
3011
3012 /* Clear and maybe re-set docking tile */
3014 TileIndex docking_tile = tile + TileOffsByDiagDir(d);
3015 if (!IsValidTile(docking_tile)) continue;
3016
3017 if (IsPossibleDockingTile(docking_tile)) {
3018 SetDockingTile(docking_tile, false);
3019 CheckForDockingTile(docking_tile);
3020 }
3021 }
3022}
3023
3030{
3031 assert(IsDockTile(t));
3032
3033 StationGfx gfx = GetStationGfx(t);
3034 if (gfx < GFX_DOCK_BASE_WATER_PART) return t;
3035
3037 TileIndex tile = t + TileOffsByDiagDir(d);
3038 if (!IsValidTile(tile)) continue;
3039 if (!IsDockTile(tile)) continue;
3040 if (GetStationGfx(tile) < GFX_DOCK_BASE_WATER_PART && tile + TileOffsByDiagDir(GetDockDirection(tile)) == t) return tile;
3041 }
3042
3043 return INVALID_TILE;
3044}
3045
3053{
3054 Station *st = Station::GetByTile(tile);
3055 CommandCost ret = CheckOwnership(st->owner);
3056 if (ret.Failed()) return ret;
3057
3058 if (!IsDockTile(tile)) return CMD_ERROR;
3059
3060 TileIndex tile1 = FindDockLandPart(tile);
3061 if (tile1 == INVALID_TILE) return CMD_ERROR;
3062 TileIndex tile2 = tile1 + TileOffsByDiagDir(GetDockDirection(tile1));
3063
3064 ret = EnsureNoVehicleOnGround(tile1);
3065 if (ret.Succeeded()) ret = EnsureNoVehicleOnGround(tile2);
3066 if (ret.Failed()) return ret;
3067
3068 if (flags.Test(DoCommandFlag::Execute)) {
3069 DoClearSquare(tile1);
3070 MarkTileDirtyByTile(tile1);
3071 MakeWaterKeepingClass(tile2, st->owner);
3072
3073 st->rect.AfterRemoveTile(st, tile1);
3074 st->rect.AfterRemoveTile(st, tile2);
3075
3076 MakeShipStationAreaSmaller(st);
3077 if (st->ship_station.tile == INVALID_TILE) {
3078 st->ship_station.Clear();
3079 st->docking_station.Clear();
3081 SetWindowClassesDirty(WindowClass::VehicleOrders);
3082 }
3083
3084 Company::Get(st->owner)->infrastructure.station -= 2;
3085
3087
3090
3091 for (Ship *s : Ship::Iterate()) {
3092 /* Find all ships going to our dock. */
3093 if (s->current_order.GetDestination() != st->index) {
3094 continue;
3095 }
3096
3097 /* Find ships that are marked as "loading" but are no longer on a
3098 * docking tile. Force them to leave the station (as they were loading
3099 * on the removed dock). */
3100 if (s->current_order.IsType(OT_LOADING) && !(IsDockingTile(s->tile) && IsShipDestinationTile(s->tile, st->index))) {
3101 s->LeaveStation();
3102 }
3103
3104 /* If we no longer have a dock, mark the order as invalid and send
3105 * the ship to the next order (or, if there is none, make it
3106 * wander the world). */
3107 if (s->current_order.IsType(OT_GOTO_STATION) && !st->facilities.Test(StationFacility::Dock)) {
3108 s->SetDestTile(s->GetOrderStationLocation(st->index));
3109 }
3110 }
3111 }
3112
3114}
3115
3123{
3124 const auto &layouts = _station_display_datas[st];
3125 if (gfx >= layouts.size()) gfx &= 1;
3126 return layouts.data() + gfx;
3127}
3128
3138bool SplitGroundSpriteForOverlay(const TileInfo *ti, SpriteID *ground, RailTrackOffset *overlay_offset)
3139{
3140 bool snow_desert;
3141 switch (*ground) {
3142 case SPR_RAIL_TRACK_X:
3143 case SPR_MONO_TRACK_X:
3144 case SPR_MGLV_TRACK_X:
3145 snow_desert = false;
3146 *overlay_offset = RTO_X;
3147 break;
3148
3149 case SPR_RAIL_TRACK_Y:
3150 case SPR_MONO_TRACK_Y:
3151 case SPR_MGLV_TRACK_Y:
3152 snow_desert = false;
3153 *overlay_offset = RTO_Y;
3154 break;
3155
3159 snow_desert = true;
3160 *overlay_offset = RTO_X;
3161 break;
3162
3166 snow_desert = true;
3167 *overlay_offset = RTO_Y;
3168 break;
3169
3170 default:
3171 return false;
3172 }
3173
3174 if (ti != nullptr) {
3175 /* Decide snow/desert from tile */
3176 switch (_settings_game.game_creation.landscape) {
3178 snow_desert = (uint)ti->z > GetSnowLine() * TILE_HEIGHT;
3179 break;
3180
3182 snow_desert = GetTropicZone(ti->tile) == TropicZone::Desert;
3183 break;
3184
3185 default:
3186 break;
3187 }
3188 }
3189
3190 *ground = snow_desert ? SPR_FLAT_SNOW_DESERT_TILE : SPR_FLAT_GRASS_TILE;
3191 return true;
3192}
3193
3200static BridgePillarFlags GetStationBlockedPillars(std::span<const BridgeableTileInfo> bridgeable_info, uint8_t layout)
3201{
3202 if (layout < std::size(bridgeable_info)) return bridgeable_info[layout].disallowed_pillars;
3203 return BRIDGEPILLARFLAGS_ALL;
3204}
3205
3215{
3216 if (statspec == nullptr || !statspec->flags.Test(StationSpecFlag::CustomFoundations)) return false;
3217
3218 /* Station has custom foundations.
3219 * Check whether the foundation continues beyond the tile's upper sides. */
3220 uint edge_info = 0;
3221 auto [slope, z] = GetFoundationPixelSlope(ti->tile);
3222 if (!HasFoundationNW(ti->tile, slope, z)) SetBit(edge_info, 0);
3223 if (!HasFoundationNE(ti->tile, slope, z)) SetBit(edge_info, 1);
3224
3225 SpriteID image = GetCustomStationFoundationRelocation(statspec, st, ti->tile, gfx, edge_info);
3226 if (image == 0) return false;
3227
3229 /* Station provides extended foundations. */
3230 static constexpr uint8_t foundation_parts[] = {
3231 UINT8_MAX, UINT8_MAX, UINT8_MAX, 0, // Invalid, Invalid, Invalid, SLOPE_SW
3232 UINT8_MAX, 1, 2, 3, // Invalid, SLOPE_EW, SLOPE_SE, SLOPE_WSE
3233 UINT8_MAX, 4, 5, 6, // Invalid, SLOPE_NW, SLOPE_NS, SLOPE_NWS
3234 7, 8, 9, // SLOPE_NE, SLOPE_ENW, SLOPE_SEN
3235 };
3236 assert(ti->tileh < std::size(foundation_parts));
3237 if (foundation_parts[ti->tileh] == UINT8_MAX) return false;
3238
3239 AddSortableSpriteToDraw(image + foundation_parts[ti->tileh], PAL_NONE, *ti, {{}, {TILE_SIZE, TILE_SIZE, TILE_HEIGHT - 1}, {}});
3240 } else {
3241 /* Draw simple foundations, built up from 8 possible foundation sprites.
3242 * Each set bit represents one of the eight composite sprites to be drawn.
3243 * 'Invalid' entries will not drawn but are included for completeness. */
3244 static constexpr uint8_t composite_foundation_parts[] = {
3245 0b0000'0000, 0b1101'0001, 0b1110'0100, 0b1110'0000, // Invalid, Invalid, Invalid, SLOPE_SW
3246 0b1100'1010, 0b1100'1001, 0b1100'0100, 0b1100'0000, // Invalid, SLOPE_EW, SLOPE_SE, SLOPE_WSE
3247 0b1101'0010, 0b1001'0001, 0b1110'0100, 0b1010'0000, // Invalid, SLOPE_NW, SLOPE_NS, SLOPE_NWS
3248 0b0100'1010, 0b0000'1001, 0b0100'0100, // SLOPE_NE, SLOPE_ENW, SLOPE_SEN
3249 };
3250 assert(ti->tileh < std::size(composite_foundation_parts));
3251
3252 uint8_t parts = composite_foundation_parts[ti->tileh];
3253
3254 /* If foundations continue beyond the tile's upper sides then mask out the last two pieces. */
3255 if (HasBit(edge_info, 0)) ClrBit(parts, 6);
3256 if (HasBit(edge_info, 1)) ClrBit(parts, 7);
3257
3258 /* We always have to draw at least one sprite, so if we have no parts to draw fall back to default foundation. */
3259 if (parts == 0) return false;
3260
3262 for (uint i : SetBitIterator(parts)) {
3263 AddSortableSpriteToDraw(image + i, PAL_NONE, *ti, {{}, {TILE_SIZE, TILE_SIZE, TILE_HEIGHT - 1}, {}});
3264 }
3266 }
3267
3268 OffsetGroundSprite(0, -static_cast<int>(TILE_HEIGHT));
3270
3271 return true;
3272}
3273
3276{
3277 const NewGRFSpriteLayout *layout = nullptr;
3278 SpriteLayoutProcessor processor; // owns heap, borrowed by tmp_layout and t
3279 DrawTileSpriteSpan tmp_layout;
3280 const DrawTileSprites *t = nullptr;
3281 int32_t total_offset;
3282 const RailTypeInfo *rti = nullptr;
3283 uint32_t relocation = 0;
3284 uint32_t ground_relocation = 0;
3285 BaseStation *st = nullptr;
3286 const StationSpec *statspec = nullptr;
3287 uint tile_layout = 0;
3288 auto bridgeable_info = GetStationBridgeableTileInfo(GetStationType(ti->tile));
3289
3290 if (HasStationRail(ti->tile)) {
3291 rti = GetRailTypeInfo(GetRailType(ti->tile));
3292 total_offset = rti->GetRailtypeSpriteOffset();
3293
3294 if (IsCustomStationSpecIndex(ti->tile)) {
3295 /* look for customization */
3296 st = BaseStation::GetByTile(ti->tile);
3297 statspec = st->speclist[GetCustomStationSpecIndex(ti->tile)].spec;
3298
3299 if (statspec != nullptr) {
3300 tile_layout = GetStationGfx(ti->tile);
3301
3303 uint16_t callback = GetStationCallback(CBID_STATION_DRAW_TILE_LAYOUT, 0, 0, statspec, st, ti->tile);
3304 if (callback != CALLBACK_FAILED) tile_layout = (callback & ~1) + to_underlying(GetRailStationAxis(ti->tile));
3305 }
3306
3307 /* Ensure the chosen tile layout is valid for this custom station */
3308 if (!statspec->renderdata.empty()) {
3309 layout = &statspec->renderdata[tile_layout < statspec->renderdata.size() ? tile_layout : (uint)GetRailStationAxis(ti->tile)];
3310 if (!layout->NeedsPreprocessing()) {
3311 t = layout;
3312 layout = nullptr;
3313 }
3314 }
3315 }
3316 }
3317 if (statspec != nullptr) bridgeable_info = statspec->bridgeable_info;
3318 } else {
3319 total_offset = 0;
3320 }
3321
3322 StationGfx gfx = GetStationGfx(ti->tile);
3323 if (IsAirport(ti->tile)) {
3324 gfx = GetAirportGfx(ti->tile);
3325 if (gfx >= NEW_AIRPORTTILE_OFFSET) {
3326 const AirportTileSpec *ats = AirportTileSpec::Get(gfx);
3327 if (ats->grf_prop.HasSpriteGroups() && DrawNewAirportTile(ti, Station::GetByTile(ti->tile), ats)) {
3328 return;
3329 }
3330 /* No sprite group (or no valid one) found, meaning no graphics associated.
3331 * Use the substitute one instead */
3332 assert(ats->grf_prop.subst_id != INVALID_AIRPORTTILE);
3333 gfx = ats->grf_prop.subst_id;
3334 }
3335 switch (gfx) {
3336 case APT_RADAR_GRASS_FENCE_SW:
3337 t = &_station_display_datas_airport_radar_grass_fence_sw[GetAnimationFrame(ti->tile)];
3338 break;
3339 case APT_GRASS_FENCE_NE_FLAG:
3340 t = &_station_display_datas_airport_flag_grass_fence_ne[GetAnimationFrame(ti->tile)];
3341 break;
3342 case APT_RADAR_FENCE_SW:
3343 t = &_station_display_datas_airport_radar_fence_sw[GetAnimationFrame(ti->tile)];
3344 break;
3345 case APT_RADAR_FENCE_NE:
3346 t = &_station_display_datas_airport_radar_fence_ne[GetAnimationFrame(ti->tile)];
3347 break;
3348 case APT_GRASS_FENCE_NE_FLAG_2:
3349 t = &_station_display_datas_airport_flag_grass_fence_ne_2[GetAnimationFrame(ti->tile)];
3350 break;
3351 }
3352 }
3353
3354 Owner owner = GetTileOwner(ti->tile);
3355
3356 PaletteID palette;
3357 if (Company::IsValidID(owner)) {
3358 palette = GetCompanyPalette(owner);
3359 } else {
3360 /* Some stations are not owner by a company, namely oil rigs */
3361 palette = PALETTE_TO_GREY;
3362 }
3363
3364 if (layout == nullptr && t == nullptr) t = GetStationTileLayout(GetStationType(ti->tile), gfx);
3365
3366 /* don't show foundation for docks */
3367 if (ti->tileh != SLOPE_FLAT && !IsDock(ti->tile)) {
3368 if (!DrawCustomStationFoundations(statspec, st, ti, tile_layout)) {
3370 }
3371 }
3372
3373 bool draw_ground = false;
3374
3375 if (IsBuoy(ti->tile)) {
3376 DrawWaterClassGround(ti);
3378 if (sprite != 0) total_offset = sprite - SPR_IMG_BUOY;
3379 } else if (IsDock(ti->tile) || (IsOilRig(ti->tile) && IsTileOnWater(ti->tile))) {
3380 if (ti->tileh == SLOPE_FLAT) {
3381 DrawWaterClassGround(ti);
3382 } else {
3383 assert(IsDock(ti->tile));
3384 TileIndex water_tile = ti->tile + TileOffsByDiagDir(GetDockDirection(ti->tile));
3385 WaterClass wc = HasTileWaterClass(water_tile) ? GetWaterClass(water_tile) : WaterClass::Invalid;
3386 if (wc == WaterClass::Sea) {
3387 DrawShoreTile(ti->tileh);
3388 } else {
3389 DrawClearLandTile(ti, 3);
3390 }
3391 }
3392 } else if (IsRoadWaypointTile(ti->tile)) {
3394 RoadType road_rt = GetRoadTypeRoad(ti->tile);
3395 RoadType tram_rt = GetRoadTypeTram(ti->tile);
3396 RoadBits road = (road_rt != INVALID_ROADTYPE) ? bits : RoadBits{};
3397 RoadBits tram = (tram_rt != INVALID_ROADTYPE) ? bits : RoadBits{};
3398 const RoadTypeInfo *road_rti = (road_rt != INVALID_ROADTYPE) ? GetRoadTypeInfo(road_rt) : nullptr;
3399 const RoadTypeInfo *tram_rti = (tram_rt != INVALID_ROADTYPE) ? GetRoadTypeInfo(tram_rt) : nullptr;
3400
3401 if (ti->tileh != SLOPE_FLAT) {
3403 }
3404
3405 DrawRoadGroundSprites(ti, road, tram, road_rti, tram_rti, GetRoadWaypointRoadside(ti->tile), IsRoadWaypointOnSnowOrDesert(ti->tile));
3406 } else {
3407 if (layout != nullptr) {
3408 /* Sprite layout which needs preprocessing */
3409 bool separate_ground = statspec->flags.Test(StationSpecFlag::SeparateGround);
3410 processor = SpriteLayoutProcessor(*layout, total_offset, rti->fallback_railtype, 0, 0, separate_ground);
3411 GetCustomStationRelocation(processor, statspec, st, ti->tile);
3412 tmp_layout = processor.GetLayout();
3413 t = &tmp_layout;
3414 total_offset = 0;
3415 } else if (statspec != nullptr) {
3416 /* Simple sprite layout */
3417 ground_relocation = relocation = GetCustomStationRelocation(statspec, st, ti->tile, 0);
3419 ground_relocation = GetCustomStationRelocation(statspec, st, ti->tile, 1);
3420 }
3421 ground_relocation += rti->fallback_railtype;
3422 }
3423
3424 draw_ground = true;
3425 }
3426
3427 if (draw_ground && !IsAnyRoadStop(ti->tile)) {
3428 SpriteID image = t->ground.sprite;
3429 PaletteID pal = t->ground.pal;
3430 RailTrackOffset overlay_offset;
3431 if (rti != nullptr && rti->UsesOverlay() && SplitGroundSpriteForOverlay(ti, &image, &overlay_offset)) {
3433 DrawGroundSprite(image, PAL_NONE);
3434 DrawGroundSprite(ground + overlay_offset, PAL_NONE);
3435
3436 if (_game_mode != GameMode::Menu && _settings_client.gui.show_track_reservation && HasStationReservation(ti->tile)) {
3438 DrawGroundSprite(overlay + overlay_offset, PALETTE_CRASH);
3439 }
3440 } else {
3441 image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
3442 if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
3443 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
3444
3445 /* PBS debugging, draw reserved tracks darker */
3446 if (_game_mode != GameMode::Menu && _settings_client.gui.show_track_reservation && HasStationRail(ti->tile) && HasStationReservation(ti->tile)) {
3448 }
3449 }
3450 }
3451
3453
3454 if (IsAnyRoadStop(ti->tile)) {
3455 RoadType road_rt = GetRoadTypeRoad(ti->tile);
3456 RoadType tram_rt = GetRoadTypeTram(ti->tile);
3457 const RoadTypeInfo *road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
3458 const RoadTypeInfo *tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
3459
3460 StationGfx view = GetStationGfx(ti->tile);
3461 StationType type = GetStationType(ti->tile);
3462
3463 const RoadStopSpec *stopspec = GetRoadStopSpec(ti->tile);
3464 RoadStopDrawModes stop_draw_mode{};
3465 if (stopspec != nullptr) {
3466 stop_draw_mode = stopspec->draw_mode;
3467 st = BaseStation::GetByTile(ti->tile);
3468 std::array<int32_t, 1> regs100;
3469 auto result = GetRoadStopLayout(ti, stopspec, st, type, view, regs100);
3470 if (result.has_value()) {
3471 if (stopspec->flags.Test(RoadStopSpecFlag::DrawModeRegister)) {
3472 stop_draw_mode = static_cast<RoadStopDrawModes>(regs100[0]);
3473 }
3474 if (type == StationType::RoadWaypoint && stop_draw_mode.Test(RoadStopDrawMode::WaypGround)) {
3475 draw_ground = true;
3476 }
3477 processor = std::move(*result);
3478 tmp_layout = processor.GetLayout();
3479 t = &tmp_layout;
3480 }
3481 }
3482
3483 /* Draw ground sprite */
3484 if (draw_ground) {
3485 SpriteID image = t->ground.sprite;
3486 PaletteID pal = t->ground.pal;
3487 image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
3488 if (GB(image, 0, SPRITE_WIDTH) != 0) {
3489 if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
3490 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
3491 }
3492 }
3493
3494 if (IsDriveThroughStopTile(ti->tile)) {
3495 if (type != StationType::RoadWaypoint && (stopspec == nullptr || stop_draw_mode.Test(RoadStopDrawMode::Overlay))) {
3496 uint sprite_offset = GetDriveThroughStopAxis(ti->tile) == Axis::X ? 1 : 0;
3497 DrawRoadOverlays(ti, PAL_NONE, road_rti, tram_rti, sprite_offset, sprite_offset);
3498 }
3499 } else {
3500 /* Non-drivethrough road stops are only valid for roads. */
3501 assert(road_rt != INVALID_ROADTYPE && tram_rt == INVALID_ROADTYPE);
3502
3503 if ((stopspec == nullptr || stop_draw_mode.Test(RoadStopDrawMode::Road)) && road_rti->UsesOverlay()) {
3505 DrawGroundSprite(ground + view, PAL_NONE);
3506 }
3507 }
3508 if (stopspec != nullptr) bridgeable_info = stopspec->bridgeable_info;
3509
3510 if (stopspec == nullptr || !stopspec->flags.Test(RoadStopSpecFlag::NoCatenary)) {
3511 /* Draw road, tram catenary */
3512 DrawRoadCatenary(ti);
3513 }
3514 }
3515
3516 if (IsRailWaypoint(ti->tile)) {
3517 /* Don't offset the waypoint graphics; they're always the same. */
3518 total_offset = 0;
3519 }
3520
3521 DrawRailTileSeq(ti, t, TransparencyOption::Buildings, total_offset, relocation, palette);
3522 DrawBridgeMiddle(ti, GetStationBlockedPillars(bridgeable_info, GetStationGfx(ti->tile)));
3523}
3524
3525void StationPickerDrawSprite(int x, int y, StationType st, RailType railtype, RoadType roadtype, int image)
3526{
3527 int32_t total_offset = 0;
3529 const DrawTileSprites *t = GetStationTileLayout(st, image);
3530 const RailTypeInfo *railtype_info = nullptr;
3531
3532 if (railtype != INVALID_RAILTYPE) {
3533 railtype_info = GetRailTypeInfo(railtype);
3534 total_offset = railtype_info->GetRailtypeSpriteOffset();
3535 }
3536
3537 SpriteID img = t->ground.sprite;
3538 RailTrackOffset overlay_offset;
3539 if (railtype_info != nullptr && railtype_info->UsesOverlay() && SplitGroundSpriteForOverlay(nullptr, &img, &overlay_offset)) {
3541 DrawSprite(img, PAL_NONE, x, y);
3542 DrawSprite(ground + overlay_offset, PAL_NONE, x, y);
3543 } else {
3544 DrawSprite(img + total_offset, HasBit(img, PALETTE_MODIFIER_COLOUR) ? pal : PAL_NONE, x, y);
3545 }
3546
3547 if (roadtype != INVALID_ROADTYPE) {
3548 const RoadTypeInfo *roadtype_info = GetRoadTypeInfo(roadtype);
3549 if (image >= 4) {
3550 /* Drive-through stop */
3551 uint sprite_offset = 5 - image;
3552
3553 /* Road underlay takes precedence over tram */
3554 if (roadtype_info->UsesOverlay()) {
3556 DrawSprite(ground + sprite_offset, PAL_NONE, x, y);
3557
3559 if (overlay) DrawSprite(overlay + sprite_offset, PAL_NONE, x, y);
3560 } else if (RoadTypeIsTram(roadtype)) {
3561 DrawSprite(SPR_TRAMWAY_TRAM + sprite_offset, PAL_NONE, x, y);
3562 }
3563 } else {
3564 /* Bay stop */
3565 if (RoadTypeIsRoad(roadtype) && roadtype_info->UsesOverlay()) {
3567 DrawSprite(ground + image, PAL_NONE, x, y);
3568 }
3569 }
3570 }
3571
3572 /* Default waypoint has no railtype specific sprites */
3573 DrawRailTileSeqInGUI(x, y, t, (st == StationType::RailWaypoint || st == StationType::RoadWaypoint) ? 0 : total_offset, 0, pal);
3574}
3575
3576
3577static void FillTileDescRoadStop(TileIndex tile, TileDesc &td)
3578{
3579 RoadType road_rt = GetRoadTypeRoad(tile);
3580 RoadType tram_rt = GetRoadTypeTram(tile);
3581 Owner road_owner = INVALID_OWNER;
3582 Owner tram_owner = INVALID_OWNER;
3583 if (road_rt != INVALID_ROADTYPE) {
3584 const RoadTypeInfo *rti = GetRoadTypeInfo(road_rt);
3585 td.roadtype = rti->strings.name;
3586 td.road_speed = rti->max_speed / 2;
3587 road_owner = GetRoadOwner(tile, RoadTramType::Road);
3588 }
3589
3590 if (tram_rt != INVALID_ROADTYPE) {
3591 const RoadTypeInfo *rti = GetRoadTypeInfo(tram_rt);
3592 td.tramtype = rti->strings.name;
3593 td.tram_speed = rti->max_speed / 2;
3594 tram_owner = GetRoadOwner(tile, RoadTramType::Tram);
3595 }
3596
3597 if (IsDriveThroughStopTile(tile)) {
3598 /* Is there a mix of owners? */
3599 if ((tram_owner != INVALID_OWNER && tram_owner != td.owner[0]) ||
3600 (road_owner != INVALID_OWNER && road_owner != td.owner[0])) {
3601 uint i = 1;
3602 if (road_owner != INVALID_OWNER) {
3603 td.owner_type[i] = STR_LAND_AREA_INFORMATION_ROAD_OWNER;
3604 td.owner[i] = road_owner;
3605 i++;
3606 }
3607 if (tram_owner != INVALID_OWNER) {
3608 td.owner_type[i] = STR_LAND_AREA_INFORMATION_TRAM_OWNER;
3609 td.owner[i] = tram_owner;
3610 }
3611 }
3612 }
3613}
3614
3615void FillTileDescRailStation(TileIndex tile, TileDesc &td)
3616{
3617 const StationSpec *spec = GetStationSpec(tile);
3618
3619 if (spec != nullptr) {
3621 td.station_name = spec->name;
3622
3623 if (spec->grf_prop.HasGrfFile()) {
3624 const GRFConfig *gc = GetGRFConfig(spec->grf_prop.grfid);
3625 td.grf = gc->GetName();
3626 }
3627 }
3628
3629 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
3630 td.rail_speed = rti->max_speed;
3631 td.railtype = rti->strings.name;
3632}
3633
3634void FillTileDescAirport(TileIndex tile, TileDesc &td)
3635{
3636 const AirportSpec *as = Station::GetByTile(tile)->airport.GetSpec();
3638 td.airport_name = as->name;
3639
3640 const AirportTileSpec *ats = AirportTileSpec::GetByTile(tile);
3641 td.airport_tile_name = ats->name;
3642
3643 if (as->grf_prop.HasGrfFile()) {
3644 const GRFConfig *gc = GetGRFConfig(as->grf_prop.grfid);
3645 td.grf = gc->GetName();
3646 } else if (ats->grf_prop.HasGrfFile()) {
3647 const GRFConfig *gc = GetGRFConfig(ats->grf_prop.grfid);
3648 td.grf = gc->GetName();
3649 }
3650}
3651
3654{
3655 td.owner[0] = GetTileOwner(tile);
3657
3658 if (IsAnyRoadStop(tile)) FillTileDescRoadStop(tile, td);
3659 if (HasStationRail(tile)) FillTileDescRailStation(tile, td);
3660 if (IsAirport(tile)) FillTileDescAirport(tile, td);
3661
3662 StringID str;
3663 switch (GetStationType(tile)) {
3664 default: NOT_REACHED();
3665 case StationType::Rail: str = STR_LAI_STATION_DESCRIPTION_RAILROAD_STATION; break;
3667 str = (IsHangar(tile) ? STR_LAI_STATION_DESCRIPTION_AIRCRAFT_HANGAR : STR_LAI_STATION_DESCRIPTION_AIRPORT);
3668 break;
3669 case StationType::Truck: str = STR_LAI_STATION_DESCRIPTION_TRUCK_LOADING_AREA; break;
3670 case StationType::Bus: str = STR_LAI_STATION_DESCRIPTION_BUS_STATION; break;
3671 case StationType::Oilrig: {
3672 const Industry *i = Station::GetByTile(tile)->industry;
3673 const IndustrySpec *is = GetIndustrySpec(i->type);
3674 td.owner[0] = i->owner;
3675 str = is->name;
3676 if (is->grf_prop.HasGrfFile()) td.grf = GetGRFConfig(is->grf_prop.grfid)->GetName();
3677 break;
3678 }
3679 case StationType::Dock: str = STR_LAI_STATION_DESCRIPTION_SHIP_DOCK; break;
3680 case StationType::Buoy: str = STR_LAI_STATION_DESCRIPTION_BUOY; break;
3681 case StationType::RailWaypoint: str = STR_LAI_STATION_DESCRIPTION_WAYPOINT; break;
3682 case StationType::RoadWaypoint: str = STR_LAI_STATION_DESCRIPTION_WAYPOINT; break;
3683 }
3684 td.str = str;
3685}
3686
3687
3690{
3691 TrackBits trackbits{};
3692
3693 switch (mode) {
3695 if (HasStationRail(tile) && !IsStationTileBlocked(tile)) {
3696 trackbits = GetRailStationTrack(tile);
3697 }
3698 break;
3699
3701 /* buoy is coded as a station, it is always on open water */
3702 if (IsBuoy(tile)) {
3703 trackbits = TRACK_BIT_ALL;
3704 /* remove tracks that connect NE map edge */
3705 if (TileX(tile) == 0) trackbits.Reset(TRACK_BIT_3WAY_NE);
3706 /* remove tracks that connect NW map edge */
3707 if (TileY(tile) == 0) trackbits.Reset({Track::Y, Track::Left, Track::Upper});
3708 }
3709 break;
3710
3712 if (IsAnyRoadStop(tile)) {
3713 RoadTramType rtt = (RoadTramType)sub_mode;
3714 if (!HasTileRoadType(tile, rtt)) break;
3715
3716 if (IsBayRoadStopTile(tile)) {
3717 DiagDirection dir = GetBayRoadStopDir(tile);
3718 if (side != DiagDirection::Invalid && dir != side) break;
3719 trackbits = DiagDirToDiagTrack(dir);
3720 } else {
3721 Axis axis = GetDriveThroughStopAxis(tile);
3722 if (side != DiagDirection::Invalid && axis != DiagDirToAxis(side)) break;
3723 trackbits = AxisToTrack(axis);
3724 }
3725 }
3726 break;
3727
3728 default:
3729 break;
3730 }
3731
3732 return {TrackBitsToTrackdirBits(trackbits), {}};
3733}
3734
3735
3738{
3739 auto *st = BaseStation::GetByTile(tile);
3740 switch (GetStationType(tile)) {
3742 TriggerAirportTileAnimation(Station::From(st), tile, AirportAnimationTrigger::TileLoop);
3743 break;
3744
3745 case StationType::Rail:
3747 TriggerStationAnimation(st, tile, StationAnimationTrigger::TileLoop);
3748 break;
3749
3750 case StationType::Dock:
3751 if (!IsTileFlat(tile)) break; // only handle water part
3752 [[fallthrough]];
3753
3754 case StationType::Oilrig: //(station part)
3755 case StationType::Buoy:
3756 TileLoop_Water(tile);
3757 break;
3758
3759 case StationType::Truck:
3760 case StationType::Bus:
3761 TriggerRoadStopAnimation(st, tile, StationAnimationTrigger::TileLoop);
3762 break;
3763
3765 switch (_settings_game.game_creation.landscape) {
3767 if (IsRoadWaypointOnSnowOrDesert(tile) != (GetTileZ(tile) > GetSnowLine())) {
3769 MarkTileDirtyByTile(tile);
3770 }
3771 break;
3772
3776 MarkTileDirtyByTile(tile);
3777 }
3778 break;
3779
3780 default: break;
3781 }
3782
3783 HouseZone new_zone = HouseZone::TownEdge;
3784 const Town *t = ClosestTownFromTile(tile, UINT_MAX);
3785 if (t != nullptr) {
3786 new_zone = GetTownRadiusGroup(t, tile);
3787 }
3788
3789 /* Adjust road ground type depending on 'new_zone' */
3791 Roadside cur_rs = GetRoadWaypointRoadside(tile);
3792
3793 if (new_rs != cur_rs) {
3794 SetRoadWaypointRoadside(tile, cur_rs == Roadside::Barren ? new_rs : Roadside::Barren);
3795 MarkTileDirtyByTile(tile);
3796 }
3797
3798 TriggerRoadStopAnimation(st, tile, StationAnimationTrigger::TileLoop);
3799 break;
3800 }
3801
3802 default: break;
3803 }
3804}
3805
3806
3809{
3810 if (HasStationRail(tile)) {
3811 AnimateStationTile(tile);
3812 return;
3813 }
3814
3815 if (IsAirport(tile)) {
3816 AnimateAirportTile(tile);
3817 return;
3818 }
3819
3820 if (IsAnyRoadStopTile(tile)) {
3821 AnimateRoadStopTile(tile);
3822 return;
3823 }
3824}
3825
3826
3829{
3830 const BaseStation *bst = BaseStation::GetByTile(tile);
3831
3834 } else if (IsHangar(tile)) {
3835 const Station *st = Station::From(bst);
3837 } else {
3838 ShowStationViewWindow(bst->index);
3839 }
3840 return true;
3841}
3842
3845{
3846 if (v->type == VehicleType::Train) {
3847 StationID station_id = GetStationIndex(tile);
3848 if (!IsRailStation(tile) || !v->IsMovingFront()) return {};
3849 Vehicle *consist = v->First();
3850 if (!consist->current_order.ShouldStopAtStation(consist, station_id)) return {};
3851
3852 int station_ahead;
3853 int station_length;
3854 int stop = GetTrainStopLocation(station_id, tile, Train::From(v), &station_ahead, &station_length);
3855
3856 /* Stop whenever that amount of station ahead + the distance from the
3857 * begin of the platform to the stop location is longer than the length
3858 * of the platform. Station ahead 'includes' the current tile where the
3859 * vehicle is on, so we need to subtract that. */
3860 if (stop + station_ahead - (int)TILE_SIZE >= station_length) return {};
3861
3863
3864 x &= 0xF;
3865 y &= 0xF;
3866
3867 if (DiagDirToAxis(dir) != Axis::X) std::swap(x, y);
3868 if (y == TILE_SIZE / 2) {
3869 if (dir != DiagDirection::SE && dir != DiagDirection::SW) x = TILE_SIZE - 1 - x;
3870 stop &= TILE_SIZE - 1;
3871
3872 if (x == stop) {
3873 return VehicleEnterTileState::EnteredStation; // enter station
3874 } else if (x < stop) {
3876 uint16_t spd = std::max(0, (stop - x) * 20 - 15);
3877 if (spd < v->cur_speed) v->cur_speed = spd;
3878 }
3879 }
3880 } else if (v->type == VehicleType::Road) {
3882 if (rv->state < RVSB_IN_ROAD_STOP && !IsReversingRoadTrackdir(static_cast<Trackdir>(rv->state)) && rv->frame == 0) {
3883 if (IsStationRoadStop(tile) && rv->IsFrontEngine()) {
3884 /* Attempt to allocate a parking bay in a road stop */
3885 if (RoadStop::GetByTile(tile, GetRoadStopType(tile))->Enter(rv)) return {};
3887 }
3888 }
3889 }
3890
3891 return {};
3892}
3893
3899{
3900 /* Collect cargoes accepted since the last big tick. */
3901 CargoTypes cargoes{};
3902 for (CargoType cargo_type : EnumRange(NUM_CARGO)) {
3903 if (st->goods[cargo_type].status.Test(GoodsEntry::State::AcceptedBigtick)) cargoes.Set(cargo_type);
3904 }
3905
3906 /* Anything to do? */
3907 if (cargoes.None()) return;
3908
3909 /* Loop over all houses in the catchment. */
3911 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
3912 if (IsTileType(tile, TileType::House)) {
3914 }
3915 }
3916}
3917
3925{
3926 if (!st->IsInUse()) {
3927 if (++st->delete_ctr >= 8) delete st;
3928 return false;
3929 }
3930
3931 if (Station::IsExpected(st)) {
3933
3934 for (GoodsEntry &ge : Station::From(st)->goods) {
3936 }
3937 }
3938
3939
3941
3942 return true;
3943}
3944
3945static inline void byte_inc_sat(uint8_t *p)
3946{
3947 uint8_t b = *p + 1;
3948 if (b != 0) *p = b;
3949}
3950
3957static void TruncateCargo(const CargoSpec *cs, GoodsEntry *ge, uint amount = UINT_MAX)
3958{
3959 /* If truncating also punish the source stations' ratings to
3960 * decrease the flow of incoming cargo. */
3961
3962 if (!ge->HasData()) return;
3963
3964 StationCargoAmountMap waiting_per_source;
3965 ge->GetData().cargo.Truncate(amount, &waiting_per_source);
3966 for (StationCargoAmountMap::iterator i(waiting_per_source.begin()); i != waiting_per_source.end(); ++i) {
3967 Station *source_station = Station::GetIfValid(i->first);
3968 if (source_station == nullptr) continue;
3969
3970 GoodsEntry &source_ge = source_station->goods[cs->Index()];
3971 source_ge.max_waiting_cargo = std::max(source_ge.max_waiting_cargo, i->second);
3972 }
3973}
3974
3980{
3981 bool waiting_changed = false;
3982
3983 byte_inc_sat(&st->time_since_load);
3984 byte_inc_sat(&st->time_since_unload);
3985
3986 for (const CargoSpec *cs : CargoSpec::Iterate()) {
3987 GoodsEntry *ge = &st->goods[cs->Index()];
3988
3989 /* The station might not currently be moving this cargo. */
3990 if (!ge->HasRating()) {
3991 /* Slowly increase the rating back to its original level in the case we
3992 * didn't deliver cargo yet to this station. This happens when a bribe
3993 * failed while you didn't moved that cargo yet to a station. */
3994 if (ge->rating < INITIAL_STATION_RATING) ge->rating++;
3995
3996 /* Nothing else to do with this cargo. */
3997 continue;
3998 }
3999
4000 byte_inc_sat(&ge->time_since_pickup);
4001
4002 /* If this cargo hasn't been picked up in a long time, get rid of it. */
4003 if (ge->time_since_pickup == 255 && _settings_game.order.selectgoods) {
4005 ge->last_speed = 0;
4006 TruncateCargo(cs, ge);
4007 waiting_changed = true;
4008 continue;
4009 }
4010
4011 bool skip = false;
4012 int rating = 0;
4013 uint waiting = ge->AvailableCount();
4014
4015 /* num_dests is at least 1 if there is any cargo as
4016 * StationID::Invalid() is also a destination.
4017 */
4018 uint num_dests = ge->HasData() ? static_cast<uint>(ge->GetData().cargo.Packets()->MapSize()) : 0;
4019
4020 /* Average amount of cargo per next hop, but prefer solitary stations
4021 * with only one or two next hops. They are allowed to have more
4022 * cargo waiting per next hop.
4023 * With manual cargo distribution waiting_avg = waiting / 2 as then
4024 * StationID::Invalid() is the only destination.
4025 */
4026 uint waiting_avg = waiting / (num_dests + 1);
4027
4028 if (_cheats.station_rating.value) {
4029 ge->rating = rating = MAX_STATION_RATING;
4030 skip = true;
4031 } else if (cs->callback_mask.Test(CargoCallbackMask::StationRatingCalc)) {
4032 /* Perform custom station rating. If it succeeds the speed, days in transit and
4033 * waiting cargo ratings must not be executed. */
4034
4035 /* NewGRFs expect last speed to be 0xFF when no vehicle has arrived yet. */
4036 uint last_speed = ge->HasVehicleEverTriedLoading() ? ge->last_speed : 0xFF;
4037
4038 uint32_t var18 = ClampTo<uint8_t>(ge->time_since_pickup)
4040 | (ClampTo<uint8_t>(last_speed) << 24);
4041 /* Convert to the 'old' vehicle types */
4042 uint32_t var10 = (st->last_vehicle_type == VehicleType::Invalid) ? 0x0 : (to_underlying(st->last_vehicle_type) + 0x10);
4043 uint16_t callback = GetCargoCallback(CBID_CARGO_STATION_RATING_CALC, var10, var18, cs);
4044 if (callback != CALLBACK_FAILED) {
4045 skip = true;
4046 rating = GB(callback, 0, 14);
4047
4048 /* Simulate a 15 bit signed value */
4049 if (HasBit(callback, 14)) rating -= 0x4000;
4050 }
4051 }
4052
4053 if (!skip) {
4054 int b = ge->last_speed - 85;
4055 if (b >= 0) rating += b >> 2;
4056
4057 uint8_t waittime = ge->time_since_pickup;
4058 if (st->last_vehicle_type == VehicleType::Ship) waittime >>= 2;
4059 if (waittime <= 21) rating += 25;
4060 if (waittime <= 12) rating += 25;
4061 if (waittime <= 6) rating += 45;
4062 if (waittime <= 3) rating += 35;
4063
4064 rating -= 90;
4065 if (ge->max_waiting_cargo <= 1500) rating += 55;
4066 if (ge->max_waiting_cargo <= 1000) rating += 35;
4067 if (ge->max_waiting_cargo <= 600) rating += 10;
4068 if (ge->max_waiting_cargo <= 300) rating += 20;
4069 if (ge->max_waiting_cargo <= 100) rating += 10;
4070 }
4071
4072 if (Company::IsValidID(st->owner) && st->town->statues.Test(st->owner)) rating += 26;
4073
4074 uint8_t age = ge->last_age;
4075 if (age < 3) rating += 10;
4076 if (age < 2) rating += 10;
4077 if (age < 1) rating += 13;
4078
4079 {
4080 int or_ = ge->rating; // old rating
4081
4082 /* only modify rating in steps of -2, -1, 0, 1 or 2 */
4083 ge->rating = rating = ClampTo<uint8_t>(or_ + Clamp(rating - or_, -2, 2));
4084
4085 /* if rating is <= 64 and more than 100 items waiting on average per destination,
4086 * remove some random amount of goods from the station */
4087 if (rating <= 64 && waiting_avg >= 100) {
4088 int dec = Random() & 0x1F;
4089 if (waiting_avg < 200) dec &= 7;
4090 waiting -= (dec + 1) * num_dests;
4091 waiting_changed = true;
4092 }
4093
4094 /* if rating is <= 127 and there are any items waiting, maybe remove some goods. */
4095 if (rating <= 127 && waiting != 0) {
4096 uint32_t r = Random();
4097 if (rating <= (int)GB(r, 0, 7)) {
4098 /* Need to have int, otherwise it will just overflow etc. */
4099 waiting = std::max((int)waiting - (int)((GB(r, 8, 2) + 1) * num_dests), 0);
4100 waiting_changed = true;
4101 }
4102 }
4103
4104 /* At some point we really must cap the cargo. Previously this
4105 * was a strict 4095, but now we'll have a less strict, but
4106 * increasingly aggressive truncation of the amount of cargo. */
4107 static const uint WAITING_CARGO_THRESHOLD = 1 << 12;
4108 static const uint WAITING_CARGO_CUT_FACTOR = 1 << 6;
4109 static const uint MAX_WAITING_CARGO = 1 << 15;
4110
4111 if (waiting > WAITING_CARGO_THRESHOLD) {
4112 uint difference = waiting - WAITING_CARGO_THRESHOLD;
4113 waiting -= (difference / WAITING_CARGO_CUT_FACTOR);
4114
4115 waiting = std::min(waiting, MAX_WAITING_CARGO);
4116 waiting_changed = true;
4117 }
4118
4119 /* We can't truncate cargo that's already reserved for loading.
4120 * Thus StoredCount() here. */
4121 if (waiting_changed && waiting < ge->AvailableCount()) {
4122 /* Feed back the exact own waiting cargo at this station for the
4123 * next rating calculation. */
4124 ge->max_waiting_cargo = 0;
4125
4126 TruncateCargo(cs, ge, ge->AvailableCount() - waiting);
4127 } else {
4128 /* If the average number per next hop is low, be more forgiving. */
4129 ge->max_waiting_cargo = waiting_avg;
4130 }
4131 }
4132 }
4133
4134 StationID index = st->index;
4135 if (waiting_changed) {
4136 SetWindowDirty(WindowClass::StationView, index); // update whole window
4137 } else {
4138 SetWindowWidgetDirty(WindowClass::StationView, index, WID_SV_ACCEPT_RATING_LIST); // update only ratings list
4139 }
4140}
4141
4150void RerouteCargo(Station *st, CargoType cargo, StationID avoid, StationID avoid2)
4151{
4152 GoodsEntry &ge = st->goods[cargo];
4153
4154 /* Reroute cargo in station. */
4155 if (ge.HasData()) ge.GetData().cargo.Reroute(UINT_MAX, &ge.GetData().cargo, avoid, avoid2, &ge);
4156
4157 /* Reroute cargo staged to be transferred. */
4158 for (Vehicle *v : st->loading_vehicles) {
4159 for (Vehicle *u = v; u != nullptr; u = u->Next()) {
4160 if (u->cargo_type != cargo) continue;
4161 u->cargo.Reroute(UINT_MAX, &u->cargo, avoid, avoid2, &ge);
4162 }
4163 }
4164}
4165
4175{
4176 for (CargoType cargo : EnumRange(NUM_CARGO)) {
4177 const bool auto_distributed = (_settings_game.linkgraph.GetDistributionType(cargo) != DistributionType::Manual);
4178 GoodsEntry &ge = from->goods[cargo];
4180 if (lg == nullptr) continue;
4181 std::vector<NodeID> to_remove{};
4182 for (Edge &edge : (*lg)[ge.node].edges) {
4183 Station *to = Station::Get((*lg)[edge.dest_node].station);
4184 assert(to->goods[cargo].node == edge.dest_node);
4185 assert(TimerGameEconomy::date >= edge.LastUpdate());
4187 if (TimerGameEconomy::date - edge.LastUpdate() > timeout) {
4188 bool updated = false;
4189
4190 if (auto_distributed) {
4191 /* Have all vehicles refresh their next hops before deciding to
4192 * remove the node. */
4193 std::vector<Vehicle *> vehicles;
4194 for (const OrderList *l : OrderList::Iterate()) {
4195 bool found_from = false;
4196 bool found_to = false;
4197 for (const Order &order : l->GetOrders()) {
4198 if (!order.IsType(OT_GOTO_STATION) && !order.IsType(OT_IMPLICIT)) continue;
4199 if (order.GetDestination() == from->index) {
4200 found_from = true;
4201 if (found_to) break;
4202 } else if (order.GetDestination() == to->index) {
4203 found_to = true;
4204 if (found_from) break;
4205 }
4206 }
4207 if (!found_to || !found_from) continue;
4208 vehicles.push_back(l->GetFirstSharedVehicle());
4209 }
4210
4211 auto iter = vehicles.begin();
4212 while (iter != vehicles.end()) {
4213 Vehicle *v = *iter;
4214 /* Do not refresh links of vehicles that have been stopped in depot for a long time. */
4216 LinkRefresher::Run(v, false); // Don't allow merging. Otherwise lg might get deleted.
4217 }
4218 if (edge.LastUpdate() == TimerGameEconomy::date) {
4219 updated = true;
4220 break;
4221 }
4222
4223 Vehicle *next_shared = v->NextShared();
4224 if (next_shared) {
4225 *iter = next_shared;
4226 ++iter;
4227 } else {
4228 iter = vehicles.erase(iter);
4229 }
4230
4231 if (iter == vehicles.end()) iter = vehicles.begin();
4232 }
4233 }
4234
4235 if (!updated) {
4236 /* If it's still considered dead remove it. */
4237 to_remove.emplace_back(to->goods[cargo].node);
4238 if (ge.HasData()) ge.GetData().flows.DeleteFlows(to->index);
4239 RerouteCargo(from, cargo, to->index, from->index);
4240 }
4241 } else if (edge.last_unrestricted_update != EconomyTime::INVALID_DATE && TimerGameEconomy::date - edge.last_unrestricted_update > timeout) {
4242 edge.Restrict();
4243 if (ge.HasData()) ge.GetData().flows.RestrictFlows(to->index);
4244 RerouteCargo(from, cargo, to->index, from->index);
4245 } else if (edge.last_restricted_update != EconomyTime::INVALID_DATE && TimerGameEconomy::date - edge.last_restricted_update > timeout) {
4246 edge.Release();
4247 }
4248 }
4249 /* Remove dead edges. */
4250 for (NodeID r : to_remove) (*lg)[ge.node].RemoveEdge(r);
4251
4252 assert(TimerGameEconomy::date >= lg->LastCompression());
4254 lg->Compress();
4255 }
4256 }
4257}
4258
4269void IncreaseStats(Station *st, CargoType cargo, StationID next_station_id, uint capacity, uint usage, uint32_t time, EdgeUpdateModes modes)
4270{
4271 GoodsEntry &ge1 = st->goods[cargo];
4272 Station *st2 = Station::Get(next_station_id);
4273 GoodsEntry &ge2 = st2->goods[cargo];
4274 LinkGraph *lg = nullptr;
4275 if (ge1.link_graph == LinkGraphID::Invalid()) {
4276 if (ge2.link_graph == LinkGraphID::Invalid()) {
4278 lg = LinkGraph::Create(cargo);
4280 ge2.link_graph = lg->index;
4281 ge2.node = lg->AddNode(st2);
4282 } else {
4283 Debug(misc, 0, "Can't allocate link graph");
4284 }
4285 } else {
4286 lg = LinkGraph::Get(ge2.link_graph);
4287 }
4288 if (lg) {
4289 ge1.link_graph = lg->index;
4290 ge1.node = lg->AddNode(st);
4291 }
4292 } else if (ge2.link_graph == LinkGraphID::Invalid()) {
4293 lg = LinkGraph::Get(ge1.link_graph);
4294 ge2.link_graph = lg->index;
4295 ge2.node = lg->AddNode(st2);
4296 } else {
4297 lg = LinkGraph::Get(ge1.link_graph);
4298 if (ge1.link_graph != ge2.link_graph) {
4300 if (lg->Size() < lg2->Size()) {
4301 LinkGraphSchedule::instance.Dequeue(lg);
4302 lg2->Merge(lg); // Updates GoodsEntries of lg
4303 lg = lg2;
4304 } else {
4305 LinkGraphSchedule::instance.Dequeue(lg2);
4306 lg->Merge(lg2); // Updates GoodsEntries of lg2
4307 }
4308 }
4309 }
4310 if (lg != nullptr) {
4311 (*lg)[ge1.node].UpdateEdge(ge2.node, capacity, usage, time, modes);
4312 }
4313}
4314
4322void IncreaseStats(Station *st, const Vehicle *front, StationID next_station_id, uint32_t time)
4323{
4324 for (const Vehicle *v = front; v != nullptr; v = v->Next()) {
4325 if (v->refit_cap > 0) {
4326 /* The cargo count can indeed be higher than the refit_cap if
4327 * wagons have been auto-replaced and subsequently auto-
4328 * refitted to a higher capacity. The cargo gets redistributed
4329 * among the wagons in that case.
4330 * As usage is not such an important figure anyway we just
4331 * ignore the additional cargo then.*/
4332 IncreaseStats(st, v->cargo_type, next_station_id, v->refit_cap,
4333 std::min<uint>(v->refit_cap, v->cargo.StoredCount()), time, EdgeUpdateMode::Increase);
4334 }
4335 }
4336}
4337
4338/* called for every station each tick */
4339static void StationHandleSmallTick(BaseStation *st)
4340{
4341 if (st->facilities.Test(StationFacility::Waypoint) || !st->IsInUse()) return;
4342
4343 uint8_t b = st->delete_ctr + 1;
4344 if (b >= Ticks::STATION_RATING_TICKS) b = 0;
4345 st->delete_ctr = b;
4346
4347 if (b == 0) UpdateStationRating(Station::From(st));
4348}
4349
4350void OnTick_Station()
4351{
4352 if (_game_mode == GameMode::Editor) return;
4353
4354 for (BaseStation *st : BaseStation::Iterate()) {
4355 StationHandleSmallTick(st);
4356
4357 /* Clean up the link graph about once a week. */
4360 };
4361
4362 /* Spread out big-tick over STATION_ACCEPTANCE_TICKS ticks. */
4364 /* Stop processing this station if it was deleted */
4365 if (!StationHandleBigTick(st)) continue;
4366 }
4367
4368 /* Spread out station animation over STATION_ACCEPTANCE_TICKS ticks. */
4370 TriggerStationAnimation(st, st->xy, StationAnimationTrigger::AcceptanceTick);
4371 TriggerRoadStopAnimation(st, st->xy, StationAnimationTrigger::AcceptanceTick);
4372 if (Station::IsExpected(st)) TriggerAirportAnimation(Station::From(st), AirportAnimationTrigger::AcceptanceTick);
4373 }
4374 }
4375}
4376
4378static const IntervalTimer<TimerGameEconomy> _economy_stations_monthly({TimerGameEconomy::Trigger::Month, TimerGameEconomy::Priority::Station}, [](auto)
4379{
4380 for (Station *st : Station::Iterate()) {
4381 for (GoodsEntry &ge : st->goods) {
4384 }
4385 }
4386});
4387
4396void ModifyStationRatingAround(TileIndex tile, Owner owner, int amount, uint radius)
4397{
4398 ForAllStationsRadius(tile, radius, [&](Station *st) {
4399 if (st->owner == owner && DistanceManhattan(tile, st->xy) <= radius) {
4400 for (GoodsEntry &ge : st->goods) {
4401 if (ge.status.Any()) {
4402 ge.rating = ClampTo<uint8_t>(ge.rating + amount);
4403 }
4404 }
4405 }
4406 });
4407}
4408
4409static uint UpdateStationWaiting(Station *st, CargoType cargo, uint amount, Source source)
4410{
4411 /* We can't allocate a CargoPacket? Then don't do anything
4412 * at all; i.e. just discard the incoming cargo. */
4413 if (!CargoPacket::CanAllocateItem()) return 0;
4414
4415 GoodsEntry &ge = st->goods[cargo];
4416 amount += ge.amount_fract;
4417 ge.amount_fract = GB(amount, 0, 8);
4418
4419 amount >>= 8;
4420 /* No new "real" cargo item yet. */
4421 if (amount == 0) return 0;
4422
4423 StationID next = ge.GetVia(st->index);
4424 ge.GetOrCreateData().cargo.Append(CargoPacket::Create(st->index, amount, source), next);
4425 LinkGraph *lg = nullptr;
4426 if (ge.link_graph == LinkGraphID::Invalid()) {
4427 if (LinkGraph::CanAllocateItem()) {
4428 lg = LinkGraph::Create(cargo);
4430 ge.link_graph = lg->index;
4431 ge.node = lg->AddNode(st);
4432 } else {
4433 Debug(misc, 0, "Can't allocate link graph");
4434 }
4435 } else {
4436 lg = LinkGraph::Get(ge.link_graph);
4437 }
4438 if (lg != nullptr) (*lg)[ge.node].UpdateSupply(amount);
4439
4440 if (!ge.HasRating()) {
4441 InvalidateWindowData(WindowClass::StationList, st->owner);
4443 }
4444
4446 TriggerStationAnimation(st, st->xy, StationAnimationTrigger::NewCargo, cargo);
4447 TriggerAirportAnimation(st, AirportAnimationTrigger::NewCargo, cargo);
4449 TriggerRoadStopAnimation(st, st->xy, StationAnimationTrigger::NewCargo, cargo);
4450
4451
4452 SetWindowDirty(WindowClass::StationView, st->index);
4453 st->MarkTilesDirty(true);
4454 return amount;
4455}
4456
4457static bool IsUniqueStationName(const std::string &name)
4458{
4459 for (const Station *st : Station::Iterate()) {
4460 if (!st->name.empty() && st->name == name) return false;
4461 }
4462
4463 return true;
4464}
4465
4473CommandCost CmdRenameStation(DoCommandFlags flags, StationID station_id, const std::string &text)
4474{
4475 Station *st = Station::GetIfValid(station_id);
4476 if (st == nullptr) return CMD_ERROR;
4477
4478 CommandCost ret = CheckOwnership(st->owner);
4479 if (ret.Failed()) return ret;
4480
4481 bool reset = text.empty();
4482
4483 if (!reset) {
4485 if (!IsUniqueStationName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
4486 }
4487
4488 if (flags.Test(DoCommandFlag::Execute)) {
4489 st->cached_name.clear();
4490 if (reset) {
4491 st->name.clear();
4492 } else {
4493 st->name = text;
4494 }
4495
4496 st->UpdateVirtCoord();
4497 InvalidateWindowData(WindowClass::StationList, st->owner, 1);
4498 }
4499
4500 return CommandCost();
4501}
4502
4510std::tuple<CommandCost, StationID> CmdMoveStationName(DoCommandFlags flags, StationID station_id, TileIndex tile)
4511{
4512 Station *st = Station::GetIfValid(station_id);
4513 if (st == nullptr) return { CMD_ERROR, StationID::Invalid() };
4514
4515 if (st->owner != OWNER_NONE) {
4516 CommandCost ret = CheckOwnership(st->owner);
4517 if (ret.Failed()) return { ret, StationID::Invalid() };
4518 }
4519
4520 const StationRect *r = &st->rect;
4521 if (!r->PtInExtendedRect(TileX(tile), TileY(tile))) {
4522 return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
4523 }
4524
4525 bool other_station = false;
4526 /* Check if the tile is the base tile of another station */
4527 ForAllStationsRadius(tile, 0, [&](BaseStation *s) {
4528 if (s != nullptr) {
4529 if (s != st && s->xy == tile) other_station = true;
4530 }
4531 });
4532 if (other_station) return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
4533
4534 if (flags.Test(DoCommandFlag::Execute)) {
4535 st->MoveSign(tile);
4536
4537 st->UpdateVirtCoord();
4538 }
4539 return { CommandCost(), station_id };
4540}
4541
4547void CcMoveStationName(Commands, const CommandCost &result, StationID station_id)
4548 {
4549 if (result.Failed()) return;
4550
4552 Station *st = Station::Get(station_id);
4553 SetViewportStationRect(st, false);
4554 }
4555
4556static void AddNearbyStationsByCatchment(TileIndex tile, StationList &stations, StationList &nearby)
4557{
4558 for (Station *st : nearby) {
4559 if (st->TileIsInCatchment(tile)) stations.insert(st);
4560 }
4561}
4562
4568{
4569 if (this->tile != INVALID_TILE) {
4570 if (IsTileType(this->tile, TileType::House)) {
4571 /* Town nearby stations need to be filtered per tile. */
4572 assert(this->w == 1 && this->h == 1);
4573 AddNearbyStationsByCatchment(this->tile, this->stations, Town::GetByTile(this->tile)->stations_near);
4574 } else {
4575 ForAllStationsAroundTiles(*this, [this](Station *st, TileIndex) {
4576 this->stations.insert(st);
4577 return true;
4578 });
4579 }
4580 this->tile = INVALID_TILE;
4581 }
4582 return this->stations;
4583}
4584
4585
4586static bool CanMoveGoodsToStation(const Station *st, CargoType cargo)
4587{
4588 /* Is the station reserved exclusively for somebody else? */
4589 if (st->owner != OWNER_NONE && st->town->exclusive_counter > 0 && st->town->exclusivity != st->owner) return false;
4590
4591 /* Lowest possible rating, better not to give cargo anymore. */
4592 if (st->goods[cargo].rating == 0) return false;
4593
4594 /* Selectively servicing stations, and not this one. */
4595 if (_settings_game.order.selectgoods && !st->goods[cargo].HasVehicleEverTriedLoading()) return false;
4596
4598 /* Passengers are never served by just a truck stop. */
4599 if (st->facilities == StationFacility::TruckStop) return false;
4600 } else {
4601 /* Non-passengers are never served by just a bus stop. */
4602 if (st->facilities == StationFacility::BusStop) return false;
4603 }
4604 return true;
4605}
4606
4607uint MoveGoodsToStation(CargoType cargo, uint amount, Source source, const StationList &all_stations, Owner exclusivity)
4608{
4609 /* Return if nothing to do. Also the rounding below fails for 0. */
4610 if (all_stations.empty()) return 0;
4611 if (amount == 0) return 0;
4612
4613 Station *first_station = nullptr;
4614 typedef std::pair<Station *, uint> StationInfo;
4615 std::vector<StationInfo> used_stations;
4616
4617 for (Station *st : all_stations) {
4618 if (exclusivity != INVALID_OWNER && exclusivity != st->owner) continue;
4619 if (!CanMoveGoodsToStation(st, cargo)) continue;
4620
4621 /* Avoid allocating a vector if there is only one station to significantly
4622 * improve performance in this common case. */
4623 if (first_station == nullptr) {
4624 first_station = st;
4625 continue;
4626 }
4627 if (used_stations.empty()) {
4628 used_stations.reserve(2);
4629 used_stations.emplace_back(first_station, 0);
4630 }
4631 used_stations.emplace_back(st, 0);
4632 }
4633
4634 /* no stations around at all? */
4635 if (first_station == nullptr) return 0;
4636
4637 if (used_stations.empty()) {
4638 /* only one station around */
4639 amount *= first_station->goods[cargo].rating + 1;
4640 return UpdateStationWaiting(first_station, cargo, amount, source);
4641 }
4642
4643 TypedIndexContainer<std::array<uint32_t, OWNER_END.base()>, Owner> company_best = {}; // best rating for each company, including OWNER_NONE
4644 TypedIndexContainer<std::array<uint32_t, OWNER_END.base()>, Owner> company_sum = {}; // sum of ratings for each company
4645 uint best_rating = 0;
4646 uint best_sum = 0; // sum of best ratings for each company
4647
4648 for (auto &p : used_stations) {
4649 auto owner = p.first->owner;
4650 auto rating = p.first->goods[cargo].rating;
4651 if (rating > company_best[owner]) {
4652 best_sum += rating - company_best[owner]; // it's usually faster than iterating companies later
4653 company_best[owner] = rating;
4654 if (rating > best_rating) best_rating = rating;
4655 }
4656 company_sum[owner] += rating;
4657 }
4658
4659 /* From now we'll calculate with fractional cargo amounts.
4660 * First determine how much cargo we really have. */
4661 amount *= best_rating + 1;
4662
4663 uint moving = 0;
4664 for (auto &p : used_stations) {
4665 Owner owner = p.first->owner;
4666 /* Multiply the amount by (company best / sum of best for each company) to get cargo allocated to a company
4667 * and by (station rating / sum of ratings in a company) to get the result for a single station. */
4668 p.second = amount * company_best[owner] * p.first->goods[cargo].rating / best_sum / company_sum[owner];
4669 moving += p.second;
4670 }
4671
4672 /* If there is some cargo left due to rounding issues distribute it among the best rated stations. */
4673 if (amount > moving) {
4674 std::stable_sort(used_stations.begin(), used_stations.end(), [cargo](const StationInfo &a, const StationInfo &b) {
4675 return b.first->goods[cargo].rating < a.first->goods[cargo].rating;
4676 });
4677
4678 assert(amount - moving <= used_stations.size());
4679 for (uint i = 0; i < amount - moving; i++) {
4680 used_stations[i].second++;
4681 }
4682 }
4683
4684 uint moved = 0;
4685 for (auto &p : used_stations) {
4686 moved += UpdateStationWaiting(p.first, cargo, p.second, source);
4687 }
4688
4689 return moved;
4690}
4691
4692void UpdateStationDockingTiles(Station *st)
4693{
4694 st->docking_station.Clear();
4695
4696 /* For neutral stations, start with the industry area instead of dock area */
4697 const TileArea *area = st->industry != nullptr ? &st->industry->location : &st->ship_station;
4698
4699 if (area->tile == INVALID_TILE) return;
4700
4701 int x = TileX(area->tile);
4702 int y = TileY(area->tile);
4703
4704 /* Expand the area by a tile on each side while
4705 * making sure that we remain inside the map. */
4706 int x2 = std::min<int>(x + area->w + 1, Map::SizeX());
4707 int x1 = std::max<int>(x - 1, 0);
4708
4709 int y2 = std::min<int>(y + area->h + 1, Map::SizeY());
4710 int y1 = std::max<int>(y - 1, 0);
4711
4712 TileArea ta(TileXY(x1, y1), TileXY(x2 - 1, y2 - 1));
4713 for (TileIndex tile : ta) {
4714 if (IsValidTile(tile) && IsPossibleDockingTile(tile)) CheckForDockingTile(tile);
4715 }
4716}
4717
4718void BuildOilRig(TileIndex tile)
4719{
4720 if (!Station::CanAllocateItem()) {
4721 Debug(misc, 0, "Can't allocate station for oilrig at 0x{:X}, reverting to oilrig only", tile);
4722 return;
4723 }
4724
4725 Station *st = Station::Create(tile);
4726 _station_kdtree.Insert(st->index);
4727 st->town = ClosestTownFromTile(tile, UINT_MAX);
4728
4730
4731 assert(IsTileType(tile, TileType::Industry));
4732 /* Mark industry as associated both ways */
4733 st->industry = Industry::GetByTile(tile);
4734 st->industry->neutral_station = st;
4735 DeleteAnimatedTile(tile);
4736 MakeOilrig(tile, st->index, GetWaterClass(tile));
4737
4738 st->owner = OWNER_NONE;
4739 st->airport.type = AT_OILRIG;
4741 st->airport.Add(tile);
4742 st->ship_station.Add(tile);
4745 UpdateStationDockingTiles(st);
4746
4747 st->rect.BeforeAddTile(tile, StationRect::ADD_FORCE);
4748
4749 st->UpdateVirtCoord();
4750
4751 /* An industry tile has now been replaced with a station tile, this may change the overlap between station catchments and industry tiles.
4752 * Recalculate the station catchment for all stations currently in the industry's nearby list.
4753 * Clear the industry's station nearby list first because Station::RecomputeCatchment cannot remove nearby industries in this case. */
4755 StationList nearby = std::move(st->industry->stations_near);
4756 st->industry->stations_near.clear();
4757 for (Station *near : nearby) {
4758 near->RecomputeCatchment(true);
4759 UpdateStationAcceptance(near, true);
4760 }
4761 }
4762
4763 st->RecomputeCatchment();
4764 UpdateStationAcceptance(st, false);
4765}
4766
4767void DeleteOilRig(TileIndex tile)
4768{
4769 Station *st = Station::GetByTile(tile);
4770
4771 MakeWaterKeepingClass(tile, OWNER_NONE);
4772
4773 /* The oil rig station is not supposed to be shared with anything else */
4774 [[maybe_unused]] static constexpr StationFacilities expected_facility{StationFacility::Airport, StationFacility::Dock};
4775 assert(st->facilities == expected_facility && st->airport.type == AT_OILRIG);
4776 if (st->industry != nullptr && st->industry->neutral_station == st) {
4777 /* Don't leave dangling neutral station pointer */
4778 st->industry->neutral_station = nullptr;
4779 }
4780 delete st;
4781}
4782
4784static void ChangeTileOwner_Station(TileIndex tile, Owner old_owner, Owner new_owner)
4785{
4786 if (IsAnyRoadStopTile(tile)) {
4787 for (RoadTramType rtt : ROADTRAMTYPES_ALL) {
4788 /* Update all roadtypes, no matter if they are present */
4789 if (GetRoadOwner(tile, rtt) == old_owner) {
4790 RoadType rt = GetRoadType(tile, rtt);
4791 if (rt != INVALID_ROADTYPE) {
4792 /* A drive-through road-stop has always two road bits. No need to dirty windows here, we'll redraw the whole screen anyway. */
4793 Company::Get(old_owner)->infrastructure.road[rt] -= 2;
4794 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.road[rt] += 2;
4795 }
4796 SetRoadOwner(tile, rtt, new_owner == INVALID_OWNER ? OWNER_NONE : new_owner);
4797 }
4798 }
4799 }
4800
4801 if (!IsTileOwner(tile, old_owner)) return;
4802
4803 if (new_owner != INVALID_OWNER) {
4804 /* Update company infrastructure counts. Only do it here
4805 * if the new owner is valid as otherwise the clear
4806 * command will do it for us. No need to dirty windows
4807 * here, we'll redraw the whole screen anyway.*/
4808 Company *old_company = Company::Get(old_owner);
4809 Company *new_company = Company::Get(new_owner);
4810
4811 /* Update counts for underlying infrastructure. */
4812 switch (GetStationType(tile)) {
4813 case StationType::Rail:
4815 if (!IsStationTileBlocked(tile)) {
4816 old_company->infrastructure.rail[GetRailType(tile)]--;
4817 new_company->infrastructure.rail[GetRailType(tile)]++;
4818 }
4819 break;
4820
4821 case StationType::Bus:
4822 case StationType::Truck:
4824 /* Road stops were already handled above. */
4825 break;
4826
4827 case StationType::Buoy:
4828 case StationType::Dock:
4829 if (GetWaterClass(tile) == WaterClass::Canal) {
4830 old_company->infrastructure.water--;
4831 new_company->infrastructure.water++;
4832 }
4833 break;
4834
4835 default:
4836 break;
4837 }
4838
4839 /* Update station tile count. */
4840 if (!IsBuoy(tile) && !IsAirport(tile)) {
4841 old_company->infrastructure.station--;
4842 new_company->infrastructure.station++;
4843 }
4844
4845 /* for buoys, owner of tile is owner of water, st->owner == OWNER_NONE */
4846 SetTileOwner(tile, new_owner);
4847 InvalidateWindowClassesData(WindowClass::StationList, 0);
4848 } else {
4849 if (IsDriveThroughStopTile(tile)) {
4850 /* Remove the drive-through road stop */
4851 if (IsRoadWaypoint(tile)) {
4852 Command<Commands::RemoveFromRoadWaypoint>::Do({DoCommandFlag::Execute, DoCommandFlag::Bankrupt}, tile, tile);
4853 } else {
4854 Command<Commands::RemoveRoadStop>::Do({DoCommandFlag::Execute, DoCommandFlag::Bankrupt}, tile, 1, 1, (GetStationType(tile) == StationType::Truck) ? RoadStopType::Truck : RoadStopType::Bus, false);
4855 }
4856 assert(IsTileType(tile, TileType::Road));
4857 /* Change owner of tile and all roadtypes */
4858 ChangeTileOwner(tile, old_owner, new_owner);
4859 } else {
4860 Command<Commands::LandscapeClear>::Do({DoCommandFlag::Execute, DoCommandFlag::Bankrupt}, tile);
4861 /* Set tile owner of water under (now removed) buoy and dock to OWNER_NONE.
4862 * Update owner of buoy if it was not removed (was in orders).
4863 * Do not update when owned by OWNER_WATER (sea and rivers). */
4864 if ((IsTileType(tile, TileType::Water) || IsBuoyTile(tile)) && IsTileOwner(tile, old_owner)) SetTileOwner(tile, OWNER_NONE);
4865 }
4866 }
4867}
4868
4878{
4879 /* Water flooding can always clear road stops. */
4880 if (_current_company == OWNER_WATER) return CommandCost();
4881
4882 CommandCost ret;
4883
4884 if (GetRoadTypeTram(tile) != INVALID_ROADTYPE) {
4885 Owner tram_owner = GetRoadOwner(tile, RoadTramType::Tram);
4886 if (tram_owner != OWNER_NONE) {
4887 ret = CheckOwnership(tram_owner);
4888 if (ret.Failed()) return ret;
4889 }
4890 }
4891
4892 if (GetRoadTypeRoad(tile) != INVALID_ROADTYPE) {
4893 Owner road_owner = GetRoadOwner(tile, RoadTramType::Road);
4894 if (road_owner == OWNER_TOWN) {
4896 if (ret.Failed()) return ret;
4897 } else if (road_owner != OWNER_NONE) {
4898 ret = CheckOwnership(road_owner);
4899 if (ret.Failed()) return ret;
4900 }
4901 }
4902
4903 return CommandCost();
4904}
4905
4908{
4909 if (flags.Test(DoCommandFlag::Auto)) {
4910 switch (GetStationType(tile)) {
4911 default: break;
4912 case StationType::Rail: return CommandCost(STR_ERROR_MUST_DEMOLISH_RAILROAD);
4913 case StationType::RailWaypoint: return CommandCost(STR_ERROR_BUILDING_MUST_BE_DEMOLISHED);
4914 case StationType::Airport: return CommandCost(STR_ERROR_MUST_DEMOLISH_AIRPORT_FIRST);
4915 case StationType::Truck: return CommandCost(HasTileRoadType(tile, RoadTramType::Tram) ? STR_ERROR_MUST_DEMOLISH_CARGO_TRAM_STATION_FIRST : STR_ERROR_MUST_DEMOLISH_TRUCK_STATION_FIRST);
4916 case StationType::Bus: return CommandCost(HasTileRoadType(tile, RoadTramType::Tram) ? STR_ERROR_MUST_DEMOLISH_PASSENGER_TRAM_STATION_FIRST : STR_ERROR_MUST_DEMOLISH_BUS_STATION_FIRST);
4917 case StationType::RoadWaypoint: return CommandCost(STR_ERROR_BUILDING_MUST_BE_DEMOLISHED);
4918 case StationType::Buoy: return CommandCost(STR_ERROR_BUOY_IN_THE_WAY);
4919 case StationType::Dock: return CommandCost(STR_ERROR_MUST_DEMOLISH_DOCK_FIRST);
4921 return CommandCostWithParam(STR_ERROR_GENERIC_OBJECT_IN_THE_WAY, STR_INDUSTRY_NAME_OIL_RIG);
4922 }
4923 }
4924
4925 switch (GetStationType(tile)) {
4926 case StationType::Rail: return RemoveRailStation(tile, flags);
4927 case StationType::RailWaypoint: return RemoveRailWaypoint(tile, flags);
4928 case StationType::Airport: return RemoveAirport(tile, flags);
4929 case StationType::Truck: [[fallthrough]];
4930 case StationType::Bus:
4931 if (IsDriveThroughStopTile(tile)) {
4932 CommandCost remove_road = CanRemoveRoadWithStop(tile, flags);
4933 if (remove_road.Failed()) return remove_road;
4934 }
4935 return RemoveRoadStop(tile, flags);
4937 CommandCost remove_road = CanRemoveRoadWithStop(tile, flags);
4938 if (remove_road.Failed()) return remove_road;
4939 return RemoveRoadWaypointStop(tile, flags);
4940 }
4941 case StationType::Buoy: return RemoveBuoy(tile, flags);
4942 case StationType::Dock: return RemoveDock(tile, flags);
4943 default: break;
4944 }
4945
4946 return CMD_ERROR;
4947}
4948
4950static CommandCost TerraformTile_Station(TileIndex tile, DoCommandFlags flags, int z_new, Slope tileh_new)
4951{
4952 if (_settings_game.construction.build_on_slopes && AutoslopeEnabled()) {
4953 /* TODO: If you implement newgrf callback 149 'land slope check', you have to decide what to do with it here.
4954 * TTDP does not call it.
4955 */
4956 if (GetTileMaxZ(tile) == z_new + GetSlopeMaxZ(tileh_new)) {
4957 switch (GetStationType(tile)) {
4959 case StationType::Rail: {
4960 if (!AutoslopeCheckForAxis(tile, z_new, tileh_new, GetRailStationAxis(tile))) break;
4962 }
4963
4966
4967 case StationType::Truck:
4968 case StationType::Bus:
4970 if (IsDriveThroughStopTile(tile)) {
4971 if (!AutoslopeCheckForAxis(tile, z_new, tileh_new, GetDriveThroughStopAxis(tile))) break;
4972 } else {
4973 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, GetBayRoadStopDir(tile))) break;
4974 }
4976 }
4977
4978 default: break;
4979 }
4980 }
4981 }
4982 return Command<Commands::LandscapeClear>::Do(flags, tile);
4983}
4984
4990uint FlowStat::GetShare(StationID st) const
4991{
4992 uint32_t prev = 0;
4993 for (const auto &it : this->shares) {
4994 if (it.second == st) {
4995 return it.first - prev;
4996 } else {
4997 prev = it.first;
4998 }
4999 }
5000 return 0;
5001}
5002
5009StationID FlowStat::GetVia(StationID excluded, StationID excluded2) const
5010{
5011 if (this->unrestricted == 0) return StationID::Invalid();
5012 assert(!this->shares.empty());
5013 SharesMap::const_iterator it = this->shares.upper_bound(RandomRange(this->unrestricted));
5014 assert(it != this->shares.end() && it->first <= this->unrestricted);
5015 if (it->second != excluded && it->second != excluded2) return it->second;
5016
5017 /* We've hit one of the excluded stations.
5018 * Draw another share, from outside its range. */
5019
5020 uint end = it->first;
5021 uint begin = (it == this->shares.begin() ? 0 : (--it)->first);
5022 uint interval = end - begin;
5023 if (interval >= this->unrestricted) return StationID::Invalid(); // Only one station in the map.
5024 uint new_max = this->unrestricted - interval;
5025 uint rand = RandomRange(new_max);
5026 SharesMap::const_iterator it2 = (rand < begin) ? this->shares.upper_bound(rand) :
5027 this->shares.upper_bound(rand + interval);
5028 assert(it2 != this->shares.end() && it2->first <= this->unrestricted);
5029 if (it2->second != excluded && it2->second != excluded2) return it2->second;
5030
5031 /* We've hit the second excluded station.
5032 * Same as before, only a bit more complicated. */
5033
5034 uint end2 = it2->first;
5035 uint begin2 = (it2 == this->shares.begin() ? 0 : (--it2)->first);
5036 uint interval2 = end2 - begin2;
5037 if (interval2 >= new_max) return StationID::Invalid(); // Only the two excluded stations in the map.
5038 new_max -= interval2;
5039 if (begin > begin2) {
5040 std::swap(begin, begin2);
5041 std::swap(end, end2);
5042 std::swap(interval, interval2);
5043 }
5044 rand = RandomRange(new_max);
5045 SharesMap::const_iterator it3 = this->shares.upper_bound(this->unrestricted);
5046 if (rand < begin) {
5047 it3 = this->shares.upper_bound(rand);
5048 } else if (rand < begin2 - interval) {
5049 it3 = this->shares.upper_bound(rand + interval);
5050 } else {
5051 it3 = this->shares.upper_bound(rand + interval + interval2);
5052 }
5053 assert(it3 != this->shares.end() && it3->first <= this->unrestricted);
5054 return it3->second;
5055}
5056
5063{
5064 assert(!this->shares.empty());
5065 SharesMap new_shares;
5066 uint i = 0;
5067 for (const auto &it : this->shares) {
5068 new_shares[++i] = it.second;
5069 if (it.first == this->unrestricted) this->unrestricted = i;
5070 }
5071 this->shares.swap(new_shares);
5072 assert(!this->shares.empty() && this->unrestricted <= (--this->shares.end())->first);
5073}
5074
5081void FlowStat::ChangeShare(StationID st, int flow)
5082{
5083 /* We assert only before changing as afterwards the shares can actually
5084 * be empty. In that case the whole flow stat must be deleted then. */
5085 assert(!this->shares.empty());
5086
5087 uint removed_shares = 0;
5088 uint added_shares = 0;
5089 uint last_share = 0;
5090 SharesMap new_shares;
5091 for (const auto &it : this->shares) {
5092 if (it.second == st) {
5093 if (flow < 0) {
5094 uint share = it.first - last_share;
5095 if (flow == INT_MIN || (uint)(-flow) >= share) {
5096 removed_shares += share;
5097 if (it.first <= this->unrestricted) this->unrestricted -= share;
5098 if (flow != INT_MIN) flow += share;
5099 last_share = it.first;
5100 continue; // remove the whole share
5101 }
5102 removed_shares += (uint)(-flow);
5103 } else {
5104 added_shares += (uint)(flow);
5105 }
5106 if (it.first <= this->unrestricted) this->unrestricted += flow;
5107
5108 /* If we don't continue above the whole flow has been added or
5109 * removed. */
5110 flow = 0;
5111 }
5112 new_shares[it.first + added_shares - removed_shares] = it.second;
5113 last_share = it.first;
5114 }
5115 if (flow > 0) {
5116 new_shares[last_share + (uint)flow] = st;
5117 if (this->unrestricted < last_share) {
5118 this->ReleaseShare(st);
5119 } else {
5120 this->unrestricted += flow;
5121 }
5122 }
5123 this->shares.swap(new_shares);
5124}
5125
5131void FlowStat::RestrictShare(StationID st)
5132{
5133 assert(!this->shares.empty());
5134 uint flow = 0;
5135 uint last_share = 0;
5136 SharesMap new_shares;
5137 for (auto &it : this->shares) {
5138 if (flow == 0) {
5139 if (it.first > this->unrestricted) return; // Not present or already restricted.
5140 if (it.second == st) {
5141 flow = it.first - last_share;
5142 this->unrestricted -= flow;
5143 } else {
5144 new_shares[it.first] = it.second;
5145 }
5146 } else {
5147 new_shares[it.first - flow] = it.second;
5148 }
5149 last_share = it.first;
5150 }
5151 if (flow == 0) return;
5152 new_shares[last_share + flow] = st;
5153 this->shares.swap(new_shares);
5154 assert(!this->shares.empty());
5155}
5156
5162void FlowStat::ReleaseShare(StationID st)
5163{
5164 assert(!this->shares.empty());
5165 uint flow = 0;
5166 uint next_share = 0;
5167 bool found = false;
5168 for (SharesMap::reverse_iterator it(this->shares.rbegin()); it != this->shares.rend(); ++it) {
5169 if (it->first < this->unrestricted) return; // Note: not <= as the share may hit the limit.
5170 if (found) {
5171 flow = next_share - it->first;
5172 this->unrestricted += flow;
5173 break;
5174 } else {
5175 if (it->first == this->unrestricted) return; // !found -> Limit not hit.
5176 if (it->second == st) found = true;
5177 }
5178 next_share = it->first;
5179 }
5180 if (flow == 0) return;
5181 SharesMap new_shares;
5182 new_shares[flow] = st;
5183 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
5184 if (it->second != st) {
5185 new_shares[flow + it->first] = it->second;
5186 } else {
5187 flow = 0;
5188 }
5189 }
5190 this->shares.swap(new_shares);
5191 assert(!this->shares.empty());
5192}
5193
5200{
5201 assert(runtime > 0);
5202 SharesMap new_shares;
5203 uint share = 0;
5204 for (auto i : this->shares) {
5205 share = std::max(share + 1, i.first * 30 / runtime);
5206 new_shares[share] = i.second;
5207 if (this->unrestricted == i.first) this->unrestricted = share;
5208 }
5209 this->shares.swap(new_shares);
5210}
5211
5218void FlowStatMap::AddFlow(StationID origin, StationID via, uint flow)
5219{
5220 FlowStatMap::iterator origin_it = this->find(origin);
5221 if (origin_it == this->end()) {
5222 this->emplace(origin, FlowStat(via, flow));
5223 } else {
5224 origin_it->second.ChangeShare(via, flow);
5225 assert(!origin_it->second.GetShares()->empty());
5226 }
5227}
5228
5237void FlowStatMap::PassOnFlow(StationID origin, StationID via, uint flow)
5238{
5239 FlowStatMap::iterator prev_it = this->find(origin);
5240 if (prev_it == this->end()) {
5241 FlowStat fs(via, flow);
5242 fs.AppendShare(StationID::Invalid(), flow);
5243 this->emplace(origin, fs);
5244 } else {
5245 prev_it->second.ChangeShare(via, flow);
5246 prev_it->second.ChangeShare(StationID::Invalid(), flow);
5247 assert(!prev_it->second.GetShares()->empty());
5248 }
5249}
5250
5256{
5257 for (auto &i : *this) {
5258 FlowStat &fs = i.second;
5259 uint local = fs.GetShare(StationID::Invalid());
5260 if (local > INT_MAX) { // make sure it fits in an int
5261 fs.ChangeShare(self, -INT_MAX);
5262 fs.ChangeShare(StationID::Invalid(), -INT_MAX);
5263 local -= INT_MAX;
5264 }
5265 fs.ChangeShare(self, -(int)local);
5266 fs.ChangeShare(StationID::Invalid(), -(int)local);
5267
5268 /* If the local share is used up there must be a share for some
5269 * remote station. */
5270 assert(!fs.GetShares()->empty());
5271 }
5272}
5273
5280std::vector<StationID> FlowStatMap::DeleteFlows(StationID via)
5281{
5282 std::vector<StationID> ret;
5283 for (FlowStatMap::iterator f_it = this->begin(); f_it != this->end();) {
5284 FlowStat &s_flows = f_it->second;
5285 s_flows.ChangeShare(via, INT_MIN);
5286 if (s_flows.GetShares()->empty()) {
5287 ret.push_back(f_it->first);
5288 this->erase(f_it++);
5289 } else {
5290 ++f_it;
5291 }
5292 }
5293 return ret;
5294}
5295
5301{
5302 for (auto &it : *this) {
5303 it.second.RestrictShare(via);
5304 }
5305}
5306
5311void FlowStatMap::ReleaseFlows(StationID via)
5312{
5313 for (auto &it : *this) {
5314 it.second.ReleaseShare(via);
5315 }
5316}
5317
5323{
5324 uint ret = 0;
5325 for (const auto &it : *this) {
5326 ret += (--(it.second.GetShares()->end()))->first;
5327 }
5328 return ret;
5329}
5330
5336uint FlowStatMap::GetFlowVia(StationID via) const
5337{
5338 uint ret = 0;
5339 for (const auto &it : *this) {
5340 ret += it.second.GetShare(via);
5341 }
5342 return ret;
5343}
5344
5350uint FlowStatMap::GetFlowFrom(StationID from) const
5351{
5352 FlowStatMap::const_iterator i = this->find(from);
5353 if (i == this->end()) return 0;
5354 return (--(i->second.GetShares()->end()))->first;
5355}
5356
5363uint FlowStatMap::GetFlowFromVia(StationID from, StationID via) const
5364{
5365 FlowStatMap::const_iterator i = this->find(from);
5366 if (i == this->end()) return 0;
5367 return i->second.GetShare(via);
5368}
5369
5371static CommandCost CheckBuildAbove_Station(TileIndex tile, [[maybe_unused]] DoCommandFlags flags, [[maybe_unused]] Axis axis, int height)
5372{
5373 StationType type = GetStationType(tile);
5374 auto bridgeable_info = GetStationBridgeableTileInfo(type);
5375
5376 switch (type) {
5377 case StationType::Rail:
5379 if (const StationSpec *spec = GetStationSpec(tile); spec != nullptr) bridgeable_info = spec->bridgeable_info;
5380 break;
5381
5382 case StationType::Bus:
5383 case StationType::Truck:
5385 if (const RoadStopSpec *spec = GetRoadStopSpec(tile); spec != nullptr) bridgeable_info = spec->bridgeable_info;
5386 break;
5387
5388 default: break;
5389 }
5390
5391 return IsStationBridgeAboveOk(tile, bridgeable_info, type, GetStationGfx(tile), height);
5392}
5393
5395extern const TileTypeProcs _tile_type_station_procs = {
5396 .draw_tile_proc = DrawTile_Station,
5397 .get_slope_pixel_z_proc = [](TileIndex tile, uint, uint, bool) { return GetTileMaxPixelZ(tile); },
5398 .clear_tile_proc = ClearTile_Station,
5399 .get_tile_desc_proc = GetTileDesc_Station,
5400 .get_tile_track_status_proc = GetTileTrackStatus_Station,
5401 .click_tile_proc = ClickTile_Station,
5402 .animate_tile_proc = AnimateTile_Station,
5403 .tile_loop_proc = TileLoop_Station,
5404 .change_tile_owner_proc = ChangeTileOwner_Station,
5405 .vehicle_enter_tile_proc = VehicleEnterTile_Station,
5406 .get_foundation_proc = [](TileIndex, Slope tileh) { return FlatteningFoundation(tileh); },
5407 .terraform_tile_proc = TerraformTile_Station,
5408 .check_build_above_proc = CheckBuildAbove_Station,
5409};
Base for aircraft.
void UpdateAirplanesOnNewStation(const Station *st)
Updates the status of the Aircraft heading or in the station.
const AirportFTAClass * GetAirport(const uint8_t airport_type)
Get the finite state machine of an airport type.
Definition airport.cpp:188
static const uint INVALID_AIRPORTTILE
id for an invalid airport tile
Definition airport.h:25
static const uint NEW_AIRPORTTILE_OFFSET
offset of first newgrf airport tile
Definition airport.h:24
@ AirportClosed
Dummy block for indicating a closed airport.
Definition airport.h:131
@ FLYING
Vehicle is flying in the air.
Definition airport.h:78
@ NUM_AIRPORTS
Maximal number of airports in total.
Definition airport.h:41
@ AT_OILRIG
Oilrig airport.
Definition airport.h:38
Enum of the default airport tiles.
void AddAnimatedTile(TileIndex tile, bool mark_dirty)
Add the given tile to the animated tile table (if it does not exist yet).
void DeleteAnimatedTile(TileIndex tile, bool immediate)
Stops animation on the given tile.
Tile animation!
Functions related to autoslope.
bool AutoslopeCheckForAxis(TileIndex tile, int z_new, Slope tileh_new, Axis axis)
Autoslope check for tiles with something built along an axis.
Definition autoslope.h:51
bool AutoslopeCheckForEntranceEdge(TileIndex tile, int z_new, Slope tileh_new, DiagDirection entrance)
Autoslope check for tiles with an entrance on an edge.
Definition autoslope.h:31
bool AutoslopeEnabled()
Tests if autoslope is enabled for _current_company.
Definition autoslope.h:65
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 T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
constexpr uint8_t FindFirstBit(T x)
Search the first set bit in a value.
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
void DrawBridgeMiddle(const TileInfo *ti, BridgePillarFlags blocked_pillars)
Draw the middle bits of a bridge.
TileIndex GetSouthernBridgeEnd(TileIndex t)
Finds the southern end of a bridge starting at a middle tile.
int GetBridgeHeight(TileIndex t)
Get the height ('z') of a bridge.
Map accessor functions for bridges.
bool IsBridgeAbove(Tile t)
checks if a bridge is set above the ground of this tile
Definition bridge_map.h:45
EnumBitSet< BridgePillarFlag, uint8_t > BridgePillarFlags
Bitset of BridgePillarFlag elements.
Definition bridge_type.h:53
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
Definition cargo_type.h:110
EnumBitSet< CargoType, uint64_t > CargoTypes
Bitset of CargoType elements.
Definition cargo_type.h:113
static constexpr CargoType NUM_CARGO
Maximum number of cargo types in a game.
Definition cargo_type.h:75
CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:22
@ Passengers
Passengers.
Definition cargotype.h:51
bool IsCargoInClass(CargoType cargo, CargoClasses cc)
Does cargo c have cargo class cc?
Definition cargotype.h:238
Cheats _cheats
All the cheats.
Definition cheat.cpp:16
Types related to cheating.
Iterator to iterate over all tiles belonging to an airport.
Iterator to iterate over all tiles belonging to an airport spec.
uint Count() const
Count the number of set bits.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Tstorage base() const noexcept
Retrieve the raw value behind this bit set.
constexpr bool None() const
Test if none of the values are set.
constexpr Timpl & Flip()
Flip all bits.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Set()
Set all bits.
constexpr bool Any(const Timpl &other) const
Test if any of the given values are set.
Iterator to iterate over all tiles belonging to a bitmaptilearea.
Common return value for all commands.
bool Succeeded() const
Did this command succeed?
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Money GetCost() const
The costs as made up to this moment.
bool Failed() const
Did this command fail?
Iterate a range of enum values.
Flat set implementation that uses a sorted vector for storage.
std::pair< const_iterator, bool > insert(const Tkey &key)
Insert a key into the set, if it does not already exist.
uint GetFlow() const
Get the sum of all flows from this FlowStatMap.
void PassOnFlow(StationID origin, StationID via, uint amount)
Pass on some flow, remembering it as invalid, for later subtraction from locally consumed flow.
std::vector< StationID > DeleteFlows(StationID via)
Delete all flows at a station for specific cargo and destination.
void AddFlow(StationID origin, StationID via, uint amount)
Add some flow from "origin", going via "via".
uint GetFlowFrom(StationID from) const
Get the sum of flows from a specific station from this FlowStatMap.
void FinalizeLocalConsumption(StationID self)
Subtract invalid flows from locally consumed flow.
void ReleaseFlows(StationID via)
Release all flows at a station for specific cargo and destination.
uint GetFlowFromVia(StationID from, StationID via) const
Get the flow from a specific station via a specific other station.
uint GetFlowVia(StationID via) const
Get the sum of flows via a specific station from this FlowStatMap.
void RestrictFlows(StationID via)
Restrict all flows at a station for specific cargo and destination.
Flow statistics telling how much flow should be sent along a link.
static const SharesMap empty_sharesmap
Static instance of FlowStat::SharesMap.
void ScaleToMonthly(uint runtime)
Scale all shares from link graph's runtime to monthly values.
void RestrictShare(StationID st)
Restrict a flow by moving it to the end of the map and decreasing the amount of unrestricted flow.
uint GetShare(StationID st) const
Get flow for a station.
StationID GetVia() const
Get a station a package can be routed to.
const SharesMap * GetShares() const
Get the actual shares as a const pointer so that they can be iterated over.
SharesMap shares
Shares of flow to be sent via specified station (or consumed locally).
void ReleaseShare(StationID st)
Release ("unrestrict") a flow by moving it to the begin of the map and increasing the amount of unres...
void ChangeShare(StationID st, int flow)
Change share for specified station.
void AppendShare(StationID st, uint flow, bool restricted=false)
Add some flow to the end of the shares map.
void Invalidate()
Reduce all flows to minimum capacity so that they don't get in the way of link usage statistics too m...
uint unrestricted
Limit for unrestricted shares.
An interval timer will fire every interval, and will continue to fire until it is deleted.
Definition timer.h:76
void Insert(const T &element)
Insert a single element in the tree.
Definition kdtree.hpp:452
static LinkGraphSchedule instance
Static instance of LinkGraphSchedule.
void Queue(LinkGraph *lg)
Queue a link graph for execution.
A connected component of a link graph.
Definition linkgraph.h:37
void Merge(LinkGraph *other)
Merge a link graph with another one.
Definition linkgraph.cpp:91
TimerGameEconomy::Date LastCompression() const
Get date of last compression.
Definition linkgraph.h:240
NodeID AddNode(const Station *st)
Add a node to the component and create empty edges associated with it.
NodeID Size() const
Get the current size of the component.
Definition linkgraph.h:234
static const uint MIN_TIMEOUT_DISTANCE
Minimum effective distance for timeout calculation.
Definition linkgraph.h:174
static constexpr TimerGameEconomy::Date STALE_LINK_DEPOT_TIMEOUT
Number of days before deleting links served only by vehicles stopped in depot.
Definition linkgraph.h:177
static constexpr TimerGameEconomy::Date COMPRESSION_INTERVAL
Minimum number of days between subsequent compressions of a LG.
Definition linkgraph.h:180
static void Run(Vehicle *v, bool allow_merge=true, bool is_full_loading=false)
Refresh all links the given vehicle will visit.
Definition refresh.cpp:26
const Tspec * GetSpec(uint index) const
Get a spec from the class at a given index.
uint GetSpecCount() const
Get the number of allocated specs within the class.
static NewGRFClass * Get(StationClassID class_index)
StringID name
Name of this class.
const RailStationTileLayout & stl
Station tile layout being iterated.
uint position
Position within iterator.
StationGfx operator*() const
Dereference operator.
uint length
Length of platforms.
std::span< const StationGfx > layout
Predefined tile layout.
This struct contains all the info that is needed to draw and construct tracks.
Definition rail.h:117
SpriteID single_x
single piece of rail in X direction, without ground
Definition rail.h:127
uint16_t max_speed
Maximum speed for vehicles travelling on this rail type.
Definition rail.h:222
struct RailTypeInfo::@157247141350136173143103254227157213063052244122 strings
Strings associated with the rail type.
SpriteID single_y
single piece of rail in Y direction, without ground
Definition rail.h:128
StringID name
Name of this rail type.
Definition rail.h:167
uint8_t fallback_railtype
Original railtype number to use when drawing non-newgrf railtypes, or when drawing stations.
Definition rail.h:192
uint GetRailtypeSpriteOffset() const
Offset between the current railtype and normal rail.
Definition rail.h:289
struct RailTypeInfo::@332027037331076264023214171276243307073252216167 base_sprites
Struct containing the main sprites.
uint16_t max_speed
Maximum speed for vehicles travelling on this road type.
Definition road.h:118
struct RoadTypeInfo::@070000167274302256150317022075324310363002361255 strings
Strings associated with the rail type.
StringID name
Name of this rail type.
Definition road.h:79
Generate TileIndices around a center tile or tile area, with increasing distance.
Add dynamic register values to a sprite layout.
DrawTileSpriteSpan GetLayout() const
Returns the result spritelayout after preprocessing.
uint Reroute(uint max_move, StationCargoList *dest, StationID avoid, StationID avoid2, const GoodsEntry *ge)
Routes packets with station "avoid" as next hop to a different place.
void Append(CargoPacket *cp, StationID next)
Appends the given cargo packet to the range of packets with the same next station.
uint Truncate(uint max_move=UINT_MAX, StationCargoAmountMap *cargo_per_source=nullptr)
Truncates where each destination loses roughly the same percentage of its cargo.
const StationList & GetStations()
Run a tile loop to find stations around a tile, on demand.
static constexpr TimerGameTick::Ticks STATION_LINKGRAPH_TICKS
Cycle duration for cleaning dead links.
static constexpr TimerGameTick::Ticks STATION_ACCEPTANCE_TICKS
Cycle duration for updating station acceptance.
static constexpr TimerGameTick::Ticks STATION_RATING_TICKS
Cycle duration for updating station rating.
Base class for tile iterators.
Wrapper class to abstract away the way the tiles are stored.
Definition map_func.h:25
static Date date
Current date in days (day counter).
static constexpr TimerGame< struct Economy >::Date INVALID_DATE
static Date date
Current date in days (day counter).
static TickCounter counter
Monotonic counter, in ticks, since start of game.
StrongType::Typedef< int32_t, DateTag< struct Economy >, StrongType::Compare, StrongType::Integer > Date
Iterate over all vehicles on a tile.
void DrawClearLandTile(const TileInfo *ti, uint8_t density)
Draw a ClearGround::Grass tile.
Definition clear_cmd.cpp:61
Functions related to clear (TileType::Clear) land.
CommandCost CommandCostWithParam(StringID str, uint64_t value)
Return an error status, with string and parameter.
Definition command.cpp:416
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Auto
don't allow building on structures
@ Execute
execute the given command
@ Bankrupt
company bankrupts, skip money check, skip vehicle on tile check in some cases
Commands
List of commands.
EnumBitSet< DoCommandFlag, uint16_t > DoCommandFlags
Bitset of DoCommandFlag elements.
Definition of stuff that is very close to a company, like the company struct itself.
PaletteID GetCompanyPalette(CompanyID company)
Get the palette for recolouring with a company colour.
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
CompanyID _current_company
Company currently doing an action.
void DirtyCompanyInfrastructureWindows(CompanyID company)
Redraw all windows with company infrastructure counts.
GUI Functions related to companies.
static constexpr Owner OWNER_END
Last + 1 owner.
static constexpr Owner OWNER_TOWN
A town owns the tile, or a town is expanding.
static constexpr Owner OWNER_NONE
The tile has no ownership.
static constexpr Owner INVALID_OWNER
An invalid owner.
static constexpr Owner OWNER_WATER
The tile/execution is done by "water".
Some simple functions to help with accessing containers.
bool include(Container &container, typename Container::const_reference &item)
Helper function to append an item to a container if it is not already contained.
Functions related to debugging.
#define Debug(category, level, format_string,...)
Output a line of debugging information.
Definition debug.h:37
bool CanBuildDepotByTileh(DiagDirection direction, Slope tileh)
Find out if the slope of the tile is suitable to build a depot of given direction.
Definition depot_func.h:27
void ShowDepotWindow(TileIndex tile, VehicleType type)
Opens a depot window.
bool IsValidAxis(Axis d)
Checks if an integer value is a valid Axis.
DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
DiagDirections AxisToDiagDirs(Axis a)
Converts an Axis to DiagDirections.
bool IsValidDiagDirection(DiagDirection d)
Checks if an integer value is a valid DiagDirection.
DiagDirection AxisToDiagDir(Axis a)
Converts an Axis to a DiagDirection.
Axis OtherAxis(Axis a)
Select the other axis as provided.
Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
DiagDirection DirToDiagDir(Direction dir)
Convert a Direction to a DiagDirection.
EnumIndexArray< T, DiagDirection, DiagDirection::End > DiagDirectionIndexArray
Array with DiagDirection as index.
Direction
Defines the 8 directions on the map.
Axis
Enumeration for the two axis X and Y.
@ X
The X axis.
DiagDirection
Enumeration for diagonal directions.
@ Invalid
Flag for an invalid DiagDirection.
@ SW
Southwest.
@ End
Used for iterations.
@ SE
Southeast.
EnumBitSet< DiagDirection, uint8_t > DiagDirections
Bitset of DiagDirection elements.
Prices _price
Prices and also the fractional part.
Definition economy.cpp:106
static const uint ROAD_STOP_TRACKBIT_FACTOR
Multiplier for how many regular track bits a bay stop counts.
@ Construction
Construction costs.
Price
Enumeration of all base prices for use with Prices.
@ BuildStationTruck
Price for building lorry stations.
@ ClearStationBus
Price for destroying bus stops.
@ BuildStationBus
Price for building bus stops.
@ ClearStationAirport
Price for destroying airports.
@ ClearStationTruck
Price for destroying lorry stations.
@ BuildStationAirport
Price for building airports.
@ ClearStationDock
Price for destroying docks.
@ ClearStationRail
Price for destroying rail stations.
@ BuildStationRailLength
Additional price for building rail stations dependent on their length.
@ BuildFoundation
Price for building foundation under other constructions e.g. roads, rails, depots,...
@ BuildStationRail
Price for building rail stations.
@ BuildStationDock
Price for building docks.
@ ClearWaypointRail
Price for destroying rail waypoints.
@ ClearRail
Price for destroying rails.
void DrawRailCatenary(const TileInfo *ti)
Draws overhead wires and pylons for electric railways.
Definition elrail.cpp:553
Header file for electrified rail specific functions.
bool HasRailCatenaryDrawn(RailType rt)
Test if we should draw rail catenary.
Definition elrail_func.h:32
#define T
Climate temperate.
Definition engines.h:91
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23).
Definition enum_type.hpp:21
EnumClassIndexContainer< std::array< T, to_underlying(N)>, Index > EnumIndexArray
A typedef for EnumClassIndexContainer using std::array as the backing container type.
Flat set container implementation.
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
Definition gfx.cpp:1037
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
uint32_t PaletteID
The number of the palette.
Definition gfx_type.h:18
uint8_t GetSnowLine()
Get the current snow line, either variable or static.
void MarkTilesDirty(bool cargo_change) const
Marks the tiles of the station as dirty.
Definition station.cpp:250
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
static const SpriteID SPR_RAIL_TRACK_Y
Definition sprites.h:443
static const SpriteID SPR_MONO_TRACK_X_SNOW
Definition sprites.h:490
static const SpriteID SPR_MGLV_TRACK_Y_SNOW
Definition sprites.h:502
static const SpriteID SPR_MONO_TRACK_Y
Definition sprites.h:485
static const SpriteID SPR_MONO_TRACK_Y_SNOW
Definition sprites.h:489
static const SpriteID SPR_MONO_TRACK_X
Definition sprites.h:486
static const SpriteID SPR_RAIL_TRACK_X_SNOW
Definition sprites.h:448
static const SpriteID SPR_MGLV_TRACK_X
Definition sprites.h:500
static const SpriteID SPR_RAIL_TRACK_Y_SNOW
Definition sprites.h:447
static const SpriteID SPR_MGLV_TRACK_X_SNOW
Definition sprites.h:503
static const SpriteID SPR_MGLV_TRACK_Y
Definition sprites.h:499
static const SpriteID SPR_RAIL_TRACK_X
Definition sprites.h:444
HouseZone
Concentric rings of zoning around the centre of a town.
Definition house.h:59
@ TownEdge
Edge of the town; roads without pavement.
Definition house.h:60
Base of all industries.
bool IsTileForestIndustry(TileIndex tile)
Check whether the tile is a forest.
const IndustrySpec * GetIndustrySpec(IndustryType thistype)
Accessor for array _industry_specs.
IndustryType GetIndustryType(Tile tile)
Retrieve the type for this industry.
IndustryID GetIndustryIndex(Tile t)
Get the industry ID of the given tile.
static const IndustryType NUM_INDUSTRYTYPES
total number of industry types, new and old; limited to 240 because we need some special ids like IT_...
@ Extractive
Like mines.
const TileTypeProcs _tile_type_station_procs
TileTypeProcs definitions for TileType::Station tiles.
Definition landscape.cpp:57
void ChangeTileOwner(TileIndex tile, Owner old_owner, Owner new_owner)
Change the owner of a tile.
void DrawFoundation(TileInfo *ti, Foundation f)
Draw foundation f at tile ti.
std::tuple< Slope, int > GetFoundationPixelSlope(TileIndex tile)
Get slope of a tile on top of a (possible) foundation If a tile does not have a foundation,...
Definition landscape.h:67
uint ApplyPixelFoundationToSlope(Foundation f, Slope &s)
Applies a foundation to a slope.
Definition landscape.h:128
Point RemapCoords2(int x, int y)
Map 3D world or tile coordinate to equivalent 2D coordinate as used in the viewports and smallmap.
Definition landscape.h:97
Command definitions related to landscape (slopes etc.).
@ Arctic
Landscape with snow levels.
@ Tropic
Landscape with distinct rainforests and deserts,.
Some typedefs for the main game.
EnumBitSet< EdgeUpdateMode, uint8_t > EdgeUpdateModes
Bitset of EdgeUpdateMode elements.
@ Increase
Increase capacity.
@ Manual
Manual distribution. No link graph calculations are run.
#define Point
Macro that prevents name conflicts between included headers.
uint DistanceFromEdge(TileIndex tile)
Param the minimum distance to an edge.
Definition map.cpp:229
uint DistanceMax(TileIndex t0, TileIndex t1)
Gets the biggest distance component (x or y) between the two given tiles.
Definition map.cpp:201
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
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition map.cpp:169
TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
Return the offset between two tiles from a TileIndexDiffC struct.
Definition map_func.h:444
TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition map_func.h:392
TileIndexDiff TileOffsByAxis(Axis axis)
Convert an Axis to a TileIndexDiff.
Definition map_func.h:559
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
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 bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
constexpr bool IsInsideMM(const size_t x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
constexpr T Clamp(const T a, const T min, const T max)
Clamp a value between an interval.
Definition math_func.hpp:79
constexpr uint ClampU(const uint a, const uint min, const uint max)
Clamp an unsigned integer between an interval.
constexpr To ClampTo(From value)
Clamp the given value down to lie within the requested type.
Types related to the misc widgets.
@ Buoy
Buoy without underlying water.
Definition newgrf.h:36
@ RoadStops
Road stops feature.
Definition newgrf.h:99
@ Stations
Stations feature.
Definition newgrf.h:83
@ Airports
Airports feature.
Definition newgrf.h:92
@ AirportTiles
Airport tiles feature.
Definition newgrf.h:96
uint8_t StationGfx
Copy from station_map.h.
StationGfx GetTranslatedAirportTileID(StationGfx gfx)
Do airporttile gfx ID translation for NewGRFs.
NewGRF handling of airport tiles.
@ NoAnimation
There is no animation.
@ DrawTileLayout
Use callback to select a tile layout to use when drawing.
@ Avail
Availability of station in construction window.
@ SlopeCheck
Check slope of new station tiles.
@ StationRatingCalc
custom station rating for this cargo type
@ CBID_STATION_BUILD_TILE_LAYOUT
Called when building a station to customize the tile layout.
@ CBID_STATION_DRAW_TILE_LAYOUT
Choose a tile layout to draw, instead of the standard range.
@ CBID_CARGO_STATION_RATING_CALC
Called to calculate part of a station rating.
@ CBID_STATION_AVAILABILITY
Determine whether a newstation should be made available to build.
static const uint CALLBACK_FAILED
Different values for Callback result evaluations.
@ Avail
Availability of road stop in construction window.
SpriteID GetCanalSprite(CanalFeature feature, TileIndex tile)
Lookup the base sprite to use for a canal.
Handling of NewGRF canals.
Cargo support for NewGRFs.
bool Convert8bitBooleanCallback(const GRFFile *grffile, uint16_t cbid, uint16_t cb_res)
Converts a callback result into a boolean.
void ErrorUnknownCallbackResult(GrfID grfid, uint16_t cbid, uint16_t cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
GRFConfig * GetGRFConfig(GrfID grfid, uint32_t mask)
Retrieve a NewGRF from the current config by its grfid.
@ Any
Use first found.
Functions/types related to NewGRF debugging.
void DeleteNewGRFInspectWindow(GrfSpecFeature feature, uint index)
Delete inspect window for a given feature and index.
void TriggerHouseAnimation_WatchedCargoAccepted(TileIndex tile, CargoTypes trigger_cargoes)
Run watched cargo accepted callback for a house.
Functions related to NewGRF houses.
SpriteID GetCustomRailSprite(const RailTypeInfo *rti, TileIndex tile, RailSpriteType rtsg, TileContext context, uint *num_results)
Get the sprite to draw for the given tile.
NewGRF handling of rail types.
void TriggerRoadStopRandomisation(BaseStation *st, TileIndex tile, StationRandomTrigger trigger, CargoType cargo_type)
Trigger road stop randomisation.
void DeallocateSpecFromRoadStop(BaseStation *st, uint8_t specindex)
Deallocate a RoadStopSpec from a Station.
std::optional< uint8_t > AllocateSpecToRoadStop(const RoadStopSpec *spec, BaseStation *st)
Allocate a RoadStopSpec to a Station.
void AssignSpecToRoadStop(const RoadStopSpec *spec, BaseStation *st, uint8_t specindex)
Assign a previously allocated RoadStopSpec specindex to a Station.
NewGRF definitions and structures for road stops.
@ Overlay
Drive-through stops: Draw the road overlay, e.g. pavement.
@ WaypGround
Waypoints: Draw the sprite layout ground tile (on top of the road).
@ Road
Bay stops: Draw the road itself.
bool IsWaypointClass(const RoadStopClass &cls)
Test if a RoadStopClass is the waypoint class.
PoolID< uint16_t, struct RoadStopClassIDTag, UINT16_MAX, UINT16_MAX > RoadStopClassID
Class IDs for stations.
EnumBitSet< RoadStopDrawMode, uint8_t > RoadStopDrawModes
Bitset of RoadStopDrawMode elements.
@ ROADSTOPTYPE_FREIGHT
This RoadStop is for freight (truck) stops.
@ ROADSTOPTYPE_ALL
This RoadStop is for both types of station road stops.
@ ROADSTOPTYPE_PASSENGER
This RoadStop is for passenger (bus) stops.
@ NoCatenary
Do not show catenary.
@ DriveThroughOnly
Stop is drive-through only.
@ DrawModeRegister
Read draw mode from register 0x100.
SpriteID GetCustomRoadSprite(const RoadTypeInfo *rti, TileIndex tile, RoadSpriteType rtsg, TileContext context, uint *num_results)
Get the sprite to draw for the given tile.
NewGRF handling of road types.
SpriteID GetCustomStationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint32_t var10)
Resolve sprites for drawing a station tile.
SpriteID GetCustomStationFoundationRelocation(const StationSpec *statspec, BaseStation *st, TileIndex tile, uint layout, uint edge_info)
Resolve the sprites for custom station foundations.
void AssignSpecToStation(const StationSpec *spec, BaseStation *st, uint8_t specindex)
Assign a previously allocated StationSpec specindex to a Station.
void DeallocateSpecFromStation(BaseStation *st, uint8_t specindex)
Deallocate a StationSpec from a Station.
void TriggerStationRandomisation(BaseStation *st, TileIndex trigger_tile, StationRandomTrigger trigger, CargoType cargo_type)
Trigger station randomisation.
CommandCost PerformStationTileSlopeCheck(TileIndex north_tile, TileIndex cur_tile, const StationSpec *statspec, Axis axis, uint8_t plat_len, uint8_t numtracks)
Check the slope of a tile of a new station.
uint32_t GetPlatformInfo(StationGfx gfx, int platforms, int length, int platform, int position, bool centred)
Evaluate a tile's position within a station, and return the result in a bit-stuffed format.
std::optional< uint8_t > AllocateSpecToStation(const StationSpec *spec, BaseStation *st)
Allocate a StationSpec to a Station.
Header file for NewGRF stations.
@ CustomFoundations
Draw custom foundations.
@ SeparateGround
Use different sprite set for ground sprites.
@ ExtendedFoundations
Extended foundation block instead of simple.
NewGRFClass< StationSpec, StationClassID > StationClass
Class containing information relating to station classes.
PoolID< uint16_t, struct StationClassIDTag, UINT16_MAX, UINT16_MAX > StationClassID
Class IDs for stations.
Functions related to news.
void AddNewsItem(EncodedString &&headline, NewsType type, NewsStyle style, NewsFlags flags, NewsReference ref1={}, NewsReference ref2={}, std::unique_ptr< NewsAllocatedData > &&data=nullptr, AdviceType advice_type=AdviceType::Invalid)
Add a new newsitem to be shown.
Definition news_gui.cpp:917
@ Acceptance
A type of cargo is (no longer) accepted.
Definition news_type.h:43
@ Small
Small news item. (Information window with text and viewport).
Definition news_type.h:79
@ InColour
News item is shown in colour (otherwise it is shown in black & white).
Definition news_type.h:90
@ LinkGraph
A game paused due to the link graph schedule lagging.
Definition openttd.h:78
@ Editor
In the scenario editor.
Definition openttd.h:21
@ Menu
In the main menu.
Definition openttd.h:19
Functions related to order backups.
Train * GetTrainForReservation(TileIndex tile, Track track)
Find the train which has reserved a specific path.
Definition pbs.cpp:345
void SetRailStationPlatformReservation(TileIndex start, DiagDirection dir, bool b)
Set the reservation for a complete station platform.
Definition pbs.cpp:57
PBS support routines.
bool ValParamRailType(const RailType rail)
Validate functions for rail building.
Definition rail.cpp:92
@ Ground
Main group of ground images.
Definition rail.h:45
@ Overlay
Images for overlaying track.
Definition rail.h:44
Money RailBuildCost(RailType railtype)
Returns the cost of building the specified railtype.
Definition rail.h:431
bool HasPowerOnRail(RailType enginetype, RailType tiletype)
Checks if an engine of the given RailType got power on a tile with a given RailType.
Definition rail.h:379
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition rail.h:303
RailTrackOffset
Offsets for sprites within an overlay/underlay set.
Definition rail.h:63
@ RTO_Y
Piece of rail in Y direction.
Definition rail.h:65
@ RTO_X
Piece of rail in X direction.
Definition rail.h:64
Command definitions for rail.
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
TrackBits GetTrackBits(Tile tile)
Gets the track bits of the given tile.
Definition rail_map.h:136
static bool IsPlainRailTile(Tile t)
Checks whether the tile is a rail tile or rail tile with signals.
Definition rail_map.h:60
void MakeRailNormal(Tile t, Owner o, TrackBits b, RailType r)
Make the given tile a normal rail.
Definition rail_map.h:624
TrackBits GetRailReservationTrackBits(Tile t)
Returns the reserved track bits of the tile.
Definition rail_map.h:194
bool HasSignals(Tile t)
Checks if a rail tile has signals.
Definition rail_map.h:72
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:25
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition rail_type.h:32
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.
Declaration of link refreshing utility.
bool ValParamRoadType(RoadType roadtype)
Validate functions for rail building.
Definition road.cpp:165
bool HasPowerOnRoad(RoadType enginetype, RoadType tiletype)
Checks if an engine of the given RoadType got power on a tile with a given RoadType.
Definition road.h:232
const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition road.h:217
@ Roadstop
Required: Bay stop surface.
Definition road.h:49
@ Ground
Required: Main group of ground images.
Definition road.h:41
@ Overlay
Optional: Images for overlaying track.
Definition road.h:40
Money RoadBuildCost(RoadType roadtype)
Returns the cost of building the specified roadtype.
Definition road.h:242
void DrawRoadGroundSprites(const TileInfo *ti, RoadBits road, RoadBits tram, const RoadTypeInfo *road_rti, const RoadTypeInfo *tram_rti, Roadside roadside, bool snow_or_desert)
Draw road ground sprites.
void DrawRoadCatenary(const TileInfo *ti)
Draws the catenary for the given tile.
void UpdateCompanyRoadInfrastructure(RoadType rt, Owner o, int count)
Update road infrastructure counts for a company.
Definition road_cmd.cpp:183
CommandCost CheckAllowRemoveRoad(TileIndex tile, RoadBits remove, Owner owner, RoadTramType rtt, DoCommandFlags flags, bool town_check)
Is it allowed to remove the given road bits from the given tile?
Definition road_cmd.cpp:255
void DrawRoadOverlays(const TileInfo *ti, PaletteID pal, const RoadTypeInfo *road_rti, const RoadTypeInfo *tram_rti, uint road_offset, uint tram_offset, bool draw_underlay)
Draw road underlay and overlay sprites.
Functions related to roads.
RoadBits AxisToRoadBits(Axis a)
Create the road-part which belongs to the given Axis.
Definition road_func.h:93
Functions used internally by the roads.
bool MayHaveRoad(Tile t)
Test whether a tile can have road/tram types.
Definition road_map.cpp:21
RoadBits GetAnyRoadBits(Tile tile, RoadTramType rtt, bool straight_tunnel_bridge_entrance)
Returns the RoadBits on an arbitrary tile Special behaviour:
Definition road_map.cpp:54
void SetRoadOwner(Tile t, RoadTramType rtt, Owner o)
Set the owner of a specific road type.
Definition road_map.h:261
RoadType GetRoadTypeRoad(Tile t)
Get the road type for RoadTramType being RoadTramType::Road.
Definition road_map.h:152
RoadBits GetRoadBits(Tile t, RoadTramType rtt)
Get the present road bits for a specific road type.
Definition road_map.h:112
DisallowedRoadDirections GetDisallowedRoadDirections(Tile t)
Gets the disallowed directions.
Definition road_map.h:311
bool HasTileRoadType(Tile t, RoadTramType rtt)
Check if a tile has a road or a tram road type.
Definition road_map.h:221
RoadType GetRoadTypeTram(Tile t)
Get the road type for RoadTramType being RoadTramType::Tram.
Definition road_map.h:163
void MakeRoadNormal(Tile t, RoadBits bits, RoadType road_rt, RoadType tram_rt, TownID town, Owner road, Owner tram)
Make a normal road tile.
Definition road_map.h:635
RoadBits GetAllRoadBits(Tile tile)
Get all set RoadBits on the given tile.
Definition road_map.h:125
RoadType GetRoadType(Tile t, RoadTramType rtt)
Get the road type for the given RoadTramType.
Definition road_map.h:175
static bool IsNormalRoadTile(Tile t)
Return whether a tile is a normal road tile.
Definition road_map.h:58
Owner GetRoadOwner(Tile t, RoadTramType rtt)
Get the owner of a specific road type.
Definition road_map.h:244
Roadside
The possible road side decorations.
Definition road_map.h:472
@ Paved
Road with paved sidewalks.
Definition road_map.h:475
@ Barren
Road on barren land.
Definition road_map.h:473
@ Grass
Road on grass.
Definition road_map.h:474
static constexpr RoadBits ROAD_X
Full road along the x-axis (south-west + north-east).
Definition road_type.h:66
EnumBitSet< RoadBit, uint8_t > RoadBits
Bitset of RoadBit elements.
Definition road_type.h:64
static constexpr RoadBits ROAD_Y
Full road along the y-axis (north-west + south-east).
Definition road_type.h:67
static constexpr RoadTramTypes ROADTRAMTYPES_ALL
All possible RoadTramTypes.
Definition road_type.h:48
RoadType
The different roadtypes we support.
Definition road_type.h:23
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
RoadTramType
The different types of road type.
Definition road_type.h:37
@ Tram
Tram type.
Definition road_type.h:39
@ Road
Road type.
Definition road_type.h:38
Base class for roadstops.
Road vehicle states.
@ RVSB_IN_ROAD_STOP
The vehicle is in a road stop.
Definition roadveh.h:49
@ RVSB_ROAD_STOP_TRACKDIR_MASK
Only bits 0 and 3 are used to encode the trackdir for road stops.
Definition roadveh.h:57
@ RVS_IN_DT_ROAD_STOP
The vehicle is in a drive-through road stop.
Definition roadveh.h:46
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
Base for ships.
bool IsShipDestinationTile(TileIndex tile, StationID station)
Test if a tile is a docking tile for the given station.
Definition ship_cmd.cpp:568
void AddTrackToSignalBuffer(TileIndex tile, Track track, Owner owner)
Add track to signal update buffer.
Definition signal.cpp:598
@ Enter
signal entering the block found
Definition signal.cpp:262
static constexpr int GetSlopeMaxZ(Slope s)
Returns the height of the highest corner of a slope relative to TileZ (= minimal height).
Definition slope_func.h:170
static constexpr bool IsSteepSlope(Slope s)
Checks if a slope is steep.
Definition slope_func.h:36
Foundation FlatteningFoundation(Slope s)
Returns the foundation needed to flatten a slope.
Definition slope_func.h:377
DiagDirection GetInclinedSlopeDirection(Slope s)
Returns the direction of an inclined slope.
Definition slope_func.h:249
Slope
Enumeration for the slope-type.
Definition slope_type.h:53
@ SLOPE_FLAT
a flat tile
Definition slope_type.h:54
@ Leveled
The tile is leveled up to a flat slope.
Definition slope_type.h:100
void DrawRailTileSeqInGUI(int x, int y, const DrawTileSprites *dts, int32_t total_offset, uint32_t newgrf_offset, PaletteID default_palette)
Draw tile sprite sequence in GUI with railroad specifics.
Definition sprite.h:122
void DrawRailTileSeq(const struct TileInfo *ti, const DrawTileSprites *dts, TransparencyOption to, int32_t total_offset, uint32_t newgrf_offset, PaletteID default_palette)
Draw tile sprite sequence on tile with railroad specifics.
Definition sprite.h:108
PaletteID GroundSpritePaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
Applies PALETTE_MODIFIER_COLOUR to a palette entry of a ground sprite.
Definition sprite.h:207
static const SpriteID SPR_TRAMWAY_TRAM
Definition sprites.h:303
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition sprites.h:1788
static const SpriteID SPR_FLAT_SNOW_DESERT_TILE
Definition sprites.h:683
static const PaletteID PALETTE_TO_GREY
Definition sprites.h:1772
static const SpriteID SPR_IMG_BUOY
Definition sprites.h:1458
static const SpriteID SPR_FLAT_GRASS_TILE
Definition sprites.h:671
static constexpr uint8_t SPRITE_MODIFIER_CUSTOM_SPRITE
these masks change the colours of the palette for a sprite.
Definition sprites.h:1726
static constexpr uint8_t SPRITE_WIDTH
number of bits for the sprite number
Definition sprites.h:1716
static constexpr uint8_t PALETTE_MODIFIER_COLOUR
this bit is set when a recolouring process is in action
Definition sprites.h:1729
Base classes/functions for stations.
void ForAllStationsAroundTiles(const TileArea &ta, Func func)
Call a function on all stations that have any part of the requested area within their catchment.
static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index=-1)
Remove a bus station/truck stop.
std::tuple< CommandCost, StationID > CmdMoveStationName(DoCommandFlags flags, StationID station_id, TileIndex tile)
Move a station name.
static StringID GetBridgeTooLowMessageForStationType(StationType type)
Get station-type-specific string for a bridge that is too low.
static void GetTileDesc_Station(TileIndex tile, TileDesc &td)
Tile callback function signature for obtaining a tile description.
static CommandCost BuildStationPart(Station **st, DoCommandFlags flags, bool reuse, TileArea area, StationNaming name_class)
Common part of building various station parts and possibly attaching them to an existing one.
static CommandCost RemoveRailWaypoint(TileIndex tile, DoCommandFlags flags)
Remove a rail waypoint.
void CcMoveStationName(Commands, const CommandCost &result, StationID station_id)
Callback function that is called after a name is moved.
CommandCost IsRailStationBridgeAboveOk(TileIndex tile, const StationSpec *spec, StationType type, StationGfx layout)
Test if a rail station can be built below a bridge.
uint8_t GetAirportNoiseLevelForDistance(const AirportSpec *as, uint distance)
Get a possible noise reduction factor based on distance from town center.
static constexpr DiagDirectionIndexArray< uint8_t > _dock_w_chk
X dimension of dock for each direction.
static CommandCost TerraformTile_Station(TileIndex tile, DoCommandFlags flags, int z_new, Slope tileh_new)
Tile callback function signature of the terraforming callback.
CommandCost RemoveFromRailBaseStation(TileArea ta, std::vector< T * > &affected_stations, DoCommandFlags flags, Money removal_cost, bool keep_rail)
Remove a number of tiles from any rail station within the area.
static CommandCost CalculateRailStationCost(TileArea tile_area, DoCommandFlags flags, Axis axis, StationID *station, RailType rt, std::vector< Train * > &affected_vehicles, StationClassID spec_class, uint16_t spec_index, uint8_t plat_len, uint8_t numtracks)
Calculates cost of new rail stations within the area.
static StringID GenerateStationName(Station *st, TileIndex tile, StationNaming name_class)
Generate a station name for the given station at the given location.
CommandCost CanExpandRailStation(const BaseStation *st, TileArea &new_ta)
Check whether we can expand the rail part of the given station.
void ClearDockingTilesCheckingNeighbours(TileIndex tile)
Clear docking tile status from tiles around a removed dock, if the tile has no neighbours which would...
bool(* CMSAMatcher)(TileIndex tile)
Function to check whether the given tile matches some criterion.
CommandCost IsRoadStationBridgeAboveOk(TileIndex tile, const RoadStopSpec *spec, StationType type, StationGfx layout)
Test if a road station can be built below a bridge.
bool IsHangar(Tile t)
Check whether the given tile is a hangar.
static Station * GetClosestDeletedStation(TileIndex tile)
Find the closest deleted station of the current company.
CommandCost CmdRenameStation(DoCommandFlags flags, StationID station_id, const std::string &text)
Rename a station.
std::pair< CargoArray, CargoTypes > GetAcceptanceAroundTiles(TileIndex center_tile, int w, int h, int rad)
Get the acceptance of cargoes around the tile in 1/8.
static CommandCost RemoveAirport(TileIndex tile, DoCommandFlags flags)
Remove an airport.
static void TileLoop_Station(TileIndex tile)
Tile callback function signature for running periodic tile updates.
static bool CMSAMine(TileIndex tile)
Check whether the tile is a mine.
void IncreaseStats(Station *st, CargoType cargo, StationID next_station_id, uint capacity, uint usage, uint32_t time, EdgeUpdateModes modes)
Increase capacity for a link stat given by station cargo and next hop.
static CommandCost CheckFlatLandRoadStop(TileIndex cur_tile, int &allowed_z, const RoadStopSpec *spec, DoCommandFlags flags, DiagDirections invalid_dirs, bool is_drive_through, StationType station_type, Axis axis, StationID *station, RoadType rt)
Checks if a road stop can be built at the given tile.
static CommandCost RemoveGenericRoadStop(DoCommandFlags flags, const TileArea &roadstop_area, bool road_waypoint, bool remove_road)
Remove a tile area of road stop or road waypoints.
static void TruncateCargo(const CargoSpec *cs, GoodsEntry *ge, uint amount=UINT_MAX)
Truncate the cargo by a specific amount.
CommandCost CmdRemoveFromRailWaypoint(DoCommandFlags flags, TileIndex start, TileIndex end, bool keep_rail)
Remove a single tile from a waypoint.
StationNaming
Station types a station could be named after.
@ Dock
Ship dock.
@ Rail
Railway station.
@ Road
Truck or bus stop.
@ Oilrig
Heliport of an oilrig.
@ Heliport
Standalone heliport.
@ Airport
Airport for fixed wing aircraft.
CommandCost FindJoiningWaypoint(StationID existing_waypoint, StationID waypoint_to_join, bool adjacent, TileArea ta, Waypoint **wp, bool is_road)
Find a nearby waypoint that joins this waypoint.
CommandCost CmdBuildDock(DoCommandFlags flags, TileIndex tile, StationID station_to_join, bool adjacent)
Build a dock/haven.
CommandCost IsBuoyBridgeAboveOk(TileIndex tile)
Test if a buoy can be built below a bridge.
static CommandCost CheckFlatLandAirport(AirportTileTableIterator tile_iter, DoCommandFlags flags)
Checks if an airport can be built at the given location and clear the area.
CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index=-1)
Remove a road waypoint.
CommandCost GetStationAround(TileArea ta, StationID closest_station, CompanyID company, T **st, F filter)
Look for a station owned by the given company around the given tile area.
CommandCost CmdRemoveRoadStop(DoCommandFlags flags, TileIndex tile, uint8_t width, uint8_t height, RoadStopType stop_type, bool remove_road)
Remove bus or truck stops.
static VehicleEnterTileStates VehicleEnterTile_Station(Vehicle *v, TileIndex tile, int x, int y)
Tile callback function for a vehicle entering a tile.
static void ChangeTileOwner_Station(TileIndex tile, Owner old_owner, Owner new_owner)
Tile callback function signature for changing the owner of a tile.
bool HasStationInUse(StationID station, bool include_company, CompanyID company)
Tests whether the company's vehicles have this station in orders.
static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)
Counts the numbers of tiles matching a specific type in the area around.
CommandCost CmdBuildRoadStop(DoCommandFlags flags, TileIndex tile, uint8_t width, uint8_t length, RoadStopType stop_type, bool is_drive_through, DiagDirection ddir, RoadType rt, RoadStopClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
Build a bus or truck stop.
static StationSpec::TileFlags GetStationTileFlags(StationGfx gfx, const StationSpec *statspec)
Get station tile flags for the given StationGfx.
static CommandCost IsDockBridgeAboveOk(TileIndex tile, StationGfx layout)
Test if a dock can be built below a bridge.
static bool DrawCustomStationFoundations(const StationSpec *statspec, BaseStation *st, TileInfo *ti, StationGfx gfx)
Draw custom station foundations for a NewGRF station if provided.
const DrawTileSprites * GetStationTileLayout(StationType st, uint8_t gfx)
Get station tile layout for a station type and its station gfx.
CommandCost CmdRemoveFromRoadWaypoint(DoCommandFlags flags, TileIndex start, TileIndex end)
Remove road waypoints.
void RerouteCargo(Station *st, CargoType cargo, StationID avoid, StationID avoid2)
Reroute cargo of type c at station st or in any vehicles unloading there.
static constexpr DiagDirectionIndexArray< TileIndexDiffC > _dock_tileoffs_chkaround
Offset of northern-most dock tile for each direction.
CommandCost ClearTile_Station(TileIndex tile, DoCommandFlags flags)
Tile callback function signature for clearing a tile.
static std::pair< CargoArray, CargoTypes > GetAcceptanceAroundStation(const Station *st)
Get the acceptance of cargoes around the station in.
static void UpdateStationRating(Station *st)
Periodic update of a station's rating.
static TrackStatus GetTileTrackStatus_Station(TileIndex tile, TransportType mode, RoadTramType sub_mode, DiagDirection side)
Tile callback function signature for getting the possible tracks that can be taken on a given tile by...
void UpdateAllStationVirtCoords()
Update the virtual coords needed to draw the station sign for all stations.
static void DrawTile_Station(TileInfo *ti)
Tile callback function signature for drawing a tile and its contents to the screen.
static bool CMSAWater(TileIndex tile)
Check whether the tile is water.
CommandCost CmdBuildAirport(DoCommandFlags flags, TileIndex tile, uint8_t airport_type, uint8_t layout, StationID station_to_join, bool allow_adjacent)
Place an Airport.
void TriggerWatchedCargoCallbacks(Station *st)
Run the watched cargo callback for all houses in the catchment area.
static CommandCost CanRemoveRoadWithStop(TileIndex tile, DoCommandFlags flags)
Check if a drive-through road stop tile can be cleared.
static RoadStop ** FindRoadStopSpot(bool truck_station, Station *st)
CargoTypes GetAcceptanceMask(const Station *st)
Get a mask of the cargo types that the station accepts.
static void RestoreTrainReservation(Train *v)
Restore platform reservation during station building/removing.
void UpdateAirportsNoise()
Recalculate the noise generated by the airports of each town.
static std::span< const BridgeableTileInfo > GetStationBridgeableTileInfo(StationType type)
Get bridgeable tile information for a station type.
static bool CMSATree(TileIndex tile)
Check whether the tile is a tree.
void ModifyStationRatingAround(TileIndex tile, Owner owner, int amount, uint radius)
Forcibly modify station ratings near a given tile.
CommandCost RemoveRailStation(T *st, DoCommandFlags flags, Money removal_cost)
Remove a rail station/waypoint.
void UpdateStationAcceptance(Station *st, bool show_msg)
Update the acceptance for a station.
static CommandCost FindJoiningRoadStop(StationID existing_stop, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
Find a nearby station that joins this road stop.
CommandCost CmdOpenCloseAirport(DoCommandFlags flags, StationID station_id)
Open/close an airport to incoming aircraft.
static const IntervalTimer< TimerGameEconomy > _economy_stations_monthly({TimerGameEconomy::Trigger::Month, TimerGameEconomy::Priority::Station}, [](auto) { for(Station *st :Station::Iterate()) { for(GoodsEntry &ge :st->goods) { ge.status.Set(GoodsEntry::State::LastMonth, ge.status.Test(GoodsEntry::State::CurrentMonth));ge.status.Reset(GoodsEntry::State::CurrentMonth);} } })
Economy monthly loop for stations.
static CommandCost CheckFlatLandRailStation(TileIndex tile_cur, TileIndex north_tile, int &allowed_z, DoCommandFlags flags, Axis axis, StationID *station, RailType rt, std::vector< Train * > &affected_vehicles, StationClassID spec_class, uint16_t spec_index, uint8_t plat_len, uint8_t numtracks)
Checks if a rail station can be built at the given tile.
static TileIndex FindDockLandPart(TileIndex t)
Find the part of a dock that is land-based.
static CommandCost CheckBuildAbove_Station(TileIndex tile, DoCommandFlags flags, Axis axis, int height)
Tile callback function signature to test if a bridge can be built above a tile.
static void FreeTrainReservation(Train *v)
Clear platform reservation during station building/removing.
static bool ClickTile_Station(TileIndex tile)
Tile callback function signature for clicking a tile.
void SetRailStationTileFlags(TileIndex tile, const StationSpec *statspec)
Set rail station tile flags for the given tile.
CommandCost CalculateRoadStopCost(TileArea tile_area, DoCommandFlags flags, bool is_drive_through, StationType station_type, const RoadStopSpec *roadstopspec, Axis axis, DiagDirection ddir, StationID *station, RoadType rt, Money unit_cost)
Calculates cost of new road stops within the area.
CargoTypes GetCargoWaitingMask(const Station *st)
Get a mask of the cargo types that have cargo waiting at the station.
static CommandCost RemoveDock(TileIndex tile, DoCommandFlags flags)
Remove a dock.
static void AnimateTile_Station(TileIndex tile)
Tile callback function signature for animating a tile.
bool SplitGroundSpriteForOverlay(const TileInfo *ti, SpriteID *ground, RailTrackOffset *overlay_offset)
Check whether a sprite is a track sprite, which can be replaced by a non-track ground sprite and a ra...
CargoArray GetProductionAroundTiles(TileIndex north_tile, int w, int h, int rad)
Get the cargo types being produced around the tile (in a rectangle).
CommandCost CmdRemoveFromRailStation(DoCommandFlags flags, TileIndex start, TileIndex end, bool keep_rail)
Remove a single tile from a rail station.
static CommandCost FindJoiningStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
Find a nearby station that joins this station.
void DeleteStaleLinks(Station *from)
Check all next hops of cargo packets in this station for existence of a a valid link they may use to ...
static BridgePillarFlags GetStationBlockedPillars(std::span< const BridgeableTileInfo > bridgeable_info, uint8_t layout)
Get blocked pillar information for a station tile.
CommandCost CheckBuildableTile(TileIndex tile, DiagDirections invalid_dirs, int &allowed_z, bool allow_steep, bool check_bridge=true)
Checks if the given tile is buildable, flat and has a certain height.
static constexpr DiagDirectionIndexArray< uint8_t > _dock_h_chk
Y dimension of dock for each direction.
CommandCost FindJoiningBaseStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, T **st, F filter)
Find a nearby station that joins this station.
Town * AirportGetNearestTown(const AirportSpec *as, Direction rotation, TileIndex tile, TileIterator &&it, uint &mindist)
Finds the town nearest to given airport.
static bool StationHandleBigTick(BaseStation *st)
This function is called for each station once every 250 ticks.
static void ShowRejectOrAcceptNews(const Station *st, CargoTypes cargoes, bool reject)
Add news item for when a station changes which cargoes it accepts.
CommandCost CmdBuildRailStation(DoCommandFlags flags, TileIndex tile_org, RailType rt, Axis axis, uint8_t numtracks, uint8_t plat_len, StationClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
Build rail station.
static void DeleteStationIfEmpty(BaseStation *st)
This is called right after a station was deleted.
static CommandCost IsStationBridgeAboveOk(TileIndex tile, std::span< const BridgeableTileInfo > bridgeable_info, StationType type, StationGfx layout, int bridge_height, StringID disallowed_msg=INVALID_STRING_ID)
Test if a bridge can be built above a station.
Command definitions related to stations.
Functions related to stations.
void ShowStationViewWindow(StationID station)
Opens StationViewWindow for given station.
@ Count
by amount of cargo
Declarations for accessing the k-d tree of stations.
void ForAllStationsRadius(TileIndex center, uint radius, Func func)
Call a function on all stations whose sign is within a radius of a center tile.
Sprites to use and how to display them for station tiles.
Functions related to station layouts.
void MakeAirport(Tile t, Owner o, StationID sid, uint8_t section, WaterClass wc)
Make the given tile an airport tile.
StationType GetStationType(Tile t)
Get the station type of this tile.
Definition station_map.h:44
StationGfx GetStationGfx(Tile t)
Get the station graphics of this tile.
Definition station_map.h:68
void SetStationGfx(Tile t, StationGfx gfx)
Set the station graphics of this tile.
Definition station_map.h:80
void MakeRoadStop(Tile t, Owner o, StationID sid, RoadStopType rst, RoadType road_rt, RoadType tram_rt, DiagDirection d)
Make the given tile a roadstop tile.
void SetCustomStationSpecIndex(Tile t, uint8_t specindex)
Set the custom station spec for this tile.
void SetStationTileHaveWires(Tile t, bool b)
Set the catenary wires state of the rail station.
bool IsAirport(Tile t)
Is this station tile an airport?
bool IsBayRoadStopTile(Tile t)
Is tile t a bay (non-drive through) road stop station?
uint GetCustomRoadStopSpecIndex(Tile t)
Get the custom road stop spec for this tile.
static const int GFX_DOCK_BASE_WATER_PART
The offset for the water parts.
Definition station_map.h:35
bool IsBuoy(Tile t)
Is tile t a buoy tile?
bool IsCompatibleTrainStationTile(Tile test_tile, Tile station_tile)
Check if a tile is a valid continuation to a railstation tile.
bool IsRoadWaypoint(Tile t)
Is the station at t a road waypoint?
void MakeDriveThroughRoadStop(Tile t, Owner station, Owner road, Owner tram, StationID sid, StationType rst, RoadType road_rt, RoadType tram_rt, Axis a)
Make the given tile a drivethrough roadstop tile.
bool IsDriveThroughStopTile(Tile t)
Is tile t a drive through road stop station or waypoint?
static Roadside GetRoadWaypointRoadside(Tile tile)
Get the decorations of a road waypoint.
bool IsRailStationTile(Tile t)
Is this tile a station tile and a rail station?
Track GetRailStationTrack(Tile t)
Get the rail track of a rail station tile.
static void ToggleRoadWaypointOnSnowOrDesert(Tile t)
Toggle the snow/desert state of a road waypoint tile.
StationID GetStationIndex(Tile t)
Get StationID from a tile.
Definition station_map.h:28
bool HasStationTileRail(Tile t)
Has this station tile a rail?
StationGfx GetAirportGfx(Tile t)
Get the station graphics of this airport tile.
uint GetCustomStationSpecIndex(Tile t)
Get the custom station spec for this tile.
bool IsRailWaypoint(Tile t)
Is this station tile a rail waypoint?
bool IsRailStation(Tile t)
Is this station tile a rail station?
Definition station_map.h:92
bool IsDockTile(Tile t)
Is tile t a dock tile?
static void SetRoadWaypointRoadside(Tile tile, Roadside s)
Set the decorations of a road waypoint.
void SetStationTileRandomBits(Tile t, uint8_t random_bits)
Set the random bits for a station tile.
bool IsAnyRoadStop(Tile t)
Is the station at t a road station?
void MakeOilrig(Tile t, StationID sid, WaterClass wc)
Make the given tile an oilrig tile.
DiagDirection GetDockDirection(Tile t)
Get the direction of a dock.
Axis GetRailStationAxis(Tile t)
Get the rail direction of a rail station.
static bool IsRoadWaypointOnSnowOrDesert(Tile t)
Check if a road waypoint tile has snow/desert.
bool IsRoadWaypointTile(Tile t)
Is this tile a station tile and a road waypoint?
bool IsStationTileBlocked(Tile t)
Is tile t a blocked tile?
bool IsTruckStop(Tile t)
Is the station at t a truck stop?
bool IsStationRoadStop(Tile t)
Is the station at t a road station?
bool IsCustomStationSpecIndex(Tile t)
Is there a custom rail station spec on this tile?
bool HasStationRail(Tile t)
Has this station tile a rail?
static const int GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET
The offset for the drive through parts.
Definition station_map.h:36
Axis GetDriveThroughStopAxis(Tile t)
Gets the axis of the drive through stop.
void SetStationTileHavePylons(Tile t, bool b)
Set the catenary pylon state of the rail station.
bool IsOilRig(Tile t)
Is tile t part of an oilrig?
bool IsBuoyTile(Tile t)
Is tile t a buoy tile?
void MakeRailStation(Tile t, Owner o, StationID sid, Axis a, uint8_t section, RailType rt)
Make the given tile a rail station tile.
bool HasStationReservation(Tile t)
Get the reservation state of the rail station.
void MakeDock(Tile t, Owner o, StationID sid, DiagDirection d, WaterClass wc)
Make the given tile a dock tile.
DiagDirection GetBayRoadStopDir(Tile t)
Gets the direction the bay road stop entrance points towards.
bool IsDock(Tile t)
Is tile t a dock tile?
bool IsAnyRoadStopTile(Tile t)
Is tile t a road stop station?
void SetStationTileBlocked(Tile t, bool b)
Set the blocked state of the rail station.
RoadStopType GetRoadStopType(Tile t)
Get the road stop type of this tile.
Definition station_map.h:56
void SetCustomRoadStopSpecIndex(Tile t, uint8_t specindex)
Set the custom road stop spec for this tile.
RoadStopType
Types of RoadStops.
@ Bus
A standard stop for buses.
@ Truck
A standard stop for trucks.
@ End
End of valid types.
@ Dock
Station with a dock.
@ Waypoint
Station is a waypoint.
@ TruckStop
Station with truck stops.
@ Train
Station with train station.
@ Airport
Station with an airport.
@ BusStop
Station with bus stops.
StationType
Station types.
@ Dock
Ship port.
@ Rail
Railways/train station.
@ Bus
Road stop for busses.
@ Truck
Road stop for trucks.
@ RailWaypoint
Waypoint for trains.
@ Buoy
Waypoint for ships.
@ RoadWaypoint
Waypoint for trucks and busses.
@ Oilrig
Heliport on an oil rig.
@ Airport
Airports and heliports, excluding the ones on oil rigs.
@ NewCargo
Trigger station on new cargo arrival.
std::set< Station *, StationCompare > StationList
List of stations.
@ Built
Trigger tile when built.
@ TileLoop
Trigger in the periodic tile loop.
@ NewCargo
Trigger station on new cargo arrival.
@ AcceptanceTick
Trigger station every 250 ticks.
EnumBitSet< StationFacility, uint8_t > StationFacilities
Bitset of StationFacility elements.
static const uint MAX_LENGTH_STATION_NAME_CHARS
The maximum length of a station name in characters including '\0'.
@ Built
Triggered when the airport is built (for all tiles at the same time).
@ TileLoop
Triggered in the periodic tile loop.
@ NewCargo
Triggered when new cargo arrives at the station (for all tiles at the same time).
@ AcceptanceTick
Triggered every 250 ticks (for all tiles at the same time).
Types related to the station widgets.
@ WID_SV_CLOSE_AIRPORT
'Close airport' button.
@ WID_SV_ROADVEHS
List of scheduled road vehs button.
@ WID_SV_ACCEPT_RATING_LIST
List of accepted cargoes / rating of cargoes.
@ WID_SV_SHIPS
List of scheduled ships button.
@ WID_SV_TRAINS
List of scheduled trains button.
Definition of base types and functions in a cross-platform compatible way.
size_t Utf8StringLength(std::string_view str)
Get the length of an UTF-8 encoded string in number of characters and thus not the number of bytes th...
Definition string.cpp:351
Functions related to low-level strings.
void GetStringWithArgs(StringBuilder &builder, StringID string, StringParameters &args, uint case_index, bool game_script)
Get a parsed string with most special stringcodes replaced by the string parameters.
Definition strings.cpp:336
EncodedString GetEncodedString(StringID str)
Encode a string with no parameters into an encoded string.
Definition strings.cpp:90
std::string GetString(StringID string)
Resolve the given StringID into a std::string with formatting but no parameters.
Definition strings.cpp:424
Functions related to OTTD's strings.
auto MakeParameters(Args &&... args)
Helper to create the StringParameters with its own buffer with the given parameter values.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames).
Aircraft, helicopters, rotors and their shadows belong to this class.
Definition aircraft.h:75
@ Airplanes
Can planes land on this airport type?
Definition airport.h:165
Defines the data structure for an airport.
StringID name
name of this airport
SubstituteGRFFileProps grf_prop
Properties related to the grf file.
std::vector< AirportTileLayout > layouts
List of layouts composing the airport.
bool IsWithinMapBounds(uint8_t table, TileIndex index) const
Check if the airport would be within the map bounds at the given tile.
uint8_t size_y
size of airport in y direction
uint8_t size_x
size of airport in x direction
static const AirportSpec * Get(uint8_t type)
Retrieve airport spec for the given airport.
std::span< const HangarTileTable > depots
Position of the depots on the airports.
bool IsAvailable() const
Check whether this airport is available to build.
uint8_t noise_level
noise that this airport generates
Defines the data structure of each individual tile of an airport.
static const AirportTileSpec * Get(StationGfx gfx)
Retrieve airport tile spec for the given airport tile.
SubstituteGRFFileProps grf_prop
properties related the the grf file
StringID name
Tile Subname string, land information on this tile will give you "AirportName (TileSubname)".
static const AirportTileSpec * GetByTile(TileIndex tile)
Retrieve airport tile spec for the given airport tile.
All airport-related information.
AirportBlocks blocks
stores which blocks on the airport are taken. was 16 bit earlier on, then 32
TileIndex GetRotatedTileFromOffset(TileIndexDiffC tidc) const
Add the tileoffset to the base tile of this airport but rotate it first.
uint GetHangarNum(TileIndex tile) const
Get the hangar number of the hangar at a specific tile.
Direction rotation
How this airport is rotated.
uint8_t type
Type of this airport,.
PersistentStorage * psa
Persistent storage for NewGRF airports.
uint GetNumHangars() const
Get the number of hangars on this airport.
TileIndex GetHangarTile(uint hangar_num) const
Get the first tile of the given hangar.
const AirportSpec * GetSpec() const
Get the AirportSpec that from the airport type of this airport.
uint8_t layout
Airport layout number.
Base class for all station-ish types.
StringID string_id
Default name (town area) of station.
TileIndex xy
Base tile of the station.
virtual void MoveSign(TileIndex new_xy)
Move this station's main coordinate somewhere else.
std::vector< SpecMapping< StationSpec > > speclist
List of rail station specs of this station.
StationFacilities facilities
The facilities that this station has.
std::string cached_name
NOSAVE: Cache of the resolved name of the station, if not using a custom name.
TileArea train_station
Tile area the train 'station' part covers.
StationAnimationTriggers cached_anim_triggers
NOSAVE: Combined animation trigger bitmask, used to determine if trigger processing should happen.
Owner owner
The owner of this station.
virtual void UpdateVirtCoord()=0
Update the coordinated of the sign (as shown in the viewport).
uint8_t delete_ctr
Delete counter. If greater than 0 then it is decremented until it reaches 0; the waypoint is then is ...
StationAnimationTriggers cached_roadstop_anim_triggers
NOSAVE: Combined animation trigger bitmask for road stops, used to determine if trigger processing sh...
StationRect rect
NOSAVE: Station spread out rectangle maintained by StationRect::xxx() functions.
bool IsInUse() const
Check whether the base station currently is in use; in use means that it is not scheduled for deletio...
Town * town
The town this station is associated with.
static BaseStation * GetByTile(TileIndex tile)
Get the base station belonging to a specific tile.
virtual bool TileBelongsToRailStation(TileIndex tile) const =0
Check whether a specific tile belongs to this station.
TrackedViewportSign sign
NOSAVE: Dimensions of sign.
TimerGameCalendar::Date build_date
Date of construction.
std::string name
Custom name.
VehicleType type
Type of vehicle.
Class for storing amounts of cargo.
Definition cargo_type.h:118
Specification of a cargo type.
Definition cargotype.h:77
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:141
CargoType Index() const
Determines index of this cargospec.
Definition cargotype.h:111
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition cargotype.h:194
uint32_t station
Count of company owned station tiles.
std::array< uint32_t, RAILTYPE_END > rail
Count of company owned track bits for each rail type.
uint32_t water
Count of company owned track bits for canals.
CompanyInfrastructure infrastructure
NOSAVE: Counts of company owned infrastructure.
T y
Y coordinate.
T x
X coordinate.
T z
Z coordinate.
Ground palette sprite of a tile, together with its sprite layout.
Definition sprite.h:76
Ground palette sprite of a tile, together with its sprite layout.
Definition sprite.h:55
PalSpriteID ground
Palette and sprite for the ground.
Definition sprite.h:56
std::string GetName() const
Get the name of this grf.
GrfID grfid
grfid that introduced this entity.
const struct GRFFile * grffile
grf file that introduced this entity
bool HasGrfFile() const
Test if this entity was introduced by NewGRF.
StationSettings station
settings related to station management
FlowStatMap flows
Planned flows through this station.
StationCargoList cargo
The cargo packets of cargo waiting in this station.
Stores station stats for a single cargo.
uint max_waiting_cargo
Max cargo from this station waiting at any station.
bool HasRating() const
Does this cargo have a rating at this station?
uint8_t last_speed
Maximum speed (up to 255) of the last vehicle that tried to load this cargo.
uint8_t last_age
Age in years (up to 255) of the last vehicle that tried to load this cargo.
uint8_t time_since_pickup
Number of rating-intervals (up to 255) since the last vehicle tried to load this cargo.
States status
Status of this cargo, see State.
NodeID node
ID of node in link graph referring to this goods entry.
@ LastMonth
Set when cargo was delivered for final delivery last month.
@ Acceptance
Set when the station accepts the cargo currently for final deliveries.
@ Rating
This indicates whether a cargo has a rating at the station.
@ AcceptedBigtick
Set when cargo was delivered for final delivery during the current STATION_ACCEPTANCE_TICKS interval.
@ CurrentMonth
Set when cargo was delivered for final delivery this month.
const GoodsEntryData & GetData() const
Get optional cargo packet/flow data.
uint8_t amount_fract
Fractional part of the amount in the cargo list.
LinkGraphID link_graph
Link graph this station belongs to.
bool HasVehicleEverTriedLoading() const
Reports whether a vehicle has ever tried to load the cargo at this station.
uint8_t rating
Station rating for this cargo.
bool HasData() const
Test if this goods entry has optional cargo packet/flow data.
GoodsEntryData & GetOrCreateData()
Get optional cargo packet/flow data.
uint AvailableCount() const
Returns sum of cargo still available for loading at the station.
StationID GetVia(StationID source) const
Get the best next hop for a cargo packet from station source.
Defines the data structure for constructing industry.
SubstituteGRFFileProps grf_prop
properties related to the grf file
StringID name
Displayed name of the industry.
StringID station_name
Default name for nearby station.
bool enabled
entity still available (by default true).newgrf can disable it, though
IndustryLifeTypes life_type
This is also known as Industry production flag, in newgrf specs.
Defines the internal data of a functional industry.
Definition industry.h:64
IndustryType type
type of industry.
Definition industry.h:117
ProducedCargoes produced
produced cargo slots
Definition industry.h:112
Owner owner
owner of the industry. Which SHOULD always be (imho) OWNER_NONE
Definition industry.h:118
static Industry * GetByTile(TileIndex tile)
Get the industry of the given tile.
Definition industry.h:253
TileArea location
Location of the industry.
Definition industry.h:108
Station * neutral_station
Associated neutral station.
Definition industry.h:110
StationList stations_near
NOSAVE: List of nearby stations.
Definition industry.h:125
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 uint Size()
Get the size of the map.
Definition map_func.h:280
Tindex class_index
Class index of this spec, invalid until class is allocated.
NewGRF supplied spritelayout.
static void Reset(TileIndex tile=INVALID_TILE, bool from_gui=true)
Reset the OrderBackups from GUI/game logic.
Shared order list linking together the linked list of orders and the list of vehicles sharing this or...
Definition order_base.h:384
If you change this, keep in mind that it is also saved in 2 other places:
Definition order_base.h:34
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition order_base.h:67
bool ShouldStopAtStation(const Vehicle *v, StationID station) const
Check whether the given vehicle should stop at the given station based on this order and the non-stop...
uint16_t w
The width of the area.
void Add(TileIndex to_add)
Add a single tile to a tile area; enlarge if needed.
Definition tilearea.cpp:43
void Clear()
Clears the 'tile area', i.e.
TileIndex tile
The base tile of the area.
uint16_t h
The height of the area.
OrthogonalTileArea & Expand(int rad)
Expand a tile area by rad tiles in each direction, keeping within map bounds.
Definition tilearea.cpp:123
SpriteID sprite
The 'real' sprite.
Definition gfx_type.h:23
PaletteID pal
The palette (use PAL_NONE) if not needed).
Definition gfx_type.h:24
static Pool::IterateWrapper< BaseStation > Iterate(size_t from=0)
static T * Create(Targs &&... args)
static Industry * Get(auto index)
static LinkGraph * GetIfValid(auto index)
Road stop specification.
Money GetBuildCost(Price category) const
Get the cost for building a road stop of this type.
std::array< BridgeableTileInfo, 6 > bridgeable_info
Per tile layout bridge information.
CargoGRFFileProps grf_prop
Link to NewGRF.
Money GetClearCost(Price category) const
Get the cost for clearing a road stop of this type.
A Stop for a Road Vehicle.
RoadStop * next
Next stop of the given type at this station.
static RoadStop * GetByTile(TileIndex tile, RoadStopType type)
Find a roadstop at given tile.
Definition roadstop.cpp:253
void MakeDriveThrough()
Join this road stop to another 'base' road stop if possible; fill all necessary data to become an act...
Definition roadstop.cpp:60
void ClearDriveThrough()
Prepare for removal of this stop; update other neighbouring stops if needed.
Definition roadstop.cpp:122
Buses, trucks and trams belong to this class.
Definition roadveh.h:105
uint8_t state
Definition roadveh.h:107
All ships have this type.
Definition ship.h:32
static Station * Create(Targs &&... args)
static bool IsExpected(const BaseStation *st)
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
static Station * Get(auto index)
static Station * GetIfValid(auto index)
static Station * From(BaseStation *st)
static RoadVehicle * From(Vehicle *v)
T * Last()
Get the last vehicle in the chain.
bool HasSpriteGroups() const
Check whether the entity has sprite groups.
Information to handle station action 0 property 24 correctly.
void SetUsed(StringID str)
Mark the given station name as used.
std::bitset< NUM_INDUSTRYTYPES > indtypes
Bit set indicating when an industry type has been found.
std::bitset< STR_SV_STNAME_FALLBACK - STR_SV_STNAME > used_names
Used default station suffixes.
bool IsAvailable(StringID str) const
Is the given station name available, and not already used?
StationRect - used to track station spread out rectangle - cheaper than scanning whole map.
bool PtInExtendedRect(int x, int y, int distance=0) const
Determines whether a given point (x, y) is within a certain distance of the station rectangle.
Definition station.cpp:567
bool serve_neutral_industries
company stations can serve industries with attached neutral stations
Station specification.
std::vector< BridgeableTileInfo > bridgeable_info
Per tile layout bridge information.
uint8_t disallowed_lengths
Bitmask of platform lengths available for the station.
StringID name
Name of this station.
uint8_t disallowed_platforms
Bitmask of number of platforms available for the station.
CargoGRFFileProps grf_prop
Link to NewGRF.
std::vector< TileFlags > tileflags
List of tile flags.
std::vector< NewGRFSpriteLayout > renderdata
Number of tile layouts.
EnumBitSet< TileFlag, uint8_t > TileFlags
Bitset of TileFlag elements.
StationCallbackMasks callback_mask
Bitmask of station callbacks that have to be called.
@ NoWires
Tile should NOT contain catenary wires.
@ Pylons
Tile should contain catenary pylons.
@ Blocked
Tile is blocked to vehicles.
StationSpecFlags flags
Bitmask of flags, bit 0: use different sprite set; bit 1: divide cargo about by station size.
Station data structure.
TileArea GetTileArea(StationType type) const override
Get the tile area for a given station type.
RoadStop * bus_stops
All the road stops.
TileArea ship_station
Tile area the ship 'station' part covers.
IndustryType indtype
Industry type to get the name from.
TileArea docking_station
Tile area the docking tiles cover.
CargoTypes always_accepted
Bitmask of always accepted cargo types (by houses, HQs, industry tiles when industry doesn't accept c...
Industry * industry
NOSAVE: Associated industry for neutral stations. (Rebuilt on load from Industry->st).
void MoveSign(TileIndex new_xy) override
Move the station main coordinate somewhere else.
std::array< GoodsEntry, NUM_CARGO > goods
Goods at this station.
TileArea bus_station
Tile area the bus 'station' part covers.
BitmapTileArea catchment_tiles
NOSAVE: Set of individual tiles covered by catchment area.
void RecomputeCatchment(bool no_clear_nearby_lists=false)
Recompute tiles covered in our catchment area.
Definition station.cpp:469
void AfterStationTileSetChange(bool adding, StationType type)
After adding/removing tiles to station, update some station-related stuff.
Airport airport
Tile area the airport covers.
void UpdateVirtCoord() override
Update the virtual coords needed to draw the station sign.
TileArea truck_station
Tile area the truck 'station' part covers.
RoadStop * truck_stops
All the truck stops.
void AddFacility(StationFacility new_facility_bit, TileIndex facil_xy)
Called when new facility is built on the station.
Definition station.cpp:233
uint16_t subst_id
The id of the entity to replace.
Tile description for the 'land area information' tool.
Definition tile_cmd.h:40
uint16_t rail_speed
Speed limit of rail (bridges and track).
Definition tile_cmd.h:53
std::optional< std::string > grf
newGRF used for the tile contents
Definition tile_cmd.h:51
StringID station_name
Type of station within the class.
Definition tile_cmd.h:47
StringID str
Description of the tile.
Definition tile_cmd.h:41
TimerGameCalendar::Date build_date
Date of construction of tile contents.
Definition tile_cmd.h:45
std::array< Owner, 4 > owner
Name of the owner(s).
Definition tile_cmd.h:43
StringID airport_class
Name of the airport class.
Definition tile_cmd.h:48
StringID airport_name
Name of the airport.
Definition tile_cmd.h:49
uint16_t tram_speed
Speed limit of tram (bridges and track).
Definition tile_cmd.h:57
StringID roadtype
Type of road on the tile.
Definition tile_cmd.h:54
StringID tramtype
Type of tram on the tile.
Definition tile_cmd.h:56
StringID railtype
Type of rail on the tile.
Definition tile_cmd.h:52
uint16_t road_speed
Speed limit of road (bridges and track).
Definition tile_cmd.h:55
std::array< StringID, 4 > owner_type
Type of each owner.
Definition tile_cmd.h:44
StringID airport_tile_name
Name of the airport tile.
Definition tile_cmd.h:50
StringID station_class
Class of station.
Definition tile_cmd.h:46
Tile information, used while rendering the tile.
Definition tile_cmd.h:34
Slope tileh
Slope of the tile.
Definition tile_cmd.h:35
TileIndex tile
Tile index.
Definition tile_cmd.h:36
Town data structure.
Definition town.h:64
CompanyMask statues
which companies have a statue?
Definition town.h:82
TileIndex xy
town center tile
Definition town.h:65
uint16_t noise_reached
level of noise that all the airports are generating
Definition town.h:80
uint16_t MaxTownNoise() const
Calculate the max town noise.
Definition town.h:224
CompanyID exclusivity
which company has exclusivity
Definition town.h:87
uint8_t exclusive_counter
months till the exclusivity expires
Definition town.h:88
Track status of a tile.
Definition track_type.h:105
'Train' is either a loco or a wagon.
Definition train.h:97
Trackdir GetVehicleTrackdir() const override
Get the tracks of the train vehicle.
Vehicle data structure.
Direction GetMovingDirection() const
Get the moving direction of this vehicle chain.
bool IsStoppedInDepot() const
Check whether the vehicle is in the depot and stopped.
bool IsMovingFront() const
Is this vehicle the moving front of the vehicle chain?
TimerGameEconomy::Date date_of_last_service
Last economy date the vehicle had a service at a depot.
virtual void SetDestTile(TileIndex tile)
Set the destination of this vehicle.
VehStates vehstatus
Status.
Vehicle * First() const
Get the first vehicle of this vehicle chain.
virtual TileIndex GetOrderStationLocation(StationID station)
Determine the location for the station where the vehicle goes to next.
Order current_order
The current order (+ status, like: loading).
Vehicle * Next() const
Get the next vehicle of this vehicle.
Vehicle * NextShared() const
Get the next vehicle of the shared vehicle chain.
uint16_t cur_speed
current speed
bool IsFrontEngine() const
Check if the vehicle is a front engine.
TileIndex tile
Current tile index.
TileIndex dest_tile
Heading for this tile.
Owner owner
Which company owns the vehicle?
Representation of a waypoint.
TileArea road_waypoint_area
Tile area the road waypoint part covers.
uint16_t waypoint_flags
Waypoint flags, see WaypointFlags.
void UpdateVirtCoord() override
Update the virtual coords needed to draw the waypoint sign.
@ Source
town/industry is source of subsidised path
@ EnteredStation
The vehicle entered a station.
Definition tile_cmd.h:25
@ CannotEnter
The vehicle cannot enter the tile.
Definition tile_cmd.h:27
void AddProducedCargo(TileIndex tile, CargoArray &produced)
Obtain the produced cargo of a tile.
Definition tile_cmd.h:257
EnumBitSet< VehicleEnterTileState, uint8_t > VehicleEnterTileStates
Bitset of VehicleEnterTileState elements.
Definition tile_cmd.h:31
void AddAcceptedCargo(TileIndex tile, CargoArray &acceptance, CargoTypes &always_accepted)
Obtain cargo acceptance of a tile.
Definition tile_cmd.h:245
bool IsTileFlat(TileIndex tile, int *h)
Check if a given tile is flat.
Definition tile_map.cpp:94
std::tuple< Slope, int > GetTileSlopeZ(TileIndex tile)
Return the slope of a given tile inside the map.
Definition tile_map.cpp:55
int GetTileMaxZ(TileIndex t)
Get top height of the tile inside the map.
Definition tile_map.cpp:135
int GetTileZ(TileIndex tile)
Get bottom height of the tile.
Definition tile_map.cpp:115
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
bool IsTileOwner(Tile tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition tile_map.h:214
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
void SetTileOwner(Tile tile, Owner owner)
Sets the owner of a tile.
Definition tile_map.h:198
int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
Definition tile_map.h:312
uint8_t GetAnimationFrame(Tile t)
Get the current animation frame.
Definition tile_map.h:250
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition tile_map.h:161
TropicZone GetTropicZone(Tile tile)
Get the tropic zone.
Definition tile_map.h:238
void SetAnimationFrame(Tile t, uint8_t frame)
Set a new animation frame.
Definition tile_map.h:262
Slope GetTileSlope(TileIndex tile)
Return the slope of a given tile inside the map.
Definition tile_map.h:279
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
@ Desert
Tile is desert.
Definition tile_type.h:83
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
static constexpr uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in ZOOM_BASE.
Definition tile_type.h:18
@ Water
Water tile.
Definition tile_type.h:55
@ Station
A tile of a station or airport.
Definition tile_type.h:54
@ Industry
Part of an industry.
Definition tile_type.h:57
@ Trees
Tile with one or more trees.
Definition tile_type.h:53
@ House
A house by a town.
Definition tile_type.h:52
@ Road
A tile with road and/or tram tracks.
Definition tile_type.h:51
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Functions related to tile highlights.
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
Definition of Interval and OneShot timers.
Definition of the game-calendar-timer.
Definition of the game-economy-timer.
Definition of the tick-based game-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.
Town * CalcClosestTownFromTile(TileIndex tile, uint threshold=UINT_MAX)
Return the town closest to the given tile within threshold.
HouseZone GetTownRadiusGroup(const Town *t, TileIndex tile)
Returns the bit corresponding to the town zone of the specified tile.
CommandCost CheckIfAuthorityAllowsNewStation(TileIndex tile, DoCommandFlags flags)
Checks whether the local authority allows construction of a new station (rail, road,...
TrackdirBits TrackBitsToTrackdirBits(TrackBits bits)
Converts TrackBits to TrackdirBits while allowing both directions.
Definition track_func.h:292
bool IsReversingRoadTrackdir(Trackdir dir)
Checks whether the trackdir means that we are reversing.
Definition track_func.h:568
Trackdir ReverseTrackdir(Trackdir trackdir)
Maps a trackdir to the reverse trackdir.
Definition track_func.h:220
Track AxisToTrack(Axis a)
Convert an Axis to the corresponding Track Axis::X -> Track::X Axis::Y -> Track::Y Uses the fact that...
Definition track_func.h:62
DiagDirection TrackdirToExitdir(Trackdir trackdir)
Maps a trackdir to the (4-way) direction the tile is exited when following that trackdir.
Definition track_func.h:343
Track DiagDirToDiagTrack(DiagDirection diagdir)
Maps a DiagDirection to the associated diagonal Track.
Definition track_func.h:419
static constexpr TrackBits TRACK_BIT_3WAY_NE
"Arrow" to the north-east
Definition track_type.h:48
EnumBitSet< Track, uint8_t > TrackBits
Bitset of Track elements.
Definition track_type.h:43
static constexpr TrackBits TRACK_BIT_ALL
All possible tracks.
Definition track_type.h:52
Trackdir
Enumeration for tracks and directions.
Definition track_type.h:63
Track
These are used to specify a single track.
Definition track_type.h:19
@ Upper
Track in the upper corner of the tile (north).
Definition track_type.h:23
@ Y
Track along the y-axis (north-west to south-east).
Definition track_type.h:22
@ Left
Track in the left corner of the tile (west).
Definition track_type.h:25
Base for the train class.
bool TryPathReserve(Train *v, bool mark_as_stuck=false, bool first_tile_okay=false)
Try to reserve a path to a safe position.
int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *moving_front, int *station_ahead, int *station_length)
Get the stop location of (the center) of the front vehicle of a train at a platform of a station.
void FreeTrainTrackReservation(const Train *v)
Free the reserved path in front of a vehicle.
@ Buildings
company buildings - depots, stations, HQ, ...
TransportType
Available types of transport.
@ Water
Transport over water.
@ Rail
Transport by train.
@ Road
Transport by road vehicle.
Functions that have tunnels and bridges in common.
CommandCost EnsureNoVehicleOnGround(TileIndex tile)
Ensure there is no vehicle at the ground at the given position.
Definition vehicle.cpp:557
@ TrainSlowing
Train is slowing down.
Functions related to vehicles.
@ Ship
Ship vehicle type.
@ Invalid
Non-existing type of vehicle.
@ Aircraft
Aircraft vehicle type.
@ Road
Road vehicle type.
@ Train
Train vehicle type.
Functions and type for generating vehicle lists.
void FindVehiclesWithOrder(VehiclePredicate veh_pred, OrderPredicate ord_pred, VehicleFunc veh_func)
Find vehicles matching an order.
void OffsetGroundSprite(int x, int y)
Called when a foundation has been drawn for the current tile.
Definition viewport.cpp:605
void SetViewportStationRect(const Station *st, bool sel)
Select or deselect station for rectangle area highlight.
void StartSpriteCombine()
Starts a block of sprites, which are "combined" into a single bounding box.
Definition viewport.cpp:765
void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int z, const SpriteBounds &bounds, bool transparent, const SubSprite *sub)
Draw a (transparent) sprite at given coordinates with a given bounding box.
Definition viewport.cpp:664
void EndSpriteCombine()
Terminates a block of sprites started by StartSpriteCombine.
Definition viewport.cpp:775
void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
Draws a ground sprite for the current tile.
Definition viewport.cpp:579
Functions related to (drawing on) viewports.
static const int TILE_HEIGHT_STEP
One Z unit tile height difference is displayed as 50m.
Declarations for accessing the k-d tree of viewports.
Functions related to water management.
void TileLoop_Water(TileIndex tile)
Tile callback function signature for running periodic tile updates.
void CheckForDockingTile(TileIndex t)
Mark the supplied tile as a docking tile if it is suitable for docking.
bool IsPossibleDockingTile(Tile t)
Check whether it is feasible that the given tile could be a docking tile.
bool HasTileWaterGround(Tile t)
Checks whether the tile has water at the ground.
Definition water_map.h:353
bool IsTileOnWater(Tile t)
Tests if the tile was built on water.
Definition water_map.h:138
WaterClass
classes of water (for WaterTileType::Clear water tile type).
Definition water_map.h:39
@ Invalid
Used for industry tiles on land (also for oilrig if newgrf says so).
Definition water_map.h:43
@ Canal
Canal.
Definition water_map.h:41
@ Sea
Sea.
Definition water_map.h:40
bool HasTileWaterClass(Tile t)
Checks whether the tile has an waterclass associated.
Definition water_map.h:103
WaterClass GetWaterClass(Tile t)
Get the water class at a tile.
Definition water_map.h:114
bool IsDockingTile(Tile t)
Checks whether the tile is marked as a dockling tile.
Definition water_map.h:375
void SetDockingTile(Tile t, bool b)
Set the docking tile state of a tile.
Definition water_map.h:364
bool IsWater(Tile t)
Is it a plain water tile?
Definition water_map.h:149
bool IsWaterTile(Tile t)
Is it a water tile with plain water?
Definition water_map.h:192
Base of waypoints.
@ WPF_ROAD
This is a road waypoint.
CommandCost RemoveBuoy(TileIndex tile, DoCommandFlags flags)
Remove a buoy.
Command definitions related to waypoints.
Functions related to waypoints.
void ShowWaypointWindow(const Waypoint *wp)
Show the window for the given waypoint.
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
Definition window.cpp:1201
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting).
Definition window.cpp:3223
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition window.cpp:3315
void SetWindowWidgetDirty(WindowClass cls, WindowNumber number, WidgetID widget_index)
Mark a particular widget in a particular window as dirty (in need of repainting).
Definition window.cpp:3209
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting).
Definition window.cpp:3193
void InvalidateWindowClassesData(WindowClass cls, int data, bool gui_scope)
Mark window data of all windows of a given class as invalid (in need of re-computing) Note that by de...
Definition window.cpp:3333
Entry point for OpenTTD to YAPF's cache.
void YapfNotifyTrackLayoutChange(TileIndex tile, Track track)
Use this function to notify YAPF that track layout (or signal configuration) has change.
@ Station
station encountered (could be a target next time)
Definition yapf_type.hpp:26