Add: INR currency (#8136)
[openttd-github.git] / src / station_cmd.cpp
blobb8838388418b7b4ac510ea37f4776c947bec45e9
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 <http://www.gnu.org/licenses/>.
6 */
8 /** @file station_cmd.cpp Handling of station tiles. */
10 #include "stdafx.h"
11 #include "aircraft.h"
12 #include "bridge_map.h"
13 #include "cmd_helper.h"
14 #include "viewport_func.h"
15 #include "viewport_kdtree.h"
16 #include "command_func.h"
17 #include "town.h"
18 #include "news_func.h"
19 #include "train.h"
20 #include "ship.h"
21 #include "roadveh.h"
22 #include "industry.h"
23 #include "newgrf_cargo.h"
24 #include "newgrf_debug.h"
25 #include "newgrf_station.h"
26 #include "newgrf_canal.h" /* For the buoy */
27 #include "pathfinder/yapf/yapf_cache.h"
28 #include "road_internal.h" /* For drawing catenary/checking road removal */
29 #include "autoslope.h"
30 #include "water.h"
31 #include "strings_func.h"
32 #include "clear_func.h"
33 #include "date_func.h"
34 #include "vehicle_func.h"
35 #include "string_func.h"
36 #include "animated_tile_func.h"
37 #include "elrail_func.h"
38 #include "station_base.h"
39 #include "station_kdtree.h"
40 #include "roadstop_base.h"
41 #include "newgrf_railtype.h"
42 #include "newgrf_roadtype.h"
43 #include "waypoint_base.h"
44 #include "waypoint_func.h"
45 #include "pbs.h"
46 #include "debug.h"
47 #include "core/random_func.hpp"
48 #include "company_base.h"
49 #include "table/airporttile_ids.h"
50 #include "newgrf_airporttiles.h"
51 #include "order_backup.h"
52 #include "newgrf_house.h"
53 #include "company_gui.h"
54 #include "linkgraph/linkgraph_base.h"
55 #include "linkgraph/refresh.h"
56 #include "widgets/station_widget.h"
57 #include "tunnelbridge_map.h"
59 #include "table/strings.h"
61 #include "safeguards.h"
63 /**
64 * Static instance of FlowStat::SharesMap.
65 * Note: This instance is created on task start.
66 * Lazy creation on first usage results in a data race between the CDist threads.
68 /* static */ const FlowStat::SharesMap FlowStat::empty_sharesmap;
70 /**
71 * Check whether the given tile is a hangar.
72 * @param t the tile to of whether it is a hangar.
73 * @pre IsTileType(t, MP_STATION)
74 * @return true if and only if the tile is a hangar.
76 bool IsHangar(TileIndex t)
78 assert(IsTileType(t, MP_STATION));
80 /* If the tile isn't an airport there's no chance it's a hangar. */
81 if (!IsAirport(t)) return false;
83 const Station *st = Station::GetByTile(t);
84 const AirportSpec *as = st->airport.GetSpec();
86 for (uint i = 0; i < as->nof_depots; i++) {
87 if (st->airport.GetHangarTile(i) == t) return true;
90 return false;
93 /**
94 * Look for a station owned by the given company around the given tile area.
95 * @param ta the area to search over
96 * @param closest_station the closest owned station found so far
97 * @param company the company whose stations to look for
98 * @param st to 'return' the found station
99 * @return Succeeded command (if zero or one station found) or failed command (for two or more stations found).
101 template <class T>
102 CommandCost GetStationAround(TileArea ta, StationID closest_station, CompanyID company, T **st)
104 ta.Expand(1);
106 /* check around to see if there are any stations there owned by the company */
107 TILE_AREA_LOOP(tile_cur, ta) {
108 if (IsTileType(tile_cur, MP_STATION)) {
109 StationID t = GetStationIndex(tile_cur);
110 if (!T::IsValidID(t) || Station::Get(t)->owner != company) continue;
111 if (closest_station == INVALID_STATION) {
112 closest_station = t;
113 } else if (closest_station != t) {
114 return_cmd_error(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
118 *st = (closest_station == INVALID_STATION) ? nullptr : T::Get(closest_station);
119 return CommandCost();
123 * Function to check whether the given tile matches some criterion.
124 * @param tile the tile to check
125 * @return true if it matches, false otherwise
127 typedef bool (*CMSAMatcher)(TileIndex tile);
130 * Counts the numbers of tiles matching a specific type in the area around
131 * @param tile the center tile of the 'count area'
132 * @param cmp the comparator/matcher (@see CMSAMatcher)
133 * @return the number of matching tiles around
135 static int CountMapSquareAround(TileIndex tile, CMSAMatcher cmp)
137 int num = 0;
139 for (int dx = -3; dx <= 3; dx++) {
140 for (int dy = -3; dy <= 3; dy++) {
141 TileIndex t = TileAddWrap(tile, dx, dy);
142 if (t != INVALID_TILE && cmp(t)) num++;
146 return num;
150 * Check whether the tile is a mine.
151 * @param tile the tile to investigate.
152 * @return true if and only if the tile is a mine
154 static bool CMSAMine(TileIndex tile)
156 /* No industry */
157 if (!IsTileType(tile, MP_INDUSTRY)) return false;
159 const Industry *ind = Industry::GetByTile(tile);
161 /* No extractive industry */
162 if ((GetIndustrySpec(ind->type)->life_type & INDUSTRYLIFE_EXTRACTIVE) == 0) return false;
164 for (uint i = 0; i < lengthof(ind->produced_cargo); i++) {
165 /* The industry extracts something non-liquid, i.e. no oil or plastic, so it is a mine.
166 * Also the production of passengers and mail is ignored. */
167 if (ind->produced_cargo[i] != CT_INVALID &&
168 (CargoSpec::Get(ind->produced_cargo[i])->classes & (CC_LIQUID | CC_PASSENGERS | CC_MAIL)) == 0) {
169 return true;
173 return false;
177 * Check whether the tile is water.
178 * @param tile the tile to investigate.
179 * @return true if and only if the tile is a water tile
181 static bool CMSAWater(TileIndex tile)
183 return IsTileType(tile, MP_WATER) && IsWater(tile);
187 * Check whether the tile is a tree.
188 * @param tile the tile to investigate.
189 * @return true if and only if the tile is a tree tile
191 static bool CMSATree(TileIndex tile)
193 return IsTileType(tile, MP_TREES);
196 #define M(x) ((x) - STR_SV_STNAME)
198 enum StationNaming {
199 STATIONNAMING_RAIL,
200 STATIONNAMING_ROAD,
201 STATIONNAMING_AIRPORT,
202 STATIONNAMING_OILRIG,
203 STATIONNAMING_DOCK,
204 STATIONNAMING_HELIPORT,
207 /** Information to handle station action 0 property 24 correctly */
208 struct StationNameInformation {
209 uint32 free_names; ///< Current bitset of free names (we can remove names).
210 bool *indtypes; ///< Array of bools telling whether an industry type has been found.
214 * Find a station action 0 property 24 station name, or reduce the
215 * free_names if needed.
216 * @param tile the tile to search
217 * @param user_data the StationNameInformation to base the search on
218 * @return true if the tile contains an industry that has not given
219 * its name to one of the other stations in town.
221 static bool FindNearIndustryName(TileIndex tile, void *user_data)
223 /* All already found industry types */
224 StationNameInformation *sni = (StationNameInformation*)user_data;
225 if (!IsTileType(tile, MP_INDUSTRY)) return false;
227 /* If the station name is undefined it means that it doesn't name a station */
228 IndustryType indtype = GetIndustryType(tile);
229 if (GetIndustrySpec(indtype)->station_name == STR_UNDEFINED) return false;
231 /* In all cases if an industry that provides a name is found two of
232 * the standard names will be disabled. */
233 sni->free_names &= ~(1 << M(STR_SV_STNAME_OILFIELD) | 1 << M(STR_SV_STNAME_MINES));
234 return !sni->indtypes[indtype];
237 static StringID GenerateStationName(Station *st, TileIndex tile, StationNaming name_class)
239 static const uint32 _gen_station_name_bits[] = {
240 0, // STATIONNAMING_RAIL
241 0, // STATIONNAMING_ROAD
242 1U << M(STR_SV_STNAME_AIRPORT), // STATIONNAMING_AIRPORT
243 1U << M(STR_SV_STNAME_OILFIELD), // STATIONNAMING_OILRIG
244 1U << M(STR_SV_STNAME_DOCKS), // STATIONNAMING_DOCK
245 1U << M(STR_SV_STNAME_HELIPORT), // STATIONNAMING_HELIPORT
248 const Town *t = st->town;
249 uint32 free_names = UINT32_MAX;
251 bool indtypes[NUM_INDUSTRYTYPES];
252 memset(indtypes, 0, sizeof(indtypes));
254 for (const Station *s : Station::Iterate()) {
255 if (s != st && s->town == t) {
256 if (s->indtype != IT_INVALID) {
257 indtypes[s->indtype] = true;
258 StringID name = GetIndustrySpec(s->indtype)->station_name;
259 if (name != STR_UNDEFINED) {
260 /* Filter for other industrytypes with the same name */
261 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
262 const IndustrySpec *indsp = GetIndustrySpec(it);
263 if (indsp->enabled && indsp->station_name == name) indtypes[it] = true;
266 continue;
268 uint str = M(s->string_id);
269 if (str <= 0x20) {
270 if (str == M(STR_SV_STNAME_FOREST)) {
271 str = M(STR_SV_STNAME_WOODS);
273 ClrBit(free_names, str);
278 TileIndex indtile = tile;
279 StationNameInformation sni = { free_names, indtypes };
280 if (CircularTileSearch(&indtile, 7, FindNearIndustryName, &sni)) {
281 /* An industry has been found nearby */
282 IndustryType indtype = GetIndustryType(indtile);
283 const IndustrySpec *indsp = GetIndustrySpec(indtype);
284 /* STR_NULL means it only disables oil rig/mines */
285 if (indsp->station_name != STR_NULL) {
286 st->indtype = indtype;
287 return STR_SV_STNAME_FALLBACK;
291 /* Oil rigs/mines name could be marked not free by looking for a near by industry. */
292 free_names = sni.free_names;
294 /* check default names */
295 uint32 tmp = free_names & _gen_station_name_bits[name_class];
296 if (tmp != 0) return STR_SV_STNAME + FindFirstBit(tmp);
298 /* check mine? */
299 if (HasBit(free_names, M(STR_SV_STNAME_MINES))) {
300 if (CountMapSquareAround(tile, CMSAMine) >= 2) {
301 return STR_SV_STNAME_MINES;
305 /* check close enough to town to get central as name? */
306 if (DistanceMax(tile, t->xy) < 8) {
307 if (HasBit(free_names, M(STR_SV_STNAME))) return STR_SV_STNAME;
309 if (HasBit(free_names, M(STR_SV_STNAME_CENTRAL))) return STR_SV_STNAME_CENTRAL;
312 /* Check lakeside */
313 if (HasBit(free_names, M(STR_SV_STNAME_LAKESIDE)) &&
314 DistanceFromEdge(tile) < 20 &&
315 CountMapSquareAround(tile, CMSAWater) >= 5) {
316 return STR_SV_STNAME_LAKESIDE;
319 /* Check woods */
320 if (HasBit(free_names, M(STR_SV_STNAME_WOODS)) && (
321 CountMapSquareAround(tile, CMSATree) >= 8 ||
322 CountMapSquareAround(tile, IsTileForestIndustry) >= 2)
324 return _settings_game.game_creation.landscape == LT_TROPIC ? STR_SV_STNAME_FOREST : STR_SV_STNAME_WOODS;
327 /* check elevation compared to town */
328 int z = GetTileZ(tile);
329 int z2 = GetTileZ(t->xy);
330 if (z < z2) {
331 if (HasBit(free_names, M(STR_SV_STNAME_VALLEY))) return STR_SV_STNAME_VALLEY;
332 } else if (z > z2) {
333 if (HasBit(free_names, M(STR_SV_STNAME_HEIGHTS))) return STR_SV_STNAME_HEIGHTS;
336 /* check direction compared to town */
337 static const int8 _direction_and_table[] = {
338 ~( (1 << M(STR_SV_STNAME_WEST)) | (1 << M(STR_SV_STNAME_EAST)) | (1 << M(STR_SV_STNAME_NORTH)) ),
339 ~( (1 << M(STR_SV_STNAME_SOUTH)) | (1 << M(STR_SV_STNAME_WEST)) | (1 << M(STR_SV_STNAME_NORTH)) ),
340 ~( (1 << M(STR_SV_STNAME_SOUTH)) | (1 << M(STR_SV_STNAME_EAST)) | (1 << M(STR_SV_STNAME_NORTH)) ),
341 ~( (1 << M(STR_SV_STNAME_SOUTH)) | (1 << M(STR_SV_STNAME_WEST)) | (1 << M(STR_SV_STNAME_EAST)) ),
344 free_names &= _direction_and_table[
345 (TileX(tile) < TileX(t->xy)) +
346 (TileY(tile) < TileY(t->xy)) * 2];
348 tmp = free_names & ((1 << 1) | (1 << 2) | (1 << 3) | (1 << 4) | (1 << 6) | (1 << 7) | (1 << 12) | (1 << 26) | (1 << 27) | (1 << 28) | (1 << 29) | (1 << 30));
349 return (tmp == 0) ? STR_SV_STNAME_FALLBACK : (STR_SV_STNAME + FindFirstBit(tmp));
351 #undef M
354 * Find the closest deleted station of the current company
355 * @param tile the tile to search from.
356 * @return the closest station or nullptr if too far.
358 static Station *GetClosestDeletedStation(TileIndex tile)
360 uint threshold = 8;
362 Station *best_station = nullptr;
363 ForAllStationsRadius(tile, threshold, [&](Station *st) {
364 if (!st->IsInUse() && st->owner == _current_company) {
365 uint cur_dist = DistanceManhattan(tile, st->xy);
367 if (cur_dist < threshold) {
368 threshold = cur_dist;
369 best_station = st;
370 } else if (cur_dist == threshold && best_station != nullptr) {
371 /* In case of a tie, lowest station ID wins */
372 if (st->index < best_station->index) best_station = st;
377 return best_station;
381 void Station::GetTileArea(TileArea *ta, StationType type) const
383 switch (type) {
384 case STATION_RAIL:
385 *ta = this->train_station;
386 return;
388 case STATION_AIRPORT:
389 *ta = this->airport;
390 return;
392 case STATION_TRUCK:
393 *ta = this->truck_station;
394 return;
396 case STATION_BUS:
397 *ta = this->bus_station;
398 return;
400 case STATION_DOCK:
401 case STATION_OILRIG:
402 *ta = this->docking_station;
403 return;
405 default: NOT_REACHED();
410 * Update the virtual coords needed to draw the station sign.
412 void Station::UpdateVirtCoord()
414 Point pt = RemapCoords2(TileX(this->xy) * TILE_SIZE, TileY(this->xy) * TILE_SIZE);
416 pt.y -= 32 * ZOOM_LVL_BASE;
417 if ((this->facilities & FACIL_AIRPORT) && this->airport.type == AT_OILRIG) pt.y -= 16 * ZOOM_LVL_BASE;
419 if (this->sign.kdtree_valid) _viewport_sign_kdtree.Remove(ViewportSignKdtreeItem::MakeStation(this->index));
421 SetDParam(0, this->index);
422 SetDParam(1, this->facilities);
423 this->sign.UpdatePosition(pt.x, pt.y, STR_VIEWPORT_STATION);
425 _viewport_sign_kdtree.Insert(ViewportSignKdtreeItem::MakeStation(this->index));
427 SetWindowDirty(WC_STATION_VIEW, this->index);
431 * Move the station main coordinate somewhere else.
432 * @param new_xy new tile location of the sign
434 void Station::MoveSign(TileIndex new_xy)
436 if (this->xy == new_xy) return;
438 _station_kdtree.Remove(this->index);
440 this->BaseStation::MoveSign(new_xy);
442 _station_kdtree.Insert(this->index);
445 /** Update the virtual coords needed to draw the station sign for all stations. */
446 void UpdateAllStationVirtCoords()
448 for (BaseStation *st : BaseStation::Iterate()) {
449 st->UpdateVirtCoord();
453 void BaseStation::FillCachedName() const
455 char buf[MAX_LENGTH_STATION_NAME_CHARS * MAX_CHAR_LENGTH];
456 int64 args_array[] = { this->index };
457 StringParameters tmp_params(args_array);
458 char *end = GetStringWithArgs(buf, Waypoint::IsExpected(this) ? STR_WAYPOINT_NAME : STR_STATION_NAME, &tmp_params, lastof(buf));
459 this->cached_name.assign(buf, end);
462 void ClearAllStationCachedNames()
464 for (BaseStation *st : BaseStation::Iterate()) {
465 st->cached_name.clear();
470 * Get a mask of the cargo types that the station accepts.
471 * @param st Station to query
472 * @return the expected mask
474 static CargoTypes GetAcceptanceMask(const Station *st)
476 CargoTypes mask = 0;
478 for (CargoID i = 0; i < NUM_CARGO; i++) {
479 if (HasBit(st->goods[i].status, GoodsEntry::GES_ACCEPTANCE)) SetBit(mask, i);
481 return mask;
485 * Items contains the two cargo names that are to be accepted or rejected.
486 * msg is the string id of the message to display.
488 static void ShowRejectOrAcceptNews(const Station *st, uint num_items, CargoID *cargo, StringID msg)
490 for (uint i = 0; i < num_items; i++) {
491 SetDParam(i + 1, CargoSpec::Get(cargo[i])->name);
494 SetDParam(0, st->index);
495 AddNewsItem(msg, NT_ACCEPTANCE, NF_INCOLOUR | NF_SMALL, NR_STATION, st->index);
499 * Get the cargo types being produced around the tile (in a rectangle).
500 * @param tile Northtile of area
501 * @param w X extent of the area
502 * @param h Y extent of the area
503 * @param rad Search radius in addition to the given area
505 CargoArray GetProductionAroundTiles(TileIndex tile, int w, int h, int rad)
507 CargoArray produced;
508 std::set<IndustryID> industries;
509 TileArea ta = TileArea(tile, w, h).Expand(rad);
511 /* Loop over all tiles to get the produced cargo of
512 * everything except industries */
513 TILE_AREA_LOOP(tile, ta) {
514 if (IsTileType(tile, MP_INDUSTRY)) industries.insert(GetIndustryIndex(tile));
515 AddProducedCargo(tile, produced);
518 /* Loop over the seen industries. They produce cargo for
519 * anything that is within 'rad' of any one of their tiles.
521 for (IndustryID industry : industries) {
522 const Industry *i = Industry::Get(industry);
523 /* Skip industry with neutral station */
524 if (i->neutral_station != nullptr && !_settings_game.station.serve_neutral_industries) continue;
526 for (uint j = 0; j < lengthof(i->produced_cargo); j++) {
527 CargoID cargo = i->produced_cargo[j];
528 if (cargo != CT_INVALID) produced[cargo]++;
532 return produced;
536 * Get the acceptance of cargoes around the tile in 1/8.
537 * @param tile Center of the search area
538 * @param w X extent of area
539 * @param h Y extent of area
540 * @param rad Search radius in addition to given area
541 * @param always_accepted bitmask of cargo accepted by houses and headquarters; can be nullptr
542 * @param ind Industry associated with neutral station (e.g. oil rig) or nullptr
544 CargoArray GetAcceptanceAroundTiles(TileIndex tile, int w, int h, int rad, CargoTypes *always_accepted)
546 CargoArray acceptance;
547 if (always_accepted != nullptr) *always_accepted = 0;
549 TileArea ta = TileArea(tile, w, h).Expand(rad);
551 TILE_AREA_LOOP(tile, ta) {
552 /* Ignore industry if it has a neutral station. */
553 if (!_settings_game.station.serve_neutral_industries && IsTileType(tile, MP_INDUSTRY) && Industry::GetByTile(tile)->neutral_station != nullptr) continue;
555 AddAcceptedCargo(tile, acceptance, always_accepted);
558 return acceptance;
562 * Get the acceptance of cargoes around the station in.
563 * @param st Station to get acceptance of.
564 * @param always_accepted bitmask of cargo accepted by houses and headquarters; can be nullptr
566 static CargoArray GetAcceptanceAroundStation(const Station *st, CargoTypes *always_accepted)
568 CargoArray acceptance;
569 if (always_accepted != nullptr) *always_accepted = 0;
571 BitmapTileIterator it(st->catchment_tiles);
572 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
573 AddAcceptedCargo(tile, acceptance, always_accepted);
576 return acceptance;
580 * Update the acceptance for a station.
581 * @param st Station to update
582 * @param show_msg controls whether to display a message that acceptance was changed.
584 void UpdateStationAcceptance(Station *st, bool show_msg)
586 /* old accepted goods types */
587 CargoTypes old_acc = GetAcceptanceMask(st);
589 /* And retrieve the acceptance. */
590 CargoArray acceptance;
591 if (!st->rect.IsEmpty()) {
592 acceptance = GetAcceptanceAroundStation(st, &st->always_accepted);
595 /* Adjust in case our station only accepts fewer kinds of goods */
596 for (CargoID i = 0; i < NUM_CARGO; i++) {
597 uint amt = acceptance[i];
599 /* Make sure the station can accept the goods type. */
600 bool is_passengers = IsCargoInClass(i, CC_PASSENGERS);
601 if ((!is_passengers && !(st->facilities & ~FACIL_BUS_STOP)) ||
602 (is_passengers && !(st->facilities & ~FACIL_TRUCK_STOP))) {
603 amt = 0;
606 GoodsEntry &ge = st->goods[i];
607 SB(ge.status, GoodsEntry::GES_ACCEPTANCE, 1, amt >= 8);
608 if (LinkGraph::IsValidID(ge.link_graph)) {
609 (*LinkGraph::Get(ge.link_graph))[ge.node].SetDemand(amt / 8);
613 /* Only show a message in case the acceptance was actually changed. */
614 CargoTypes new_acc = GetAcceptanceMask(st);
615 if (old_acc == new_acc) return;
617 /* show a message to report that the acceptance was changed? */
618 if (show_msg && st->owner == _local_company && st->IsInUse()) {
619 /* List of accept and reject strings for different number of
620 * cargo types */
621 static const StringID accept_msg[] = {
622 STR_NEWS_STATION_NOW_ACCEPTS_CARGO,
623 STR_NEWS_STATION_NOW_ACCEPTS_CARGO_AND_CARGO,
625 static const StringID reject_msg[] = {
626 STR_NEWS_STATION_NO_LONGER_ACCEPTS_CARGO,
627 STR_NEWS_STATION_NO_LONGER_ACCEPTS_CARGO_OR_CARGO,
630 /* Array of accepted and rejected cargo types */
631 CargoID accepts[2] = { CT_INVALID, CT_INVALID };
632 CargoID rejects[2] = { CT_INVALID, CT_INVALID };
633 uint num_acc = 0;
634 uint num_rej = 0;
636 /* Test each cargo type to see if its acceptance has changed */
637 for (CargoID i = 0; i < NUM_CARGO; i++) {
638 if (HasBit(new_acc, i)) {
639 if (!HasBit(old_acc, i) && num_acc < lengthof(accepts)) {
640 /* New cargo is accepted */
641 accepts[num_acc++] = i;
643 } else {
644 if (HasBit(old_acc, i) && num_rej < lengthof(rejects)) {
645 /* Old cargo is no longer accepted */
646 rejects[num_rej++] = i;
651 /* Show news message if there are any changes */
652 if (num_acc > 0) ShowRejectOrAcceptNews(st, num_acc, accepts, accept_msg[num_acc - 1]);
653 if (num_rej > 0) ShowRejectOrAcceptNews(st, num_rej, rejects, reject_msg[num_rej - 1]);
656 /* redraw the station view since acceptance changed */
657 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_ACCEPT_RATING_LIST);
660 static void UpdateStationSignCoord(BaseStation *st)
662 const StationRect *r = &st->rect;
664 if (r->IsEmpty()) return; // no tiles belong to this station
666 /* clamp sign coord to be inside the station rect */
667 TileIndex new_xy = TileXY(ClampU(TileX(st->xy), r->left, r->right), ClampU(TileY(st->xy), r->top, r->bottom));
668 st->MoveSign(new_xy);
670 if (!Station::IsExpected(st)) return;
671 Station *full_station = Station::From(st);
672 for (CargoID c = 0; c < NUM_CARGO; ++c) {
673 LinkGraphID lg = full_station->goods[c].link_graph;
674 if (!LinkGraph::IsValidID(lg)) continue;
675 (*LinkGraph::Get(lg))[full_station->goods[c].node].UpdateLocation(st->xy);
680 * Common part of building various station parts and possibly attaching them to an existing one.
681 * @param[in,out] st Station to attach to
682 * @param flags Command flags
683 * @param reuse Whether to try to reuse a deleted station (gray sign) if possible
684 * @param area Area occupied by the new part
685 * @param name_class Station naming class to use to generate the new station's name
686 * @return Command error that occurred, if any
688 static CommandCost BuildStationPart(Station **st, DoCommandFlag flags, bool reuse, TileArea area, StationNaming name_class)
690 /* Find a deleted station close to us */
691 if (*st == nullptr && reuse) *st = GetClosestDeletedStation(area.tile);
693 if (*st != nullptr) {
694 if ((*st)->owner != _current_company) {
695 return_cmd_error(CMD_ERROR);
698 CommandCost ret = (*st)->rect.BeforeAddRect(area.tile, area.w, area.h, StationRect::ADD_TEST);
699 if (ret.Failed()) return ret;
700 } else {
701 /* allocate and initialize new station */
702 if (!Station::CanAllocateItem()) return_cmd_error(STR_ERROR_TOO_MANY_STATIONS_LOADING);
704 if (flags & DC_EXEC) {
705 *st = new Station(area.tile);
706 _station_kdtree.Insert((*st)->index);
708 (*st)->town = ClosestTownFromTile(area.tile, UINT_MAX);
709 (*st)->string_id = GenerateStationName(*st, area.tile, name_class);
711 if (Company::IsValidID(_current_company)) {
712 SetBit((*st)->town->have_ratings, _current_company);
716 return CommandCost();
720 * This is called right after a station was deleted.
721 * It checks if the whole station is free of substations, and if so, the station will be
722 * deleted after a little while.
723 * @param st Station
725 static void DeleteStationIfEmpty(BaseStation *st)
727 if (!st->IsInUse()) {
728 st->delete_ctr = 0;
729 InvalidateWindowData(WC_STATION_LIST, st->owner, 0);
731 /* station remains but it probably lost some parts - station sign should stay in the station boundaries */
732 UpdateStationSignCoord(st);
736 * After adding/removing tiles to station, update some station-related stuff.
737 * @param adding True if adding tiles, false if removing them.
738 * @param type StationType being modified.
740 void Station::AfterStationTileSetChange(bool adding, StationType type)
742 this->UpdateVirtCoord();
743 this->RecomputeCatchment();
744 DirtyCompanyInfrastructureWindows(this->owner);
745 if (adding) InvalidateWindowData(WC_STATION_LIST, this->owner, 0);
747 switch (type) {
748 case STATION_RAIL:
749 SetWindowWidgetDirty(WC_STATION_VIEW, this->index, WID_SV_TRAINS);
750 break;
751 case STATION_AIRPORT:
752 break;
753 case STATION_TRUCK:
754 case STATION_BUS:
755 SetWindowWidgetDirty(WC_STATION_VIEW, this->index, WID_SV_ROADVEHS);
756 break;
757 case STATION_DOCK:
758 SetWindowWidgetDirty(WC_STATION_VIEW, this->index, WID_SV_SHIPS);
759 break;
760 default: NOT_REACHED();
763 if (adding) {
764 UpdateStationAcceptance(this, false);
765 InvalidateWindowData(WC_SELECT_STATION, 0, 0);
766 } else {
767 DeleteStationIfEmpty(this);
772 CommandCost ClearTile_Station(TileIndex tile, DoCommandFlag flags);
775 * Checks if the given tile is buildable, flat and has a certain height.
776 * @param tile TileIndex to check.
777 * @param invalid_dirs Prohibited directions for slopes (set of #DiagDirection).
778 * @param allowed_z Height allowed for the tile. If allowed_z is negative, it will be set to the height of this tile.
779 * @param allow_steep Whether steep slopes are allowed.
780 * @param check_bridge Check for the existence of a bridge.
781 * @return The cost in case of success, or an error code if it failed.
783 CommandCost CheckBuildableTile(TileIndex tile, uint invalid_dirs, int &allowed_z, bool allow_steep, bool check_bridge = true)
785 if (check_bridge && IsBridgeAbove(tile)) {
786 return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
789 CommandCost ret = EnsureNoVehicleOnGround(tile);
790 if (ret.Failed()) return ret;
792 int z;
793 Slope tileh = GetTileSlope(tile, &z);
795 /* Prohibit building if
796 * 1) The tile is "steep" (i.e. stretches two height levels).
797 * 2) The tile is non-flat and the build_on_slopes switch is disabled.
799 if ((!allow_steep && IsSteepSlope(tileh)) ||
800 ((!_settings_game.construction.build_on_slopes) && tileh != SLOPE_FLAT)) {
801 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
804 CommandCost cost(EXPENSES_CONSTRUCTION);
805 int flat_z = z + GetSlopeMaxZ(tileh);
806 if (tileh != SLOPE_FLAT) {
807 /* Forbid building if the tile faces a slope in a invalid direction. */
808 for (DiagDirection dir = DIAGDIR_BEGIN; dir != DIAGDIR_END; dir++) {
809 if (HasBit(invalid_dirs, dir) && !CanBuildDepotByTileh(dir, tileh)) {
810 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
813 cost.AddCost(_price[PR_BUILD_FOUNDATION]);
816 /* The level of this tile must be equal to allowed_z. */
817 if (allowed_z < 0) {
818 /* First tile. */
819 allowed_z = flat_z;
820 } else if (allowed_z != flat_z) {
821 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
824 return cost;
828 * Checks if an airport can be built at the given location and clear the area.
829 * @param tile_iter Airport tile iterator.
830 * @param flags Operation to perform.
831 * @return The cost in case of success, or an error code if it failed.
833 static CommandCost CheckFlatLandAirport(AirportTileTableIterator tile_iter, DoCommandFlag flags)
835 CommandCost cost(EXPENSES_CONSTRUCTION);
836 int allowed_z = -1;
838 for (; tile_iter != INVALID_TILE; ++tile_iter) {
839 CommandCost ret = CheckBuildableTile(tile_iter, 0, allowed_z, true);
840 if (ret.Failed()) return ret;
841 cost.AddCost(ret);
843 ret = DoCommand(tile_iter, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
844 if (ret.Failed()) return ret;
845 cost.AddCost(ret);
848 return cost;
852 * Checks if a rail station can be built at the given area.
853 * @param tile_area Area to check.
854 * @param flags Operation to perform.
855 * @param axis Rail station axis.
856 * @param station StationID to be queried and returned if available.
857 * @param rt The rail type to check for (overbuilding rail stations over rail).
858 * @param affected_vehicles List of trains with PBS reservations on the tiles
859 * @param spec_class Station class.
860 * @param spec_index Index into the station class.
861 * @param plat_len Platform length.
862 * @param numtracks Number of platforms.
863 * @return The cost in case of success, or an error code if it failed.
865 static CommandCost CheckFlatLandRailStation(TileArea tile_area, DoCommandFlag flags, Axis axis, StationID *station, RailType rt, std::vector<Train *> &affected_vehicles, StationClassID spec_class, byte spec_index, byte plat_len, byte numtracks)
867 CommandCost cost(EXPENSES_CONSTRUCTION);
868 int allowed_z = -1;
869 uint invalid_dirs = 5 << axis;
871 const StationSpec *statspec = StationClass::Get(spec_class)->GetSpec(spec_index);
872 bool slope_cb = statspec != nullptr && HasBit(statspec->callback_mask, CBM_STATION_SLOPE_CHECK);
874 TILE_AREA_LOOP(tile_cur, tile_area) {
875 CommandCost ret = CheckBuildableTile(tile_cur, invalid_dirs, allowed_z, false);
876 if (ret.Failed()) return ret;
877 cost.AddCost(ret);
879 if (slope_cb) {
880 /* Do slope check if requested. */
881 ret = PerformStationTileSlopeCheck(tile_area.tile, tile_cur, statspec, axis, plat_len, numtracks);
882 if (ret.Failed()) return ret;
885 /* if station is set, then we have special handling to allow building on top of already existing stations.
886 * so station points to INVALID_STATION if we can build on any station.
887 * Or it points to a station if we're only allowed to build on exactly that station. */
888 if (station != nullptr && IsTileType(tile_cur, MP_STATION)) {
889 if (!IsRailStation(tile_cur)) {
890 return ClearTile_Station(tile_cur, DC_AUTO); // get error message
891 } else {
892 StationID st = GetStationIndex(tile_cur);
893 if (*station == INVALID_STATION) {
894 *station = st;
895 } else if (*station != st) {
896 return_cmd_error(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
899 } else {
900 /* Rail type is only valid when building a railway station; if station to
901 * build isn't a rail station it's INVALID_RAILTYPE. */
902 if (rt != INVALID_RAILTYPE &&
903 IsPlainRailTile(tile_cur) && !HasSignals(tile_cur) &&
904 HasPowerOnRail(GetRailType(tile_cur), rt)) {
905 /* Allow overbuilding if the tile:
906 * - has rail, but no signals
907 * - it has exactly one track
908 * - the track is in line with the station
909 * - the current rail type has power on the to-be-built type (e.g. convert normal rail to el rail)
911 TrackBits tracks = GetTrackBits(tile_cur);
912 Track track = RemoveFirstTrack(&tracks);
913 Track expected_track = HasBit(invalid_dirs, DIAGDIR_NE) ? TRACK_X : TRACK_Y;
915 if (tracks == TRACK_BIT_NONE && track == expected_track) {
916 /* Check for trains having a reservation for this tile. */
917 if (HasBit(GetRailReservationTrackBits(tile_cur), track)) {
918 Train *v = GetTrainForReservation(tile_cur, track);
919 if (v != nullptr) {
920 affected_vehicles.push_back(v);
923 CommandCost ret = DoCommand(tile_cur, 0, track, flags, CMD_REMOVE_SINGLE_RAIL);
924 if (ret.Failed()) return ret;
925 cost.AddCost(ret);
926 /* With flags & ~DC_EXEC CmdLandscapeClear would fail since the rail still exists */
927 continue;
930 ret = DoCommand(tile_cur, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
931 if (ret.Failed()) return ret;
932 cost.AddCost(ret);
936 return cost;
940 * Checks if a road stop can be built at the given tile.
941 * @param tile_area Area to check.
942 * @param flags Operation to perform.
943 * @param invalid_dirs Prohibited directions (set of DiagDirections).
944 * @param is_drive_through True if trying to build a drive-through station.
945 * @param is_truck_stop True when building a truck stop, false otherwise.
946 * @param axis Axis of a drive-through road stop.
947 * @param station StationID to be queried and returned if available.
948 * @param rt Road type to build.
949 * @return The cost in case of success, or an error code if it failed.
951 static CommandCost CheckFlatLandRoadStop(TileArea tile_area, DoCommandFlag flags, uint invalid_dirs, bool is_drive_through, bool is_truck_stop, Axis axis, StationID *station, RoadType rt)
953 CommandCost cost(EXPENSES_CONSTRUCTION);
954 int allowed_z = -1;
956 TILE_AREA_LOOP(cur_tile, tile_area) {
957 CommandCost ret = CheckBuildableTile(cur_tile, invalid_dirs, allowed_z, !is_drive_through);
958 if (ret.Failed()) return ret;
959 cost.AddCost(ret);
961 /* If station is set, then we have special handling to allow building on top of already existing stations.
962 * Station points to INVALID_STATION if we can build on any station.
963 * Or it points to a station if we're only allowed to build on exactly that station. */
964 if (station != nullptr && IsTileType(cur_tile, MP_STATION)) {
965 if (!IsRoadStop(cur_tile)) {
966 return ClearTile_Station(cur_tile, DC_AUTO); // Get error message.
967 } else {
968 if (is_truck_stop != IsTruckStop(cur_tile) ||
969 is_drive_through != IsDriveThroughStopTile(cur_tile)) {
970 return ClearTile_Station(cur_tile, DC_AUTO); // Get error message.
972 /* Drive-through station in the wrong direction. */
973 if (is_drive_through && IsDriveThroughStopTile(cur_tile) && DiagDirToAxis(GetRoadStopDir(cur_tile)) != axis){
974 return_cmd_error(STR_ERROR_DRIVE_THROUGH_DIRECTION);
976 StationID st = GetStationIndex(cur_tile);
977 if (*station == INVALID_STATION) {
978 *station = st;
979 } else if (*station != st) {
980 return_cmd_error(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
983 } else {
984 bool build_over_road = is_drive_through && IsNormalRoadTile(cur_tile);
985 /* Road bits in the wrong direction. */
986 RoadBits rb = IsNormalRoadTile(cur_tile) ? GetAllRoadBits(cur_tile) : ROAD_NONE;
987 if (build_over_road && (rb & (axis == AXIS_X ? ROAD_Y : ROAD_X)) != 0) {
988 /* Someone was pedantic and *NEEDED* three fracking different error messages. */
989 switch (CountBits(rb)) {
990 case 1:
991 return_cmd_error(STR_ERROR_DRIVE_THROUGH_DIRECTION);
993 case 2:
994 if (rb == ROAD_X || rb == ROAD_Y) return_cmd_error(STR_ERROR_DRIVE_THROUGH_DIRECTION);
995 return_cmd_error(STR_ERROR_DRIVE_THROUGH_CORNER);
997 default: // 3 or 4
998 return_cmd_error(STR_ERROR_DRIVE_THROUGH_JUNCTION);
1002 if (build_over_road) {
1003 /* There is a road, check if we can build road+tram stop over it. */
1004 RoadType road_rt = GetRoadType(cur_tile, RTT_ROAD);
1005 if (road_rt != INVALID_ROADTYPE) {
1006 Owner road_owner = GetRoadOwner(cur_tile, RTT_ROAD);
1007 if (road_owner == OWNER_TOWN) {
1008 if (!_settings_game.construction.road_stop_on_town_road) return_cmd_error(STR_ERROR_DRIVE_THROUGH_ON_TOWN_ROAD);
1009 } else if (!_settings_game.construction.road_stop_on_competitor_road && road_owner != OWNER_NONE) {
1010 CommandCost ret = CheckOwnership(road_owner);
1011 if (ret.Failed()) return ret;
1013 uint num_pieces = CountBits(GetRoadBits(cur_tile, RTT_ROAD));
1015 if (RoadTypeIsRoad(rt) && !HasPowerOnRoad(rt, road_rt)) return_cmd_error(STR_ERROR_NO_SUITABLE_ROAD);
1017 if (GetDisallowedRoadDirections(cur_tile) != DRD_NONE && road_owner != OWNER_TOWN) {
1018 CommandCost ret = CheckOwnership(road_owner);
1019 if (ret.Failed()) return ret;
1022 cost.AddCost(RoadBuildCost(road_rt) * (2 - num_pieces));
1023 } else if (RoadTypeIsRoad(rt)) {
1024 cost.AddCost(RoadBuildCost(rt) * 2);
1027 /* There is a tram, check if we can build road+tram stop over it. */
1028 RoadType tram_rt = GetRoadType(cur_tile, RTT_TRAM);
1029 if (tram_rt != INVALID_ROADTYPE) {
1030 Owner tram_owner = GetRoadOwner(cur_tile, RTT_TRAM);
1031 if (Company::IsValidID(tram_owner) &&
1032 (!_settings_game.construction.road_stop_on_competitor_road ||
1033 /* Disallow breaking end-of-line of someone else
1034 * so trams can still reverse on this tile. */
1035 HasExactlyOneBit(GetRoadBits(cur_tile, RTT_TRAM)))) {
1036 CommandCost ret = CheckOwnership(tram_owner);
1037 if (ret.Failed()) return ret;
1039 uint num_pieces = CountBits(GetRoadBits(cur_tile, RTT_TRAM));
1041 if (RoadTypeIsTram(rt) && !HasPowerOnRoad(rt, tram_rt)) return_cmd_error(STR_ERROR_NO_SUITABLE_ROAD);
1043 cost.AddCost(RoadBuildCost(tram_rt) * (2 - num_pieces));
1044 } else if (RoadTypeIsTram(rt)) {
1045 cost.AddCost(RoadBuildCost(rt) * 2);
1047 } else {
1048 ret = DoCommand(cur_tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
1049 if (ret.Failed()) return ret;
1050 cost.AddCost(ret);
1051 cost.AddCost(RoadBuildCost(rt) * 2);
1056 return cost;
1060 * Check whether we can expand the rail part of the given station.
1061 * @param st the station to expand
1062 * @param new_ta the current (and if all is fine new) tile area of the rail part of the station
1063 * @param axis the axis of the newly build rail
1064 * @return Succeeded or failed command.
1066 CommandCost CanExpandRailStation(const BaseStation *st, TileArea &new_ta, Axis axis)
1068 TileArea cur_ta = st->train_station;
1070 /* determine new size of train station region.. */
1071 int x = min(TileX(cur_ta.tile), TileX(new_ta.tile));
1072 int y = min(TileY(cur_ta.tile), TileY(new_ta.tile));
1073 new_ta.w = max(TileX(cur_ta.tile) + cur_ta.w, TileX(new_ta.tile) + new_ta.w) - x;
1074 new_ta.h = max(TileY(cur_ta.tile) + cur_ta.h, TileY(new_ta.tile) + new_ta.h) - y;
1075 new_ta.tile = TileXY(x, y);
1077 /* make sure the final size is not too big. */
1078 if (new_ta.w > _settings_game.station.station_spread || new_ta.h > _settings_game.station.station_spread) {
1079 return_cmd_error(STR_ERROR_STATION_TOO_SPREAD_OUT);
1082 return CommandCost();
1085 static inline byte *CreateSingle(byte *layout, int n)
1087 int i = n;
1088 do *layout++ = 0; while (--i);
1089 layout[((n - 1) >> 1) - n] = 2;
1090 return layout;
1093 static inline byte *CreateMulti(byte *layout, int n, byte b)
1095 int i = n;
1096 do *layout++ = b; while (--i);
1097 if (n > 4) {
1098 layout[0 - n] = 0;
1099 layout[n - 1 - n] = 0;
1101 return layout;
1105 * Create the station layout for the given number of tracks and platform length.
1106 * @param layout The layout to write to.
1107 * @param numtracks The number of tracks to write.
1108 * @param plat_len The length of the platforms.
1109 * @param statspec The specification of the station to (possibly) get the layout from.
1111 void GetStationLayout(byte *layout, int numtracks, int plat_len, const StationSpec *statspec)
1113 if (statspec != nullptr && statspec->lengths >= plat_len &&
1114 statspec->platforms[plat_len - 1] >= numtracks &&
1115 statspec->layouts[plat_len - 1][numtracks - 1]) {
1116 /* Custom layout defined, follow it. */
1117 memcpy(layout, statspec->layouts[plat_len - 1][numtracks - 1],
1118 plat_len * numtracks);
1119 return;
1122 if (plat_len == 1) {
1123 CreateSingle(layout, numtracks);
1124 } else {
1125 if (numtracks & 1) layout = CreateSingle(layout, plat_len);
1126 numtracks >>= 1;
1128 while (--numtracks >= 0) {
1129 layout = CreateMulti(layout, plat_len, 4);
1130 layout = CreateMulti(layout, plat_len, 6);
1136 * Find a nearby station that joins this station.
1137 * @tparam T the class to find a station for
1138 * @tparam error_message the error message when building a station on top of others
1139 * @param existing_station an existing station we build over
1140 * @param station_to_join the station to join to
1141 * @param adjacent whether adjacent stations are allowed
1142 * @param ta the area of the newly build station
1143 * @param st 'return' pointer for the found station
1144 * @return command cost with the error or 'okay'
1146 template <class T, StringID error_message>
1147 CommandCost FindJoiningBaseStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, T **st)
1149 assert(*st == nullptr);
1150 bool check_surrounding = true;
1152 if (_settings_game.station.adjacent_stations) {
1153 if (existing_station != INVALID_STATION) {
1154 if (adjacent && existing_station != station_to_join) {
1155 /* You can't build an adjacent station over the top of one that
1156 * already exists. */
1157 return_cmd_error(error_message);
1158 } else {
1159 /* Extend the current station, and don't check whether it will
1160 * be near any other stations. */
1161 *st = T::GetIfValid(existing_station);
1162 check_surrounding = (*st == nullptr);
1164 } else {
1165 /* There's no station here. Don't check the tiles surrounding this
1166 * one if the company wanted to build an adjacent station. */
1167 if (adjacent) check_surrounding = false;
1171 if (check_surrounding) {
1172 /* Make sure there is no more than one other station around us that is owned by us. */
1173 CommandCost ret = GetStationAround(ta, existing_station, _current_company, st);
1174 if (ret.Failed()) return ret;
1177 /* Distant join */
1178 if (*st == nullptr && station_to_join != INVALID_STATION) *st = T::GetIfValid(station_to_join);
1180 return CommandCost();
1184 * Find a nearby station that joins this station.
1185 * @param existing_station an existing station we build over
1186 * @param station_to_join the station to join to
1187 * @param adjacent whether adjacent stations are allowed
1188 * @param ta the area of the newly build station
1189 * @param st 'return' pointer for the found station
1190 * @return command cost with the error or 'okay'
1192 static CommandCost FindJoiningStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
1194 return FindJoiningBaseStation<Station, STR_ERROR_MUST_REMOVE_RAILWAY_STATION_FIRST>(existing_station, station_to_join, adjacent, ta, st);
1198 * Find a nearby waypoint that joins this waypoint.
1199 * @param existing_waypoint an existing waypoint we build over
1200 * @param waypoint_to_join the waypoint to join to
1201 * @param adjacent whether adjacent waypoints are allowed
1202 * @param ta the area of the newly build waypoint
1203 * @param wp 'return' pointer for the found waypoint
1204 * @return command cost with the error or 'okay'
1206 CommandCost FindJoiningWaypoint(StationID existing_waypoint, StationID waypoint_to_join, bool adjacent, TileArea ta, Waypoint **wp)
1208 return FindJoiningBaseStation<Waypoint, STR_ERROR_MUST_REMOVE_RAILWAYPOINT_FIRST>(existing_waypoint, waypoint_to_join, adjacent, ta, wp);
1212 * Clear platform reservation during station building/removing.
1213 * @param v vehicle which holds reservation
1215 static void FreeTrainReservation(Train *v)
1217 FreeTrainTrackReservation(v);
1218 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), false);
1219 v = v->Last();
1220 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(ReverseTrackdir(v->GetVehicleTrackdir())), false);
1224 * Restore platform reservation during station building/removing.
1225 * @param v vehicle which held reservation
1227 static void RestoreTrainReservation(Train *v)
1229 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), true);
1230 TryPathReserve(v, true, true);
1231 v = v->Last();
1232 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(ReverseTrackdir(v->GetVehicleTrackdir())), true);
1236 * Build rail station
1237 * @param tile_org northern most position of station dragging/placement
1238 * @param flags operation to perform
1239 * @param p1 various bitstuffed elements
1240 * - p1 = (bit 0- 5) - railtype
1241 * - p1 = (bit 6) - orientation (Axis)
1242 * - p1 = (bit 8-15) - number of tracks
1243 * - p1 = (bit 16-23) - platform length
1244 * - p1 = (bit 24) - allow stations directly adjacent to other stations.
1245 * @param p2 various bitstuffed elements
1246 * - p2 = (bit 0- 7) - custom station class
1247 * - p2 = (bit 8-15) - custom station id
1248 * - p2 = (bit 16-31) - station ID to join (NEW_STATION if build new one)
1249 * @param text unused
1250 * @return the cost of this operation or an error
1252 CommandCost CmdBuildRailStation(TileIndex tile_org, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1254 /* Unpack parameters */
1255 RailType rt = Extract<RailType, 0, 6>(p1);
1256 Axis axis = Extract<Axis, 6, 1>(p1);
1257 byte numtracks = GB(p1, 8, 8);
1258 byte plat_len = GB(p1, 16, 8);
1259 bool adjacent = HasBit(p1, 24);
1261 StationClassID spec_class = Extract<StationClassID, 0, 8>(p2);
1262 byte spec_index = GB(p2, 8, 8);
1263 StationID station_to_join = GB(p2, 16, 16);
1265 /* Does the authority allow this? */
1266 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile_org, flags);
1267 if (ret.Failed()) return ret;
1269 if (!ValParamRailtype(rt)) return CMD_ERROR;
1271 /* Check if the given station class is valid */
1272 if ((uint)spec_class >= StationClass::GetClassCount() || spec_class == STAT_CLASS_WAYP) return CMD_ERROR;
1273 if (spec_index >= StationClass::Get(spec_class)->GetSpecCount()) return CMD_ERROR;
1274 if (plat_len == 0 || numtracks == 0) return CMD_ERROR;
1276 int w_org, h_org;
1277 if (axis == AXIS_X) {
1278 w_org = plat_len;
1279 h_org = numtracks;
1280 } else {
1281 h_org = plat_len;
1282 w_org = numtracks;
1285 bool reuse = (station_to_join != NEW_STATION);
1286 if (!reuse) station_to_join = INVALID_STATION;
1287 bool distant_join = (station_to_join != INVALID_STATION);
1289 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
1291 if (h_org > _settings_game.station.station_spread || w_org > _settings_game.station.station_spread) return CMD_ERROR;
1293 /* these values are those that will be stored in train_tile and station_platforms */
1294 TileArea new_location(tile_org, w_org, h_org);
1296 /* Make sure the area below consists of clear tiles. (OR tiles belonging to a certain rail station) */
1297 StationID est = INVALID_STATION;
1298 std::vector<Train *> affected_vehicles;
1299 /* Clear the land below the station. */
1300 CommandCost cost = CheckFlatLandRailStation(new_location, flags, axis, &est, rt, affected_vehicles, spec_class, spec_index, plat_len, numtracks);
1301 if (cost.Failed()) return cost;
1302 /* Add construction expenses. */
1303 cost.AddCost((numtracks * _price[PR_BUILD_STATION_RAIL] + _price[PR_BUILD_STATION_RAIL_LENGTH]) * plat_len);
1304 cost.AddCost(numtracks * plat_len * RailBuildCost(rt));
1306 Station *st = nullptr;
1307 ret = FindJoiningStation(est, station_to_join, adjacent, new_location, &st);
1308 if (ret.Failed()) return ret;
1310 ret = BuildStationPart(&st, flags, reuse, new_location, STATIONNAMING_RAIL);
1311 if (ret.Failed()) return ret;
1313 if (st != nullptr && st->train_station.tile != INVALID_TILE) {
1314 CommandCost ret = CanExpandRailStation(st, new_location, axis);
1315 if (ret.Failed()) return ret;
1318 /* Check if we can allocate a custom stationspec to this station */
1319 const StationSpec *statspec = StationClass::Get(spec_class)->GetSpec(spec_index);
1320 int specindex = AllocateSpecToStation(statspec, st, (flags & DC_EXEC) != 0);
1321 if (specindex == -1) return_cmd_error(STR_ERROR_TOO_MANY_STATION_SPECS);
1323 if (statspec != nullptr) {
1324 /* Perform NewStation checks */
1326 /* Check if the station size is permitted */
1327 if (HasBit(statspec->disallowed_platforms, min(numtracks - 1, 7)) || HasBit(statspec->disallowed_lengths, min(plat_len - 1, 7))) {
1328 return CMD_ERROR;
1331 /* Check if the station is buildable */
1332 if (HasBit(statspec->callback_mask, CBM_STATION_AVAIL)) {
1333 uint16 cb_res = GetStationCallback(CBID_STATION_AVAILABILITY, 0, 0, statspec, nullptr, INVALID_TILE);
1334 if (cb_res != CALLBACK_FAILED && !Convert8bitBooleanCallback(statspec->grf_prop.grffile, CBID_STATION_AVAILABILITY, cb_res)) return CMD_ERROR;
1338 if (flags & DC_EXEC) {
1339 TileIndexDiff tile_delta;
1340 byte *layout_ptr;
1341 byte numtracks_orig;
1342 Track track;
1344 st->train_station = new_location;
1345 st->AddFacility(FACIL_TRAIN, new_location.tile);
1347 st->rect.BeforeAddRect(tile_org, w_org, h_org, StationRect::ADD_TRY);
1349 if (statspec != nullptr) {
1350 /* Include this station spec's animation trigger bitmask
1351 * in the station's cached copy. */
1352 st->cached_anim_triggers |= statspec->animation.triggers;
1355 tile_delta = (axis == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1));
1356 track = AxisToTrack(axis);
1358 layout_ptr = AllocaM(byte, numtracks * plat_len);
1359 GetStationLayout(layout_ptr, numtracks, plat_len, statspec);
1361 numtracks_orig = numtracks;
1363 Company *c = Company::Get(st->owner);
1364 TileIndex tile_track = tile_org;
1365 do {
1366 TileIndex tile = tile_track;
1367 int w = plat_len;
1368 do {
1369 byte layout = *layout_ptr++;
1370 if (IsRailStationTile(tile) && HasStationReservation(tile)) {
1371 /* Check for trains having a reservation for this tile. */
1372 Train *v = GetTrainForReservation(tile, AxisToTrack(GetRailStationAxis(tile)));
1373 if (v != nullptr) {
1374 affected_vehicles.push_back(v);
1375 FreeTrainReservation(v);
1379 /* Railtype can change when overbuilding. */
1380 if (IsRailStationTile(tile)) {
1381 if (!IsStationTileBlocked(tile)) c->infrastructure.rail[GetRailType(tile)]--;
1382 c->infrastructure.station--;
1385 /* Remove animation if overbuilding */
1386 DeleteAnimatedTile(tile);
1387 byte old_specindex = HasStationTileRail(tile) ? GetCustomStationSpecIndex(tile) : 0;
1388 MakeRailStation(tile, st->owner, st->index, axis, layout & ~1, rt);
1389 /* Free the spec if we overbuild something */
1390 DeallocateSpecFromStation(st, old_specindex);
1392 SetCustomStationSpecIndex(tile, specindex);
1393 SetStationTileRandomBits(tile, GB(Random(), 0, 4));
1394 SetAnimationFrame(tile, 0);
1396 if (!IsStationTileBlocked(tile)) c->infrastructure.rail[rt]++;
1397 c->infrastructure.station++;
1399 if (statspec != nullptr) {
1400 /* Use a fixed axis for GetPlatformInfo as our platforms / numtracks are always the right way around */
1401 uint32 platinfo = GetPlatformInfo(AXIS_X, GetStationGfx(tile), plat_len, numtracks_orig, plat_len - w, numtracks_orig - numtracks, false);
1403 /* As the station is not yet completely finished, the station does not yet exist. */
1404 uint16 callback = GetStationCallback(CBID_STATION_TILE_LAYOUT, platinfo, 0, statspec, nullptr, tile);
1405 if (callback != CALLBACK_FAILED) {
1406 if (callback < 8) {
1407 SetStationGfx(tile, (callback & ~1) + axis);
1408 } else {
1409 ErrorUnknownCallbackResult(statspec->grf_prop.grffile->grfid, CBID_STATION_TILE_LAYOUT, callback);
1413 /* Trigger station animation -- after building? */
1414 TriggerStationAnimation(st, tile, SAT_BUILT);
1417 tile += tile_delta;
1418 } while (--w);
1419 AddTrackToSignalBuffer(tile_track, track, _current_company);
1420 YapfNotifyTrackLayoutChange(tile_track, track);
1421 tile_track += tile_delta ^ TileDiffXY(1, 1); // perpendicular to tile_delta
1422 } while (--numtracks);
1424 for (uint i = 0; i < affected_vehicles.size(); ++i) {
1425 /* Restore reservations of trains. */
1426 RestoreTrainReservation(affected_vehicles[i]);
1429 /* Check whether we need to expand the reservation of trains already on the station. */
1430 TileArea update_reservation_area;
1431 if (axis == AXIS_X) {
1432 update_reservation_area = TileArea(tile_org, 1, numtracks_orig);
1433 } else {
1434 update_reservation_area = TileArea(tile_org, numtracks_orig, 1);
1437 TILE_AREA_LOOP(tile, update_reservation_area) {
1438 /* Don't even try to make eye candy parts reserved. */
1439 if (IsStationTileBlocked(tile)) continue;
1441 DiagDirection dir = AxisToDiagDir(axis);
1442 TileIndexDiff tile_offset = TileOffsByDiagDir(dir);
1443 TileIndex platform_begin = tile;
1444 TileIndex platform_end = tile;
1446 /* We can only account for tiles that are reachable from this tile, so ignore primarily blocked tiles while finding the platform begin and end. */
1447 for (TileIndex next_tile = platform_begin - tile_offset; IsCompatibleTrainStationTile(next_tile, platform_begin); next_tile -= tile_offset) {
1448 platform_begin = next_tile;
1450 for (TileIndex next_tile = platform_end + tile_offset; IsCompatibleTrainStationTile(next_tile, platform_end); next_tile += tile_offset) {
1451 platform_end = next_tile;
1454 /* If there is at least on reservation on the platform, we reserve the whole platform. */
1455 bool reservation = false;
1456 for (TileIndex t = platform_begin; !reservation && t <= platform_end; t += tile_offset) {
1457 reservation = HasStationReservation(t);
1460 if (reservation) {
1461 SetRailStationPlatformReservation(platform_begin, dir, true);
1465 st->MarkTilesDirty(false);
1466 st->AfterStationTileSetChange(true, STATION_RAIL);
1469 return cost;
1472 static TileArea MakeStationAreaSmaller(BaseStation *st, TileArea ta, bool (*func)(BaseStation *, TileIndex))
1474 restart:
1476 /* too small? */
1477 if (ta.w != 0 && ta.h != 0) {
1478 /* check the left side, x = constant, y changes */
1479 for (uint i = 0; !func(st, ta.tile + TileDiffXY(0, i));) {
1480 /* the left side is unused? */
1481 if (++i == ta.h) {
1482 ta.tile += TileDiffXY(1, 0);
1483 ta.w--;
1484 goto restart;
1488 /* check the right side, x = constant, y changes */
1489 for (uint i = 0; !func(st, ta.tile + TileDiffXY(ta.w - 1, i));) {
1490 /* the right side is unused? */
1491 if (++i == ta.h) {
1492 ta.w--;
1493 goto restart;
1497 /* check the upper side, y = constant, x changes */
1498 for (uint i = 0; !func(st, ta.tile + TileDiffXY(i, 0));) {
1499 /* the left side is unused? */
1500 if (++i == ta.w) {
1501 ta.tile += TileDiffXY(0, 1);
1502 ta.h--;
1503 goto restart;
1507 /* check the lower side, y = constant, x changes */
1508 for (uint i = 0; !func(st, ta.tile + TileDiffXY(i, ta.h - 1));) {
1509 /* the left side is unused? */
1510 if (++i == ta.w) {
1511 ta.h--;
1512 goto restart;
1515 } else {
1516 ta.Clear();
1519 return ta;
1522 static bool TileBelongsToRailStation(BaseStation *st, TileIndex tile)
1524 return st->TileBelongsToRailStation(tile);
1527 static void MakeRailStationAreaSmaller(BaseStation *st)
1529 st->train_station = MakeStationAreaSmaller(st, st->train_station, TileBelongsToRailStation);
1532 static bool TileBelongsToShipStation(BaseStation *st, TileIndex tile)
1534 return IsDockTile(tile) && GetStationIndex(tile) == st->index;
1537 static void MakeShipStationAreaSmaller(Station *st)
1539 st->ship_station = MakeStationAreaSmaller(st, st->ship_station, TileBelongsToShipStation);
1540 UpdateStationDockingTiles(st);
1544 * Remove a number of tiles from any rail station within the area.
1545 * @param ta the area to clear station tile from.
1546 * @param affected_stations the stations affected.
1547 * @param flags the command flags.
1548 * @param removal_cost the cost for removing the tile, including the rail.
1549 * @param keep_rail whether to keep the rail of the station.
1550 * @tparam T the type of station to remove.
1551 * @return the number of cleared tiles or an error.
1553 template <class T>
1554 CommandCost RemoveFromRailBaseStation(TileArea ta, std::vector<T *> &affected_stations, DoCommandFlag flags, Money removal_cost, bool keep_rail)
1556 /* Count of the number of tiles removed */
1557 int quantity = 0;
1558 CommandCost total_cost(EXPENSES_CONSTRUCTION);
1559 /* Accumulator for the errors seen during clearing. If no errors happen,
1560 * and the quantity is 0 there is no station. Otherwise it will be one
1561 * of the other error that got accumulated. */
1562 CommandCost error;
1564 /* Do the action for every tile into the area */
1565 TILE_AREA_LOOP(tile, ta) {
1566 /* Make sure the specified tile is a rail station */
1567 if (!HasStationTileRail(tile)) continue;
1569 /* If there is a vehicle on ground, do not allow to remove (flood) the tile */
1570 CommandCost ret = EnsureNoVehicleOnGround(tile);
1571 error.AddCost(ret);
1572 if (ret.Failed()) continue;
1574 /* Check ownership of station */
1575 T *st = T::GetByTile(tile);
1576 if (st == nullptr) continue;
1578 if (_current_company != OWNER_WATER) {
1579 CommandCost ret = CheckOwnership(st->owner);
1580 error.AddCost(ret);
1581 if (ret.Failed()) continue;
1584 /* If we reached here, the tile is valid so increase the quantity of tiles we will remove */
1585 quantity++;
1587 if (keep_rail || IsStationTileBlocked(tile)) {
1588 /* Don't refund the 'steel' of the track when we keep the
1589 * rail, or when the tile didn't have any rail at all. */
1590 total_cost.AddCost(-_price[PR_CLEAR_RAIL]);
1593 if (flags & DC_EXEC) {
1594 /* read variables before the station tile is removed */
1595 uint specindex = GetCustomStationSpecIndex(tile);
1596 Track track = GetRailStationTrack(tile);
1597 Owner owner = GetTileOwner(tile);
1598 RailType rt = GetRailType(tile);
1599 Train *v = nullptr;
1601 if (HasStationReservation(tile)) {
1602 v = GetTrainForReservation(tile, track);
1603 if (v != nullptr) FreeTrainReservation(v);
1606 bool build_rail = keep_rail && !IsStationTileBlocked(tile);
1607 if (!build_rail && !IsStationTileBlocked(tile)) Company::Get(owner)->infrastructure.rail[rt]--;
1609 DoClearSquare(tile);
1610 DeleteNewGRFInspectWindow(GSF_STATIONS, tile);
1611 if (build_rail) MakeRailNormal(tile, owner, TrackToTrackBits(track), rt);
1612 Company::Get(owner)->infrastructure.station--;
1613 DirtyCompanyInfrastructureWindows(owner);
1615 st->rect.AfterRemoveTile(st, tile);
1616 AddTrackToSignalBuffer(tile, track, owner);
1617 YapfNotifyTrackLayoutChange(tile, track);
1619 DeallocateSpecFromStation(st, specindex);
1621 include(affected_stations, st);
1623 if (v != nullptr) RestoreTrainReservation(v);
1627 if (quantity == 0) return error.Failed() ? error : CommandCost(STR_ERROR_THERE_IS_NO_STATION);
1629 for (T *st : affected_stations) {
1631 /* now we need to make the "spanned" area of the railway station smaller
1632 * if we deleted something at the edges.
1633 * we also need to adjust train_tile. */
1634 MakeRailStationAreaSmaller(st);
1635 UpdateStationSignCoord(st);
1637 /* if we deleted the whole station, delete the train facility. */
1638 if (st->train_station.tile == INVALID_TILE) {
1639 st->facilities &= ~FACIL_TRAIN;
1640 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_TRAINS);
1641 st->UpdateVirtCoord();
1642 DeleteStationIfEmpty(st);
1646 total_cost.AddCost(quantity * removal_cost);
1647 return total_cost;
1651 * Remove a single tile from a rail station.
1652 * This allows for custom-built station with holes and weird layouts
1653 * @param start tile of station piece to remove
1654 * @param flags operation to perform
1655 * @param p1 start_tile
1656 * @param p2 various bitstuffed elements
1657 * - p2 = bit 0 - if set keep the rail
1658 * @param text unused
1659 * @return the cost of this operation or an error
1661 CommandCost CmdRemoveFromRailStation(TileIndex start, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1663 TileIndex end = p1 == 0 ? start : p1;
1664 if (start >= MapSize() || end >= MapSize()) return CMD_ERROR;
1666 TileArea ta(start, end);
1667 std::vector<Station *> affected_stations;
1669 CommandCost ret = RemoveFromRailBaseStation(ta, affected_stations, flags, _price[PR_CLEAR_STATION_RAIL], HasBit(p2, 0));
1670 if (ret.Failed()) return ret;
1672 /* Do all station specific functions here. */
1673 for (Station *st : affected_stations) {
1675 if (st->train_station.tile == INVALID_TILE) SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_TRAINS);
1676 st->MarkTilesDirty(false);
1677 st->RecomputeCatchment();
1680 /* Now apply the rail cost to the number that we deleted */
1681 return ret;
1685 * Remove a single tile from a waypoint.
1686 * This allows for custom-built waypoint with holes and weird layouts
1687 * @param start tile of waypoint piece to remove
1688 * @param flags operation to perform
1689 * @param p1 start_tile
1690 * @param p2 various bitstuffed elements
1691 * - p2 = bit 0 - if set keep the rail
1692 * @param text unused
1693 * @return the cost of this operation or an error
1695 CommandCost CmdRemoveFromRailWaypoint(TileIndex start, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1697 TileIndex end = p1 == 0 ? start : p1;
1698 if (start >= MapSize() || end >= MapSize()) return CMD_ERROR;
1700 TileArea ta(start, end);
1701 std::vector<Waypoint *> affected_stations;
1703 return RemoveFromRailBaseStation(ta, affected_stations, flags, _price[PR_CLEAR_WAYPOINT_RAIL], HasBit(p2, 0));
1708 * Remove a rail station/waypoint
1709 * @param st The station/waypoint to remove the rail part from
1710 * @param flags operation to perform
1711 * @param removal_cost the cost for removing a tile
1712 * @tparam T the type of station to remove
1713 * @return cost or failure of operation
1715 template <class T>
1716 CommandCost RemoveRailStation(T *st, DoCommandFlag flags, Money removal_cost)
1718 /* Current company owns the station? */
1719 if (_current_company != OWNER_WATER) {
1720 CommandCost ret = CheckOwnership(st->owner);
1721 if (ret.Failed()) return ret;
1724 /* determine width and height of platforms */
1725 TileArea ta = st->train_station;
1727 assert(ta.w != 0 && ta.h != 0);
1729 CommandCost cost(EXPENSES_CONSTRUCTION);
1730 /* clear all areas of the station */
1731 TILE_AREA_LOOP(tile, ta) {
1732 /* only remove tiles that are actually train station tiles */
1733 if (st->TileBelongsToRailStation(tile)) {
1734 std::vector<T*> affected_stations; // dummy
1735 CommandCost ret = RemoveFromRailBaseStation(TileArea(tile, 1, 1), affected_stations, flags, removal_cost, false);
1736 if (ret.Failed()) return ret;
1737 cost.AddCost(ret);
1741 return cost;
1745 * Remove a rail station
1746 * @param tile Tile of the station.
1747 * @param flags operation to perform
1748 * @return cost or failure of operation
1750 static CommandCost RemoveRailStation(TileIndex tile, DoCommandFlag flags)
1752 /* if there is flooding, remove platforms tile by tile */
1753 if (_current_company == OWNER_WATER) {
1754 return DoCommand(tile, 0, 0, DC_EXEC, CMD_REMOVE_FROM_RAIL_STATION);
1757 Station *st = Station::GetByTile(tile);
1758 CommandCost cost = RemoveRailStation(st, flags, _price[PR_CLEAR_STATION_RAIL]);
1760 if (flags & DC_EXEC) st->RecomputeCatchment();
1762 return cost;
1766 * Remove a rail waypoint
1767 * @param tile Tile of the waypoint.
1768 * @param flags operation to perform
1769 * @return cost or failure of operation
1771 static CommandCost RemoveRailWaypoint(TileIndex tile, DoCommandFlag flags)
1773 /* if there is flooding, remove waypoints tile by tile */
1774 if (_current_company == OWNER_WATER) {
1775 return DoCommand(tile, 0, 0, DC_EXEC, CMD_REMOVE_FROM_RAIL_WAYPOINT);
1778 return RemoveRailStation(Waypoint::GetByTile(tile), flags, _price[PR_CLEAR_WAYPOINT_RAIL]);
1783 * @param truck_station Determines whether a stop is #ROADSTOP_BUS or #ROADSTOP_TRUCK
1784 * @param st The Station to do the whole procedure for
1785 * @return a pointer to where to link a new RoadStop*
1787 static RoadStop **FindRoadStopSpot(bool truck_station, Station *st)
1789 RoadStop **primary_stop = (truck_station) ? &st->truck_stops : &st->bus_stops;
1791 if (*primary_stop == nullptr) {
1792 /* we have no roadstop of the type yet, so write a "primary stop" */
1793 return primary_stop;
1794 } else {
1795 /* there are stops already, so append to the end of the list */
1796 RoadStop *stop = *primary_stop;
1797 while (stop->next != nullptr) stop = stop->next;
1798 return &stop->next;
1802 static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlag flags);
1805 * Find a nearby station that joins this road stop.
1806 * @param existing_stop an existing road stop we build over
1807 * @param station_to_join the station to join to
1808 * @param adjacent whether adjacent stations are allowed
1809 * @param ta the area of the newly build station
1810 * @param st 'return' pointer for the found station
1811 * @return command cost with the error or 'okay'
1813 static CommandCost FindJoiningRoadStop(StationID existing_stop, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
1815 return FindJoiningBaseStation<Station, STR_ERROR_MUST_REMOVE_ROAD_STOP_FIRST>(existing_stop, station_to_join, adjacent, ta, st);
1819 * Build a bus or truck stop.
1820 * @param tile Northernmost tile of the stop.
1821 * @param flags Operation to perform.
1822 * @param p1 bit 0..7: Width of the road stop.
1823 * bit 8..15: Length of the road stop.
1824 * @param p2 bit 0: 0 For bus stops, 1 for truck stops.
1825 * bit 1: 0 For normal stops, 1 for drive-through.
1826 * bit 2: Allow stations directly adjacent to other stations.
1827 * bit 3..4: Entrance direction (#DiagDirection) for normal stops.
1828 * bit 3: #Axis of the road for drive-through stops.
1829 * bit 5..10: The roadtype.
1830 * bit 16..31: Station ID to join (NEW_STATION if build new one).
1831 * @param text Unused.
1832 * @return The cost of this operation or an error.
1834 CommandCost CmdBuildRoadStop(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1836 bool type = HasBit(p2, 0);
1837 bool is_drive_through = HasBit(p2, 1);
1838 RoadType rt = Extract<RoadType, 5, 6>(p2);
1839 if (!ValParamRoadType(rt)) return CMD_ERROR;
1840 StationID station_to_join = GB(p2, 16, 16);
1841 bool reuse = (station_to_join != NEW_STATION);
1842 if (!reuse) station_to_join = INVALID_STATION;
1843 bool distant_join = (station_to_join != INVALID_STATION);
1845 uint8 width = (uint8)GB(p1, 0, 8);
1846 uint8 length = (uint8)GB(p1, 8, 8);
1848 /* Check if the requested road stop is too big */
1849 if (width > _settings_game.station.station_spread || length > _settings_game.station.station_spread) return_cmd_error(STR_ERROR_STATION_TOO_SPREAD_OUT);
1850 /* Check for incorrect width / length. */
1851 if (width == 0 || length == 0) return CMD_ERROR;
1852 /* Check if the first tile and the last tile are valid */
1853 if (!IsValidTile(tile) || TileAddWrap(tile, width - 1, length - 1) == INVALID_TILE) return CMD_ERROR;
1855 TileArea roadstop_area(tile, width, length);
1857 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
1859 /* Trams only have drive through stops */
1860 if (!is_drive_through && RoadTypeIsTram(rt)) return CMD_ERROR;
1862 DiagDirection ddir;
1863 Axis axis;
1864 if (is_drive_through) {
1865 /* By definition axis is valid, due to there being 2 axes and reading 1 bit. */
1866 axis = Extract<Axis, 3, 1>(p2);
1867 ddir = AxisToDiagDir(axis);
1868 } else {
1869 /* By definition ddir is valid, due to there being 4 diagonal directions and reading 2 bits. */
1870 ddir = Extract<DiagDirection, 3, 2>(p2);
1871 axis = DiagDirToAxis(ddir);
1874 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile, flags);
1875 if (ret.Failed()) return ret;
1877 /* Total road stop cost. */
1878 CommandCost cost(EXPENSES_CONSTRUCTION, roadstop_area.w * roadstop_area.h * _price[type ? PR_BUILD_STATION_TRUCK : PR_BUILD_STATION_BUS]);
1879 StationID est = INVALID_STATION;
1880 ret = CheckFlatLandRoadStop(roadstop_area, flags, is_drive_through ? 5 << axis : 1 << ddir, is_drive_through, type, axis, &est, rt);
1881 if (ret.Failed()) return ret;
1882 cost.AddCost(ret);
1884 Station *st = nullptr;
1885 ret = FindJoiningRoadStop(est, station_to_join, HasBit(p2, 2), roadstop_area, &st);
1886 if (ret.Failed()) return ret;
1888 /* Check if this number of road stops can be allocated. */
1889 if (!RoadStop::CanAllocateItem(roadstop_area.w * roadstop_area.h)) return_cmd_error(type ? STR_ERROR_TOO_MANY_TRUCK_STOPS : STR_ERROR_TOO_MANY_BUS_STOPS);
1891 ret = BuildStationPart(&st, flags, reuse, roadstop_area, STATIONNAMING_ROAD);
1892 if (ret.Failed()) return ret;
1894 if (flags & DC_EXEC) {
1895 /* Check every tile in the area. */
1896 TILE_AREA_LOOP(cur_tile, roadstop_area) {
1897 /* Get existing road types and owners before any tile clearing */
1898 RoadType road_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RTT_ROAD) : INVALID_ROADTYPE;
1899 RoadType tram_rt = MayHaveRoad(cur_tile) ? GetRoadType(cur_tile, RTT_TRAM) : INVALID_ROADTYPE;
1900 Owner road_owner = road_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RTT_ROAD) : _current_company;
1901 Owner tram_owner = tram_rt != INVALID_ROADTYPE ? GetRoadOwner(cur_tile, RTT_TRAM) : _current_company;
1903 if (IsTileType(cur_tile, MP_STATION) && IsRoadStop(cur_tile)) {
1904 RemoveRoadStop(cur_tile, flags);
1907 RoadStop *road_stop = new RoadStop(cur_tile);
1908 /* Insert into linked list of RoadStops. */
1909 RoadStop **currstop = FindRoadStopSpot(type, st);
1910 *currstop = road_stop;
1912 if (type) {
1913 st->truck_station.Add(cur_tile);
1914 } else {
1915 st->bus_station.Add(cur_tile);
1918 /* Initialize an empty station. */
1919 st->AddFacility((type) ? FACIL_TRUCK_STOP : FACIL_BUS_STOP, cur_tile);
1921 st->rect.BeforeAddTile(cur_tile, StationRect::ADD_TRY);
1923 RoadStopType rs_type = type ? ROADSTOP_TRUCK : ROADSTOP_BUS;
1924 if (is_drive_through) {
1925 /* Update company infrastructure counts. If the current tile is a normal road tile, remove the old
1926 * bits first. */
1927 if (IsNormalRoadTile(cur_tile)) {
1928 UpdateCompanyRoadInfrastructure(road_rt, road_owner, -(int)CountBits(GetRoadBits(cur_tile, RTT_ROAD)));
1929 UpdateCompanyRoadInfrastructure(tram_rt, tram_owner, -(int)CountBits(GetRoadBits(cur_tile, RTT_TRAM)));
1932 if (road_rt == INVALID_ROADTYPE && RoadTypeIsRoad(rt)) road_rt = rt;
1933 if (tram_rt == INVALID_ROADTYPE && RoadTypeIsTram(rt)) tram_rt = rt;
1935 UpdateCompanyRoadInfrastructure(road_rt, road_owner, 2);
1936 UpdateCompanyRoadInfrastructure(tram_rt, tram_owner, 2);
1938 MakeDriveThroughRoadStop(cur_tile, st->owner, road_owner, tram_owner, st->index, rs_type, road_rt, tram_rt, axis);
1939 road_stop->MakeDriveThrough();
1940 } else {
1941 if (road_rt == INVALID_ROADTYPE && RoadTypeIsRoad(rt)) road_rt = rt;
1942 if (tram_rt == INVALID_ROADTYPE && RoadTypeIsTram(rt)) tram_rt = rt;
1943 /* Non-drive-through stop never overbuild and always count as two road bits. */
1944 Company::Get(st->owner)->infrastructure.road[rt] += 2;
1945 MakeRoadStop(cur_tile, st->owner, st->index, rs_type, road_rt, tram_rt, ddir);
1947 Company::Get(st->owner)->infrastructure.station++;
1949 MarkTileDirtyByTile(cur_tile);
1953 if (st != nullptr) {
1954 st->AfterStationTileSetChange(true, type ? STATION_TRUCK: STATION_BUS);
1956 return cost;
1960 static Vehicle *ClearRoadStopStatusEnum(Vehicle *v, void *)
1962 if (v->type == VEH_ROAD) {
1963 /* Okay... we are a road vehicle on a drive through road stop.
1964 * But that road stop has just been removed, so we need to make
1965 * sure we are in a valid state... however, vehicles can also
1966 * turn on road stop tiles, so only clear the 'road stop' state
1967 * bits and only when the state was 'in road stop', otherwise
1968 * we'll end up clearing the turn around bits. */
1969 RoadVehicle *rv = RoadVehicle::From(v);
1970 if (HasBit(rv->state, RVS_IN_DT_ROAD_STOP)) rv->state &= RVSB_ROAD_STOP_TRACKDIR_MASK;
1973 return nullptr;
1978 * Remove a bus station/truck stop
1979 * @param tile TileIndex been queried
1980 * @param flags operation to perform
1981 * @return cost or failure of operation
1983 static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlag flags)
1985 Station *st = Station::GetByTile(tile);
1987 if (_current_company != OWNER_WATER) {
1988 CommandCost ret = CheckOwnership(st->owner);
1989 if (ret.Failed()) return ret;
1992 bool is_truck = IsTruckStop(tile);
1994 RoadStop **primary_stop;
1995 RoadStop *cur_stop;
1996 if (is_truck) { // truck stop
1997 primary_stop = &st->truck_stops;
1998 cur_stop = RoadStop::GetByTile(tile, ROADSTOP_TRUCK);
1999 } else {
2000 primary_stop = &st->bus_stops;
2001 cur_stop = RoadStop::GetByTile(tile, ROADSTOP_BUS);
2004 assert(cur_stop != nullptr);
2006 /* don't do the check for drive-through road stops when company bankrupts */
2007 if (IsDriveThroughStopTile(tile) && (flags & DC_BANKRUPT)) {
2008 /* remove the 'going through road stop' status from all vehicles on that tile */
2009 if (flags & DC_EXEC) FindVehicleOnPos(tile, nullptr, &ClearRoadStopStatusEnum);
2010 } else {
2011 CommandCost ret = EnsureNoVehicleOnGround(tile);
2012 if (ret.Failed()) return ret;
2015 if (flags & DC_EXEC) {
2016 if (*primary_stop == cur_stop) {
2017 /* removed the first stop in the list */
2018 *primary_stop = cur_stop->next;
2019 /* removed the only stop? */
2020 if (*primary_stop == nullptr) {
2021 st->facilities &= (is_truck ? ~FACIL_TRUCK_STOP : ~FACIL_BUS_STOP);
2023 } else {
2024 /* tell the predecessor in the list to skip this stop */
2025 RoadStop *pred = *primary_stop;
2026 while (pred->next != cur_stop) pred = pred->next;
2027 pred->next = cur_stop->next;
2030 /* Update company infrastructure counts. */
2031 FOR_ALL_ROADTRAMTYPES(rtt) {
2032 RoadType rt = GetRoadType(tile, rtt);
2033 UpdateCompanyRoadInfrastructure(rt, GetRoadOwner(tile, rtt), -2);
2036 Company::Get(st->owner)->infrastructure.station--;
2037 DirtyCompanyInfrastructureWindows(st->owner);
2039 if (IsDriveThroughStopTile(tile)) {
2040 /* Clears the tile for us */
2041 cur_stop->ClearDriveThrough();
2042 } else {
2043 DoClearSquare(tile);
2046 delete cur_stop;
2048 /* Make sure no vehicle is going to the old roadstop */
2049 for (RoadVehicle *v : RoadVehicle::Iterate()) {
2050 if (v->First() == v && v->current_order.IsType(OT_GOTO_STATION) &&
2051 v->dest_tile == tile) {
2052 v->SetDestTile(v->GetOrderStationLocation(st->index));
2056 st->rect.AfterRemoveTile(st, tile);
2058 st->AfterStationTileSetChange(false, is_truck ? STATION_TRUCK: STATION_BUS);
2060 /* Update the tile area of the truck/bus stop */
2061 if (is_truck) {
2062 st->truck_station.Clear();
2063 for (const RoadStop *rs = st->truck_stops; rs != nullptr; rs = rs->next) st->truck_station.Add(rs->xy);
2064 } else {
2065 st->bus_station.Clear();
2066 for (const RoadStop *rs = st->bus_stops; rs != nullptr; rs = rs->next) st->bus_station.Add(rs->xy);
2070 return CommandCost(EXPENSES_CONSTRUCTION, _price[is_truck ? PR_CLEAR_STATION_TRUCK : PR_CLEAR_STATION_BUS]);
2074 * Remove bus or truck stops.
2075 * @param tile Northernmost tile of the removal area.
2076 * @param flags Operation to perform.
2077 * @param p1 bit 0..7: Width of the removal area.
2078 * bit 8..15: Height of the removal area.
2079 * @param p2 bit 0: 0 For bus stops, 1 for truck stops.
2080 * @param p2 bit 1: 0 to keep roads of all drive-through stops, 1 to remove them.
2081 * @param text Unused.
2082 * @return The cost of this operation or an error.
2084 CommandCost CmdRemoveRoadStop(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2086 uint8 width = (uint8)GB(p1, 0, 8);
2087 uint8 height = (uint8)GB(p1, 8, 8);
2088 bool keep_drive_through_roads = !HasBit(p2, 1);
2090 /* Check for incorrect width / height. */
2091 if (width == 0 || height == 0) return CMD_ERROR;
2092 /* Check if the first tile and the last tile are valid */
2093 if (!IsValidTile(tile) || TileAddWrap(tile, width - 1, height - 1) == INVALID_TILE) return CMD_ERROR;
2094 /* Bankrupting company is not supposed to remove roads, there may be road vehicles. */
2095 if (!keep_drive_through_roads && (flags & DC_BANKRUPT)) return CMD_ERROR;
2097 TileArea roadstop_area(tile, width, height);
2099 CommandCost cost(EXPENSES_CONSTRUCTION);
2100 CommandCost last_error(STR_ERROR_THERE_IS_NO_STATION);
2101 bool had_success = false;
2103 TILE_AREA_LOOP(cur_tile, roadstop_area) {
2104 /* Make sure the specified tile is a road stop of the correct type */
2105 if (!IsTileType(cur_tile, MP_STATION) || !IsRoadStop(cur_tile) || (uint32)GetRoadStopType(cur_tile) != GB(p2, 0, 1)) continue;
2107 /* Save information on to-be-restored roads before the stop is removed. */
2108 RoadBits road_bits = ROAD_NONE;
2109 RoadType road_type[] = { INVALID_ROADTYPE, INVALID_ROADTYPE };
2110 Owner road_owner[] = { OWNER_NONE, OWNER_NONE };
2111 if (IsDriveThroughStopTile(cur_tile)) {
2112 FOR_ALL_ROADTRAMTYPES(rtt) {
2113 road_type[rtt] = GetRoadType(cur_tile, rtt);
2114 if (road_type[rtt] == INVALID_ROADTYPE) continue;
2115 road_owner[rtt] = GetRoadOwner(cur_tile, rtt);
2116 /* If we don't want to preserve our roads then restore only roads of others. */
2117 if (!keep_drive_through_roads && road_owner[rtt] == _current_company) road_type[rtt] = INVALID_ROADTYPE;
2119 road_bits = AxisToRoadBits(DiagDirToAxis(GetRoadStopDir(cur_tile)));
2122 CommandCost ret = RemoveRoadStop(cur_tile, flags);
2123 if (ret.Failed()) {
2124 last_error = ret;
2125 continue;
2127 cost.AddCost(ret);
2128 had_success = true;
2130 /* Restore roads. */
2131 if ((flags & DC_EXEC) && (road_type[RTT_ROAD] != INVALID_ROADTYPE || road_type[RTT_TRAM] != INVALID_ROADTYPE)) {
2132 MakeRoadNormal(cur_tile, road_bits, road_type[RTT_ROAD], road_type[RTT_TRAM], ClosestTownFromTile(cur_tile, UINT_MAX)->index,
2133 road_owner[RTT_ROAD], road_owner[RTT_TRAM]);
2135 /* Update company infrastructure counts. */
2136 int count = CountBits(road_bits);
2137 UpdateCompanyRoadInfrastructure(road_type[RTT_ROAD], road_owner[RTT_ROAD], count);
2138 UpdateCompanyRoadInfrastructure(road_type[RTT_TRAM], road_owner[RTT_TRAM], count);
2142 return had_success ? cost : last_error;
2146 * Get a possible noise reduction factor based on distance from town center.
2147 * The further you get, the less noise you generate.
2148 * So all those folks at city council can now happily slee... work in their offices
2149 * @param as airport information
2150 * @param distance minimum distance between town and airport
2151 * @return the noise that will be generated, according to distance
2153 uint8 GetAirportNoiseLevelForDistance(const AirportSpec *as, uint distance)
2155 /* 0 cannot be accounted, and 1 is the lowest that can be reduced from town.
2156 * So no need to go any further*/
2157 if (as->noise_level < 2) return as->noise_level;
2159 /* The steps for measuring noise reduction are based on the "magical" (and arbitrary) 8 base distance
2160 * adding the town_council_tolerance 4 times, as a way to graduate, depending of the tolerance.
2161 * Basically, it says that the less tolerant a town is, the bigger the distance before
2162 * an actual decrease can be granted */
2163 uint8 town_tolerance_distance = 8 + (_settings_game.difficulty.town_council_tolerance * 4);
2165 /* now, we want to have the distance segmented using the distance judged bareable by town
2166 * This will give us the coefficient of reduction the distance provides. */
2167 uint noise_reduction = distance / town_tolerance_distance;
2169 /* If the noise reduction equals the airport noise itself, don't give it for free.
2170 * Otherwise, simply reduce the airport's level. */
2171 return noise_reduction >= as->noise_level ? 1 : as->noise_level - noise_reduction;
2175 * Finds the town nearest to given airport. Based on minimal manhattan distance to any airport's tile.
2176 * If two towns have the same distance, town with lower index is returned.
2177 * @param as airport's description
2178 * @param it An iterator over all airport tiles
2179 * @param[out] mindist Minimum distance to town
2180 * @return nearest town to airport
2182 Town *AirportGetNearestTown(const AirportSpec *as, const TileIterator &it, uint &mindist)
2184 assert(Town::GetNumItems() > 0);
2186 Town *nearest = nullptr;
2188 uint perimeter_min_x = TileX(it);
2189 uint perimeter_min_y = TileY(it);
2190 uint perimeter_max_x = perimeter_min_x + as->size_x - 1;
2191 uint perimeter_max_y = perimeter_min_y + as->size_y - 1;
2193 mindist = UINT_MAX - 1; // prevent overflow
2195 std::unique_ptr<TileIterator> copy(it.Clone());
2196 for (TileIndex cur_tile = *copy; cur_tile != INVALID_TILE; cur_tile = ++*copy) {
2197 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) {
2198 Town *t = CalcClosestTownFromTile(cur_tile, mindist + 1);
2199 if (t == nullptr) continue;
2201 uint dist = DistanceManhattan(t->xy, cur_tile);
2202 if (dist == mindist && t->index < nearest->index) nearest = t;
2203 if (dist < mindist) {
2204 nearest = t;
2205 mindist = dist;
2210 return nearest;
2214 /** Recalculate the noise generated by the airports of each town */
2215 void UpdateAirportsNoise()
2217 for (Town *t : Town::Iterate()) t->noise_reached = 0;
2219 for (const Station *st : Station::Iterate()) {
2220 if (st->airport.tile != INVALID_TILE && st->airport.type != AT_OILRIG) {
2221 const AirportSpec *as = st->airport.GetSpec();
2222 AirportTileIterator it(st);
2223 uint dist;
2224 Town *nearest = AirportGetNearestTown(as, it, dist);
2225 nearest->noise_reached += GetAirportNoiseLevelForDistance(as, dist);
2231 * Place an Airport.
2232 * @param tile tile where airport will be built
2233 * @param flags operation to perform
2234 * @param p1
2235 * - p1 = (bit 0- 7) - airport type, @see airport.h
2236 * - p1 = (bit 8-15) - airport layout
2237 * @param p2 various bitstuffed elements
2238 * - p2 = (bit 0) - allow airports directly adjacent to other airports.
2239 * - p2 = (bit 16-31) - station ID to join (NEW_STATION if build new one)
2240 * @param text unused
2241 * @return the cost of this operation or an error
2243 CommandCost CmdBuildAirport(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2245 StationID station_to_join = GB(p2, 16, 16);
2246 bool reuse = (station_to_join != NEW_STATION);
2247 if (!reuse) station_to_join = INVALID_STATION;
2248 bool distant_join = (station_to_join != INVALID_STATION);
2249 byte airport_type = GB(p1, 0, 8);
2250 byte layout = GB(p1, 8, 8);
2252 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2254 if (airport_type >= NUM_AIRPORTS) return CMD_ERROR;
2256 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile, flags);
2257 if (ret.Failed()) return ret;
2259 /* Check if a valid, buildable airport was chosen for construction */
2260 const AirportSpec *as = AirportSpec::Get(airport_type);
2261 if (!as->IsAvailable() || layout >= as->num_table) return CMD_ERROR;
2262 if (!as->IsWithinMapBounds(layout, tile)) return CMD_ERROR;
2264 Direction rotation = as->rotation[layout];
2265 int w = as->size_x;
2266 int h = as->size_y;
2267 if (rotation == DIR_E || rotation == DIR_W) Swap(w, h);
2268 TileArea airport_area = TileArea(tile, w, h);
2270 if (w > _settings_game.station.station_spread || h > _settings_game.station.station_spread) {
2271 return_cmd_error(STR_ERROR_STATION_TOO_SPREAD_OUT);
2274 AirportTileTableIterator iter(as->table[layout], tile);
2275 CommandCost cost = CheckFlatLandAirport(iter, flags);
2276 if (cost.Failed()) return cost;
2278 /* The noise level is the noise from the airport and reduce it to account for the distance to the town center. */
2279 uint dist;
2280 Town *nearest = AirportGetNearestTown(as, iter, dist);
2281 uint newnoise_level = GetAirportNoiseLevelForDistance(as, dist);
2283 /* Check if local auth would allow a new airport */
2284 StringID authority_refuse_message = STR_NULL;
2285 Town *authority_refuse_town = nullptr;
2287 if (_settings_game.economy.station_noise_level) {
2288 /* do not allow to build a new airport if this raise the town noise over the maximum allowed by town */
2289 if ((nearest->noise_reached + newnoise_level) > nearest->MaxTownNoise()) {
2290 authority_refuse_message = STR_ERROR_LOCAL_AUTHORITY_REFUSES_NOISE;
2291 authority_refuse_town = nearest;
2293 } else {
2294 Town *t = ClosestTownFromTile(tile, UINT_MAX);
2295 uint num = 0;
2296 for (const Station *st : Station::Iterate()) {
2297 if (st->town == t && (st->facilities & FACIL_AIRPORT) && st->airport.type != AT_OILRIG) num++;
2299 if (num >= 2) {
2300 authority_refuse_message = STR_ERROR_LOCAL_AUTHORITY_REFUSES_AIRPORT;
2301 authority_refuse_town = t;
2305 if (authority_refuse_message != STR_NULL) {
2306 SetDParam(0, authority_refuse_town->index);
2307 return_cmd_error(authority_refuse_message);
2310 Station *st = nullptr;
2311 ret = FindJoiningStation(INVALID_STATION, station_to_join, HasBit(p2, 0), airport_area, &st);
2312 if (ret.Failed()) return ret;
2314 /* Distant join */
2315 if (st == nullptr && distant_join) st = Station::GetIfValid(station_to_join);
2317 ret = BuildStationPart(&st, flags, reuse, airport_area, (GetAirport(airport_type)->flags & AirportFTAClass::AIRPLANES) ? STATIONNAMING_AIRPORT : STATIONNAMING_HELIPORT);
2318 if (ret.Failed()) return ret;
2320 if (st != nullptr && st->airport.tile != INVALID_TILE) {
2321 return_cmd_error(STR_ERROR_TOO_CLOSE_TO_ANOTHER_AIRPORT);
2324 for (AirportTileTableIterator iter(as->table[layout], tile); iter != INVALID_TILE; ++iter) {
2325 cost.AddCost(_price[PR_BUILD_STATION_AIRPORT]);
2328 if (flags & DC_EXEC) {
2329 /* Always add the noise, so there will be no need to recalculate when option toggles */
2330 nearest->noise_reached += newnoise_level;
2332 st->AddFacility(FACIL_AIRPORT, tile);
2333 st->airport.type = airport_type;
2334 st->airport.layout = layout;
2335 st->airport.flags = 0;
2336 st->airport.rotation = rotation;
2338 st->rect.BeforeAddRect(tile, w, h, StationRect::ADD_TRY);
2340 for (AirportTileTableIterator iter(as->table[layout], tile); iter != INVALID_TILE; ++iter) {
2341 MakeAirport(iter, st->owner, st->index, iter.GetStationGfx(), WATER_CLASS_INVALID);
2342 SetStationTileRandomBits(iter, GB(Random(), 0, 4));
2343 st->airport.Add(iter);
2345 if (AirportTileSpec::Get(GetTranslatedAirportTileID(iter.GetStationGfx()))->animation.status != ANIM_STATUS_NO_ANIMATION) AddAnimatedTile(iter);
2348 /* Only call the animation trigger after all tiles have been built */
2349 for (AirportTileTableIterator iter(as->table[layout], tile); iter != INVALID_TILE; ++iter) {
2350 AirportTileAnimationTrigger(st, iter, AAT_BUILT);
2353 UpdateAirplanesOnNewStation(st);
2355 Company::Get(st->owner)->infrastructure.airport++;
2357 st->AfterStationTileSetChange(true, STATION_AIRPORT);
2358 InvalidateWindowData(WC_STATION_VIEW, st->index, -1);
2360 if (_settings_game.economy.station_noise_level) {
2361 SetWindowDirty(WC_TOWN_VIEW, st->town->index);
2365 return cost;
2369 * Remove an airport
2370 * @param tile TileIndex been queried
2371 * @param flags operation to perform
2372 * @return cost or failure of operation
2374 static CommandCost RemoveAirport(TileIndex tile, DoCommandFlag flags)
2376 Station *st = Station::GetByTile(tile);
2378 if (_current_company != OWNER_WATER) {
2379 CommandCost ret = CheckOwnership(st->owner);
2380 if (ret.Failed()) return ret;
2383 tile = st->airport.tile;
2385 CommandCost cost(EXPENSES_CONSTRUCTION);
2387 for (const Aircraft *a : Aircraft::Iterate()) {
2388 if (!a->IsNormalAircraft()) continue;
2389 if (a->targetairport == st->index && a->state != FLYING) {
2390 return_cmd_error(STR_ERROR_AIRCRAFT_IN_THE_WAY);
2394 if (flags & DC_EXEC) {
2395 const AirportSpec *as = st->airport.GetSpec();
2396 /* The noise level is the noise from the airport and reduce it to account for the distance to the town center.
2397 * And as for construction, always remove it, even if the setting is not set, in order to avoid the
2398 * need of recalculation */
2399 AirportTileIterator it(st);
2400 uint dist;
2401 Town *nearest = AirportGetNearestTown(as, it, dist);
2402 nearest->noise_reached -= GetAirportNoiseLevelForDistance(as, dist);
2405 TILE_AREA_LOOP(tile_cur, st->airport) {
2406 if (!st->TileBelongsToAirport(tile_cur)) continue;
2408 CommandCost ret = EnsureNoVehicleOnGround(tile_cur);
2409 if (ret.Failed()) return ret;
2411 cost.AddCost(_price[PR_CLEAR_STATION_AIRPORT]);
2413 if (flags & DC_EXEC) {
2414 if (IsHangarTile(tile_cur)) OrderBackup::Reset(tile_cur, false);
2415 DeleteAnimatedTile(tile_cur);
2416 DoClearSquare(tile_cur);
2417 DeleteNewGRFInspectWindow(GSF_AIRPORTTILES, tile_cur);
2421 if (flags & DC_EXEC) {
2422 /* Clear the persistent storage. */
2423 delete st->airport.psa;
2425 for (uint i = 0; i < st->airport.GetNumHangars(); ++i) {
2426 DeleteWindowById(
2427 WC_VEHICLE_DEPOT, st->airport.GetHangarTile(i)
2431 st->rect.AfterRemoveRect(st, st->airport);
2433 st->airport.Clear();
2434 st->facilities &= ~FACIL_AIRPORT;
2436 InvalidateWindowData(WC_STATION_VIEW, st->index, -1);
2438 if (_settings_game.economy.station_noise_level) {
2439 SetWindowDirty(WC_TOWN_VIEW, st->town->index);
2442 Company::Get(st->owner)->infrastructure.airport--;
2444 st->AfterStationTileSetChange(false, STATION_AIRPORT);
2446 DeleteNewGRFInspectWindow(GSF_AIRPORTS, st->index);
2449 return cost;
2453 * Open/close an airport to incoming aircraft.
2454 * @param tile Unused.
2455 * @param flags Operation to perform.
2456 * @param p1 Station ID of the airport.
2457 * @param p2 Unused.
2458 * @param text unused
2459 * @return the cost of this operation or an error
2461 CommandCost CmdOpenCloseAirport(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2463 if (!Station::IsValidID(p1)) return CMD_ERROR;
2464 Station *st = Station::Get(p1);
2466 if (!(st->facilities & FACIL_AIRPORT) || st->owner == OWNER_NONE) return CMD_ERROR;
2468 CommandCost ret = CheckOwnership(st->owner);
2469 if (ret.Failed()) return ret;
2471 if (flags & DC_EXEC) {
2472 st->airport.flags ^= AIRPORT_CLOSED_block;
2473 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_CLOSE_AIRPORT);
2475 return CommandCost();
2479 * Tests whether the company's vehicles have this station in orders
2480 * @param station station ID
2481 * @param include_company If true only check vehicles of \a company, if false only check vehicles of other companies
2482 * @param company company ID
2484 bool HasStationInUse(StationID station, bool include_company, CompanyID company)
2486 for (const Vehicle *v : Vehicle::Iterate()) {
2487 if ((v->owner == company) == include_company) {
2488 const Order *order;
2489 FOR_VEHICLE_ORDERS(v, order) {
2490 if ((order->IsType(OT_GOTO_STATION) || order->IsType(OT_GOTO_WAYPOINT)) && order->GetDestination() == station) {
2491 return true;
2496 return false;
2499 static const TileIndexDiffC _dock_tileoffs_chkaround[] = {
2500 {-1, 0},
2501 { 0, 0},
2502 { 0, 0},
2503 { 0, -1}
2505 static const byte _dock_w_chk[4] = { 2, 1, 2, 1 };
2506 static const byte _dock_h_chk[4] = { 1, 2, 1, 2 };
2509 * Build a dock/haven.
2510 * @param tile tile where dock will be built
2511 * @param flags operation to perform
2512 * @param p1 (bit 0) - allow docks directly adjacent to other docks.
2513 * @param p2 bit 16-31: station ID to join (NEW_STATION if build new one)
2514 * @param text unused
2515 * @return the cost of this operation or an error
2517 CommandCost CmdBuildDock(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2519 StationID station_to_join = GB(p2, 16, 16);
2520 bool reuse = (station_to_join != NEW_STATION);
2521 if (!reuse) station_to_join = INVALID_STATION;
2522 bool distant_join = (station_to_join != INVALID_STATION);
2524 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2526 DiagDirection direction = GetInclinedSlopeDirection(GetTileSlope(tile));
2527 if (direction == INVALID_DIAGDIR) return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
2528 direction = ReverseDiagDir(direction);
2530 /* Docks cannot be placed on rapids */
2531 if (HasTileWaterGround(tile)) return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
2533 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile, flags);
2534 if (ret.Failed()) return ret;
2536 if (IsBridgeAbove(tile)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
2538 ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
2539 if (ret.Failed()) return ret;
2541 TileIndex tile_cur = tile + TileOffsByDiagDir(direction);
2543 if (!IsTileType(tile_cur, MP_WATER) || !IsTileFlat(tile_cur)) {
2544 return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
2547 if (IsBridgeAbove(tile_cur)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
2549 /* Get the water class of the water tile before it is cleared.*/
2550 WaterClass wc = GetWaterClass(tile_cur);
2552 ret = DoCommand(tile_cur, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
2553 if (ret.Failed()) return ret;
2555 tile_cur += TileOffsByDiagDir(direction);
2556 if (!IsTileType(tile_cur, MP_WATER) || !IsTileFlat(tile_cur)) {
2557 return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
2560 TileArea dock_area = TileArea(tile + ToTileIndexDiff(_dock_tileoffs_chkaround[direction]),
2561 _dock_w_chk[direction], _dock_h_chk[direction]);
2563 /* middle */
2564 Station *st = nullptr;
2565 ret = FindJoiningStation(INVALID_STATION, station_to_join, HasBit(p1, 0), dock_area, &st);
2566 if (ret.Failed()) return ret;
2568 /* Distant join */
2569 if (st == nullptr && distant_join) st = Station::GetIfValid(station_to_join);
2571 ret = BuildStationPart(&st, flags, reuse, dock_area, STATIONNAMING_DOCK);
2572 if (ret.Failed()) return ret;
2574 if (flags & DC_EXEC) {
2575 st->ship_station.Add(tile);
2576 st->ship_station.Add(tile + TileOffsByDiagDir(direction));
2577 st->AddFacility(FACIL_DOCK, tile);
2579 st->rect.BeforeAddRect(dock_area.tile, dock_area.w, dock_area.h, StationRect::ADD_TRY);
2581 /* If the water part of the dock is on a canal, update infrastructure counts.
2582 * This is needed as we've unconditionally cleared that tile before. */
2583 if (wc == WATER_CLASS_CANAL) {
2584 Company::Get(st->owner)->infrastructure.water++;
2586 Company::Get(st->owner)->infrastructure.station += 2;
2588 MakeDock(tile, st->owner, st->index, direction, wc);
2589 UpdateStationDockingTiles(st);
2591 st->AfterStationTileSetChange(true, STATION_DOCK);
2594 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_STATION_DOCK]);
2597 void RemoveDockingTile(TileIndex t)
2599 for (DiagDirection d = DIAGDIR_BEGIN; d != DIAGDIR_END; d++) {
2600 TileIndex tile = t + TileOffsByDiagDir(d);
2601 if (!IsValidTile(tile)) continue;
2603 if (IsTileType(tile, MP_STATION)) {
2604 Station *st = Station::GetByTile(tile);
2605 if (st != nullptr) UpdateStationDockingTiles(st);
2606 } else if (IsTileType(tile, MP_INDUSTRY)) {
2607 Station *neutral = Industry::GetByTile(tile)->neutral_station;
2608 if (neutral != nullptr) UpdateStationDockingTiles(neutral);
2614 * Clear docking tile status from tiles around a removed dock, if the tile has
2615 * no neighbours which would keep it as a docking tile.
2616 * @param tile Ex-dock tile to check.
2618 void ClearDockingTilesCheckingNeighbours(TileIndex tile)
2620 assert(IsValidTile(tile));
2622 /* Clear and maybe re-set docking tile */
2623 for (DiagDirection d = DIAGDIR_BEGIN; d != DIAGDIR_END; d++) {
2624 TileIndex docking_tile = tile + TileOffsByDiagDir(d);
2625 if (!IsValidTile(docking_tile)) continue;
2627 if (IsPossibleDockingTile(docking_tile)) {
2628 SetDockingTile(docking_tile, false);
2629 CheckForDockingTile(docking_tile);
2635 * Check if a dock tile can be docked from the given direction.
2636 * @param t Tile index of dock.
2637 * @param d DiagDirection adjacent to dock being tested.
2638 * @return True iff the dock can be docked from the given direction.
2640 bool IsValidDockingDirectionForDock(TileIndex t, DiagDirection d)
2642 assert(IsDockTile(t));
2644 /** Bitmap of valid directions for each dock tile part. */
2645 static const uint8 _valid_docking_tile[] = {
2646 0, 0, 0, 0, // No docking against the slope part.
2647 1 << DIAGDIR_NE | 1 << DIAGDIR_SW, // Docking permitted at the end
2648 1 << DIAGDIR_NW | 1 << DIAGDIR_SE, // of the flat piers.
2651 StationGfx gfx = GetStationGfx(t);
2652 assert(gfx < lengthof(_valid_docking_tile));
2653 return HasBit(_valid_docking_tile[gfx], d);
2657 * Find the part of a dock that is land-based
2658 * @param t Dock tile to find land part of
2659 * @return tile of land part of dock
2661 static TileIndex FindDockLandPart(TileIndex t)
2663 assert(IsDockTile(t));
2665 StationGfx gfx = GetStationGfx(t);
2666 if (gfx < GFX_DOCK_BASE_WATER_PART) return t;
2668 for (DiagDirection d = DIAGDIR_BEGIN; d != DIAGDIR_END; d++) {
2669 TileIndex tile = t + TileOffsByDiagDir(d);
2670 if (!IsValidTile(tile)) continue;
2671 if (!IsDockTile(tile)) continue;
2672 if (GetStationGfx(tile) < GFX_DOCK_BASE_WATER_PART && tile + TileOffsByDiagDir(GetDockDirection(tile)) == t) return tile;
2675 return INVALID_TILE;
2679 * Remove a dock
2680 * @param tile TileIndex been queried
2681 * @param flags operation to perform
2682 * @return cost or failure of operation
2684 static CommandCost RemoveDock(TileIndex tile, DoCommandFlag flags)
2686 Station *st = Station::GetByTile(tile);
2687 CommandCost ret = CheckOwnership(st->owner);
2688 if (ret.Failed()) return ret;
2690 if (!IsDockTile(tile)) return CMD_ERROR;
2692 TileIndex tile1 = FindDockLandPart(tile);
2693 if (tile1 == INVALID_TILE) return CMD_ERROR;
2694 TileIndex tile2 = tile1 + TileOffsByDiagDir(GetDockDirection(tile1));
2696 ret = EnsureNoVehicleOnGround(tile1);
2697 if (ret.Succeeded()) ret = EnsureNoVehicleOnGround(tile2);
2698 if (ret.Failed()) return ret;
2700 if (flags & DC_EXEC) {
2701 DoClearSquare(tile1);
2702 MarkTileDirtyByTile(tile1);
2703 MakeWaterKeepingClass(tile2, st->owner);
2705 st->rect.AfterRemoveTile(st, tile1);
2706 st->rect.AfterRemoveTile(st, tile2);
2708 MakeShipStationAreaSmaller(st);
2709 if (st->ship_station.tile == INVALID_TILE) {
2710 st->ship_station.Clear();
2711 st->docking_station.Clear();
2712 st->facilities &= ~FACIL_DOCK;
2715 Company::Get(st->owner)->infrastructure.station -= 2;
2717 st->AfterStationTileSetChange(false, STATION_DOCK);
2719 ClearDockingTilesCheckingNeighbours(tile1);
2720 ClearDockingTilesCheckingNeighbours(tile2);
2722 /* All ships that were going to our station, can't go to it anymore.
2723 * Just clear the order, then automatically the next appropriate order
2724 * will be selected and in case of no appropriate order it will just
2725 * wander around the world. */
2726 if (!(st->facilities & FACIL_DOCK)) {
2727 for (Ship *s : Ship::Iterate()) {
2728 if (s->current_order.IsType(OT_LOADING) && s->current_order.GetDestination() == st->index) {
2729 s->LeaveStation();
2732 if (s->current_order.IsType(OT_GOTO_STATION) && s->current_order.GetDestination() == st->index) {
2733 s->SetDestTile(s->GetOrderStationLocation(st->index));
2739 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_CLEAR_STATION_DOCK]);
2742 #include "table/station_land.h"
2744 const DrawTileSprites *GetStationTileLayout(StationType st, byte gfx)
2746 return &_station_display_datas[st][gfx];
2750 * Check whether a sprite is a track sprite, which can be replaced by a non-track ground sprite and a rail overlay.
2751 * If the ground sprite is suitable, \a ground is replaced with the new non-track ground sprite, and \a overlay_offset
2752 * is set to the overlay to draw.
2753 * @param ti Positional info for the tile to decide snowyness etc. May be nullptr.
2754 * @param[in,out] ground Groundsprite to draw.
2755 * @param[out] overlay_offset Overlay to draw.
2756 * @return true if overlay can be drawn.
2758 bool SplitGroundSpriteForOverlay(const TileInfo *ti, SpriteID *ground, RailTrackOffset *overlay_offset)
2760 bool snow_desert;
2761 switch (*ground) {
2762 case SPR_RAIL_TRACK_X:
2763 case SPR_MONO_TRACK_X:
2764 case SPR_MGLV_TRACK_X:
2765 snow_desert = false;
2766 *overlay_offset = RTO_X;
2767 break;
2769 case SPR_RAIL_TRACK_Y:
2770 case SPR_MONO_TRACK_Y:
2771 case SPR_MGLV_TRACK_Y:
2772 snow_desert = false;
2773 *overlay_offset = RTO_Y;
2774 break;
2776 case SPR_RAIL_TRACK_X_SNOW:
2777 case SPR_MONO_TRACK_X_SNOW:
2778 case SPR_MGLV_TRACK_X_SNOW:
2779 snow_desert = true;
2780 *overlay_offset = RTO_X;
2781 break;
2783 case SPR_RAIL_TRACK_Y_SNOW:
2784 case SPR_MONO_TRACK_Y_SNOW:
2785 case SPR_MGLV_TRACK_Y_SNOW:
2786 snow_desert = true;
2787 *overlay_offset = RTO_Y;
2788 break;
2790 default:
2791 return false;
2794 if (ti != nullptr) {
2795 /* Decide snow/desert from tile */
2796 switch (_settings_game.game_creation.landscape) {
2797 case LT_ARCTIC:
2798 snow_desert = (uint)ti->z > GetSnowLine() * TILE_HEIGHT;
2799 break;
2801 case LT_TROPIC:
2802 snow_desert = GetTropicZone(ti->tile) == TROPICZONE_DESERT;
2803 break;
2805 default:
2806 break;
2810 *ground = snow_desert ? SPR_FLAT_SNOW_DESERT_TILE : SPR_FLAT_GRASS_TILE;
2811 return true;
2814 static void DrawTile_Station(TileInfo *ti)
2816 const NewGRFSpriteLayout *layout = nullptr;
2817 DrawTileSprites tmp_rail_layout;
2818 const DrawTileSprites *t = nullptr;
2819 int32 total_offset;
2820 const RailtypeInfo *rti = nullptr;
2821 uint32 relocation = 0;
2822 uint32 ground_relocation = 0;
2823 BaseStation *st = nullptr;
2824 const StationSpec *statspec = nullptr;
2825 uint tile_layout = 0;
2827 if (HasStationRail(ti->tile)) {
2828 rti = GetRailTypeInfo(GetRailType(ti->tile));
2829 total_offset = rti->GetRailtypeSpriteOffset();
2831 if (IsCustomStationSpecIndex(ti->tile)) {
2832 /* look for customization */
2833 st = BaseStation::GetByTile(ti->tile);
2834 statspec = st->speclist[GetCustomStationSpecIndex(ti->tile)].spec;
2836 if (statspec != nullptr) {
2837 tile_layout = GetStationGfx(ti->tile);
2839 if (HasBit(statspec->callback_mask, CBM_STATION_SPRITE_LAYOUT)) {
2840 uint16 callback = GetStationCallback(CBID_STATION_SPRITE_LAYOUT, 0, 0, statspec, st, ti->tile);
2841 if (callback != CALLBACK_FAILED) tile_layout = (callback & ~1) + GetRailStationAxis(ti->tile);
2844 /* Ensure the chosen tile layout is valid for this custom station */
2845 if (statspec->renderdata != nullptr) {
2846 layout = &statspec->renderdata[tile_layout < statspec->tiles ? tile_layout : (uint)GetRailStationAxis(ti->tile)];
2847 if (!layout->NeedsPreprocessing()) {
2848 t = layout;
2849 layout = nullptr;
2854 } else {
2855 total_offset = 0;
2858 StationGfx gfx = GetStationGfx(ti->tile);
2859 if (IsAirport(ti->tile)) {
2860 gfx = GetAirportGfx(ti->tile);
2861 if (gfx >= NEW_AIRPORTTILE_OFFSET) {
2862 const AirportTileSpec *ats = AirportTileSpec::Get(gfx);
2863 if (ats->grf_prop.spritegroup[0] != nullptr && DrawNewAirportTile(ti, Station::GetByTile(ti->tile), gfx, ats)) {
2864 return;
2866 /* No sprite group (or no valid one) found, meaning no graphics associated.
2867 * Use the substitute one instead */
2868 assert(ats->grf_prop.subst_id != INVALID_AIRPORTTILE);
2869 gfx = ats->grf_prop.subst_id;
2871 switch (gfx) {
2872 case APT_RADAR_GRASS_FENCE_SW:
2873 t = &_station_display_datas_airport_radar_grass_fence_sw[GetAnimationFrame(ti->tile)];
2874 break;
2875 case APT_GRASS_FENCE_NE_FLAG:
2876 t = &_station_display_datas_airport_flag_grass_fence_ne[GetAnimationFrame(ti->tile)];
2877 break;
2878 case APT_RADAR_FENCE_SW:
2879 t = &_station_display_datas_airport_radar_fence_sw[GetAnimationFrame(ti->tile)];
2880 break;
2881 case APT_RADAR_FENCE_NE:
2882 t = &_station_display_datas_airport_radar_fence_ne[GetAnimationFrame(ti->tile)];
2883 break;
2884 case APT_GRASS_FENCE_NE_FLAG_2:
2885 t = &_station_display_datas_airport_flag_grass_fence_ne_2[GetAnimationFrame(ti->tile)];
2886 break;
2890 Owner owner = GetTileOwner(ti->tile);
2892 PaletteID palette;
2893 if (Company::IsValidID(owner)) {
2894 palette = COMPANY_SPRITE_COLOUR(owner);
2895 } else {
2896 /* Some stations are not owner by a company, namely oil rigs */
2897 palette = PALETTE_TO_GREY;
2900 if (layout == nullptr && (t == nullptr || t->seq == nullptr)) t = GetStationTileLayout(GetStationType(ti->tile), gfx);
2902 /* don't show foundation for docks */
2903 if (ti->tileh != SLOPE_FLAT && !IsDock(ti->tile)) {
2904 if (statspec != nullptr && HasBit(statspec->flags, SSF_CUSTOM_FOUNDATIONS)) {
2905 /* Station has custom foundations.
2906 * Check whether the foundation continues beyond the tile's upper sides. */
2907 uint edge_info = 0;
2908 int z;
2909 Slope slope = GetFoundationPixelSlope(ti->tile, &z);
2910 if (!HasFoundationNW(ti->tile, slope, z)) SetBit(edge_info, 0);
2911 if (!HasFoundationNE(ti->tile, slope, z)) SetBit(edge_info, 1);
2912 SpriteID image = GetCustomStationFoundationRelocation(statspec, st, ti->tile, tile_layout, edge_info);
2913 if (image == 0) goto draw_default_foundation;
2915 if (HasBit(statspec->flags, SSF_EXTENDED_FOUNDATIONS)) {
2916 /* Station provides extended foundations. */
2918 static const uint8 foundation_parts[] = {
2919 0, 0, 0, 0, // Invalid, Invalid, Invalid, SLOPE_SW
2920 0, 1, 2, 3, // Invalid, SLOPE_EW, SLOPE_SE, SLOPE_WSE
2921 0, 4, 5, 6, // Invalid, SLOPE_NW, SLOPE_NS, SLOPE_NWS
2922 7, 8, 9 // SLOPE_NE, SLOPE_ENW, SLOPE_SEN
2925 AddSortableSpriteToDraw(image + foundation_parts[ti->tileh], PAL_NONE, ti->x, ti->y, 16, 16, 7, ti->z);
2926 } else {
2927 /* Draw simple foundations, built up from 8 possible foundation sprites. */
2929 /* Each set bit represents one of the eight composite sprites to be drawn.
2930 * 'Invalid' entries will not drawn but are included for completeness. */
2931 static const uint8 composite_foundation_parts[] = {
2932 /* Invalid (00000000), Invalid (11010001), Invalid (11100100), SLOPE_SW (11100000) */
2933 0x00, 0xD1, 0xE4, 0xE0,
2934 /* Invalid (11001010), SLOPE_EW (11001001), SLOPE_SE (11000100), SLOPE_WSE (11000000) */
2935 0xCA, 0xC9, 0xC4, 0xC0,
2936 /* Invalid (11010010), SLOPE_NW (10010001), SLOPE_NS (11100100), SLOPE_NWS (10100000) */
2937 0xD2, 0x91, 0xE4, 0xA0,
2938 /* SLOPE_NE (01001010), SLOPE_ENW (00001001), SLOPE_SEN (01000100) */
2939 0x4A, 0x09, 0x44
2942 uint8 parts = composite_foundation_parts[ti->tileh];
2944 /* If foundations continue beyond the tile's upper sides then
2945 * mask out the last two pieces. */
2946 if (HasBit(edge_info, 0)) ClrBit(parts, 6);
2947 if (HasBit(edge_info, 1)) ClrBit(parts, 7);
2949 if (parts == 0) {
2950 /* We always have to draw at least one sprite to make sure there is a boundingbox and a sprite with the
2951 * correct offset for the childsprites.
2952 * So, draw the (completely empty) sprite of the default foundations. */
2953 goto draw_default_foundation;
2956 StartSpriteCombine();
2957 for (int i = 0; i < 8; i++) {
2958 if (HasBit(parts, i)) {
2959 AddSortableSpriteToDraw(image + i, PAL_NONE, ti->x, ti->y, 16, 16, 7, ti->z);
2962 EndSpriteCombine();
2965 OffsetGroundSprite(31, 1);
2966 ti->z += ApplyPixelFoundationToSlope(FOUNDATION_LEVELED, &ti->tileh);
2967 } else {
2968 draw_default_foundation:
2969 DrawFoundation(ti, FOUNDATION_LEVELED);
2973 if (IsBuoy(ti->tile)) {
2974 DrawWaterClassGround(ti);
2975 SpriteID sprite = GetCanalSprite(CF_BUOY, ti->tile);
2976 if (sprite != 0) total_offset = sprite - SPR_IMG_BUOY;
2977 } else if (IsDock(ti->tile) || (IsOilRig(ti->tile) && IsTileOnWater(ti->tile))) {
2978 if (ti->tileh == SLOPE_FLAT) {
2979 DrawWaterClassGround(ti);
2980 } else {
2981 assert(IsDock(ti->tile));
2982 TileIndex water_tile = ti->tile + TileOffsByDiagDir(GetDockDirection(ti->tile));
2983 WaterClass wc = HasTileWaterClass(water_tile) ? GetWaterClass(water_tile) : WATER_CLASS_INVALID;
2984 if (wc == WATER_CLASS_SEA) {
2985 DrawShoreTile(ti->tileh);
2986 } else {
2987 DrawClearLandTile(ti, 3);
2990 } else {
2991 if (layout != nullptr) {
2992 /* Sprite layout which needs preprocessing */
2993 bool separate_ground = HasBit(statspec->flags, SSF_SEPARATE_GROUND);
2994 uint32 var10_values = layout->PrepareLayout(total_offset, rti->fallback_railtype, 0, 0, separate_ground);
2995 uint8 var10;
2996 FOR_EACH_SET_BIT(var10, var10_values) {
2997 uint32 var10_relocation = GetCustomStationRelocation(statspec, st, ti->tile, var10);
2998 layout->ProcessRegisters(var10, var10_relocation, separate_ground);
3000 tmp_rail_layout.seq = layout->GetLayout(&tmp_rail_layout.ground);
3001 t = &tmp_rail_layout;
3002 total_offset = 0;
3003 } else if (statspec != nullptr) {
3004 /* Simple sprite layout */
3005 ground_relocation = relocation = GetCustomStationRelocation(statspec, st, ti->tile, 0);
3006 if (HasBit(statspec->flags, SSF_SEPARATE_GROUND)) {
3007 ground_relocation = GetCustomStationRelocation(statspec, st, ti->tile, 1);
3009 ground_relocation += rti->fallback_railtype;
3012 SpriteID image = t->ground.sprite;
3013 PaletteID pal = t->ground.pal;
3014 RailTrackOffset overlay_offset;
3015 if (rti != nullptr && rti->UsesOverlay() && SplitGroundSpriteForOverlay(ti, &image, &overlay_offset)) {
3016 SpriteID ground = GetCustomRailSprite(rti, ti->tile, RTSG_GROUND);
3017 DrawGroundSprite(image, PAL_NONE);
3018 DrawGroundSprite(ground + overlay_offset, PAL_NONE);
3020 if (_game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasStationReservation(ti->tile)) {
3021 SpriteID overlay = GetCustomRailSprite(rti, ti->tile, RTSG_OVERLAY);
3022 DrawGroundSprite(overlay + overlay_offset, PALETTE_CRASH);
3024 } else {
3025 image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
3026 if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
3027 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
3029 /* PBS debugging, draw reserved tracks darker */
3030 if (_game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasStationRail(ti->tile) && HasStationReservation(ti->tile)) {
3031 const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(ti->tile));
3032 DrawGroundSprite(GetRailStationAxis(ti->tile) == AXIS_X ? rti->base_sprites.single_x : rti->base_sprites.single_y, PALETTE_CRASH);
3037 if (HasStationRail(ti->tile) && HasRailCatenaryDrawn(GetRailType(ti->tile))) DrawRailCatenary(ti);
3039 if (IsRoadStop(ti->tile)) {
3040 RoadType road_rt = GetRoadTypeRoad(ti->tile);
3041 RoadType tram_rt = GetRoadTypeTram(ti->tile);
3042 const RoadTypeInfo* road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
3043 const RoadTypeInfo* tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
3045 if (IsDriveThroughStopTile(ti->tile)) {
3046 Axis axis = GetRoadStopDir(ti->tile) == DIAGDIR_NE ? AXIS_X : AXIS_Y;
3047 uint sprite_offset = axis == AXIS_X ? 1 : 0;
3049 DrawRoadOverlays(ti, PAL_NONE, road_rti, tram_rti, sprite_offset, sprite_offset);
3050 } else {
3051 /* Non-drivethrough road stops are only valid for roads. */
3052 assert(road_rt != INVALID_ROADTYPE && tram_rt == INVALID_ROADTYPE);
3054 if (road_rti->UsesOverlay()) {
3055 DiagDirection dir = GetRoadStopDir(ti->tile);
3056 SpriteID ground = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_ROADSTOP);
3057 DrawGroundSprite(ground + dir, PAL_NONE);
3061 /* Draw road, tram catenary */
3062 DrawRoadCatenary(ti);
3065 if (IsRailWaypoint(ti->tile)) {
3066 /* Don't offset the waypoint graphics; they're always the same. */
3067 total_offset = 0;
3070 DrawRailTileSeq(ti, t, TO_BUILDINGS, total_offset, relocation, palette);
3073 void StationPickerDrawSprite(int x, int y, StationType st, RailType railtype, RoadType roadtype, int image)
3075 int32 total_offset = 0;
3076 PaletteID pal = COMPANY_SPRITE_COLOUR(_local_company);
3077 const DrawTileSprites *t = GetStationTileLayout(st, image);
3078 const RailtypeInfo *rti = nullptr;
3080 if (railtype != INVALID_RAILTYPE) {
3081 rti = GetRailTypeInfo(railtype);
3082 total_offset = rti->GetRailtypeSpriteOffset();
3085 SpriteID img = t->ground.sprite;
3086 RailTrackOffset overlay_offset;
3087 if (rti != nullptr && rti->UsesOverlay() && SplitGroundSpriteForOverlay(nullptr, &img, &overlay_offset)) {
3088 SpriteID ground = GetCustomRailSprite(rti, INVALID_TILE, RTSG_GROUND);
3089 DrawSprite(img, PAL_NONE, x, y);
3090 DrawSprite(ground + overlay_offset, PAL_NONE, x, y);
3091 } else {
3092 DrawSprite(img + total_offset, HasBit(img, PALETTE_MODIFIER_COLOUR) ? pal : PAL_NONE, x, y);
3095 if (roadtype != INVALID_ROADTYPE) {
3096 const RoadTypeInfo* rti = GetRoadTypeInfo(roadtype);
3097 if (image >= 4) {
3098 /* Drive-through stop */
3099 uint sprite_offset = 5 - image;
3101 /* Road underlay takes precedence over tram */
3102 if (rti->UsesOverlay()) {
3103 SpriteID ground = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_GROUND);
3104 DrawSprite(ground + sprite_offset, PAL_NONE, x, y);
3106 SpriteID overlay = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_OVERLAY);
3107 if (overlay) DrawSprite(overlay + sprite_offset, PAL_NONE, x, y);
3108 } else if (RoadTypeIsTram(roadtype)) {
3109 DrawSprite(SPR_TRAMWAY_TRAM + sprite_offset, PAL_NONE, x, y);
3111 } else {
3112 /* Drive-in stop */
3113 if (RoadTypeIsRoad(roadtype) && rti->UsesOverlay()) {
3114 SpriteID ground = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_ROADSTOP);
3115 DrawSprite(ground + image, PAL_NONE, x, y);
3120 /* Default waypoint has no railtype specific sprites */
3121 DrawRailTileSeqInGUI(x, y, t, st == STATION_WAYPOINT ? 0 : total_offset, 0, pal);
3124 static int GetSlopePixelZ_Station(TileIndex tile, uint x, uint y)
3126 return GetTileMaxPixelZ(tile);
3129 static Foundation GetFoundation_Station(TileIndex tile, Slope tileh)
3131 return FlatteningFoundation(tileh);
3134 static void GetTileDesc_Station(TileIndex tile, TileDesc *td)
3136 td->owner[0] = GetTileOwner(tile);
3138 if (IsRoadStopTile(tile)) {
3139 RoadType road_rt = GetRoadTypeRoad(tile);
3140 RoadType tram_rt = GetRoadTypeTram(tile);
3141 Owner road_owner = INVALID_OWNER;
3142 Owner tram_owner = INVALID_OWNER;
3143 if (road_rt != INVALID_ROADTYPE) {
3144 const RoadTypeInfo *rti = GetRoadTypeInfo(road_rt);
3145 td->roadtype = rti->strings.name;
3146 td->road_speed = rti->max_speed / 2;
3147 road_owner = GetRoadOwner(tile, RTT_ROAD);
3150 if (tram_rt != INVALID_ROADTYPE) {
3151 const RoadTypeInfo *rti = GetRoadTypeInfo(tram_rt);
3152 td->tramtype = rti->strings.name;
3153 td->tram_speed = rti->max_speed / 2;
3154 tram_owner = GetRoadOwner(tile, RTT_TRAM);
3157 if (IsDriveThroughStopTile(tile)) {
3158 /* Is there a mix of owners? */
3159 if ((tram_owner != INVALID_OWNER && tram_owner != td->owner[0]) ||
3160 (road_owner != INVALID_OWNER && road_owner != td->owner[0])) {
3161 uint i = 1;
3162 if (road_owner != INVALID_OWNER) {
3163 td->owner_type[i] = STR_LAND_AREA_INFORMATION_ROAD_OWNER;
3164 td->owner[i] = road_owner;
3165 i++;
3167 if (tram_owner != INVALID_OWNER) {
3168 td->owner_type[i] = STR_LAND_AREA_INFORMATION_TRAM_OWNER;
3169 td->owner[i] = tram_owner;
3175 td->build_date = BaseStation::GetByTile(tile)->build_date;
3177 if (HasStationTileRail(tile)) {
3178 const StationSpec *spec = GetStationSpec(tile);
3180 if (spec != nullptr) {
3181 td->station_class = StationClass::Get(spec->cls_id)->name;
3182 td->station_name = spec->name;
3184 if (spec->grf_prop.grffile != nullptr) {
3185 const GRFConfig *gc = GetGRFConfig(spec->grf_prop.grffile->grfid);
3186 td->grf = gc->GetName();
3190 const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
3191 td->rail_speed = rti->max_speed;
3192 td->railtype = rti->strings.name;
3195 if (IsAirport(tile)) {
3196 const AirportSpec *as = Station::GetByTile(tile)->airport.GetSpec();
3197 td->airport_class = AirportClass::Get(as->cls_id)->name;
3198 td->airport_name = as->name;
3200 const AirportTileSpec *ats = AirportTileSpec::GetByTile(tile);
3201 td->airport_tile_name = ats->name;
3203 if (as->grf_prop.grffile != nullptr) {
3204 const GRFConfig *gc = GetGRFConfig(as->grf_prop.grffile->grfid);
3205 td->grf = gc->GetName();
3206 } else if (ats->grf_prop.grffile != nullptr) {
3207 const GRFConfig *gc = GetGRFConfig(ats->grf_prop.grffile->grfid);
3208 td->grf = gc->GetName();
3212 StringID str;
3213 switch (GetStationType(tile)) {
3214 default: NOT_REACHED();
3215 case STATION_RAIL: str = STR_LAI_STATION_DESCRIPTION_RAILROAD_STATION; break;
3216 case STATION_AIRPORT:
3217 str = (IsHangar(tile) ? STR_LAI_STATION_DESCRIPTION_AIRCRAFT_HANGAR : STR_LAI_STATION_DESCRIPTION_AIRPORT);
3218 break;
3219 case STATION_TRUCK: str = STR_LAI_STATION_DESCRIPTION_TRUCK_LOADING_AREA; break;
3220 case STATION_BUS: str = STR_LAI_STATION_DESCRIPTION_BUS_STATION; break;
3221 case STATION_OILRIG: {
3222 const Industry *i = Station::GetByTile(tile)->industry;
3223 const IndustrySpec *is = GetIndustrySpec(i->type);
3224 td->owner[0] = i->owner;
3225 str = is->name;
3226 if (is->grf_prop.grffile != nullptr) td->grf = GetGRFConfig(is->grf_prop.grffile->grfid)->GetName();
3227 break;
3229 case STATION_DOCK: str = STR_LAI_STATION_DESCRIPTION_SHIP_DOCK; break;
3230 case STATION_BUOY: str = STR_LAI_STATION_DESCRIPTION_BUOY; break;
3231 case STATION_WAYPOINT: str = STR_LAI_STATION_DESCRIPTION_WAYPOINT; break;
3233 td->str = str;
3237 static TrackStatus GetTileTrackStatus_Station(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
3239 TrackBits trackbits = TRACK_BIT_NONE;
3241 switch (mode) {
3242 case TRANSPORT_RAIL:
3243 if (HasStationRail(tile) && !IsStationTileBlocked(tile)) {
3244 trackbits = TrackToTrackBits(GetRailStationTrack(tile));
3246 break;
3248 case TRANSPORT_WATER:
3249 /* buoy is coded as a station, it is always on open water */
3250 if (IsBuoy(tile)) {
3251 trackbits = TRACK_BIT_ALL;
3252 /* remove tracks that connect NE map edge */
3253 if (TileX(tile) == 0) trackbits &= ~(TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_RIGHT);
3254 /* remove tracks that connect NW map edge */
3255 if (TileY(tile) == 0) trackbits &= ~(TRACK_BIT_Y | TRACK_BIT_LEFT | TRACK_BIT_UPPER);
3257 break;
3259 case TRANSPORT_ROAD:
3260 if (IsRoadStop(tile)) {
3261 RoadTramType rtt = (RoadTramType)sub_mode;
3262 if (!HasTileRoadType(tile, rtt)) break;
3264 DiagDirection dir = GetRoadStopDir(tile);
3265 Axis axis = DiagDirToAxis(dir);
3267 if (side != INVALID_DIAGDIR) {
3268 if (axis != DiagDirToAxis(side) || (IsStandardRoadStopTile(tile) && dir != side)) break;
3271 trackbits = AxisToTrackBits(axis);
3273 break;
3275 default:
3276 break;
3279 return CombineTrackStatus(TrackBitsToTrackdirBits(trackbits), TRACKDIR_BIT_NONE);
3283 static void TileLoop_Station(TileIndex tile)
3285 /* FIXME -- GetTileTrackStatus_Station -> animated stationtiles
3286 * hardcoded.....not good */
3287 switch (GetStationType(tile)) {
3288 case STATION_AIRPORT:
3289 AirportTileAnimationTrigger(Station::GetByTile(tile), tile, AAT_TILELOOP);
3290 break;
3292 case STATION_DOCK:
3293 if (!IsTileFlat(tile)) break; // only handle water part
3294 FALLTHROUGH;
3296 case STATION_OILRIG: //(station part)
3297 case STATION_BUOY:
3298 TileLoop_Water(tile);
3299 break;
3301 default: break;
3306 static void AnimateTile_Station(TileIndex tile)
3308 if (HasStationRail(tile)) {
3309 AnimateStationTile(tile);
3310 return;
3313 if (IsAirport(tile)) {
3314 AnimateAirportTile(tile);
3319 static bool ClickTile_Station(TileIndex tile)
3321 const BaseStation *bst = BaseStation::GetByTile(tile);
3323 if (bst->facilities & FACIL_WAYPOINT) {
3324 ShowWaypointWindow(Waypoint::From(bst));
3325 } else if (IsHangar(tile)) {
3326 const Station *st = Station::From(bst);
3327 ShowDepotWindow(st->airport.GetHangarTile(st->airport.GetHangarNum(tile)), VEH_AIRCRAFT);
3328 } else {
3329 ShowStationViewWindow(bst->index);
3331 return true;
3334 static VehicleEnterTileStatus VehicleEnter_Station(Vehicle *v, TileIndex tile, int x, int y)
3336 if (v->type == VEH_TRAIN) {
3337 StationID station_id = GetStationIndex(tile);
3338 if (!v->current_order.ShouldStopAtStation(v, station_id)) return VETSB_CONTINUE;
3339 if (!IsRailStation(tile) || !v->IsFrontEngine()) return VETSB_CONTINUE;
3341 int station_ahead;
3342 int station_length;
3343 int stop = GetTrainStopLocation(station_id, tile, Train::From(v), &station_ahead, &station_length);
3345 /* Stop whenever that amount of station ahead + the distance from the
3346 * begin of the platform to the stop location is longer than the length
3347 * of the platform. Station ahead 'includes' the current tile where the
3348 * vehicle is on, so we need to subtract that. */
3349 if (stop + station_ahead - (int)TILE_SIZE >= station_length) return VETSB_CONTINUE;
3351 DiagDirection dir = DirToDiagDir(v->direction);
3353 x &= 0xF;
3354 y &= 0xF;
3356 if (DiagDirToAxis(dir) != AXIS_X) Swap(x, y);
3357 if (y == TILE_SIZE / 2) {
3358 if (dir != DIAGDIR_SE && dir != DIAGDIR_SW) x = TILE_SIZE - 1 - x;
3359 stop &= TILE_SIZE - 1;
3361 if (x == stop) {
3362 return VETSB_ENTERED_STATION | (VehicleEnterTileStatus)(station_id << VETS_STATION_ID_OFFSET); // enter station
3363 } else if (x < stop) {
3364 v->vehstatus |= VS_TRAIN_SLOWING;
3365 uint16 spd = max(0, (stop - x) * 20 - 15);
3366 if (spd < v->cur_speed) v->cur_speed = spd;
3369 } else if (v->type == VEH_ROAD) {
3370 RoadVehicle *rv = RoadVehicle::From(v);
3371 if (rv->state < RVSB_IN_ROAD_STOP && !IsReversingRoadTrackdir((Trackdir)rv->state) && rv->frame == 0) {
3372 if (IsRoadStop(tile) && rv->IsFrontEngine()) {
3373 /* Attempt to allocate a parking bay in a road stop */
3374 return RoadStop::GetByTile(tile, GetRoadStopType(tile))->Enter(rv) ? VETSB_CONTINUE : VETSB_CANNOT_ENTER;
3379 return VETSB_CONTINUE;
3383 * Run the watched cargo callback for all houses in the catchment area.
3384 * @param st Station.
3386 void TriggerWatchedCargoCallbacks(Station *st)
3388 /* Collect cargoes accepted since the last big tick. */
3389 CargoTypes cargoes = 0;
3390 for (CargoID cid = 0; cid < NUM_CARGO; cid++) {
3391 if (HasBit(st->goods[cid].status, GoodsEntry::GES_ACCEPTED_BIGTICK)) SetBit(cargoes, cid);
3394 /* Anything to do? */
3395 if (cargoes == 0) return;
3397 /* Loop over all houses in the catchment. */
3398 BitmapTileIterator it(st->catchment_tiles);
3399 for (TileIndex tile = it; tile != INVALID_TILE; tile = ++it) {
3400 if (IsTileType(tile, MP_HOUSE)) {
3401 WatchedCargoCallback(tile, cargoes);
3407 * This function is called for each station once every 250 ticks.
3408 * Not all stations will get the tick at the same time.
3409 * @param st the station receiving the tick.
3410 * @return true if the station is still valid (wasn't deleted)
3412 static bool StationHandleBigTick(BaseStation *st)
3414 if (!st->IsInUse()) {
3415 if (++st->delete_ctr >= 8) delete st;
3416 return false;
3419 if (Station::IsExpected(st)) {
3420 TriggerWatchedCargoCallbacks(Station::From(st));
3422 for (CargoID i = 0; i < NUM_CARGO; i++) {
3423 ClrBit(Station::From(st)->goods[i].status, GoodsEntry::GES_ACCEPTED_BIGTICK);
3428 if ((st->facilities & FACIL_WAYPOINT) == 0) UpdateStationAcceptance(Station::From(st), true);
3430 return true;
3433 static inline void byte_inc_sat(byte *p)
3435 byte b = *p + 1;
3436 if (b != 0) *p = b;
3440 * Truncate the cargo by a specific amount.
3441 * @param cs The type of cargo to perform the truncation for.
3442 * @param ge The goods entry, of the station, to truncate.
3443 * @param amount The amount to truncate the cargo by.
3445 static void TruncateCargo(const CargoSpec *cs, GoodsEntry *ge, uint amount = UINT_MAX)
3447 /* If truncating also punish the source stations' ratings to
3448 * decrease the flow of incoming cargo. */
3450 StationCargoAmountMap waiting_per_source;
3451 ge->cargo.Truncate(amount, &waiting_per_source);
3452 for (StationCargoAmountMap::iterator i(waiting_per_source.begin()); i != waiting_per_source.end(); ++i) {
3453 Station *source_station = Station::GetIfValid(i->first);
3454 if (source_station == nullptr) continue;
3456 GoodsEntry &source_ge = source_station->goods[cs->Index()];
3457 source_ge.max_waiting_cargo = max(source_ge.max_waiting_cargo, i->second);
3461 static void UpdateStationRating(Station *st)
3463 bool waiting_changed = false;
3465 byte_inc_sat(&st->time_since_load);
3466 byte_inc_sat(&st->time_since_unload);
3468 const CargoSpec *cs;
3469 FOR_ALL_CARGOSPECS(cs) {
3470 GoodsEntry *ge = &st->goods[cs->Index()];
3471 /* Slowly increase the rating back to his original level in the case we
3472 * didn't deliver cargo yet to this station. This happens when a bribe
3473 * failed while you didn't moved that cargo yet to a station. */
3474 if (!ge->HasRating() && ge->rating < INITIAL_STATION_RATING) {
3475 ge->rating++;
3478 /* Only change the rating if we are moving this cargo */
3479 if (ge->HasRating()) {
3480 byte_inc_sat(&ge->time_since_pickup);
3481 if (ge->time_since_pickup == 255 && _settings_game.order.selectgoods) {
3482 ClrBit(ge->status, GoodsEntry::GES_RATING);
3483 ge->last_speed = 0;
3484 TruncateCargo(cs, ge);
3485 waiting_changed = true;
3486 continue;
3489 bool skip = false;
3490 int rating = 0;
3491 uint waiting = ge->cargo.AvailableCount();
3493 /* num_dests is at least 1 if there is any cargo as
3494 * INVALID_STATION is also a destination.
3496 uint num_dests = (uint)ge->cargo.Packets()->MapSize();
3498 /* Average amount of cargo per next hop, but prefer solitary stations
3499 * with only one or two next hops. They are allowed to have more
3500 * cargo waiting per next hop.
3501 * With manual cargo distribution waiting_avg = waiting / 2 as then
3502 * INVALID_STATION is the only destination.
3504 uint waiting_avg = waiting / (num_dests + 1);
3506 if (HasBit(cs->callback_mask, CBM_CARGO_STATION_RATING_CALC)) {
3507 /* Perform custom station rating. If it succeeds the speed, days in transit and
3508 * waiting cargo ratings must not be executed. */
3510 /* NewGRFs expect last speed to be 0xFF when no vehicle has arrived yet. */
3511 uint last_speed = ge->HasVehicleEverTriedLoading() ? ge->last_speed : 0xFF;
3513 uint32 var18 = min(ge->time_since_pickup, 0xFF) | (min(ge->max_waiting_cargo, 0xFFFF) << 8) | (min(last_speed, 0xFF) << 24);
3514 /* Convert to the 'old' vehicle types */
3515 uint32 var10 = (st->last_vehicle_type == VEH_INVALID) ? 0x0 : (st->last_vehicle_type + 0x10);
3516 uint16 callback = GetCargoCallback(CBID_CARGO_STATION_RATING_CALC, var10, var18, cs);
3517 if (callback != CALLBACK_FAILED) {
3518 skip = true;
3519 rating = GB(callback, 0, 14);
3521 /* Simulate a 15 bit signed value */
3522 if (HasBit(callback, 14)) rating -= 0x4000;
3526 if (!skip) {
3527 int b = ge->last_speed - 85;
3528 if (b >= 0) rating += b >> 2;
3530 byte waittime = ge->time_since_pickup;
3531 if (st->last_vehicle_type == VEH_SHIP) waittime >>= 2;
3532 if (waittime <= 21) rating += 25;
3533 if (waittime <= 12) rating += 25;
3534 if (waittime <= 6) rating += 45;
3535 if (waittime <= 3) rating += 35;
3537 rating -= 90;
3538 if (ge->max_waiting_cargo <= 1500) rating += 55;
3539 if (ge->max_waiting_cargo <= 1000) rating += 35;
3540 if (ge->max_waiting_cargo <= 600) rating += 10;
3541 if (ge->max_waiting_cargo <= 300) rating += 20;
3542 if (ge->max_waiting_cargo <= 100) rating += 10;
3545 if (Company::IsValidID(st->owner) && HasBit(st->town->statues, st->owner)) rating += 26;
3547 byte age = ge->last_age;
3548 if (age < 3) rating += 10;
3549 if (age < 2) rating += 10;
3550 if (age < 1) rating += 13;
3553 int or_ = ge->rating; // old rating
3555 /* only modify rating in steps of -2, -1, 0, 1 or 2 */
3556 ge->rating = rating = or_ + Clamp(Clamp(rating, 0, 255) - or_, -2, 2);
3558 /* if rating is <= 64 and more than 100 items waiting on average per destination,
3559 * remove some random amount of goods from the station */
3560 if (rating <= 64 && waiting_avg >= 100) {
3561 int dec = Random() & 0x1F;
3562 if (waiting_avg < 200) dec &= 7;
3563 waiting -= (dec + 1) * num_dests;
3564 waiting_changed = true;
3567 /* if rating is <= 127 and there are any items waiting, maybe remove some goods. */
3568 if (rating <= 127 && waiting != 0) {
3569 uint32 r = Random();
3570 if (rating <= (int)GB(r, 0, 7)) {
3571 /* Need to have int, otherwise it will just overflow etc. */
3572 waiting = max((int)waiting - (int)((GB(r, 8, 2) - 1) * num_dests), 0);
3573 waiting_changed = true;
3577 /* At some point we really must cap the cargo. Previously this
3578 * was a strict 4095, but now we'll have a less strict, but
3579 * increasingly aggressive truncation of the amount of cargo. */
3580 static const uint WAITING_CARGO_THRESHOLD = 1 << 12;
3581 static const uint WAITING_CARGO_CUT_FACTOR = 1 << 6;
3582 static const uint MAX_WAITING_CARGO = 1 << 15;
3584 if (waiting > WAITING_CARGO_THRESHOLD) {
3585 uint difference = waiting - WAITING_CARGO_THRESHOLD;
3586 waiting -= (difference / WAITING_CARGO_CUT_FACTOR);
3588 waiting = min(waiting, MAX_WAITING_CARGO);
3589 waiting_changed = true;
3592 /* We can't truncate cargo that's already reserved for loading.
3593 * Thus StoredCount() here. */
3594 if (waiting_changed && waiting < ge->cargo.AvailableCount()) {
3595 /* Feed back the exact own waiting cargo at this station for the
3596 * next rating calculation. */
3597 ge->max_waiting_cargo = 0;
3599 TruncateCargo(cs, ge, ge->cargo.AvailableCount() - waiting);
3600 } else {
3601 /* If the average number per next hop is low, be more forgiving. */
3602 ge->max_waiting_cargo = waiting_avg;
3608 StationID index = st->index;
3609 if (waiting_changed) {
3610 SetWindowDirty(WC_STATION_VIEW, index); // update whole window
3611 } else {
3612 SetWindowWidgetDirty(WC_STATION_VIEW, index, WID_SV_ACCEPT_RATING_LIST); // update only ratings list
3617 * Reroute cargo of type c at station st or in any vehicles unloading there.
3618 * Make sure the cargo's new next hop is neither "avoid" nor "avoid2".
3619 * @param st Station to be rerouted at.
3620 * @param c Type of cargo.
3621 * @param avoid Original next hop of cargo, avoid this.
3622 * @param avoid2 Another station to be avoided when rerouting.
3624 void RerouteCargo(Station *st, CargoID c, StationID avoid, StationID avoid2)
3626 GoodsEntry &ge = st->goods[c];
3628 /* Reroute cargo in station. */
3629 ge.cargo.Reroute(UINT_MAX, &ge.cargo, avoid, avoid2, &ge);
3631 /* Reroute cargo staged to be transferred. */
3632 for (std::list<Vehicle *>::iterator it(st->loading_vehicles.begin()); it != st->loading_vehicles.end(); ++it) {
3633 for (Vehicle *v = *it; v != nullptr; v = v->Next()) {
3634 if (v->cargo_type != c) continue;
3635 v->cargo.Reroute(UINT_MAX, &v->cargo, avoid, avoid2, &ge);
3641 * Check all next hops of cargo packets in this station for existence of a
3642 * a valid link they may use to travel on. Reroute any cargo not having a valid
3643 * link and remove timed out links found like this from the linkgraph. We're
3644 * not all links here as that is expensive and useless. A link no one is using
3645 * doesn't hurt either.
3646 * @param from Station to check.
3648 void DeleteStaleLinks(Station *from)
3650 for (CargoID c = 0; c < NUM_CARGO; ++c) {
3651 const bool auto_distributed = (_settings_game.linkgraph.GetDistributionType(c) != DT_MANUAL);
3652 GoodsEntry &ge = from->goods[c];
3653 LinkGraph *lg = LinkGraph::GetIfValid(ge.link_graph);
3654 if (lg == nullptr) continue;
3655 Node node = (*lg)[ge.node];
3656 for (EdgeIterator it(node.Begin()); it != node.End();) {
3657 Edge edge = it->second;
3658 Station *to = Station::Get((*lg)[it->first].Station());
3659 assert(to->goods[c].node == it->first);
3660 ++it; // Do that before removing the edge. Anything else may crash.
3661 assert(_date >= edge.LastUpdate());
3662 uint timeout = LinkGraph::MIN_TIMEOUT_DISTANCE + (DistanceManhattan(from->xy, to->xy) >> 3);
3663 if ((uint)(_date - edge.LastUpdate()) > timeout) {
3664 bool updated = false;
3666 if (auto_distributed) {
3667 /* Have all vehicles refresh their next hops before deciding to
3668 * remove the node. */
3669 std::vector<Vehicle *> vehicles;
3670 for (OrderList *l : OrderList::Iterate()) {
3671 bool found_from = false;
3672 bool found_to = false;
3673 for (Order *order = l->GetFirstOrder(); order != nullptr; order = order->next) {
3674 if (!order->IsType(OT_GOTO_STATION) && !order->IsType(OT_IMPLICIT)) continue;
3675 if (order->GetDestination() == from->index) {
3676 found_from = true;
3677 if (found_to) break;
3678 } else if (order->GetDestination() == to->index) {
3679 found_to = true;
3680 if (found_from) break;
3683 if (!found_to || !found_from) continue;
3684 vehicles.push_back(l->GetFirstSharedVehicle());
3687 auto iter = vehicles.begin();
3688 while (iter != vehicles.end()) {
3689 Vehicle *v = *iter;
3691 LinkRefresher::Run(v, false); // Don't allow merging. Otherwise lg might get deleted.
3692 if (edge.LastUpdate() == _date) {
3693 updated = true;
3694 break;
3697 Vehicle *next_shared = v->NextShared();
3698 if (next_shared) {
3699 *iter = next_shared;
3700 ++iter;
3701 } else {
3702 iter = vehicles.erase(iter);
3705 if (iter == vehicles.end()) iter = vehicles.begin();
3709 if (!updated) {
3710 /* If it's still considered dead remove it. */
3711 node.RemoveEdge(to->goods[c].node);
3712 ge.flows.DeleteFlows(to->index);
3713 RerouteCargo(from, c, to->index, from->index);
3715 } else if (edge.LastUnrestrictedUpdate() != INVALID_DATE && (uint)(_date - edge.LastUnrestrictedUpdate()) > timeout) {
3716 edge.Restrict();
3717 ge.flows.RestrictFlows(to->index);
3718 RerouteCargo(from, c, to->index, from->index);
3719 } else if (edge.LastRestrictedUpdate() != INVALID_DATE && (uint)(_date - edge.LastRestrictedUpdate()) > timeout) {
3720 edge.Release();
3723 assert(_date >= lg->LastCompression());
3724 if ((uint)(_date - lg->LastCompression()) > LinkGraph::COMPRESSION_INTERVAL) {
3725 lg->Compress();
3731 * Increase capacity for a link stat given by station cargo and next hop.
3732 * @param st Station to get the link stats from.
3733 * @param cargo Cargo to increase stat for.
3734 * @param next_station_id Station the consist will be travelling to next.
3735 * @param capacity Capacity to add to link stat.
3736 * @param usage Usage to add to link stat.
3737 * @param mode Update mode to be applied.
3739 void IncreaseStats(Station *st, CargoID cargo, StationID next_station_id, uint capacity, uint usage, EdgeUpdateMode mode)
3741 GoodsEntry &ge1 = st->goods[cargo];
3742 Station *st2 = Station::Get(next_station_id);
3743 GoodsEntry &ge2 = st2->goods[cargo];
3744 LinkGraph *lg = nullptr;
3745 if (ge1.link_graph == INVALID_LINK_GRAPH) {
3746 if (ge2.link_graph == INVALID_LINK_GRAPH) {
3747 if (LinkGraph::CanAllocateItem()) {
3748 lg = new LinkGraph(cargo);
3749 LinkGraphSchedule::instance.Queue(lg);
3750 ge2.link_graph = lg->index;
3751 ge2.node = lg->AddNode(st2);
3752 } else {
3753 DEBUG(misc, 0, "Can't allocate link graph");
3755 } else {
3756 lg = LinkGraph::Get(ge2.link_graph);
3758 if (lg) {
3759 ge1.link_graph = lg->index;
3760 ge1.node = lg->AddNode(st);
3762 } else if (ge2.link_graph == INVALID_LINK_GRAPH) {
3763 lg = LinkGraph::Get(ge1.link_graph);
3764 ge2.link_graph = lg->index;
3765 ge2.node = lg->AddNode(st2);
3766 } else {
3767 lg = LinkGraph::Get(ge1.link_graph);
3768 if (ge1.link_graph != ge2.link_graph) {
3769 LinkGraph *lg2 = LinkGraph::Get(ge2.link_graph);
3770 if (lg->Size() < lg2->Size()) {
3771 LinkGraphSchedule::instance.Unqueue(lg);
3772 lg2->Merge(lg); // Updates GoodsEntries of lg
3773 lg = lg2;
3774 } else {
3775 LinkGraphSchedule::instance.Unqueue(lg2);
3776 lg->Merge(lg2); // Updates GoodsEntries of lg2
3780 if (lg != nullptr) {
3781 (*lg)[ge1.node].UpdateEdge(ge2.node, capacity, usage, mode);
3786 * Increase capacity for all link stats associated with vehicles in the given consist.
3787 * @param st Station to get the link stats from.
3788 * @param front First vehicle in the consist.
3789 * @param next_station_id Station the consist will be travelling to next.
3791 void IncreaseStats(Station *st, const Vehicle *front, StationID next_station_id)
3793 for (const Vehicle *v = front; v != nullptr; v = v->Next()) {
3794 if (v->refit_cap > 0) {
3795 /* The cargo count can indeed be higher than the refit_cap if
3796 * wagons have been auto-replaced and subsequently auto-
3797 * refitted to a higher capacity. The cargo gets redistributed
3798 * among the wagons in that case.
3799 * As usage is not such an important figure anyway we just
3800 * ignore the additional cargo then.*/
3801 IncreaseStats(st, v->cargo_type, next_station_id, v->refit_cap,
3802 min(v->refit_cap, v->cargo.StoredCount()), EUM_INCREASE);
3807 /* called for every station each tick */
3808 static void StationHandleSmallTick(BaseStation *st)
3810 if ((st->facilities & FACIL_WAYPOINT) != 0 || !st->IsInUse()) return;
3812 byte b = st->delete_ctr + 1;
3813 if (b >= STATION_RATING_TICKS) b = 0;
3814 st->delete_ctr = b;
3816 if (b == 0) UpdateStationRating(Station::From(st));
3819 void OnTick_Station()
3821 if (_game_mode == GM_EDITOR) return;
3823 for (BaseStation *st : BaseStation::Iterate()) {
3824 StationHandleSmallTick(st);
3826 /* Clean up the link graph about once a week. */
3827 if (Station::IsExpected(st) && (_tick_counter + st->index) % STATION_LINKGRAPH_TICKS == 0) {
3828 DeleteStaleLinks(Station::From(st));
3831 /* Run STATION_ACCEPTANCE_TICKS = 250 tick interval trigger for station animation.
3832 * Station index is included so that triggers are not all done
3833 * at the same time. */
3834 if ((_tick_counter + st->index) % STATION_ACCEPTANCE_TICKS == 0) {
3835 /* Stop processing this station if it was deleted */
3836 if (!StationHandleBigTick(st)) continue;
3837 TriggerStationAnimation(st, st->xy, SAT_250_TICKS);
3838 if (Station::IsExpected(st)) AirportAnimationTrigger(Station::From(st), AAT_STATION_250_TICKS);
3843 /** Monthly loop for stations. */
3844 void StationMonthlyLoop()
3846 for (Station *st : Station::Iterate()) {
3847 for (CargoID i = 0; i < NUM_CARGO; i++) {
3848 GoodsEntry *ge = &st->goods[i];
3849 SB(ge->status, GoodsEntry::GES_LAST_MONTH, 1, GB(ge->status, GoodsEntry::GES_CURRENT_MONTH, 1));
3850 ClrBit(ge->status, GoodsEntry::GES_CURRENT_MONTH);
3856 void ModifyStationRatingAround(TileIndex tile, Owner owner, int amount, uint radius)
3858 ForAllStationsRadius(tile, radius, [&](Station *st) {
3859 if (st->owner == owner && DistanceManhattan(tile, st->xy) <= radius) {
3860 for (CargoID i = 0; i < NUM_CARGO; i++) {
3861 GoodsEntry *ge = &st->goods[i];
3863 if (ge->status != 0) {
3864 ge->rating = Clamp(ge->rating + amount, 0, 255);
3871 static uint UpdateStationWaiting(Station *st, CargoID type, uint amount, SourceType source_type, SourceID source_id)
3873 /* We can't allocate a CargoPacket? Then don't do anything
3874 * at all; i.e. just discard the incoming cargo. */
3875 if (!CargoPacket::CanAllocateItem()) return 0;
3877 GoodsEntry &ge = st->goods[type];
3878 amount += ge.amount_fract;
3879 ge.amount_fract = GB(amount, 0, 8);
3881 amount >>= 8;
3882 /* No new "real" cargo item yet. */
3883 if (amount == 0) return 0;
3885 StationID next = ge.GetVia(st->index);
3886 ge.cargo.Append(new CargoPacket(st->index, st->xy, amount, source_type, source_id), next);
3887 LinkGraph *lg = nullptr;
3888 if (ge.link_graph == INVALID_LINK_GRAPH) {
3889 if (LinkGraph::CanAllocateItem()) {
3890 lg = new LinkGraph(type);
3891 LinkGraphSchedule::instance.Queue(lg);
3892 ge.link_graph = lg->index;
3893 ge.node = lg->AddNode(st);
3894 } else {
3895 DEBUG(misc, 0, "Can't allocate link graph");
3897 } else {
3898 lg = LinkGraph::Get(ge.link_graph);
3900 if (lg != nullptr) (*lg)[ge.node].UpdateSupply(amount);
3902 if (!ge.HasRating()) {
3903 InvalidateWindowData(WC_STATION_LIST, st->index);
3904 SetBit(ge.status, GoodsEntry::GES_RATING);
3907 TriggerStationRandomisation(st, st->xy, SRT_NEW_CARGO, type);
3908 TriggerStationAnimation(st, st->xy, SAT_NEW_CARGO, type);
3909 AirportAnimationTrigger(st, AAT_STATION_NEW_CARGO, type);
3911 SetWindowDirty(WC_STATION_VIEW, st->index);
3912 st->MarkTilesDirty(true);
3913 return amount;
3916 static bool IsUniqueStationName(const char *name)
3918 for (const Station *st : Station::Iterate()) {
3919 if (st->name != nullptr && strcmp(st->name, name) == 0) return false;
3922 return true;
3926 * Rename a station
3927 * @param tile unused
3928 * @param flags operation to perform
3929 * @param p1 station ID that is to be renamed
3930 * @param p2 unused
3931 * @param text the new name or an empty string when resetting to the default
3932 * @return the cost of this operation or an error
3934 CommandCost CmdRenameStation(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
3936 Station *st = Station::GetIfValid(p1);
3937 if (st == nullptr) return CMD_ERROR;
3939 CommandCost ret = CheckOwnership(st->owner);
3940 if (ret.Failed()) return ret;
3942 bool reset = StrEmpty(text);
3944 if (!reset) {
3945 if (Utf8StringLength(text) >= MAX_LENGTH_STATION_NAME_CHARS) return CMD_ERROR;
3946 if (!IsUniqueStationName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
3949 if (flags & DC_EXEC) {
3950 st->cached_name.clear();
3951 free(st->name);
3952 st->name = reset ? nullptr : stredup(text);
3954 st->UpdateVirtCoord();
3955 InvalidateWindowData(WC_STATION_LIST, st->owner, 1);
3958 return CommandCost();
3961 static void AddNearbyStationsByCatchment(TileIndex tile, StationList *stations, StationList &nearby)
3963 for (Station *st : nearby) {
3964 if (st->TileIsInCatchment(tile)) stations->insert(st);
3969 * Find all stations around a rectangular producer (industry, house, headquarter, ...)
3971 * @param location The location/area of the producer
3972 * @param[out] stations The list to store the stations in
3973 * @param use_nearby Use nearby station list of industry/town associated with location.tile
3975 void FindStationsAroundTiles(const TileArea &location, StationList * const stations, bool use_nearby)
3977 if (use_nearby) {
3978 /* Industries and towns maintain a list of nearby stations */
3979 if (IsTileType(location.tile, MP_INDUSTRY)) {
3980 /* Industry nearby stations are already filtered by catchment. */
3981 *stations = Industry::GetByTile(location.tile)->stations_near;
3982 return;
3983 } else if (IsTileType(location.tile, MP_HOUSE)) {
3984 /* Town nearby stations need to be filtered per tile. */
3985 assert(location.w == 1 && location.h == 1);
3986 AddNearbyStationsByCatchment(location.tile, stations, Town::GetByTile(location.tile)->stations_near);
3987 return;
3991 /* Not using, or don't have a nearby stations list, so we need to scan. */
3992 std::set<StationID> seen_stations;
3994 /* Scan an area around the building covering the maximum possible station
3995 * to find the possible nearby stations. */
3996 uint max_c = _settings_game.station.modified_catchment ? MAX_CATCHMENT : CA_UNMODIFIED;
3997 TileArea ta = TileArea(location).Expand(max_c);
3998 TILE_AREA_LOOP(tile, ta) {
3999 if (IsTileType(tile, MP_STATION)) seen_stations.insert(GetStationIndex(tile));
4002 for (StationID stationid : seen_stations) {
4003 Station *st = Station::GetIfValid(stationid);
4004 if (st == nullptr) continue; /* Waypoint */
4006 /* Check if station is attached to an industry */
4007 if (!_settings_game.station.serve_neutral_industries && st->industry != nullptr) continue;
4009 /* Test if the tile is within the station's catchment */
4010 TILE_AREA_LOOP(tile, location) {
4011 if (st->TileIsInCatchment(tile)) {
4012 stations->insert(st);
4013 break;
4020 * Run a tile loop to find stations around a tile, on demand. Cache the result for further requests
4021 * @return pointer to a StationList containing all stations found
4023 const StationList *StationFinder::GetStations()
4025 if (this->tile != INVALID_TILE) {
4026 FindStationsAroundTiles(*this, &this->stations);
4027 this->tile = INVALID_TILE;
4029 return &this->stations;
4032 static bool CanMoveGoodsToStation(const Station *st, CargoID type)
4034 /* Is the station reserved exclusively for somebody else? */
4035 if (st->owner != OWNER_NONE && st->town->exclusive_counter > 0 && st->town->exclusivity != st->owner) return false;
4037 /* Lowest possible rating, better not to give cargo anymore. */
4038 if (st->goods[type].rating == 0) return false;
4040 /* Selectively servicing stations, and not this one. */
4041 if (_settings_game.order.selectgoods && !st->goods[type].HasVehicleEverTriedLoading()) return false;
4043 if (IsCargoInClass(type, CC_PASSENGERS)) {
4044 /* Passengers are never served by just a truck stop. */
4045 if (st->facilities == FACIL_TRUCK_STOP) return false;
4046 } else {
4047 /* Non-passengers are never served by just a bus stop. */
4048 if (st->facilities == FACIL_BUS_STOP) return false;
4050 return true;
4053 uint MoveGoodsToStation(CargoID type, uint amount, SourceType source_type, SourceID source_id, const StationList *all_stations)
4055 /* Return if nothing to do. Also the rounding below fails for 0. */
4056 if (all_stations->empty()) return 0;
4057 if (amount == 0) return 0;
4059 Station *first_station = nullptr;
4060 typedef std::pair<Station *, uint> StationInfo;
4061 std::vector<StationInfo> used_stations;
4063 for (Station *st : *all_stations) {
4064 if (!CanMoveGoodsToStation(st, type)) continue;
4066 /* Avoid allocating a vector if there is only one station to significantly
4067 * improve performance in this common case. */
4068 if (first_station == nullptr) {
4069 first_station = st;
4070 continue;
4072 if (used_stations.empty()) {
4073 used_stations.reserve(2);
4074 used_stations.emplace_back(std::make_pair(first_station, 0));
4076 used_stations.emplace_back(std::make_pair(st, 0));
4079 /* no stations around at all? */
4080 if (first_station == nullptr) return 0;
4082 if (used_stations.empty()) {
4083 /* only one station around */
4084 amount *= first_station->goods[type].rating + 1;
4085 return UpdateStationWaiting(first_station, type, amount, source_type, source_id);
4088 uint company_best[OWNER_NONE + 1] = {}; // best rating for each company, including OWNER_NONE
4089 uint company_sum[OWNER_NONE + 1] = {}; // sum of ratings for each company
4090 uint best_rating = 0;
4091 uint best_sum = 0; // sum of best ratings for each company
4093 for (auto &p : used_stations) {
4094 auto owner = p.first->owner;
4095 auto rating = p.first->goods[type].rating;
4096 if (rating > company_best[owner]) {
4097 best_sum += rating - company_best[owner]; // it's usually faster than iterating companies later
4098 company_best[owner] = rating;
4099 if (rating > best_rating) best_rating = rating;
4101 company_sum[owner] += rating;
4104 /* From now we'll calculate with fractional cargo amounts.
4105 * First determine how much cargo we really have. */
4106 amount *= best_rating + 1;
4108 uint moving = 0;
4109 for (auto &p : used_stations) {
4110 uint owner = p.first->owner;
4111 /* Multiply the amount by (company best / sum of best for each company) to get cargo allocated to a company
4112 * and by (station rating / sum of ratings in a company) to get the result for a single station. */
4113 p.second = amount * company_best[owner] * p.first->goods[type].rating / best_sum / company_sum[owner];
4114 moving += p.second;
4117 /* If there is some cargo left due to rounding issues distribute it among the best rated stations. */
4118 if (amount > moving) {
4119 std::sort(used_stations.begin(), used_stations.end(), [type] (const StationInfo &a, const StationInfo &b) {
4120 return b.first->goods[type].rating < a.first->goods[type].rating;
4123 assert(amount - moving <= used_stations.size());
4124 for (uint i = 0; i < amount - moving; i++) {
4125 used_stations[i].second++;
4129 uint moved = 0;
4130 for (auto &p : used_stations) {
4131 moved += UpdateStationWaiting(p.first, type, p.second, source_type, source_id);
4134 return moved;
4137 void UpdateStationDockingTiles(Station *st)
4139 st->docking_station.Clear();
4141 /* For neutral stations, start with the industry area instead of dock area */
4142 const TileArea *area = st->industry != nullptr ? &st->industry->location : &st->ship_station;
4144 if (area->tile == INVALID_TILE) return;
4146 int x = TileX(area->tile);
4147 int y = TileY(area->tile);
4149 /* Expand the area by a tile on each side while
4150 * making sure that we remain inside the map. */
4151 int x2 = min(x + area->w + 1, MapSizeX());
4152 int x1 = max(x - 1, 0);
4154 int y2 = min(y + area->h + 1, MapSizeY());
4155 int y1 = max(y - 1, 0);
4157 TileArea ta(TileXY(x1, y1), TileXY(x2 - 1, y2 - 1));
4158 TILE_AREA_LOOP(tile, ta) {
4159 if (IsValidTile(tile) && IsPossibleDockingTile(tile)) CheckForDockingTile(tile);
4163 void BuildOilRig(TileIndex tile)
4165 if (!Station::CanAllocateItem()) {
4166 DEBUG(misc, 0, "Can't allocate station for oilrig at 0x%X, reverting to oilrig only", tile);
4167 return;
4170 Station *st = new Station(tile);
4171 _station_kdtree.Insert(st->index);
4172 st->town = ClosestTownFromTile(tile, UINT_MAX);
4174 st->string_id = GenerateStationName(st, tile, STATIONNAMING_OILRIG);
4176 assert(IsTileType(tile, MP_INDUSTRY));
4177 /* Mark industry as associated both ways */
4178 st->industry = Industry::GetByTile(tile);
4179 st->industry->neutral_station = st;
4180 DeleteAnimatedTile(tile);
4181 MakeOilrig(tile, st->index, GetWaterClass(tile));
4183 st->owner = OWNER_NONE;
4184 st->airport.type = AT_OILRIG;
4185 st->airport.Add(tile);
4186 st->ship_station.Add(tile);
4187 st->facilities = FACIL_AIRPORT | FACIL_DOCK;
4188 st->build_date = _date;
4189 UpdateStationDockingTiles(st);
4191 st->rect.BeforeAddTile(tile, StationRect::ADD_FORCE);
4193 st->UpdateVirtCoord();
4194 st->RecomputeCatchment();
4195 UpdateStationAcceptance(st, false);
4198 void DeleteOilRig(TileIndex tile)
4200 Station *st = Station::GetByTile(tile);
4202 MakeWaterKeepingClass(tile, OWNER_NONE);
4204 /* The oil rig station is not supposed to be shared with anything else */
4205 assert(st->facilities == (FACIL_AIRPORT | FACIL_DOCK) && st->airport.type == AT_OILRIG);
4206 if (st->industry != nullptr && st->industry->neutral_station == st) {
4207 /* Don't leave dangling neutral station pointer */
4208 st->industry->neutral_station = nullptr;
4210 delete st;
4213 static void ChangeTileOwner_Station(TileIndex tile, Owner old_owner, Owner new_owner)
4215 if (IsRoadStopTile(tile)) {
4216 FOR_ALL_ROADTRAMTYPES(rtt) {
4217 /* Update all roadtypes, no matter if they are present */
4218 if (GetRoadOwner(tile, rtt) == old_owner) {
4219 RoadType rt = GetRoadType(tile, rtt);
4220 if (rt != INVALID_ROADTYPE) {
4221 /* A drive-through road-stop has always two road bits. No need to dirty windows here, we'll redraw the whole screen anyway. */
4222 Company::Get(old_owner)->infrastructure.road[rt] -= 2;
4223 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.road[rt] += 2;
4225 SetRoadOwner(tile, rtt, new_owner == INVALID_OWNER ? OWNER_NONE : new_owner);
4230 if (!IsTileOwner(tile, old_owner)) return;
4232 if (new_owner != INVALID_OWNER) {
4233 /* Update company infrastructure counts. Only do it here
4234 * if the new owner is valid as otherwise the clear
4235 * command will do it for us. No need to dirty windows
4236 * here, we'll redraw the whole screen anyway.*/
4237 Company *old_company = Company::Get(old_owner);
4238 Company *new_company = Company::Get(new_owner);
4240 /* Update counts for underlying infrastructure. */
4241 switch (GetStationType(tile)) {
4242 case STATION_RAIL:
4243 case STATION_WAYPOINT:
4244 if (!IsStationTileBlocked(tile)) {
4245 old_company->infrastructure.rail[GetRailType(tile)]--;
4246 new_company->infrastructure.rail[GetRailType(tile)]++;
4248 break;
4250 case STATION_BUS:
4251 case STATION_TRUCK:
4252 /* Road stops were already handled above. */
4253 break;
4255 case STATION_BUOY:
4256 case STATION_DOCK:
4257 if (GetWaterClass(tile) == WATER_CLASS_CANAL) {
4258 old_company->infrastructure.water--;
4259 new_company->infrastructure.water++;
4261 break;
4263 default:
4264 break;
4267 /* Update station tile count. */
4268 if (!IsBuoy(tile) && !IsAirport(tile)) {
4269 old_company->infrastructure.station--;
4270 new_company->infrastructure.station++;
4273 /* for buoys, owner of tile is owner of water, st->owner == OWNER_NONE */
4274 SetTileOwner(tile, new_owner);
4275 InvalidateWindowClassesData(WC_STATION_LIST, 0);
4276 } else {
4277 if (IsDriveThroughStopTile(tile)) {
4278 /* Remove the drive-through road stop */
4279 DoCommand(tile, 1 | 1 << 8, (GetStationType(tile) == STATION_TRUCK) ? ROADSTOP_TRUCK : ROADSTOP_BUS, DC_EXEC | DC_BANKRUPT, CMD_REMOVE_ROAD_STOP);
4280 assert(IsTileType(tile, MP_ROAD));
4281 /* Change owner of tile and all roadtypes */
4282 ChangeTileOwner(tile, old_owner, new_owner);
4283 } else {
4284 DoCommand(tile, 0, 0, DC_EXEC | DC_BANKRUPT, CMD_LANDSCAPE_CLEAR);
4285 /* Set tile owner of water under (now removed) buoy and dock to OWNER_NONE.
4286 * Update owner of buoy if it was not removed (was in orders).
4287 * Do not update when owned by OWNER_WATER (sea and rivers). */
4288 if ((IsTileType(tile, MP_WATER) || IsBuoyTile(tile)) && IsTileOwner(tile, old_owner)) SetTileOwner(tile, OWNER_NONE);
4294 * Check if a drive-through road stop tile can be cleared.
4295 * Road stops built on town-owned roads check the conditions
4296 * that would allow clearing of the original road.
4297 * @param tile road stop tile to check
4298 * @param flags command flags
4299 * @return true if the road can be cleared
4301 static bool CanRemoveRoadWithStop(TileIndex tile, DoCommandFlag flags)
4303 /* Yeah... water can always remove stops, right? */
4304 if (_current_company == OWNER_WATER) return true;
4306 if (GetRoadTypeTram(tile) != INVALID_ROADTYPE) {
4307 Owner tram_owner = GetRoadOwner(tile, RTT_TRAM);
4308 if (tram_owner != OWNER_NONE && CheckOwnership(tram_owner).Failed()) return false;
4310 if (GetRoadTypeRoad(tile) != INVALID_ROADTYPE) {
4311 Owner road_owner = GetRoadOwner(tile, RTT_ROAD);
4312 if (road_owner != OWNER_TOWN) {
4313 if (road_owner != OWNER_NONE && CheckOwnership(road_owner).Failed()) return false;
4314 } else {
4315 if (CheckAllowRemoveRoad(tile, GetAnyRoadBits(tile, RTT_ROAD), OWNER_TOWN, RTT_ROAD, flags).Failed()) return false;
4319 return true;
4323 * Clear a single tile of a station.
4324 * @param tile The tile to clear.
4325 * @param flags The DoCommand flags related to the "command".
4326 * @return The cost, or error of clearing.
4328 CommandCost ClearTile_Station(TileIndex tile, DoCommandFlag flags)
4330 if (flags & DC_AUTO) {
4331 switch (GetStationType(tile)) {
4332 default: break;
4333 case STATION_RAIL: return_cmd_error(STR_ERROR_MUST_DEMOLISH_RAILROAD);
4334 case STATION_WAYPOINT: return_cmd_error(STR_ERROR_BUILDING_MUST_BE_DEMOLISHED);
4335 case STATION_AIRPORT: return_cmd_error(STR_ERROR_MUST_DEMOLISH_AIRPORT_FIRST);
4336 case STATION_TRUCK: return_cmd_error(HasTileRoadType(tile, RTT_TRAM) ? STR_ERROR_MUST_DEMOLISH_CARGO_TRAM_STATION_FIRST : STR_ERROR_MUST_DEMOLISH_TRUCK_STATION_FIRST);
4337 case STATION_BUS: return_cmd_error(HasTileRoadType(tile, RTT_TRAM) ? STR_ERROR_MUST_DEMOLISH_PASSENGER_TRAM_STATION_FIRST : STR_ERROR_MUST_DEMOLISH_BUS_STATION_FIRST);
4338 case STATION_BUOY: return_cmd_error(STR_ERROR_BUOY_IN_THE_WAY);
4339 case STATION_DOCK: return_cmd_error(STR_ERROR_MUST_DEMOLISH_DOCK_FIRST);
4340 case STATION_OILRIG:
4341 SetDParam(1, STR_INDUSTRY_NAME_OIL_RIG);
4342 return_cmd_error(STR_ERROR_GENERIC_OBJECT_IN_THE_WAY);
4346 switch (GetStationType(tile)) {
4347 case STATION_RAIL: return RemoveRailStation(tile, flags);
4348 case STATION_WAYPOINT: return RemoveRailWaypoint(tile, flags);
4349 case STATION_AIRPORT: return RemoveAirport(tile, flags);
4350 case STATION_TRUCK:
4351 if (IsDriveThroughStopTile(tile) && !CanRemoveRoadWithStop(tile, flags)) {
4352 return_cmd_error(STR_ERROR_MUST_DEMOLISH_TRUCK_STATION_FIRST);
4354 return RemoveRoadStop(tile, flags);
4355 case STATION_BUS:
4356 if (IsDriveThroughStopTile(tile) && !CanRemoveRoadWithStop(tile, flags)) {
4357 return_cmd_error(STR_ERROR_MUST_DEMOLISH_BUS_STATION_FIRST);
4359 return RemoveRoadStop(tile, flags);
4360 case STATION_BUOY: return RemoveBuoy(tile, flags);
4361 case STATION_DOCK: return RemoveDock(tile, flags);
4362 default: break;
4365 return CMD_ERROR;
4368 static CommandCost TerraformTile_Station(TileIndex tile, DoCommandFlag flags, int z_new, Slope tileh_new)
4370 if (_settings_game.construction.build_on_slopes && AutoslopeEnabled()) {
4371 /* TODO: If you implement newgrf callback 149 'land slope check', you have to decide what to do with it here.
4372 * TTDP does not call it.
4374 if (GetTileMaxZ(tile) == z_new + GetSlopeMaxZ(tileh_new)) {
4375 switch (GetStationType(tile)) {
4376 case STATION_WAYPOINT:
4377 case STATION_RAIL: {
4378 DiagDirection direction = AxisToDiagDir(GetRailStationAxis(tile));
4379 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, direction)) break;
4380 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, ReverseDiagDir(direction))) break;
4381 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4384 case STATION_AIRPORT:
4385 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4387 case STATION_TRUCK:
4388 case STATION_BUS: {
4389 DiagDirection direction = GetRoadStopDir(tile);
4390 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, direction)) break;
4391 if (IsDriveThroughStopTile(tile)) {
4392 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, ReverseDiagDir(direction))) break;
4394 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4397 default: break;
4401 return DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
4405 * Get flow for a station.
4406 * @param st Station to get flow for.
4407 * @return Flow for st.
4409 uint FlowStat::GetShare(StationID st) const
4411 uint32 prev = 0;
4412 for (SharesMap::const_iterator it = this->shares.begin(); it != this->shares.end(); ++it) {
4413 if (it->second == st) {
4414 return it->first - prev;
4415 } else {
4416 prev = it->first;
4419 return 0;
4423 * Get a station a package can be routed to, but exclude the given ones.
4424 * @param excluded StationID not to be selected.
4425 * @param excluded2 Another StationID not to be selected.
4426 * @return A station ID from the shares map.
4428 StationID FlowStat::GetVia(StationID excluded, StationID excluded2) const
4430 if (this->unrestricted == 0) return INVALID_STATION;
4431 assert(!this->shares.empty());
4432 SharesMap::const_iterator it = this->shares.upper_bound(RandomRange(this->unrestricted));
4433 assert(it != this->shares.end() && it->first <= this->unrestricted);
4434 if (it->second != excluded && it->second != excluded2) return it->second;
4436 /* We've hit one of the excluded stations.
4437 * Draw another share, from outside its range. */
4439 uint end = it->first;
4440 uint begin = (it == this->shares.begin() ? 0 : (--it)->first);
4441 uint interval = end - begin;
4442 if (interval >= this->unrestricted) return INVALID_STATION; // Only one station in the map.
4443 uint new_max = this->unrestricted - interval;
4444 uint rand = RandomRange(new_max);
4445 SharesMap::const_iterator it2 = (rand < begin) ? this->shares.upper_bound(rand) :
4446 this->shares.upper_bound(rand + interval);
4447 assert(it2 != this->shares.end() && it2->first <= this->unrestricted);
4448 if (it2->second != excluded && it2->second != excluded2) return it2->second;
4450 /* We've hit the second excluded station.
4451 * Same as before, only a bit more complicated. */
4453 uint end2 = it2->first;
4454 uint begin2 = (it2 == this->shares.begin() ? 0 : (--it2)->first);
4455 uint interval2 = end2 - begin2;
4456 if (interval2 >= new_max) return INVALID_STATION; // Only the two excluded stations in the map.
4457 new_max -= interval2;
4458 if (begin > begin2) {
4459 Swap(begin, begin2);
4460 Swap(end, end2);
4461 Swap(interval, interval2);
4463 rand = RandomRange(new_max);
4464 SharesMap::const_iterator it3 = this->shares.upper_bound(this->unrestricted);
4465 if (rand < begin) {
4466 it3 = this->shares.upper_bound(rand);
4467 } else if (rand < begin2 - interval) {
4468 it3 = this->shares.upper_bound(rand + interval);
4469 } else {
4470 it3 = this->shares.upper_bound(rand + interval + interval2);
4472 assert(it3 != this->shares.end() && it3->first <= this->unrestricted);
4473 return it3->second;
4477 * Reduce all flows to minimum capacity so that they don't get in the way of
4478 * link usage statistics too much. Keep them around, though, to continue
4479 * routing any remaining cargo.
4481 void FlowStat::Invalidate()
4483 assert(!this->shares.empty());
4484 SharesMap new_shares;
4485 uint i = 0;
4486 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
4487 new_shares[++i] = it->second;
4488 if (it->first == this->unrestricted) this->unrestricted = i;
4490 this->shares.swap(new_shares);
4491 assert(!this->shares.empty() && this->unrestricted <= (--this->shares.end())->first);
4495 * Change share for specified station. By specifying INT_MIN as parameter you
4496 * can erase a share. Newly added flows will be unrestricted.
4497 * @param st Next Hop to be removed.
4498 * @param flow Share to be added or removed.
4500 void FlowStat::ChangeShare(StationID st, int flow)
4502 /* We assert only before changing as afterwards the shares can actually
4503 * be empty. In that case the whole flow stat must be deleted then. */
4504 assert(!this->shares.empty());
4506 uint removed_shares = 0;
4507 uint added_shares = 0;
4508 uint last_share = 0;
4509 SharesMap new_shares;
4510 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
4511 if (it->second == st) {
4512 if (flow < 0) {
4513 uint share = it->first - last_share;
4514 if (flow == INT_MIN || (uint)(-flow) >= share) {
4515 removed_shares += share;
4516 if (it->first <= this->unrestricted) this->unrestricted -= share;
4517 if (flow != INT_MIN) flow += share;
4518 last_share = it->first;
4519 continue; // remove the whole share
4521 removed_shares += (uint)(-flow);
4522 } else {
4523 added_shares += (uint)(flow);
4525 if (it->first <= this->unrestricted) this->unrestricted += flow;
4527 /* If we don't continue above the whole flow has been added or
4528 * removed. */
4529 flow = 0;
4531 new_shares[it->first + added_shares - removed_shares] = it->second;
4532 last_share = it->first;
4534 if (flow > 0) {
4535 new_shares[last_share + (uint)flow] = st;
4536 if (this->unrestricted < last_share) {
4537 this->ReleaseShare(st);
4538 } else {
4539 this->unrestricted += flow;
4542 this->shares.swap(new_shares);
4546 * Restrict a flow by moving it to the end of the map and decreasing the amount
4547 * of unrestricted flow.
4548 * @param st Station of flow to be restricted.
4550 void FlowStat::RestrictShare(StationID st)
4552 assert(!this->shares.empty());
4553 uint flow = 0;
4554 uint last_share = 0;
4555 SharesMap new_shares;
4556 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
4557 if (flow == 0) {
4558 if (it->first > this->unrestricted) return; // Not present or already restricted.
4559 if (it->second == st) {
4560 flow = it->first - last_share;
4561 this->unrestricted -= flow;
4562 } else {
4563 new_shares[it->first] = it->second;
4565 } else {
4566 new_shares[it->first - flow] = it->second;
4568 last_share = it->first;
4570 if (flow == 0) return;
4571 new_shares[last_share + flow] = st;
4572 this->shares.swap(new_shares);
4573 assert(!this->shares.empty());
4577 * Release ("unrestrict") a flow by moving it to the begin of the map and
4578 * increasing the amount of unrestricted flow.
4579 * @param st Station of flow to be released.
4581 void FlowStat::ReleaseShare(StationID st)
4583 assert(!this->shares.empty());
4584 uint flow = 0;
4585 uint next_share = 0;
4586 bool found = false;
4587 for (SharesMap::reverse_iterator it(this->shares.rbegin()); it != this->shares.rend(); ++it) {
4588 if (it->first < this->unrestricted) return; // Note: not <= as the share may hit the limit.
4589 if (found) {
4590 flow = next_share - it->first;
4591 this->unrestricted += flow;
4592 break;
4593 } else {
4594 if (it->first == this->unrestricted) return; // !found -> Limit not hit.
4595 if (it->second == st) found = true;
4597 next_share = it->first;
4599 if (flow == 0) return;
4600 SharesMap new_shares;
4601 new_shares[flow] = st;
4602 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
4603 if (it->second != st) {
4604 new_shares[flow + it->first] = it->second;
4605 } else {
4606 flow = 0;
4609 this->shares.swap(new_shares);
4610 assert(!this->shares.empty());
4614 * Scale all shares from link graph's runtime to monthly values.
4615 * @param runtime Time the link graph has been running without compression.
4616 * @pre runtime must be greater than 0 as we don't want infinite flow values.
4618 void FlowStat::ScaleToMonthly(uint runtime)
4620 assert(runtime > 0);
4621 SharesMap new_shares;
4622 uint share = 0;
4623 for (SharesMap::iterator i = this->shares.begin(); i != this->shares.end(); ++i) {
4624 share = max(share + 1, i->first * 30 / runtime);
4625 new_shares[share] = i->second;
4626 if (this->unrestricted == i->first) this->unrestricted = share;
4628 this->shares.swap(new_shares);
4632 * Add some flow from "origin", going via "via".
4633 * @param origin Origin of the flow.
4634 * @param via Next hop.
4635 * @param flow Amount of flow to be added.
4637 void FlowStatMap::AddFlow(StationID origin, StationID via, uint flow)
4639 FlowStatMap::iterator origin_it = this->find(origin);
4640 if (origin_it == this->end()) {
4641 this->insert(std::make_pair(origin, FlowStat(via, flow)));
4642 } else {
4643 origin_it->second.ChangeShare(via, flow);
4644 assert(!origin_it->second.GetShares()->empty());
4649 * Pass on some flow, remembering it as invalid, for later subtraction from
4650 * locally consumed flow. This is necessary because we can't have negative
4651 * flows and we don't want to sort the flows before adding them up.
4652 * @param origin Origin of the flow.
4653 * @param via Next hop.
4654 * @param flow Amount of flow to be passed.
4656 void FlowStatMap::PassOnFlow(StationID origin, StationID via, uint flow)
4658 FlowStatMap::iterator prev_it = this->find(origin);
4659 if (prev_it == this->end()) {
4660 FlowStat fs(via, flow);
4661 fs.AppendShare(INVALID_STATION, flow);
4662 this->insert(std::make_pair(origin, fs));
4663 } else {
4664 prev_it->second.ChangeShare(via, flow);
4665 prev_it->second.ChangeShare(INVALID_STATION, flow);
4666 assert(!prev_it->second.GetShares()->empty());
4671 * Subtract invalid flows from locally consumed flow.
4672 * @param self ID of own station.
4674 void FlowStatMap::FinalizeLocalConsumption(StationID self)
4676 for (FlowStatMap::iterator i = this->begin(); i != this->end(); ++i) {
4677 FlowStat &fs = i->second;
4678 uint local = fs.GetShare(INVALID_STATION);
4679 if (local > INT_MAX) { // make sure it fits in an int
4680 fs.ChangeShare(self, -INT_MAX);
4681 fs.ChangeShare(INVALID_STATION, -INT_MAX);
4682 local -= INT_MAX;
4684 fs.ChangeShare(self, -(int)local);
4685 fs.ChangeShare(INVALID_STATION, -(int)local);
4687 /* If the local share is used up there must be a share for some
4688 * remote station. */
4689 assert(!fs.GetShares()->empty());
4694 * Delete all flows at a station for specific cargo and destination.
4695 * @param via Remote station of flows to be deleted.
4696 * @return IDs of source stations for which the complete FlowStat, not only a
4697 * share, has been erased.
4699 StationIDStack FlowStatMap::DeleteFlows(StationID via)
4701 StationIDStack ret;
4702 for (FlowStatMap::iterator f_it = this->begin(); f_it != this->end();) {
4703 FlowStat &s_flows = f_it->second;
4704 s_flows.ChangeShare(via, INT_MIN);
4705 if (s_flows.GetShares()->empty()) {
4706 ret.Push(f_it->first);
4707 this->erase(f_it++);
4708 } else {
4709 ++f_it;
4712 return ret;
4716 * Restrict all flows at a station for specific cargo and destination.
4717 * @param via Remote station of flows to be restricted.
4719 void FlowStatMap::RestrictFlows(StationID via)
4721 for (FlowStatMap::iterator it = this->begin(); it != this->end(); ++it) {
4722 it->second.RestrictShare(via);
4727 * Release all flows at a station for specific cargo and destination.
4728 * @param via Remote station of flows to be released.
4730 void FlowStatMap::ReleaseFlows(StationID via)
4732 for (FlowStatMap::iterator it = this->begin(); it != this->end(); ++it) {
4733 it->second.ReleaseShare(via);
4738 * Get the sum of all flows from this FlowStatMap.
4739 * @return sum of all flows.
4741 uint FlowStatMap::GetFlow() const
4743 uint ret = 0;
4744 for (FlowStatMap::const_iterator i = this->begin(); i != this->end(); ++i) {
4745 ret += (--(i->second.GetShares()->end()))->first;
4747 return ret;
4751 * Get the sum of flows via a specific station from this FlowStatMap.
4752 * @param via Remote station to look for.
4753 * @return all flows for 'via' added up.
4755 uint FlowStatMap::GetFlowVia(StationID via) const
4757 uint ret = 0;
4758 for (FlowStatMap::const_iterator i = this->begin(); i != this->end(); ++i) {
4759 ret += i->second.GetShare(via);
4761 return ret;
4765 * Get the sum of flows from a specific station from this FlowStatMap.
4766 * @param from Origin station to look for.
4767 * @return all flows from 'from' added up.
4769 uint FlowStatMap::GetFlowFrom(StationID from) const
4771 FlowStatMap::const_iterator i = this->find(from);
4772 if (i == this->end()) return 0;
4773 return (--(i->second.GetShares()->end()))->first;
4777 * Get the flow from a specific station via a specific other station.
4778 * @param from Origin station to look for.
4779 * @param via Remote station to look for.
4780 * @return flow share originating at 'from' and going to 'via'.
4782 uint FlowStatMap::GetFlowFromVia(StationID from, StationID via) const
4784 FlowStatMap::const_iterator i = this->find(from);
4785 if (i == this->end()) return 0;
4786 return i->second.GetShare(via);
4789 extern const TileTypeProcs _tile_type_station_procs = {
4790 DrawTile_Station, // draw_tile_proc
4791 GetSlopePixelZ_Station, // get_slope_z_proc
4792 ClearTile_Station, // clear_tile_proc
4793 nullptr, // add_accepted_cargo_proc
4794 GetTileDesc_Station, // get_tile_desc_proc
4795 GetTileTrackStatus_Station, // get_tile_track_status_proc
4796 ClickTile_Station, // click_tile_proc
4797 AnimateTile_Station, // animate_tile_proc
4798 TileLoop_Station, // tile_loop_proc
4799 ChangeTileOwner_Station, // change_tile_owner_proc
4800 nullptr, // add_produced_cargo_proc
4801 VehicleEnter_Station, // vehicle_enter_tile_proc
4802 GetFoundation_Station, // get_foundation_proc
4803 TerraformTile_Station, // terraform_tile_proc