(svn r27756) -Codechange: Add StringTab enum
[openttd.git] / src / station_cmd.cpp
blob610cf7216a3b5455259debcd20cb0ef00fe67a50
1 /* $Id$ */
3 /*
4 * This file is part of OpenTTD.
5 * 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.
6 * 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.
7 * 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/>.
8 */
10 /** @file station_cmd.cpp Handling of station tiles. */
12 #include "stdafx.h"
13 #include "aircraft.h"
14 #include "bridge_map.h"
15 #include "cmd_helper.h"
16 #include "viewport_func.h"
17 #include "command_func.h"
18 #include "town.h"
19 #include "news_func.h"
20 #include "train.h"
21 #include "ship.h"
22 #include "roadveh.h"
23 #include "industry.h"
24 #include "newgrf_cargo.h"
25 #include "newgrf_debug.h"
26 #include "newgrf_station.h"
27 #include "newgrf_canal.h" /* For the buoy */
28 #include "pathfinder/yapf/yapf_cache.h"
29 #include "road_internal.h" /* For drawing catenary/checking road removal */
30 #include "autoslope.h"
31 #include "water.h"
32 #include "strings_func.h"
33 #include "clear_func.h"
34 #include "date_func.h"
35 #include "vehicle_func.h"
36 #include "string_func.h"
37 #include "animated_tile_func.h"
38 #include "elrail_func.h"
39 #include "station_base.h"
40 #include "roadstop_base.h"
41 #include "newgrf_railtype.h"
42 #include "waypoint_base.h"
43 #include "waypoint_func.h"
44 #include "pbs.h"
45 #include "debug.h"
46 #include "core/random_func.hpp"
47 #include "company_base.h"
48 #include "table/airporttile_ids.h"
49 #include "newgrf_airporttiles.h"
50 #include "order_backup.h"
51 #include "newgrf_house.h"
52 #include "company_gui.h"
53 #include "linkgraph/linkgraph_base.h"
54 #include "linkgraph/refresh.h"
55 #include "widgets/station_widget.h"
57 #include "table/strings.h"
59 #include "safeguards.h"
61 /**
62 * Static instance of FlowStat::SharesMap.
63 * Note: This instance is created on task start.
64 * Lazy creation on first usage results in a data race between the CDist threads.
66 /* static */ const FlowStat::SharesMap FlowStat::empty_sharesmap;
68 /**
69 * Check whether the given tile is a hangar.
70 * @param t the tile to of whether it is a hangar.
71 * @pre IsTileType(t, MP_STATION)
72 * @return true if and only if the tile is a hangar.
74 bool IsHangar(TileIndex t)
76 assert(IsTileType(t, MP_STATION));
78 /* If the tile isn't an airport there's no chance it's a hangar. */
79 if (!IsAirport(t)) return false;
81 const Station *st = Station::GetByTile(t);
82 const AirportSpec *as = st->airport.GetSpec();
84 for (uint i = 0; i < as->nof_depots; i++) {
85 if (st->airport.GetHangarTile(i) == t) return true;
88 return false;
91 /**
92 * Look for a station around the given tile area.
93 * @param ta the area to search over
94 * @param closest_station the closest station found so far
95 * @param st to 'return' the found station
96 * @return Succeeded command (if zero or one station found) or failed command (for two or more stations found).
98 template <class T>
99 CommandCost GetStationAround(TileArea ta, StationID closest_station, T **st)
101 ta.tile -= TileDiffXY(1, 1);
102 ta.w += 2;
103 ta.h += 2;
105 /* check around to see if there's any stations there */
106 TILE_AREA_LOOP(tile_cur, ta) {
107 if (IsTileType(tile_cur, MP_STATION)) {
108 StationID t = GetStationIndex(tile_cur);
109 if (!T::IsValidID(t)) 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) ? NULL : 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 const Station *s;
255 FOR_ALL_STATIONS(s) {
256 if (s != st && s->town == t) {
257 if (s->indtype != IT_INVALID) {
258 indtypes[s->indtype] = true;
259 StringID name = GetIndustrySpec(s->indtype)->station_name;
260 if (name != STR_UNDEFINED) {
261 /* Filter for other industrytypes with the same name */
262 for (IndustryType it = 0; it < NUM_INDUSTRYTYPES; it++) {
263 const IndustrySpec *indsp = GetIndustrySpec(it);
264 if (indsp->enabled && indsp->station_name == name) indtypes[it] = true;
267 continue;
269 uint str = M(s->string_id);
270 if (str <= 0x20) {
271 if (str == M(STR_SV_STNAME_FOREST)) {
272 str = M(STR_SV_STNAME_WOODS);
274 ClrBit(free_names, str);
279 TileIndex indtile = tile;
280 StationNameInformation sni = { free_names, indtypes };
281 if (CircularTileSearch(&indtile, 7, FindNearIndustryName, &sni)) {
282 /* An industry has been found nearby */
283 IndustryType indtype = GetIndustryType(indtile);
284 const IndustrySpec *indsp = GetIndustrySpec(indtype);
285 /* STR_NULL means it only disables oil rig/mines */
286 if (indsp->station_name != STR_NULL) {
287 st->indtype = indtype;
288 return STR_SV_STNAME_FALLBACK;
292 /* Oil rigs/mines name could be marked not free by looking for a near by industry. */
293 free_names = sni.free_names;
295 /* check default names */
296 uint32 tmp = free_names & _gen_station_name_bits[name_class];
297 if (tmp != 0) return STR_SV_STNAME + FindFirstBit(tmp);
299 /* check mine? */
300 if (HasBit(free_names, M(STR_SV_STNAME_MINES))) {
301 if (CountMapSquareAround(tile, CMSAMine) >= 2) {
302 return STR_SV_STNAME_MINES;
306 /* check close enough to town to get central as name? */
307 if (DistanceMax(tile, t->xy) < 8) {
308 if (HasBit(free_names, M(STR_SV_STNAME))) return STR_SV_STNAME;
310 if (HasBit(free_names, M(STR_SV_STNAME_CENTRAL))) return STR_SV_STNAME_CENTRAL;
313 /* Check lakeside */
314 if (HasBit(free_names, M(STR_SV_STNAME_LAKESIDE)) &&
315 DistanceFromEdge(tile) < 20 &&
316 CountMapSquareAround(tile, CMSAWater) >= 5) {
317 return STR_SV_STNAME_LAKESIDE;
320 /* Check woods */
321 if (HasBit(free_names, M(STR_SV_STNAME_WOODS)) && (
322 CountMapSquareAround(tile, CMSATree) >= 8 ||
323 CountMapSquareAround(tile, IsTileForestIndustry) >= 2)
325 return _settings_game.game_creation.landscape == LT_TROPIC ? STR_SV_STNAME_FOREST : STR_SV_STNAME_WOODS;
328 /* check elevation compared to town */
329 int z = GetTileZ(tile);
330 int z2 = GetTileZ(t->xy);
331 if (z < z2) {
332 if (HasBit(free_names, M(STR_SV_STNAME_VALLEY))) return STR_SV_STNAME_VALLEY;
333 } else if (z > z2) {
334 if (HasBit(free_names, M(STR_SV_STNAME_HEIGHTS))) return STR_SV_STNAME_HEIGHTS;
337 /* check direction compared to town */
338 static const int8 _direction_and_table[] = {
339 ~( (1 << M(STR_SV_STNAME_WEST)) | (1 << M(STR_SV_STNAME_EAST)) | (1 << M(STR_SV_STNAME_NORTH)) ),
340 ~( (1 << M(STR_SV_STNAME_SOUTH)) | (1 << M(STR_SV_STNAME_WEST)) | (1 << M(STR_SV_STNAME_NORTH)) ),
341 ~( (1 << M(STR_SV_STNAME_SOUTH)) | (1 << M(STR_SV_STNAME_EAST)) | (1 << M(STR_SV_STNAME_NORTH)) ),
342 ~( (1 << M(STR_SV_STNAME_SOUTH)) | (1 << M(STR_SV_STNAME_WEST)) | (1 << M(STR_SV_STNAME_EAST)) ),
345 free_names &= _direction_and_table[
346 (TileX(tile) < TileX(t->xy)) +
347 (TileY(tile) < TileY(t->xy)) * 2];
349 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));
350 return (tmp == 0) ? STR_SV_STNAME_FALLBACK : (STR_SV_STNAME + FindFirstBit(tmp));
352 #undef M
355 * Find the closest deleted station of the current company
356 * @param tile the tile to search from.
357 * @return the closest station or NULL if too far.
359 static Station *GetClosestDeletedStation(TileIndex tile)
361 uint threshold = 8;
362 Station *best_station = NULL;
363 Station *st;
365 FOR_ALL_STATIONS(st) {
366 if (!st->IsInUse() && st->owner == _current_company) {
367 uint cur_dist = DistanceManhattan(tile, st->xy);
369 if (cur_dist < threshold) {
370 threshold = cur_dist;
371 best_station = st;
376 return best_station;
380 void Station::GetTileArea(TileArea *ta, StationType type) const
382 switch (type) {
383 case STATION_RAIL:
384 *ta = this->train_station;
385 return;
387 case STATION_AIRPORT:
388 *ta = this->airport;
389 return;
391 case STATION_TRUCK:
392 *ta = this->truck_station;
393 return;
395 case STATION_BUS:
396 *ta = this->bus_station;
397 return;
399 case STATION_DOCK:
400 case STATION_OILRIG:
401 ta->tile = this->dock_tile;
402 break;
404 default: NOT_REACHED();
407 ta->w = 1;
408 ta->h = 1;
412 * Update the virtual coords needed to draw the station sign.
414 void Station::UpdateVirtCoord()
416 Point pt = RemapCoords2(TileX(this->xy) * TILE_SIZE, TileY(this->xy) * TILE_SIZE);
418 pt.y -= 32 * ZOOM_LVL_BASE;
419 if ((this->facilities & FACIL_AIRPORT) && this->airport.type == AT_OILRIG) pt.y -= 16 * ZOOM_LVL_BASE;
421 SetDParam(0, this->index);
422 SetDParam(1, this->facilities);
423 this->sign.UpdatePosition(pt.x, pt.y, STR_VIEWPORT_STATION);
425 SetWindowDirty(WC_STATION_VIEW, this->index);
428 /** Update the virtual coords needed to draw the station sign for all stations. */
429 void UpdateAllStationVirtCoords()
431 BaseStation *st;
433 FOR_ALL_BASE_STATIONS(st) {
434 st->UpdateVirtCoord();
439 * Get a mask of the cargo types that the station accepts.
440 * @param st Station to query
441 * @return the expected mask
443 static uint GetAcceptanceMask(const Station *st)
445 uint mask = 0;
447 for (CargoID i = 0; i < NUM_CARGO; i++) {
448 if (HasBit(st->goods[i].status, GoodsEntry::GES_ACCEPTANCE)) mask |= 1 << i;
450 return mask;
454 * Items contains the two cargo names that are to be accepted or rejected.
455 * msg is the string id of the message to display.
457 static void ShowRejectOrAcceptNews(const Station *st, uint num_items, CargoID *cargo, StringID msg)
459 for (uint i = 0; i < num_items; i++) {
460 SetDParam(i + 1, CargoSpec::Get(cargo[i])->name);
463 SetDParam(0, st->index);
464 AddNewsItem(msg, NT_ACCEPTANCE, NF_INCOLOUR | NF_SMALL, NR_STATION, st->index);
468 * Get the cargo types being produced around the tile (in a rectangle).
469 * @param tile Northtile of area
470 * @param w X extent of the area
471 * @param h Y extent of the area
472 * @param rad Search radius in addition to the given area
474 CargoArray GetProductionAroundTiles(TileIndex tile, int w, int h, int rad)
476 CargoArray produced;
478 int x = TileX(tile);
479 int y = TileY(tile);
481 /* expand the region by rad tiles on each side
482 * while making sure that we remain inside the board. */
483 int x2 = min(x + w + rad, MapSizeX());
484 int x1 = max(x - rad, 0);
486 int y2 = min(y + h + rad, MapSizeY());
487 int y1 = max(y - rad, 0);
489 assert(x1 < x2);
490 assert(y1 < y2);
491 assert(w > 0);
492 assert(h > 0);
494 TileArea ta(TileXY(x1, y1), TileXY(x2 - 1, y2 - 1));
496 /* Loop over all tiles to get the produced cargo of
497 * everything except industries */
498 TILE_AREA_LOOP(tile, ta) AddProducedCargo(tile, produced);
500 /* Loop over the industries. They produce cargo for
501 * anything that is within 'rad' from their bounding
502 * box. As such if you have e.g. a oil well the tile
503 * area loop might not hit an industry tile while
504 * the industry would produce cargo for the station.
506 const Industry *i;
507 FOR_ALL_INDUSTRIES(i) {
508 if (!ta.Intersects(i->location)) continue;
510 for (uint j = 0; j < lengthof(i->produced_cargo); j++) {
511 CargoID cargo = i->produced_cargo[j];
512 if (cargo != CT_INVALID) produced[cargo]++;
516 return produced;
520 * Get the acceptance of cargoes around the tile in 1/8.
521 * @param tile Center of the search area
522 * @param w X extent of area
523 * @param h Y extent of area
524 * @param rad Search radius in addition to given area
525 * @param always_accepted bitmask of cargo accepted by houses and headquarters; can be NULL
527 CargoArray GetAcceptanceAroundTiles(TileIndex tile, int w, int h, int rad, uint32 *always_accepted)
529 CargoArray acceptance;
530 if (always_accepted != NULL) *always_accepted = 0;
532 int x = TileX(tile);
533 int y = TileY(tile);
535 /* expand the region by rad tiles on each side
536 * while making sure that we remain inside the board. */
537 int x2 = min(x + w + rad, MapSizeX());
538 int y2 = min(y + h + rad, MapSizeY());
539 int x1 = max(x - rad, 0);
540 int y1 = max(y - rad, 0);
542 assert(x1 < x2);
543 assert(y1 < y2);
544 assert(w > 0);
545 assert(h > 0);
547 for (int yc = y1; yc != y2; yc++) {
548 for (int xc = x1; xc != x2; xc++) {
549 TileIndex tile = TileXY(xc, yc);
550 AddAcceptedCargo(tile, acceptance, always_accepted);
554 return acceptance;
558 * Update the acceptance for a station.
559 * @param st Station to update
560 * @param show_msg controls whether to display a message that acceptance was changed.
562 void UpdateStationAcceptance(Station *st, bool show_msg)
564 /* old accepted goods types */
565 uint old_acc = GetAcceptanceMask(st);
567 /* And retrieve the acceptance. */
568 CargoArray acceptance;
569 if (!st->rect.IsEmpty()) {
570 acceptance = GetAcceptanceAroundTiles(
571 TileXY(st->rect.left, st->rect.top),
572 st->rect.right - st->rect.left + 1,
573 st->rect.bottom - st->rect.top + 1,
574 st->GetCatchmentRadius(),
575 &st->always_accepted
579 /* Adjust in case our station only accepts fewer kinds of goods */
580 for (CargoID i = 0; i < NUM_CARGO; i++) {
581 uint amt = acceptance[i];
583 /* Make sure the station can accept the goods type. */
584 bool is_passengers = IsCargoInClass(i, CC_PASSENGERS);
585 if ((!is_passengers && !(st->facilities & ~FACIL_BUS_STOP)) ||
586 (is_passengers && !(st->facilities & ~FACIL_TRUCK_STOP))) {
587 amt = 0;
590 GoodsEntry &ge = st->goods[i];
591 SB(ge.status, GoodsEntry::GES_ACCEPTANCE, 1, amt >= 8);
592 if (LinkGraph::IsValidID(ge.link_graph)) {
593 (*LinkGraph::Get(ge.link_graph))[ge.node].SetDemand(amt / 8);
597 /* Only show a message in case the acceptance was actually changed. */
598 uint new_acc = GetAcceptanceMask(st);
599 if (old_acc == new_acc) return;
601 /* show a message to report that the acceptance was changed? */
602 if (show_msg && st->owner == _local_company && st->IsInUse()) {
603 /* List of accept and reject strings for different number of
604 * cargo types */
605 static const StringID accept_msg[] = {
606 STR_NEWS_STATION_NOW_ACCEPTS_CARGO,
607 STR_NEWS_STATION_NOW_ACCEPTS_CARGO_AND_CARGO,
609 static const StringID reject_msg[] = {
610 STR_NEWS_STATION_NO_LONGER_ACCEPTS_CARGO,
611 STR_NEWS_STATION_NO_LONGER_ACCEPTS_CARGO_OR_CARGO,
614 /* Array of accepted and rejected cargo types */
615 CargoID accepts[2] = { CT_INVALID, CT_INVALID };
616 CargoID rejects[2] = { CT_INVALID, CT_INVALID };
617 uint num_acc = 0;
618 uint num_rej = 0;
620 /* Test each cargo type to see if its acceptance has changed */
621 for (CargoID i = 0; i < NUM_CARGO; i++) {
622 if (HasBit(new_acc, i)) {
623 if (!HasBit(old_acc, i) && num_acc < lengthof(accepts)) {
624 /* New cargo is accepted */
625 accepts[num_acc++] = i;
627 } else {
628 if (HasBit(old_acc, i) && num_rej < lengthof(rejects)) {
629 /* Old cargo is no longer accepted */
630 rejects[num_rej++] = i;
635 /* Show news message if there are any changes */
636 if (num_acc > 0) ShowRejectOrAcceptNews(st, num_acc, accepts, accept_msg[num_acc - 1]);
637 if (num_rej > 0) ShowRejectOrAcceptNews(st, num_rej, rejects, reject_msg[num_rej - 1]);
640 /* redraw the station view since acceptance changed */
641 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_ACCEPT_RATING_LIST);
644 static void UpdateStationSignCoord(BaseStation *st)
646 const StationRect *r = &st->rect;
648 if (r->IsEmpty()) return; // no tiles belong to this station
650 /* clamp sign coord to be inside the station rect */
651 st->xy = TileXY(ClampU(TileX(st->xy), r->left, r->right), ClampU(TileY(st->xy), r->top, r->bottom));
652 st->UpdateVirtCoord();
654 if (!Station::IsExpected(st)) return;
655 Station *full_station = Station::From(st);
656 for (CargoID c = 0; c < NUM_CARGO; ++c) {
657 LinkGraphID lg = full_station->goods[c].link_graph;
658 if (!LinkGraph::IsValidID(lg)) continue;
659 (*LinkGraph::Get(lg))[full_station->goods[c].node].UpdateLocation(st->xy);
664 * Common part of building various station parts and possibly attaching them to an existing one.
665 * @param [in,out] st Station to attach to
666 * @param flags Command flags
667 * @param reuse Whether to try to reuse a deleted station (gray sign) if possible
668 * @param area Area occupied by the new part
669 * @param name_class Station naming class to use to generate the new station's name
670 * @return Command error that occurred, if any
672 static CommandCost BuildStationPart(Station **st, DoCommandFlag flags, bool reuse, TileArea area, StationNaming name_class)
674 /* Find a deleted station close to us */
675 if (*st == NULL && reuse) *st = GetClosestDeletedStation(area.tile);
677 if (*st != NULL) {
678 if ((*st)->owner != _current_company) {
679 return_cmd_error(STR_ERROR_TOO_CLOSE_TO_ANOTHER_STATION);
682 CommandCost ret = (*st)->rect.BeforeAddRect(area.tile, area.w, area.h, StationRect::ADD_TEST);
683 if (ret.Failed()) return ret;
684 } else {
685 /* allocate and initialize new station */
686 if (!Station::CanAllocateItem()) return_cmd_error(STR_ERROR_TOO_MANY_STATIONS_LOADING);
688 if (flags & DC_EXEC) {
689 *st = new Station(area.tile);
691 (*st)->town = ClosestTownFromTile(area.tile, UINT_MAX);
692 (*st)->string_id = GenerateStationName(*st, area.tile, name_class);
694 if (Company::IsValidID(_current_company)) {
695 SetBit((*st)->town->have_ratings, _current_company);
699 return CommandCost();
703 * This is called right after a station was deleted.
704 * It checks if the whole station is free of substations, and if so, the station will be
705 * deleted after a little while.
706 * @param st Station
708 static void DeleteStationIfEmpty(BaseStation *st)
710 if (!st->IsInUse()) {
711 st->delete_ctr = 0;
712 InvalidateWindowData(WC_STATION_LIST, st->owner, 0);
714 /* station remains but it probably lost some parts - station sign should stay in the station boundaries */
715 UpdateStationSignCoord(st);
718 CommandCost ClearTile_Station(TileIndex tile, DoCommandFlag flags);
721 * Checks if the given tile is buildable, flat and has a certain height.
722 * @param tile TileIndex to check.
723 * @param invalid_dirs Prohibited directions for slopes (set of #DiagDirection).
724 * @param allowed_z Height allowed for the tile. If allowed_z is negative, it will be set to the height of this tile.
725 * @param allow_steep Whether steep slopes are allowed.
726 * @param check_bridge Check for the existence of a bridge.
727 * @return The cost in case of success, or an error code if it failed.
729 CommandCost CheckBuildableTile(TileIndex tile, uint invalid_dirs, int &allowed_z, bool allow_steep, bool check_bridge = true)
731 if (check_bridge && IsBridgeAbove(tile)) {
732 return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
735 CommandCost ret = EnsureNoVehicleOnGround(tile);
736 if (ret.Failed()) return ret;
738 int z;
739 Slope tileh = GetTileSlope(tile, &z);
741 /* Prohibit building if
742 * 1) The tile is "steep" (i.e. stretches two height levels).
743 * 2) The tile is non-flat and the build_on_slopes switch is disabled.
745 if ((!allow_steep && IsSteepSlope(tileh)) ||
746 ((!_settings_game.construction.build_on_slopes) && tileh != SLOPE_FLAT)) {
747 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
750 CommandCost cost(EXPENSES_CONSTRUCTION);
751 int flat_z = z + GetSlopeMaxZ(tileh);
752 if (tileh != SLOPE_FLAT) {
753 /* Forbid building if the tile faces a slope in a invalid direction. */
754 for (DiagDirection dir = DIAGDIR_BEGIN; dir != DIAGDIR_END; dir++) {
755 if (HasBit(invalid_dirs, dir) && !CanBuildDepotByTileh(dir, tileh)) {
756 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
759 cost.AddCost(_price[PR_BUILD_FOUNDATION]);
762 /* The level of this tile must be equal to allowed_z. */
763 if (allowed_z < 0) {
764 /* First tile. */
765 allowed_z = flat_z;
766 } else if (allowed_z != flat_z) {
767 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
770 return cost;
774 * Tries to clear the given area.
775 * @param tile_area Area to check.
776 * @param flags Operation to perform.
777 * @return The cost in case of success, or an error code if it failed.
779 CommandCost CheckFlatLand(TileArea tile_area, DoCommandFlag flags)
781 CommandCost cost(EXPENSES_CONSTRUCTION);
782 int allowed_z = -1;
784 TILE_AREA_LOOP(tile_cur, tile_area) {
785 CommandCost ret = CheckBuildableTile(tile_cur, 0, allowed_z, true);
786 if (ret.Failed()) return ret;
787 cost.AddCost(ret);
789 ret = DoCommand(tile_cur, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
790 if (ret.Failed()) return ret;
791 cost.AddCost(ret);
794 return cost;
798 * Checks if a rail station can be built at the given area.
799 * @param tile_area Area to check.
800 * @param flags Operation to perform.
801 * @param axis Rail station axis.
802 * @param station StationID to be queried and returned if available.
803 * @param rt The rail type to check for (overbuilding rail stations over rail).
804 * @param affected_vehicles List of trains with PBS reservations on the tiles
805 * @param spec_class Station class.
806 * @param spec_index Index into the station class.
807 * @param plat_len Platform length.
808 * @param numtracks Number of platforms.
809 * @return The cost in case of success, or an error code if it failed.
811 static CommandCost CheckFlatLandRailStation(TileArea tile_area, DoCommandFlag flags, Axis axis, StationID *station, RailType rt, SmallVector<Train *, 4> &affected_vehicles, StationClassID spec_class, byte spec_index, byte plat_len, byte numtracks)
813 CommandCost cost(EXPENSES_CONSTRUCTION);
814 int allowed_z = -1;
815 uint invalid_dirs = 5 << axis;
817 const StationSpec *statspec = StationClass::Get(spec_class)->GetSpec(spec_index);
818 bool slope_cb = statspec != NULL && HasBit(statspec->callback_mask, CBM_STATION_SLOPE_CHECK);
820 TILE_AREA_LOOP(tile_cur, tile_area) {
821 CommandCost ret = CheckBuildableTile(tile_cur, invalid_dirs, allowed_z, false);
822 if (ret.Failed()) return ret;
823 cost.AddCost(ret);
825 if (slope_cb) {
826 /* Do slope check if requested. */
827 ret = PerformStationTileSlopeCheck(tile_area.tile, tile_cur, statspec, axis, plat_len, numtracks);
828 if (ret.Failed()) return ret;
831 /* if station is set, then we have special handling to allow building on top of already existing stations.
832 * so station points to INVALID_STATION if we can build on any station.
833 * Or it points to a station if we're only allowed to build on exactly that station. */
834 if (station != NULL && IsTileType(tile_cur, MP_STATION)) {
835 if (!IsRailStation(tile_cur)) {
836 return ClearTile_Station(tile_cur, DC_AUTO); // get error message
837 } else {
838 StationID st = GetStationIndex(tile_cur);
839 if (*station == INVALID_STATION) {
840 *station = st;
841 } else if (*station != st) {
842 return_cmd_error(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
845 } else {
846 /* Rail type is only valid when building a railway station; if station to
847 * build isn't a rail station it's INVALID_RAILTYPE. */
848 if (rt != INVALID_RAILTYPE &&
849 IsPlainRailTile(tile_cur) && !HasSignals(tile_cur) &&
850 HasPowerOnRail(GetRailType(tile_cur), rt)) {
851 /* Allow overbuilding if the tile:
852 * - has rail, but no signals
853 * - it has exactly one track
854 * - the track is in line with the station
855 * - the current rail type has power on the to-be-built type (e.g. convert normal rail to el rail)
857 TrackBits tracks = GetTrackBits(tile_cur);
858 Track track = RemoveFirstTrack(&tracks);
859 Track expected_track = HasBit(invalid_dirs, DIAGDIR_NE) ? TRACK_X : TRACK_Y;
861 if (tracks == TRACK_BIT_NONE && track == expected_track) {
862 /* Check for trains having a reservation for this tile. */
863 if (HasBit(GetRailReservationTrackBits(tile_cur), track)) {
864 Train *v = GetTrainForReservation(tile_cur, track);
865 if (v != NULL) {
866 *affected_vehicles.Append() = v;
869 CommandCost ret = DoCommand(tile_cur, 0, track, flags, CMD_REMOVE_SINGLE_RAIL);
870 if (ret.Failed()) return ret;
871 cost.AddCost(ret);
872 /* With flags & ~DC_EXEC CmdLandscapeClear would fail since the rail still exists */
873 continue;
876 ret = DoCommand(tile_cur, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
877 if (ret.Failed()) return ret;
878 cost.AddCost(ret);
882 return cost;
886 * Checks if a road stop can be built at the given tile.
887 * @param tile_area Area to check.
888 * @param flags Operation to perform.
889 * @param invalid_dirs Prohibited directions (set of DiagDirections).
890 * @param is_drive_through True if trying to build a drive-through station.
891 * @param is_truck_stop True when building a truck stop, false otherwise.
892 * @param axis Axis of a drive-through road stop.
893 * @param station StationID to be queried and returned if available.
894 * @param rts Road types to build.
895 * @return The cost in case of success, or an error code if it failed.
897 static CommandCost CheckFlatLandRoadStop(TileArea tile_area, DoCommandFlag flags, uint invalid_dirs, bool is_drive_through, bool is_truck_stop, Axis axis, StationID *station, RoadTypes rts)
899 CommandCost cost(EXPENSES_CONSTRUCTION);
900 int allowed_z = -1;
902 TILE_AREA_LOOP(cur_tile, tile_area) {
903 CommandCost ret = CheckBuildableTile(cur_tile, invalid_dirs, allowed_z, !is_drive_through);
904 if (ret.Failed()) return ret;
905 cost.AddCost(ret);
907 /* If station is set, then we have special handling to allow building on top of already existing stations.
908 * Station points to INVALID_STATION if we can build on any station.
909 * Or it points to a station if we're only allowed to build on exactly that station. */
910 if (station != NULL && IsTileType(cur_tile, MP_STATION)) {
911 if (!IsRoadStop(cur_tile)) {
912 return ClearTile_Station(cur_tile, DC_AUTO); // Get error message.
913 } else {
914 if (is_truck_stop != IsTruckStop(cur_tile) ||
915 is_drive_through != IsDriveThroughStopTile(cur_tile)) {
916 return ClearTile_Station(cur_tile, DC_AUTO); // Get error message.
918 /* Drive-through station in the wrong direction. */
919 if (is_drive_through && IsDriveThroughStopTile(cur_tile) && DiagDirToAxis(GetRoadStopDir(cur_tile)) != axis){
920 return_cmd_error(STR_ERROR_DRIVE_THROUGH_DIRECTION);
922 StationID st = GetStationIndex(cur_tile);
923 if (*station == INVALID_STATION) {
924 *station = st;
925 } else if (*station != st) {
926 return_cmd_error(STR_ERROR_ADJOINS_MORE_THAN_ONE_EXISTING);
929 } else {
930 bool build_over_road = is_drive_through && IsNormalRoadTile(cur_tile);
931 /* Road bits in the wrong direction. */
932 RoadBits rb = IsNormalRoadTile(cur_tile) ? GetAllRoadBits(cur_tile) : ROAD_NONE;
933 if (build_over_road && (rb & (axis == AXIS_X ? ROAD_Y : ROAD_X)) != 0) {
934 /* Someone was pedantic and *NEEDED* three fracking different error messages. */
935 switch (CountBits(rb)) {
936 case 1:
937 return_cmd_error(STR_ERROR_DRIVE_THROUGH_DIRECTION);
939 case 2:
940 if (rb == ROAD_X || rb == ROAD_Y) return_cmd_error(STR_ERROR_DRIVE_THROUGH_DIRECTION);
941 return_cmd_error(STR_ERROR_DRIVE_THROUGH_CORNER);
943 default: // 3 or 4
944 return_cmd_error(STR_ERROR_DRIVE_THROUGH_JUNCTION);
948 RoadTypes cur_rts = IsNormalRoadTile(cur_tile) ? GetRoadTypes(cur_tile) : ROADTYPES_NONE;
949 uint num_roadbits = 0;
950 if (build_over_road) {
951 /* There is a road, check if we can build road+tram stop over it. */
952 if (HasBit(cur_rts, ROADTYPE_ROAD)) {
953 Owner road_owner = GetRoadOwner(cur_tile, ROADTYPE_ROAD);
954 if (road_owner == OWNER_TOWN) {
955 if (!_settings_game.construction.road_stop_on_town_road) return_cmd_error(STR_ERROR_DRIVE_THROUGH_ON_TOWN_ROAD);
956 } else if (!_settings_game.construction.road_stop_on_competitor_road && road_owner != OWNER_NONE) {
957 CommandCost ret = CheckOwnership(road_owner);
958 if (ret.Failed()) return ret;
960 num_roadbits += CountBits(GetRoadBits(cur_tile, ROADTYPE_ROAD));
963 /* There is a tram, check if we can build road+tram stop over it. */
964 if (HasBit(cur_rts, ROADTYPE_TRAM)) {
965 Owner tram_owner = GetRoadOwner(cur_tile, ROADTYPE_TRAM);
966 if (Company::IsValidID(tram_owner) &&
967 (!_settings_game.construction.road_stop_on_competitor_road ||
968 /* Disallow breaking end-of-line of someone else
969 * so trams can still reverse on this tile. */
970 HasExactlyOneBit(GetRoadBits(cur_tile, ROADTYPE_TRAM)))) {
971 CommandCost ret = CheckOwnership(tram_owner);
972 if (ret.Failed()) return ret;
974 num_roadbits += CountBits(GetRoadBits(cur_tile, ROADTYPE_TRAM));
977 /* Take into account existing roadbits. */
978 rts |= cur_rts;
979 } else {
980 ret = DoCommand(cur_tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
981 if (ret.Failed()) return ret;
982 cost.AddCost(ret);
985 uint roadbits_to_build = CountBits(rts) * 2 - num_roadbits;
986 cost.AddCost(_price[PR_BUILD_ROAD] * roadbits_to_build);
990 return cost;
994 * Check whether we can expand the rail part of the given station.
995 * @param st the station to expand
996 * @param new_ta the current (and if all is fine new) tile area of the rail part of the station
997 * @param axis the axis of the newly build rail
998 * @return Succeeded or failed command.
1000 CommandCost CanExpandRailStation(const BaseStation *st, TileArea &new_ta, Axis axis)
1002 TileArea cur_ta = st->train_station;
1004 /* determine new size of train station region.. */
1005 int x = min(TileX(cur_ta.tile), TileX(new_ta.tile));
1006 int y = min(TileY(cur_ta.tile), TileY(new_ta.tile));
1007 new_ta.w = max(TileX(cur_ta.tile) + cur_ta.w, TileX(new_ta.tile) + new_ta.w) - x;
1008 new_ta.h = max(TileY(cur_ta.tile) + cur_ta.h, TileY(new_ta.tile) + new_ta.h) - y;
1009 new_ta.tile = TileXY(x, y);
1011 /* make sure the final size is not too big. */
1012 if (new_ta.w > _settings_game.station.station_spread || new_ta.h > _settings_game.station.station_spread) {
1013 return_cmd_error(STR_ERROR_STATION_TOO_SPREAD_OUT);
1016 return CommandCost();
1019 static inline byte *CreateSingle(byte *layout, int n)
1021 int i = n;
1022 do *layout++ = 0; while (--i);
1023 layout[((n - 1) >> 1) - n] = 2;
1024 return layout;
1027 static inline byte *CreateMulti(byte *layout, int n, byte b)
1029 int i = n;
1030 do *layout++ = b; while (--i);
1031 if (n > 4) {
1032 layout[0 - n] = 0;
1033 layout[n - 1 - n] = 0;
1035 return layout;
1039 * Create the station layout for the given number of tracks and platform length.
1040 * @param layout The layout to write to.
1041 * @param numtracks The number of tracks to write.
1042 * @param plat_len The length of the platforms.
1043 * @param statspec The specification of the station to (possibly) get the layout from.
1045 void GetStationLayout(byte *layout, int numtracks, int plat_len, const StationSpec *statspec)
1047 if (statspec != NULL && statspec->lengths >= plat_len &&
1048 statspec->platforms[plat_len - 1] >= numtracks &&
1049 statspec->layouts[plat_len - 1][numtracks - 1]) {
1050 /* Custom layout defined, follow it. */
1051 memcpy(layout, statspec->layouts[plat_len - 1][numtracks - 1],
1052 plat_len * numtracks);
1053 return;
1056 if (plat_len == 1) {
1057 CreateSingle(layout, numtracks);
1058 } else {
1059 if (numtracks & 1) layout = CreateSingle(layout, plat_len);
1060 numtracks >>= 1;
1062 while (--numtracks >= 0) {
1063 layout = CreateMulti(layout, plat_len, 4);
1064 layout = CreateMulti(layout, plat_len, 6);
1070 * Find a nearby station that joins this station.
1071 * @tparam T the class to find a station for
1072 * @tparam error_message the error message when building a station on top of others
1073 * @param existing_station an existing station we build over
1074 * @param station_to_join the station to join to
1075 * @param adjacent whether adjacent stations are allowed
1076 * @param ta the area of the newly build station
1077 * @param st 'return' pointer for the found station
1078 * @return command cost with the error or 'okay'
1080 template <class T, StringID error_message>
1081 CommandCost FindJoiningBaseStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, T **st)
1083 assert(*st == NULL);
1084 bool check_surrounding = true;
1086 if (_settings_game.station.adjacent_stations) {
1087 if (existing_station != INVALID_STATION) {
1088 if (adjacent && existing_station != station_to_join) {
1089 /* You can't build an adjacent station over the top of one that
1090 * already exists. */
1091 return_cmd_error(error_message);
1092 } else {
1093 /* Extend the current station, and don't check whether it will
1094 * be near any other stations. */
1095 *st = T::GetIfValid(existing_station);
1096 check_surrounding = (*st == NULL);
1098 } else {
1099 /* There's no station here. Don't check the tiles surrounding this
1100 * one if the company wanted to build an adjacent station. */
1101 if (adjacent) check_surrounding = false;
1105 if (check_surrounding) {
1106 /* Make sure there are no similar stations around us. */
1107 CommandCost ret = GetStationAround(ta, existing_station, st);
1108 if (ret.Failed()) return ret;
1111 /* Distant join */
1112 if (*st == NULL && station_to_join != INVALID_STATION) *st = T::GetIfValid(station_to_join);
1114 return CommandCost();
1118 * Find a nearby station that joins this station.
1119 * @param existing_station an existing station we build over
1120 * @param station_to_join the station to join to
1121 * @param adjacent whether adjacent stations are allowed
1122 * @param ta the area of the newly build station
1123 * @param st 'return' pointer for the found station
1124 * @return command cost with the error or 'okay'
1126 static CommandCost FindJoiningStation(StationID existing_station, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
1128 return FindJoiningBaseStation<Station, STR_ERROR_MUST_REMOVE_RAILWAY_STATION_FIRST>(existing_station, station_to_join, adjacent, ta, st);
1132 * Find a nearby waypoint that joins this waypoint.
1133 * @param existing_waypoint an existing waypoint we build over
1134 * @param waypoint_to_join the waypoint to join to
1135 * @param adjacent whether adjacent waypoints are allowed
1136 * @param ta the area of the newly build waypoint
1137 * @param wp 'return' pointer for the found waypoint
1138 * @return command cost with the error or 'okay'
1140 CommandCost FindJoiningWaypoint(StationID existing_waypoint, StationID waypoint_to_join, bool adjacent, TileArea ta, Waypoint **wp)
1142 return FindJoiningBaseStation<Waypoint, STR_ERROR_MUST_REMOVE_RAILWAYPOINT_FIRST>(existing_waypoint, waypoint_to_join, adjacent, ta, wp);
1146 * Build rail station
1147 * @param tile_org northern most position of station dragging/placement
1148 * @param flags operation to perform
1149 * @param p1 various bitstuffed elements
1150 * - p1 = (bit 0- 3) - railtype
1151 * - p1 = (bit 4) - orientation (Axis)
1152 * - p1 = (bit 8-15) - number of tracks
1153 * - p1 = (bit 16-23) - platform length
1154 * - p1 = (bit 24) - allow stations directly adjacent to other stations.
1155 * @param p2 various bitstuffed elements
1156 * - p2 = (bit 0- 7) - custom station class
1157 * - p2 = (bit 8-15) - custom station id
1158 * - p2 = (bit 16-31) - station ID to join (NEW_STATION if build new one)
1159 * @param text unused
1160 * @return the cost of this operation or an error
1162 CommandCost CmdBuildRailStation(TileIndex tile_org, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1164 /* Unpack parameters */
1165 RailType rt = Extract<RailType, 0, 4>(p1);
1166 Axis axis = Extract<Axis, 4, 1>(p1);
1167 byte numtracks = GB(p1, 8, 8);
1168 byte plat_len = GB(p1, 16, 8);
1169 bool adjacent = HasBit(p1, 24);
1171 StationClassID spec_class = Extract<StationClassID, 0, 8>(p2);
1172 byte spec_index = GB(p2, 8, 8);
1173 StationID station_to_join = GB(p2, 16, 16);
1175 /* Does the authority allow this? */
1176 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile_org, flags);
1177 if (ret.Failed()) return ret;
1179 if (!ValParamRailtype(rt)) return CMD_ERROR;
1181 /* Check if the given station class is valid */
1182 if ((uint)spec_class >= StationClass::GetClassCount() || spec_class == STAT_CLASS_WAYP) return CMD_ERROR;
1183 if (spec_index >= StationClass::Get(spec_class)->GetSpecCount()) return CMD_ERROR;
1184 if (plat_len == 0 || numtracks == 0) return CMD_ERROR;
1186 int w_org, h_org;
1187 if (axis == AXIS_X) {
1188 w_org = plat_len;
1189 h_org = numtracks;
1190 } else {
1191 h_org = plat_len;
1192 w_org = numtracks;
1195 bool reuse = (station_to_join != NEW_STATION);
1196 if (!reuse) station_to_join = INVALID_STATION;
1197 bool distant_join = (station_to_join != INVALID_STATION);
1199 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
1201 if (h_org > _settings_game.station.station_spread || w_org > _settings_game.station.station_spread) return CMD_ERROR;
1203 /* these values are those that will be stored in train_tile and station_platforms */
1204 TileArea new_location(tile_org, w_org, h_org);
1206 /* Make sure the area below consists of clear tiles. (OR tiles belonging to a certain rail station) */
1207 StationID est = INVALID_STATION;
1208 SmallVector<Train *, 4> affected_vehicles;
1209 /* Clear the land below the station. */
1210 CommandCost cost = CheckFlatLandRailStation(new_location, flags, axis, &est, rt, affected_vehicles, spec_class, spec_index, plat_len, numtracks);
1211 if (cost.Failed()) return cost;
1212 /* Add construction expenses. */
1213 cost.AddCost((numtracks * _price[PR_BUILD_STATION_RAIL] + _price[PR_BUILD_STATION_RAIL_LENGTH]) * plat_len);
1214 cost.AddCost(numtracks * plat_len * RailBuildCost(rt));
1216 Station *st = NULL;
1217 ret = FindJoiningStation(est, station_to_join, adjacent, new_location, &st);
1218 if (ret.Failed()) return ret;
1220 ret = BuildStationPart(&st, flags, reuse, new_location, STATIONNAMING_RAIL);
1221 if (ret.Failed()) return ret;
1223 if (st != NULL && st->train_station.tile != INVALID_TILE) {
1224 CommandCost ret = CanExpandRailStation(st, new_location, axis);
1225 if (ret.Failed()) return ret;
1228 /* Check if we can allocate a custom stationspec to this station */
1229 const StationSpec *statspec = StationClass::Get(spec_class)->GetSpec(spec_index);
1230 int specindex = AllocateSpecToStation(statspec, st, (flags & DC_EXEC) != 0);
1231 if (specindex == -1) return_cmd_error(STR_ERROR_TOO_MANY_STATION_SPECS);
1233 if (statspec != NULL) {
1234 /* Perform NewStation checks */
1236 /* Check if the station size is permitted */
1237 if (HasBit(statspec->disallowed_platforms, min(numtracks - 1, 7)) || HasBit(statspec->disallowed_lengths, min(plat_len - 1, 7))) {
1238 return CMD_ERROR;
1241 /* Check if the station is buildable */
1242 if (HasBit(statspec->callback_mask, CBM_STATION_AVAIL)) {
1243 uint16 cb_res = GetStationCallback(CBID_STATION_AVAILABILITY, 0, 0, statspec, NULL, INVALID_TILE);
1244 if (cb_res != CALLBACK_FAILED && !Convert8bitBooleanCallback(statspec->grf_prop.grffile, CBID_STATION_AVAILABILITY, cb_res)) return CMD_ERROR;
1248 if (flags & DC_EXEC) {
1249 TileIndexDiff tile_delta;
1250 byte *layout_ptr;
1251 byte numtracks_orig;
1252 Track track;
1254 st->train_station = new_location;
1255 st->AddFacility(FACIL_TRAIN, new_location.tile);
1257 st->rect.BeforeAddRect(tile_org, w_org, h_org, StationRect::ADD_TRY);
1259 if (statspec != NULL) {
1260 /* Include this station spec's animation trigger bitmask
1261 * in the station's cached copy. */
1262 st->cached_anim_triggers |= statspec->animation.triggers;
1265 tile_delta = (axis == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1));
1266 track = AxisToTrack(axis);
1268 layout_ptr = AllocaM(byte, numtracks * plat_len);
1269 GetStationLayout(layout_ptr, numtracks, plat_len, statspec);
1271 numtracks_orig = numtracks;
1273 Company *c = Company::Get(st->owner);
1274 TileIndex tile_track = tile_org;
1275 do {
1276 TileIndex tile = tile_track;
1277 int w = plat_len;
1278 do {
1279 byte layout = *layout_ptr++;
1280 if (IsRailStationTile(tile) && HasStationReservation(tile)) {
1281 /* Check for trains having a reservation for this tile. */
1282 Train *v = GetTrainForReservation(tile, AxisToTrack(GetRailStationAxis(tile)));
1283 if (v != NULL) {
1284 FreeTrainTrackReservation(v);
1285 *affected_vehicles.Append() = v;
1286 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), false);
1287 for (; v->Next() != NULL; v = v->Next()) { }
1288 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(ReverseTrackdir(v->GetVehicleTrackdir())), false);
1292 /* Railtype can change when overbuilding. */
1293 if (IsRailStationTile(tile)) {
1294 if (!IsStationTileBlocked(tile)) c->infrastructure.rail[GetRailType(tile)]--;
1295 c->infrastructure.station--;
1298 /* Remove animation if overbuilding */
1299 DeleteAnimatedTile(tile);
1300 byte old_specindex = HasStationTileRail(tile) ? GetCustomStationSpecIndex(tile) : 0;
1301 MakeRailStation(tile, st->owner, st->index, axis, layout & ~1, rt);
1302 /* Free the spec if we overbuild something */
1303 DeallocateSpecFromStation(st, old_specindex);
1305 SetCustomStationSpecIndex(tile, specindex);
1306 SetStationTileRandomBits(tile, GB(Random(), 0, 4));
1307 SetAnimationFrame(tile, 0);
1309 if (!IsStationTileBlocked(tile)) c->infrastructure.rail[rt]++;
1310 c->infrastructure.station++;
1312 if (statspec != NULL) {
1313 /* Use a fixed axis for GetPlatformInfo as our platforms / numtracks are always the right way around */
1314 uint32 platinfo = GetPlatformInfo(AXIS_X, GetStationGfx(tile), plat_len, numtracks_orig, plat_len - w, numtracks_orig - numtracks, false);
1316 /* As the station is not yet completely finished, the station does not yet exist. */
1317 uint16 callback = GetStationCallback(CBID_STATION_TILE_LAYOUT, platinfo, 0, statspec, NULL, tile);
1318 if (callback != CALLBACK_FAILED) {
1319 if (callback < 8) {
1320 SetStationGfx(tile, (callback & ~1) + axis);
1321 } else {
1322 ErrorUnknownCallbackResult(statspec->grf_prop.grffile->grfid, CBID_STATION_TILE_LAYOUT, callback);
1326 /* Trigger station animation -- after building? */
1327 TriggerStationAnimation(st, tile, SAT_BUILT);
1330 tile += tile_delta;
1331 } while (--w);
1332 AddTrackToSignalBuffer(tile_track, track, _current_company);
1333 YapfNotifyTrackLayoutChange(tile_track, track);
1334 tile_track += tile_delta ^ TileDiffXY(1, 1); // perpendicular to tile_delta
1335 } while (--numtracks);
1337 for (uint i = 0; i < affected_vehicles.Length(); ++i) {
1338 /* Restore reservations of trains. */
1339 Train *v = affected_vehicles[i];
1340 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), true);
1341 TryPathReserve(v, true, true);
1342 for (; v->Next() != NULL; v = v->Next()) { }
1343 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(ReverseTrackdir(v->GetVehicleTrackdir())), true);
1346 /* Check whether we need to expand the reservation of trains already on the station. */
1347 TileArea update_reservation_area;
1348 if (axis == AXIS_X) {
1349 update_reservation_area = TileArea(tile_org, 1, numtracks_orig);
1350 } else {
1351 update_reservation_area = TileArea(tile_org, numtracks_orig, 1);
1354 TILE_AREA_LOOP(tile, update_reservation_area) {
1355 /* Don't even try to make eye candy parts reserved. */
1356 if (IsStationTileBlocked(tile)) continue;
1358 DiagDirection dir = AxisToDiagDir(axis);
1359 TileIndexDiff tile_offset = TileOffsByDiagDir(dir);
1360 TileIndex platform_begin = tile;
1361 TileIndex platform_end = tile;
1363 /* We can only account for tiles that are reachable from this tile, so ignore primarily blocked tiles while finding the platform begin and end. */
1364 for (TileIndex next_tile = platform_begin - tile_offset; IsCompatibleTrainStationTile(next_tile, platform_begin); next_tile -= tile_offset) {
1365 platform_begin = next_tile;
1367 for (TileIndex next_tile = platform_end + tile_offset; IsCompatibleTrainStationTile(next_tile, platform_end); next_tile += tile_offset) {
1368 platform_end = next_tile;
1371 /* If there is at least on reservation on the platform, we reserve the whole platform. */
1372 bool reservation = false;
1373 for (TileIndex t = platform_begin; !reservation && t <= platform_end; t += tile_offset) {
1374 reservation = HasStationReservation(t);
1377 if (reservation) {
1378 SetRailStationPlatformReservation(platform_begin, dir, true);
1382 st->MarkTilesDirty(false);
1383 st->UpdateVirtCoord();
1384 UpdateStationAcceptance(st, false);
1385 st->RecomputeIndustriesNear();
1386 InvalidateWindowData(WC_SELECT_STATION, 0, 0);
1387 InvalidateWindowData(WC_STATION_LIST, st->owner, 0);
1388 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_TRAINS);
1389 DirtyCompanyInfrastructureWindows(st->owner);
1392 return cost;
1395 static void MakeRailStationAreaSmaller(BaseStation *st)
1397 TileArea ta = st->train_station;
1399 restart:
1401 /* too small? */
1402 if (ta.w != 0 && ta.h != 0) {
1403 /* check the left side, x = constant, y changes */
1404 for (uint i = 0; !st->TileBelongsToRailStation(ta.tile + TileDiffXY(0, i));) {
1405 /* the left side is unused? */
1406 if (++i == ta.h) {
1407 ta.tile += TileDiffXY(1, 0);
1408 ta.w--;
1409 goto restart;
1413 /* check the right side, x = constant, y changes */
1414 for (uint i = 0; !st->TileBelongsToRailStation(ta.tile + TileDiffXY(ta.w - 1, i));) {
1415 /* the right side is unused? */
1416 if (++i == ta.h) {
1417 ta.w--;
1418 goto restart;
1422 /* check the upper side, y = constant, x changes */
1423 for (uint i = 0; !st->TileBelongsToRailStation(ta.tile + TileDiffXY(i, 0));) {
1424 /* the left side is unused? */
1425 if (++i == ta.w) {
1426 ta.tile += TileDiffXY(0, 1);
1427 ta.h--;
1428 goto restart;
1432 /* check the lower side, y = constant, x changes */
1433 for (uint i = 0; !st->TileBelongsToRailStation(ta.tile + TileDiffXY(i, ta.h - 1));) {
1434 /* the left side is unused? */
1435 if (++i == ta.w) {
1436 ta.h--;
1437 goto restart;
1440 } else {
1441 ta.Clear();
1444 st->train_station = ta;
1448 * Remove a number of tiles from any rail station within the area.
1449 * @param ta the area to clear station tile from.
1450 * @param affected_stations the stations affected.
1451 * @param flags the command flags.
1452 * @param removal_cost the cost for removing the tile, including the rail.
1453 * @param keep_rail whether to keep the rail of the station.
1454 * @tparam T the type of station to remove.
1455 * @return the number of cleared tiles or an error.
1457 template <class T>
1458 CommandCost RemoveFromRailBaseStation(TileArea ta, SmallVector<T *, 4> &affected_stations, DoCommandFlag flags, Money removal_cost, bool keep_rail)
1460 /* Count of the number of tiles removed */
1461 int quantity = 0;
1462 CommandCost total_cost(EXPENSES_CONSTRUCTION);
1463 /* Accumulator for the errors seen during clearing. If no errors happen,
1464 * and the quantity is 0 there is no station. Otherwise it will be one
1465 * of the other error that got accumulated. */
1466 CommandCost error;
1468 /* Do the action for every tile into the area */
1469 TILE_AREA_LOOP(tile, ta) {
1470 /* Make sure the specified tile is a rail station */
1471 if (!HasStationTileRail(tile)) continue;
1473 /* If there is a vehicle on ground, do not allow to remove (flood) the tile */
1474 CommandCost ret = EnsureNoVehicleOnGround(tile);
1475 error.AddCost(ret);
1476 if (ret.Failed()) continue;
1478 /* Check ownership of station */
1479 T *st = T::GetByTile(tile);
1480 if (st == NULL) continue;
1482 if (_current_company != OWNER_WATER) {
1483 CommandCost ret = CheckOwnership(st->owner);
1484 error.AddCost(ret);
1485 if (ret.Failed()) continue;
1488 /* If we reached here, the tile is valid so increase the quantity of tiles we will remove */
1489 quantity++;
1491 if (keep_rail || IsStationTileBlocked(tile)) {
1492 /* Don't refund the 'steel' of the track when we keep the
1493 * rail, or when the tile didn't have any rail at all. */
1494 total_cost.AddCost(-_price[PR_CLEAR_RAIL]);
1497 if (flags & DC_EXEC) {
1498 /* read variables before the station tile is removed */
1499 uint specindex = GetCustomStationSpecIndex(tile);
1500 Track track = GetRailStationTrack(tile);
1501 Owner owner = GetTileOwner(tile);
1502 RailType rt = GetRailType(tile);
1503 Train *v = NULL;
1505 if (HasStationReservation(tile)) {
1506 v = GetTrainForReservation(tile, track);
1507 if (v != NULL) {
1508 /* Free train reservation. */
1509 FreeTrainTrackReservation(v);
1510 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), false);
1511 Vehicle *temp = v;
1512 for (; temp->Next() != NULL; temp = temp->Next()) { }
1513 if (IsRailStationTile(temp->tile)) SetRailStationPlatformReservation(temp->tile, TrackdirToExitdir(ReverseTrackdir(temp->GetVehicleTrackdir())), false);
1517 bool build_rail = keep_rail && !IsStationTileBlocked(tile);
1518 if (!build_rail && !IsStationTileBlocked(tile)) Company::Get(owner)->infrastructure.rail[rt]--;
1520 DoClearSquare(tile);
1521 DeleteNewGRFInspectWindow(GSF_STATIONS, tile);
1522 if (build_rail) MakeRailNormal(tile, owner, TrackToTrackBits(track), rt);
1523 Company::Get(owner)->infrastructure.station--;
1524 DirtyCompanyInfrastructureWindows(owner);
1526 st->rect.AfterRemoveTile(st, tile);
1527 AddTrackToSignalBuffer(tile, track, owner);
1528 YapfNotifyTrackLayoutChange(tile, track);
1530 DeallocateSpecFromStation(st, specindex);
1532 affected_stations.Include(st);
1534 if (v != NULL) {
1535 /* Restore station reservation. */
1536 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(v->GetVehicleTrackdir()), true);
1537 TryPathReserve(v, true, true);
1538 for (; v->Next() != NULL; v = v->Next()) { }
1539 if (IsRailStationTile(v->tile)) SetRailStationPlatformReservation(v->tile, TrackdirToExitdir(ReverseTrackdir(v->GetVehicleTrackdir())), true);
1544 if (quantity == 0) return error.Failed() ? error : CommandCost(STR_ERROR_THERE_IS_NO_STATION);
1546 for (T **stp = affected_stations.Begin(); stp != affected_stations.End(); stp++) {
1547 T *st = *stp;
1549 /* now we need to make the "spanned" area of the railway station smaller
1550 * if we deleted something at the edges.
1551 * we also need to adjust train_tile. */
1552 MakeRailStationAreaSmaller(st);
1553 UpdateStationSignCoord(st);
1555 /* if we deleted the whole station, delete the train facility. */
1556 if (st->train_station.tile == INVALID_TILE) {
1557 st->facilities &= ~FACIL_TRAIN;
1558 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_TRAINS);
1559 st->UpdateVirtCoord();
1560 DeleteStationIfEmpty(st);
1564 total_cost.AddCost(quantity * removal_cost);
1565 return total_cost;
1569 * Remove a single tile from a rail station.
1570 * This allows for custom-built station with holes and weird layouts
1571 * @param start tile of station piece to remove
1572 * @param flags operation to perform
1573 * @param p1 start_tile
1574 * @param p2 various bitstuffed elements
1575 * - p2 = bit 0 - if set keep the rail
1576 * @param text unused
1577 * @return the cost of this operation or an error
1579 CommandCost CmdRemoveFromRailStation(TileIndex start, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1581 TileIndex end = p1 == 0 ? start : p1;
1582 if (start >= MapSize() || end >= MapSize()) return CMD_ERROR;
1584 TileArea ta(start, end);
1585 SmallVector<Station *, 4> affected_stations;
1587 CommandCost ret = RemoveFromRailBaseStation(ta, affected_stations, flags, _price[PR_CLEAR_STATION_RAIL], HasBit(p2, 0));
1588 if (ret.Failed()) return ret;
1590 /* Do all station specific functions here. */
1591 for (Station **stp = affected_stations.Begin(); stp != affected_stations.End(); stp++) {
1592 Station *st = *stp;
1594 if (st->train_station.tile == INVALID_TILE) SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_TRAINS);
1595 st->MarkTilesDirty(false);
1596 st->RecomputeIndustriesNear();
1599 /* Now apply the rail cost to the number that we deleted */
1600 return ret;
1604 * Remove a single tile from a waypoint.
1605 * This allows for custom-built waypoint with holes and weird layouts
1606 * @param start tile of waypoint piece to remove
1607 * @param flags operation to perform
1608 * @param p1 start_tile
1609 * @param p2 various bitstuffed elements
1610 * - p2 = bit 0 - if set keep the rail
1611 * @param text unused
1612 * @return the cost of this operation or an error
1614 CommandCost CmdRemoveFromRailWaypoint(TileIndex start, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1616 TileIndex end = p1 == 0 ? start : p1;
1617 if (start >= MapSize() || end >= MapSize()) return CMD_ERROR;
1619 TileArea ta(start, end);
1620 SmallVector<Waypoint *, 4> affected_stations;
1622 return RemoveFromRailBaseStation(ta, affected_stations, flags, _price[PR_CLEAR_WAYPOINT_RAIL], HasBit(p2, 0));
1627 * Remove a rail station/waypoint
1628 * @param st The station/waypoint to remove the rail part from
1629 * @param flags operation to perform
1630 * @param removal_cost the cost for removing a tile
1631 * @tparam T the type of station to remove
1632 * @return cost or failure of operation
1634 template <class T>
1635 CommandCost RemoveRailStation(T *st, DoCommandFlag flags, Money removal_cost)
1637 /* Current company owns the station? */
1638 if (_current_company != OWNER_WATER) {
1639 CommandCost ret = CheckOwnership(st->owner);
1640 if (ret.Failed()) return ret;
1643 /* determine width and height of platforms */
1644 TileArea ta = st->train_station;
1646 assert(ta.w != 0 && ta.h != 0);
1648 CommandCost cost(EXPENSES_CONSTRUCTION);
1649 /* clear all areas of the station */
1650 TILE_AREA_LOOP(tile, ta) {
1651 /* only remove tiles that are actually train station tiles */
1652 if (st->TileBelongsToRailStation(tile)) {
1653 SmallVector<T*, 4> affected_stations; // dummy
1654 CommandCost ret = RemoveFromRailBaseStation(TileArea(tile, 1, 1), affected_stations, flags, removal_cost, false);
1655 if (ret.Failed()) return ret;
1656 cost.AddCost(ret);
1660 return cost;
1664 * Remove a rail station
1665 * @param tile Tile of the station.
1666 * @param flags operation to perform
1667 * @return cost or failure of operation
1669 static CommandCost RemoveRailStation(TileIndex tile, DoCommandFlag flags)
1671 /* if there is flooding, remove platforms tile by tile */
1672 if (_current_company == OWNER_WATER) {
1673 return DoCommand(tile, 0, 0, DC_EXEC, CMD_REMOVE_FROM_RAIL_STATION);
1676 Station *st = Station::GetByTile(tile);
1677 CommandCost cost = RemoveRailStation(st, flags, _price[PR_CLEAR_STATION_RAIL]);
1679 if (flags & DC_EXEC) st->RecomputeIndustriesNear();
1681 return cost;
1685 * Remove a rail waypoint
1686 * @param tile Tile of the waypoint.
1687 * @param flags operation to perform
1688 * @return cost or failure of operation
1690 static CommandCost RemoveRailWaypoint(TileIndex tile, DoCommandFlag flags)
1692 /* if there is flooding, remove waypoints tile by tile */
1693 if (_current_company == OWNER_WATER) {
1694 return DoCommand(tile, 0, 0, DC_EXEC, CMD_REMOVE_FROM_RAIL_WAYPOINT);
1697 return RemoveRailStation(Waypoint::GetByTile(tile), flags, _price[PR_CLEAR_WAYPOINT_RAIL]);
1702 * @param truck_station Determines whether a stop is #ROADSTOP_BUS or #ROADSTOP_TRUCK
1703 * @param st The Station to do the whole procedure for
1704 * @return a pointer to where to link a new RoadStop*
1706 static RoadStop **FindRoadStopSpot(bool truck_station, Station *st)
1708 RoadStop **primary_stop = (truck_station) ? &st->truck_stops : &st->bus_stops;
1710 if (*primary_stop == NULL) {
1711 /* we have no roadstop of the type yet, so write a "primary stop" */
1712 return primary_stop;
1713 } else {
1714 /* there are stops already, so append to the end of the list */
1715 RoadStop *stop = *primary_stop;
1716 while (stop->next != NULL) stop = stop->next;
1717 return &stop->next;
1721 static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlag flags);
1724 * Find a nearby station that joins this road stop.
1725 * @param existing_stop an existing road stop we build over
1726 * @param station_to_join the station to join to
1727 * @param adjacent whether adjacent stations are allowed
1728 * @param ta the area of the newly build station
1729 * @param st 'return' pointer for the found station
1730 * @return command cost with the error or 'okay'
1732 static CommandCost FindJoiningRoadStop(StationID existing_stop, StationID station_to_join, bool adjacent, TileArea ta, Station **st)
1734 return FindJoiningBaseStation<Station, STR_ERROR_MUST_REMOVE_ROAD_STOP_FIRST>(existing_stop, station_to_join, adjacent, ta, st);
1738 * Build a bus or truck stop.
1739 * @param tile Northernmost tile of the stop.
1740 * @param flags Operation to perform.
1741 * @param p1 bit 0..7: Width of the road stop.
1742 * bit 8..15: Length of the road stop.
1743 * @param p2 bit 0: 0 For bus stops, 1 for truck stops.
1744 * bit 1: 0 For normal stops, 1 for drive-through.
1745 * bit 2..3: The roadtypes.
1746 * bit 5: Allow stations directly adjacent to other stations.
1747 * bit 6..7: Entrance direction (#DiagDirection) for normal stops.
1748 * bit 6: #Axis of the road for drive-through stops.
1749 * bit 16..31: Station ID to join (NEW_STATION if build new one).
1750 * @param text Unused.
1751 * @return The cost of this operation or an error.
1753 CommandCost CmdBuildRoadStop(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1755 bool type = HasBit(p2, 0);
1756 bool is_drive_through = HasBit(p2, 1);
1757 RoadTypes rts = Extract<RoadTypes, 2, 2>(p2);
1758 StationID station_to_join = GB(p2, 16, 16);
1759 bool reuse = (station_to_join != NEW_STATION);
1760 if (!reuse) station_to_join = INVALID_STATION;
1761 bool distant_join = (station_to_join != INVALID_STATION);
1763 uint8 width = (uint8)GB(p1, 0, 8);
1764 uint8 lenght = (uint8)GB(p1, 8, 8);
1766 /* Check if the requested road stop is too big */
1767 if (width > _settings_game.station.station_spread || lenght > _settings_game.station.station_spread) return_cmd_error(STR_ERROR_STATION_TOO_SPREAD_OUT);
1768 /* Check for incorrect width / length. */
1769 if (width == 0 || lenght == 0) return CMD_ERROR;
1770 /* Check if the first tile and the last tile are valid */
1771 if (!IsValidTile(tile) || TileAddWrap(tile, width - 1, lenght - 1) == INVALID_TILE) return CMD_ERROR;
1773 TileArea roadstop_area(tile, width, lenght);
1775 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
1777 if (!HasExactlyOneBit(rts) || !HasRoadTypesAvail(_current_company, rts)) return CMD_ERROR;
1779 /* Trams only have drive through stops */
1780 if (!is_drive_through && HasBit(rts, ROADTYPE_TRAM)) return CMD_ERROR;
1782 DiagDirection ddir;
1783 Axis axis;
1784 if (is_drive_through) {
1785 /* By definition axis is valid, due to there being 2 axes and reading 1 bit. */
1786 axis = Extract<Axis, 6, 1>(p2);
1787 ddir = AxisToDiagDir(axis);
1788 } else {
1789 /* By definition ddir is valid, due to there being 4 diagonal directions and reading 2 bits. */
1790 ddir = Extract<DiagDirection, 6, 2>(p2);
1791 axis = DiagDirToAxis(ddir);
1794 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile, flags);
1795 if (ret.Failed()) return ret;
1797 /* Total road stop cost. */
1798 CommandCost cost(EXPENSES_CONSTRUCTION, roadstop_area.w * roadstop_area.h * _price[type ? PR_BUILD_STATION_TRUCK : PR_BUILD_STATION_BUS]);
1799 StationID est = INVALID_STATION;
1800 ret = CheckFlatLandRoadStop(roadstop_area, flags, is_drive_through ? 5 << axis : 1 << ddir, is_drive_through, type, axis, &est, rts);
1801 if (ret.Failed()) return ret;
1802 cost.AddCost(ret);
1804 Station *st = NULL;
1805 ret = FindJoiningRoadStop(est, station_to_join, HasBit(p2, 5), roadstop_area, &st);
1806 if (ret.Failed()) return ret;
1808 /* Check if this number of road stops can be allocated. */
1809 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);
1811 ret = BuildStationPart(&st, flags, reuse, roadstop_area, STATIONNAMING_ROAD);
1812 if (ret.Failed()) return ret;
1814 if (flags & DC_EXEC) {
1815 /* Check every tile in the area. */
1816 TILE_AREA_LOOP(cur_tile, roadstop_area) {
1817 RoadTypes cur_rts = GetRoadTypes(cur_tile);
1818 Owner road_owner = HasBit(cur_rts, ROADTYPE_ROAD) ? GetRoadOwner(cur_tile, ROADTYPE_ROAD) : _current_company;
1819 Owner tram_owner = HasBit(cur_rts, ROADTYPE_TRAM) ? GetRoadOwner(cur_tile, ROADTYPE_TRAM) : _current_company;
1821 if (IsTileType(cur_tile, MP_STATION) && IsRoadStop(cur_tile)) {
1822 RemoveRoadStop(cur_tile, flags);
1825 RoadStop *road_stop = new RoadStop(cur_tile);
1826 /* Insert into linked list of RoadStops. */
1827 RoadStop **currstop = FindRoadStopSpot(type, st);
1828 *currstop = road_stop;
1830 if (type) {
1831 st->truck_station.Add(cur_tile);
1832 } else {
1833 st->bus_station.Add(cur_tile);
1836 /* Initialize an empty station. */
1837 st->AddFacility((type) ? FACIL_TRUCK_STOP : FACIL_BUS_STOP, cur_tile);
1839 st->rect.BeforeAddTile(cur_tile, StationRect::ADD_TRY);
1841 RoadStopType rs_type = type ? ROADSTOP_TRUCK : ROADSTOP_BUS;
1842 if (is_drive_through) {
1843 /* Update company infrastructure counts. If the current tile is a normal
1844 * road tile, count only the new road bits needed to get a full diagonal road. */
1845 RoadType rt;
1846 FOR_EACH_SET_ROADTYPE(rt, cur_rts | rts) {
1847 Company *c = Company::GetIfValid(rt == ROADTYPE_ROAD ? road_owner : tram_owner);
1848 if (c != NULL) {
1849 c->infrastructure.road[rt] += 2 - (IsNormalRoadTile(cur_tile) && HasBit(cur_rts, rt) ? CountBits(GetRoadBits(cur_tile, rt)) : 0);
1850 DirtyCompanyInfrastructureWindows(c->index);
1854 MakeDriveThroughRoadStop(cur_tile, st->owner, road_owner, tram_owner, st->index, rs_type, rts | cur_rts, axis);
1855 road_stop->MakeDriveThrough();
1856 } else {
1857 /* Non-drive-through stop never overbuild and always count as two road bits. */
1858 Company::Get(st->owner)->infrastructure.road[FIND_FIRST_BIT(rts)] += 2;
1859 MakeRoadStop(cur_tile, st->owner, st->index, rs_type, rts, ddir);
1861 Company::Get(st->owner)->infrastructure.station++;
1862 DirtyCompanyInfrastructureWindows(st->owner);
1864 MarkTileDirtyByTile(cur_tile);
1868 if (st != NULL) {
1869 st->UpdateVirtCoord();
1870 UpdateStationAcceptance(st, false);
1871 st->RecomputeIndustriesNear();
1872 InvalidateWindowData(WC_SELECT_STATION, 0, 0);
1873 InvalidateWindowData(WC_STATION_LIST, st->owner, 0);
1874 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_ROADVEHS);
1876 return cost;
1880 static Vehicle *ClearRoadStopStatusEnum(Vehicle *v, void *)
1882 if (v->type == VEH_ROAD) {
1883 /* Okay... we are a road vehicle on a drive through road stop.
1884 * But that road stop has just been removed, so we need to make
1885 * sure we are in a valid state... however, vehicles can also
1886 * turn on road stop tiles, so only clear the 'road stop' state
1887 * bits and only when the state was 'in road stop', otherwise
1888 * we'll end up clearing the turn around bits. */
1889 RoadVehicle *rv = RoadVehicle::From(v);
1890 if (HasBit(rv->state, RVS_IN_DT_ROAD_STOP)) rv->state &= RVSB_ROAD_STOP_TRACKDIR_MASK;
1893 return NULL;
1898 * Remove a bus station/truck stop
1899 * @param tile TileIndex been queried
1900 * @param flags operation to perform
1901 * @return cost or failure of operation
1903 static CommandCost RemoveRoadStop(TileIndex tile, DoCommandFlag flags)
1905 Station *st = Station::GetByTile(tile);
1907 if (_current_company != OWNER_WATER) {
1908 CommandCost ret = CheckOwnership(st->owner);
1909 if (ret.Failed()) return ret;
1912 bool is_truck = IsTruckStop(tile);
1914 RoadStop **primary_stop;
1915 RoadStop *cur_stop;
1916 if (is_truck) { // truck stop
1917 primary_stop = &st->truck_stops;
1918 cur_stop = RoadStop::GetByTile(tile, ROADSTOP_TRUCK);
1919 } else {
1920 primary_stop = &st->bus_stops;
1921 cur_stop = RoadStop::GetByTile(tile, ROADSTOP_BUS);
1924 assert(cur_stop != NULL);
1926 /* don't do the check for drive-through road stops when company bankrupts */
1927 if (IsDriveThroughStopTile(tile) && (flags & DC_BANKRUPT)) {
1928 /* remove the 'going through road stop' status from all vehicles on that tile */
1929 if (flags & DC_EXEC) FindVehicleOnPos(tile, NULL, &ClearRoadStopStatusEnum);
1930 } else {
1931 CommandCost ret = EnsureNoVehicleOnGround(tile);
1932 if (ret.Failed()) return ret;
1935 if (flags & DC_EXEC) {
1936 if (*primary_stop == cur_stop) {
1937 /* removed the first stop in the list */
1938 *primary_stop = cur_stop->next;
1939 /* removed the only stop? */
1940 if (*primary_stop == NULL) {
1941 st->facilities &= (is_truck ? ~FACIL_TRUCK_STOP : ~FACIL_BUS_STOP);
1943 } else {
1944 /* tell the predecessor in the list to skip this stop */
1945 RoadStop *pred = *primary_stop;
1946 while (pred->next != cur_stop) pred = pred->next;
1947 pred->next = cur_stop->next;
1950 /* Update company infrastructure counts. */
1951 RoadType rt;
1952 FOR_EACH_SET_ROADTYPE(rt, GetRoadTypes(tile)) {
1953 Company *c = Company::GetIfValid(GetRoadOwner(tile, rt));
1954 if (c != NULL) {
1955 c->infrastructure.road[rt] -= 2;
1956 DirtyCompanyInfrastructureWindows(c->index);
1959 Company::Get(st->owner)->infrastructure.station--;
1960 DirtyCompanyInfrastructureWindows(st->owner);
1962 if (IsDriveThroughStopTile(tile)) {
1963 /* Clears the tile for us */
1964 cur_stop->ClearDriveThrough();
1965 } else {
1966 DoClearSquare(tile);
1969 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_ROADVEHS);
1970 delete cur_stop;
1972 /* Make sure no vehicle is going to the old roadstop */
1973 RoadVehicle *v;
1974 FOR_ALL_ROADVEHICLES(v) {
1975 if (v->First() == v && v->current_order.IsType(OT_GOTO_STATION) &&
1976 v->dest_tile == tile) {
1977 v->dest_tile = v->GetOrderStationLocation(st->index);
1981 st->rect.AfterRemoveTile(st, tile);
1983 st->UpdateVirtCoord();
1984 st->RecomputeIndustriesNear();
1985 DeleteStationIfEmpty(st);
1987 /* Update the tile area of the truck/bus stop */
1988 if (is_truck) {
1989 st->truck_station.Clear();
1990 for (const RoadStop *rs = st->truck_stops; rs != NULL; rs = rs->next) st->truck_station.Add(rs->xy);
1991 } else {
1992 st->bus_station.Clear();
1993 for (const RoadStop *rs = st->bus_stops; rs != NULL; rs = rs->next) st->bus_station.Add(rs->xy);
1997 return CommandCost(EXPENSES_CONSTRUCTION, _price[is_truck ? PR_CLEAR_STATION_TRUCK : PR_CLEAR_STATION_BUS]);
2001 * Remove bus or truck stops.
2002 * @param tile Northernmost tile of the removal area.
2003 * @param flags Operation to perform.
2004 * @param p1 bit 0..7: Width of the removal area.
2005 * bit 8..15: Height of the removal area.
2006 * @param p2 bit 0: 0 For bus stops, 1 for truck stops.
2007 * @param p2 bit 1: 0 to keep roads of all drive-through stops, 1 to remove them.
2008 * @param text Unused.
2009 * @return The cost of this operation or an error.
2011 CommandCost CmdRemoveRoadStop(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2013 uint8 width = (uint8)GB(p1, 0, 8);
2014 uint8 height = (uint8)GB(p1, 8, 8);
2015 bool keep_drive_through_roads = !HasBit(p2, 1);
2017 /* Check for incorrect width / height. */
2018 if (width == 0 || height == 0) return CMD_ERROR;
2019 /* Check if the first tile and the last tile are valid */
2020 if (!IsValidTile(tile) || TileAddWrap(tile, width - 1, height - 1) == INVALID_TILE) return CMD_ERROR;
2021 /* Bankrupting company is not supposed to remove roads, there may be road vehicles. */
2022 if (!keep_drive_through_roads && (flags & DC_BANKRUPT)) return CMD_ERROR;
2024 TileArea roadstop_area(tile, width, height);
2026 CommandCost cost(EXPENSES_CONSTRUCTION);
2027 CommandCost last_error(STR_ERROR_THERE_IS_NO_STATION);
2028 bool had_success = false;
2030 TILE_AREA_LOOP(cur_tile, roadstop_area) {
2031 /* Make sure the specified tile is a road stop of the correct type */
2032 if (!IsTileType(cur_tile, MP_STATION) || !IsRoadStop(cur_tile) || (uint32)GetRoadStopType(cur_tile) != GB(p2, 0, 1)) continue;
2034 /* Save information on to-be-restored roads before the stop is removed. */
2035 RoadTypes rts = ROADTYPES_NONE;
2036 RoadBits road_bits = ROAD_NONE;
2037 Owner road_owner[] = { OWNER_NONE, OWNER_NONE };
2038 assert_compile(lengthof(road_owner) == ROADTYPE_END);
2039 if (IsDriveThroughStopTile(cur_tile)) {
2040 RoadType rt;
2041 FOR_EACH_SET_ROADTYPE(rt, GetRoadTypes(cur_tile)) {
2042 road_owner[rt] = GetRoadOwner(cur_tile, rt);
2043 /* If we don't want to preserve our roads then restore only roads of others. */
2044 if (keep_drive_through_roads || road_owner[rt] != _current_company) SetBit(rts, rt);
2046 road_bits = AxisToRoadBits(DiagDirToAxis(GetRoadStopDir(cur_tile)));
2049 CommandCost ret = RemoveRoadStop(cur_tile, flags);
2050 if (ret.Failed()) {
2051 last_error = ret;
2052 continue;
2054 cost.AddCost(ret);
2055 had_success = true;
2057 /* Restore roads. */
2058 if ((flags & DC_EXEC) && rts != ROADTYPES_NONE) {
2059 MakeRoadNormal(cur_tile, road_bits, rts, ClosestTownFromTile(cur_tile, UINT_MAX)->index,
2060 road_owner[ROADTYPE_ROAD], road_owner[ROADTYPE_TRAM]);
2062 /* Update company infrastructure counts. */
2063 RoadType rt;
2064 FOR_EACH_SET_ROADTYPE(rt, rts) {
2065 Company *c = Company::GetIfValid(GetRoadOwner(cur_tile, rt));
2066 if (c != NULL) {
2067 c->infrastructure.road[rt] += CountBits(road_bits);
2068 DirtyCompanyInfrastructureWindows(c->index);
2074 return had_success ? cost : last_error;
2078 * Computes the minimal distance from town's xy to any airport's tile.
2079 * @param it An iterator over all airport tiles.
2080 * @param town_tile town's tile (t->xy)
2081 * @return minimal manhattan distance from town_tile to any airport's tile
2083 static uint GetMinimalAirportDistanceToTile(TileIterator &it, TileIndex town_tile)
2085 uint mindist = UINT_MAX;
2087 for (TileIndex cur_tile = it; cur_tile != INVALID_TILE; cur_tile = ++it) {
2088 mindist = min(mindist, DistanceManhattan(town_tile, cur_tile));
2091 return mindist;
2095 * Get a possible noise reduction factor based on distance from town center.
2096 * The further you get, the less noise you generate.
2097 * So all those folks at city council can now happily slee... work in their offices
2098 * @param as airport information
2099 * @param it An iterator over all airport tiles.
2100 * @param town_tile TileIndex of town's center, the one who will receive the airport's candidature
2101 * @return the noise that will be generated, according to distance
2103 uint8 GetAirportNoiseLevelForTown(const AirportSpec *as, TileIterator &it, TileIndex town_tile)
2105 /* 0 cannot be accounted, and 1 is the lowest that can be reduced from town.
2106 * So no need to go any further*/
2107 if (as->noise_level < 2) return as->noise_level;
2109 uint distance = GetMinimalAirportDistanceToTile(it, town_tile);
2111 /* The steps for measuring noise reduction are based on the "magical" (and arbitrary) 8 base distance
2112 * adding the town_council_tolerance 4 times, as a way to graduate, depending of the tolerance.
2113 * Basically, it says that the less tolerant a town is, the bigger the distance before
2114 * an actual decrease can be granted */
2115 uint8 town_tolerance_distance = 8 + (_settings_game.difficulty.town_council_tolerance * 4);
2117 /* now, we want to have the distance segmented using the distance judged bareable by town
2118 * This will give us the coefficient of reduction the distance provides. */
2119 uint noise_reduction = distance / town_tolerance_distance;
2121 /* If the noise reduction equals the airport noise itself, don't give it for free.
2122 * Otherwise, simply reduce the airport's level. */
2123 return noise_reduction >= as->noise_level ? 1 : as->noise_level - noise_reduction;
2127 * Finds the town nearest to given airport. Based on minimal manhattan distance to any airport's tile.
2128 * If two towns have the same distance, town with lower index is returned.
2129 * @param as airport's description
2130 * @param it An iterator over all airport tiles
2131 * @return nearest town to airport
2133 Town *AirportGetNearestTown(const AirportSpec *as, const TileIterator &it)
2135 Town *t, *nearest = NULL;
2136 uint add = as->size_x + as->size_y - 2; // GetMinimalAirportDistanceToTile can differ from DistanceManhattan by this much
2137 uint mindist = UINT_MAX - add; // prevent overflow
2138 FOR_ALL_TOWNS(t) {
2139 if (DistanceManhattan(t->xy, it) < mindist + add) { // avoid calling GetMinimalAirportDistanceToTile too often
2140 TileIterator *copy = it.Clone();
2141 uint dist = GetMinimalAirportDistanceToTile(*copy, t->xy);
2142 delete copy;
2143 if (dist < mindist) {
2144 nearest = t;
2145 mindist = dist;
2150 return nearest;
2154 /** Recalculate the noise generated by the airports of each town */
2155 void UpdateAirportsNoise()
2157 Town *t;
2158 const Station *st;
2160 FOR_ALL_TOWNS(t) t->noise_reached = 0;
2162 FOR_ALL_STATIONS(st) {
2163 if (st->airport.tile != INVALID_TILE && st->airport.type != AT_OILRIG) {
2164 const AirportSpec *as = st->airport.GetSpec();
2165 AirportTileIterator it(st);
2166 Town *nearest = AirportGetNearestTown(as, it);
2167 nearest->noise_reached += GetAirportNoiseLevelForTown(as, it, nearest->xy);
2173 * Place an Airport.
2174 * @param tile tile where airport will be built
2175 * @param flags operation to perform
2176 * @param p1
2177 * - p1 = (bit 0- 7) - airport type, @see airport.h
2178 * - p1 = (bit 8-15) - airport layout
2179 * @param p2 various bitstuffed elements
2180 * - p2 = (bit 0) - allow airports directly adjacent to other airports.
2181 * - p2 = (bit 16-31) - station ID to join (NEW_STATION if build new one)
2182 * @param text unused
2183 * @return the cost of this operation or an error
2185 CommandCost CmdBuildAirport(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2187 StationID station_to_join = GB(p2, 16, 16);
2188 bool reuse = (station_to_join != NEW_STATION);
2189 if (!reuse) station_to_join = INVALID_STATION;
2190 bool distant_join = (station_to_join != INVALID_STATION);
2191 byte airport_type = GB(p1, 0, 8);
2192 byte layout = GB(p1, 8, 8);
2194 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2196 if (airport_type >= NUM_AIRPORTS) return CMD_ERROR;
2198 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile, flags);
2199 if (ret.Failed()) return ret;
2201 /* Check if a valid, buildable airport was chosen for construction */
2202 const AirportSpec *as = AirportSpec::Get(airport_type);
2203 if (!as->IsAvailable() || layout >= as->num_table) return CMD_ERROR;
2205 Direction rotation = as->rotation[layout];
2206 int w = as->size_x;
2207 int h = as->size_y;
2208 if (rotation == DIR_E || rotation == DIR_W) Swap(w, h);
2209 TileArea airport_area = TileArea(tile, w, h);
2211 if (w > _settings_game.station.station_spread || h > _settings_game.station.station_spread) {
2212 return_cmd_error(STR_ERROR_STATION_TOO_SPREAD_OUT);
2215 CommandCost cost = CheckFlatLand(airport_area, flags);
2216 if (cost.Failed()) return cost;
2218 /* The noise level is the noise from the airport and reduce it to account for the distance to the town center. */
2219 AirportTileTableIterator iter(as->table[layout], tile);
2220 Town *nearest = AirportGetNearestTown(as, iter);
2221 uint newnoise_level = GetAirportNoiseLevelForTown(as, iter, nearest->xy);
2223 /* Check if local auth would allow a new airport */
2224 StringID authority_refuse_message = STR_NULL;
2225 Town *authority_refuse_town = NULL;
2227 if (_settings_game.economy.station_noise_level) {
2228 /* do not allow to build a new airport if this raise the town noise over the maximum allowed by town */
2229 if ((nearest->noise_reached + newnoise_level) > nearest->MaxTownNoise()) {
2230 authority_refuse_message = STR_ERROR_LOCAL_AUTHORITY_REFUSES_NOISE;
2231 authority_refuse_town = nearest;
2233 } else {
2234 Town *t = ClosestTownFromTile(tile, UINT_MAX);
2235 uint num = 0;
2236 const Station *st;
2237 FOR_ALL_STATIONS(st) {
2238 if (st->town == t && (st->facilities & FACIL_AIRPORT) && st->airport.type != AT_OILRIG) num++;
2240 if (num >= 2) {
2241 authority_refuse_message = STR_ERROR_LOCAL_AUTHORITY_REFUSES_AIRPORT;
2242 authority_refuse_town = t;
2246 if (authority_refuse_message != STR_NULL) {
2247 SetDParam(0, authority_refuse_town->index);
2248 return_cmd_error(authority_refuse_message);
2251 Station *st = NULL;
2252 ret = FindJoiningStation(INVALID_STATION, station_to_join, HasBit(p2, 0), airport_area, &st);
2253 if (ret.Failed()) return ret;
2255 /* Distant join */
2256 if (st == NULL && distant_join) st = Station::GetIfValid(station_to_join);
2258 ret = BuildStationPart(&st, flags, reuse, airport_area, (GetAirport(airport_type)->flags & AirportFTAClass::AIRPLANES) ? STATIONNAMING_AIRPORT : STATIONNAMING_HELIPORT);
2259 if (ret.Failed()) return ret;
2261 if (st != NULL && st->airport.tile != INVALID_TILE) {
2262 return_cmd_error(STR_ERROR_TOO_CLOSE_TO_ANOTHER_AIRPORT);
2265 for (AirportTileTableIterator iter(as->table[layout], tile); iter != INVALID_TILE; ++iter) {
2266 cost.AddCost(_price[PR_BUILD_STATION_AIRPORT]);
2269 if (flags & DC_EXEC) {
2270 /* Always add the noise, so there will be no need to recalculate when option toggles */
2271 nearest->noise_reached += newnoise_level;
2273 st->AddFacility(FACIL_AIRPORT, tile);
2274 st->airport.type = airport_type;
2275 st->airport.layout = layout;
2276 st->airport.flags = 0;
2277 st->airport.rotation = rotation;
2279 st->rect.BeforeAddRect(tile, w, h, StationRect::ADD_TRY);
2281 for (AirportTileTableIterator iter(as->table[layout], tile); iter != INVALID_TILE; ++iter) {
2282 MakeAirport(iter, st->owner, st->index, iter.GetStationGfx(), WATER_CLASS_INVALID);
2283 SetStationTileRandomBits(iter, GB(Random(), 0, 4));
2284 st->airport.Add(iter);
2286 if (AirportTileSpec::Get(GetTranslatedAirportTileID(iter.GetStationGfx()))->animation.status != ANIM_STATUS_NO_ANIMATION) AddAnimatedTile(iter);
2289 /* Only call the animation trigger after all tiles have been built */
2290 for (AirportTileTableIterator iter(as->table[layout], tile); iter != INVALID_TILE; ++iter) {
2291 AirportTileAnimationTrigger(st, iter, AAT_BUILT);
2294 UpdateAirplanesOnNewStation(st);
2296 Company::Get(st->owner)->infrastructure.airport++;
2297 DirtyCompanyInfrastructureWindows(st->owner);
2299 st->UpdateVirtCoord();
2300 UpdateStationAcceptance(st, false);
2301 st->RecomputeIndustriesNear();
2302 InvalidateWindowData(WC_SELECT_STATION, 0, 0);
2303 InvalidateWindowData(WC_STATION_LIST, st->owner, 0);
2304 InvalidateWindowData(WC_STATION_VIEW, st->index, -1);
2306 if (_settings_game.economy.station_noise_level) {
2307 SetWindowDirty(WC_TOWN_VIEW, st->town->index);
2311 return cost;
2315 * Remove an airport
2316 * @param tile TileIndex been queried
2317 * @param flags operation to perform
2318 * @return cost or failure of operation
2320 static CommandCost RemoveAirport(TileIndex tile, DoCommandFlag flags)
2322 Station *st = Station::GetByTile(tile);
2324 if (_current_company != OWNER_WATER) {
2325 CommandCost ret = CheckOwnership(st->owner);
2326 if (ret.Failed()) return ret;
2329 tile = st->airport.tile;
2331 CommandCost cost(EXPENSES_CONSTRUCTION);
2333 const Aircraft *a;
2334 FOR_ALL_AIRCRAFT(a) {
2335 if (!a->IsNormalAircraft()) continue;
2336 if (a->targetairport == st->index && a->state != FLYING) return CMD_ERROR;
2339 if (flags & DC_EXEC) {
2340 const AirportSpec *as = st->airport.GetSpec();
2341 /* The noise level is the noise from the airport and reduce it to account for the distance to the town center.
2342 * And as for construction, always remove it, even if the setting is not set, in order to avoid the
2343 * need of recalculation */
2344 AirportTileIterator it(st);
2345 Town *nearest = AirportGetNearestTown(as, it);
2346 nearest->noise_reached -= GetAirportNoiseLevelForTown(as, it, nearest->xy);
2349 TILE_AREA_LOOP(tile_cur, st->airport) {
2350 if (!st->TileBelongsToAirport(tile_cur)) continue;
2352 CommandCost ret = EnsureNoVehicleOnGround(tile_cur);
2353 if (ret.Failed()) return ret;
2355 cost.AddCost(_price[PR_CLEAR_STATION_AIRPORT]);
2357 if (flags & DC_EXEC) {
2358 if (IsHangarTile(tile_cur)) OrderBackup::Reset(tile_cur, false);
2359 DeleteAnimatedTile(tile_cur);
2360 DoClearSquare(tile_cur);
2361 DeleteNewGRFInspectWindow(GSF_AIRPORTTILES, tile_cur);
2365 if (flags & DC_EXEC) {
2366 /* Clear the persistent storage. */
2367 delete st->airport.psa;
2369 for (uint i = 0; i < st->airport.GetNumHangars(); ++i) {
2370 DeleteWindowById(
2371 WC_VEHICLE_DEPOT, st->airport.GetHangarTile(i)
2375 st->rect.AfterRemoveRect(st, st->airport);
2377 st->airport.Clear();
2378 st->facilities &= ~FACIL_AIRPORT;
2380 InvalidateWindowData(WC_STATION_VIEW, st->index, -1);
2382 if (_settings_game.economy.station_noise_level) {
2383 SetWindowDirty(WC_TOWN_VIEW, st->town->index);
2386 Company::Get(st->owner)->infrastructure.airport--;
2387 DirtyCompanyInfrastructureWindows(st->owner);
2389 st->UpdateVirtCoord();
2390 st->RecomputeIndustriesNear();
2391 DeleteStationIfEmpty(st);
2392 DeleteNewGRFInspectWindow(GSF_AIRPORTS, st->index);
2395 return cost;
2399 * Open/close an airport to incoming aircraft.
2400 * @param tile Unused.
2401 * @param flags Operation to perform.
2402 * @param p1 Station ID of the airport.
2403 * @param p2 Unused.
2404 * @param text unused
2405 * @return the cost of this operation or an error
2407 CommandCost CmdOpenCloseAirport(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2409 if (!Station::IsValidID(p1)) return CMD_ERROR;
2410 Station *st = Station::Get(p1);
2412 if (!(st->facilities & FACIL_AIRPORT) || st->owner == OWNER_NONE) return CMD_ERROR;
2414 CommandCost ret = CheckOwnership(st->owner);
2415 if (ret.Failed()) return ret;
2417 if (flags & DC_EXEC) {
2418 st->airport.flags ^= AIRPORT_CLOSED_block;
2419 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_CLOSE_AIRPORT);
2421 return CommandCost();
2425 * Tests whether the company's vehicles have this station in orders
2426 * @param station station ID
2427 * @param include_company If true only check vehicles of \a company, if false only check vehicles of other companies
2428 * @param company company ID
2430 bool HasStationInUse(StationID station, bool include_company, CompanyID company)
2432 const Vehicle *v;
2433 FOR_ALL_VEHICLES(v) {
2434 if ((v->owner == company) == include_company) {
2435 const Order *order;
2436 FOR_VEHICLE_ORDERS(v, order) {
2437 if ((order->IsType(OT_GOTO_STATION) || order->IsType(OT_GOTO_WAYPOINT)) && order->GetDestination() == station) {
2438 return true;
2443 return false;
2446 static const TileIndexDiffC _dock_tileoffs_chkaround[] = {
2447 {-1, 0},
2448 { 0, 0},
2449 { 0, 0},
2450 { 0, -1}
2452 static const byte _dock_w_chk[4] = { 2, 1, 2, 1 };
2453 static const byte _dock_h_chk[4] = { 1, 2, 1, 2 };
2456 * Build a dock/haven.
2457 * @param tile tile where dock will be built
2458 * @param flags operation to perform
2459 * @param p1 (bit 0) - allow docks directly adjacent to other docks.
2460 * @param p2 bit 16-31: station ID to join (NEW_STATION if build new one)
2461 * @param text unused
2462 * @return the cost of this operation or an error
2464 CommandCost CmdBuildDock(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2466 StationID station_to_join = GB(p2, 16, 16);
2467 bool reuse = (station_to_join != NEW_STATION);
2468 if (!reuse) station_to_join = INVALID_STATION;
2469 bool distant_join = (station_to_join != INVALID_STATION);
2471 if (distant_join && (!_settings_game.station.distant_join_stations || !Station::IsValidID(station_to_join))) return CMD_ERROR;
2473 DiagDirection direction = GetInclinedSlopeDirection(GetTileSlope(tile));
2474 if (direction == INVALID_DIAGDIR) return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
2475 direction = ReverseDiagDir(direction);
2477 /* Docks cannot be placed on rapids */
2478 if (HasTileWaterGround(tile)) return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
2480 CommandCost ret = CheckIfAuthorityAllowsNewStation(tile, flags);
2481 if (ret.Failed()) return ret;
2483 if (IsBridgeAbove(tile)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
2485 ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
2486 if (ret.Failed()) return ret;
2488 TileIndex tile_cur = tile + TileOffsByDiagDir(direction);
2490 if (!IsTileType(tile_cur, MP_WATER) || !IsTileFlat(tile_cur)) {
2491 return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
2494 if (IsBridgeAbove(tile_cur)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
2496 /* Get the water class of the water tile before it is cleared.*/
2497 WaterClass wc = GetWaterClass(tile_cur);
2499 ret = DoCommand(tile_cur, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
2500 if (ret.Failed()) return ret;
2502 tile_cur += TileOffsByDiagDir(direction);
2503 if (!IsTileType(tile_cur, MP_WATER) || !IsTileFlat(tile_cur)) {
2504 return_cmd_error(STR_ERROR_SITE_UNSUITABLE);
2507 TileArea dock_area = TileArea(tile + ToTileIndexDiff(_dock_tileoffs_chkaround[direction]),
2508 _dock_w_chk[direction], _dock_h_chk[direction]);
2510 /* middle */
2511 Station *st = NULL;
2512 ret = FindJoiningStation(INVALID_STATION, station_to_join, HasBit(p1, 0), dock_area, &st);
2513 if (ret.Failed()) return ret;
2515 /* Distant join */
2516 if (st == NULL && distant_join) st = Station::GetIfValid(station_to_join);
2518 ret = BuildStationPart(&st, flags, reuse, dock_area, STATIONNAMING_DOCK);
2519 if (ret.Failed()) return ret;
2521 if (st != NULL && st->dock_tile != INVALID_TILE) return_cmd_error(STR_ERROR_TOO_CLOSE_TO_ANOTHER_DOCK);
2523 if (flags & DC_EXEC) {
2524 st->dock_tile = tile;
2525 st->AddFacility(FACIL_DOCK, tile);
2527 st->rect.BeforeAddRect(dock_area.tile, dock_area.w, dock_area.h, StationRect::ADD_TRY);
2529 /* If the water part of the dock is on a canal, update infrastructure counts.
2530 * This is needed as we've unconditionally cleared that tile before. */
2531 if (wc == WATER_CLASS_CANAL) {
2532 Company::Get(st->owner)->infrastructure.water++;
2534 Company::Get(st->owner)->infrastructure.station += 2;
2535 DirtyCompanyInfrastructureWindows(st->owner);
2537 MakeDock(tile, st->owner, st->index, direction, wc);
2539 st->UpdateVirtCoord();
2540 UpdateStationAcceptance(st, false);
2541 st->RecomputeIndustriesNear();
2542 InvalidateWindowData(WC_SELECT_STATION, 0, 0);
2543 InvalidateWindowData(WC_STATION_LIST, st->owner, 0);
2544 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_SHIPS);
2547 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_STATION_DOCK]);
2551 * Remove a dock
2552 * @param tile TileIndex been queried
2553 * @param flags operation to perform
2554 * @return cost or failure of operation
2556 static CommandCost RemoveDock(TileIndex tile, DoCommandFlag flags)
2558 Station *st = Station::GetByTile(tile);
2559 CommandCost ret = CheckOwnership(st->owner);
2560 if (ret.Failed()) return ret;
2562 TileIndex docking_location = TILE_ADD(st->dock_tile, ToTileIndexDiff(GetDockOffset(st->dock_tile)));
2564 TileIndex tile1 = st->dock_tile;
2565 TileIndex tile2 = tile1 + TileOffsByDiagDir(GetDockDirection(tile1));
2567 ret = EnsureNoVehicleOnGround(tile1);
2568 if (ret.Succeeded()) ret = EnsureNoVehicleOnGround(tile2);
2569 if (ret.Failed()) return ret;
2571 if (flags & DC_EXEC) {
2572 DoClearSquare(tile1);
2573 MarkTileDirtyByTile(tile1);
2574 MakeWaterKeepingClass(tile2, st->owner);
2576 st->rect.AfterRemoveTile(st, tile1);
2577 st->rect.AfterRemoveTile(st, tile2);
2579 st->dock_tile = INVALID_TILE;
2580 st->facilities &= ~FACIL_DOCK;
2582 Company::Get(st->owner)->infrastructure.station -= 2;
2583 DirtyCompanyInfrastructureWindows(st->owner);
2585 SetWindowWidgetDirty(WC_STATION_VIEW, st->index, WID_SV_SHIPS);
2586 st->UpdateVirtCoord();
2587 st->RecomputeIndustriesNear();
2588 DeleteStationIfEmpty(st);
2590 /* All ships that were going to our station, can't go to it anymore.
2591 * Just clear the order, then automatically the next appropriate order
2592 * will be selected and in case of no appropriate order it will just
2593 * wander around the world. */
2594 Ship *s;
2595 FOR_ALL_SHIPS(s) {
2596 if (s->current_order.IsType(OT_LOADING) && s->tile == docking_location) {
2597 s->LeaveStation();
2600 if (s->dest_tile == docking_location) {
2601 s->dest_tile = 0;
2602 s->current_order.Free();
2607 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_CLEAR_STATION_DOCK]);
2610 #include "table/station_land.h"
2612 const DrawTileSprites *GetStationTileLayout(StationType st, byte gfx)
2614 return &_station_display_datas[st][gfx];
2618 * Check whether a sprite is a track sprite, which can be replaced by a non-track ground sprite and a rail overlay.
2619 * If the ground sprite is suitable, \a ground is replaced with the new non-track ground sprite, and \a overlay_offset
2620 * is set to the overlay to draw.
2621 * @param ti Positional info for the tile to decide snowyness etc. May be NULL.
2622 * @param [in,out] ground Groundsprite to draw.
2623 * @param [out] overlay_offset Overlay to draw.
2624 * @return true if overlay can be drawn.
2626 bool SplitGroundSpriteForOverlay(const TileInfo *ti, SpriteID *ground, RailTrackOffset *overlay_offset)
2628 bool snow_desert;
2629 switch (*ground) {
2630 case SPR_RAIL_TRACK_X:
2631 snow_desert = false;
2632 *overlay_offset = RTO_X;
2633 break;
2635 case SPR_RAIL_TRACK_Y:
2636 snow_desert = false;
2637 *overlay_offset = RTO_Y;
2638 break;
2640 case SPR_RAIL_TRACK_X_SNOW:
2641 snow_desert = true;
2642 *overlay_offset = RTO_X;
2643 break;
2645 case SPR_RAIL_TRACK_Y_SNOW:
2646 snow_desert = true;
2647 *overlay_offset = RTO_Y;
2648 break;
2650 default:
2651 return false;
2654 if (ti != NULL) {
2655 /* Decide snow/desert from tile */
2656 switch (_settings_game.game_creation.landscape) {
2657 case LT_ARCTIC:
2658 snow_desert = (uint)ti->z > GetSnowLine() * TILE_HEIGHT;
2659 break;
2661 case LT_TROPIC:
2662 snow_desert = GetTropicZone(ti->tile) == TROPICZONE_DESERT;
2663 break;
2665 default:
2666 break;
2670 *ground = snow_desert ? SPR_FLAT_SNOW_DESERT_TILE : SPR_FLAT_GRASS_TILE;
2671 return true;
2674 static void DrawTile_Station(TileInfo *ti)
2676 const NewGRFSpriteLayout *layout = NULL;
2677 DrawTileSprites tmp_rail_layout;
2678 const DrawTileSprites *t = NULL;
2679 RoadTypes roadtypes;
2680 int32 total_offset;
2681 const RailtypeInfo *rti = NULL;
2682 uint32 relocation = 0;
2683 uint32 ground_relocation = 0;
2684 BaseStation *st = NULL;
2685 const StationSpec *statspec = NULL;
2686 uint tile_layout = 0;
2688 if (HasStationRail(ti->tile)) {
2689 rti = GetRailTypeInfo(GetRailType(ti->tile));
2690 roadtypes = ROADTYPES_NONE;
2691 total_offset = rti->GetRailtypeSpriteOffset();
2693 if (IsCustomStationSpecIndex(ti->tile)) {
2694 /* look for customization */
2695 st = BaseStation::GetByTile(ti->tile);
2696 statspec = st->speclist[GetCustomStationSpecIndex(ti->tile)].spec;
2698 if (statspec != NULL) {
2699 tile_layout = GetStationGfx(ti->tile);
2701 if (HasBit(statspec->callback_mask, CBM_STATION_SPRITE_LAYOUT)) {
2702 uint16 callback = GetStationCallback(CBID_STATION_SPRITE_LAYOUT, 0, 0, statspec, st, ti->tile);
2703 if (callback != CALLBACK_FAILED) tile_layout = (callback & ~1) + GetRailStationAxis(ti->tile);
2706 /* Ensure the chosen tile layout is valid for this custom station */
2707 if (statspec->renderdata != NULL) {
2708 layout = &statspec->renderdata[tile_layout < statspec->tiles ? tile_layout : (uint)GetRailStationAxis(ti->tile)];
2709 if (!layout->NeedsPreprocessing()) {
2710 t = layout;
2711 layout = NULL;
2716 } else {
2717 roadtypes = IsRoadStop(ti->tile) ? GetRoadTypes(ti->tile) : ROADTYPES_NONE;
2718 total_offset = 0;
2721 StationGfx gfx = GetStationGfx(ti->tile);
2722 if (IsAirport(ti->tile)) {
2723 gfx = GetAirportGfx(ti->tile);
2724 if (gfx >= NEW_AIRPORTTILE_OFFSET) {
2725 const AirportTileSpec *ats = AirportTileSpec::Get(gfx);
2726 if (ats->grf_prop.spritegroup[0] != NULL && DrawNewAirportTile(ti, Station::GetByTile(ti->tile), gfx, ats)) {
2727 return;
2729 /* No sprite group (or no valid one) found, meaning no graphics associated.
2730 * Use the substitute one instead */
2731 assert(ats->grf_prop.subst_id != INVALID_AIRPORTTILE);
2732 gfx = ats->grf_prop.subst_id;
2734 switch (gfx) {
2735 case APT_RADAR_GRASS_FENCE_SW:
2736 t = &_station_display_datas_airport_radar_grass_fence_sw[GetAnimationFrame(ti->tile)];
2737 break;
2738 case APT_GRASS_FENCE_NE_FLAG:
2739 t = &_station_display_datas_airport_flag_grass_fence_ne[GetAnimationFrame(ti->tile)];
2740 break;
2741 case APT_RADAR_FENCE_SW:
2742 t = &_station_display_datas_airport_radar_fence_sw[GetAnimationFrame(ti->tile)];
2743 break;
2744 case APT_RADAR_FENCE_NE:
2745 t = &_station_display_datas_airport_radar_fence_ne[GetAnimationFrame(ti->tile)];
2746 break;
2747 case APT_GRASS_FENCE_NE_FLAG_2:
2748 t = &_station_display_datas_airport_flag_grass_fence_ne_2[GetAnimationFrame(ti->tile)];
2749 break;
2753 Owner owner = GetTileOwner(ti->tile);
2755 PaletteID palette;
2756 if (Company::IsValidID(owner)) {
2757 palette = COMPANY_SPRITE_COLOUR(owner);
2758 } else {
2759 /* Some stations are not owner by a company, namely oil rigs */
2760 palette = PALETTE_TO_GREY;
2763 if (layout == NULL && (t == NULL || t->seq == NULL)) t = GetStationTileLayout(GetStationType(ti->tile), gfx);
2765 /* don't show foundation for docks */
2766 if (ti->tileh != SLOPE_FLAT && !IsDock(ti->tile)) {
2767 if (statspec != NULL && HasBit(statspec->flags, SSF_CUSTOM_FOUNDATIONS)) {
2768 /* Station has custom foundations.
2769 * Check whether the foundation continues beyond the tile's upper sides. */
2770 uint edge_info = 0;
2771 int z;
2772 Slope slope = GetFoundationPixelSlope(ti->tile, &z);
2773 if (!HasFoundationNW(ti->tile, slope, z)) SetBit(edge_info, 0);
2774 if (!HasFoundationNE(ti->tile, slope, z)) SetBit(edge_info, 1);
2775 SpriteID image = GetCustomStationFoundationRelocation(statspec, st, ti->tile, tile_layout, edge_info);
2776 if (image == 0) goto draw_default_foundation;
2778 if (HasBit(statspec->flags, SSF_EXTENDED_FOUNDATIONS)) {
2779 /* Station provides extended foundations. */
2781 static const uint8 foundation_parts[] = {
2782 0, 0, 0, 0, // Invalid, Invalid, Invalid, SLOPE_SW
2783 0, 1, 2, 3, // Invalid, SLOPE_EW, SLOPE_SE, SLOPE_WSE
2784 0, 4, 5, 6, // Invalid, SLOPE_NW, SLOPE_NS, SLOPE_NWS
2785 7, 8, 9 // SLOPE_NE, SLOPE_ENW, SLOPE_SEN
2788 AddSortableSpriteToDraw(image + foundation_parts[ti->tileh], PAL_NONE, ti->x, ti->y, 16, 16, 7, ti->z);
2789 } else {
2790 /* Draw simple foundations, built up from 8 possible foundation sprites. */
2792 /* Each set bit represents one of the eight composite sprites to be drawn.
2793 * 'Invalid' entries will not drawn but are included for completeness. */
2794 static const uint8 composite_foundation_parts[] = {
2795 /* Invalid (00000000), Invalid (11010001), Invalid (11100100), SLOPE_SW (11100000) */
2796 0x00, 0xD1, 0xE4, 0xE0,
2797 /* Invalid (11001010), SLOPE_EW (11001001), SLOPE_SE (11000100), SLOPE_WSE (11000000) */
2798 0xCA, 0xC9, 0xC4, 0xC0,
2799 /* Invalid (11010010), SLOPE_NW (10010001), SLOPE_NS (11100100), SLOPE_NWS (10100000) */
2800 0xD2, 0x91, 0xE4, 0xA0,
2801 /* SLOPE_NE (01001010), SLOPE_ENW (00001001), SLOPE_SEN (01000100) */
2802 0x4A, 0x09, 0x44
2805 uint8 parts = composite_foundation_parts[ti->tileh];
2807 /* If foundations continue beyond the tile's upper sides then
2808 * mask out the last two pieces. */
2809 if (HasBit(edge_info, 0)) ClrBit(parts, 6);
2810 if (HasBit(edge_info, 1)) ClrBit(parts, 7);
2812 if (parts == 0) {
2813 /* We always have to draw at least one sprite to make sure there is a boundingbox and a sprite with the
2814 * correct offset for the childsprites.
2815 * So, draw the (completely empty) sprite of the default foundations. */
2816 goto draw_default_foundation;
2819 StartSpriteCombine();
2820 for (int i = 0; i < 8; i++) {
2821 if (HasBit(parts, i)) {
2822 AddSortableSpriteToDraw(image + i, PAL_NONE, ti->x, ti->y, 16, 16, 7, ti->z);
2825 EndSpriteCombine();
2828 OffsetGroundSprite(31, 1);
2829 ti->z += ApplyPixelFoundationToSlope(FOUNDATION_LEVELED, &ti->tileh);
2830 } else {
2831 draw_default_foundation:
2832 DrawFoundation(ti, FOUNDATION_LEVELED);
2836 if (IsBuoy(ti->tile)) {
2837 DrawWaterClassGround(ti);
2838 SpriteID sprite = GetCanalSprite(CF_BUOY, ti->tile);
2839 if (sprite != 0) total_offset = sprite - SPR_IMG_BUOY;
2840 } else if (IsDock(ti->tile) || (IsOilRig(ti->tile) && IsTileOnWater(ti->tile))) {
2841 if (ti->tileh == SLOPE_FLAT) {
2842 DrawWaterClassGround(ti);
2843 } else {
2844 assert(IsDock(ti->tile));
2845 TileIndex water_tile = ti->tile + TileOffsByDiagDir(GetDockDirection(ti->tile));
2846 WaterClass wc = GetWaterClass(water_tile);
2847 if (wc == WATER_CLASS_SEA) {
2848 DrawShoreTile(ti->tileh);
2849 } else {
2850 DrawClearLandTile(ti, 3);
2853 } else {
2854 if (layout != NULL) {
2855 /* Sprite layout which needs preprocessing */
2856 bool separate_ground = HasBit(statspec->flags, SSF_SEPARATE_GROUND);
2857 uint32 var10_values = layout->PrepareLayout(total_offset, rti->fallback_railtype, 0, 0, separate_ground);
2858 uint8 var10;
2859 FOR_EACH_SET_BIT(var10, var10_values) {
2860 uint32 var10_relocation = GetCustomStationRelocation(statspec, st, ti->tile, var10);
2861 layout->ProcessRegisters(var10, var10_relocation, separate_ground);
2863 tmp_rail_layout.seq = layout->GetLayout(&tmp_rail_layout.ground);
2864 t = &tmp_rail_layout;
2865 total_offset = 0;
2866 } else if (statspec != NULL) {
2867 /* Simple sprite layout */
2868 ground_relocation = relocation = GetCustomStationRelocation(statspec, st, ti->tile, 0);
2869 if (HasBit(statspec->flags, SSF_SEPARATE_GROUND)) {
2870 ground_relocation = GetCustomStationRelocation(statspec, st, ti->tile, 1);
2872 ground_relocation += rti->fallback_railtype;
2875 SpriteID image = t->ground.sprite;
2876 PaletteID pal = t->ground.pal;
2877 RailTrackOffset overlay_offset;
2878 if (rti != NULL && rti->UsesOverlay() && SplitGroundSpriteForOverlay(ti, &image, &overlay_offset)) {
2879 SpriteID ground = GetCustomRailSprite(rti, ti->tile, RTSG_GROUND);
2880 DrawGroundSprite(image, PAL_NONE);
2881 DrawGroundSprite(ground + overlay_offset, PAL_NONE);
2883 if (_game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasStationReservation(ti->tile)) {
2884 SpriteID overlay = GetCustomRailSprite(rti, ti->tile, RTSG_OVERLAY);
2885 DrawGroundSprite(overlay + overlay_offset, PALETTE_CRASH);
2887 } else {
2888 image += HasBit(image, SPRITE_MODIFIER_CUSTOM_SPRITE) ? ground_relocation : total_offset;
2889 if (HasBit(pal, SPRITE_MODIFIER_CUSTOM_SPRITE)) pal += ground_relocation;
2890 DrawGroundSprite(image, GroundSpritePaletteTransform(image, pal, palette));
2892 /* PBS debugging, draw reserved tracks darker */
2893 if (_game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasStationRail(ti->tile) && HasStationReservation(ti->tile)) {
2894 const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(ti->tile));
2895 DrawGroundSprite(GetRailStationAxis(ti->tile) == AXIS_X ? rti->base_sprites.single_x : rti->base_sprites.single_y, PALETTE_CRASH);
2900 if (HasStationRail(ti->tile) && HasRailCatenaryDrawn(GetRailType(ti->tile))) DrawRailCatenary(ti);
2902 if (HasBit(roadtypes, ROADTYPE_TRAM)) {
2903 Axis axis = GetRoadStopDir(ti->tile) == DIAGDIR_NE ? AXIS_X : AXIS_Y;
2904 DrawGroundSprite((HasBit(roadtypes, ROADTYPE_ROAD) ? SPR_TRAMWAY_OVERLAY : SPR_TRAMWAY_TRAM) + (axis ^ 1), PAL_NONE);
2905 DrawRoadCatenary(ti, axis == AXIS_X ? ROAD_X : ROAD_Y);
2908 if (IsRailWaypoint(ti->tile)) {
2909 /* Don't offset the waypoint graphics; they're always the same. */
2910 total_offset = 0;
2913 DrawRailTileSeq(ti, t, TO_BUILDINGS, total_offset, relocation, palette);
2916 void StationPickerDrawSprite(int x, int y, StationType st, RailType railtype, RoadType roadtype, int image)
2918 int32 total_offset = 0;
2919 PaletteID pal = COMPANY_SPRITE_COLOUR(_local_company);
2920 const DrawTileSprites *t = GetStationTileLayout(st, image);
2921 const RailtypeInfo *rti = NULL;
2923 if (railtype != INVALID_RAILTYPE) {
2924 rti = GetRailTypeInfo(railtype);
2925 total_offset = rti->GetRailtypeSpriteOffset();
2928 SpriteID img = t->ground.sprite;
2929 RailTrackOffset overlay_offset;
2930 if (rti != NULL && rti->UsesOverlay() && SplitGroundSpriteForOverlay(NULL, &img, &overlay_offset)) {
2931 SpriteID ground = GetCustomRailSprite(rti, INVALID_TILE, RTSG_GROUND);
2932 DrawSprite(img, PAL_NONE, x, y);
2933 DrawSprite(ground + overlay_offset, PAL_NONE, x, y);
2934 } else {
2935 DrawSprite(img + total_offset, HasBit(img, PALETTE_MODIFIER_COLOUR) ? pal : PAL_NONE, x, y);
2938 if (roadtype == ROADTYPE_TRAM) {
2939 DrawSprite(SPR_TRAMWAY_TRAM + (t->ground.sprite == SPR_ROAD_PAVED_STRAIGHT_X ? 1 : 0), PAL_NONE, x, y);
2942 /* Default waypoint has no railtype specific sprites */
2943 DrawRailTileSeqInGUI(x, y, t, st == STATION_WAYPOINT ? 0 : total_offset, 0, pal);
2946 static int GetSlopePixelZ_Station(TileIndex tile, uint x, uint y)
2948 return GetTileMaxPixelZ(tile);
2951 static Foundation GetFoundation_Station(TileIndex tile, Slope tileh)
2953 return FlatteningFoundation(tileh);
2956 static void GetTileDesc_Station(TileIndex tile, TileDesc *td)
2958 td->owner[0] = GetTileOwner(tile);
2959 if (IsDriveThroughStopTile(tile)) {
2960 Owner road_owner = INVALID_OWNER;
2961 Owner tram_owner = INVALID_OWNER;
2962 RoadTypes rts = GetRoadTypes(tile);
2963 if (HasBit(rts, ROADTYPE_ROAD)) road_owner = GetRoadOwner(tile, ROADTYPE_ROAD);
2964 if (HasBit(rts, ROADTYPE_TRAM)) tram_owner = GetRoadOwner(tile, ROADTYPE_TRAM);
2966 /* Is there a mix of owners? */
2967 if ((tram_owner != INVALID_OWNER && tram_owner != td->owner[0]) ||
2968 (road_owner != INVALID_OWNER && road_owner != td->owner[0])) {
2969 uint i = 1;
2970 if (road_owner != INVALID_OWNER) {
2971 td->owner_type[i] = STR_LAND_AREA_INFORMATION_ROAD_OWNER;
2972 td->owner[i] = road_owner;
2973 i++;
2975 if (tram_owner != INVALID_OWNER) {
2976 td->owner_type[i] = STR_LAND_AREA_INFORMATION_TRAM_OWNER;
2977 td->owner[i] = tram_owner;
2981 td->build_date = BaseStation::GetByTile(tile)->build_date;
2983 if (HasStationTileRail(tile)) {
2984 const StationSpec *spec = GetStationSpec(tile);
2986 if (spec != NULL) {
2987 td->station_class = StationClass::Get(spec->cls_id)->name;
2988 td->station_name = spec->name;
2990 if (spec->grf_prop.grffile != NULL) {
2991 const GRFConfig *gc = GetGRFConfig(spec->grf_prop.grffile->grfid);
2992 td->grf = gc->GetName();
2996 const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
2997 td->rail_speed = rti->max_speed;
2998 td->railtype = rti->strings.name;
3001 if (IsAirport(tile)) {
3002 const AirportSpec *as = Station::GetByTile(tile)->airport.GetSpec();
3003 td->airport_class = AirportClass::Get(as->cls_id)->name;
3004 td->airport_name = as->name;
3006 const AirportTileSpec *ats = AirportTileSpec::GetByTile(tile);
3007 td->airport_tile_name = ats->name;
3009 if (as->grf_prop.grffile != NULL) {
3010 const GRFConfig *gc = GetGRFConfig(as->grf_prop.grffile->grfid);
3011 td->grf = gc->GetName();
3012 } else if (ats->grf_prop.grffile != NULL) {
3013 const GRFConfig *gc = GetGRFConfig(ats->grf_prop.grffile->grfid);
3014 td->grf = gc->GetName();
3018 StringID str;
3019 switch (GetStationType(tile)) {
3020 default: NOT_REACHED();
3021 case STATION_RAIL: str = STR_LAI_STATION_DESCRIPTION_RAILROAD_STATION; break;
3022 case STATION_AIRPORT:
3023 str = (IsHangar(tile) ? STR_LAI_STATION_DESCRIPTION_AIRCRAFT_HANGAR : STR_LAI_STATION_DESCRIPTION_AIRPORT);
3024 break;
3025 case STATION_TRUCK: str = STR_LAI_STATION_DESCRIPTION_TRUCK_LOADING_AREA; break;
3026 case STATION_BUS: str = STR_LAI_STATION_DESCRIPTION_BUS_STATION; break;
3027 case STATION_OILRIG: str = STR_INDUSTRY_NAME_OIL_RIG; break;
3028 case STATION_DOCK: str = STR_LAI_STATION_DESCRIPTION_SHIP_DOCK; break;
3029 case STATION_BUOY: str = STR_LAI_STATION_DESCRIPTION_BUOY; break;
3030 case STATION_WAYPOINT: str = STR_LAI_STATION_DESCRIPTION_WAYPOINT; break;
3032 td->str = str;
3036 static TrackStatus GetTileTrackStatus_Station(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
3038 TrackBits trackbits = TRACK_BIT_NONE;
3040 switch (mode) {
3041 case TRANSPORT_RAIL:
3042 if (HasStationRail(tile) && !IsStationTileBlocked(tile)) {
3043 trackbits = TrackToTrackBits(GetRailStationTrack(tile));
3045 break;
3047 case TRANSPORT_WATER:
3048 /* buoy is coded as a station, it is always on open water */
3049 if (IsBuoy(tile)) {
3050 trackbits = TRACK_BIT_ALL;
3051 /* remove tracks that connect NE map edge */
3052 if (TileX(tile) == 0) trackbits &= ~(TRACK_BIT_X | TRACK_BIT_UPPER | TRACK_BIT_RIGHT);
3053 /* remove tracks that connect NW map edge */
3054 if (TileY(tile) == 0) trackbits &= ~(TRACK_BIT_Y | TRACK_BIT_LEFT | TRACK_BIT_UPPER);
3056 break;
3058 case TRANSPORT_ROAD:
3059 if ((GetRoadTypes(tile) & sub_mode) != 0 && IsRoadStop(tile)) {
3060 DiagDirection dir = GetRoadStopDir(tile);
3061 Axis axis = DiagDirToAxis(dir);
3063 if (side != INVALID_DIAGDIR) {
3064 if (axis != DiagDirToAxis(side) || (IsStandardRoadStopTile(tile) && dir != side)) break;
3067 trackbits = AxisToTrackBits(axis);
3069 break;
3071 default:
3072 break;
3075 return CombineTrackStatus(TrackBitsToTrackdirBits(trackbits), TRACKDIR_BIT_NONE);
3079 static void TileLoop_Station(TileIndex tile)
3081 /* FIXME -- GetTileTrackStatus_Station -> animated stationtiles
3082 * hardcoded.....not good */
3083 switch (GetStationType(tile)) {
3084 case STATION_AIRPORT:
3085 AirportTileAnimationTrigger(Station::GetByTile(tile), tile, AAT_TILELOOP);
3086 break;
3088 case STATION_DOCK:
3089 if (!IsTileFlat(tile)) break; // only handle water part
3090 /* FALL THROUGH */
3091 case STATION_OILRIG: //(station part)
3092 case STATION_BUOY:
3093 TileLoop_Water(tile);
3094 break;
3096 default: break;
3101 static void AnimateTile_Station(TileIndex tile)
3103 if (HasStationRail(tile)) {
3104 AnimateStationTile(tile);
3105 return;
3108 if (IsAirport(tile)) {
3109 AnimateAirportTile(tile);
3114 static bool ClickTile_Station(TileIndex tile)
3116 const BaseStation *bst = BaseStation::GetByTile(tile);
3118 if (bst->facilities & FACIL_WAYPOINT) {
3119 ShowWaypointWindow(Waypoint::From(bst));
3120 } else if (IsHangar(tile)) {
3121 const Station *st = Station::From(bst);
3122 ShowDepotWindow(st->airport.GetHangarTile(st->airport.GetHangarNum(tile)), VEH_AIRCRAFT);
3123 } else {
3124 ShowStationViewWindow(bst->index);
3126 return true;
3129 static VehicleEnterTileStatus VehicleEnter_Station(Vehicle *v, TileIndex tile, int x, int y)
3131 if (v->type == VEH_TRAIN) {
3132 StationID station_id = GetStationIndex(tile);
3133 if (!v->current_order.ShouldStopAtStation(v, station_id)) return VETSB_CONTINUE;
3134 if (!IsRailStation(tile) || !v->IsFrontEngine()) return VETSB_CONTINUE;
3136 int station_ahead;
3137 int station_length;
3138 int stop = GetTrainStopLocation(station_id, tile, Train::From(v), &station_ahead, &station_length);
3140 /* Stop whenever that amount of station ahead + the distance from the
3141 * begin of the platform to the stop location is longer than the length
3142 * of the platform. Station ahead 'includes' the current tile where the
3143 * vehicle is on, so we need to subtract that. */
3144 if (stop + station_ahead - (int)TILE_SIZE >= station_length) return VETSB_CONTINUE;
3146 DiagDirection dir = DirToDiagDir(v->direction);
3148 x &= 0xF;
3149 y &= 0xF;
3151 if (DiagDirToAxis(dir) != AXIS_X) Swap(x, y);
3152 if (y == TILE_SIZE / 2) {
3153 if (dir != DIAGDIR_SE && dir != DIAGDIR_SW) x = TILE_SIZE - 1 - x;
3154 stop &= TILE_SIZE - 1;
3156 if (x == stop) {
3157 return VETSB_ENTERED_STATION | (VehicleEnterTileStatus)(station_id << VETS_STATION_ID_OFFSET); // enter station
3158 } else if (x < stop) {
3159 v->vehstatus |= VS_TRAIN_SLOWING;
3160 uint16 spd = max(0, (stop - x) * 20 - 15);
3161 if (spd < v->cur_speed) v->cur_speed = spd;
3164 } else if (v->type == VEH_ROAD) {
3165 RoadVehicle *rv = RoadVehicle::From(v);
3166 if (rv->state < RVSB_IN_ROAD_STOP && !IsReversingRoadTrackdir((Trackdir)rv->state) && rv->frame == 0) {
3167 if (IsRoadStop(tile) && rv->IsFrontEngine()) {
3168 /* Attempt to allocate a parking bay in a road stop */
3169 return RoadStop::GetByTile(tile, GetRoadStopType(tile))->Enter(rv) ? VETSB_CONTINUE : VETSB_CANNOT_ENTER;
3174 return VETSB_CONTINUE;
3178 * Run the watched cargo callback for all houses in the catchment area.
3179 * @param st Station.
3181 void TriggerWatchedCargoCallbacks(Station *st)
3183 /* Collect cargoes accepted since the last big tick. */
3184 uint cargoes = 0;
3185 for (CargoID cid = 0; cid < NUM_CARGO; cid++) {
3186 if (HasBit(st->goods[cid].status, GoodsEntry::GES_ACCEPTED_BIGTICK)) SetBit(cargoes, cid);
3189 /* Anything to do? */
3190 if (cargoes == 0) return;
3192 /* Loop over all houses in the catchment. */
3193 Rect r = st->GetCatchmentRect();
3194 TileArea ta(TileXY(r.left, r.top), TileXY(r.right, r.bottom));
3195 TILE_AREA_LOOP(tile, ta) {
3196 if (IsTileType(tile, MP_HOUSE)) {
3197 WatchedCargoCallback(tile, cargoes);
3203 * This function is called for each station once every 250 ticks.
3204 * Not all stations will get the tick at the same time.
3205 * @param st the station receiving the tick.
3206 * @return true if the station is still valid (wasn't deleted)
3208 static bool StationHandleBigTick(BaseStation *st)
3210 if (!st->IsInUse()) {
3211 if (++st->delete_ctr >= 8) delete st;
3212 return false;
3215 if (Station::IsExpected(st)) {
3216 TriggerWatchedCargoCallbacks(Station::From(st));
3218 for (CargoID i = 0; i < NUM_CARGO; i++) {
3219 ClrBit(Station::From(st)->goods[i].status, GoodsEntry::GES_ACCEPTED_BIGTICK);
3224 if ((st->facilities & FACIL_WAYPOINT) == 0) UpdateStationAcceptance(Station::From(st), true);
3226 return true;
3229 static inline void byte_inc_sat(byte *p)
3231 byte b = *p + 1;
3232 if (b != 0) *p = b;
3236 * Truncate the cargo by a specific amount.
3237 * @param cs The type of cargo to perform the truncation for.
3238 * @param ge The goods entry, of the station, to truncate.
3239 * @param amount The amount to truncate the cargo by.
3241 static void TruncateCargo(const CargoSpec *cs, GoodsEntry *ge, uint amount = UINT_MAX)
3243 /* If truncating also punish the source stations' ratings to
3244 * decrease the flow of incoming cargo. */
3246 StationCargoAmountMap waiting_per_source;
3247 ge->cargo.Truncate(amount, &waiting_per_source);
3248 for (StationCargoAmountMap::iterator i(waiting_per_source.begin()); i != waiting_per_source.end(); ++i) {
3249 Station *source_station = Station::GetIfValid(i->first);
3250 if (source_station == NULL) continue;
3252 GoodsEntry &source_ge = source_station->goods[cs->Index()];
3253 source_ge.max_waiting_cargo = max(source_ge.max_waiting_cargo, i->second);
3257 static void UpdateStationRating(Station *st)
3259 bool waiting_changed = false;
3261 byte_inc_sat(&st->time_since_load);
3262 byte_inc_sat(&st->time_since_unload);
3264 const CargoSpec *cs;
3265 FOR_ALL_CARGOSPECS(cs) {
3266 GoodsEntry *ge = &st->goods[cs->Index()];
3267 /* Slowly increase the rating back to his original level in the case we
3268 * didn't deliver cargo yet to this station. This happens when a bribe
3269 * failed while you didn't moved that cargo yet to a station. */
3270 if (!ge->HasRating() && ge->rating < INITIAL_STATION_RATING) {
3271 ge->rating++;
3274 /* Only change the rating if we are moving this cargo */
3275 if (ge->HasRating()) {
3276 byte_inc_sat(&ge->time_since_pickup);
3277 if (ge->time_since_pickup == 255 && _settings_game.order.selectgoods) {
3278 ClrBit(ge->status, GoodsEntry::GES_RATING);
3279 ge->last_speed = 0;
3280 TruncateCargo(cs, ge);
3281 waiting_changed = true;
3282 continue;
3285 bool skip = false;
3286 int rating = 0;
3287 uint waiting = ge->cargo.AvailableCount();
3289 /* num_dests is at least 1 if there is any cargo as
3290 * INVALID_STATION is also a destination.
3292 uint num_dests = (uint)ge->cargo.Packets()->MapSize();
3294 /* Average amount of cargo per next hop, but prefer solitary stations
3295 * with only one or two next hops. They are allowed to have more
3296 * cargo waiting per next hop.
3297 * With manual cargo distribution waiting_avg = waiting / 2 as then
3298 * INVALID_STATION is the only destination.
3300 uint waiting_avg = waiting / (num_dests + 1);
3302 if (HasBit(cs->callback_mask, CBM_CARGO_STATION_RATING_CALC)) {
3303 /* Perform custom station rating. If it succeeds the speed, days in transit and
3304 * waiting cargo ratings must not be executed. */
3306 /* NewGRFs expect last speed to be 0xFF when no vehicle has arrived yet. */
3307 uint last_speed = ge->HasVehicleEverTriedLoading() ? ge->last_speed : 0xFF;
3309 uint32 var18 = min(ge->time_since_pickup, 0xFF) | (min(ge->max_waiting_cargo, 0xFFFF) << 8) | (min(last_speed, 0xFF) << 24);
3310 /* Convert to the 'old' vehicle types */
3311 uint32 var10 = (st->last_vehicle_type == VEH_INVALID) ? 0x0 : (st->last_vehicle_type + 0x10);
3312 uint16 callback = GetCargoCallback(CBID_CARGO_STATION_RATING_CALC, var10, var18, cs);
3313 if (callback != CALLBACK_FAILED) {
3314 skip = true;
3315 rating = GB(callback, 0, 14);
3317 /* Simulate a 15 bit signed value */
3318 if (HasBit(callback, 14)) rating -= 0x4000;
3322 if (!skip) {
3323 int b = ge->last_speed - 85;
3324 if (b >= 0) rating += b >> 2;
3326 byte waittime = ge->time_since_pickup;
3327 if (st->last_vehicle_type == VEH_SHIP) waittime >>= 2;
3328 (waittime > 21) ||
3329 (rating += 25, waittime > 12) ||
3330 (rating += 25, waittime > 6) ||
3331 (rating += 45, waittime > 3) ||
3332 (rating += 35, true);
3334 (rating -= 90, ge->max_waiting_cargo > 1500) ||
3335 (rating += 55, ge->max_waiting_cargo > 1000) ||
3336 (rating += 35, ge->max_waiting_cargo > 600) ||
3337 (rating += 10, ge->max_waiting_cargo > 300) ||
3338 (rating += 20, ge->max_waiting_cargo > 100) ||
3339 (rating += 10, true);
3342 if (Company::IsValidID(st->owner) && HasBit(st->town->statues, st->owner)) rating += 26;
3344 byte age = ge->last_age;
3345 (age >= 3) ||
3346 (rating += 10, age >= 2) ||
3347 (rating += 10, age >= 1) ||
3348 (rating += 13, true);
3351 int or_ = ge->rating; // old rating
3353 /* only modify rating in steps of -2, -1, 0, 1 or 2 */
3354 ge->rating = rating = or_ + Clamp(Clamp(rating, 0, 255) - or_, -2, 2);
3356 /* if rating is <= 64 and more than 100 items waiting on average per destination,
3357 * remove some random amount of goods from the station */
3358 if (rating <= 64 && waiting_avg >= 100) {
3359 int dec = Random() & 0x1F;
3360 if (waiting_avg < 200) dec &= 7;
3361 waiting -= (dec + 1) * num_dests;
3362 waiting_changed = true;
3365 /* if rating is <= 127 and there are any items waiting, maybe remove some goods. */
3366 if (rating <= 127 && waiting != 0) {
3367 uint32 r = Random();
3368 if (rating <= (int)GB(r, 0, 7)) {
3369 /* Need to have int, otherwise it will just overflow etc. */
3370 waiting = max((int)waiting - (int)((GB(r, 8, 2) - 1) * num_dests), 0);
3371 waiting_changed = true;
3375 /* At some point we really must cap the cargo. Previously this
3376 * was a strict 4095, but now we'll have a less strict, but
3377 * increasingly aggressive truncation of the amount of cargo. */
3378 static const uint WAITING_CARGO_THRESHOLD = 1 << 12;
3379 static const uint WAITING_CARGO_CUT_FACTOR = 1 << 6;
3380 static const uint MAX_WAITING_CARGO = 1 << 15;
3382 if (waiting > WAITING_CARGO_THRESHOLD) {
3383 uint difference = waiting - WAITING_CARGO_THRESHOLD;
3384 waiting -= (difference / WAITING_CARGO_CUT_FACTOR);
3386 waiting = min(waiting, MAX_WAITING_CARGO);
3387 waiting_changed = true;
3390 /* We can't truncate cargo that's already reserved for loading.
3391 * Thus StoredCount() here. */
3392 if (waiting_changed && waiting < ge->cargo.AvailableCount()) {
3393 /* Feed back the exact own waiting cargo at this station for the
3394 * next rating calculation. */
3395 ge->max_waiting_cargo = 0;
3397 TruncateCargo(cs, ge, ge->cargo.AvailableCount() - waiting);
3398 } else {
3399 /* If the average number per next hop is low, be more forgiving. */
3400 ge->max_waiting_cargo = waiting_avg;
3406 StationID index = st->index;
3407 if (waiting_changed) {
3408 SetWindowDirty(WC_STATION_VIEW, index); // update whole window
3409 } else {
3410 SetWindowWidgetDirty(WC_STATION_VIEW, index, WID_SV_ACCEPT_RATING_LIST); // update only ratings list
3415 * Reroute cargo of type c at station st or in any vehicles unloading there.
3416 * Make sure the cargo's new next hop is neither "avoid" nor "avoid2".
3417 * @param st Station to be rerouted at.
3418 * @param c Type of cargo.
3419 * @param avoid Original next hop of cargo, avoid this.
3420 * @param avoid2 Another station to be avoided when rerouting.
3422 void RerouteCargo(Station *st, CargoID c, StationID avoid, StationID avoid2)
3424 GoodsEntry &ge = st->goods[c];
3426 /* Reroute cargo in station. */
3427 ge.cargo.Reroute(UINT_MAX, &ge.cargo, avoid, avoid2, &ge);
3429 /* Reroute cargo staged to be transfered. */
3430 for (std::list<Vehicle *>::iterator it(st->loading_vehicles.begin()); it != st->loading_vehicles.end(); ++it) {
3431 for (Vehicle *v = *it; v != NULL; v = v->Next()) {
3432 if (v->cargo_type != c) continue;
3433 v->cargo.Reroute(UINT_MAX, &v->cargo, avoid, avoid2, &ge);
3439 * Check all next hops of cargo packets in this station for existance of a
3440 * a valid link they may use to travel on. Reroute any cargo not having a valid
3441 * link and remove timed out links found like this from the linkgraph. We're
3442 * not all links here as that is expensive and useless. A link no one is using
3443 * doesn't hurt either.
3444 * @param from Station to check.
3446 void DeleteStaleLinks(Station *from)
3448 for (CargoID c = 0; c < NUM_CARGO; ++c) {
3449 const bool auto_distributed = (_settings_game.linkgraph.GetDistributionType(c) != DT_MANUAL);
3450 GoodsEntry &ge = from->goods[c];
3451 LinkGraph *lg = LinkGraph::GetIfValid(ge.link_graph);
3452 if (lg == NULL) continue;
3453 Node node = (*lg)[ge.node];
3454 for (EdgeIterator it(node.Begin()); it != node.End();) {
3455 Edge edge = it->second;
3456 Station *to = Station::Get((*lg)[it->first].Station());
3457 assert(to->goods[c].node == it->first);
3458 ++it; // Do that before removing the edge. Anything else may crash.
3459 assert(_date >= edge.LastUpdate());
3460 uint timeout = LinkGraph::MIN_TIMEOUT_DISTANCE + (DistanceManhattan(from->xy, to->xy) >> 3);
3461 if ((uint)(_date - edge.LastUpdate()) > timeout) {
3462 bool updated = false;
3464 if (auto_distributed) {
3465 /* Have all vehicles refresh their next hops before deciding to
3466 * remove the node. */
3467 OrderList *l;
3468 SmallVector<Vehicle *, 32> vehicles;
3469 FOR_ALL_ORDER_LISTS(l) {
3470 bool found_from = false;
3471 bool found_to = false;
3472 for (Order *order = l->GetFirstOrder(); order != NULL; order = order->next) {
3473 if (!order->IsType(OT_GOTO_STATION) && !order->IsType(OT_IMPLICIT)) continue;
3474 if (order->GetDestination() == from->index) {
3475 found_from = true;
3476 if (found_to) break;
3477 } else if (order->GetDestination() == to->index) {
3478 found_to = true;
3479 if (found_from) break;
3482 if (!found_to || !found_from) continue;
3483 *(vehicles.Append()) = l->GetFirstSharedVehicle();
3486 Vehicle **iter = vehicles.Begin();
3487 while (iter != vehicles.End()) {
3488 Vehicle *v = *iter;
3490 LinkRefresher::Run(v, false); // Don't allow merging. Otherwise lg might get deleted.
3491 if (edge.LastUpdate() == _date) {
3492 updated = true;
3493 break;
3496 Vehicle *next_shared = v->NextShared();
3497 if (next_shared) {
3498 *iter = next_shared;
3499 ++iter;
3500 } else {
3501 vehicles.Erase(iter);
3504 if (iter == vehicles.End()) iter = vehicles.Begin();
3508 if (!updated) {
3509 /* If it's still considered dead remove it. */
3510 node.RemoveEdge(to->goods[c].node);
3511 ge.flows.DeleteFlows(to->index);
3512 RerouteCargo(from, c, to->index, from->index);
3514 } else if (edge.LastUnrestrictedUpdate() != INVALID_DATE && (uint)(_date - edge.LastUnrestrictedUpdate()) > timeout) {
3515 edge.Restrict();
3516 ge.flows.RestrictFlows(to->index);
3517 RerouteCargo(from, c, to->index, from->index);
3518 } else if (edge.LastRestrictedUpdate() != INVALID_DATE && (uint)(_date - edge.LastRestrictedUpdate()) > timeout) {
3519 edge.Release();
3522 assert(_date >= lg->LastCompression());
3523 if ((uint)(_date - lg->LastCompression()) > LinkGraph::COMPRESSION_INTERVAL) {
3524 lg->Compress();
3530 * Increase capacity for a link stat given by station cargo and next hop.
3531 * @param st Station to get the link stats from.
3532 * @param cargo Cargo to increase stat for.
3533 * @param next_station_id Station the consist will be travelling to next.
3534 * @param capacity Capacity to add to link stat.
3535 * @param usage Usage to add to link stat.
3536 * @param mode Update mode to be applied.
3538 void IncreaseStats(Station *st, CargoID cargo, StationID next_station_id, uint capacity, uint usage, EdgeUpdateMode mode)
3540 GoodsEntry &ge1 = st->goods[cargo];
3541 Station *st2 = Station::Get(next_station_id);
3542 GoodsEntry &ge2 = st2->goods[cargo];
3543 LinkGraph *lg = NULL;
3544 if (ge1.link_graph == INVALID_LINK_GRAPH) {
3545 if (ge2.link_graph == INVALID_LINK_GRAPH) {
3546 if (LinkGraph::CanAllocateItem()) {
3547 lg = new LinkGraph(cargo);
3548 LinkGraphSchedule::instance.Queue(lg);
3549 ge2.link_graph = lg->index;
3550 ge2.node = lg->AddNode(st2);
3551 } else {
3552 DEBUG(misc, 0, "Can't allocate link graph");
3554 } else {
3555 lg = LinkGraph::Get(ge2.link_graph);
3557 if (lg) {
3558 ge1.link_graph = lg->index;
3559 ge1.node = lg->AddNode(st);
3561 } else if (ge2.link_graph == INVALID_LINK_GRAPH) {
3562 lg = LinkGraph::Get(ge1.link_graph);
3563 ge2.link_graph = lg->index;
3564 ge2.node = lg->AddNode(st2);
3565 } else {
3566 lg = LinkGraph::Get(ge1.link_graph);
3567 if (ge1.link_graph != ge2.link_graph) {
3568 LinkGraph *lg2 = LinkGraph::Get(ge2.link_graph);
3569 if (lg->Size() < lg2->Size()) {
3570 LinkGraphSchedule::instance.Unqueue(lg);
3571 lg2->Merge(lg); // Updates GoodsEntries of lg
3572 lg = lg2;
3573 } else {
3574 LinkGraphSchedule::instance.Unqueue(lg2);
3575 lg->Merge(lg2); // Updates GoodsEntries of lg2
3579 if (lg != NULL) {
3580 (*lg)[ge1.node].UpdateEdge(ge2.node, capacity, usage, mode);
3585 * Increase capacity for all link stats associated with vehicles in the given consist.
3586 * @param st Station to get the link stats from.
3587 * @param front First vehicle in the consist.
3588 * @param next_station_id Station the consist will be travelling to next.
3590 void IncreaseStats(Station *st, const Vehicle *front, StationID next_station_id)
3592 for (const Vehicle *v = front; v != NULL; v = v->Next()) {
3593 if (v->refit_cap > 0) {
3594 /* The cargo count can indeed be higher than the refit_cap if
3595 * wagons have been auto-replaced and subsequently auto-
3596 * refitted to a higher capacity. The cargo gets redistributed
3597 * among the wagons in that case.
3598 * As usage is not such an important figure anyway we just
3599 * ignore the additional cargo then.*/
3600 IncreaseStats(st, v->cargo_type, next_station_id, v->refit_cap,
3601 min(v->refit_cap, v->cargo.StoredCount()), EUM_INCREASE);
3606 /* called for every station each tick */
3607 static void StationHandleSmallTick(BaseStation *st)
3609 if ((st->facilities & FACIL_WAYPOINT) != 0 || !st->IsInUse()) return;
3611 byte b = st->delete_ctr + 1;
3612 if (b >= STATION_RATING_TICKS) b = 0;
3613 st->delete_ctr = b;
3615 if (b == 0) UpdateStationRating(Station::From(st));
3618 void OnTick_Station()
3620 if (_game_mode == GM_EDITOR) return;
3622 BaseStation *st;
3623 FOR_ALL_BASE_STATIONS(st) {
3624 StationHandleSmallTick(st);
3626 /* Clean up the link graph about once a week. */
3627 if (Station::IsExpected(st) && (_tick_counter + st->index) % STATION_LINKGRAPH_TICKS == 0) {
3628 DeleteStaleLinks(Station::From(st));
3631 /* Run STATION_ACCEPTANCE_TICKS = 250 tick interval trigger for station animation.
3632 * Station index is included so that triggers are not all done
3633 * at the same time. */
3634 if ((_tick_counter + st->index) % STATION_ACCEPTANCE_TICKS == 0) {
3635 /* Stop processing this station if it was deleted */
3636 if (!StationHandleBigTick(st)) continue;
3637 TriggerStationAnimation(st, st->xy, SAT_250_TICKS);
3638 if (Station::IsExpected(st)) AirportAnimationTrigger(Station::From(st), AAT_STATION_250_TICKS);
3643 /** Monthly loop for stations. */
3644 void StationMonthlyLoop()
3646 Station *st;
3648 FOR_ALL_STATIONS(st) {
3649 for (CargoID i = 0; i < NUM_CARGO; i++) {
3650 GoodsEntry *ge = &st->goods[i];
3651 SB(ge->status, GoodsEntry::GES_LAST_MONTH, 1, GB(ge->status, GoodsEntry::GES_CURRENT_MONTH, 1));
3652 ClrBit(ge->status, GoodsEntry::GES_CURRENT_MONTH);
3658 void ModifyStationRatingAround(TileIndex tile, Owner owner, int amount, uint radius)
3660 Station *st;
3662 FOR_ALL_STATIONS(st) {
3663 if (st->owner == owner &&
3664 DistanceManhattan(tile, st->xy) <= radius) {
3665 for (CargoID i = 0; i < NUM_CARGO; i++) {
3666 GoodsEntry *ge = &st->goods[i];
3668 if (ge->status != 0) {
3669 ge->rating = Clamp(ge->rating + amount, 0, 255);
3676 static uint UpdateStationWaiting(Station *st, CargoID type, uint amount, SourceType source_type, SourceID source_id)
3678 /* We can't allocate a CargoPacket? Then don't do anything
3679 * at all; i.e. just discard the incoming cargo. */
3680 if (!CargoPacket::CanAllocateItem()) return 0;
3682 GoodsEntry &ge = st->goods[type];
3683 amount += ge.amount_fract;
3684 ge.amount_fract = GB(amount, 0, 8);
3686 amount >>= 8;
3687 /* No new "real" cargo item yet. */
3688 if (amount == 0) return 0;
3690 StationID next = ge.GetVia(st->index);
3691 ge.cargo.Append(new CargoPacket(st->index, st->xy, amount, source_type, source_id), next);
3692 LinkGraph *lg = NULL;
3693 if (ge.link_graph == INVALID_LINK_GRAPH) {
3694 if (LinkGraph::CanAllocateItem()) {
3695 lg = new LinkGraph(type);
3696 LinkGraphSchedule::instance.Queue(lg);
3697 ge.link_graph = lg->index;
3698 ge.node = lg->AddNode(st);
3699 } else {
3700 DEBUG(misc, 0, "Can't allocate link graph");
3702 } else {
3703 lg = LinkGraph::Get(ge.link_graph);
3705 if (lg != NULL) (*lg)[ge.node].UpdateSupply(amount);
3707 if (!ge.HasRating()) {
3708 InvalidateWindowData(WC_STATION_LIST, st->index);
3709 SetBit(ge.status, GoodsEntry::GES_RATING);
3712 TriggerStationRandomisation(st, st->xy, SRT_NEW_CARGO, type);
3713 TriggerStationAnimation(st, st->xy, SAT_NEW_CARGO, type);
3714 AirportAnimationTrigger(st, AAT_STATION_NEW_CARGO, type);
3716 SetWindowDirty(WC_STATION_VIEW, st->index);
3717 st->MarkTilesDirty(true);
3718 return amount;
3721 static bool IsUniqueStationName(const char *name)
3723 const Station *st;
3725 FOR_ALL_STATIONS(st) {
3726 if (st->name != NULL && strcmp(st->name, name) == 0) return false;
3729 return true;
3733 * Rename a station
3734 * @param tile unused
3735 * @param flags operation to perform
3736 * @param p1 station ID that is to be renamed
3737 * @param p2 unused
3738 * @param text the new name or an empty string when resetting to the default
3739 * @return the cost of this operation or an error
3741 CommandCost CmdRenameStation(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
3743 Station *st = Station::GetIfValid(p1);
3744 if (st == NULL) return CMD_ERROR;
3746 CommandCost ret = CheckOwnership(st->owner);
3747 if (ret.Failed()) return ret;
3749 bool reset = StrEmpty(text);
3751 if (!reset) {
3752 if (Utf8StringLength(text) >= MAX_LENGTH_STATION_NAME_CHARS) return CMD_ERROR;
3753 if (!IsUniqueStationName(text)) return_cmd_error(STR_ERROR_NAME_MUST_BE_UNIQUE);
3756 if (flags & DC_EXEC) {
3757 free(st->name);
3758 st->name = reset ? NULL : stredup(text);
3760 st->UpdateVirtCoord();
3761 InvalidateWindowData(WC_STATION_LIST, st->owner, 1);
3764 return CommandCost();
3768 * Find all stations around a rectangular producer (industry, house, headquarter, ...)
3770 * @param location The location/area of the producer
3771 * @param stations The list to store the stations in
3773 void FindStationsAroundTiles(const TileArea &location, StationList *stations)
3775 /* area to search = producer plus station catchment radius */
3776 uint max_rad = (_settings_game.station.modified_catchment ? MAX_CATCHMENT : CA_UNMODIFIED);
3778 uint x = TileX(location.tile);
3779 uint y = TileY(location.tile);
3781 uint min_x = (x > max_rad) ? x - max_rad : 0;
3782 uint max_x = x + location.w + max_rad;
3783 uint min_y = (y > max_rad) ? y - max_rad : 0;
3784 uint max_y = y + location.h + max_rad;
3786 if (min_x == 0 && _settings_game.construction.freeform_edges) min_x = 1;
3787 if (min_y == 0 && _settings_game.construction.freeform_edges) min_y = 1;
3788 if (max_x >= MapSizeX()) max_x = MapSizeX() - 1;
3789 if (max_y >= MapSizeY()) max_y = MapSizeY() - 1;
3791 for (uint cy = min_y; cy < max_y; cy++) {
3792 for (uint cx = min_x; cx < max_x; cx++) {
3793 TileIndex cur_tile = TileXY(cx, cy);
3794 if (!IsTileType(cur_tile, MP_STATION)) continue;
3796 Station *st = Station::GetByTile(cur_tile);
3797 /* st can be NULL in case of waypoints */
3798 if (st == NULL) continue;
3800 if (_settings_game.station.modified_catchment) {
3801 int rad = st->GetCatchmentRadius();
3802 int rad_x = cx - x;
3803 int rad_y = cy - y;
3805 if (rad_x < -rad || rad_x >= rad + location.w) continue;
3806 if (rad_y < -rad || rad_y >= rad + location.h) continue;
3809 /* Insert the station in the set. This will fail if it has
3810 * already been added.
3812 stations->Include(st);
3818 * Run a tile loop to find stations around a tile, on demand. Cache the result for further requests
3819 * @return pointer to a StationList containing all stations found
3821 const StationList *StationFinder::GetStations()
3823 if (this->tile != INVALID_TILE) {
3824 FindStationsAroundTiles(*this, &this->stations);
3825 this->tile = INVALID_TILE;
3827 return &this->stations;
3830 uint MoveGoodsToStation(CargoID type, uint amount, SourceType source_type, SourceID source_id, const StationList *all_stations)
3832 /* Return if nothing to do. Also the rounding below fails for 0. */
3833 if (amount == 0) return 0;
3835 Station *st1 = NULL; // Station with best rating
3836 Station *st2 = NULL; // Second best station
3837 uint best_rating1 = 0; // rating of st1
3838 uint best_rating2 = 0; // rating of st2
3840 for (Station * const *st_iter = all_stations->Begin(); st_iter != all_stations->End(); ++st_iter) {
3841 Station *st = *st_iter;
3843 /* Is the station reserved exclusively for somebody else? */
3844 if (st->town->exclusive_counter > 0 && st->town->exclusivity != st->owner) continue;
3846 if (st->goods[type].rating == 0) continue; // Lowest possible rating, better not to give cargo anymore
3848 if (_settings_game.order.selectgoods && !st->goods[type].HasVehicleEverTriedLoading()) continue; // Selectively servicing stations, and not this one
3850 if (IsCargoInClass(type, CC_PASSENGERS)) {
3851 if (st->facilities == FACIL_TRUCK_STOP) continue; // passengers are never served by just a truck stop
3852 } else {
3853 if (st->facilities == FACIL_BUS_STOP) continue; // non-passengers are never served by just a bus stop
3856 /* This station can be used, add it to st1/st2 */
3857 if (st1 == NULL || st->goods[type].rating >= best_rating1) {
3858 st2 = st1; best_rating2 = best_rating1; st1 = st; best_rating1 = st->goods[type].rating;
3859 } else if (st2 == NULL || st->goods[type].rating >= best_rating2) {
3860 st2 = st; best_rating2 = st->goods[type].rating;
3864 /* no stations around at all? */
3865 if (st1 == NULL) return 0;
3867 /* From now we'll calculate with fractal cargo amounts.
3868 * First determine how much cargo we really have. */
3869 amount *= best_rating1 + 1;
3871 if (st2 == NULL) {
3872 /* only one station around */
3873 return UpdateStationWaiting(st1, type, amount, source_type, source_id);
3876 /* several stations around, the best two (highest rating) are in st1 and st2 */
3877 assert(st1 != NULL);
3878 assert(st2 != NULL);
3879 assert(best_rating1 != 0 || best_rating2 != 0);
3881 /* Then determine the amount the worst station gets. We do it this way as the
3882 * best should get a bonus, which in this case is the rounding difference from
3883 * this calculation. In reality that will mean the bonus will be pretty low.
3884 * Nevertheless, the best station should always get the most cargo regardless
3885 * of rounding issues. */
3886 uint worst_cargo = amount * best_rating2 / (best_rating1 + best_rating2);
3887 assert(worst_cargo <= (amount - worst_cargo));
3889 /* And then send the cargo to the stations! */
3890 uint moved = UpdateStationWaiting(st1, type, amount - worst_cargo, source_type, source_id);
3891 /* These two UpdateStationWaiting's can't be in the statement as then the order
3892 * of execution would be undefined and that could cause desyncs with callbacks. */
3893 return moved + UpdateStationWaiting(st2, type, worst_cargo, source_type, source_id);
3896 void BuildOilRig(TileIndex tile)
3898 if (!Station::CanAllocateItem()) {
3899 DEBUG(misc, 0, "Can't allocate station for oilrig at 0x%X, reverting to oilrig only", tile);
3900 return;
3903 Station *st = new Station(tile);
3904 st->town = ClosestTownFromTile(tile, UINT_MAX);
3906 st->string_id = GenerateStationName(st, tile, STATIONNAMING_OILRIG);
3908 assert(IsTileType(tile, MP_INDUSTRY));
3909 DeleteAnimatedTile(tile);
3910 MakeOilrig(tile, st->index, GetWaterClass(tile));
3912 st->owner = OWNER_NONE;
3913 st->airport.type = AT_OILRIG;
3914 st->airport.Add(tile);
3915 st->dock_tile = tile;
3916 st->facilities = FACIL_AIRPORT | FACIL_DOCK;
3917 st->build_date = _date;
3919 st->rect.BeforeAddTile(tile, StationRect::ADD_FORCE);
3921 st->UpdateVirtCoord();
3922 UpdateStationAcceptance(st, false);
3923 st->RecomputeIndustriesNear();
3926 void DeleteOilRig(TileIndex tile)
3928 Station *st = Station::GetByTile(tile);
3930 MakeWaterKeepingClass(tile, OWNER_NONE);
3932 st->dock_tile = INVALID_TILE;
3933 st->airport.Clear();
3934 st->facilities &= ~(FACIL_AIRPORT | FACIL_DOCK);
3935 st->airport.flags = 0;
3937 st->rect.AfterRemoveTile(st, tile);
3939 st->UpdateVirtCoord();
3940 st->RecomputeIndustriesNear();
3941 if (!st->IsInUse()) delete st;
3944 static void ChangeTileOwner_Station(TileIndex tile, Owner old_owner, Owner new_owner)
3946 if (IsRoadStopTile(tile)) {
3947 for (RoadType rt = ROADTYPE_ROAD; rt < ROADTYPE_END; rt++) {
3948 /* Update all roadtypes, no matter if they are present */
3949 if (GetRoadOwner(tile, rt) == old_owner) {
3950 if (HasTileRoadType(tile, rt)) {
3951 /* A drive-through road-stop has always two road bits. No need to dirty windows here, we'll redraw the whole screen anyway. */
3952 Company::Get(old_owner)->infrastructure.road[rt] -= 2;
3953 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.road[rt] += 2;
3955 SetRoadOwner(tile, rt, new_owner == INVALID_OWNER ? OWNER_NONE : new_owner);
3960 if (!IsTileOwner(tile, old_owner)) return;
3962 if (new_owner != INVALID_OWNER) {
3963 /* Update company infrastructure counts. Only do it here
3964 * if the new owner is valid as otherwise the clear
3965 * command will do it for us. No need to dirty windows
3966 * here, we'll redraw the whole screen anyway.*/
3967 Company *old_company = Company::Get(old_owner);
3968 Company *new_company = Company::Get(new_owner);
3970 /* Update counts for underlying infrastructure. */
3971 switch (GetStationType(tile)) {
3972 case STATION_RAIL:
3973 case STATION_WAYPOINT:
3974 if (!IsStationTileBlocked(tile)) {
3975 old_company->infrastructure.rail[GetRailType(tile)]--;
3976 new_company->infrastructure.rail[GetRailType(tile)]++;
3978 break;
3980 case STATION_BUS:
3981 case STATION_TRUCK:
3982 /* Road stops were already handled above. */
3983 break;
3985 case STATION_BUOY:
3986 case STATION_DOCK:
3987 if (GetWaterClass(tile) == WATER_CLASS_CANAL) {
3988 old_company->infrastructure.water--;
3989 new_company->infrastructure.water++;
3991 break;
3993 default:
3994 break;
3997 /* Update station tile count. */
3998 if (!IsBuoy(tile) && !IsAirport(tile)) {
3999 old_company->infrastructure.station--;
4000 new_company->infrastructure.station++;
4003 /* for buoys, owner of tile is owner of water, st->owner == OWNER_NONE */
4004 SetTileOwner(tile, new_owner);
4005 InvalidateWindowClassesData(WC_STATION_LIST, 0);
4006 } else {
4007 if (IsDriveThroughStopTile(tile)) {
4008 /* Remove the drive-through road stop */
4009 DoCommand(tile, 1 | 1 << 8, (GetStationType(tile) == STATION_TRUCK) ? ROADSTOP_TRUCK : ROADSTOP_BUS, DC_EXEC | DC_BANKRUPT, CMD_REMOVE_ROAD_STOP);
4010 assert(IsTileType(tile, MP_ROAD));
4011 /* Change owner of tile and all roadtypes */
4012 ChangeTileOwner(tile, old_owner, new_owner);
4013 } else {
4014 DoCommand(tile, 0, 0, DC_EXEC | DC_BANKRUPT, CMD_LANDSCAPE_CLEAR);
4015 /* Set tile owner of water under (now removed) buoy and dock to OWNER_NONE.
4016 * Update owner of buoy if it was not removed (was in orders).
4017 * Do not update when owned by OWNER_WATER (sea and rivers). */
4018 if ((IsTileType(tile, MP_WATER) || IsBuoyTile(tile)) && IsTileOwner(tile, old_owner)) SetTileOwner(tile, OWNER_NONE);
4024 * Check if a drive-through road stop tile can be cleared.
4025 * Road stops built on town-owned roads check the conditions
4026 * that would allow clearing of the original road.
4027 * @param tile road stop tile to check
4028 * @param flags command flags
4029 * @return true if the road can be cleared
4031 static bool CanRemoveRoadWithStop(TileIndex tile, DoCommandFlag flags)
4033 /* Yeah... water can always remove stops, right? */
4034 if (_current_company == OWNER_WATER) return true;
4036 RoadTypes rts = GetRoadTypes(tile);
4037 if (HasBit(rts, ROADTYPE_TRAM)) {
4038 Owner tram_owner = GetRoadOwner(tile, ROADTYPE_TRAM);
4039 if (tram_owner != OWNER_NONE && CheckOwnership(tram_owner).Failed()) return false;
4041 if (HasBit(rts, ROADTYPE_ROAD)) {
4042 Owner road_owner = GetRoadOwner(tile, ROADTYPE_ROAD);
4043 if (road_owner != OWNER_TOWN) {
4044 if (road_owner != OWNER_NONE && CheckOwnership(road_owner).Failed()) return false;
4045 } else {
4046 if (CheckAllowRemoveRoad(tile, GetAnyRoadBits(tile, ROADTYPE_ROAD), OWNER_TOWN, ROADTYPE_ROAD, flags).Failed()) return false;
4050 return true;
4054 * Clear a single tile of a station.
4055 * @param tile The tile to clear.
4056 * @param flags The DoCommand flags related to the "command".
4057 * @return The cost, or error of clearing.
4059 CommandCost ClearTile_Station(TileIndex tile, DoCommandFlag flags)
4061 if (flags & DC_AUTO) {
4062 switch (GetStationType(tile)) {
4063 default: break;
4064 case STATION_RAIL: return_cmd_error(STR_ERROR_MUST_DEMOLISH_RAILROAD);
4065 case STATION_WAYPOINT: return_cmd_error(STR_ERROR_BUILDING_MUST_BE_DEMOLISHED);
4066 case STATION_AIRPORT: return_cmd_error(STR_ERROR_MUST_DEMOLISH_AIRPORT_FIRST);
4067 case STATION_TRUCK: return_cmd_error(HasTileRoadType(tile, ROADTYPE_TRAM) ? STR_ERROR_MUST_DEMOLISH_CARGO_TRAM_STATION_FIRST : STR_ERROR_MUST_DEMOLISH_TRUCK_STATION_FIRST);
4068 case STATION_BUS: return_cmd_error(HasTileRoadType(tile, ROADTYPE_TRAM) ? STR_ERROR_MUST_DEMOLISH_PASSENGER_TRAM_STATION_FIRST : STR_ERROR_MUST_DEMOLISH_BUS_STATION_FIRST);
4069 case STATION_BUOY: return_cmd_error(STR_ERROR_BUOY_IN_THE_WAY);
4070 case STATION_DOCK: return_cmd_error(STR_ERROR_MUST_DEMOLISH_DOCK_FIRST);
4071 case STATION_OILRIG:
4072 SetDParam(1, STR_INDUSTRY_NAME_OIL_RIG);
4073 return_cmd_error(STR_ERROR_GENERIC_OBJECT_IN_THE_WAY);
4077 switch (GetStationType(tile)) {
4078 case STATION_RAIL: return RemoveRailStation(tile, flags);
4079 case STATION_WAYPOINT: return RemoveRailWaypoint(tile, flags);
4080 case STATION_AIRPORT: return RemoveAirport(tile, flags);
4081 case STATION_TRUCK:
4082 if (IsDriveThroughStopTile(tile) && !CanRemoveRoadWithStop(tile, flags)) {
4083 return_cmd_error(STR_ERROR_MUST_DEMOLISH_TRUCK_STATION_FIRST);
4085 return RemoveRoadStop(tile, flags);
4086 case STATION_BUS:
4087 if (IsDriveThroughStopTile(tile) && !CanRemoveRoadWithStop(tile, flags)) {
4088 return_cmd_error(STR_ERROR_MUST_DEMOLISH_BUS_STATION_FIRST);
4090 return RemoveRoadStop(tile, flags);
4091 case STATION_BUOY: return RemoveBuoy(tile, flags);
4092 case STATION_DOCK: return RemoveDock(tile, flags);
4093 default: break;
4096 return CMD_ERROR;
4099 static CommandCost TerraformTile_Station(TileIndex tile, DoCommandFlag flags, int z_new, Slope tileh_new)
4101 if (_settings_game.construction.build_on_slopes && AutoslopeEnabled()) {
4102 /* TODO: If you implement newgrf callback 149 'land slope check', you have to decide what to do with it here.
4103 * TTDP does not call it.
4105 if (GetTileMaxZ(tile) == z_new + GetSlopeMaxZ(tileh_new)) {
4106 switch (GetStationType(tile)) {
4107 case STATION_WAYPOINT:
4108 case STATION_RAIL: {
4109 DiagDirection direction = AxisToDiagDir(GetRailStationAxis(tile));
4110 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, direction)) break;
4111 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, ReverseDiagDir(direction))) break;
4112 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4115 case STATION_AIRPORT:
4116 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4118 case STATION_TRUCK:
4119 case STATION_BUS: {
4120 DiagDirection direction = GetRoadStopDir(tile);
4121 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, direction)) break;
4122 if (IsDriveThroughStopTile(tile)) {
4123 if (!AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, ReverseDiagDir(direction))) break;
4125 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
4128 default: break;
4132 return DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
4136 * Get flow for a station.
4137 * @param st Station to get flow for.
4138 * @return Flow for st.
4140 uint FlowStat::GetShare(StationID st) const
4142 uint32 prev = 0;
4143 for (SharesMap::const_iterator it = this->shares.begin(); it != this->shares.end(); ++it) {
4144 if (it->second == st) {
4145 return it->first - prev;
4146 } else {
4147 prev = it->first;
4150 return 0;
4154 * Get a station a package can be routed to, but exclude the given ones.
4155 * @param excluded StationID not to be selected.
4156 * @param excluded2 Another StationID not to be selected.
4157 * @return A station ID from the shares map.
4159 StationID FlowStat::GetVia(StationID excluded, StationID excluded2) const
4161 if (this->unrestricted == 0) return INVALID_STATION;
4162 assert(!this->shares.empty());
4163 SharesMap::const_iterator it = this->shares.upper_bound(RandomRange(this->unrestricted));
4164 assert(it != this->shares.end() && it->first <= this->unrestricted);
4165 if (it->second != excluded && it->second != excluded2) return it->second;
4167 /* We've hit one of the excluded stations.
4168 * Draw another share, from outside its range. */
4170 uint end = it->first;
4171 uint begin = (it == this->shares.begin() ? 0 : (--it)->first);
4172 uint interval = end - begin;
4173 if (interval >= this->unrestricted) return INVALID_STATION; // Only one station in the map.
4174 uint new_max = this->unrestricted - interval;
4175 uint rand = RandomRange(new_max);
4176 SharesMap::const_iterator it2 = (rand < begin) ? this->shares.upper_bound(rand) :
4177 this->shares.upper_bound(rand + interval);
4178 assert(it2 != this->shares.end() && it2->first <= this->unrestricted);
4179 if (it2->second != excluded && it2->second != excluded2) return it2->second;
4181 /* We've hit the second excluded station.
4182 * Same as before, only a bit more complicated. */
4184 uint end2 = it2->first;
4185 uint begin2 = (it2 == this->shares.begin() ? 0 : (--it2)->first);
4186 uint interval2 = end2 - begin2;
4187 if (interval2 >= new_max) return INVALID_STATION; // Only the two excluded stations in the map.
4188 new_max -= interval2;
4189 if (begin > begin2) {
4190 Swap(begin, begin2);
4191 Swap(end, end2);
4192 Swap(interval, interval2);
4194 rand = RandomRange(new_max);
4195 SharesMap::const_iterator it3 = this->shares.upper_bound(this->unrestricted);
4196 if (rand < begin) {
4197 it3 = this->shares.upper_bound(rand);
4198 } else if (rand < begin2 - interval) {
4199 it3 = this->shares.upper_bound(rand + interval);
4200 } else {
4201 it3 = this->shares.upper_bound(rand + interval + interval2);
4203 assert(it3 != this->shares.end() && it3->first <= this->unrestricted);
4204 return it3->second;
4208 * Reduce all flows to minimum capacity so that they don't get in the way of
4209 * link usage statistics too much. Keep them around, though, to continue
4210 * routing any remaining cargo.
4212 void FlowStat::Invalidate()
4214 assert(!this->shares.empty());
4215 SharesMap new_shares;
4216 uint i = 0;
4217 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
4218 new_shares[++i] = it->second;
4219 if (it->first == this->unrestricted) this->unrestricted = i;
4221 this->shares.swap(new_shares);
4222 assert(!this->shares.empty() && this->unrestricted <= (--this->shares.end())->first);
4226 * Change share for specified station. By specifing INT_MIN as parameter you
4227 * can erase a share. Newly added flows will be unrestricted.
4228 * @param st Next Hop to be removed.
4229 * @param flow Share to be added or removed.
4231 void FlowStat::ChangeShare(StationID st, int flow)
4233 /* We assert only before changing as afterwards the shares can actually
4234 * be empty. In that case the whole flow stat must be deleted then. */
4235 assert(!this->shares.empty());
4237 uint removed_shares = 0;
4238 uint added_shares = 0;
4239 uint last_share = 0;
4240 SharesMap new_shares;
4241 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
4242 if (it->second == st) {
4243 if (flow < 0) {
4244 uint share = it->first - last_share;
4245 if (flow == INT_MIN || (uint)(-flow) >= share) {
4246 removed_shares += share;
4247 if (it->first <= this->unrestricted) this->unrestricted -= share;
4248 if (flow != INT_MIN) flow += share;
4249 last_share = it->first;
4250 continue; // remove the whole share
4252 removed_shares += (uint)(-flow);
4253 } else {
4254 added_shares += (uint)(flow);
4256 if (it->first <= this->unrestricted) this->unrestricted += flow;
4258 /* If we don't continue above the whole flow has been added or
4259 * removed. */
4260 flow = 0;
4262 new_shares[it->first + added_shares - removed_shares] = it->second;
4263 last_share = it->first;
4265 if (flow > 0) {
4266 new_shares[last_share + (uint)flow] = st;
4267 if (this->unrestricted < last_share) {
4268 this->ReleaseShare(st);
4269 } else {
4270 this->unrestricted += flow;
4273 this->shares.swap(new_shares);
4277 * Restrict a flow by moving it to the end of the map and decreasing the amount
4278 * of unrestricted flow.
4279 * @param st Station of flow to be restricted.
4281 void FlowStat::RestrictShare(StationID st)
4283 assert(!this->shares.empty());
4284 uint flow = 0;
4285 uint last_share = 0;
4286 SharesMap new_shares;
4287 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
4288 if (flow == 0) {
4289 if (it->first > this->unrestricted) return; // Not present or already restricted.
4290 if (it->second == st) {
4291 flow = it->first - last_share;
4292 this->unrestricted -= flow;
4293 } else {
4294 new_shares[it->first] = it->second;
4296 } else {
4297 new_shares[it->first - flow] = it->second;
4299 last_share = it->first;
4301 if (flow == 0) return;
4302 new_shares[last_share + flow] = st;
4303 this->shares.swap(new_shares);
4304 assert(!this->shares.empty());
4308 * Release ("unrestrict") a flow by moving it to the begin of the map and
4309 * increasing the amount of unrestricted flow.
4310 * @param st Station of flow to be released.
4312 void FlowStat::ReleaseShare(StationID st)
4314 assert(!this->shares.empty());
4315 uint flow = 0;
4316 uint next_share = 0;
4317 bool found = false;
4318 for (SharesMap::reverse_iterator it(this->shares.rbegin()); it != this->shares.rend(); ++it) {
4319 if (it->first < this->unrestricted) return; // Note: not <= as the share may hit the limit.
4320 if (found) {
4321 flow = next_share - it->first;
4322 this->unrestricted += flow;
4323 break;
4324 } else {
4325 if (it->first == this->unrestricted) return; // !found -> Limit not hit.
4326 if (it->second == st) found = true;
4328 next_share = it->first;
4330 if (flow == 0) return;
4331 SharesMap new_shares;
4332 new_shares[flow] = st;
4333 for (SharesMap::iterator it(this->shares.begin()); it != this->shares.end(); ++it) {
4334 if (it->second != st) {
4335 new_shares[flow + it->first] = it->second;
4336 } else {
4337 flow = 0;
4340 this->shares.swap(new_shares);
4341 assert(!this->shares.empty());
4345 * Scale all shares from link graph's runtime to monthly values.
4346 * @param runtime Time the link graph has been running without compression.
4347 * @pre runtime must be greater than 0 as we don't want infinite flow values.
4349 void FlowStat::ScaleToMonthly(uint runtime)
4351 assert(runtime > 0);
4352 SharesMap new_shares;
4353 uint share = 0;
4354 for (SharesMap::iterator i = this->shares.begin(); i != this->shares.end(); ++i) {
4355 share = max(share + 1, i->first * 30 / runtime);
4356 new_shares[share] = i->second;
4357 if (this->unrestricted == i->first) this->unrestricted = share;
4359 this->shares.swap(new_shares);
4363 * Add some flow from "origin", going via "via".
4364 * @param origin Origin of the flow.
4365 * @param via Next hop.
4366 * @param flow Amount of flow to be added.
4368 void FlowStatMap::AddFlow(StationID origin, StationID via, uint flow)
4370 FlowStatMap::iterator origin_it = this->find(origin);
4371 if (origin_it == this->end()) {
4372 this->insert(std::make_pair(origin, FlowStat(via, flow)));
4373 } else {
4374 origin_it->second.ChangeShare(via, flow);
4375 assert(!origin_it->second.GetShares()->empty());
4380 * Pass on some flow, remembering it as invalid, for later subtraction from
4381 * locally consumed flow. This is necessary because we can't have negative
4382 * flows and we don't want to sort the flows before adding them up.
4383 * @param origin Origin of the flow.
4384 * @param via Next hop.
4385 * @param flow Amount of flow to be passed.
4387 void FlowStatMap::PassOnFlow(StationID origin, StationID via, uint flow)
4389 FlowStatMap::iterator prev_it = this->find(origin);
4390 if (prev_it == this->end()) {
4391 FlowStat fs(via, flow);
4392 fs.AppendShare(INVALID_STATION, flow);
4393 this->insert(std::make_pair(origin, fs));
4394 } else {
4395 prev_it->second.ChangeShare(via, flow);
4396 prev_it->second.ChangeShare(INVALID_STATION, flow);
4397 assert(!prev_it->second.GetShares()->empty());
4402 * Subtract invalid flows from locally consumed flow.
4403 * @param self ID of own station.
4405 void FlowStatMap::FinalizeLocalConsumption(StationID self)
4407 for (FlowStatMap::iterator i = this->begin(); i != this->end(); ++i) {
4408 FlowStat &fs = i->second;
4409 uint local = fs.GetShare(INVALID_STATION);
4410 if (local > INT_MAX) { // make sure it fits in an int
4411 fs.ChangeShare(self, -INT_MAX);
4412 fs.ChangeShare(INVALID_STATION, -INT_MAX);
4413 local -= INT_MAX;
4415 fs.ChangeShare(self, -(int)local);
4416 fs.ChangeShare(INVALID_STATION, -(int)local);
4418 /* If the local share is used up there must be a share for some
4419 * remote station. */
4420 assert(!fs.GetShares()->empty());
4425 * Delete all flows at a station for specific cargo and destination.
4426 * @param via Remote station of flows to be deleted.
4427 * @return IDs of source stations for which the complete FlowStat, not only a
4428 * share, has been erased.
4430 StationIDStack FlowStatMap::DeleteFlows(StationID via)
4432 StationIDStack ret;
4433 for (FlowStatMap::iterator f_it = this->begin(); f_it != this->end();) {
4434 FlowStat &s_flows = f_it->second;
4435 s_flows.ChangeShare(via, INT_MIN);
4436 if (s_flows.GetShares()->empty()) {
4437 ret.Push(f_it->first);
4438 this->erase(f_it++);
4439 } else {
4440 ++f_it;
4443 return ret;
4447 * Restrict all flows at a station for specific cargo and destination.
4448 * @param via Remote station of flows to be restricted.
4450 void FlowStatMap::RestrictFlows(StationID via)
4452 for (FlowStatMap::iterator it = this->begin(); it != this->end(); ++it) {
4453 it->second.RestrictShare(via);
4458 * Release all flows at a station for specific cargo and destination.
4459 * @param via Remote station of flows to be released.
4461 void FlowStatMap::ReleaseFlows(StationID via)
4463 for (FlowStatMap::iterator it = this->begin(); it != this->end(); ++it) {
4464 it->second.ReleaseShare(via);
4469 * Get the sum of all flows from this FlowStatMap.
4470 * @return sum of all flows.
4472 uint FlowStatMap::GetFlow() const
4474 uint ret = 0;
4475 for (FlowStatMap::const_iterator i = this->begin(); i != this->end(); ++i) {
4476 ret += (--(i->second.GetShares()->end()))->first;
4478 return ret;
4482 * Get the sum of flows via a specific station from this FlowStatMap.
4483 * @param via Remote station to look for.
4484 * @return all flows for 'via' added up.
4486 uint FlowStatMap::GetFlowVia(StationID via) const
4488 uint ret = 0;
4489 for (FlowStatMap::const_iterator i = this->begin(); i != this->end(); ++i) {
4490 ret += i->second.GetShare(via);
4492 return ret;
4496 * Get the sum of flows from a specific station from this FlowStatMap.
4497 * @param from Origin station to look for.
4498 * @return all flows from 'from' added up.
4500 uint FlowStatMap::GetFlowFrom(StationID from) const
4502 FlowStatMap::const_iterator i = this->find(from);
4503 if (i == this->end()) return 0;
4504 return (--(i->second.GetShares()->end()))->first;
4508 * Get the flow from a specific station via a specific other station.
4509 * @param from Origin station to look for.
4510 * @param via Remote station to look for.
4511 * @return flow share originating at 'from' and going to 'via'.
4513 uint FlowStatMap::GetFlowFromVia(StationID from, StationID via) const
4515 FlowStatMap::const_iterator i = this->find(from);
4516 if (i == this->end()) return 0;
4517 return i->second.GetShare(via);
4520 extern const TileTypeProcs _tile_type_station_procs = {
4521 DrawTile_Station, // draw_tile_proc
4522 GetSlopePixelZ_Station, // get_slope_z_proc
4523 ClearTile_Station, // clear_tile_proc
4524 NULL, // add_accepted_cargo_proc
4525 GetTileDesc_Station, // get_tile_desc_proc
4526 GetTileTrackStatus_Station, // get_tile_track_status_proc
4527 ClickTile_Station, // click_tile_proc
4528 AnimateTile_Station, // animate_tile_proc
4529 TileLoop_Station, // tile_loop_proc
4530 ChangeTileOwner_Station, // change_tile_owner_proc
4531 NULL, // add_produced_cargo_proc
4532 VehicleEnter_Station, // vehicle_enter_tile_proc
4533 GetFoundation_Station, // get_foundation_proc
4534 TerraformTile_Station, // terraform_tile_proc