OpenTTD Source 20251213-master-g1091fa6071
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
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, MP_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, MP_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, MP_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) &&
191 return true;
192 }
193 }
194
195 return false;
196}
197
203static bool CMSAWater(TileIndex tile)
204{
205 return IsTileType(tile, MP_WATER) && IsWater(tile);
206}
207
213static bool CMSATree(TileIndex tile)
214{
215 return IsTileType(tile, MP_TREES);
216}
217
218enum StationNaming : uint8_t {
219 STATIONNAMING_RAIL,
220 STATIONNAMING_ROAD,
221 STATIONNAMING_AIRPORT,
222 STATIONNAMING_OILRIG,
223 STATIONNAMING_DOCK,
224 STATIONNAMING_HELIPORT,
225};
226
229 std::bitset<STR_SV_STNAME_FALLBACK - STR_SV_STNAME> used_names;
230 std::bitset<NUM_INDUSTRYTYPES> indtypes;
231
232 bool IsAvailable(StringID str) const
233 {
234 assert(IsInsideMM(str, STR_SV_STNAME, STR_SV_STNAME_FALLBACK));
235 return !this->used_names.test(str - STR_SV_STNAME);
236 }
237
238 void SetUsed(StringID str)
239 {
240 assert(IsInsideMM(str, STR_SV_STNAME, STR_SV_STNAME_FALLBACK));
241 this->used_names.set(str - STR_SV_STNAME);
242 }
243};
244
245static StringID GenerateStationName(Station *st, TileIndex tile, StationNaming name_class)
246{
247 const Town *t = st->town;
248
250
251 for (const Station *s : Station::Iterate()) {
252 if (s != st && s->town == t) {
253 if (s->indtype != IT_INVALID) {
254 sni.indtypes[s->indtype] = true;
255 StringID name = GetIndustrySpec(s->indtype)->station_name;
256 if (name != STR_UNDEFINED) {
257 /* Filter for other industrytypes with the same name */
258 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
259 const IndustrySpec *indsp = GetIndustrySpec(it);
260 if (indsp->enabled && indsp->station_name == name) sni.indtypes[it] = true;
261 }
262 }
263 continue;
264 }
265 if (IsInsideMM(s->string_id, STR_SV_STNAME, STR_SV_STNAME_FALLBACK)) {
266 auto str = s->string_id;
267 if (str == STR_SV_STNAME_FOREST) str = STR_SV_STNAME_WOODS;
268 sni.SetUsed(str);
269 }
270 }
271 }
272
273 for (auto indtile : SpiralTileSequence(tile, 7)) {
274 if (!IsTileType(indtile, MP_INDUSTRY)) continue;
275
276 /* If the station name is undefined it means that it doesn't name a station */
277 IndustryType indtype = GetIndustryType(indtile);
278 const IndustrySpec *indsp = GetIndustrySpec(indtype);
279 if (indsp->station_name == STR_UNDEFINED) continue;
280
281 /* In all cases if an industry that provides a name is found two of
282 * the standard names will be disabled. */
283 sni.SetUsed(STR_SV_STNAME_OILFIELD);
284 sni.SetUsed(STR_SV_STNAME_MINES);
285 if (sni.indtypes[indtype]) continue;
286
287 /* STR_NULL means it only disables oil rig/mines */
288 if (indsp->station_name != STR_NULL) {
289 st->indtype = indtype;
290 return STR_SV_STNAME_FALLBACK;
291 }
292 break;
293 }
294
295 /* check default names
296 * Oil rigs/mines name could be marked not free by looking for a near by industry. */
297 switch (name_class) {
298 case STATIONNAMING_AIRPORT:
299 if (sni.IsAvailable(STR_SV_STNAME_AIRPORT)) return STR_SV_STNAME_AIRPORT;
300 break;
301 case STATIONNAMING_OILRIG:
302 if (sni.IsAvailable(STR_SV_STNAME_OILFIELD)) return STR_SV_STNAME_OILFIELD;
303 break;
304 case STATIONNAMING_DOCK:
305 if (sni.IsAvailable(STR_SV_STNAME_DOCKS)) return STR_SV_STNAME_DOCKS;
306 break;
307 case STATIONNAMING_HELIPORT:
308 if (sni.IsAvailable(STR_SV_STNAME_HELIPORT)) return STR_SV_STNAME_HELIPORT;
309 break;
310 default:
311 break;
312 };
313
314 /* check mine? */
315 if (sni.IsAvailable(STR_SV_STNAME_MINES)) {
316 if (CountMapSquareAround(tile, CMSAMine) >= 2) {
317 return STR_SV_STNAME_MINES;
318 }
319 }
320
321 /* check close enough to town to get central as name? */
322 if (DistanceMax(tile, t->xy) < 8) {
323 if (sni.IsAvailable(STR_SV_STNAME)) return STR_SV_STNAME;
324 if (sni.IsAvailable(STR_SV_STNAME_CENTRAL)) return STR_SV_STNAME_CENTRAL;
325 }
326
327 /* Check lakeside */
328 if (sni.IsAvailable(STR_SV_STNAME_LAKESIDE) &&
329 DistanceFromEdge(tile) < 20 &&
330 CountMapSquareAround(tile, CMSAWater) >= 5) {
331 return STR_SV_STNAME_LAKESIDE;
332 }
333
334 /* Check woods */
335 if (sni.IsAvailable(STR_SV_STNAME_WOODS) && (
336 CountMapSquareAround(tile, CMSATree) >= 8 ||
338 ) {
339 return _settings_game.game_creation.landscape == LandscapeType::Tropic ? STR_SV_STNAME_FOREST : STR_SV_STNAME_WOODS;
340 }
341
342 /* check elevation compared to town */
343 int z = GetTileZ(tile);
344 int z2 = GetTileZ(t->xy);
345 if (z < z2) {
346 if (sni.IsAvailable(STR_SV_STNAME_VALLEY)) return STR_SV_STNAME_VALLEY;
347 } else if (z > z2) {
348 if (sni.IsAvailable(STR_SV_STNAME_HEIGHTS)) return STR_SV_STNAME_HEIGHTS;
349 }
350
351 /* check direction compared to town */
352 if (TileX(tile) < TileX(t->xy)) {
353 sni.SetUsed(STR_SV_STNAME_SOUTH);
354 sni.SetUsed(STR_SV_STNAME_WEST);
355 } else {
356 sni.SetUsed(STR_SV_STNAME_NORTH);
357 sni.SetUsed(STR_SV_STNAME_EAST);
358 }
359 if (TileY(tile) < TileY(t->xy)) {
360 sni.SetUsed(STR_SV_STNAME_SOUTH);
361 sni.SetUsed(STR_SV_STNAME_EAST);
362 } else {
363 sni.SetUsed(STR_SV_STNAME_NORTH);
364 sni.SetUsed(STR_SV_STNAME_WEST);
365 }
366
368 static const StringID fallback_names[] = {
369 STR_SV_STNAME_NORTH,
370 STR_SV_STNAME_SOUTH,
371 STR_SV_STNAME_EAST,
372 STR_SV_STNAME_WEST,
373 STR_SV_STNAME_TRANSFER,
374 STR_SV_STNAME_HALT,
375 STR_SV_STNAME_EXCHANGE,
376 STR_SV_STNAME_ANNEXE,
377 STR_SV_STNAME_SIDINGS,
378 STR_SV_STNAME_BRANCH,
379 STR_SV_STNAME_UPPER,
380 STR_SV_STNAME_LOWER,
381 };
382 for (auto str : fallback_names) {
383 if (sni.IsAvailable(str)) return str;
384 }
385 return STR_SV_STNAME_FALLBACK;
386}
387
394{
395 uint threshold = 8;
396
397 Station *best_station = nullptr;
398 ForAllStationsRadius(tile, threshold, [&](Station *st) {
399 if (!st->IsInUse() && st->owner == _current_company) {
400 uint cur_dist = DistanceManhattan(tile, st->xy);
401
402 if (cur_dist < threshold) {
403 threshold = cur_dist;
404 best_station = st;
405 } else if (cur_dist == threshold && best_station != nullptr) {
406 /* In case of a tie, lowest station ID wins */
407 if (st->index < best_station->index) best_station = st;
408 }
409 }
410 });
411
412 return best_station;
413}
414
415
417{
418 switch (type) {
419 case StationType::Rail: return this->train_station;
420 case StationType::Airport: return this->airport;
421 case StationType::Truck: return this->truck_station;
422 case StationType::Bus: return this->bus_station;
423 case StationType::Dock:
424 case StationType::Oilrig: return this->docking_station;
425 default: NOT_REACHED();
426 }
427}
428
433{
434 Point pt = RemapCoords2(TileX(this->xy) * TILE_SIZE, TileY(this->xy) * TILE_SIZE);
435
436 pt.y -= 32 * ZOOM_BASE;
437 if (this->facilities.Test(StationFacility::Airport) && this->airport.type == AT_OILRIG) pt.y -= 16 * ZOOM_BASE;
438
439 if (this->sign.kdtree_valid) _viewport_sign_kdtree.Remove(ViewportSignKdtreeItem::MakeStation(this->index));
440
441 this->sign.UpdatePosition(pt.x, pt.y, GetString(STR_VIEWPORT_STATION, this->index, this->facilities), GetString(STR_STATION_NAME, this->index, this->facilities));
442
443 _viewport_sign_kdtree.Insert(ViewportSignKdtreeItem::MakeStation(this->index));
444
446}
447
453{
454 if (this->xy == new_xy) return;
455
456 _station_kdtree.Remove(this->index);
457
458 this->BaseStation::MoveSign(new_xy);
459
460 _station_kdtree.Insert(this->index);
461}
462
465{
466 for (BaseStation *st : BaseStation::Iterate()) {
467 st->UpdateVirtCoord();
468 }
469}
470
471void BaseStation::FillCachedName() const
472{
473 auto tmp_params = MakeParameters(this->index);
474 this->cached_name = GetStringWithArgs(Waypoint::IsExpected(this) ? STR_WAYPOINT_NAME : STR_STATION_NAME, tmp_params);
475}
476
477void ClearAllStationCachedNames()
478{
479 for (BaseStation *st : BaseStation::Iterate()) {
480 st->cached_name.clear();
481 }
482}
483
489CargoTypes GetAcceptanceMask(const Station *st)
490{
491 CargoTypes mask = 0;
492
493 for (auto it = std::begin(st->goods); it != std::end(st->goods); ++it) {
494 if (it->status.Test(GoodsEntry::State::Acceptance)) SetBit(mask, std::distance(std::begin(st->goods), it));
495 }
496 return mask;
497}
498
504CargoTypes GetEmptyMask(const Station *st)
505{
506 CargoTypes mask = 0;
507
508 for (auto it = std::begin(st->goods); it != std::end(st->goods); ++it) {
509 if (!it->HasData() || it->GetData().cargo.TotalCount() == 0) SetBit(mask, std::distance(std::begin(st->goods), it));
510 }
511 return mask;
512}
513
520static void ShowRejectOrAcceptNews(const Station *st, CargoTypes cargoes, bool reject)
521{
522 StringID msg = reject ? STR_NEWS_STATION_NO_LONGER_ACCEPTS_CARGO_LIST : STR_NEWS_STATION_NOW_ACCEPTS_CARGO_LIST;
524}
525
533CargoArray GetProductionAroundTiles(TileIndex north_tile, int w, int h, int rad)
534{
535 CargoArray produced{};
536 FlatSet<IndustryID> industries;
537 TileArea ta = TileArea(north_tile, w, h).Expand(rad);
538
539 /* Loop over all tiles to get the produced cargo of
540 * everything except industries */
541 for (TileIndex tile : ta) {
542 if (IsTileType(tile, MP_INDUSTRY)) industries.insert(GetIndustryIndex(tile));
543 AddProducedCargo(tile, produced);
544 }
545
546 /* Loop over the seen industries. They produce cargo for
547 * anything that is within 'rad' of any one of their tiles.
548 */
549 for (IndustryID industry : industries) {
550 const Industry *i = Industry::Get(industry);
551 /* Skip industry with neutral station */
552 if (i->neutral_station != nullptr && !_settings_game.station.serve_neutral_industries) continue;
553
554 for (const auto &p : i->produced) {
555 if (IsValidCargoType(p.cargo)) produced[p.cargo]++;
556 }
557 }
558
559 return produced;
560}
561
571CargoArray GetAcceptanceAroundTiles(TileIndex center_tile, int w, int h, int rad, CargoTypes *always_accepted)
572{
573 CargoArray acceptance{};
574 if (always_accepted != nullptr) *always_accepted = 0;
575
576 TileArea ta = TileArea(center_tile, w, h).Expand(rad);
577
578 for (TileIndex tile : ta) {
579 /* Ignore industry if it has a neutral station. */
581
582 AddAcceptedCargo(tile, acceptance, always_accepted);
583 }
584
585 return acceptance;
586}
587
593static CargoArray GetAcceptanceAroundStation(const Station *st, CargoTypes *always_accepted)
594{
595 CargoArray acceptance{};
596 if (always_accepted != nullptr) *always_accepted = 0;
597
599 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
600 AddAcceptedCargo(tile, acceptance, always_accepted);
601 }
602
603 return acceptance;
604}
605
611void UpdateStationAcceptance(Station *st, bool show_msg)
612{
613 /* old accepted goods types */
614 CargoTypes old_acc = GetAcceptanceMask(st);
615
616 /* And retrieve the acceptance. */
617 CargoArray acceptance{};
618 if (!st->rect.IsEmpty()) {
619 acceptance = GetAcceptanceAroundStation(st, &st->always_accepted);
620 }
621
622 /* Adjust in case our station only accepts fewer kinds of goods */
623 for (CargoType cargo = 0; cargo < NUM_CARGO; ++cargo) {
624 uint amt = acceptance[cargo];
625
626 /* Make sure the station can accept the goods type. */
627 bool is_passengers = IsCargoInClass(cargo, CargoClass::Passengers);
628 if ((!is_passengers && !st->facilities.Any({StationFacility::Train, StationFacility::TruckStop, StationFacility::Airport, StationFacility::Dock})) ||
629 (is_passengers && !st->facilities.Any({StationFacility::Train, StationFacility::BusStop, StationFacility::Airport, StationFacility::Dock}))) {
630 amt = 0;
631 }
632
633 GoodsEntry &ge = st->goods[cargo];
636 (*LinkGraph::Get(ge.link_graph))[ge.node].SetDemand(amt / 8);
637 }
638 }
639
640 /* Only show a message in case the acceptance was actually changed. */
641 CargoTypes new_acc = GetAcceptanceMask(st);
642 if (old_acc == new_acc) return;
643
644 /* show a message to report that the acceptance was changed? */
645 if (show_msg && st->owner == _local_company && st->IsInUse()) {
646 /* Combine old and new masks to get changes */
647 CargoTypes accepts = new_acc & ~old_acc;
648 CargoTypes rejects = ~new_acc & old_acc;
649
650 /* Show news message if there are any changes */
651 if (accepts != 0) ShowRejectOrAcceptNews(st, accepts, false);
652 if (rejects != 0) ShowRejectOrAcceptNews(st, rejects, true);
653 }
654
655 /* redraw the station view since acceptance changed */
657}
658
659static void UpdateStationSignCoord(BaseStation *st)
660{
661 const StationRect *r = &st->rect;
662
663 if (r->IsEmpty()) return; // no tiles belong to this station
664
665 /* clamp sign coord to be inside the station rect */
666 TileIndex new_xy = TileXY(ClampU(TileX(st->xy), r->left, r->right), ClampU(TileY(st->xy), r->top, r->bottom));
667 st->MoveSign(new_xy);
668
669 if (!Station::IsExpected(st)) return;
670 Station *full_station = Station::From(st);
671 for (const GoodsEntry &ge : full_station->goods) {
672 LinkGraphID lg = ge.link_graph;
673 if (!LinkGraph::IsValidID(lg)) continue;
674 (*LinkGraph::Get(lg))[ge.node].UpdateLocation(st->xy);
675 }
676}
677
687static CommandCost BuildStationPart(Station **st, DoCommandFlags flags, bool reuse, TileArea area, StationNaming name_class)
688{
689 /* Find a deleted station close to us */
690 if (*st == nullptr && reuse) *st = GetClosestDeletedStation(area.tile);
691
692 if (*st != nullptr) {
693 if ((*st)->owner != _current_company) {
694 return CommandCost(CMD_ERROR);
695 }
696
697 CommandCost ret = (*st)->rect.BeforeAddRect(area.tile, area.w, area.h, StationRect::ADD_TEST);
698 if (ret.Failed()) return ret;
699 } else {
700 /* allocate and initialize new station */
701 if (!Station::CanAllocateItem()) return CommandCost(STR_ERROR_TOO_MANY_STATIONS_LOADING);
702
703 if (flags.Test(DoCommandFlag::Execute)) {
704 *st = new Station(area.tile);
705 _station_kdtree.Insert((*st)->index);
706
707 (*st)->town = ClosestTownFromTile(area.tile, UINT_MAX);
708 (*st)->string_id = GenerateStationName(*st, area.tile, name_class);
709
711 (*st)->town->have_ratings.Set(_current_company);
712 }
713 }
714 }
715 return CommandCost();
716}
717
725{
726 if (!st->IsInUse()) {
727 st->delete_ctr = 0;
729 }
730 /* station remains but it probably lost some parts - station sign should stay in the station boundaries */
731 UpdateStationSignCoord(st);
732}
733
740{
741 this->UpdateVirtCoord();
743
744 if (adding) {
745 this->RecomputeCatchment();
746 MarkCatchmentTilesDirty();
748 } else {
749 MarkCatchmentTilesDirty();
750 }
751
752 switch (type) {
753 case StationType::Rail:
755 break;
756 case StationType::Airport:
757 break;
758 case StationType::Truck:
759 case StationType::Bus:
761 break;
762 case StationType::Dock:
764 break;
765 default: NOT_REACHED();
766 }
767
768 if (adding) {
769 UpdateStationAcceptance(this, false);
771 } else {
773 this->RecomputeCatchment();
774 }
775
776}
777
779
789CommandCost CheckBuildableTile(TileIndex tile, DiagDirections invalid_dirs, int &allowed_z, bool allow_steep, bool check_bridge = true)
790{
791 if (check_bridge && IsBridgeAbove(tile)) {
792 return CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
793 }
794
796 if (ret.Failed()) return ret;
797
798 auto [tileh, z] = GetTileSlopeZ(tile);
799
800 /* Prohibit building if
801 * 1) The tile is "steep" (i.e. stretches two height levels).
802 * 2) The tile is non-flat and the build_on_slopes switch is disabled.
803 */
804 if ((!allow_steep && IsSteepSlope(tileh)) ||
806 return CommandCost(STR_ERROR_FLAT_LAND_REQUIRED);
807 }
808
810 int flat_z = z + GetSlopeMaxZ(tileh);
811 if (tileh != SLOPE_FLAT) {
812 /* Forbid building if the tile faces a slope in a invalid direction. */
813 for (DiagDirection dir = DIAGDIR_BEGIN; dir != DIAGDIR_END; dir++) {
814 if (invalid_dirs.Test(dir) && !CanBuildDepotByTileh(dir, tileh)) {
815 return CommandCost(STR_ERROR_FLAT_LAND_REQUIRED);
816 }
817 }
818 cost.AddCost(_price[PR_BUILD_FOUNDATION]);
819 }
820
821 /* The level of this tile must be equal to allowed_z. */
822 if (allowed_z < 0) {
823 /* First tile. */
824 allowed_z = flat_z;
825 } else if (allowed_z != flat_z) {
826 return CommandCost(STR_ERROR_FLAT_LAND_REQUIRED);
827 }
828
829 return cost;
830}
831
839{
841 int allowed_z = -1;
842
843 for (; tile_iter != INVALID_TILE; ++tile_iter) {
844 CommandCost ret = CheckBuildableTile(tile_iter, {}, allowed_z, true);
845 if (ret.Failed()) return ret;
846 cost.AddCost(ret.GetCost());
847
848 ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile_iter);
849 if (ret.Failed()) return ret;
850 cost.AddCost(ret.GetCost());
851 }
852
853 return cost;
854}
855
862{
863 static constexpr std::array<StringID, to_underlying(StationType::End)> too_low_msgs = {
864 STR_ERROR_BRIDGE_TOO_LOW_FOR_STATION, // Rail
865 INVALID_STRING_ID, // Airport
866 STR_ERROR_BRIDGE_TOO_LOW_FOR_ROADSTOP, // Truck
867 STR_ERROR_BRIDGE_TOO_LOW_FOR_ROADSTOP, // Bus
868 INVALID_STRING_ID, // Oilrig
869 STR_ERROR_BRIDGE_TOO_LOW_FOR_DOCK, // Dock
870 STR_ERROR_BRIDGE_TOO_LOW_FOR_BUOY, // Buoy
871 STR_ERROR_BRIDGE_TOO_LOW_FOR_RAIL_WAYPOINT, // RailWaypoint
872 STR_ERROR_BRIDGE_TOO_LOW_FOR_ROAD_WAYPOINT, // RoadWaypoint
873 };
874 return too_low_msgs[to_underlying(type)];
875};
876
887static CommandCost IsStationBridgeAboveOk(TileIndex tile, std::span<const BridgeableTileInfo> bridgeable_info, StationType type, StationGfx layout, int bridge_height, StringID disallowed_msg = INVALID_STRING_ID)
888{
889 int height = layout < std::size(bridgeable_info) ? bridgeable_info[layout].height : 0;
890
891 if (height == 0) {
892 if (disallowed_msg != INVALID_STRING_ID) return CommandCost{disallowed_msg};
893 /* Get normal error message associated with clearing the tile. */
895 }
896 if (GetTileMaxZ(tile) + height > bridge_height) {
897 int height_diff = (GetTileMaxZ(tile) + height - bridge_height) * TILE_HEIGHT_STEP;
899 }
900
901 return CommandCost{};
902}
903
909static std::span<const BridgeableTileInfo> GetStationBridgeableTileInfo(StationType type)
910{
911 return _station_bridgeable_info[to_underlying(type)];
912}
913
923{
924 if (!IsBridgeAbove(tile)) return CommandCost();
925
926 TileIndex rampsouth = GetSouthernBridgeEnd(tile);
927 auto bridgeable_info = spec == nullptr ? GetStationBridgeableTileInfo(type) : spec->bridgeable_info;
928 return IsStationBridgeAboveOk(tile, bridgeable_info, type, layout, GetBridgeHeight(rampsouth), STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
929}
930
940{
941 if (!IsBridgeAbove(tile)) return CommandCost();
942
943 TileIndex rampsouth = GetSouthernBridgeEnd(tile);
944 auto bridgeable_info = spec == nullptr ? GetStationBridgeableTileInfo(type) : spec->bridgeable_info;
945 return IsStationBridgeAboveOk(tile, bridgeable_info, type, layout, GetBridgeHeight(rampsouth), STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
946}
947
955{
956 if (!IsBridgeAbove(tile)) return CommandCost();
957
958 TileIndex rampsouth = GetSouthernBridgeEnd(tile);
959 auto bridgeable_info = GetStationBridgeableTileInfo(StationType::Dock);
960 return IsStationBridgeAboveOk(tile, bridgeable_info, StationType::Dock, layout, GetBridgeHeight(rampsouth), STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
961}
962
979static 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)
980{
982 DiagDirections invalid_dirs = AxisToDiagDirs(axis);
983
984 const StationSpec *statspec = StationClass::Get(spec_class)->GetSpec(spec_index);
985 bool slope_cb = statspec != nullptr && statspec->callback_mask.Test(StationCallbackMask::SlopeCheck);
986
987 CommandCost ret = CheckBuildableTile(tile_cur, invalid_dirs, allowed_z, false, false);
988 if (ret.Failed()) return ret;
989 cost.AddCost(ret.GetCost());
990
991 if (slope_cb) {
992 /* Do slope check if requested. */
993 ret = PerformStationTileSlopeCheck(north_tile, tile_cur, statspec, axis, plat_len, numtracks);
994 if (ret.Failed()) return ret;
995 }
996
997 /* if station is set, then we have special handling to allow building on top of already existing stations.
998 * so station points to StationID::Invalid() if we can build on any station.
999 * Or it points to a station if we're only allowed to build on exactly that station. */
1000 if (station != nullptr && IsTileType(tile_cur, MP_STATION)) {
1001 if (!IsRailStation(tile_cur)) {
1002 return ClearTile_Station(tile_cur, DoCommandFlag::Auto); // get error message
1003 } else {
1004 StationID st = GetStationIndex(tile_cur);
1005 if (*station == StationID::Invalid()) {
1006 *station = st;
1007 } else if (*station != st) {
1008 return CommandCost(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
1009 }
1010 }
1011 } else {
1012 /* If we are building a station with a valid railtype, we may be able to overbuild an existing rail tile. */
1013 if (rt != INVALID_RAILTYPE && IsPlainRailTile(tile_cur)) {
1014 /* Don't overbuild signals. */
1015 if (HasSignals(tile_cur)) return CommandCost(STR_ERROR_MUST_REMOVE_SIGNALS_FIRST);
1016
1017 /* The current rail type must have power on the to-be-built type (e.g. convert normal rail to electrified rail). */
1018 if (HasPowerOnRail(GetRailType(tile_cur), rt)) {
1019 TrackBits tracks = GetTrackBits(tile_cur);
1020 Track track = RemoveFirstTrack(&tracks);
1021 Track expected_track = invalid_dirs.Test(DIAGDIR_NE) ? TRACK_X : TRACK_Y;
1022
1023 /* The existing track must align with the desired station axis. */
1024 if (tracks == TRACK_BIT_NONE && track == expected_track) {
1025 /* Check for trains having a reservation for this tile. */
1026 if (HasBit(GetRailReservationTrackBits(tile_cur), track)) {
1027 Train *v = GetTrainForReservation(tile_cur, track);
1028 if (v != nullptr) {
1029 affected_vehicles.push_back(v);
1030 }
1031 }
1032 ret = Command<CMD_REMOVE_SINGLE_RAIL>::Do(flags, tile_cur, track);
1033 if (ret.Failed()) return ret;
1034 cost.AddCost(ret.GetCost());
1035 /* With DoCommandFlags{flags}.Reset(DoCommandFlag::Execute) CmdLandscapeClear would fail since the rail still exists */
1036 return cost;
1037 }
1038 }
1039 }
1040 ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile_cur);
1041 if (ret.Failed()) return ret;
1042 cost.AddCost(ret.GetCost());
1043 }
1044
1045 return cost;
1046}
1047
1062static 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)
1063{
1065
1066 CommandCost ret = CheckBuildableTile(cur_tile, invalid_dirs, allowed_z, !is_drive_through, false);
1067 if (ret.Failed()) return ret;
1068 cost.AddCost(ret.GetCost());
1069
1070 ret = IsRoadStationBridgeAboveOk(cur_tile, spec, station_type, is_drive_through ? GFX_TRUCK_BUS_DRIVETHROUGH_OFFSET + axis : FindFirstBit(invalid_dirs.base()));
1071 if (ret.Failed()) return ret;
1072
1073 /* If station is set, then we have special handling to allow building on top of already existing stations.
1074 * Station points to StationID::Invalid() if we can build on any station.
1075 * Or it points to a station if we're only allowed to build on exactly that station. */
1076 if (station != nullptr && IsTileType(cur_tile, MP_STATION)) {
1077 if (!IsAnyRoadStop(cur_tile)) {
1078 return ClearTile_Station(cur_tile, DoCommandFlag::Auto); // Get error message.
1079 } else {
1080 if (station_type != GetStationType(cur_tile) ||
1081 is_drive_through != IsDriveThroughStopTile(cur_tile)) {
1082 return ClearTile_Station(cur_tile, DoCommandFlag::Auto); // Get error message.
1083 }
1084 /* Drive-through station in the wrong direction. */
1085 if (is_drive_through && IsDriveThroughStopTile(cur_tile) && GetDriveThroughStopAxis(cur_tile) != axis) {
1086 return CommandCost(STR_ERROR_DRIVE_THROUGH_DIRECTION);
1087 }
1088 StationID st = GetStationIndex(cur_tile);
1089 if (*station == StationID::Invalid()) {
1090 *station = st;
1091 } else if (*station != st) {
1092 return CommandCost(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
1093 }
1094 }
1095 } else {
1096 bool build_over_road = is_drive_through && IsNormalRoadTile(cur_tile);
1097 /* Road bits in the wrong direction. */
1098 RoadBits rb = IsNormalRoadTile(cur_tile) ? GetAllRoadBits(cur_tile) : ROAD_NONE;
1099 if (build_over_road && (rb & (axis == AXIS_X ? ROAD_Y : ROAD_X)) != 0) {
1100 /* Someone was pedantic and *NEEDED* three fracking different error messages. */
1101 switch (CountBits(rb)) {
1102 case 1:
1103 return CommandCost(STR_ERROR_DRIVE_THROUGH_DIRECTION);
1104
1105 case 2:
1106 if (rb == ROAD_X || rb == ROAD_Y) return CommandCost(STR_ERROR_DRIVE_THROUGH_DIRECTION);
1107 return CommandCost(STR_ERROR_DRIVE_THROUGH_CORNER);
1108
1109 default: // 3 or 4
1110 return CommandCost(STR_ERROR_DRIVE_THROUGH_JUNCTION);
1111 }
1112 }
1113
1114 if (build_over_road) {
1115 /* There is a road, check if we can build road+tram stop over it. */
1116 RoadType road_rt = GetRoadType(cur_tile, RTT_ROAD);
1117 if (road_rt != INVALID_ROADTYPE) {
1118 Owner road_owner = GetRoadOwner(cur_tile, RTT_ROAD);
1119 if (road_owner == OWNER_TOWN) {
1120 if (!_settings_game.construction.road_stop_on_town_road) return CommandCost(STR_ERROR_DRIVE_THROUGH_ON_TOWN_ROAD);
1122 ret = CheckOwnership(road_owner);
1123 if (ret.Failed()) return ret;
1124 }
1125 uint num_pieces = CountBits(GetRoadBits(cur_tile, RTT_ROAD));
1126
1127 if (rt != INVALID_ROADTYPE && RoadTypeIsRoad(rt) && !HasPowerOnRoad(rt, road_rt)) return CommandCost(STR_ERROR_NO_SUITABLE_ROAD);
1128
1129 if (GetDisallowedRoadDirections(cur_tile) != DRD_NONE && road_owner != OWNER_TOWN) {
1130 ret = CheckOwnership(road_owner);
1131 if (ret.Failed()) return ret;
1132 }
1133
1134 cost.AddCost(RoadBuildCost(road_rt) * (2 - num_pieces));
1135 } else if (rt != INVALID_ROADTYPE && RoadTypeIsRoad(rt)) {
1136 cost.AddCost(RoadBuildCost(rt) * 2);
1137 }
1138
1139 /* There is a tram, check if we can build road+tram stop over it. */
1140 RoadType tram_rt = GetRoadType(cur_tile, RTT_TRAM);
1141 if (tram_rt != INVALID_ROADTYPE) {
1142 Owner tram_owner = GetRoadOwner(cur_tile, RTT_TRAM);
1143 if (Company::IsValidID(tram_owner) &&
1145 /* Disallow breaking end-of-line of someone else
1146 * so trams can still reverse on this tile. */
1147 HasExactlyOneBit(GetRoadBits(cur_tile, RTT_TRAM)))) {
1148 ret = CheckOwnership(tram_owner);
1149 if (ret.Failed()) return ret;
1150 }
1151 uint num_pieces = CountBits(GetRoadBits(cur_tile, RTT_TRAM));
1152
1153 if (rt != INVALID_ROADTYPE && RoadTypeIsTram(rt) && !HasPowerOnRoad(rt, tram_rt)) return CommandCost(STR_ERROR_NO_SUITABLE_ROAD);
1154
1155 cost.AddCost(RoadBuildCost(tram_rt) * (2 - num_pieces));
1156 } else if (rt != INVALID_ROADTYPE && RoadTypeIsTram(rt)) {
1157 cost.AddCost(RoadBuildCost(rt) * 2);
1158 }
1159 } else if (rt == INVALID_ROADTYPE) {
1160 return CommandCost(STR_ERROR_THERE_IS_NO_ROAD);
1161 } else {
1162 ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, cur_tile);
1163 if (ret.Failed()) return ret;
1164 cost.AddCost(ret.GetCost());
1165 cost.AddCost(RoadBuildCost(rt) * 2);
1166 }
1167 }
1168
1169 return cost;
1170}
1171
1179{
1180 TileArea cur_ta = st->train_station;
1181
1182 /* determine new size of train station region.. */
1183 int x = std::min(TileX(cur_ta.tile), TileX(new_ta.tile));
1184 int y = std::min(TileY(cur_ta.tile), TileY(new_ta.tile));
1185 new_ta.w = std::max(TileX(cur_ta.tile) + cur_ta.w, TileX(new_ta.tile) + new_ta.w) - x;
1186 new_ta.h = std::max(TileY(cur_ta.tile) + cur_ta.h, TileY(new_ta.tile) + new_ta.h) - y;
1187 new_ta.tile = TileXY(x, y);
1188
1189 /* make sure the final size is not too big. */
1191 return CommandCost(STR_ERROR_STATION_TOO_SPREAD_OUT);
1192 }
1193
1194 return CommandCost();
1195}
1196
1197RailStationTileLayout::RailStationTileLayout(const StationSpec *spec, uint8_t platforms, uint8_t length) : platforms(platforms), length(length)
1198{
1199 if (spec == nullptr) return;
1200
1201 /* Look for a predefined layout for the required size. */
1202 auto found = spec->layouts.find(GetStationLayoutKey(platforms, length));
1203 if (found != std::end(spec->layouts)) this->layout = found->second;
1204}
1205
1206StationGfx RailStationTileLayout::Iterator::operator*() const
1207{
1208 /* Use predefined layout if it exists. Mask bit zero which will indicate axis. */
1209 if (!stl.layout.empty()) return this->stl.layout[this->position] & ~1;
1210
1211 if (this->stl.length == 1) {
1212 /* Special case for 1-long platforms, all bare platforms except one small building. */
1213 return this->position == ((this->stl.platforms - 1) / 2) ? 2 : 0;
1214 }
1215
1216 if ((this->position < this->stl.length && (this->stl.platforms % 2 == 1))) {
1217 /* Number of tracks is odd, make the first platform bare with a small building. */
1218 return this->position == ((this->stl.length - 1) / 2) ? 2 : 0;
1219 }
1220
1221 if (this->stl.length > 4 && ((this->position % this->stl.length) == 0 || (this->position % this->stl.length) == this->stl.length - 1)) {
1222 /* Station is longer than 4 tiles, place bare platforms at either end. */
1223 return 0;
1224 }
1225
1226 /* None of the above so must be north or south part of larger station. */
1227 return (((this->position / this->stl.length) % 2) == (this->stl.platforms % 2)) ? 4 : 6;
1228}
1229
1242template <class T, StringID error_message, class F>
1243CommandCost FindJoiningBaseStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, T **st, F filter)
1244{
1245 assert(*st == nullptr);
1246 bool check_surrounding = true;
1247
1248 if (existing_station != StationID::Invalid()) {
1249 if (adjacent && existing_station != station_to_join) {
1250 /* You can't build an adjacent station over the top of one that
1251 * already exists. */
1252 return CommandCost(error_message);
1253 } else {
1254 /* Extend the current station, and don't check whether it will
1255 * be near any other stations. */
1256 T *candidate = T::GetIfValid(existing_station);
1257 if (candidate != nullptr && filter(candidate)) *st = candidate;
1258 check_surrounding = (*st == nullptr);
1259 }
1260 } else {
1261 /* There's no station here. Don't check the tiles surrounding this
1262 * one if the company wanted to build an adjacent station. */
1263 if (adjacent) check_surrounding = false;
1264 }
1265
1266 if (check_surrounding) {
1267 /* Make sure there is no more than one other station around us that is owned by us. */
1268 CommandCost ret = GetStationAround(ta, existing_station, _current_company, st, filter);
1269 if (ret.Failed()) return ret;
1270 }
1271
1272 /* Distant join */
1273 if (*st == nullptr && station_to_join != StationID::Invalid()) *st = T::GetIfValid(station_to_join);
1274
1275 return CommandCost();
1276}
1277
1287static CommandCost FindJoiningStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
1288{
1289 return FindJoiningBaseStation<Station, STR_ERROR_MUST_REMOVE_RAILWAY_STATION_FIRST>(existing_station, station_to_join, adjacent, ta, st, [](const Station *) -> bool { return true; });
1290}
1291
1302CommandCost FindJoiningWaypoint(StationID existing_waypoint, StationID waypoint_to_join, bool adjacent, TileArea ta, Waypoint **wp, bool is_road)
1303{
1304 if (is_road) {
1305 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); });
1306 } else {
1307 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); });
1308 }
1309}
1310
1322
1334
1349static 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)
1350{
1352 bool length_price_ready = true;
1353 uint8_t tracknum = 0;
1354 int allowed_z = -1;
1355 for (TileIndex cur_tile : tile_area) {
1356 /* Clear the land below the station. */
1357 CommandCost ret = CheckFlatLandRailStation(cur_tile, tile_area.tile, allowed_z, flags, axis, station, rt, affected_vehicles, spec_class, spec_index, plat_len, numtracks);
1358 if (ret.Failed()) return ret;
1359
1360 /* Only add _price[PR_BUILD_STATION_RAIL_LENGTH] once for each valid plat_len. */
1361 if (tracknum == numtracks) {
1362 length_price_ready = true;
1363 tracknum = 0;
1364 } else {
1365 tracknum++;
1366 }
1367
1368 /* AddCost for new or rotated rail stations. */
1369 if (!IsRailStationTile(cur_tile) || (IsRailStationTile(cur_tile) && GetRailStationAxis(cur_tile) != axis)) {
1370 cost.AddCost(ret.GetCost());
1371 cost.AddCost(_price[PR_BUILD_STATION_RAIL]);
1372 cost.AddCost(RailBuildCost(rt));
1373
1374 if (length_price_ready) {
1375 cost.AddCost(_price[PR_BUILD_STATION_RAIL_LENGTH]);
1376 length_price_ready = false;
1377 }
1378 }
1379 }
1380
1381 return cost;
1382}
1383
1391{
1392 /* Default stations do not draw pylons under roofs (gfx >= 4) */
1393 if (statspec == nullptr || gfx >= statspec->tileflags.size()) return gfx < 4 ? StationSpec::TileFlag::Pylons : StationSpec::TileFlags{};
1394 return statspec->tileflags[gfx];
1395}
1396
1403{
1404 const auto flags = GetStationTileFlags(GetStationGfx(tile), statspec);
1408}
1409
1424CommandCost 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)
1425{
1426 /* Does the authority allow this? */
1427 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile_org, flags);
1428 if (ret.Failed()) return ret;
1429
1430 if (!ValParamRailType(rt) || !IsValidAxis(axis)) return CMD_ERROR;
1431
1432 /* Check if the given station class is valid */
1433 if (static_cast<uint>(spec_class) >= StationClass::GetClassCount()) return CMD_ERROR;
1434 const StationClass *cls = StationClass::Get(spec_class);
1435 if (IsWaypointClass(*cls)) return CMD_ERROR;
1436 if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
1437 if (plat_len == 0 || numtracks == 0) return CMD_ERROR;
1438
1439 int w_org, h_org;
1440 if (axis == AXIS_X) {
1441 w_org = plat_len;
1442 h_org = numtracks;
1443 } else {
1444 h_org = plat_len;
1445 w_org = numtracks;
1446 }
1447
1448 /* Check if the first tile and the last tile are valid */
1449 if (!IsValidTile(tile_org) || TileAddWrap(tile_org, w_org - 1, h_org - 1) == INVALID_TILE) return CMD_ERROR;
1450
1451 bool reuse = (station_to_join != NEW_STATION);
1452 if (!reuse) station_to_join = StationID::Invalid();
1453 bool distant_join = (station_to_join != StationID::Invalid());
1454
1455 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
1456
1458
1459 /* these values are those that will be stored in train_tile and station_platforms */
1460 TileArea new_location(tile_org, w_org, h_org);
1461
1462 /* Make sure the area below consists of clear tiles. (OR tiles belonging to a certain rail station) */
1463 StationID est = StationID::Invalid();
1464 std::vector<Train *> affected_vehicles;
1465 /* Add construction and clearing expenses. */
1466 CommandCost cost = CalculateRailStationCost(new_location, flags, axis, &est, rt, affected_vehicles, spec_class, spec_index, plat_len, numtracks);
1467 if (cost.Failed()) return cost;
1468
1469 Station *st = nullptr;
1470 ret = FindJoiningStation(est, station_to_join, adjacent, new_location, &st);
1471 if (ret.Failed()) return ret;
1472
1473 ret = BuildStationPart(&st, flags, reuse, new_location, STATIONNAMING_RAIL);
1474 if (ret.Failed()) return ret;
1475
1476 if (st != nullptr && st->train_station.tile != INVALID_TILE) {
1477 ret = CanExpandRailStation(st, new_location);
1478 if (ret.Failed()) return ret;
1479 }
1480
1481 const StationSpec *statspec = StationClass::Get(spec_class)->GetSpec(spec_index);
1482 TileIndexDiff tile_delta = TileOffsByAxis(axis); // offset to go to the next platform tile
1483 TileIndexDiff track_delta = TileOffsByAxis(OtherAxis(axis)); // offset to go to the next track
1484
1485 RailStationTileLayout stl{statspec, numtracks, plat_len};
1486 for (auto [i, it, tile_track] = std::make_tuple(0, stl.begin(), tile_org); i != numtracks; ++i, tile_track += track_delta) {
1487 for (auto [j, tile] = std::make_tuple(0, tile_track); j != plat_len; ++j, tile += tile_delta, ++it) {
1488 /* Don't check the layout if there's no bridge above anyway. */
1489 if (!IsBridgeAbove(tile)) continue;
1490
1491 StationGfx gfx = *it + axis;
1492 if (statspec != nullptr) {
1493 uint32_t platinfo = GetPlatformInfo(AXIS_X, gfx, plat_len, numtracks, j, i, false);
1494 /* As the station is not yet completely finished, the station does not yet exist. */
1495 uint16_t callback = GetStationCallback(CBID_STATION_BUILD_TILE_LAYOUT, platinfo, 0, statspec, nullptr, INVALID_TILE);
1496 if (callback != CALLBACK_FAILED && callback <= UINT8_MAX) gfx = (callback & ~1) + axis;
1497 }
1498
1499 ret = IsRailStationBridgeAboveOk(tile, statspec, StationType::Rail, gfx);
1500 if (ret.Failed()) return ret;
1501 }
1502 }
1503
1504 /* Check if we can allocate a custom stationspec to this station */
1505 auto specindex = AllocateSpecToStation(statspec, st);
1506 if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
1507
1508 if (statspec != nullptr) {
1509 /* Perform NewStation checks */
1510
1511 /* Check if the station size is permitted */
1512 if (HasBit(statspec->disallowed_platforms, std::min(numtracks - 1, 7))) return CommandCost(STR_ERROR_STATION_DISALLOWED_NUMBER_TRACKS);
1513 if (HasBit(statspec->disallowed_lengths, std::min(plat_len - 1, 7))) return CommandCost(STR_ERROR_STATION_DISALLOWED_LENGTH);
1514
1515 /* Check if the station is buildable */
1517 uint16_t cb_res = GetStationCallback(CBID_STATION_AVAILABILITY, 0, 0, statspec, nullptr, INVALID_TILE);
1519 }
1520 }
1521
1522 if (flags.Test(DoCommandFlag::Execute)) {
1523 st->train_station = new_location;
1524 st->AddFacility(StationFacility::Train, new_location.tile);
1525
1526 st->rect.BeforeAddRect(tile_org, w_org, h_org, StationRect::ADD_TRY);
1527
1528 if (specindex.has_value()) AssignSpecToStation(statspec, st, *specindex);
1529 if (statspec != nullptr) {
1530 /* Include this station spec's animation trigger bitmask
1531 * in the station's cached copy. */
1532 st->cached_anim_triggers.Set(statspec->animation.triggers);
1533 }
1534
1535 Track track = AxisToTrack(axis);
1536 Company *c = Company::Get(st->owner);
1537 for (auto [i, it, tile_track] = std::make_tuple(0, stl.begin(), tile_org); i != numtracks; ++i, tile_track += track_delta) {
1538 for (auto [j, tile] = std::make_tuple(0, tile_track); j != plat_len; ++j, tile += tile_delta, ++it) {
1539 if (IsRailStationTile(tile) && HasStationReservation(tile)) {
1540 /* Check for trains having a reservation for this tile. */
1542 if (v != nullptr) {
1543 affected_vehicles.push_back(v);
1545 }
1546 }
1547
1548 /* Railtype can change when overbuilding. */
1549 if (IsRailStationTile(tile)) {
1550 if (!IsStationTileBlocked(tile)) c->infrastructure.rail[GetRailType(tile)]--;
1552 }
1553
1554 /* Remove animation if overbuilding */
1555 DeleteAnimatedTile(tile);
1556 uint8_t old_specindex = HasStationTileRail(tile) ? GetCustomStationSpecIndex(tile) : 0;
1557
1558 MakeRailStation(tile, st->owner, st->index, axis, *it, rt);
1559 /* Free the spec if we overbuild something */
1560 DeallocateSpecFromStation(st, old_specindex);
1561 if (statspec == nullptr) DeleteNewGRFInspectWindow(GSF_STATIONS, tile);
1562
1563 SetCustomStationSpecIndex(tile, *specindex);
1564 SetStationTileRandomBits(tile, GB(Random(), 0, 4));
1565 SetAnimationFrame(tile, 0);
1566
1567 if (statspec != nullptr) {
1568 /* Use a fixed axis for GetPlatformInfo as our platforms / numtracks are always the right way around */
1569 uint32_t platinfo = GetPlatformInfo(AXIS_X, GetStationGfx(tile), plat_len, numtracks, j, i, false);
1570
1571 /* As the station is not yet completely finished, the station does not yet exist. */
1572 uint16_t callback = GetStationCallback(CBID_STATION_BUILD_TILE_LAYOUT, platinfo, 0, statspec, nullptr, tile);
1573 if (callback != CALLBACK_FAILED) {
1574 if (callback <= UINT8_MAX) {
1575 SetStationGfx(tile, (callback & ~1) + axis);
1576 } else {
1578 }
1579 }
1580
1581 /* Trigger station animation -- after building? */
1582 TriggerStationAnimation(st, tile, StationAnimationTrigger::Built);
1583 }
1584
1585 SetRailStationTileFlags(tile, statspec);
1586
1587 if (!IsStationTileBlocked(tile)) c->infrastructure.rail[rt]++;
1589 }
1590 AddTrackToSignalBuffer(tile_track, track, _current_company);
1591 YapfNotifyTrackLayoutChange(tile_track, track);
1592 }
1593
1594 for (uint i = 0; i < affected_vehicles.size(); ++i) {
1595 /* Restore reservations of trains. */
1596 RestoreTrainReservation(affected_vehicles[i]);
1597 }
1598
1599 /* Check whether we need to expand the reservation of trains already on the station. */
1600 TileArea update_reservation_area;
1601 if (axis == AXIS_X) {
1602 update_reservation_area = TileArea(tile_org, 1, numtracks);
1603 } else {
1604 update_reservation_area = TileArea(tile_org, numtracks, 1);
1605 }
1606
1607 for (TileIndex tile : update_reservation_area) {
1608 /* Don't even try to make eye candy parts reserved. */
1609 if (IsStationTileBlocked(tile)) continue;
1610
1611 DiagDirection dir = AxisToDiagDir(axis);
1612 TileIndexDiff tile_offset = TileOffsByDiagDir(dir);
1613 TileIndex platform_begin = tile;
1614 TileIndex platform_end = tile;
1615
1616 /* We can only account for tiles that are reachable from this tile, so ignore primarily blocked tiles while finding the platform begin and end. */
1617 for (TileIndex next_tile = platform_begin - tile_offset; IsCompatibleTrainStationTile(next_tile, platform_begin); next_tile -= tile_offset) {
1618 platform_begin = next_tile;
1619 }
1620 for (TileIndex next_tile = platform_end + tile_offset; IsCompatibleTrainStationTile(next_tile, platform_end); next_tile += tile_offset) {
1621 platform_end = next_tile;
1622 }
1623
1624 /* If there is at least on reservation on the platform, we reserve the whole platform. */
1625 bool reservation = false;
1626 for (TileIndex t = platform_begin; !reservation && t <= platform_end; t += tile_offset) {
1627 reservation = HasStationReservation(t);
1628 }
1629
1630 if (reservation) {
1631 SetRailStationPlatformReservation(platform_begin, dir, true);
1632 }
1633 }
1634
1635 st->MarkTilesDirty(false);
1636 st->AfterStationTileSetChange(true, StationType::Rail);
1637 }
1638
1639 return cost;
1640}
1641
1642static TileArea MakeStationAreaSmaller(BaseStation *st, TileArea ta, bool (*func)(BaseStation *, TileIndex))
1643{
1644restart:
1645
1646 /* too small? */
1647 if (ta.w != 0 && ta.h != 0) {
1648 /* check the left side, x = constant, y changes */
1649 for (uint i = 0; !func(st, ta.tile + TileDiffXY(0, i));) {
1650 /* the left side is unused? */
1651 if (++i == ta.h) {
1652 ta.tile += TileDiffXY(1, 0);
1653 ta.w--;
1654 goto restart;
1655 }
1656 }
1657
1658 /* check the right side, x = constant, y changes */
1659 for (uint i = 0; !func(st, ta.tile + TileDiffXY(ta.w - 1, i));) {
1660 /* the right side is unused? */
1661 if (++i == ta.h) {
1662 ta.w--;
1663 goto restart;
1664 }
1665 }
1666
1667 /* check the upper side, y = constant, x changes */
1668 for (uint i = 0; !func(st, ta.tile + TileDiffXY(i, 0));) {
1669 /* the left side is unused? */
1670 if (++i == ta.w) {
1671 ta.tile += TileDiffXY(0, 1);
1672 ta.h--;
1673 goto restart;
1674 }
1675 }
1676
1677 /* check the lower side, y = constant, x changes */
1678 for (uint i = 0; !func(st, ta.tile + TileDiffXY(i, ta.h - 1));) {
1679 /* the left side is unused? */
1680 if (++i == ta.w) {
1681 ta.h--;
1682 goto restart;
1683 }
1684 }
1685 } else {
1686 ta.Clear();
1687 }
1688
1689 return ta;
1690}
1691
1692static bool TileBelongsToRailStation(BaseStation *st, TileIndex tile)
1693{
1694 return st->TileBelongsToRailStation(tile);
1695}
1696
1697static void MakeRailStationAreaSmaller(BaseStation *st)
1698{
1699 st->train_station = MakeStationAreaSmaller(st, st->train_station, TileBelongsToRailStation);
1700}
1701
1702static bool TileBelongsToShipStation(BaseStation *st, TileIndex tile)
1703{
1704 return IsDockTile(tile) && GetStationIndex(tile) == st->index;
1705}
1706
1707static void MakeShipStationAreaSmaller(Station *st)
1708{
1709 st->ship_station = MakeStationAreaSmaller(st, st->ship_station, TileBelongsToShipStation);
1710 UpdateStationDockingTiles(st);
1711}
1712
1713static bool TileBelongsToRoadWaypointStation(BaseStation *st, TileIndex tile)
1714{
1715 return IsRoadWaypointTile(tile) && GetStationIndex(tile) == st->index;
1716}
1717
1718void MakeRoadWaypointStationAreaSmaller(BaseStation *st, TileArea &road_waypoint_area)
1719{
1720 road_waypoint_area = MakeStationAreaSmaller(st, road_waypoint_area, TileBelongsToRoadWaypointStation);
1721}
1722
1733template <class T>
1734CommandCost RemoveFromRailBaseStation(TileArea ta, std::vector<T *> &affected_stations, DoCommandFlags flags, Money removal_cost, bool keep_rail)
1735{
1736 /* Count of the number of tiles removed */
1737 int quantity = 0;
1739 /* Accumulator for the errors seen during clearing. If no errors happen,
1740 * and the quantity is 0 there is no station. Otherwise it will be one
1741 * of the other error that got accumulated. */
1742 CommandCost error;
1743
1744 /* Do the action for every tile into the area */
1745 for (TileIndex tile : ta) {
1746 /* Make sure the specified tile is a rail station */
1747 if (!HasStationTileRail(tile)) continue;
1748
1749 /* If there is a vehicle on ground, do not allow to remove (flood) the tile */
1751 error.AddCost(std::move(ret));
1752 if (error.Failed()) continue;
1753
1754 /* Check ownership of station */
1755 T *st = T::GetByTile(tile);
1756 if (st == nullptr) continue;
1757
1759 ret = CheckOwnership(st->owner);
1760 error.AddCost(std::move(ret));
1761 if (error.Failed()) continue;
1762 }
1763
1764 /* If we reached here, the tile is valid so increase the quantity of tiles we will remove */
1765 quantity++;
1766
1767 if (keep_rail || IsStationTileBlocked(tile)) {
1768 /* Don't refund the 'steel' of the track when we keep the
1769 * rail, or when the tile didn't have any rail at all. */
1770 total_cost.AddCost(-_price[PR_CLEAR_RAIL]);
1771 }
1772
1773 if (flags.Test(DoCommandFlag::Execute)) {
1774 /* read variables before the station tile is removed */
1775 uint specindex = GetCustomStationSpecIndex(tile);
1776 Track track = GetRailStationTrack(tile);
1777 Owner owner = GetTileOwner(tile);
1778 RailType rt = GetRailType(tile);
1779 Train *v = nullptr;
1780
1781 if (HasStationReservation(tile)) {
1782 v = GetTrainForReservation(tile, track);
1783 if (v != nullptr) FreeTrainReservation(v);
1784 }
1785
1786 bool build_rail = keep_rail && !IsStationTileBlocked(tile);
1787 if (!build_rail && !IsStationTileBlocked(tile)) Company::Get(owner)->infrastructure.rail[rt]--;
1788
1789 DoClearSquare(tile);
1790 DeleteNewGRFInspectWindow(GSF_STATIONS, tile.base());
1791 if (build_rail) MakeRailNormal(tile, owner, TrackToTrackBits(track), rt);
1792 Company::Get(owner)->infrastructure.station--;
1794
1795 st->rect.AfterRemoveTile(st, tile);
1796 AddTrackToSignalBuffer(tile, track, owner);
1797 YapfNotifyTrackLayoutChange(tile, track);
1798
1799 DeallocateSpecFromStation(st, specindex);
1800
1801 include(affected_stations, st);
1802
1803 if (v != nullptr) RestoreTrainReservation(v);
1804 }
1805 }
1806
1807 if (quantity == 0) return error.Failed() ? error : CommandCost(STR_ERROR_THERE_IS_NO_STATION);
1808
1809 for (T *st : affected_stations) {
1810
1811 /* now we need to make the "spanned" area of the railway station smaller
1812 * if we deleted something at the edges.
1813 * we also need to adjust train_tile. */
1814 MakeRailStationAreaSmaller(st);
1815 UpdateStationSignCoord(st);
1816
1817 /* if we deleted the whole station, delete the train facility. */
1818 if (st->train_station.tile == INVALID_TILE) {
1822 MarkCatchmentTilesDirty();
1823 st->UpdateVirtCoord();
1825 }
1826 }
1827
1828 total_cost.AddCost(quantity * removal_cost);
1829 return total_cost;
1830}
1831
1842{
1843 if (end == 0) end = start;
1844 if (start >= Map::Size() || end >= Map::Size()) return CMD_ERROR;
1845
1846 TileArea ta(start, end);
1847 std::vector<Station *> affected_stations;
1848
1849 CommandCost ret = RemoveFromRailBaseStation(ta, affected_stations, flags, _price[PR_CLEAR_STATION_RAIL], keep_rail);
1850 if (ret.Failed()) return ret;
1851
1852 /* Do all station specific functions here. */
1853 for (Station *st : affected_stations) {
1854
1856 st->MarkTilesDirty(false);
1857 MarkCatchmentTilesDirty();
1858 st->RecomputeCatchment();
1859 }
1860
1861 /* Now apply the rail cost to the number that we deleted */
1862 return ret;
1863}
1864
1875{
1876 if (end == 0) end = start;
1877 if (start >= Map::Size() || end >= Map::Size()) return CMD_ERROR;
1878
1879 TileArea ta(start, end);
1880 std::vector<Waypoint *> affected_stations;
1881
1882 return RemoveFromRailBaseStation(ta, affected_stations, flags, _price[PR_CLEAR_WAYPOINT_RAIL], keep_rail);
1883}
1884
1885
1894template <class T>
1896{
1897 /* Current company owns the station? */
1899 CommandCost ret = CheckOwnership(st->owner);
1900 if (ret.Failed()) return ret;
1901 }
1902
1903 /* determine width and height of platforms */
1904 TileArea ta = st->train_station;
1905
1906 assert(ta.w != 0 && ta.h != 0);
1907
1909 /* clear all areas of the station */
1910 for (TileIndex tile : ta) {
1911 /* only remove tiles that are actually train station tiles */
1912 if (st->TileBelongsToRailStation(tile)) {
1913 std::vector<T*> affected_stations; // dummy
1914 CommandCost ret = RemoveFromRailBaseStation(TileArea(tile, 1, 1), affected_stations, flags, removal_cost, false);
1915 if (ret.Failed()) return ret;
1916 cost.AddCost(ret.GetCost());
1917 }
1918 }
1919
1920 return cost;
1921}
1922
1930{
1931 /* if there is flooding, remove platforms tile by tile */
1934 }
1935
1936 Station *st = Station::GetByTile(tile);
1937 CommandCost cost = RemoveRailStation(st, flags, _price[PR_CLEAR_STATION_RAIL]);
1938
1940
1941 return cost;
1942}
1943
1951{
1952 /* if there is flooding, remove waypoints tile by tile */
1955 }
1956
1957 return RemoveRailStation(Waypoint::GetByTile(tile), flags, _price[PR_CLEAR_WAYPOINT_RAIL]);
1958}
1959
1960
1966static RoadStop **FindRoadStopSpot(bool truck_station, Station *st)
1967{
1968 RoadStop **primary_stop = (truck_station) ? &st->truck_stops : &st->bus_stops;
1969
1970 if (*primary_stop == nullptr) {
1971 /* we have no roadstop of the type yet, so write a "primary stop" */
1972 return primary_stop;
1973 } else {
1974 /* there are stops already, so append to the end of the list */
1975 RoadStop *stop = *primary_stop;
1976 while (stop->next != nullptr) stop = stop->next;
1977 return &stop->next;
1978 }
1979}
1980
1981static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index = -1);
1982CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index = -1);
1983
1993static CommandCost FindJoiningRoadStop(StationID existing_stop, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
1994{
1995 return FindJoiningBaseStation<Station, STR_ERROR_MUST_REMOVE_ROAD_STOP_FIRST>(existing_stop, station_to_join, adjacent, ta, st, [](const Station *) -> bool { return true; });
1996}
1997
2012CommandCost CalculateRoadStopCost(TileArea tile_area, DoCommandFlags flags, bool is_drive_through, StationType station_type, const RoadStopSpec *roadstopspec, Axis axis, DiagDirection ddir, StationID *est, RoadType rt, Money unit_cost)
2013{
2014 DiagDirections invalid_dirs{};
2015 if (is_drive_through) {
2016 invalid_dirs.Set(AxisToDiagDir(axis));
2017 invalid_dirs.Set(ReverseDiagDir(AxisToDiagDir(axis)));
2018 } else {
2019 invalid_dirs.Set(ddir);
2020 }
2021
2022 /* Check every tile in the area. */
2023 int allowed_z = -1;
2025 for (TileIndex cur_tile : tile_area) {
2026 CommandCost ret = CheckFlatLandRoadStop(cur_tile, allowed_z, roadstopspec, flags, invalid_dirs, is_drive_through, station_type, axis, est, rt);
2027 if (ret.Failed()) return ret;
2028
2029 bool is_preexisting_roadstop = IsTileType(cur_tile, MP_STATION) && IsAnyRoadStop(cur_tile);
2030
2031 /* Only add costs if a stop doesn't already exist in the location */
2032 if (!is_preexisting_roadstop) {
2033 cost.AddCost(ret.GetCost());
2034 cost.AddCost(unit_cost);
2035 }
2036 }
2037
2038 return cost;
2039}
2040
2057CommandCost CmdBuildRoadStop(DoCommandFlags flags, TileIndex tile, uint8_t width, uint8_t length, RoadStopType stop_type, bool is_drive_through,
2058 DiagDirection ddir, RoadType rt, RoadStopClassID spec_class, uint16_t spec_index, StationID station_to_join, bool adjacent)
2059{
2060 if (!ValParamRoadType(rt) || !IsValidDiagDirection(ddir) || stop_type >= RoadStopType::End) return CMD_ERROR;
2061 bool reuse = (station_to_join != NEW_STATION);
2062 if (!reuse) station_to_join = StationID::Invalid();
2063 bool distant_join = (station_to_join != StationID::Invalid());
2064
2065 /* Check if the given station class is valid */
2066 if (static_cast<uint>(spec_class) >= RoadStopClass::GetClassCount()) return CMD_ERROR;
2067 const RoadStopClass *cls = RoadStopClass::Get(spec_class);
2068 if (IsWaypointClass(*cls)) return CMD_ERROR;
2069 if (spec_index >= cls->GetSpecCount()) return CMD_ERROR;
2070
2071 const RoadStopSpec *roadstopspec = cls->GetSpec(spec_index);
2072 if (roadstopspec != nullptr) {
2073 if (stop_type == RoadStopType::Truck && roadstopspec->stop_type != ROADSTOPTYPE_FREIGHT && roadstopspec->stop_type != ROADSTOPTYPE_ALL) return CMD_ERROR;
2074 if (stop_type == RoadStopType::Bus && roadstopspec->stop_type != ROADSTOPTYPE_PASSENGER && roadstopspec->stop_type != ROADSTOPTYPE_ALL) return CMD_ERROR;
2075 if (!is_drive_through && roadstopspec->flags.Test(RoadStopSpecFlag::DriveThroughOnly)) return CMD_ERROR;
2076 }
2077
2078 /* Check if the requested road stop is too big */
2079 if (width > _settings_game.station.station_spread || length > _settings_game.station.station_spread) return CommandCost(STR_ERROR_STATION_TOO_SPREAD_OUT);
2080 /* Check for incorrect width / length. */
2081 if (width == 0 || length == 0) return CMD_ERROR;
2082 /* Check if the first tile and the last tile are valid */
2083 if (!IsValidTile(tile) || TileAddWrap(tile, width - 1, length - 1) == INVALID_TILE) return CMD_ERROR;
2084
2085 TileArea roadstop_area(tile, width, length);
2086
2087 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2088
2089 /* Trams only have drive through stops */
2090 if (!is_drive_through && RoadTypeIsTram(rt)) return CMD_ERROR;
2091
2092 Axis axis = DiagDirToAxis(ddir);
2093
2095 if (ret.Failed()) return ret;
2096
2097 bool is_truck_stop = stop_type != RoadStopType::Bus;
2098
2099 /* Total road stop cost. */
2100 Money unit_cost;
2101 if (roadstopspec != nullptr) {
2102 unit_cost = roadstopspec->GetBuildCost(is_truck_stop ? PR_BUILD_STATION_TRUCK : PR_BUILD_STATION_BUS);
2103 } else {
2104 unit_cost = _price[is_truck_stop ? PR_BUILD_STATION_TRUCK : PR_BUILD_STATION_BUS];
2105 }
2106 StationID est = StationID::Invalid();
2107 CommandCost cost = CalculateRoadStopCost(roadstop_area, flags, is_drive_through, is_truck_stop ? StationType::Truck : StationType::Bus, roadstopspec, axis, ddir, &est, rt, unit_cost);
2108 if (cost.Failed()) return cost;
2109
2110 Station *st = nullptr;
2111 ret = FindJoiningRoadStop(est, station_to_join, adjacent, roadstop_area, &st);
2112 if (ret.Failed()) return ret;
2113
2114 /* Check if this number of road stops can be allocated. */
2115 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);
2116
2117 ret = BuildStationPart(&st, flags, reuse, roadstop_area, STATIONNAMING_ROAD);
2118 if (ret.Failed()) return ret;
2119
2120 /* Check if we can allocate a custom stationspec to this station */
2121 auto specindex = AllocateSpecToRoadStop(roadstopspec, st);
2122 if (!specindex.has_value()) return CommandCost(STR_ERROR_TOO_MANY_STATION_SPECS);
2123
2124 if (roadstopspec != nullptr) {
2125 /* Perform NewGRF checks */
2126
2127 /* Check if the road stop is buildable */
2128 if (roadstopspec->callback_mask.Test(RoadStopCallbackMask::Avail)) {
2129 uint16_t cb_res = GetRoadStopCallback(CBID_STATION_AVAILABILITY, 0, 0, roadstopspec, nullptr, INVALID_TILE, rt, is_truck_stop ? StationType::Truck : StationType::Bus, 0);
2130 if (cb_res != CALLBACK_FAILED && !Convert8bitBooleanCallback(roadstopspec->grf_prop.grffile, CBID_STATION_AVAILABILITY, cb_res)) return CMD_ERROR;
2131 }
2132 }
2133
2134 if (flags.Test(DoCommandFlag::Execute)) {
2135 if (specindex.has_value()) AssignSpecToRoadStop(roadstopspec, st, *specindex);
2136 /* Check every tile in the area. */
2137 for (TileIndex cur_tile : roadstop_area) {
2138 /* Get existing road types and owners before any tile clearing */
2139 RoadType road_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RTT_ROAD) : INVALID_ROADTYPE;
2140 RoadType tram_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RTT_TRAM) : INVALID_ROADTYPE;
2141 Owner road_owner = road_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RTT_ROAD) : _current_company;
2142 Owner tram_owner = tram_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RTT_TRAM) : _current_company;
2143
2144 if (IsTileType(cur_tile, MP_STATION) && IsStationRoadStop(cur_tile)) {
2145 RemoveRoadStop(cur_tile, flags, *specindex);
2146 }
2147
2148 if (roadstopspec != nullptr) {
2149 /* Include this road stop spec's animation trigger bitmask
2150 * in the station's cached copy. */
2151 st->cached_roadstop_anim_triggers.Set(roadstopspec->animation.triggers);
2152 }
2153
2154 RoadStop *road_stop = new RoadStop(cur_tile);
2155 /* Insert into linked list of RoadStops. */
2156 RoadStop **currstop = FindRoadStopSpot(is_truck_stop, st);
2157 *currstop = road_stop;
2158
2159 if (is_truck_stop) {
2160 st->truck_station.Add(cur_tile);
2161 } else {
2162 st->bus_station.Add(cur_tile);
2163 }
2164
2165 /* Initialize an empty station. */
2166 st->AddFacility(is_truck_stop ? StationFacility::TruckStop : StationFacility::BusStop, cur_tile);
2167
2168 st->rect.BeforeAddTile(cur_tile, StationRect::ADD_TRY);
2169
2170 RoadStopType rs_type = is_truck_stop ? RoadStopType::Truck : RoadStopType::Bus;
2171 if (is_drive_through) {
2172 /* Update company infrastructure counts. If the current tile is a normal road tile, remove the old
2173 * bits first. */
2174 if (IsNormalRoadTile(cur_tile)) {
2175 UpdateCompanyRoadInfrastructure(road_rt, road_owner, -(int)CountBits(GetRoadBits(cur_tile, RTT_ROAD)));
2176 UpdateCompanyRoadInfrastructure(tram_rt, tram_owner, -(int)CountBits(GetRoadBits(cur_tile, RTT_TRAM)));
2177 }
2178
2179 if (road_rt == INVALID_ROADTYPE && RoadTypeIsRoad(rt)) road_rt = rt;
2180 if (tram_rt == INVALID_ROADTYPE && RoadTypeIsTram(rt)) tram_rt = rt;
2181
2182 MakeDriveThroughRoadStop(cur_tile, st->owner, road_owner, tram_owner, st->index, (rs_type == RoadStopType::Bus ? StationType::Bus : StationType::Truck), road_rt, tram_rt, axis);
2183 road_stop->MakeDriveThrough();
2184 } else {
2185 if (road_rt == INVALID_ROADTYPE && RoadTypeIsRoad(rt)) road_rt = rt;
2186 if (tram_rt == INVALID_ROADTYPE && RoadTypeIsTram(rt)) tram_rt = rt;
2187 MakeRoadStop(cur_tile, st->owner, st->index, rs_type, road_rt, tram_rt, ddir);
2188 }
2191 Company::Get(st->owner)->infrastructure.station++;
2192
2193 SetCustomRoadStopSpecIndex(cur_tile, *specindex);
2194 if (roadstopspec != nullptr) {
2195 st->SetRoadStopRandomBits(cur_tile, GB(Random(), 0, 8));
2196 TriggerRoadStopAnimation(st, cur_tile, StationAnimationTrigger::Built);
2197 }
2198
2199 MarkTileDirtyByTile(cur_tile);
2200 }
2201
2202 if (st != nullptr) {
2203 st->AfterStationTileSetChange(true, is_truck_stop ? StationType::Truck: StationType::Bus);
2204 }
2205 }
2206 return cost;
2207}
2208
2216static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index)
2217{
2218 Station *st = Station::GetByTile(tile);
2219
2221 CommandCost ret = CheckOwnership(st->owner);
2222 if (ret.Failed()) return ret;
2223 }
2224
2225 bool is_truck = IsTruckStop(tile);
2226
2227 RoadStop **primary_stop;
2228 RoadStop *cur_stop;
2229 if (is_truck) { // truck stop
2230 primary_stop = &st->truck_stops;
2231 cur_stop = RoadStop::GetByTile(tile, RoadStopType::Truck);
2232 } else {
2233 primary_stop = &st->bus_stops;
2234 cur_stop = RoadStop::GetByTile(tile, RoadStopType::Bus);
2235 }
2236
2237 assert(cur_stop != nullptr);
2238
2239 /* don't do the check for drive-through road stops when company bankrupts */
2241 /* remove the 'going through road stop' status from all vehicles on that tile */
2242 if (flags.Test(DoCommandFlag::Execute)) {
2243 for (Vehicle *v : VehiclesOnTile(tile)) {
2244 if (v->type != VEH_ROAD) continue;
2245 /* Okay... we are a road vehicle on a drive through road stop.
2246 * But that road stop has just been removed, so we need to make
2247 * sure we are in a valid state... however, vehicles can also
2248 * turn on road stop tiles, so only clear the 'road stop' state
2249 * bits and only when the state was 'in road stop', otherwise
2250 * we'll end up clearing the turn around bits. */
2253 }
2254 }
2255 } else {
2257 if (ret.Failed()) return ret;
2258 }
2259
2260 const RoadStopSpec *spec = GetRoadStopSpec(tile);
2261
2262 if (flags.Test(DoCommandFlag::Execute)) {
2263 if (*primary_stop == cur_stop) {
2264 /* removed the first stop in the list */
2265 *primary_stop = cur_stop->next;
2266 /* removed the only stop? */
2267 if (*primary_stop == nullptr) {
2270 }
2271 } else {
2272 /* tell the predecessor in the list to skip this stop */
2273 RoadStop *pred = *primary_stop;
2274 while (pred->next != cur_stop) pred = pred->next;
2275 pred->next = cur_stop->next;
2276 }
2277
2278 /* Update company infrastructure counts. */
2279 for (RoadTramType rtt : _roadtramtypes) {
2280 RoadType rt = GetRoadType(tile, rtt);
2282 }
2283
2284 Company::Get(st->owner)->infrastructure.station--;
2286
2287 uint specindex = GetCustomRoadStopSpecIndex(tile);
2288
2289 DeleteNewGRFInspectWindow(GSF_ROADSTOPS, tile.base());
2290
2291 if (IsDriveThroughStopTile(tile)) {
2292 /* Clears the tile for us */
2293 cur_stop->ClearDriveThrough();
2294 DeleteAnimatedTile(tile);
2295 } else {
2296 DoClearSquare(tile);
2297 }
2298
2299 delete cur_stop;
2300
2301 /* Make sure no vehicle is going to the old roadstop. Narrow the search to any road vehicles with an order to
2302 * this station, then look for any currently heading to the tile. */
2303 StationID station_id = st->index;
2305 [](const Vehicle *v) { return v->type == VEH_ROAD; },
2306 [station_id](const Order *order) { return order->IsType(OT_GOTO_STATION) && order->GetDestination() == station_id; },
2307 [station_id, tile](Vehicle *v) {
2308 if (v->current_order.IsType(OT_GOTO_STATION) && v->dest_tile == tile) {
2309 v->SetDestTile(v->GetOrderStationLocation(station_id));
2310 }
2311 }
2312 );
2313
2314 st->rect.AfterRemoveTile(st, tile);
2315
2316 if (replacement_spec_index < 0) st->AfterStationTileSetChange(false, is_truck ? StationType::Truck: StationType::Bus);
2317
2318 st->RemoveRoadStopTileData(tile);
2319 if ((int)specindex != replacement_spec_index) DeallocateSpecFromRoadStop(st, specindex);
2320
2321 /* Update the tile area of the truck/bus stop */
2322 if (is_truck) {
2323 st->truck_station.Clear();
2324 for (const RoadStop *rs = st->truck_stops; rs != nullptr; rs = rs->next) st->truck_station.Add(rs->xy);
2325 } else {
2326 st->bus_station.Clear();
2327 for (const RoadStop *rs = st->bus_stops; rs != nullptr; rs = rs->next) st->bus_station.Add(rs->xy);
2328 }
2329 }
2330
2331 Price category = is_truck ? PR_CLEAR_STATION_TRUCK : PR_CLEAR_STATION_BUS;
2332 return CommandCost(EXPENSES_CONSTRUCTION, spec != nullptr ? spec->GetClearCost(category) : _price[category]);
2333}
2334
2342CommandCost RemoveRoadWaypointStop(TileIndex tile, DoCommandFlags flags, int replacement_spec_index)
2343{
2344 Waypoint *wp = Waypoint::GetByTile(tile);
2345
2347 CommandCost ret = CheckOwnership(wp->owner);
2348 if (ret.Failed()) return ret;
2349 }
2350
2351 /* Ignore vehicles when the company goes bankrupt. The road will remain, any vehicles going to the waypoint will be removed. */
2352 if (!flags.Test(DoCommandFlag::Bankrupt)) {
2354 if (ret.Failed()) return ret;
2355 }
2356
2357 const RoadStopSpec *spec = GetRoadStopSpec(tile);
2358
2359 if (flags.Test(DoCommandFlag::Execute)) {
2360 /* Update company infrastructure counts. */
2361 for (RoadTramType rtt : _roadtramtypes) {
2362 RoadType rt = GetRoadType(tile, rtt);
2364 }
2365
2366 Company::Get(wp->owner)->infrastructure.station--;
2368
2369 uint specindex = GetCustomRoadStopSpecIndex(tile);
2370
2371 DeleteNewGRFInspectWindow(GSF_ROADSTOPS, tile.base());
2372
2373 DoClearSquare(tile);
2374
2375 wp->rect.AfterRemoveTile(wp, tile);
2376
2377 wp->RemoveRoadStopTileData(tile);
2378 if ((int)specindex != replacement_spec_index) DeallocateSpecFromRoadStop(wp, specindex);
2379
2380 if (replacement_spec_index < 0) {
2381 MakeRoadWaypointStationAreaSmaller(wp, wp->road_waypoint_area);
2382
2383 UpdateStationSignCoord(wp);
2384
2385 /* if we deleted the whole waypoint, delete the road facility. */
2389 wp->UpdateVirtCoord();
2391 }
2392 }
2393 }
2394
2395 return CommandCost(EXPENSES_CONSTRUCTION, spec != nullptr ? spec->GetClearCost(PR_CLEAR_STATION_TRUCK) : _price[PR_CLEAR_STATION_TRUCK]);
2396}
2397
2406static CommandCost RemoveGenericRoadStop(DoCommandFlags flags, const TileArea &roadstop_area, bool road_waypoint, bool remove_road)
2407{
2409 CommandCost last_error(STR_ERROR_THERE_IS_NO_STATION);
2410 bool had_success = false;
2411
2412 for (TileIndex cur_tile : roadstop_area) {
2413 /* Make sure the specified tile is a road stop of the correct type */
2414 if (!IsTileType(cur_tile, MP_STATION) || !IsAnyRoadStop(cur_tile) || IsRoadWaypoint(cur_tile) != road_waypoint) continue;
2415
2416 /* Save information on to-be-restored roads before the stop is removed. */
2417 RoadBits road_bits = ROAD_NONE;
2418 RoadType road_type[] = { INVALID_ROADTYPE, INVALID_ROADTYPE };
2419 Owner road_owner[] = { OWNER_NONE, OWNER_NONE };
2420 if (IsDriveThroughStopTile(cur_tile)) {
2421 for (RoadTramType rtt : _roadtramtypes) {
2422 road_type[rtt] = GetRoadType(cur_tile, rtt);
2423 if (road_type[rtt] == INVALID_ROADTYPE) continue;
2424 road_owner[rtt] = GetRoadOwner(cur_tile, rtt);
2425 /* If we don't want to preserve our roads then restore only roads of others. */
2426 if (remove_road && road_owner[rtt] == _current_company) road_type[rtt] = INVALID_ROADTYPE;
2427 }
2428 road_bits = AxisToRoadBits(GetDriveThroughStopAxis(cur_tile));
2429 }
2430
2431 CommandCost ret;
2432 if (road_waypoint) {
2433 ret = RemoveRoadWaypointStop(cur_tile, flags);
2434 } else {
2435 ret = RemoveRoadStop(cur_tile, flags);
2436 }
2437 if (ret.Failed()) {
2438 last_error = std::move(ret);
2439 continue;
2440 }
2441 cost.AddCost(ret.GetCost());
2442 had_success = true;
2443
2444 /* Restore roads. */
2445 if (flags.Test(DoCommandFlag::Execute) && (road_type[RTT_ROAD] != INVALID_ROADTYPE || road_type[RTT_TRAM] != INVALID_ROADTYPE)) {
2446 MakeRoadNormal(cur_tile, road_bits, road_type[RTT_ROAD], road_type[RTT_TRAM], ClosestTownFromTile(cur_tile, UINT_MAX)->index,
2447 road_owner[RTT_ROAD], road_owner[RTT_TRAM]);
2448
2449 /* Update company infrastructure counts. */
2450 int count = CountBits(road_bits);
2451 UpdateCompanyRoadInfrastructure(road_type[RTT_ROAD], road_owner[RTT_ROAD], count);
2452 UpdateCompanyRoadInfrastructure(road_type[RTT_TRAM], road_owner[RTT_TRAM], count);
2453 }
2454 }
2455
2456 return had_success ? cost : last_error;
2457}
2458
2469CommandCost CmdRemoveRoadStop(DoCommandFlags flags, TileIndex tile, uint8_t width, uint8_t height, RoadStopType stop_type, bool remove_road)
2470{
2471 if (stop_type >= RoadStopType::End) return CMD_ERROR;
2472 /* Check for incorrect width / height. */
2473 if (width == 0 || height == 0) return CMD_ERROR;
2474 /* Check if the first tile and the last tile are valid */
2475 if (!IsValidTile(tile) || TileAddWrap(tile, width - 1, height - 1) == INVALID_TILE) return CMD_ERROR;
2476 /* Bankrupting company is not supposed to remove roads, there may be road vehicles. */
2477 if (remove_road && flags.Test(DoCommandFlag::Bankrupt)) return CMD_ERROR;
2478
2479 TileArea roadstop_area(tile, width, height);
2480
2481 return RemoveGenericRoadStop(flags, roadstop_area, false, remove_road);
2482}
2483
2492{
2493 if (end == 0) end = start;
2494 if (start >= Map::Size() || end >= Map::Size()) return CMD_ERROR;
2495
2496 TileArea roadstop_area(start, end);
2497
2498 return RemoveGenericRoadStop(flags, roadstop_area, true, false);
2499}
2500
2509uint8_t GetAirportNoiseLevelForDistance(const AirportSpec *as, uint distance)
2510{
2511 /* 0 cannot be accounted, and 1 is the lowest that can be reduced from town.
2512 * So no need to go any further*/
2513 if (as->noise_level < 2) return as->noise_level;
2514
2515 /* The steps for measuring noise reduction are based on the "magical" (and arbitrary) 8 base distance
2516 * adding the town_council_tolerance 4 times, as a way to graduate, depending of the tolerance.
2517 * Basically, it says that the less tolerant a town is, the bigger the distance before
2518 * an actual decrease can be granted */
2519 uint8_t town_tolerance_distance = 8 + (_settings_game.difficulty.town_council_tolerance * 4);
2520
2521 /* now, we want to have the distance segmented using the distance judged bareable by town
2522 * This will give us the coefficient of reduction the distance provides. */
2523 uint noise_reduction = distance / town_tolerance_distance;
2524
2525 /* If the noise reduction equals the airport noise itself, don't give it for free.
2526 * Otherwise, simply reduce the airport's level. */
2527 return noise_reduction >= as->noise_level ? 1 : as->noise_level - noise_reduction;
2528}
2529
2540Town *AirportGetNearestTown(const AirportSpec *as, Direction rotation, TileIndex tile, TileIterator &&it, uint &mindist)
2541{
2542 assert(Town::GetNumItems() > 0);
2543
2544 Town *nearest = nullptr;
2545
2546 auto width = as->size_x;
2547 auto height = as->size_y;
2548 if (rotation == DIR_E || rotation == DIR_W) std::swap(width, height);
2549
2550 uint perimeter_min_x = TileX(tile);
2551 uint perimeter_min_y = TileY(tile);
2552 uint perimeter_max_x = perimeter_min_x + width - 1;
2553 uint perimeter_max_y = perimeter_min_y + height - 1;
2554
2555 mindist = UINT_MAX - 1; // prevent overflow
2556
2557 for (TileIndex cur_tile = *it; cur_tile != INVALID_TILE; cur_tile = ++it) {
2558 assert(IsInsideBS(TileX(cur_tile), perimeter_min_x, width));
2559 assert(IsInsideBS(TileY(cur_tile), perimeter_min_y, height));
2560 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) {
2561 Town *t = CalcClosestTownFromTile(cur_tile, mindist + 1);
2562 if (t == nullptr) continue;
2563
2564 uint dist = DistanceManhattan(t->xy, cur_tile);
2565 if (dist == mindist && t->index < nearest->index) nearest = t;
2566 if (dist < mindist) {
2567 nearest = t;
2568 mindist = dist;
2569 }
2570 }
2571 }
2572
2573 return nearest;
2574}
2575
2583static Town *AirportGetNearestTown(const Station *st, uint &mindist)
2584{
2586}
2587
2588
2591{
2592 for (Town *t : Town::Iterate()) t->noise_reached = 0;
2593
2594 for (const Station *st : Station::Iterate()) {
2595 if (st->airport.tile != INVALID_TILE && st->airport.type != AT_OILRIG) {
2596 uint dist;
2597 Town *nearest = AirportGetNearestTown(st, dist);
2598 nearest->noise_reached += GetAirportNoiseLevelForDistance(st->airport.GetSpec(), dist);
2599 }
2600 }
2601}
2602
2613CommandCost CmdBuildAirport(DoCommandFlags flags, TileIndex tile, uint8_t airport_type, uint8_t layout, StationID station_to_join, bool allow_adjacent)
2614{
2615 bool reuse = (station_to_join != NEW_STATION);
2616 if (!reuse) station_to_join = StationID::Invalid();
2617 bool distant_join = (station_to_join != StationID::Invalid());
2618
2619 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2620
2621 if (airport_type >= NUM_AIRPORTS) return CMD_ERROR;
2622
2624 if (ret.Failed()) return ret;
2625
2626 /* Check if a valid, buildable airport was chosen for construction */
2627 const AirportSpec *as = AirportSpec::Get(airport_type);
2628 if (!as->IsAvailable() || layout >= as->layouts.size()) return CMD_ERROR;
2629 if (!as->IsWithinMapBounds(layout, tile)) return CMD_ERROR;
2630
2631 Direction rotation = as->layouts[layout].rotation;
2632 int w = as->size_x;
2633 int h = as->size_y;
2634 if (rotation == DIR_E || rotation == DIR_W) std::swap(w, h);
2635 TileArea airport_area = TileArea(tile, w, h);
2636
2638 return CommandCost(STR_ERROR_STATION_TOO_SPREAD_OUT);
2639 }
2640
2641 AirportTileTableIterator tile_iter(as->layouts[layout].tiles, tile);
2642 CommandCost cost = CheckFlatLandAirport(tile_iter, flags);
2643 if (cost.Failed()) return cost;
2644
2645 /* The noise level is the noise from the airport and reduce it to account for the distance to the town center. */
2646 uint dist;
2647 Town *nearest = AirportGetNearestTown(as, rotation, tile, std::move(tile_iter), dist);
2648 uint newnoise_level = GetAirportNoiseLevelForDistance(as, dist);
2649
2650 /* Check if local auth would allow a new airport */
2651 StringID authority_refuse_message = STR_NULL;
2652 Town *authority_refuse_town = nullptr;
2653
2655 /* do not allow to build a new airport if this raise the town noise over the maximum allowed by town */
2656 if ((nearest->noise_reached + newnoise_level) > nearest->MaxTownNoise()) {
2657 authority_refuse_message = STR_ERROR_LOCAL_AUTHORITY_REFUSES_NOISE;
2658 authority_refuse_town = nearest;
2659 }
2660 } else if (_settings_game.difficulty.town_council_tolerance != TOWN_COUNCIL_PERMISSIVE) {
2661 Town *t = ClosestTownFromTile(tile, UINT_MAX);
2662 uint num = 0;
2663 for (const Station *st : Station::Iterate()) {
2664 if (st->town == t && st->facilities.Test(StationFacility::Airport) && st->airport.type != AT_OILRIG) num++;
2665 }
2666 if (num >= 2) {
2667 authority_refuse_message = STR_ERROR_LOCAL_AUTHORITY_REFUSES_AIRPORT;
2668 authority_refuse_town = t;
2669 }
2670 }
2671
2672 if (authority_refuse_message != STR_NULL) {
2673 return CommandCostWithParam(authority_refuse_message, authority_refuse_town->index);
2674 }
2675
2676 Station *st = nullptr;
2677 ret = FindJoiningStation(StationID::Invalid(), station_to_join, allow_adjacent, airport_area, &st);
2678 if (ret.Failed()) return ret;
2679
2680 /* Distant join */
2681 if (st == nullptr && distant_join) st = Station::GetIfValid(station_to_join);
2682
2683 ret = BuildStationPart(&st, flags, reuse, airport_area, GetAirport(airport_type)->flags.Test(AirportFTAClass::Flag::Airplanes) ? STATIONNAMING_AIRPORT : STATIONNAMING_HELIPORT);
2684 if (ret.Failed()) return ret;
2685
2686 if (st != nullptr && st->airport.tile != INVALID_TILE) {
2687 return CommandCost(STR_ERROR_TOO_CLOSE_TO_ANOTHER_AIRPORT);
2688 }
2689
2690 for (AirportTileTableIterator iter(as->layouts[layout].tiles, tile); iter != INVALID_TILE; ++iter) {
2691 cost.AddCost(_price[PR_BUILD_STATION_AIRPORT]);
2692 }
2693
2694 if (flags.Test(DoCommandFlag::Execute)) {
2695 /* Always add the noise, so there will be no need to recalculate when option toggles */
2696 nearest->noise_reached += newnoise_level;
2697
2699 st->airport.type = airport_type;
2700 st->airport.layout = layout;
2701 st->airport.blocks = {};
2702 st->airport.rotation = rotation;
2703
2704 st->rect.BeforeAddRect(tile, w, h, StationRect::ADD_TRY);
2705
2706 for (AirportTileTableIterator iter(as->layouts[layout].tiles, tile); iter != INVALID_TILE; ++iter) {
2707 Tile t(iter);
2708 MakeAirport(t, st->owner, st->index, iter.GetStationGfx(), WaterClass::Invalid);
2709 SetStationTileRandomBits(t, GB(Random(), 0, 4));
2710 st->airport.Add(iter);
2711
2713 }
2714
2715 /* Only call the animation trigger after all tiles have been built */
2716 for (AirportTileTableIterator iter(as->layouts[layout].tiles, tile); iter != INVALID_TILE; ++iter) {
2717 TriggerAirportTileAnimation(st, iter, AirportAnimationTrigger::Built);
2718 }
2719
2721
2722 Company::Get(st->owner)->infrastructure.airport++;
2723
2724 st->AfterStationTileSetChange(true, StationType::Airport);
2726
2729 }
2730 }
2731
2732 return cost;
2733}
2734
2742{
2743 Station *st = Station::GetByTile(tile);
2744
2746 CommandCost ret = CheckOwnership(st->owner);
2747 if (ret.Failed()) return ret;
2748 }
2749
2750 tile = st->airport.tile;
2751
2753
2754 for (const Aircraft *a : Aircraft::Iterate()) {
2755 if (!a->IsNormalAircraft()) continue;
2756 if (a->targetairport == st->index && a->state != FLYING) {
2757 return CommandCost(STR_ERROR_AIRCRAFT_IN_THE_WAY);
2758 }
2759 }
2760
2761 if (flags.Test(DoCommandFlag::Execute)) {
2762 for (uint i = 0; i < st->airport.GetNumHangars(); ++i) {
2763 TileIndex tile_cur = st->airport.GetHangarTile(i);
2764 OrderBackup::Reset(tile_cur, false);
2766 }
2767
2768 /* The noise level is the noise from the airport and reduce it to account for the distance to the town center.
2769 * And as for construction, always remove it, even if the setting is not set, in order to avoid the
2770 * need of recalculation */
2771 uint dist;
2772 Town *nearest = AirportGetNearestTown(st, dist);
2774
2777 }
2778 }
2779
2780 for (TileIndex tile_cur : st->airport) {
2781 if (!st->TileBelongsToAirport(tile_cur)) continue;
2782
2783 CommandCost ret = EnsureNoVehicleOnGround(tile_cur);
2784 if (ret.Failed()) return ret;
2785
2786 cost.AddCost(_price[PR_CLEAR_STATION_AIRPORT]);
2787
2788 if (flags.Test(DoCommandFlag::Execute)) {
2789 DoClearSquare(tile_cur);
2790 DeleteNewGRFInspectWindow(GSF_AIRPORTTILES, tile_cur.base());
2791 }
2792 }
2793
2794 if (flags.Test(DoCommandFlag::Execute)) {
2795 /* Clear the persistent storage. */
2796 delete st->airport.psa;
2797
2798 st->rect.AfterRemoveRect(st, st->airport);
2799
2800 st->airport.Clear();
2803
2805
2806 Company::Get(st->owner)->infrastructure.airport--;
2807
2808 st->AfterStationTileSetChange(false, StationType::Airport);
2809
2810 DeleteNewGRFInspectWindow(GSF_AIRPORTS, st->index);
2811 }
2812
2813 return cost;
2814}
2815
2823{
2824 if (!Station::IsValidID(station_id)) return CMD_ERROR;
2825 Station *st = Station::Get(station_id);
2826
2828
2829 CommandCost ret = CheckOwnership(st->owner);
2830 if (ret.Failed()) return ret;
2831
2832 if (flags.Test(DoCommandFlag::Execute)) {
2835 }
2836 return CommandCost();
2837}
2838
2845bool HasStationInUse(StationID station, bool include_company, CompanyID company)
2846{
2847 for (const OrderList *orderlist : OrderList::Iterate()) {
2848 const Vehicle *v = orderlist->GetFirstSharedVehicle();
2849 assert(v != nullptr);
2850 if ((v->owner == company) != include_company) continue;
2851
2852 for (const Order &order : orderlist->GetOrders()) {
2853 if (order.GetDestination() == station && (order.IsType(OT_GOTO_STATION) || order.IsType(OT_GOTO_WAYPOINT))) {
2854 return true;
2855 }
2856 }
2857 }
2858 return false;
2859}
2860
2861static const TileIndexDiffC _dock_tileoffs_chkaround[] = {
2862 {-1, 0},
2863 { 0, 0},
2864 { 0, 0},
2865 { 0, -1}
2866};
2867static const uint8_t _dock_w_chk[4] = { 2, 1, 2, 1 };
2868static const uint8_t _dock_h_chk[4] = { 1, 2, 1, 2 };
2869
2878CommandCost CmdBuildDock(DoCommandFlags flags, TileIndex tile, StationID station_to_join, bool adjacent)
2879{
2880 bool reuse = (station_to_join != NEW_STATION);
2881 if (!reuse) station_to_join = StationID::Invalid();
2882 bool distant_join = (station_to_join != StationID::Invalid());
2883
2884 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2885
2887 if (direction == INVALID_DIAGDIR) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
2888 direction = ReverseDiagDir(direction);
2889
2890 /* Docks cannot be placed on rapids */
2891 if (HasTileWaterGround(tile)) return CommandCost(STR_ERROR_SITE_UNSUITABLE);
2892
2894 if (ret.Failed()) return ret;
2895
2896 ret = IsDockBridgeAboveOk(tile, to_underlying(direction));
2897 if (ret.Failed()) return ret;
2898
2899 CommandCost cost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_STATION_DOCK]);
2900 ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
2901 if (ret.Failed()) return ret;
2902 cost.AddCost(ret.GetCost());
2903
2904 TileIndex tile_cur = tile + TileOffsByDiagDir(direction);
2905
2906 if (!HasTileWaterGround(tile_cur) || !IsTileFlat(tile_cur)) {
2907 return CommandCost(STR_ERROR_SITE_UNSUITABLE);
2908 }
2909
2911 if (ret.Failed()) return ret;
2912
2913 /* Get the water class of the water tile before it is cleared.*/
2914 WaterClass wc = GetWaterClass(tile_cur);
2915
2916 bool add_cost = !IsWaterTile(tile_cur);
2917 ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile_cur);
2918 if (ret.Failed()) return ret;
2919 if (add_cost) cost.AddCost(ret.GetCost());
2920
2921 tile_cur += TileOffsByDiagDir(direction);
2922 if (!IsTileType(tile_cur, MP_WATER) || !IsTileFlat(tile_cur)) {
2923 return CommandCost(STR_ERROR_SITE_UNSUITABLE);
2924 }
2925
2926 TileArea dock_area = TileArea(tile + ToTileIndexDiff(_dock_tileoffs_chkaround[direction]),
2927 _dock_w_chk[direction], _dock_h_chk[direction]);
2928
2929 /* middle */
2930 Station *st = nullptr;
2931 ret = FindJoiningStation(StationID::Invalid(), station_to_join, adjacent, dock_area, &st);
2932 if (ret.Failed()) return ret;
2933
2934 /* Distant join */
2935 if (st == nullptr && distant_join) st = Station::GetIfValid(station_to_join);
2936
2937 ret = BuildStationPart(&st, flags, reuse, dock_area, STATIONNAMING_DOCK);
2938 if (ret.Failed()) return ret;
2939
2940 if (flags.Test(DoCommandFlag::Execute)) {
2941 st->ship_station.Add(tile);
2942 TileIndex flat_tile = tile + TileOffsByDiagDir(direction);
2943 st->ship_station.Add(flat_tile);
2945
2946 st->rect.BeforeAddRect(dock_area.tile, dock_area.w, dock_area.h, StationRect::ADD_TRY);
2947
2948 /* If the water part of the dock is on a canal, update infrastructure counts.
2949 * This is needed as we've cleared that tile before.
2950 * Clearing object tiles may result in water tiles which are already accounted for in the water infrastructure total.
2951 * See: MakeWaterKeepingClass() */
2952 if (wc == WaterClass::Canal && !(HasTileWaterClass(flat_tile) && GetWaterClass(flat_tile) == WaterClass::Canal && IsTileOwner(flat_tile, _current_company))) {
2953 Company::Get(st->owner)->infrastructure.water++;
2954 }
2955 Company::Get(st->owner)->infrastructure.station += 2;
2956
2957 MakeDock(tile, st->owner, st->index, direction, wc);
2958 UpdateStationDockingTiles(st);
2959
2960 st->AfterStationTileSetChange(true, StationType::Dock);
2961 }
2962
2963 return cost;
2964}
2965
2966void RemoveDockingTile(TileIndex t)
2967{
2968 for (DiagDirection d = DIAGDIR_BEGIN; d != DIAGDIR_END; d++) {
2969 TileIndex tile = t + TileOffsByDiagDir(d);
2970 if (!IsValidTile(tile)) continue;
2971
2972 if (IsTileType(tile, MP_STATION)) {
2973 Station *st = Station::GetByTile(tile);
2974 if (st != nullptr) UpdateStationDockingTiles(st);
2975 } else if (IsTileType(tile, MP_INDUSTRY)) {
2977 if (neutral != nullptr) UpdateStationDockingTiles(neutral);
2978 }
2979 }
2980}
2981
2988{
2989 assert(IsValidTile(tile));
2990
2991 /* Clear and maybe re-set docking tile */
2992 for (DiagDirection d = DIAGDIR_BEGIN; d != DIAGDIR_END; d++) {
2993 TileIndex docking_tile = tile + TileOffsByDiagDir(d);
2994 if (!IsValidTile(docking_tile)) continue;
2995
2996 if (IsPossibleDockingTile(docking_tile)) {
2997 SetDockingTile(docking_tile, false);
2998 CheckForDockingTile(docking_tile);
2999 }
3000 }
3001}
3002
3009{
3010 assert(IsDockTile(t));
3011
3012 StationGfx gfx = GetStationGfx(t);
3013 if (gfx < GFX_DOCK_BASE_WATER_PART) return t;
3014
3015 for (DiagDirection d = DIAGDIR_BEGIN; d != DIAGDIR_END; d++) {
3016 TileIndex tile = t + TileOffsByDiagDir(d);
3017 if (!IsValidTile(tile)) continue;
3018 if (!IsDockTile(tile)) continue;
3019 if (GetStationGfx(tile) < GFX_DOCK_BASE_WATER_PART && tile + TileOffsByDiagDir(GetDockDirection(tile)) == t) return tile;
3020 }
3021
3022 return INVALID_TILE;
3023}
3024
3032{
3033 Station *st = Station::GetByTile(tile);
3034 CommandCost ret = CheckOwnership(st->owner);
3035 if (ret.Failed()) return ret;
3036
3037 if (!IsDockTile(tile)) return CMD_ERROR;
3038
3039 TileIndex tile1 = FindDockLandPart(tile);
3040 if (tile1 == INVALID_TILE) return CMD_ERROR;
3041 TileIndex tile2 = tile1 + TileOffsByDiagDir(GetDockDirection(tile1));
3042
3043 ret = EnsureNoVehicleOnGround(tile1);
3044 if (ret.Succeeded()) ret = EnsureNoVehicleOnGround(tile2);
3045 if (ret.Failed()) return ret;
3046
3047 if (flags.Test(DoCommandFlag::Execute)) {
3048 DoClearSquare(tile1);
3049 MarkTileDirtyByTile(tile1);
3050 MakeWaterKeepingClass(tile2, st->owner);
3051
3052 st->rect.AfterRemoveTile(st, tile1);
3053 st->rect.AfterRemoveTile(st, tile2);
3054
3055 MakeShipStationAreaSmaller(st);
3056 if (st->ship_station.tile == INVALID_TILE) {
3057 st->ship_station.Clear();
3058 st->docking_station.Clear();
3061 }
3062
3063 Company::Get(st->owner)->infrastructure.station -= 2;
3064
3065 st->AfterStationTileSetChange(false, StationType::Dock);
3066
3069
3070 for (Ship *s : Ship::Iterate()) {
3071 /* Find all ships going to our dock. */
3072 if (s->current_order.GetDestination() != st->index) {
3073 continue;
3074 }
3075
3076 /* Find ships that are marked as "loading" but are no longer on a
3077 * docking tile. Force them to leave the station (as they were loading
3078 * on the removed dock). */
3079 if (s->current_order.IsType(OT_LOADING) && !(IsDockingTile(s->tile) && IsShipDestinationTile(s->tile, st->index))) {
3080 s->LeaveStation();
3081 }
3082
3083 /* If we no longer have a dock, mark the order as invalid and send
3084 * the ship to the next order (or, if there is none, make it
3085 * wander the world). */
3086 if (s->current_order.IsType(OT_GOTO_STATION) && !st->facilities.Test(StationFacility::Dock)) {
3087 s->SetDestTile(s->GetOrderStationLocation(st->index));
3088 }
3089 }
3090 }
3091
3092 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_CLEAR_STATION_DOCK]);
3093}
3094
3102{
3103 const auto &layouts = _station_display_datas[to_underlying(st)];
3104 if (gfx >= layouts.size()) gfx &= 1;
3105 return layouts.data() + gfx;
3106}
3107
3117bool SplitGroundSpriteForOverlay(const TileInfo *ti, SpriteID *ground, RailTrackOffset *overlay_offset)
3118{
3119 bool snow_desert;
3120 switch (*ground) {
3121 case SPR_RAIL_TRACK_X:
3122 case SPR_MONO_TRACK_X:
3123 case SPR_MGLV_TRACK_X:
3124 snow_desert = false;
3125 *overlay_offset = RTO_X;
3126 break;
3127
3128 case SPR_RAIL_TRACK_Y:
3129 case SPR_MONO_TRACK_Y:
3130 case SPR_MGLV_TRACK_Y:
3131 snow_desert = false;
3132 *overlay_offset = RTO_Y;
3133 break;
3134
3135 case SPR_RAIL_TRACK_X_SNOW:
3136 case SPR_MONO_TRACK_X_SNOW:
3137 case SPR_MGLV_TRACK_X_SNOW:
3138 snow_desert = true;
3139 *overlay_offset = RTO_X;
3140 break;
3141
3142 case SPR_RAIL_TRACK_Y_SNOW:
3143 case SPR_MONO_TRACK_Y_SNOW:
3144 case SPR_MGLV_TRACK_Y_SNOW:
3145 snow_desert = true;
3146 *overlay_offset = RTO_Y;
3147 break;
3148
3149 default:
3150 return false;
3151 }
3152
3153 if (ti != nullptr) {
3154 /* Decide snow/desert from tile */
3156 case LandscapeType::Arctic:
3157 snow_desert = (uint)ti->z > GetSnowLine() * TILE_HEIGHT;
3158 break;
3159
3160 case LandscapeType::Tropic:
3161 snow_desert = GetTropicZone(ti->tile) == TROPICZONE_DESERT;
3162 break;
3163
3164 default:
3165 break;
3166 }
3167 }
3168
3169 *ground = snow_desert ? SPR_FLAT_SNOW_DESERT_TILE : SPR_FLAT_GRASS_TILE;
3170 return true;
3171}
3172
3179static BridgePillarFlags GetStationBlockedPillars(std::span<const BridgeableTileInfo> bridgeable_info, uint8_t layout)
3180{
3181 if (layout < std::size(bridgeable_info)) return bridgeable_info[layout].disallowed_pillars;
3182 return BRIDGEPILLARFLAGS_ALL;
3183}
3184
3194{
3195 if (statspec == nullptr || !statspec->flags.Test(StationSpecFlag::CustomFoundations)) return false;
3196
3197 /* Station has custom foundations.
3198 * Check whether the foundation continues beyond the tile's upper sides. */
3199 uint edge_info = 0;
3200 auto [slope, z] = GetFoundationPixelSlope(ti->tile);
3201 if (!HasFoundationNW(ti->tile, slope, z)) SetBit(edge_info, 0);
3202 if (!HasFoundationNE(ti->tile, slope, z)) SetBit(edge_info, 1);
3203
3204 SpriteID image = GetCustomStationFoundationRelocation(statspec, st, ti->tile, gfx, edge_info);
3205 if (image == 0) return false;
3206
3208 /* Station provides extended foundations. */
3209 static constexpr uint8_t foundation_parts[] = {
3210 UINT8_MAX, UINT8_MAX, UINT8_MAX, 0, // Invalid, Invalid, Invalid, SLOPE_SW
3211 UINT8_MAX, 1, 2, 3, // Invalid, SLOPE_EW, SLOPE_SE, SLOPE_WSE
3212 UINT8_MAX, 4, 5, 6, // Invalid, SLOPE_NW, SLOPE_NS, SLOPE_NWS
3213 7, 8, 9, // SLOPE_NE, SLOPE_ENW, SLOPE_SEN
3214 };
3215 assert(ti->tileh < std::size(foundation_parts));
3216 if (foundation_parts[ti->tileh] == UINT8_MAX) return false;
3217
3218 AddSortableSpriteToDraw(image + foundation_parts[ti->tileh], PAL_NONE, *ti, {{}, {TILE_SIZE, TILE_SIZE, TILE_HEIGHT - 1}, {}});
3219 } else {
3220 /* Draw simple foundations, built up from 8 possible foundation sprites.
3221 * Each set bit represents one of the eight composite sprites to be drawn.
3222 * 'Invalid' entries will not drawn but are included for completeness. */
3223 static constexpr uint8_t composite_foundation_parts[] = {
3224 0b0000'0000, 0b1101'0001, 0b1110'0100, 0b1110'0000, // Invalid, Invalid, Invalid, SLOPE_SW
3225 0b1100'1010, 0b1100'1001, 0b1100'0100, 0b1100'0000, // Invalid, SLOPE_EW, SLOPE_SE, SLOPE_WSE
3226 0b1101'0010, 0b1001'0001, 0b1110'0100, 0b1010'0000, // Invalid, SLOPE_NW, SLOPE_NS, SLOPE_NWS
3227 0b0100'1010, 0b0000'1001, 0b0100'0100, // SLOPE_NE, SLOPE_ENW, SLOPE_SEN
3228 };
3229 assert(ti->tileh < std::size(composite_foundation_parts));
3230
3231 uint8_t parts = composite_foundation_parts[ti->tileh];
3232
3233 /* If foundations continue beyond the tile's upper sides then mask out the last two pieces. */
3234 if (HasBit(edge_info, 0)) ClrBit(parts, 6);
3235 if (HasBit(edge_info, 1)) ClrBit(parts, 7);
3236
3237 /* We always have to draw at least one sprite, so if we have no parts to draw fall back to default foundation. */
3238 if (parts == 0) return false;
3239
3241 for (uint i : SetBitIterator(parts)) {
3242 AddSortableSpriteToDraw(image + i, PAL_NONE, *ti, {{}, {TILE_SIZE, TILE_SIZE, TILE_HEIGHT - 1}, {}});
3243 }
3245 }
3246
3247 OffsetGroundSprite(0, -static_cast<int>(TILE_HEIGHT));
3249
3250 return true;
3251}
3252
3253static void DrawTile_Station(TileInfo *ti)
3254{
3255 const NewGRFSpriteLayout *layout = nullptr;
3256 SpriteLayoutProcessor processor; // owns heap, borrowed by tmp_layout and t
3257 DrawTileSpriteSpan tmp_layout;
3258 const DrawTileSprites *t = nullptr;
3259 int32_t total_offset;
3260 const RailTypeInfo *rti = nullptr;
3261 uint32_t relocation = 0;
3262 uint32_t ground_relocation = 0;
3263 BaseStation *st = nullptr;
3264 const StationSpec *statspec = nullptr;
3265 uint tile_layout = 0;
3266 auto bridgeable_info = GetStationBridgeableTileInfo(GetStationType(ti->tile));
3267
3268 if (HasStationRail(ti->tile)) {
3269 rti = GetRailTypeInfo(GetRailType(ti->tile));
3270 total_offset = rti->GetRailtypeSpriteOffset();
3271
3272 if (IsCustomStationSpecIndex(ti->tile)) {
3273 /* look for customization */
3274 st = BaseStation::GetByTile(ti->tile);
3275 statspec = st->speclist[GetCustomStationSpecIndex(ti->tile)].spec;
3276
3277 if (statspec != nullptr) {
3278 tile_layout = GetStationGfx(ti->tile);
3279
3281 uint16_t callback = GetStationCallback(CBID_STATION_DRAW_TILE_LAYOUT, 0, 0, statspec, st, ti->tile);
3282 if (callback != CALLBACK_FAILED) tile_layout = (callback & ~1) + GetRailStationAxis(ti->tile);
3283 }
3284
3285 /* Ensure the chosen tile layout is valid for this custom station */
3286 if (!statspec->renderdata.empty()) {
3287 layout = &statspec->renderdata[tile_layout < statspec->renderdata.size() ? tile_layout : (uint)GetRailStationAxis(ti->tile)];
3288 if (!layout->NeedsPreprocessing()) {
3289 t = layout;
3290 layout = nullptr;
3291 }
3292 }
3293 }
3294 }
3295 if (statspec != nullptr) bridgeable_info = statspec->bridgeable_info;
3296 } else {
3297 total_offset = 0;
3298 }
3299
3300 StationGfx gfx = GetStationGfx(ti->tile);
3301 if (IsAirport(ti->tile)) {
3302 gfx = GetAirportGfx(ti->tile);
3303 if (gfx >= NEW_AIRPORTTILE_OFFSET) {
3304 const AirportTileSpec *ats = AirportTileSpec::Get(gfx);
3305 if (ats->grf_prop.HasSpriteGroups() && DrawNewAirportTile(ti, Station::GetByTile(ti->tile), ats)) {
3306 return;
3307 }
3308 /* No sprite group (or no valid one) found, meaning no graphics associated.
3309 * Use the substitute one instead */
3310 assert(ats->grf_prop.subst_id != INVALID_AIRPORTTILE);
3311 gfx = ats->grf_prop.subst_id;
3312 }
3313 switch (gfx) {
3314 case APT_RADAR_GRASS_FENCE_SW:
3315 t = &_station_display_datas_airport_radar_grass_fence_sw[GetAnimationFrame(ti->tile)];
3316 break;
3317 case APT_GRASS_FENCE_NE_FLAG:
3318 t = &_station_display_datas_airport_flag_grass_fence_ne[GetAnimationFrame(ti->tile)];
3319 break;
3320 case APT_RADAR_FENCE_SW:
3321 t = &_station_display_datas_airport_radar_fence_sw[GetAnimationFrame(ti->tile)];
3322 break;
3323 case APT_RADAR_FENCE_NE:
3324 t = &_station_display_datas_airport_radar_fence_ne[GetAnimationFrame(ti->tile)];
3325 break;
3326 case APT_GRASS_FENCE_NE_FLAG_2:
3327 t = &_station_display_datas_airport_flag_grass_fence_ne_2[GetAnimationFrame(ti->tile)];
3328 break;
3329 }
3330 }
3331
3332 Owner owner = GetTileOwner(ti->tile);
3333
3334 PaletteID palette;
3335 if (Company::IsValidID(owner)) {
3336 palette = GetCompanyPalette(owner);
3337 } else {
3338 /* Some stations are not owner by a company, namely oil rigs */
3339 palette = PALETTE_TO_GREY;
3340 }
3341
3342 if (layout == nullptr && t == nullptr) t = GetStationTileLayout(GetStationType(ti->tile), gfx);
3343
3344 /* don't show foundation for docks */
3345 if (ti->tileh != SLOPE_FLAT && !IsDock(ti->tile)) {
3346 if (!DrawCustomStationFoundations(statspec, st, ti, tile_layout)) {
3348 }
3349 }
3350
3351 bool draw_ground = false;
3352
3353 if (IsBuoy(ti->tile)) {
3354 DrawWaterClassGround(ti);
3355 SpriteID sprite = GetCanalSprite(CF_BUOY, ti->tile);
3356 if (sprite != 0) total_offset = sprite - SPR_IMG_BUOY;
3357 } else if (IsDock(ti->tile) || (IsOilRig(ti->tile) && IsTileOnWater(ti->tile))) {
3358 if (ti->tileh == SLOPE_FLAT) {
3359 DrawWaterClassGround(ti);
3360 } else {
3361 assert(IsDock(ti->tile));
3362 TileIndex water_tile = ti->tile + TileOffsByDiagDir(GetDockDirection(ti->tile));
3363 WaterClass wc = HasTileWaterClass(water_tile) ? GetWaterClass(water_tile) : WaterClass::Invalid;
3364 if (wc == WaterClass::Sea) {
3365 DrawShoreTile(ti->tileh);
3366 } else {
3367 DrawClearLandTile(ti, 3);
3368 }
3369 }
3370 } else if (IsRoadWaypointTile(ti->tile)) {
3372 RoadType road_rt = GetRoadTypeRoad(ti->tile);
3373 RoadType tram_rt = GetRoadTypeTram(ti->tile);
3374 RoadBits road = (road_rt != INVALID_ROADTYPE) ? bits : ROAD_NONE;
3375 RoadBits tram = (tram_rt != INVALID_ROADTYPE) ? bits : ROAD_NONE;
3376 const RoadTypeInfo *road_rti = (road_rt != INVALID_ROADTYPE) ? GetRoadTypeInfo(road_rt) : nullptr;
3377 const RoadTypeInfo *tram_rti = (tram_rt != INVALID_ROADTYPE) ? GetRoadTypeInfo(tram_rt) : nullptr;
3378
3379 if (ti->tileh != SLOPE_FLAT) {
3381 }
3382
3383 DrawRoadGroundSprites(ti, road, tram, road_rti, tram_rti, GetRoadWaypointRoadside(ti->tile), IsRoadWaypointOnSnowOrDesert(ti->tile));
3384 } else {
3385 if (layout != nullptr) {
3386 /* Sprite layout which needs preprocessing */
3387 bool separate_ground = statspec->flags.Test(StationSpecFlag::SeparateGround);
3388 processor = SpriteLayoutProcessor(*layout, total_offset, rti->fallback_railtype, 0, 0, separate_ground);
3389 GetCustomStationRelocation(processor, statspec, st, ti->tile);
3390 tmp_layout = processor.GetLayout();
3391 t = &tmp_layout;
3392 total_offset = 0;
3393 } else if (statspec != nullptr) {
3394 /* Simple sprite layout */
3395 ground_relocation = relocation = GetCustomStationRelocation(statspec, st, ti->tile, 0);
3397 ground_relocation = GetCustomStationRelocation(statspec, st, ti->tile, 1);
3398 }
3399 ground_relocation += rti->fallback_railtype;
3400 }
3401
3402 draw_ground = true;
3403 }
3404
3405 if (draw_ground && !IsAnyRoadStop(ti->tile)) {
3406 SpriteID image = t->ground.sprite;
3407 PaletteID pal = t->ground.pal;
3408 RailTrackOffset overlay_offset;
3409 if (rti != nullptr && rti->UsesOverlay() && SplitGroundSpriteForOverlay(ti, &image, &overlay_offset)) {
3410 SpriteID ground = GetCustomRailSprite(rti, ti->tile, RTSG_GROUND);
3411 DrawGroundSprite(image, PAL_NONE);
3412 DrawGroundSprite(ground + overlay_offset, PAL_NONE);
3413
3414 if (_game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasStationReservation(ti->tile)) {
3415 SpriteID overlay = GetCustomRailSprite(rti, ti->tile, RTSG_OVERLAY);
3416 DrawGroundSprite(overlay + overlay_offset, PALETTE_CRASH);
3417 }
3418 } else {
3419 image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
3420 if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
3421 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
3422
3423 /* PBS debugging, draw reserved tracks darker */
3424 if (_game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasStationRail(ti->tile) && HasStationReservation(ti->tile)) {
3425 DrawGroundSprite(GetRailStationAxis(ti->tile) == AXIS_X ? rti->base_sprites.single_x : rti->base_sprites.single_y, PALETTE_CRASH);
3426 }
3427 }
3428 }
3429
3431
3432 if (IsAnyRoadStop(ti->tile)) {
3433 RoadType road_rt = GetRoadTypeRoad(ti->tile);
3434 RoadType tram_rt = GetRoadTypeTram(ti->tile);
3435 const RoadTypeInfo *road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
3436 const RoadTypeInfo *tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
3437
3438 StationGfx view = GetStationGfx(ti->tile);
3439 StationType type = GetStationType(ti->tile);
3440
3441 const RoadStopSpec *stopspec = GetRoadStopSpec(ti->tile);
3442 RoadStopDrawModes stop_draw_mode{};
3443 if (stopspec != nullptr) {
3444 stop_draw_mode = stopspec->draw_mode;
3445 st = BaseStation::GetByTile(ti->tile);
3446 std::array<int32_t, 1> regs100;
3447 auto result = GetRoadStopLayout(ti, stopspec, st, type, view, regs100);
3448 if (result.has_value()) {
3449 if (stopspec->flags.Test(RoadStopSpecFlag::DrawModeRegister)) {
3450 stop_draw_mode = static_cast<RoadStopDrawModes>(regs100[0]);
3451 }
3452 if (type == StationType::RoadWaypoint && stop_draw_mode.Test(RoadStopDrawMode::WaypGround)) {
3453 draw_ground = true;
3454 }
3455 processor = std::move(*result);
3456 tmp_layout = processor.GetLayout();
3457 t = &tmp_layout;
3458 }
3459 }
3460
3461 /* Draw ground sprite */
3462 if (draw_ground) {
3463 SpriteID image = t->ground.sprite;
3464 PaletteID pal = t->ground.pal;
3465 image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
3466 if (GB(image, 0, SPRITE_WIDTH) != 0) {
3467 if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
3468 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
3469 }
3470 }
3471
3472 if (IsDriveThroughStopTile(ti->tile)) {
3473 if (type != StationType::RoadWaypoint && (stopspec == nullptr || stop_draw_mode.Test(RoadStopDrawMode::Overlay))) {
3474 uint sprite_offset = GetDriveThroughStopAxis(ti->tile) == AXIS_X ? 1 : 0;
3475 DrawRoadOverlays(ti, PAL_NONE, road_rti, tram_rti, sprite_offset, sprite_offset);
3476 }
3477 } else {
3478 /* Non-drivethrough road stops are only valid for roads. */
3479 assert(road_rt != INVALID_ROADTYPE && tram_rt == INVALID_ROADTYPE);
3480
3481 if ((stopspec == nullptr || stop_draw_mode.Test(RoadStopDrawMode::Road)) && road_rti->UsesOverlay()) {
3482 SpriteID ground = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_ROADSTOP);
3483 DrawGroundSprite(ground + view, PAL_NONE);
3484 }
3485 }
3486 if (stopspec != nullptr) bridgeable_info = stopspec->bridgeable_info;
3487
3488 if (stopspec == nullptr || !stopspec->flags.Test(RoadStopSpecFlag::NoCatenary)) {
3489 /* Draw road, tram catenary */
3490 DrawRoadCatenary(ti);
3491 }
3492 }
3493
3494 if (IsRailWaypoint(ti->tile)) {
3495 /* Don't offset the waypoint graphics; they're always the same. */
3496 total_offset = 0;
3497 }
3498
3499 DrawRailTileSeq(ti, t, TO_BUILDINGS, total_offset, relocation, palette);
3500 DrawBridgeMiddle(ti, GetStationBlockedPillars(bridgeable_info, GetStationGfx(ti->tile)));
3501}
3502
3503void StationPickerDrawSprite(int x, int y, StationType st, RailType railtype, RoadType roadtype, int image)
3504{
3505 int32_t total_offset = 0;
3507 const DrawTileSprites *t = GetStationTileLayout(st, image);
3508 const RailTypeInfo *railtype_info = nullptr;
3509
3510 if (railtype != INVALID_RAILTYPE) {
3511 railtype_info = GetRailTypeInfo(railtype);
3512 total_offset = railtype_info->GetRailtypeSpriteOffset();
3513 }
3514
3515 SpriteID img = t->ground.sprite;
3516 RailTrackOffset overlay_offset;
3517 if (railtype_info != nullptr && railtype_info->UsesOverlay() && SplitGroundSpriteForOverlay(nullptr, &img, &overlay_offset)) {
3518 SpriteID ground = GetCustomRailSprite(railtype_info, INVALID_TILE, RTSG_GROUND);
3519 DrawSprite(img, PAL_NONE, x, y);
3520 DrawSprite(ground + overlay_offset, PAL_NONE, x, y);
3521 } else {
3522 DrawSprite(img + total_offset, HasBit(img, PALETTE_MODIFIER_COLOUR) ? pal : PAL_NONE, x, y);
3523 }
3524
3525 if (roadtype != INVALID_ROADTYPE) {
3526 const RoadTypeInfo *roadtype_info = GetRoadTypeInfo(roadtype);
3527 if (image >= 4) {
3528 /* Drive-through stop */
3529 uint sprite_offset = 5 - image;
3530
3531 /* Road underlay takes precedence over tram */
3532 if (roadtype_info->UsesOverlay()) {
3533 SpriteID ground = GetCustomRoadSprite(roadtype_info, INVALID_TILE, ROTSG_GROUND);
3534 DrawSprite(ground + sprite_offset, PAL_NONE, x, y);
3535
3536 SpriteID overlay = GetCustomRoadSprite(roadtype_info, INVALID_TILE, ROTSG_OVERLAY);
3537 if (overlay) DrawSprite(overlay + sprite_offset, PAL_NONE, x, y);
3538 } else if (RoadTypeIsTram(roadtype)) {
3539 DrawSprite(SPR_TRAMWAY_TRAM + sprite_offset, PAL_NONE, x, y);
3540 }
3541 } else {
3542 /* Bay stop */
3543 if (RoadTypeIsRoad(roadtype) && roadtype_info->UsesOverlay()) {
3544 SpriteID ground = GetCustomRoadSprite(roadtype_info, INVALID_TILE, ROTSG_ROADSTOP);
3545 DrawSprite(ground + image, PAL_NONE, x, y);
3546 }
3547 }
3548 }
3549
3550 /* Default waypoint has no railtype specific sprites */
3551 DrawRailTileSeqInGUI(x, y, t, (st == StationType::RailWaypoint || st == StationType::RoadWaypoint) ? 0 : total_offset, 0, pal);
3552}
3553
3554static int GetSlopePixelZ_Station(TileIndex tile, uint, uint, bool)
3555{
3556 return GetTileMaxPixelZ(tile);
3557}
3558
3559static Foundation GetFoundation_Station(TileIndex, Slope tileh)
3560{
3561 return FlatteningFoundation(tileh);
3562}
3563
3564static void FillTileDescRoadStop(TileIndex tile, TileDesc &td)
3565{
3566 RoadType road_rt = GetRoadTypeRoad(tile);
3567 RoadType tram_rt = GetRoadTypeTram(tile);
3568 Owner road_owner = INVALID_OWNER;
3569 Owner tram_owner = INVALID_OWNER;
3570 if (road_rt != INVALID_ROADTYPE) {
3571 const RoadTypeInfo *rti = GetRoadTypeInfo(road_rt);
3572 td.roadtype = rti->strings.name;
3573 td.road_speed = rti->max_speed / 2;
3574 road_owner = GetRoadOwner(tile, RTT_ROAD);
3575 }
3576
3577 if (tram_rt != INVALID_ROADTYPE) {
3578 const RoadTypeInfo *rti = GetRoadTypeInfo(tram_rt);
3579 td.tramtype = rti->strings.name;
3580 td.tram_speed = rti->max_speed / 2;
3581 tram_owner = GetRoadOwner(tile, RTT_TRAM);
3582 }
3583
3584 if (IsDriveThroughStopTile(tile)) {
3585 /* Is there a mix of owners? */
3586 if ((tram_owner != INVALID_OWNER && tram_owner != td.owner[0]) ||
3587 (road_owner != INVALID_OWNER && road_owner != td.owner[0])) {
3588 uint i = 1;
3589 if (road_owner != INVALID_OWNER) {
3590 td.owner_type[i] = STR_LAND_AREA_INFORMATION_ROAD_OWNER;
3591 td.owner[i] = road_owner;
3592 i++;
3593 }
3594 if (tram_owner != INVALID_OWNER) {
3595 td.owner_type[i] = STR_LAND_AREA_INFORMATION_TRAM_OWNER;
3596 td.owner[i] = tram_owner;
3597 }
3598 }
3599 }
3600}
3601
3602void FillTileDescRailStation(TileIndex tile, TileDesc &td)
3603{
3604 const StationSpec *spec = GetStationSpec(tile);
3605
3606 if (spec != nullptr) {
3608 td.station_name = spec->name;
3609
3610 if (spec->grf_prop.HasGrfFile()) {
3611 const GRFConfig *gc = GetGRFConfig(spec->grf_prop.grfid);
3612 td.grf = gc->GetName();
3613 }
3614 }
3615
3616 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
3617 td.rail_speed = rti->max_speed;
3618 td.railtype = rti->strings.name;
3619}
3620
3621void FillTileDescAirport(TileIndex tile, TileDesc &td)
3622{
3623 const AirportSpec *as = Station::GetByTile(tile)->airport.GetSpec();
3625 td.airport_name = as->name;
3626
3628 td.airport_tile_name = ats->name;
3629
3630 if (as->grf_prop.HasGrfFile()) {
3631 const GRFConfig *gc = GetGRFConfig(as->grf_prop.grfid);
3632 td.grf = gc->GetName();
3633 } else if (ats->grf_prop.HasGrfFile()) {
3634 const GRFConfig *gc = GetGRFConfig(ats->grf_prop.grfid);
3635 td.grf = gc->GetName();
3636 }
3637}
3638
3639static void GetTileDesc_Station(TileIndex tile, TileDesc &td)
3640{
3641 td.owner[0] = GetTileOwner(tile);
3643
3644 if (IsAnyRoadStop(tile)) FillTileDescRoadStop(tile, td);
3645 if (HasStationRail(tile)) FillTileDescRailStation(tile, td);
3646 if (IsAirport(tile)) FillTileDescAirport(tile, td);
3647
3648 StringID str;
3649 switch (GetStationType(tile)) {
3650 default: NOT_REACHED();
3651 case StationType::Rail: str = STR_LAI_STATION_DESCRIPTION_RAILROAD_STATION; break;
3652 case StationType::Airport:
3653 str = (IsHangar(tile) ? STR_LAI_STATION_DESCRIPTION_AIRCRAFT_HANGAR : STR_LAI_STATION_DESCRIPTION_AIRPORT);
3654 break;
3655 case StationType::Truck: str = STR_LAI_STATION_DESCRIPTION_TRUCK_LOADING_AREA; break;
3656 case StationType::Bus: str = STR_LAI_STATION_DESCRIPTION_BUS_STATION; break;
3657 case StationType::Oilrig: {
3658 const Industry *i = Station::GetByTile(tile)->industry;
3659 const IndustrySpec *is = GetIndustrySpec(i->type);
3660 td.owner[0] = i->owner;
3661 str = is->name;
3662 if (is->grf_prop.HasGrfFile()) td.grf = GetGRFConfig(is->grf_prop.grfid)->GetName();
3663 break;
3664 }
3665 case StationType::Dock: str = STR_LAI_STATION_DESCRIPTION_SHIP_DOCK; break;
3666 case StationType::Buoy: str = STR_LAI_STATION_DESCRIPTION_BUOY; break;
3667 case StationType::RailWaypoint: str = STR_LAI_STATION_DESCRIPTION_WAYPOINT; break;
3668 case StationType::RoadWaypoint: str = STR_LAI_STATION_DESCRIPTION_WAYPOINT; break;
3669 }
3670 td.str = str;
3671}
3672
3673
3674static TrackStatus GetTileTrackStatus_Station(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
3675{
3676 TrackBits trackbits = TRACK_BIT_NONE;
3677
3678 switch (mode) {
3679 case TRANSPORT_RAIL:
3680 if (HasStationRail(tile) && !IsStationTileBlocked(tile)) {
3681 trackbits = TrackToTrackBits(GetRailStationTrack(tile));
3682 }
3683 break;
3684
3685 case TRANSPORT_WATER:
3686 /* buoy is coded as a station, it is always on open water */
3687 if (IsBuoy(tile)) {
3688 trackbits = TRACK_BIT_ALL;
3689 /* remove tracks that connect NE map edge */
3690 if (TileX(tile) == 0) trackbits &= ~(TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_RIGHT);
3691 /* remove tracks that connect NW map edge */
3692 if (TileY(tile) == 0) trackbits &= ~(TRACK_BIT_Y | TRACK_BIT_LEFT | TRACK_BIT_UPPER);
3693 }
3694 break;
3695
3696 case TRANSPORT_ROAD:
3697 if (IsAnyRoadStop(tile)) {
3698 RoadTramType rtt = (RoadTramType)sub_mode;
3699 if (!HasTileRoadType(tile, rtt)) break;
3700
3701 if (IsBayRoadStopTile(tile)) {
3702 DiagDirection dir = GetBayRoadStopDir(tile);
3703 if (side != INVALID_DIAGDIR && dir != side) break;
3704 trackbits = DiagDirToDiagTrackBits(dir);
3705 } else {
3706 Axis axis = GetDriveThroughStopAxis(tile);
3707 if (side != INVALID_DIAGDIR && axis != DiagDirToAxis(side)) break;
3708 trackbits = AxisToTrackBits(axis);
3709 }
3710 }
3711 break;
3712
3713 default:
3714 break;
3715 }
3716
3718}
3719
3720
3721static void TileLoop_Station(TileIndex tile)
3722{
3723 auto *st = BaseStation::GetByTile(tile);
3724 switch (GetStationType(tile)) {
3725 case StationType::Airport:
3726 TriggerAirportTileAnimation(Station::From(st), tile, AirportAnimationTrigger::TileLoop);
3727 break;
3728
3729 case StationType::Rail:
3730 case StationType::RailWaypoint:
3731 TriggerStationAnimation(st, tile, StationAnimationTrigger::TileLoop);
3732 break;
3733
3734 case StationType::Dock:
3735 if (!IsTileFlat(tile)) break; // only handle water part
3736 [[fallthrough]];
3737
3738 case StationType::Oilrig: //(station part)
3739 case StationType::Buoy:
3740 TileLoop_Water(tile);
3741 break;
3742
3743 case StationType::Truck:
3744 case StationType::Bus:
3745 TriggerRoadStopAnimation(st, tile, StationAnimationTrigger::TileLoop);
3746 break;
3747
3748 case StationType::RoadWaypoint: {
3750 case LandscapeType::Arctic:
3751 if (IsRoadWaypointOnSnowOrDesert(tile) != (GetTileZ(tile) > GetSnowLine())) {
3753 MarkTileDirtyByTile(tile);
3754 }
3755 break;
3756
3757 case LandscapeType::Tropic:
3760 MarkTileDirtyByTile(tile);
3761 }
3762 break;
3763
3764 default: break;
3765 }
3766
3767 HouseZone new_zone = HouseZone::TownEdge;
3768 const Town *t = ClosestTownFromTile(tile, UINT_MAX);
3769 if (t != nullptr) {
3770 new_zone = GetTownRadiusGroup(t, tile);
3771 }
3772
3773 /* Adjust road ground type depending on 'new_zone' */
3774 Roadside new_rs = new_zone != HouseZone::TownEdge ? Roadside::Paved : Roadside::Grass;
3775 Roadside cur_rs = GetRoadWaypointRoadside(tile);
3776
3777 if (new_rs != cur_rs) {
3778 SetRoadWaypointRoadside(tile, cur_rs == Roadside::Barren ? new_rs : Roadside::Barren);
3779 MarkTileDirtyByTile(tile);
3780 }
3781
3782 TriggerRoadStopAnimation(st, tile, StationAnimationTrigger::TileLoop);
3783 break;
3784 }
3785
3786 default: break;
3787 }
3788}
3789
3790
3791static void AnimateTile_Station(TileIndex tile)
3792{
3793 if (HasStationRail(tile)) {
3794 AnimateStationTile(tile);
3795 return;
3796 }
3797
3798 if (IsAirport(tile)) {
3799 AnimateAirportTile(tile);
3800 return;
3801 }
3802
3803 if (IsAnyRoadStopTile(tile)) {
3804 AnimateRoadStopTile(tile);
3805 return;
3806 }
3807}
3808
3809
3810static bool ClickTile_Station(TileIndex tile)
3811{
3812 const BaseStation *bst = BaseStation::GetByTile(tile);
3813
3816 } else if (IsHangar(tile)) {
3817 const Station *st = Station::From(bst);
3819 } else {
3821 }
3822 return true;
3823}
3824
3825static VehicleEnterTileStates VehicleEnter_Station(Vehicle *v, TileIndex tile, int x, int y)
3826{
3827 if (v->type == VEH_TRAIN) {
3828 StationID station_id = GetStationIndex(tile);
3829 if (!v->current_order.ShouldStopAtStation(v, station_id)) return {};
3830 if (!IsRailStation(tile) || !v->IsFrontEngine()) return {};
3831
3832 int station_ahead;
3833 int station_length;
3834 int stop = GetTrainStopLocation(station_id, tile, Train::From(v), &station_ahead, &station_length);
3835
3836 /* Stop whenever that amount of station ahead + the distance from the
3837 * begin of the platform to the stop location is longer than the length
3838 * of the platform. Station ahead 'includes' the current tile where the
3839 * vehicle is on, so we need to subtract that. */
3840 if (stop + station_ahead - (int)TILE_SIZE >= station_length) return {};
3841
3843
3844 x &= 0xF;
3845 y &= 0xF;
3846
3847 if (DiagDirToAxis(dir) != AXIS_X) std::swap(x, y);
3848 if (y == TILE_SIZE / 2) {
3849 if (dir != DIAGDIR_SE && dir != DIAGDIR_SW) x = TILE_SIZE - 1 - x;
3850 stop &= TILE_SIZE - 1;
3851
3852 if (x == stop) {
3853 return VehicleEnterTileState::EnteredStation; // enter station
3854 } else if (x < stop) {
3856 uint16_t spd = std::max(0, (stop - x) * 20 - 15);
3857 if (spd < v->cur_speed) v->cur_speed = spd;
3858 }
3859 }
3860 } else if (v->type == VEH_ROAD) {
3862 if (rv->state < RVSB_IN_ROAD_STOP && !IsReversingRoadTrackdir((Trackdir)rv->state) && rv->frame == 0) {
3863 if (IsStationRoadStop(tile) && rv->IsFrontEngine()) {
3864 /* Attempt to allocate a parking bay in a road stop */
3865 if (RoadStop::GetByTile(tile, GetRoadStopType(tile))->Enter(rv)) return {};
3867 }
3868 }
3869 }
3870
3871 return {};
3872}
3873
3879{
3880 /* Collect cargoes accepted since the last big tick. */
3881 CargoTypes cargoes = 0;
3882 for (CargoType cargo_type = 0; cargo_type < NUM_CARGO; cargo_type++) {
3883 if (st->goods[cargo_type].status.Test(GoodsEntry::State::AcceptedBigtick)) SetBit(cargoes, cargo_type);
3884 }
3885
3886 /* Anything to do? */
3887 if (cargoes == 0) return;
3888
3889 /* Loop over all houses in the catchment. */
3891 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
3892 if (IsTileType(tile, MP_HOUSE)) {
3894 }
3895 }
3896}
3897
3905{
3906 if (!st->IsInUse()) {
3907 if (++st->delete_ctr >= 8) delete st;
3908 return false;
3909 }
3910
3911 if (Station::IsExpected(st)) {
3913
3914 for (GoodsEntry &ge : Station::From(st)->goods) {
3915 ge.status.Reset(GoodsEntry::State::AcceptedBigtick);
3916 }
3917 }
3918
3919
3921
3922 return true;
3923}
3924
3925static inline void byte_inc_sat(uint8_t *p)
3926{
3927 uint8_t b = *p + 1;
3928 if (b != 0) *p = b;
3929}
3930
3937static void TruncateCargo(const CargoSpec *cs, GoodsEntry *ge, uint amount = UINT_MAX)
3938{
3939 /* If truncating also punish the source stations' ratings to
3940 * decrease the flow of incoming cargo. */
3941
3942 if (!ge->HasData()) return;
3943
3944 StationCargoAmountMap waiting_per_source;
3945 ge->GetData().cargo.Truncate(amount, &waiting_per_source);
3946 for (StationCargoAmountMap::iterator i(waiting_per_source.begin()); i != waiting_per_source.end(); ++i) {
3947 Station *source_station = Station::GetIfValid(i->first);
3948 if (source_station == nullptr) continue;
3949
3950 GoodsEntry &source_ge = source_station->goods[cs->Index()];
3951 source_ge.max_waiting_cargo = std::max(source_ge.max_waiting_cargo, i->second);
3952 }
3953}
3954
3960{
3961 bool waiting_changed = false;
3962
3963 byte_inc_sat(&st->time_since_load);
3964 byte_inc_sat(&st->time_since_unload);
3965
3966 for (const CargoSpec *cs : CargoSpec::Iterate()) {
3967 GoodsEntry *ge = &st->goods[cs->Index()];
3968
3969 /* The station might not currently be moving this cargo. */
3970 if (!ge->HasRating()) {
3971 /* Slowly increase the rating back to its original level in the case we
3972 * didn't deliver cargo yet to this station. This happens when a bribe
3973 * failed while you didn't moved that cargo yet to a station. */
3974 if (ge->rating < INITIAL_STATION_RATING) ge->rating++;
3975
3976 /* Nothing else to do with this cargo. */
3977 continue;
3978 }
3979
3980 byte_inc_sat(&ge->time_since_pickup);
3981
3982 /* If this cargo hasn't been picked up in a long time, get rid of it. */
3985 ge->last_speed = 0;
3986 TruncateCargo(cs, ge);
3987 waiting_changed = true;
3988 continue;
3989 }
3990
3991 bool skip = false;
3992 int rating = 0;
3993 uint waiting = ge->HasData() ? ge->GetData().cargo.AvailableCount() : 0;
3994
3995 /* num_dests is at least 1 if there is any cargo as
3996 * StationID::Invalid() is also a destination.
3997 */
3998 uint num_dests = ge->HasData() ? static_cast<uint>(ge->GetData().cargo.Packets()->MapSize()) : 0;
3999
4000 /* Average amount of cargo per next hop, but prefer solitary stations
4001 * with only one or two next hops. They are allowed to have more
4002 * cargo waiting per next hop.
4003 * With manual cargo distribution waiting_avg = waiting / 2 as then
4004 * StationID::Invalid() is the only destination.
4005 */
4006 uint waiting_avg = waiting / (num_dests + 1);
4007
4009 ge->rating = rating = MAX_STATION_RATING;
4010 skip = true;
4011 } else if (cs->callback_mask.Test(CargoCallbackMask::StationRatingCalc)) {
4012 /* Perform custom station rating. If it succeeds the speed, days in transit and
4013 * waiting cargo ratings must not be executed. */
4014
4015 /* NewGRFs expect last speed to be 0xFF when no vehicle has arrived yet. */
4016 uint last_speed = ge->HasVehicleEverTriedLoading() ? ge->last_speed : 0xFF;
4017
4018 uint32_t var18 = ClampTo<uint8_t>(ge->time_since_pickup)
4019 | (ClampTo<uint16_t>(ge->max_waiting_cargo) << 8)
4020 | (ClampTo<uint8_t>(last_speed) << 24);
4021 /* Convert to the 'old' vehicle types */
4022 uint32_t var10 = (st->last_vehicle_type == VEH_INVALID) ? 0x0 : (st->last_vehicle_type + 0x10);
4023 uint16_t callback = GetCargoCallback(CBID_CARGO_STATION_RATING_CALC, var10, var18, cs);
4024 if (callback != CALLBACK_FAILED) {
4025 skip = true;
4026 rating = GB(callback, 0, 14);
4027
4028 /* Simulate a 15 bit signed value */
4029 if (HasBit(callback, 14)) rating -= 0x4000;
4030 }
4031 }
4032
4033 if (!skip) {
4034 int b = ge->last_speed - 85;
4035 if (b >= 0) rating += b >> 2;
4036
4037 uint8_t waittime = ge->time_since_pickup;
4038 if (st->last_vehicle_type == VEH_SHIP) waittime >>= 2;
4039 if (waittime <= 21) rating += 25;
4040 if (waittime <= 12) rating += 25;
4041 if (waittime <= 6) rating += 45;
4042 if (waittime <= 3) rating += 35;
4043
4044 rating -= 90;
4045 if (ge->max_waiting_cargo <= 1500) rating += 55;
4046 if (ge->max_waiting_cargo <= 1000) rating += 35;
4047 if (ge->max_waiting_cargo <= 600) rating += 10;
4048 if (ge->max_waiting_cargo <= 300) rating += 20;
4049 if (ge->max_waiting_cargo <= 100) rating += 10;
4050 }
4051
4052 if (Company::IsValidID(st->owner) && st->town->statues.Test(st->owner)) rating += 26;
4053
4054 uint8_t age = ge->last_age;
4055 if (age < 3) rating += 10;
4056 if (age < 2) rating += 10;
4057 if (age < 1) rating += 13;
4058
4059 {
4060 int or_ = ge->rating; // old rating
4061
4062 /* only modify rating in steps of -2, -1, 0, 1 or 2 */
4063 ge->rating = rating = ClampTo<uint8_t>(or_ + Clamp(rating - or_, -2, 2));
4064
4065 /* if rating is <= 64 and more than 100 items waiting on average per destination,
4066 * remove some random amount of goods from the station */
4067 if (rating <= 64 && waiting_avg >= 100) {
4068 int dec = Random() & 0x1F;
4069 if (waiting_avg < 200) dec &= 7;
4070 waiting -= (dec + 1) * num_dests;
4071 waiting_changed = true;
4072 }
4073
4074 /* if rating is <= 127 and there are any items waiting, maybe remove some goods. */
4075 if (rating <= 127 && waiting != 0) {
4076 uint32_t r = Random();
4077 if (rating <= (int)GB(r, 0, 7)) {
4078 /* Need to have int, otherwise it will just overflow etc. */
4079 waiting = std::max((int)waiting - (int)((GB(r, 8, 2) + 1) * num_dests), 0);
4080 waiting_changed = true;
4081 }
4082 }
4083
4084 /* At some point we really must cap the cargo. Previously this
4085 * was a strict 4095, but now we'll have a less strict, but
4086 * increasingly aggressive truncation of the amount of cargo. */
4087 static const uint WAITING_CARGO_THRESHOLD = 1 << 12;
4088 static const uint WAITING_CARGO_CUT_FACTOR = 1 << 6;
4089 static const uint MAX_WAITING_CARGO = 1 << 15;
4090
4091 if (waiting > WAITING_CARGO_THRESHOLD) {
4092 uint difference = waiting - WAITING_CARGO_THRESHOLD;
4093 waiting -= (difference / WAITING_CARGO_CUT_FACTOR);
4094
4095 waiting = std::min(waiting, MAX_WAITING_CARGO);
4096 waiting_changed = true;
4097 }
4098
4099 /* We can't truncate cargo that's already reserved for loading.
4100 * Thus StoredCount() here. */
4101 if (waiting_changed && waiting < (ge->HasData() ? ge->GetData().cargo.AvailableCount() : 0)) {
4102 /* Feed back the exact own waiting cargo at this station for the
4103 * next rating calculation. */
4104 ge->max_waiting_cargo = 0;
4105
4106 TruncateCargo(cs, ge, ge->GetData().cargo.AvailableCount() - waiting);
4107 } else {
4108 /* If the average number per next hop is low, be more forgiving. */
4109 ge->max_waiting_cargo = waiting_avg;
4110 }
4111 }
4112 }
4113
4114 StationID index = st->index;
4115 if (waiting_changed) {
4116 SetWindowDirty(WC_STATION_VIEW, index); // update whole window
4117 } else {
4118 SetWindowWidgetDirty(WC_STATION_VIEW, index, WID_SV_ACCEPT_RATING_LIST); // update only ratings list
4119 }
4120}
4121
4130void RerouteCargo(Station *st, CargoType cargo, StationID avoid, StationID avoid2)
4131{
4132 GoodsEntry &ge = st->goods[cargo];
4133
4134 /* Reroute cargo in station. */
4135 if (ge.HasData()) ge.GetData().cargo.Reroute(UINT_MAX, &ge.GetData().cargo, avoid, avoid2, &ge);
4136
4137 /* Reroute cargo staged to be transferred. */
4138 for (Vehicle *v : st->loading_vehicles) {
4139 for (Vehicle *u = v; u != nullptr; u = u->Next()) {
4140 if (u->cargo_type != cargo) continue;
4141 u->cargo.Reroute(UINT_MAX, &u->cargo, avoid, avoid2, &ge);
4142 }
4143 }
4144}
4145
4155{
4156 for (CargoType cargo = 0; cargo < NUM_CARGO; ++cargo) {
4157 const bool auto_distributed = (_settings_game.linkgraph.GetDistributionType(cargo) != DT_MANUAL);
4158 GoodsEntry &ge = from->goods[cargo];
4160 if (lg == nullptr) continue;
4161 std::vector<NodeID> to_remove{};
4162 for (Edge &edge : (*lg)[ge.node].edges) {
4163 Station *to = Station::Get((*lg)[edge.dest_node].station);
4164 assert(to->goods[cargo].node == edge.dest_node);
4165 assert(TimerGameEconomy::date >= edge.LastUpdate());
4167 if (TimerGameEconomy::date - edge.LastUpdate() > timeout) {
4168 bool updated = false;
4169
4170 if (auto_distributed) {
4171 /* Have all vehicles refresh their next hops before deciding to
4172 * remove the node. */
4173 std::vector<Vehicle *> vehicles;
4174 for (const OrderList *l : OrderList::Iterate()) {
4175 bool found_from = false;
4176 bool found_to = false;
4177 for (const Order &order : l->GetOrders()) {
4178 if (!order.IsType(OT_GOTO_STATION) && !order.IsType(OT_IMPLICIT)) continue;
4179 if (order.GetDestination() == from->index) {
4180 found_from = true;
4181 if (found_to) break;
4182 } else if (order.GetDestination() == to->index) {
4183 found_to = true;
4184 if (found_from) break;
4185 }
4186 }
4187 if (!found_to || !found_from) continue;
4188 vehicles.push_back(l->GetFirstSharedVehicle());
4189 }
4190
4191 auto iter = vehicles.begin();
4192 while (iter != vehicles.end()) {
4193 Vehicle *v = *iter;
4194 /* Do not refresh links of vehicles that have been stopped in depot for a long time. */
4196 LinkRefresher::Run(v, false); // Don't allow merging. Otherwise lg might get deleted.
4197 }
4198 if (edge.LastUpdate() == TimerGameEconomy::date) {
4199 updated = true;
4200 break;
4201 }
4202
4203 Vehicle *next_shared = v->NextShared();
4204 if (next_shared) {
4205 *iter = next_shared;
4206 ++iter;
4207 } else {
4208 iter = vehicles.erase(iter);
4209 }
4210
4211 if (iter == vehicles.end()) iter = vehicles.begin();
4212 }
4213 }
4214
4215 if (!updated) {
4216 /* If it's still considered dead remove it. */
4217 to_remove.emplace_back(to->goods[cargo].node);
4218 if (ge.HasData()) ge.GetData().flows.DeleteFlows(to->index);
4219 RerouteCargo(from, cargo, to->index, from->index);
4220 }
4221 } else if (edge.last_unrestricted_update != EconomyTime::INVALID_DATE && TimerGameEconomy::date - edge.last_unrestricted_update > timeout) {
4222 edge.Restrict();
4223 if (ge.HasData()) ge.GetData().flows.RestrictFlows(to->index);
4224 RerouteCargo(from, cargo, to->index, from->index);
4225 } else if (edge.last_restricted_update != EconomyTime::INVALID_DATE && TimerGameEconomy::date - edge.last_restricted_update > timeout) {
4226 edge.Release();
4227 }
4228 }
4229 /* Remove dead edges. */
4230 for (NodeID r : to_remove) (*lg)[ge.node].RemoveEdge(r);
4231
4232 assert(TimerGameEconomy::date >= lg->LastCompression());
4234 lg->Compress();
4235 }
4236 }
4237}
4238
4248void IncreaseStats(Station *st, CargoType cargo, StationID next_station_id, uint capacity, uint usage, uint32_t time, EdgeUpdateModes modes)
4249{
4250 GoodsEntry &ge1 = st->goods[cargo];
4251 Station *st2 = Station::Get(next_station_id);
4252 GoodsEntry &ge2 = st2->goods[cargo];
4253 LinkGraph *lg = nullptr;
4254 if (ge1.link_graph == LinkGraphID::Invalid()) {
4255 if (ge2.link_graph == LinkGraphID::Invalid()) {
4257 lg = new LinkGraph(cargo);
4259 ge2.link_graph = lg->index;
4260 ge2.node = lg->AddNode(st2);
4261 } else {
4262 Debug(misc, 0, "Can't allocate link graph");
4263 }
4264 } else {
4265 lg = LinkGraph::Get(ge2.link_graph);
4266 }
4267 if (lg) {
4268 ge1.link_graph = lg->index;
4269 ge1.node = lg->AddNode(st);
4270 }
4271 } else if (ge2.link_graph == LinkGraphID::Invalid()) {
4272 lg = LinkGraph::Get(ge1.link_graph);
4273 ge2.link_graph = lg->index;
4274 ge2.node = lg->AddNode(st2);
4275 } else {
4276 lg = LinkGraph::Get(ge1.link_graph);
4277 if (ge1.link_graph != ge2.link_graph) {
4279 if (lg->Size() < lg2->Size()) {
4281 lg2->Merge(lg); // Updates GoodsEntries of lg
4282 lg = lg2;
4283 } else {
4285 lg->Merge(lg2); // Updates GoodsEntries of lg2
4286 }
4287 }
4288 }
4289 if (lg != nullptr) {
4290 (*lg)[ge1.node].UpdateEdge(ge2.node, capacity, usage, time, modes);
4291 }
4292}
4293
4300void IncreaseStats(Station *st, const Vehicle *front, StationID next_station_id, uint32_t time)
4301{
4302 for (const Vehicle *v = front; v != nullptr; v = v->Next()) {
4303 if (v->refit_cap > 0) {
4304 /* The cargo count can indeed be higher than the refit_cap if
4305 * wagons have been auto-replaced and subsequently auto-
4306 * refitted to a higher capacity. The cargo gets redistributed
4307 * among the wagons in that case.
4308 * As usage is not such an important figure anyway we just
4309 * ignore the additional cargo then.*/
4310 IncreaseStats(st, v->cargo_type, next_station_id, v->refit_cap,
4311 std::min<uint>(v->refit_cap, v->cargo.StoredCount()), time, EdgeUpdateMode::Increase);
4312 }
4313 }
4314}
4315
4316/* called for every station each tick */
4317static void StationHandleSmallTick(BaseStation *st)
4318{
4319 if (st->facilities.Test(StationFacility::Waypoint) || !st->IsInUse()) return;
4320
4321 uint8_t b = st->delete_ctr + 1;
4322 if (b >= Ticks::STATION_RATING_TICKS) b = 0;
4323 st->delete_ctr = b;
4324
4325 if (b == 0) UpdateStationRating(Station::From(st));
4326}
4327
4328void OnTick_Station()
4329{
4330 if (_game_mode == GM_EDITOR) return;
4331
4332 for (BaseStation *st : BaseStation::Iterate()) {
4333 StationHandleSmallTick(st);
4334
4335 /* Clean up the link graph about once a week. */
4338 };
4339
4340 /* Spread out big-tick over STATION_ACCEPTANCE_TICKS ticks. */
4342 /* Stop processing this station if it was deleted */
4343 if (!StationHandleBigTick(st)) continue;
4344 }
4345
4346 /* Spread out station animation over STATION_ACCEPTANCE_TICKS ticks. */
4348 TriggerStationAnimation(st, st->xy, StationAnimationTrigger::AcceptanceTick);
4349 TriggerRoadStopAnimation(st, st->xy, StationAnimationTrigger::AcceptanceTick);
4350 if (Station::IsExpected(st)) TriggerAirportAnimation(Station::From(st), AirportAnimationTrigger::AcceptanceTick);
4351 }
4352 }
4353}
4354
4356static const IntervalTimer<TimerGameEconomy> _economy_stations_monthly({TimerGameEconomy::MONTH, TimerGameEconomy::Priority::STATION}, [](auto)
4357{
4358 for (Station *st : Station::Iterate()) {
4359 for (GoodsEntry &ge : st->goods) {
4360 ge.status.Set(GoodsEntry::State::LastMonth, ge.status.Test(GoodsEntry::State::CurrentMonth));
4361 ge.status.Reset(GoodsEntry::State::CurrentMonth);
4362 }
4363 }
4364});
4365
4374void ModifyStationRatingAround(TileIndex tile, Owner owner, int amount, uint radius)
4375{
4376 ForAllStationsRadius(tile, radius, [&](Station *st) {
4377 if (st->owner == owner && DistanceManhattan(tile, st->xy) <= radius) {
4378 for (GoodsEntry &ge : st->goods) {
4379 if (ge.status.Any()) {
4380 ge.rating = ClampTo<uint8_t>(ge.rating + amount);
4381 }
4382 }
4383 }
4384 });
4385}
4386
4387static uint UpdateStationWaiting(Station *st, CargoType cargo, uint amount, Source source)
4388{
4389 /* We can't allocate a CargoPacket? Then don't do anything
4390 * at all; i.e. just discard the incoming cargo. */
4391 if (!CargoPacket::CanAllocateItem()) return 0;
4392
4393 GoodsEntry &ge = st->goods[cargo];
4394 amount += ge.amount_fract;
4395 ge.amount_fract = GB(amount, 0, 8);
4396
4397 amount >>= 8;
4398 /* No new "real" cargo item yet. */
4399 if (amount == 0) return 0;
4400
4401 StationID next = ge.GetVia(st->index);
4402 ge.GetOrCreateData().cargo.Append(new CargoPacket(st->index, amount, source), next);
4403 LinkGraph *lg = nullptr;
4404 if (ge.link_graph == LinkGraphID::Invalid()) {
4406 lg = new LinkGraph(cargo);
4408 ge.link_graph = lg->index;
4409 ge.node = lg->AddNode(st);
4410 } else {
4411 Debug(misc, 0, "Can't allocate link graph");
4412 }
4413 } else {
4414 lg = LinkGraph::Get(ge.link_graph);
4415 }
4416 if (lg != nullptr) (*lg)[ge.node].UpdateSupply(amount);
4417
4418 if (!ge.HasRating()) {
4421 }
4422
4424 TriggerStationAnimation(st, st->xy, StationAnimationTrigger::NewCargo, cargo);
4425 TriggerAirportAnimation(st, AirportAnimationTrigger::NewCargo, cargo);
4426 TriggerRoadStopRandomisation(st, st->xy, StationRandomTrigger::NewCargo, cargo);
4427 TriggerRoadStopAnimation(st, st->xy, StationAnimationTrigger::NewCargo, cargo);
4428
4429
4431 st->MarkTilesDirty(true);
4432 return amount;
4433}
4434
4435static bool IsUniqueStationName(const std::string &name)
4436{
4437 for (const Station *st : Station::Iterate()) {
4438 if (!st->name.empty() && st->name == name) return false;
4439 }
4440
4441 return true;
4442}
4443
4451CommandCost CmdRenameStation(DoCommandFlags flags, StationID station_id, const std::string &text)
4452{
4453 Station *st = Station::GetIfValid(station_id);
4454 if (st == nullptr) return CMD_ERROR;
4455
4456 CommandCost ret = CheckOwnership(st->owner);
4457 if (ret.Failed()) return ret;
4458
4459 bool reset = text.empty();
4460
4461 if (!reset) {
4463 if (!IsUniqueStationName(text)) return CommandCost(STR_ERROR_NAME_MUST_BE_UNIQUE);
4464 }
4465
4466 if (flags.Test(DoCommandFlag::Execute)) {
4467 st->cached_name.clear();
4468 if (reset) {
4469 st->name.clear();
4470 } else {
4471 st->name = text;
4472 }
4473
4474 st->UpdateVirtCoord();
4476 }
4477
4478 return CommandCost();
4479}
4480
4488std::tuple<CommandCost, StationID> CmdMoveStationName(DoCommandFlags flags, StationID station_id, TileIndex tile)
4489{
4490 Station *st = Station::GetIfValid(station_id);
4491 if (st == nullptr) return { CMD_ERROR, StationID::Invalid() };
4492
4493 if (st->owner != OWNER_NONE) {
4494 CommandCost ret = CheckOwnership(st->owner);
4495 if (ret.Failed()) return { ret, StationID::Invalid() };
4496 }
4497
4498 const StationRect *r = &st->rect;
4499 if (!r->PtInExtendedRect(TileX(tile), TileY(tile))) {
4500 return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
4501 }
4502
4503 bool other_station = false;
4504 /* Check if the tile is the base tile of another station */
4505 ForAllStationsRadius(tile, 0, [&](BaseStation *s) {
4506 if (s != nullptr) {
4507 if (s != st && s->xy == tile) other_station = true;
4508 }
4509 });
4510 if (other_station) return { CommandCost(STR_ERROR_SITE_UNSUITABLE), StationID::Invalid() };
4511
4512 if (flags.Test(DoCommandFlag::Execute)) {
4513 st->MoveSign(tile);
4514
4515 st->UpdateVirtCoord();
4516 }
4517 return { CommandCost(), station_id };
4518}
4519
4525void CcMoveStationName(Commands, const CommandCost &result, StationID station_id)
4526 {
4527 if (result.Failed()) return;
4528
4530 Station *st = Station::Get(station_id);
4531 SetViewportStationRect(st, false);
4532 }
4533
4534static void AddNearbyStationsByCatchment(TileIndex tile, StationList &stations, StationList &nearby)
4535{
4536 for (Station *st : nearby) {
4537 if (st->TileIsInCatchment(tile)) stations.insert(st);
4538 }
4539}
4540
4546{
4547 if (this->tile != INVALID_TILE) {
4548 if (IsTileType(this->tile, MP_HOUSE)) {
4549 /* Town nearby stations need to be filtered per tile. */
4550 assert(this->w == 1 && this->h == 1);
4551 AddNearbyStationsByCatchment(this->tile, this->stations, Town::GetByTile(this->tile)->stations_near);
4552 } else {
4553 ForAllStationsAroundTiles(*this, [this](Station *st, TileIndex) {
4554 this->stations.insert(st);
4555 return true;
4556 });
4557 }
4558 this->tile = INVALID_TILE;
4559 }
4560 return this->stations;
4561}
4562
4563
4564static bool CanMoveGoodsToStation(const Station *st, CargoType cargo)
4565{
4566 /* Is the station reserved exclusively for somebody else? */
4567 if (st->owner != OWNER_NONE && st->town->exclusive_counter > 0 && st->town->exclusivity != st->owner) return false;
4568
4569 /* Lowest possible rating, better not to give cargo anymore. */
4570 if (st->goods[cargo].rating == 0) return false;
4571
4572 /* Selectively servicing stations, and not this one. */
4573 if (_settings_game.order.selectgoods && !st->goods[cargo].HasVehicleEverTriedLoading()) return false;
4574
4576 /* Passengers are never served by just a truck stop. */
4577 if (st->facilities == StationFacility::TruckStop) return false;
4578 } else {
4579 /* Non-passengers are never served by just a bus stop. */
4580 if (st->facilities == StationFacility::BusStop) return false;
4581 }
4582 return true;
4583}
4584
4585uint MoveGoodsToStation(CargoType cargo, uint amount, Source source, const StationList &all_stations, Owner exclusivity)
4586{
4587 /* Return if nothing to do. Also the rounding below fails for 0. */
4588 if (all_stations.empty()) return 0;
4589 if (amount == 0) return 0;
4590
4591 Station *first_station = nullptr;
4592 typedef std::pair<Station *, uint> StationInfo;
4593 std::vector<StationInfo> used_stations;
4594
4595 for (Station *st : all_stations) {
4596 if (exclusivity != INVALID_OWNER && exclusivity != st->owner) continue;
4597 if (!CanMoveGoodsToStation(st, cargo)) continue;
4598
4599 /* Avoid allocating a vector if there is only one station to significantly
4600 * improve performance in this common case. */
4601 if (first_station == nullptr) {
4602 first_station = st;
4603 continue;
4604 }
4605 if (used_stations.empty()) {
4606 used_stations.reserve(2);
4607 used_stations.emplace_back(first_station, 0);
4608 }
4609 used_stations.emplace_back(st, 0);
4610 }
4611
4612 /* no stations around at all? */
4613 if (first_station == nullptr) return 0;
4614
4615 if (used_stations.empty()) {
4616 /* only one station around */
4617 amount *= first_station->goods[cargo].rating + 1;
4618 return UpdateStationWaiting(first_station, cargo, amount, source);
4619 }
4620
4621 TypedIndexContainer<std::array<uint32_t, OWNER_END.base()>, Owner> company_best = {}; // best rating for each company, including OWNER_NONE
4622 TypedIndexContainer<std::array<uint32_t, OWNER_END.base()>, Owner> company_sum = {}; // sum of ratings for each company
4623 uint best_rating = 0;
4624 uint best_sum = 0; // sum of best ratings for each company
4625
4626 for (auto &p : used_stations) {
4627 auto owner = p.first->owner;
4628 auto rating = p.first->goods[cargo].rating;
4629 if (rating > company_best[owner]) {
4630 best_sum += rating - company_best[owner]; // it's usually faster than iterating companies later
4631 company_best[owner] = rating;
4632 if (rating > best_rating) best_rating = rating;
4633 }
4634 company_sum[owner] += rating;
4635 }
4636
4637 /* From now we'll calculate with fractional cargo amounts.
4638 * First determine how much cargo we really have. */
4639 amount *= best_rating + 1;
4640
4641 uint moving = 0;
4642 for (auto &p : used_stations) {
4643 Owner owner = p.first->owner;
4644 /* Multiply the amount by (company best / sum of best for each company) to get cargo allocated to a company
4645 * and by (station rating / sum of ratings in a company) to get the result for a single station. */
4646 p.second = amount * company_best[owner] * p.first->goods[cargo].rating / best_sum / company_sum[owner];
4647 moving += p.second;
4648 }
4649
4650 /* If there is some cargo left due to rounding issues distribute it among the best rated stations. */
4651 if (amount > moving) {
4652 std::stable_sort(used_stations.begin(), used_stations.end(), [cargo](const StationInfo &a, const StationInfo &b) {
4653 return b.first->goods[cargo].rating < a.first->goods[cargo].rating;
4654 });
4655
4656 assert(amount - moving <= used_stations.size());
4657 for (uint i = 0; i < amount - moving; i++) {
4658 used_stations[i].second++;
4659 }
4660 }
4661
4662 uint moved = 0;
4663 for (auto &p : used_stations) {
4664 moved += UpdateStationWaiting(p.first, cargo, p.second, source);
4665 }
4666
4667 return moved;
4668}
4669
4670void UpdateStationDockingTiles(Station *st)
4671{
4672 st->docking_station.Clear();
4673
4674 /* For neutral stations, start with the industry area instead of dock area */
4675 const TileArea *area = st->industry != nullptr ? &st->industry->location : &st->ship_station;
4676
4677 if (area->tile == INVALID_TILE) return;
4678
4679 int x = TileX(area->tile);
4680 int y = TileY(area->tile);
4681
4682 /* Expand the area by a tile on each side while
4683 * making sure that we remain inside the map. */
4684 int x2 = std::min<int>(x + area->w + 1, Map::SizeX());
4685 int x1 = std::max<int>(x - 1, 0);
4686
4687 int y2 = std::min<int>(y + area->h + 1, Map::SizeY());
4688 int y1 = std::max<int>(y - 1, 0);
4689
4690 TileArea ta(TileXY(x1, y1), TileXY(x2 - 1, y2 - 1));
4691 for (TileIndex tile : ta) {
4692 if (IsValidTile(tile) && IsPossibleDockingTile(tile)) CheckForDockingTile(tile);
4693 }
4694}
4695
4696void BuildOilRig(TileIndex tile)
4697{
4698 if (!Station::CanAllocateItem()) {
4699 Debug(misc, 0, "Can't allocate station for oilrig at 0x{:X}, reverting to oilrig only", tile);
4700 return;
4701 }
4702
4703 Station *st = new Station(tile);
4704 _station_kdtree.Insert(st->index);
4705 st->town = ClosestTownFromTile(tile, UINT_MAX);
4706
4707 st->string_id = GenerateStationName(st, tile, STATIONNAMING_OILRIG);
4708
4709 assert(IsTileType(tile, MP_INDUSTRY));
4710 /* Mark industry as associated both ways */
4711 st->industry = Industry::GetByTile(tile);
4712 st->industry->neutral_station = st;
4713 DeleteAnimatedTile(tile);
4714 MakeOilrig(tile, st->index, GetWaterClass(tile));
4715
4716 st->owner = OWNER_NONE;
4717 st->airport.type = AT_OILRIG;
4718 st->airport.rotation = DIR_N;
4719 st->airport.Add(tile);
4720 st->ship_station.Add(tile);
4723 UpdateStationDockingTiles(st);
4724
4725 st->rect.BeforeAddTile(tile, StationRect::ADD_FORCE);
4726
4727 st->UpdateVirtCoord();
4728
4729 /* An industry tile has now been replaced with a station tile, this may change the overlap between station catchments and industry tiles.
4730 * Recalculate the station catchment for all stations currently in the industry's nearby list.
4731 * Clear the industry's station nearby list first because Station::RecomputeCatchment cannot remove nearby industries in this case. */
4733 StationList nearby = std::move(st->industry->stations_near);
4734 st->industry->stations_near.clear();
4735 for (Station *near : nearby) {
4736 near->RecomputeCatchment(true);
4737 UpdateStationAcceptance(near, true);
4738 }
4739 }
4740
4741 st->RecomputeCatchment();
4742 UpdateStationAcceptance(st, false);
4743}
4744
4745void DeleteOilRig(TileIndex tile)
4746{
4747 Station *st = Station::GetByTile(tile);
4748
4749 MakeWaterKeepingClass(tile, OWNER_NONE);
4750
4751 /* The oil rig station is not supposed to be shared with anything else */
4752 [[maybe_unused]] static constexpr StationFacilities expected_facility{StationFacility::Airport, StationFacility::Dock};
4753 assert(st->facilities == expected_facility && st->airport.type == AT_OILRIG);
4754 if (st->industry != nullptr && st->industry->neutral_station == st) {
4755 /* Don't leave dangling neutral station pointer */
4756 st->industry->neutral_station = nullptr;
4757 }
4758 delete st;
4759}
4760
4761static void ChangeTileOwner_Station(TileIndex tile, Owner old_owner, Owner new_owner)
4762{
4763
4764 if (IsAnyRoadStopTile(tile)) {
4765 for (RoadTramType rtt : _roadtramtypes) {
4766 /* Update all roadtypes, no matter if they are present */
4767 if (GetRoadOwner(tile, rtt) == old_owner) {
4768 RoadType rt = GetRoadType(tile, rtt);
4769 if (rt != INVALID_ROADTYPE) {
4770 /* A drive-through road-stop has always two road bits. No need to dirty windows here, we'll redraw the whole screen anyway. */
4771 Company::Get(old_owner)->infrastructure.road[rt] -= 2;
4772 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.road[rt] += 2;
4773 }
4774 SetRoadOwner(tile, rtt, new_owner == INVALID_OWNER ? OWNER_NONE : new_owner);
4775 }
4776 }
4777 }
4778
4779 if (!IsTileOwner(tile, old_owner)) return;
4780
4781 if (new_owner != INVALID_OWNER) {
4782 /* Update company infrastructure counts. Only do it here
4783 * if the new owner is valid as otherwise the clear
4784 * command will do it for us. No need to dirty windows
4785 * here, we'll redraw the whole screen anyway.*/
4786 Company *old_company = Company::Get(old_owner);
4787 Company *new_company = Company::Get(new_owner);
4788
4789 /* Update counts for underlying infrastructure. */
4790 switch (GetStationType(tile)) {
4791 case StationType::Rail:
4792 case StationType::RailWaypoint:
4793 if (!IsStationTileBlocked(tile)) {
4794 old_company->infrastructure.rail[GetRailType(tile)]--;
4795 new_company->infrastructure.rail[GetRailType(tile)]++;
4796 }
4797 break;
4798
4799 case StationType::Bus:
4800 case StationType::Truck:
4801 case StationType::RoadWaypoint:
4802 /* Road stops were already handled above. */
4803 break;
4804
4805 case StationType::Buoy:
4806 case StationType::Dock:
4807 if (GetWaterClass(tile) == WaterClass::Canal) {
4808 old_company->infrastructure.water--;
4809 new_company->infrastructure.water++;
4810 }
4811 break;
4812
4813 default:
4814 break;
4815 }
4816
4817 /* Update station tile count. */
4818 if (!IsBuoy(tile) && !IsAirport(tile)) {
4819 old_company->infrastructure.station--;
4820 new_company->infrastructure.station++;
4821 }
4822
4823 /* for buoys, owner of tile is owner of water, st->owner == OWNER_NONE */
4824 SetTileOwner(tile, new_owner);
4826 } else {
4827 if (IsDriveThroughStopTile(tile)) {
4828 /* Remove the drive-through road stop */
4829 if (IsRoadWaypoint(tile)) {
4831 } else {
4833 }
4834 assert(IsTileType(tile, MP_ROAD));
4835 /* Change owner of tile and all roadtypes */
4836 ChangeTileOwner(tile, old_owner, new_owner);
4837 } else {
4839 /* Set tile owner of water under (now removed) buoy and dock to OWNER_NONE.
4840 * Update owner of buoy if it was not removed (was in orders).
4841 * Do not update when owned by OWNER_WATER (sea and rivers). */
4842 if ((IsTileType(tile, MP_WATER) || IsBuoyTile(tile)) && IsTileOwner(tile, old_owner)) SetTileOwner(tile, OWNER_NONE);
4843 }
4844 }
4845}
4846
4856{
4857 /* Water flooding can always clear road stops. */
4858 if (_current_company == OWNER_WATER) return CommandCost();
4859
4860 CommandCost ret;
4861
4862 if (GetRoadTypeTram(tile) != INVALID_ROADTYPE) {
4863 Owner tram_owner = GetRoadOwner(tile, RTT_TRAM);
4864 if (tram_owner != OWNER_NONE) {
4865 ret = CheckOwnership(tram_owner);
4866 if (ret.Failed()) return ret;
4867 }
4868 }
4869
4870 if (GetRoadTypeRoad(tile) != INVALID_ROADTYPE) {
4871 Owner road_owner = GetRoadOwner(tile, RTT_ROAD);
4872 if (road_owner == OWNER_TOWN) {
4873 ret = CheckAllowRemoveRoad(tile, GetAnyRoadBits(tile, RTT_ROAD), OWNER_TOWN, RTT_ROAD, flags);
4874 if (ret.Failed()) return ret;
4875 } else if (road_owner != OWNER_NONE) {
4876 ret = CheckOwnership(road_owner);
4877 if (ret.Failed()) return ret;
4878 }
4879 }
4880
4881 return CommandCost();
4882}
4883
4891{
4892 if (flags.Test(DoCommandFlag::Auto)) {
4893 switch (GetStationType(tile)) {
4894 default: break;
4895 case StationType::Rail: return CommandCost(STR_ERROR_MUST_DEMOLISH_RAILROAD);
4896 case StationType::RailWaypoint: return CommandCost(STR_ERROR_BUILDING_MUST_BE_DEMOLISHED);
4897 case StationType::Airport: return CommandCost(STR_ERROR_MUST_DEMOLISH_AIRPORT_FIRST);
4898 case StationType::Truck: return CommandCost(HasTileRoadType(tile, RTT_TRAM) ? STR_ERROR_MUST_DEMOLISH_CARGO_TRAM_STATION_FIRST : STR_ERROR_MUST_DEMOLISH_TRUCK_STATION_FIRST);
4899 case StationType::Bus: return CommandCost(HasTileRoadType(tile, RTT_TRAM) ? STR_ERROR_MUST_DEMOLISH_PASSENGER_TRAM_STATION_FIRST : STR_ERROR_MUST_DEMOLISH_BUS_STATION_FIRST);
4900 case StationType::RoadWaypoint: return CommandCost(STR_ERROR_BUILDING_MUST_BE_DEMOLISHED);
4901 case StationType::Buoy: return CommandCost(STR_ERROR_BUOY_IN_THE_WAY);
4902 case StationType::Dock: return CommandCost(STR_ERROR_MUST_DEMOLISH_DOCK_FIRST);
4903 case StationType::Oilrig:
4904 return CommandCostWithParam(STR_ERROR_GENERIC_OBJECT_IN_THE_WAY, STR_INDUSTRY_NAME_OIL_RIG);
4905 }
4906 }
4907
4908 switch (GetStationType(tile)) {
4909 case StationType::Rail: return RemoveRailStation(tile, flags);
4910 case StationType::RailWaypoint: return RemoveRailWaypoint(tile, flags);
4911 case StationType::Airport: return RemoveAirport(tile, flags);
4912 case StationType::Truck: [[fallthrough]];
4913 case StationType::Bus:
4914 if (IsDriveThroughStopTile(tile)) {
4915 CommandCost remove_road = CanRemoveRoadWithStop(tile, flags);
4916 if (remove_road.Failed()) return remove_road;
4917 }
4918 return RemoveRoadStop(tile, flags);
4919 case StationType::RoadWaypoint: {
4920 CommandCost remove_road = CanRemoveRoadWithStop(tile, flags);
4921 if (remove_road.Failed()) return remove_road;
4922 return RemoveRoadWaypointStop(tile, flags);
4923 }
4924 case StationType::Buoy: return RemoveBuoy(tile, flags);
4925 case StationType::Dock: return RemoveDock(tile, flags);
4926 default: break;
4927 }
4928
4929 return CMD_ERROR;
4930}
4931
4932static CommandCost TerraformTile_Station(TileIndex tile, DoCommandFlags flags, int z_new, Slope tileh_new)
4933{
4935 /* TODO: If you implement newgrf callback 149 'land slope check', you have to decide what to do with it here.
4936 * TTDP does not call it.
4937 */
4938 if (GetTileMaxZ(tile) == z_new + GetSlopeMaxZ(tileh_new)) {
4939 switch (GetStationType(tile)) {
4940 case StationType::RailWaypoint:
4941 case StationType::Rail: {
4942 if (!AutoslopeCheckForAxis(tile, z_new, tileh_new, GetRailStationAxis(tile))) break;
4943 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4944 }
4945
4946 case StationType::Airport:
4947 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4948
4949 case StationType::Truck:
4950 case StationType::Bus:
4951 case StationType::RoadWaypoint: {
4952 if (IsDriveThroughStopTile(tile)) {
4953 if (!AutoslopeCheckForAxis(tile, z_new, tileh_new, GetDriveThroughStopAxis(tile))) break;
4954 } else {
4955 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, GetBayRoadStopDir(tile))) break;
4956 }
4957 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4958 }
4959
4960 default: break;
4961 }
4962 }
4963 }
4964 return Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
4965}
4966
4973{
4974 uint32_t prev = 0;
4975 for (const auto &it : this->shares) {
4976 if (it.second == st) {
4977 return it.first - prev;
4978 } else {
4979 prev = it.first;
4980 }
4981 }
4982 return 0;
4983}
4984
4992{
4993 if (this->unrestricted == 0) return StationID::Invalid();
4994 assert(!this->shares.empty());
4995 SharesMap::const_iterator it = this->shares.upper_bound(RandomRange(this->unrestricted));
4996 assert(it != this->shares.end() && it->first <= this->unrestricted);
4997 if (it->second != excluded && it->second != excluded2) return it->second;
4998
4999 /* We've hit one of the excluded stations.
5000 * Draw another share, from outside its range. */
5001
5002 uint end = it->first;
5003 uint begin = (it == this->shares.begin() ? 0 : (--it)->first);
5004 uint interval = end - begin;
5005 if (interval >= this->unrestricted) return StationID::Invalid(); // Only one station in the map.
5006 uint new_max = this->unrestricted - interval;
5007 uint rand = RandomRange(new_max);
5008 SharesMap::const_iterator it2 = (rand < begin) ? this->shares.upper_bound(rand) :
5009 this->shares.upper_bound(rand + interval);
5010 assert(it2 != this->shares.end() && it2->first <= this->unrestricted);
5011 if (it2->second != excluded && it2->second != excluded2) return it2->second;
5012
5013 /* We've hit the second excluded station.
5014 * Same as before, only a bit more complicated. */
5015
5016 uint end2 = it2->first;
5017 uint begin2 = (it2 == this->shares.begin() ? 0 : (--it2)->first);
5018 uint interval2 = end2 - begin2;
5019 if (interval2 >= new_max) return StationID::Invalid(); // Only the two excluded stations in the map.
5020 new_max -= interval2;
5021 if (begin > begin2) {
5022 std::swap(begin, begin2);
5023 std::swap(end, end2);
5024 std::swap(interval, interval2);
5025 }
5026 rand = RandomRange(new_max);
5027 SharesMap::const_iterator it3 = this->shares.upper_bound(this->unrestricted);
5028 if (rand < begin) {
5029 it3 = this->shares.upper_bound(rand);
5030 } else if (rand < begin2 - interval) {
5031 it3 = this->shares.upper_bound(rand + interval);
5032 } else {
5033 it3 = this->shares.upper_bound(rand + interval + interval2);
5034 }
5035 assert(it3 != this->shares.end() && it3->first <= this->unrestricted);
5036 return it3->second;
5037}
5038
5045{
5046 assert(!this->shares.empty());
5047 SharesMap new_shares;
5048 uint i = 0;
5049 for (const auto &it : this->shares) {
5050 new_shares[++i] = it.second;
5051 if (it.first == this->unrestricted) this->unrestricted = i;
5052 }
5053 this->shares.swap(new_shares);
5054 assert(!this->shares.empty() && this->unrestricted <= (--this->shares.end())->first);
5055}
5056
5064{
5065 /* We assert only before changing as afterwards the shares can actually
5066 * be empty. In that case the whole flow stat must be deleted then. */
5067 assert(!this->shares.empty());
5068
5069 uint removed_shares = 0;
5070 uint added_shares = 0;
5071 uint last_share = 0;
5072 SharesMap new_shares;
5073 for (const auto &it : this->shares) {
5074 if (it.second == st) {
5075 if (flow < 0) {
5076 uint share = it.first - last_share;
5077 if (flow == INT_MIN || (uint)(-flow) >= share) {
5078 removed_shares += share;
5079 if (it.first <= this->unrestricted) this->unrestricted -= share;
5080 if (flow != INT_MIN) flow += share;
5081 last_share = it.first;
5082 continue; // remove the whole share
5083 }
5084 removed_shares += (uint)(-flow);
5085 } else {
5086 added_shares += (uint)(flow);
5087 }
5088 if (it.first <= this->unrestricted) this->unrestricted += flow;
5089
5090 /* If we don't continue above the whole flow has been added or
5091 * removed. */
5092 flow = 0;
5093 }
5094 new_shares[it.first + added_shares - removed_shares] = it.second;
5095 last_share = it.first;
5096 }
5097 if (flow > 0) {
5098 new_shares[last_share + (uint)flow] = st;
5099 if (this->unrestricted < last_share) {
5100 this->ReleaseShare(st);
5101 } else {
5102 this->unrestricted += flow;
5103 }
5104 }
5105 this->shares.swap(new_shares);
5106}
5107
5114{
5115 assert(!this->shares.empty());
5116 uint flow = 0;
5117 uint last_share = 0;
5118 SharesMap new_shares;
5119 for (auto &it : this->shares) {
5120 if (flow == 0) {
5121 if (it.first > this->unrestricted) return; // Not present or already restricted.
5122 if (it.second == st) {
5123 flow = it.first - last_share;
5124 this->unrestricted -= flow;
5125 } else {
5126 new_shares[it.first] = it.second;
5127 }
5128 } else {
5129 new_shares[it.first - flow] = it.second;
5130 }
5131 last_share = it.first;
5132 }
5133 if (flow == 0) return;
5134 new_shares[last_share + flow] = st;
5135 this->shares.swap(new_shares);
5136 assert(!this->shares.empty());
5137}
5138
5145{
5146 assert(!this->shares.empty());
5147 uint flow = 0;
5148 uint next_share = 0;
5149 bool found = false;
5150 for (SharesMap::reverse_iterator it(this->shares.rbegin()); it != this->shares.rend(); ++it) {
5151 if (it->first < this->unrestricted) return; // Note: not <= as the share may hit the limit.
5152 if (found) {
5153 flow = next_share - it->first;
5154 this->unrestricted += flow;
5155 break;
5156 } else {
5157 if (it->first == this->unrestricted) return; // !found -> Limit not hit.
5158 if (it->second == st) found = true;
5159 }
5160 next_share = it->first;
5161 }
5162 if (flow == 0) return;
5163 SharesMap new_shares;
5164 new_shares[flow] = st;
5165 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
5166 if (it->second != st) {
5167 new_shares[flow + it->first] = it->second;
5168 } else {
5169 flow = 0;
5170 }
5171 }
5172 this->shares.swap(new_shares);
5173 assert(!this->shares.empty());
5174}
5175
5182{
5183 assert(runtime > 0);
5184 SharesMap new_shares;
5185 uint share = 0;
5186 for (auto i : this->shares) {
5187 share = std::max(share + 1, i.first * 30 / runtime);
5188 new_shares[share] = i.second;
5189 if (this->unrestricted == i.first) this->unrestricted = share;
5190 }
5191 this->shares.swap(new_shares);
5192}
5193
5200void FlowStatMap::AddFlow(StationID origin, StationID via, uint flow)
5201{
5202 FlowStatMap::iterator origin_it = this->find(origin);
5203 if (origin_it == this->end()) {
5204 this->emplace(origin, FlowStat(via, flow));
5205 } else {
5206 origin_it->second.ChangeShare(via, flow);
5207 assert(!origin_it->second.GetShares()->empty());
5208 }
5209}
5210
5219void FlowStatMap::PassOnFlow(StationID origin, StationID via, uint flow)
5220{
5221 FlowStatMap::iterator prev_it = this->find(origin);
5222 if (prev_it == this->end()) {
5223 FlowStat fs(via, flow);
5224 fs.AppendShare(StationID::Invalid(), flow);
5225 this->emplace(origin, fs);
5226 } else {
5227 prev_it->second.ChangeShare(via, flow);
5228 prev_it->second.ChangeShare(StationID::Invalid(), flow);
5229 assert(!prev_it->second.GetShares()->empty());
5230 }
5231}
5232
5238{
5239 for (auto &i : *this) {
5240 FlowStat &fs = i.second;
5241 uint local = fs.GetShare(StationID::Invalid());
5242 if (local > INT_MAX) { // make sure it fits in an int
5243 fs.ChangeShare(self, -INT_MAX);
5244 fs.ChangeShare(StationID::Invalid(), -INT_MAX);
5245 local -= INT_MAX;
5246 }
5247 fs.ChangeShare(self, -(int)local);
5248 fs.ChangeShare(StationID::Invalid(), -(int)local);
5249
5250 /* If the local share is used up there must be a share for some
5251 * remote station. */
5252 assert(!fs.GetShares()->empty());
5253 }
5254}
5255
5262std::vector<StationID> FlowStatMap::DeleteFlows(StationID via)
5263{
5264 std::vector<StationID> ret;
5265 for (FlowStatMap::iterator f_it = this->begin(); f_it != this->end();) {
5266 FlowStat &s_flows = f_it->second;
5267 s_flows.ChangeShare(via, INT_MIN);
5268 if (s_flows.GetShares()->empty()) {
5269 ret.push_back(f_it->first);
5270 this->erase(f_it++);
5271 } else {
5272 ++f_it;
5273 }
5274 }
5275 return ret;
5276}
5277
5283{
5284 for (auto &it : *this) {
5285 it.second.RestrictShare(via);
5286 }
5287}
5288
5294{
5295 for (auto &it : *this) {
5296 it.second.ReleaseShare(via);
5297 }
5298}
5299
5305{
5306 uint ret = 0;
5307 for (const auto &it : *this) {
5308 ret += (--(it.second.GetShares()->end()))->first;
5309 }
5310 return ret;
5311}
5312
5319{
5320 uint ret = 0;
5321 for (const auto &it : *this) {
5322 ret += it.second.GetShare(via);
5323 }
5324 return ret;
5325}
5326
5333{
5334 FlowStatMap::const_iterator i = this->find(from);
5335 if (i == this->end()) return 0;
5336 return (--(i->second.GetShares()->end()))->first;
5337}
5338
5346{
5347 FlowStatMap::const_iterator i = this->find(from);
5348 if (i == this->end()) return 0;
5349 return i->second.GetShare(via);
5350}
5351
5352static CommandCost CheckBuildAbove_Station(TileIndex tile, DoCommandFlags, Axis, int height)
5353{
5354 StationType type = GetStationType(tile);
5355 auto bridgeable_info = GetStationBridgeableTileInfo(type);
5356
5357 switch (type) {
5358 case StationType::Rail:
5359 case StationType::RailWaypoint:
5360 if (const StationSpec *spec = GetStationSpec(tile); spec != nullptr) bridgeable_info = spec->bridgeable_info;
5361 break;
5362
5363 case StationType::Bus:
5364 case StationType::Truck:
5365 case StationType::RoadWaypoint:
5366 if (const RoadStopSpec *spec = GetRoadStopSpec(tile); spec != nullptr) bridgeable_info = spec->bridgeable_info;
5367 break;
5368
5369 default: break;
5370 }
5371
5372 return IsStationBridgeAboveOk(tile, bridgeable_info, type, GetStationGfx(tile), height);
5373}
5374
5375extern const TileTypeProcs _tile_type_station_procs = {
5376 DrawTile_Station, // draw_tile_proc
5377 GetSlopePixelZ_Station, // get_slope_z_proc
5378 ClearTile_Station, // clear_tile_proc
5379 nullptr, // add_accepted_cargo_proc
5380 GetTileDesc_Station, // get_tile_desc_proc
5381 GetTileTrackStatus_Station, // get_tile_track_status_proc
5382 ClickTile_Station, // click_tile_proc
5383 AnimateTile_Station, // animate_tile_proc
5384 TileLoop_Station, // tile_loop_proc
5385 ChangeTileOwner_Station, // change_tile_owner_proc
5386 nullptr, // add_produced_cargo_proc
5387 VehicleEnter_Station, // vehicle_enter_tile_proc
5388 GetFoundation_Station, // get_foundation_proc
5389 TerraformTile_Station, // terraform_tile_proc
5390 CheckBuildAbove_Station, // check_build_above_proc
5391};
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:186
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.
@ FLYING
Vehicle is flying in the air.
Definition airport.h:77
@ 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
constexpr bool HasExactlyOneBit(T value)
Test whether value has exactly 1 bit set.
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 uint CountBits(T value)
Counts the number of set bits in a variable.
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
uint8_t CargoType
Cargo slots to indicate a cargo type within a game.
Definition cargo_type.h:21
bool IsValidCargoType(CargoType cargo)
Test whether cargo type is not INVALID_CARGO.
Definition cargo_type.h:104
static const CargoType NUM_CARGO
Maximum number of cargo types in a game.
Definition cargo_type.h:73
@ Mail
Mail.
@ Liquid
Liquids (Oil, Water, Rubber)
@ Passengers
Passengers.
bool IsCargoInClass(CargoType cargo, CargoClasses cc)
Does cargo c have cargo class cc?
Definition cargotype.h:236
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.
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 Timpl & Reset()
Reset all bits.
constexpr Timpl & Flip(Tvalue_type value)
Flip the value-th bit.
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.
const Tcont * Packets() const
Returns a pointer to the cargo packet list (so you can iterate over it etc).
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?
Enum-as-bit-set wrapper.
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.
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...
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:396
void Remove(const T &element)
Remove a single element from the tree, if it exists.
Definition kdtree.hpp:415
static LinkGraphSchedule instance
Static instance of LinkGraphSchedule.
void Queue(LinkGraph *lg)
Queue a link graph for execution.
void Dequeue(LinkGraph *lg)
Remove a link graph from the execution queue.
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:90
TimerGameEconomy::Date LastCompression() const
Get date of last compression.
Definition linkgraph.h:236
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:230
static const uint MIN_TIMEOUT_DISTANCE
Minimum effective distance for timeout calculation.
Definition linkgraph.h:170
static constexpr TimerGameEconomy::Date STALE_LINK_DEPOT_TIMEOUT
Number of days before deleting links served only by vehicles stopped in depot.
Definition linkgraph.h:173
static constexpr TimerGameEconomy::Date COMPRESSION_INTERVAL
Minimum number of days between subsequent compressions of a LG.
Definition linkgraph.h:176
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
size_t MapSize() const
Count the number of ranges with equal keys in this MultiMap.
Definition multimap.hpp:291
Struct containing information relating to NewGRF classes for stations and airports.
StringID name
Name of this class.
static NewGRFClass * Get(Tindex class_index)
Get a particular class.
uint GetSpecCount() const
Get the number of allocated specs within the class.
static uint GetClassCount()
Get the number of allocated classes.
const Tspec * GetSpec(uint index) const
Get a spec from the class at a given index.
uint position
Position within iterator.
const RailStationTileLayout & stl
Station tile layout being iterated.
uint length
Length of platforms.
uint platforms
Number 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:115
SpriteID single_x
single piece of rail in X direction, without ground
Definition rail.h:125
uint16_t max_speed
Maximum speed for vehicles travelling on this rail type.
Definition rail.h:220
StringID name
Name of this rail type.
Definition rail.h:165
uint8_t fallback_railtype
Original railtype number to use when drawing non-newgrf railtypes, or when drawing stations.
Definition rail.h:190
uint GetRailtypeSpriteOffset() const
Offset between the current railtype and normal rail.
Definition rail.h:286
struct RailTypeInfo::@22 strings
Strings associated with the rail type.
struct RailTypeInfo::@19 base_sprites
Struct containing the main sprites.
struct RoadTypeInfo::@25 strings
Strings associated with the rail type.
uint16_t max_speed
Maximum speed for vehicles travelling on this road type.
Definition road.h:116
StringID name
Name of this rail type.
Definition road.h:77
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.
uint AvailableCount() const
Returns sum of cargo still available for loading at the station.
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
Representation of an invalid date.
static Date date
Current date in days (day counter).
static TickCounter counter
Monotonic counter, in ticks, since start of game.
A sort-of mixin that implements 'at(pos)' and 'operator[](pos)' only for a specific type.
uint StoredCount() const
Returns sum of cargo on board the vehicle (ie not only reserved).
Iterate over all vehicles on a tile.
Functions related to clear (MP_CLEAR) land.
CommandCost CommandCostWithParam(StringID str, uint64_t value)
Return an error status, with string and parameter.
Definition command.cpp:417
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.
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.
Direction
Defines the 8 directions on the map.
@ DIR_N
North.
@ DIR_W
West.
@ DIR_E
East.
Axis
Allow incrementing of DiagDirDiff variables.
@ AXIS_X
The X axis.
DiagDirection
Enumeration for diagonal directions.
@ DIAGDIR_NE
Northeast, upper right on your monitor.
@ DIAGDIR_SE
Southeast.
@ DIAGDIR_END
Used for iterations.
@ DIAGDIR_BEGIN
Used for iterations.
@ INVALID_DIAGDIR
Flag for an invalid DiagDirection.
@ DIAGDIR_SW
Southwest.
static const uint ROAD_STOP_TRACKBIT_FACTOR
Multiplier for how many regular track bits a bay stop counts.
@ EXPENSES_CONSTRUCTION
Construction costs.
Price
Enumeration of all base prices for use with Prices.
void DrawRailCatenary(const TileInfo *ti)
Draws overhead wires and pylons for electric railways.
Definition elrail.cpp:550
header file for electrified rail specific functions
bool HasRailCatenaryDrawn(RailType rt)
Test if we should draw rail catenary.
Definition elrail_func.h:30
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23)
Definition enum_type.hpp:17
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:1028
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ Invalid
Pseudosprite or other unusable sprite, used only internally.
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:247
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
HouseZone
Definition house.h:55
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.
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.).
@ Random
Randomise borders.
Some typedefs for the main game.
@ Increase
Increase capacity.
@ DT_MANUAL
Manual distribution. No link graph calculations are run.
uint DistanceFromEdge(TileIndex tile)
Param the minimum distance to an edge.
Definition map.cpp:218
uint DistanceMax(TileIndex t0, TileIndex t1)
Gets the biggest distance component (x or y) between the two given tiles.
Definition map.cpp:190
TileIndex TileAddWrap(TileIndex tile, int addx, int addy)
This function checks if we add addx/addy to tile, if we do wrap around the edges.
Definition map.cpp:109
uint DistanceManhattan(TileIndex t0, TileIndex t1)
Gets the Manhattan distance between the two given tiles.
Definition map.cpp:158
TileIndexDiff ToTileIndexDiff(TileIndexDiffC tidc)
Return the offset between two tiles from a TileIndexDiffC struct.
Definition map_func.h:452
TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition map_func.h:401
TileIndexDiff TileOffsByAxis(Axis axis)
Convert an Axis to a TileIndexDiff.
Definition map_func.h:567
static TileIndex TileXY(uint x, uint y)
Returns the TileIndex of a coordinate.
Definition map_func.h:385
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:437
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:427
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:582
int32_t TileIndexDiff
An offset value between two tiles.
Definition map_type.h:23
constexpr 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.
Types related to the misc widgets.
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.
void ErrorUnknownCallbackResult(uint32_t grfid, uint16_t cbid, uint16_t cb_res)
Record that a NewGRF returned an unknown/invalid callback result.
bool Convert8bitBooleanCallback(const GRFFile *grffile, uint16_t cbid, uint16_t cb_res)
Converts a callback result into a boolean.
GRFConfig * GetGRFConfig(uint32_t grfid, uint32_t mask)
Retrieve a NewGRF from the current config by its grfid.
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, RailTypeSpriteGroup rtsg, TileContext context, uint *num_results)
Get the sprite to draw for the given tile.
NewGRF handling of rail types.
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.
RoadStopClassID
@ 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, RoadTypeSpriteGroup rtsg, TileContext context, uint *num_results)
Get the sprite to draw for the given tile.
NewGRF handling of road types.
uint32_t GetPlatformInfo(Axis axis, uint8_t tile, int platforms, int length, int x, int y, bool centred)
Evaluate a tile's position within a station, and return the result in a bit-stuffed format.
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.
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.
uint16_t GetStationLayoutKey(uint8_t platforms, uint8_t length)
Get the station layout key for a given station layout size.
StationClassID
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:900
@ Acceptance
A type of cargo is (no longer) accepted.
@ Small
Small news item. (Information window with text and viewport)
@ InColour
News item is shown in colour (otherwise it is shown in black & white).
Functions related to order backups.
Train * GetTrainForReservation(TileIndex tile, Track track)
Find the train which has reserved a specific path.
Definition pbs.cpp:331
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:90
Money RailBuildCost(RailType railtype)
Returns the cost of building the specified railtype.
Definition rail.h:428
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:376
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition rail.h:300
@ RTSG_GROUND
Main group of ground images.
Definition rail.h:43
@ RTSG_OVERLAY
Images for overlaying track.
Definition rail.h:42
RailTrackOffset
Offsets for sprites within an overlay/underlay set.
Definition rail.h:61
@ RTO_Y
Piece of rail in Y direction.
Definition rail.h:63
@ RTO_X
Piece of rail in X direction.
Definition rail.h:62
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
@ Barren
Nothing (dirt)
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.
Definition of link refreshing utility.
bool ValParamRoadType(RoadType roadtype)
Validate functions for rail building.
Definition road.cpp:164
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:230
const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition road.h:215
@ ROTSG_OVERLAY
Optional: Images for overlaying track.
Definition road.h:38
@ ROTSG_ROADSTOP
Required: Bay stop surface.
Definition road.h:47
@ ROTSG_GROUND
Required: Main group of ground images.
Definition road.h:39
Money RoadBuildCost(RoadType roadtype)
Returns the cost of building the specified roadtype.
Definition road.h:240
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:180
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:252
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:111
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:235
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:285
bool HasTileRoadType(Tile t, RoadTramType rtt)
Check if a tile has a road or a tram road type.
Definition road_map.h:195
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:620
RoadBits GetAllRoadBits(Tile tile)
Get all set RoadBits on the given tile.
Definition road_map.h:125
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:218
Roadside
The possible road side decorations.
Definition road_map.h:457
@ Paved
Road with paved sidewalks.
@ Barren
Road on barren land.
@ Grass
Road on grass.
RoadBits
Enumeration for the road parts on a tile.
Definition road_type.h:56
@ ROAD_NONE
No road-part is build.
Definition road_type.h:57
@ ROAD_Y
Full road along the y-axis (north-west + south-east)
Definition road_type.h:63
@ ROAD_X
Full road along the x-axis (south-west + north-east)
Definition road_type.h:62
RoadTramType
The different types of road type.
Definition road_type.h:37
@ RTT_ROAD
Road road type.
Definition road_type.h:38
@ RTT_TRAM
Tram road type.
Definition road_type.h:39
RoadType
The different roadtypes we support.
Definition road_type.h:23
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
@ DRD_NONE
None of the directions are disallowed.
Definition road_type.h:78
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:617
void AddTrackToSignalBuffer(TileIndex tile, Track track, Owner owner)
Add track to signal update buffer.
Definition signal.cpp:589
@ Enter
signal entering the block found
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:160
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:369
DiagDirection GetInclinedSlopeDirection(Slope s)
Returns the direction of an inclined slope.
Definition slope_func.h:239
Slope
Enumeration for the slope-type.
Definition slope_type.h:48
@ SLOPE_FLAT
a flat tile
Definition slope_type.h:49
Foundation
Enumeration for Foundations.
Definition slope_type.h:93
@ FOUNDATION_LEVELED
The tile is leveled up to a flat slope.
Definition slope_type.h:95
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:105
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:95
PaletteID GroundSpritePaletteTransform(SpriteID image, PaletteID pal, PaletteID default_pal)
Applies PALETTE_MODIFIER_COLOUR to a palette entry of a ground sprite.
Definition sprite.h:174
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition sprites.h:1619
static constexpr uint8_t SPRITE_MODIFIER_CUSTOM_SPRITE
these masks change the colours of the palette for a sprite.
Definition sprites.h:1559
static constexpr uint8_t SPRITE_WIDTH
number of bits for the sprite number
Definition sprites.h:1549
static constexpr uint8_t PALETTE_MODIFIER_COLOUR
this bit is set when a recolouring process is in action
Definition sprites.h:1562
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 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.
static const IntervalTimer< TimerGameEconomy > _economy_stations_monthly({TimerGameEconomy::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.
CargoTypes GetEmptyMask(const Station *st)
Get a mask of the cargo types that are empty at the station.
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.
CargoArray GetAcceptanceAroundTiles(TileIndex center_tile, int w, int h, int rad, CargoTypes *always_accepted)
Get the acceptance of cargoes around the tile in 1/8.
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)
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.
static CommandCost RemoveAirport(TileIndex tile, DoCommandFlags flags)
Remove an airport.
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.
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.
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.
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.
CommandCost ClearTile_Station(TileIndex tile, DoCommandFlags flags)
Clear a single tile of a station.
static void UpdateStationRating(Station *st)
Periodic update of a station's rating.
void UpdateAllStationVirtCoords()
Update the virtual coords needed to draw the station sign for all stations.
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 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 void FreeTrainReservation(Train *v)
Clear platform reservation during station building/removing.
void SetRailStationTileFlags(TileIndex tile, const StationSpec *statspec)
Set rail station tile flags for the given tile.
static CargoArray GetAcceptanceAroundStation(const Station *st, CargoTypes *always_accepted)
Get the acceptance of cargoes around the station in.
static CommandCost RemoveDock(TileIndex tile, DoCommandFlags flags)
Remove a dock.
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.
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.
CommandCost CalculateRoadStopCost(TileArea tile_area, DoCommandFlags flags, bool is_drive_through, StationType station_type, const RoadStopSpec *roadstopspec, Axis axis, DiagDirection ddir, StationID *est, RoadType rt, Money unit_cost)
Calculates cost of new road stops within the area.
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.
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? In other words, is this station tile a rail station or rail waypoint?
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? In other words, is this station tile a rail station or rail waypoint?
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.
@ 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.
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:349
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:72
@ Airplanes
Can planes land on this airport type?
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)".
AnimationInfo< AirportAnimationTriggers > animation
Information about the animation.
static const AirportTileSpec * GetByTile(TileIndex tile)
Retrieve airport tile spec for the given airport tile.
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.
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:111
Container for cargo from the same location and time.
Definition cargopacket.h:41
Specification of a cargo type.
Definition cargotype.h:74
CargoClasses classes
Classes of this cargo type.
Definition cargotype.h:81
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo type.
Definition cargotype.h:137
CargoType Index() const
Determines index of this cargospec.
Definition cargotype.h:108
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition cargotype.h:192
bool value
tells if the bool cheat is active or not
Definition cheat_type.h:18
Cheat station_rating
Fix station ratings at 100%.
Definition cheat_type.h:35
GUISettings gui
settings related to the GUI
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.
bool build_on_slopes
allow building on slopes
bool road_stop_on_town_road
allow building of drive-through road stops on town owned roads
bool road_stop_on_competitor_road
allow building of drive-through road stops on roads owned by competitors
T y
Y coordinate.
T x
X coordinate.
T z
Z coordinate.
uint8_t town_council_tolerance
minimum required town ratings to be allowed to demolish stuff
Ground palette sprite of a tile, together with its sprite layout.
Definition sprite.h:67
Ground palette sprite of a tile, together with its sprite layout.
Definition sprite.h:52
PalSpriteID ground
Palette and sprite for the ground.
Definition sprite.h:53
bool station_noise_level
build new airports when the town noise level is still within accepted limits
Information about GRF, used in the game and (part of it) in savegames.
std::string GetName() const
Get the name of this grf.
const struct GRFFile * grffile
grf file that introduced this entity
uint32_t grfid
grfid that introduced this entity.
bool HasGrfFile() const
Test if this entity was introduced by NewGRF.
bool show_track_reservation
highlight reserved tracks.
LandscapeType landscape
the landscape we're currently in
EconomySettings economy
settings to change the economy
ConstructionSettings construction
construction of things in-game
DifficultySettings difficulty
settings related to the difficulty
GameCreationSettings game_creation
settings used during the creation of a game (map)
StationSettings station
settings related to station management
LinkGraphSettings linkgraph
settings for link graph calculations
OrderSettings order
settings related to orders
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.
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:62
IndustryType type
type of industry.
Definition industry.h:115
ProducedCargoes produced
produced cargo slots
Definition industry.h:110
Owner owner
owner of the industry. Which SHOULD always be (imho) OWNER_NONE
Definition industry.h:116
static Industry * GetByTile(TileIndex tile)
Get the industry of the given tile.
Definition industry.h:251
TileArea location
Location of the industry.
Definition industry.h:106
Station * neutral_station
Associated neutral station.
Definition industry.h:108
StationList stations_near
NOSAVE: List of nearby stations.
Definition industry.h:123
An edge in the link graph.
Definition linkgraph.h:42
static uint SizeX()
Get the size of the map along the X.
Definition map_func.h:272
static uint SizeY()
Get the size of the map along the Y.
Definition map_func.h:281
static uint Size()
Get the size of the map.
Definition map_func.h:290
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:274
bool selectgoods
only send the goods to station if a train has been there
bool IsType(OrderType type) const
Check whether this order is of the given type.
Definition order_base.h:66
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...
Represents the covered area of e.g.
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< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
static Titem * Get(auto index)
Returns Titem with given index.
static size_t GetNumItems()
Returns number of valid items in the pool.
Tindex index
Index of this pool item.
static bool CanAllocateItem(size_t n=1)
Helper functions so we can use PoolItem::Function() instead of _poolitem_pool.Function()
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
static Titem * GetIfValid(auto index)
Returns Titem with given 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:98
uint8_t state
Definition roadveh.h:100
Iterable ensemble of each set bit in a value.
All ships have this type.
Definition ship.h:32
A location from where cargo can come from (or go to).
Definition source_type.h:32
static bool IsValidID(auto index)
Tests whether given index is a valid index for station of this type.
static bool IsExpected(const BaseStation *st)
Helper for checking whether the given station is of this type.
static Pool::IterateWrapper< Station > Iterate(size_t from=0)
Returns an iterable ensemble of all valid stations of type T.
static Station * Get(auto index)
Gets station with given index.
static Station * GetIfValid(auto index)
Returns station if the index is a valid index for this station type.
static Station * From(BaseStation *st)
Converts a BaseStation to SpecializedStation with type checking.
static T * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
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.
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.
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:564
uint8_t station_spread
amount a station may spread
bool serve_neutral_industries
company stations can serve industries with attached neutral stations
bool distant_join_stations
allow to join non-adjacent 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::unordered_map< uint16_t, std::vector< uint8_t > > layouts
Custom platform layouts, keyed by platform and length combined.
std::vector< TileFlags > tileflags
List of tile flags.
std::vector< NewGRFSpriteLayout > renderdata
Number of tile layouts.
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:466
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:230
Tile description for the 'land area information' tool.
Definition tile_cmd.h:36
uint16_t rail_speed
Speed limit of rail (bridges and track)
Definition tile_cmd.h:49
std::optional< std::string > grf
newGRF used for the tile contents
Definition tile_cmd.h:47
StringID station_name
Type of station within the class.
Definition tile_cmd.h:43
StringID str
Description of the tile.
Definition tile_cmd.h:37
TimerGameCalendar::Date build_date
Date of construction of tile contents.
Definition tile_cmd.h:41
std::array< Owner, 4 > owner
Name of the owner(s)
Definition tile_cmd.h:39
StringID airport_class
Name of the airport class.
Definition tile_cmd.h:44
StringID airport_name
Name of the airport.
Definition tile_cmd.h:45
uint16_t tram_speed
Speed limit of tram (bridges and track)
Definition tile_cmd.h:53
StringID roadtype
Type of road on the tile.
Definition tile_cmd.h:50
StringID tramtype
Type of tram on the tile.
Definition tile_cmd.h:52
StringID railtype
Type of rail on the tile.
Definition tile_cmd.h:48
uint16_t road_speed
Speed limit of road (bridges and track)
Definition tile_cmd.h:51
std::array< StringID, 4 > owner_type
Type of each owner.
Definition tile_cmd.h:40
StringID airport_tile_name
Name of the airport tile.
Definition tile_cmd.h:46
StringID station_class
Class of station.
Definition tile_cmd.h:42
A pair-construct of a TileIndexDiff.
Definition map_type.h:31
Tile information, used while rendering the tile.
Definition tile_cmd.h:30
Slope tileh
Slope of the tile.
Definition tile_cmd.h:31
TileIndex tile
Tile index.
Definition tile_cmd.h:32
Set of callback functions for performing tile operations of a given tile type.
Definition tile_cmd.h:152
Town data structure.
Definition town.h:63
CompanyMask statues
which companies have a statue?
Definition town.h:79
TileIndex xy
town center tile
Definition town.h:64
uint16_t noise_reached
level of noise that all the airports are generating
Definition town.h:77
uint16_t MaxTownNoise() const
Calculate the max town noise.
Definition town.h:174
CompanyID exclusivity
which company has exclusivity
Definition town.h:84
uint8_t exclusive_counter
months till the exclusivity expires
Definition town.h:85
void UpdatePosition(int center, int top, std::string_view str, std::string_view str_small={})
Update the position of the viewport sign.
bool kdtree_valid
Are the sign data valid for use with the _viewport_sign_kdtree?
'Train' is either a loco or a wagon.
Definition train.h:91
Trackdir GetVehicleTrackdir() const override
Get the tracks of the train vehicle.
Vehicle data structure.
Direction direction
facing
bool IsStoppedInDepot() const
Check whether the vehicle is in the depot and stopped.
VehicleCargoList cargo
The cargo this vehicle is carrying.
TimerGameEconomy::Date date_of_last_service
Last economy date the vehicle had a service at a depot.
VehStates vehstatus
Status.
CargoType cargo_type
type of cargo this vehicle is carrying
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.
uint16_t refit_cap
Capacity left over from before last refit.
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.
@ EnteredStation
The vehicle entered a station.
@ CannotEnter
The vehicle cannot enter the tile.
bool IsTileFlat(TileIndex tile, int *h)
Check if a given tile is flat.
Definition tile_map.cpp:95
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:136
int GetTileZ(TileIndex tile)
Get bottom height of the tile.
Definition tile_map.cpp:116
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
@ TROPICZONE_DESERT
Tile is desert.
Definition tile_type.h:78
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
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:87
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
@ MP_TREES
Tile got trees.
Definition tile_type.h:52
@ MP_ROAD
A tile with road (or tram tracks)
Definition tile_type.h:50
@ MP_STATION
A tile of a station.
Definition tile_type.h:53
@ MP_HOUSE
A house by a town.
Definition tile_type.h:51
@ MP_WATER
Water tile.
Definition tile_type.h:54
@ MP_INDUSTRY
Part of an industry.
Definition tile_type.h:56
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,...
TrackBits TrackToTrackBits(Track track)
Maps a Track to the corresponding TrackBits value.
Definition track_func.h:77
TrackdirBits TrackBitsToTrackdirBits(TrackBits bits)
Converts TrackBits to TrackdirBits while allowing both directions.
Definition track_func.h:319
bool IsReversingRoadTrackdir(Trackdir dir)
Checks whether the trackdir means that we are reversing.
Definition track_func.h:673
Trackdir ReverseTrackdir(Trackdir trackdir)
Maps a trackdir to the reverse trackdir.
Definition track_func.h:247
TrackStatus CombineTrackStatus(TrackdirBits trackdirbits, TrackdirBits red_signals)
Builds a TrackStatus.
Definition track_func.h:388
TrackBits AxisToTrackBits(Axis a)
Maps an Axis to the corresponding TrackBits value.
Definition track_func.h:88
TrackBits DiagDirToDiagTrackBits(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track bits incidating with that diagdir.
Definition track_func.h:524
Track AxisToTrack(Axis a)
Convert an Axis to the corresponding Track AXIS_X -> TRACK_X AXIS_Y -> TRACK_Y Uses the fact that the...
Definition track_func.h:66
Track RemoveFirstTrack(TrackBits *tracks)
Removes first Track from TrackBits and returns it.
Definition track_func.h:131
DiagDirection TrackdirToExitdir(Trackdir trackdir)
Maps a trackdir to the (4-way) direction the tile is exited when following that trackdir.
Definition track_func.h:439
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
@ TRACK_BIT_UPPER
Upper track.
Definition track_type.h:39
@ TRACK_BIT_LEFT
Left track.
Definition track_type.h:41
@ TRACK_BIT_Y
Y-axis track.
Definition track_type.h:38
@ TRACK_BIT_NONE
No track.
Definition track_type.h:36
@ TRACK_BIT_X
X-axis track.
Definition track_type.h:37
@ TRACK_BIT_ALL
All possible tracks.
Definition track_type.h:50
@ TRACK_BIT_RIGHT
Right track.
Definition track_type.h:42
Trackdir
Enumeration for tracks and directions.
Definition track_type.h:66
@ TRACKDIR_BIT_NONE
No track build.
Definition track_type.h:98
Track
These are used to specify a single track.
Definition track_type.h:19
@ TRACK_Y
Track along the y-axis (north-west to south-east)
Definition track_type.h:22
@ TRACK_X
Track along the x-axis (north-east to south-west)
Definition track_type.h:21
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.
void FreeTrainTrackReservation(const Train *v)
Free the reserved path in front of a vehicle.
int GetTrainStopLocation(StationID station_id, TileIndex tile, const Train *v, 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.
@ TO_BUILDINGS
company buildings - depots, stations, HQ, ...
TransportType
Available types of transport.
@ TRANSPORT_RAIL
Transport by train.
@ TRANSPORT_ROAD
Transport by road vehicle.
@ TRANSPORT_WATER
Transport over water.
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:527
@ TrainSlowing
Train is slowing down.
Functions related to vehicles.
@ VEH_INVALID
Non-existing type of vehicle.
@ VEH_ROAD
Road vehicle type.
@ VEH_AIRCRAFT
Aircraft vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_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:591
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:764
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:663
void EndSpriteCombine()
Terminates a block of sprites started by StartSpriteCombine.
Definition viewport.cpp:774
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.
Functions related to water (management)
void TileLoop_Water(TileIndex tile)
Let a water tile floods its diagonal adjoining tiles called from tunnelbridge_cmd,...
void CheckForDockingTile(TileIndex t)
Mark the supplied tile as a docking tile if it is suitable for docking.
bool HasTileWaterGround(Tile t)
Checks whether the tile has water at the ground.
Definition water_map.h:352
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).
@ Canal
Canal.
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:373
void SetDockingTile(Tile t, bool b)
Set the docking tile state of a tile.
Definition water_map.h:363
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:1193
void SetWindowClassesDirty(WindowClass cls)
Mark all windows of a particular class as dirty (in need of repainting)
Definition window.cpp:3202
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:3294
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:3189
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition window.cpp:3176
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:3311
@ WC_STATION_LIST
Station list; Window numbers:
@ WC_VEHICLE_ORDERS
Vehicle orders; Window numbers:
@ WC_VEHICLE_DEPOT
Depot view; Window numbers:
@ WC_SELECT_STATION
Select station (when joining stations); Window numbers:
@ WC_STATION_VIEW
Station view; Window numbers:
@ WC_TOWN_VIEW
Town view; Window numbers:
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.