Codechange: Use unique_ptr instead of raw pointer for string layouts. (#13128)
[openttd-github.git] / src / road_cmd.cpp
blob433715d584eabbba7fd2c48efa4c440716842e0a
1 /*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6 */
8 /** @file road_cmd.cpp Commands related to road tiles. */
10 #include "stdafx.h"
11 #include "road.h"
12 #include "road_internal.h"
13 #include "viewport_func.h"
14 #include "command_func.h"
15 #include "company_func.h"
16 #include "pathfinder/yapf/yapf_cache.h"
17 #include "depot_base.h"
18 #include "newgrf.h"
19 #include "autoslope.h"
20 #include "tunnelbridge_map.h"
21 #include "strings_func.h"
22 #include "vehicle_func.h"
23 #include "sound_func.h"
24 #include "tunnelbridge.h"
25 #include "cheat_type.h"
26 #include "effectvehicle_func.h"
27 #include "effectvehicle_base.h"
28 #include "elrail_func.h"
29 #include "roadveh.h"
30 #include "train.h"
31 #include "town.h"
32 #include "company_base.h"
33 #include "core/random_func.hpp"
34 #include "core/container_func.hpp"
35 #include "newgrf_debug.h"
36 #include "newgrf_railtype.h"
37 #include "newgrf_roadtype.h"
38 #include "timer/timer_game_calendar.h"
39 #include "genworld.h"
40 #include "company_gui.h"
41 #include "road_func.h"
42 #include "road_cmd.h"
43 #include "landscape_cmd.h"
44 #include "rail_cmd.h"
46 #include "table/strings.h"
47 #include "table/roadtypes.h"
49 #include "safeguards.h"
51 /** Helper type for lists/vectors of road vehicles */
52 typedef std::vector<RoadVehicle *> RoadVehicleList;
54 RoadTypeInfo _roadtypes[ROADTYPE_END];
55 std::vector<RoadType> _sorted_roadtypes;
56 RoadTypes _roadtypes_hidden_mask;
58 /**
59 * Bitmap of road/tram types.
60 * Bit if set if a roadtype is tram.
62 RoadTypes _roadtypes_type;
64 /**
65 * Reset all road type information to its default values.
67 void ResetRoadTypes()
69 static_assert(lengthof(_original_roadtypes) <= lengthof(_roadtypes));
71 auto insert = std::copy(std::begin(_original_roadtypes), std::end(_original_roadtypes), std::begin(_roadtypes));
72 std::fill(insert, std::end(_roadtypes), RoadTypeInfo{});
74 _roadtypes_hidden_mask = ROADTYPES_NONE;
75 _roadtypes_type = ROADTYPES_TRAM;
78 void ResolveRoadTypeGUISprites(RoadTypeInfo *rti)
80 SpriteID cursors_base = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_CURSORS);
81 if (cursors_base != 0) {
82 rti->gui_sprites.build_y_road = cursors_base + 0;
83 rti->gui_sprites.build_x_road = cursors_base + 1;
84 rti->gui_sprites.auto_road = cursors_base + 2;
85 rti->gui_sprites.build_depot = cursors_base + 3;
86 rti->gui_sprites.build_tunnel = cursors_base + 4;
87 rti->gui_sprites.convert_road = cursors_base + 5;
88 rti->cursor.road_swne = cursors_base + 6;
89 rti->cursor.road_nwse = cursors_base + 7;
90 rti->cursor.autoroad = cursors_base + 8;
91 rti->cursor.depot = cursors_base + 9;
92 rti->cursor.tunnel = cursors_base + 10;
93 rti->cursor.convert_road = cursors_base + 11;
97 /**
98 * Compare roadtypes based on their sorting order.
99 * @param first The roadtype to compare to.
100 * @param second The roadtype to compare.
101 * @return True iff the first should be sorted before the second.
103 static bool CompareRoadTypes(const RoadType &first, const RoadType &second)
105 if (RoadTypeIsRoad(first) == RoadTypeIsRoad(second)) {
106 return GetRoadTypeInfo(first)->sorting_order < GetRoadTypeInfo(second)->sorting_order;
108 return RoadTypeIsTram(first) < RoadTypeIsTram(second);
112 * Resolve sprites of custom road types
114 void InitRoadTypes()
116 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
117 RoadTypeInfo *rti = &_roadtypes[rt];
118 ResolveRoadTypeGUISprites(rti);
119 if (HasBit(rti->flags, ROTF_HIDDEN)) SetBit(_roadtypes_hidden_mask, rt);
122 _sorted_roadtypes.clear();
123 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
124 if (_roadtypes[rt].label != 0 && !HasBit(_roadtypes_hidden_mask, rt)) {
125 _sorted_roadtypes.push_back(rt);
128 std::sort(_sorted_roadtypes.begin(), _sorted_roadtypes.end(), CompareRoadTypes);
132 * Allocate a new road type label
134 RoadType AllocateRoadType(RoadTypeLabel label, RoadTramType rtt)
136 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
137 RoadTypeInfo *rti = &_roadtypes[rt];
139 if (rti->label == 0) {
140 /* Set up new road type */
141 *rti = _original_roadtypes[(rtt == RTT_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD];
142 rti->label = label;
143 rti->alternate_labels.clear();
144 rti->flags = ROTFB_NONE;
145 rti->introduction_date = CalendarTime::INVALID_DATE;
147 /* Make us compatible with ourself. */
148 rti->powered_roadtypes = (RoadTypes)(1ULL << rt);
150 /* We also introduce ourself. */
151 rti->introduces_roadtypes = (RoadTypes)(1ULL << rt);
153 /* Default sort order; order of allocation, but with some
154 * offsets so it's easier for NewGRF to pick a spot without
155 * changing the order of other (original) road types.
156 * The << is so you can place other roadtypes in between the
157 * other roadtypes, the 7 is to be able to place something
158 * before the first (default) road type. */
159 rti->sorting_order = rt << 2 | 7;
161 /* Set bitmap of road/tram types */
162 if (rtt == RTT_TRAM) {
163 SetBit(_roadtypes_type, rt);
164 } else {
165 ClrBit(_roadtypes_type, rt);
168 return rt;
172 return INVALID_ROADTYPE;
176 * Verify whether a road vehicle is available.
177 * @return \c true if at least one road vehicle is available, \c false if not
179 bool RoadVehiclesAreBuilt()
181 return !RoadVehicle::Iterate().empty();
185 * Update road infrastructure counts for a company.
186 * @param rt Road type to update count of.
187 * @param o Owner of road piece.
188 * @param count Number of road pieces to adjust.
190 void UpdateCompanyRoadInfrastructure(RoadType rt, Owner o, int count)
192 if (rt == INVALID_ROADTYPE) return;
194 Company *c = Company::GetIfValid(o);
195 if (c == nullptr) return;
197 c->infrastructure.road[rt] += count;
198 DirtyCompanyInfrastructureWindows(c->index);
201 /** Invalid RoadBits on slopes. */
202 static const RoadBits _invalid_tileh_slopes_road[2][15] = {
203 /* The inverse of the mixable RoadBits on a leveled slope */
205 ROAD_NONE, // SLOPE_FLAT
206 ROAD_NE | ROAD_SE, // SLOPE_W
207 ROAD_NE | ROAD_NW, // SLOPE_S
209 ROAD_NE, // SLOPE_SW
210 ROAD_NW | ROAD_SW, // SLOPE_E
211 ROAD_NONE, // SLOPE_EW
213 ROAD_NW, // SLOPE_SE
214 ROAD_NONE, // SLOPE_WSE
215 ROAD_SE | ROAD_SW, // SLOPE_N
217 ROAD_SE, // SLOPE_NW
218 ROAD_NONE, // SLOPE_NS
219 ROAD_NONE, // SLOPE_ENW
221 ROAD_SW, // SLOPE_NE
222 ROAD_NONE, // SLOPE_SEN
223 ROAD_NONE // SLOPE_NWS
225 /* The inverse of the allowed straight roads on a slope
226 * (with and without a foundation). */
228 ROAD_NONE, // SLOPE_FLAT
229 ROAD_NONE, // SLOPE_W Foundation
230 ROAD_NONE, // SLOPE_S Foundation
232 ROAD_Y, // SLOPE_SW
233 ROAD_NONE, // SLOPE_E Foundation
234 ROAD_ALL, // SLOPE_EW
236 ROAD_X, // SLOPE_SE
237 ROAD_ALL, // SLOPE_WSE
238 ROAD_NONE, // SLOPE_N Foundation
240 ROAD_X, // SLOPE_NW
241 ROAD_ALL, // SLOPE_NS
242 ROAD_ALL, // SLOPE_ENW
244 ROAD_Y, // SLOPE_NE
245 ROAD_ALL, // SLOPE_SEN
246 ROAD_ALL // SLOPE_NW
250 static Foundation GetRoadFoundation(Slope tileh, RoadBits bits);
253 * Is it allowed to remove the given road bits from the given tile?
254 * @param tile the tile to remove the road from
255 * @param remove the roadbits that are going to be removed
256 * @param owner the actual owner of the roadbits of the tile
257 * @param rt the road type to remove the bits from
258 * @param flags command flags
259 * @param town_check Shall the town rating checked/affected
260 * @return A succeeded command when it is allowed to remove the road bits, a failed command otherwise.
262 CommandCost CheckAllowRemoveRoad(TileIndex tile, RoadBits remove, Owner owner, RoadTramType rtt, DoCommandFlag flags, bool town_check)
264 if (_game_mode == GM_EDITOR || remove == ROAD_NONE) return CommandCost();
266 /* Water can always flood and towns can always remove "normal" road pieces.
267 * Towns are not be allowed to remove non "normal" road pieces, like tram
268 * tracks as that would result in trams that cannot turn. */
269 if (_current_company == OWNER_WATER ||
270 (rtt == RTT_ROAD && !Company::IsValidID(_current_company))) return CommandCost();
272 /* Only do the special processing if the road is owned
273 * by a town */
274 if (owner != OWNER_TOWN) {
275 if (owner == OWNER_NONE) return CommandCost();
276 CommandCost ret = CheckOwnership(owner);
277 return ret;
280 if (!town_check) return CommandCost();
282 if (_cheats.magic_bulldozer.value) return CommandCost();
284 Town *t = ClosestTownFromTile(tile, UINT_MAX);
285 if (t == nullptr) return CommandCost();
287 /* check if you're allowed to remove the street owned by a town
288 * removal allowance depends on difficulty setting */
289 CommandCost ret = CheckforTownRating(flags, t, ROAD_REMOVE);
290 if (ret.Failed()) return ret;
292 /* Get a bitmask of which neighbouring roads has a tile */
293 RoadBits n = ROAD_NONE;
294 RoadBits present = GetAnyRoadBits(tile, rtt);
295 if ((present & ROAD_NE) && (GetAnyRoadBits(TileAddXY(tile, -1, 0), rtt) & ROAD_SW)) n |= ROAD_NE;
296 if ((present & ROAD_SE) && (GetAnyRoadBits(TileAddXY(tile, 0, 1), rtt) & ROAD_NW)) n |= ROAD_SE;
297 if ((present & ROAD_SW) && (GetAnyRoadBits(TileAddXY(tile, 1, 0), rtt) & ROAD_NE)) n |= ROAD_SW;
298 if ((present & ROAD_NW) && (GetAnyRoadBits(TileAddXY(tile, 0, -1), rtt) & ROAD_SE)) n |= ROAD_NW;
300 int rating_decrease = RATING_ROAD_DOWN_STEP_EDGE;
301 /* If 0 or 1 bits are set in n, or if no bits that match the bits to remove,
302 * then allow it */
303 if (KillFirstBit(n) != ROAD_NONE && (n & remove) != ROAD_NONE) {
304 /* you can remove all kind of roads with extra dynamite */
305 if (!_settings_game.construction.extra_dynamite) {
306 SetDParam(0, t->index);
307 return_cmd_error(STR_ERROR_LOCAL_AUTHORITY_REFUSES_TO_ALLOW_THIS);
309 rating_decrease = RATING_ROAD_DOWN_STEP_INNER;
311 ChangeTownRating(t, rating_decrease, RATING_ROAD_MINIMUM, flags);
313 return CommandCost();
318 * Delete a piece of road.
319 * @param tile tile where to remove road from
320 * @param flags operation to perform
321 * @param pieces roadbits to remove
322 * @param rt roadtype to remove
323 * @param town_check should we check if the town allows removal?
325 static CommandCost RemoveRoad(TileIndex tile, DoCommandFlag flags, RoadBits pieces, RoadTramType rtt, bool town_check)
327 assert(pieces != ROAD_NONE);
329 RoadType existing_rt = MayHaveRoad(tile) ? GetRoadType(tile, rtt) : INVALID_ROADTYPE;
330 /* The tile doesn't have the given road type */
331 if (existing_rt == INVALID_ROADTYPE) return_cmd_error((rtt == RTT_TRAM) ? STR_ERROR_THERE_IS_NO_TRAMWAY : STR_ERROR_THERE_IS_NO_ROAD);
333 switch (GetTileType(tile)) {
334 case MP_ROAD: {
335 CommandCost ret = EnsureNoVehicleOnGround(tile);
336 if (ret.Failed()) return ret;
337 break;
340 case MP_STATION: {
341 if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;
343 CommandCost ret = EnsureNoVehicleOnGround(tile);
344 if (ret.Failed()) return ret;
345 break;
348 case MP_TUNNELBRIDGE: {
349 if (GetTunnelBridgeTransportType(tile) != TRANSPORT_ROAD) return CMD_ERROR;
350 CommandCost ret = TunnelBridgeIsFree(tile, GetOtherTunnelBridgeEnd(tile));
351 if (ret.Failed()) return ret;
352 break;
355 default:
356 return CMD_ERROR;
359 CommandCost ret = CheckAllowRemoveRoad(tile, pieces, GetRoadOwner(tile, rtt), rtt, flags, town_check);
360 if (ret.Failed()) return ret;
362 if (!IsTileType(tile, MP_ROAD)) {
363 /* If it's the last roadtype, just clear the whole tile */
364 if (GetRoadType(tile, OtherRoadTramType(rtt)) == INVALID_ROADTYPE) return Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
366 CommandCost cost(EXPENSES_CONSTRUCTION);
367 if (IsTileType(tile, MP_TUNNELBRIDGE)) {
368 /* Removing any roadbit in the bridge axis removes the roadtype (that's the behaviour remove-long-roads needs) */
369 if ((AxisToRoadBits(DiagDirToAxis(GetTunnelBridgeDirection(tile))) & pieces) == ROAD_NONE) return_cmd_error((rtt == RTT_TRAM) ? STR_ERROR_THERE_IS_NO_TRAMWAY : STR_ERROR_THERE_IS_NO_ROAD);
371 TileIndex other_end = GetOtherTunnelBridgeEnd(tile);
372 /* Pay for *every* tile of the bridge or tunnel */
373 uint len = GetTunnelBridgeLength(other_end, tile) + 2;
374 cost.AddCost(len * 2 * RoadClearCost(existing_rt));
375 if (flags & DC_EXEC) {
376 /* A full diagonal road tile has two road bits. */
377 UpdateCompanyRoadInfrastructure(existing_rt, GetRoadOwner(tile, rtt), -(int)(len * 2 * TUNNELBRIDGE_TRACKBIT_FACTOR));
379 SetRoadType(other_end, rtt, INVALID_ROADTYPE);
380 SetRoadType(tile, rtt, INVALID_ROADTYPE);
382 /* If the owner of the bridge sells all its road, also move the ownership
383 * to the owner of the other roadtype, unless the bridge owner is a town. */
384 Owner other_owner = GetRoadOwner(tile, OtherRoadTramType(rtt));
385 if (!IsTileOwner(tile, other_owner) && !IsTileOwner(tile, OWNER_TOWN)) {
386 SetTileOwner(tile, other_owner);
387 SetTileOwner(other_end, other_owner);
390 /* Mark tiles dirty that have been repaved */
391 if (IsBridge(tile)) {
392 MarkBridgeDirty(tile);
393 } else {
394 MarkTileDirtyByTile(tile);
395 MarkTileDirtyByTile(other_end);
398 } else {
399 assert(IsDriveThroughStopTile(tile));
400 cost.AddCost(RoadClearCost(existing_rt) * 2);
401 if (flags & DC_EXEC) {
402 /* A full diagonal road tile has two road bits. */
403 UpdateCompanyRoadInfrastructure(existing_rt, GetRoadOwner(tile, rtt), -2);
404 SetRoadType(tile, rtt, INVALID_ROADTYPE);
405 MarkTileDirtyByTile(tile);
408 return cost;
411 switch (GetRoadTileType(tile)) {
412 case ROAD_TILE_NORMAL: {
413 Slope tileh = GetTileSlope(tile);
415 /* Steep slopes behave the same as slopes with one corner raised. */
416 if (IsSteepSlope(tileh)) {
417 tileh = SlopeWithOneCornerRaised(GetHighestSlopeCorner(tileh));
420 RoadBits present = GetRoadBits(tile, rtt);
421 const RoadBits other = GetRoadBits(tile, OtherRoadTramType(rtt));
422 const Foundation f = GetRoadFoundation(tileh, present);
424 if (HasRoadWorks(tile) && _current_company != OWNER_WATER) return_cmd_error(STR_ERROR_ROAD_WORKS_IN_PROGRESS);
426 /* Autocomplete to a straight road
427 * @li if the bits of the other roadtypes result in another foundation
428 * @li if build on slopes is disabled */
429 if ((IsStraightRoad(other) && (other & _invalid_tileh_slopes_road[0][tileh & SLOPE_ELEVATED]) != ROAD_NONE) ||
430 (tileh != SLOPE_FLAT && !_settings_game.construction.build_on_slopes)) {
431 pieces |= MirrorRoadBits(pieces);
434 /* limit the bits to delete to the existing bits. */
435 pieces &= present;
436 if (pieces == ROAD_NONE) return_cmd_error((rtt == RTT_TRAM) ? STR_ERROR_THERE_IS_NO_TRAMWAY : STR_ERROR_THERE_IS_NO_ROAD);
438 /* Now set present what it will be after the remove */
439 present ^= pieces;
441 /* Check for invalid RoadBit combinations on slopes */
442 if (tileh != SLOPE_FLAT && present != ROAD_NONE &&
443 (present & _invalid_tileh_slopes_road[0][tileh & SLOPE_ELEVATED]) == present) {
444 return CMD_ERROR;
447 if (flags & DC_EXEC) {
448 if (HasRoadWorks(tile)) {
449 /* flooding tile with road works, don't forget to remove the effect vehicle too */
450 assert(_current_company == OWNER_WATER);
451 for (EffectVehicle *v : EffectVehicle::Iterate()) {
452 if (TileVirtXY(v->x_pos, v->y_pos) == tile) {
453 delete v;
458 UpdateCompanyRoadInfrastructure(existing_rt, GetRoadOwner(tile, rtt), -(int)CountBits(pieces));
460 if (present == ROAD_NONE) {
461 /* No other road type, just clear tile. */
462 if (GetRoadType(tile, OtherRoadTramType(rtt)) == INVALID_ROADTYPE) {
463 /* Includes MarkTileDirtyByTile() */
464 DoClearSquare(tile);
465 } else {
466 if (rtt == RTT_ROAD && IsRoadOwner(tile, rtt, OWNER_TOWN)) {
467 /* Update nearest-town index */
468 const Town *town = CalcClosestTownFromTile(tile);
469 SetTownIndex(tile, town == nullptr ? INVALID_TOWN : town->index);
471 if (rtt == RTT_ROAD) SetDisallowedRoadDirections(tile, DRD_NONE);
472 SetRoadBits(tile, ROAD_NONE, rtt);
473 SetRoadType(tile, rtt, INVALID_ROADTYPE);
474 MarkTileDirtyByTile(tile);
476 } else {
477 /* When bits are removed, you *always* end up with something that
478 * is not a complete straight road tile. However, trams do not have
479 * onewayness, so they cannot remove it either. */
480 if (rtt == RTT_ROAD) SetDisallowedRoadDirections(tile, DRD_NONE);
481 SetRoadBits(tile, present, rtt);
482 MarkTileDirtyByTile(tile);
486 CommandCost cost(EXPENSES_CONSTRUCTION, CountBits(pieces) * RoadClearCost(existing_rt));
487 /* If we build a foundation we have to pay for it. */
488 if (f == FOUNDATION_NONE && GetRoadFoundation(tileh, present) != FOUNDATION_NONE) cost.AddCost(_price[PR_BUILD_FOUNDATION]);
490 return cost;
493 case ROAD_TILE_CROSSING: {
494 if (pieces & ComplementRoadBits(GetCrossingRoadBits(tile))) {
495 return CMD_ERROR;
498 if (flags & DC_EXEC) {
499 UpdateAdjacentLevelCrossingTilesOnLevelCrossingRemoval(tile, GetCrossingRoadAxis(tile));
501 /* A full diagonal road tile has two road bits. */
502 UpdateCompanyRoadInfrastructure(existing_rt, GetRoadOwner(tile, rtt), -2);
504 Track railtrack = GetCrossingRailTrack(tile);
505 if (GetRoadType(tile, OtherRoadTramType(rtt)) == INVALID_ROADTYPE) {
506 TrackBits tracks = GetCrossingRailBits(tile);
507 bool reserved = HasCrossingReservation(tile);
508 MakeRailNormal(tile, GetTileOwner(tile), tracks, GetRailType(tile));
509 if (reserved) SetTrackReservation(tile, tracks);
511 /* Update rail count for level crossings. The plain track should still be accounted
512 * for, so only subtract the difference to the level crossing cost. */
513 Company *c = Company::GetIfValid(GetTileOwner(tile));
514 if (c != nullptr) {
515 c->infrastructure.rail[GetRailType(tile)] -= LEVELCROSSING_TRACKBIT_FACTOR - 1;
516 DirtyCompanyInfrastructureWindows(c->index);
518 } else {
519 SetRoadType(tile, rtt, INVALID_ROADTYPE);
521 MarkTileDirtyByTile(tile);
522 YapfNotifyTrackLayoutChange(tile, railtrack);
524 return CommandCost(EXPENSES_CONSTRUCTION, RoadClearCost(existing_rt) * 2);
527 default:
528 case ROAD_TILE_DEPOT:
529 return CMD_ERROR;
535 * Calculate the costs for roads on slopes
536 * Aside modify the RoadBits to fit on the slopes
538 * @note The RoadBits are modified too!
539 * @param tileh The current slope
540 * @param pieces The RoadBits we want to add
541 * @param existing The existent RoadBits of the current type
542 * @param other The other existent RoadBits
543 * @return The costs for these RoadBits on this slope
545 static CommandCost CheckRoadSlope(Slope tileh, RoadBits *pieces, RoadBits existing, RoadBits other)
547 /* Remove already build pieces */
548 CLRBITS(*pieces, existing);
550 /* If we can't build anything stop here */
551 if (*pieces == ROAD_NONE) return CMD_ERROR;
553 /* All RoadBit combos are valid on flat land */
554 if (tileh == SLOPE_FLAT) return CommandCost();
556 /* Steep slopes behave the same as slopes with one corner raised. */
557 if (IsSteepSlope(tileh)) {
558 tileh = SlopeWithOneCornerRaised(GetHighestSlopeCorner(tileh));
561 /* Save the merge of all bits of the current type */
562 RoadBits type_bits = existing | *pieces;
564 /* Roads on slopes */
565 if (_settings_game.construction.build_on_slopes && (_invalid_tileh_slopes_road[0][tileh] & (other | type_bits)) == ROAD_NONE) {
567 /* If we add leveling we've got to pay for it */
568 if ((other | existing) == ROAD_NONE) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
570 return CommandCost();
573 /* Autocomplete uphill roads */
574 *pieces |= MirrorRoadBits(*pieces);
575 type_bits = existing | *pieces;
577 /* Uphill roads */
578 if (IsStraightRoad(type_bits) && (other == type_bits || other == ROAD_NONE) &&
579 (_invalid_tileh_slopes_road[1][tileh] & (other | type_bits)) == ROAD_NONE) {
581 /* Slopes with foundation ? */
582 if (IsSlopeWithOneCornerRaised(tileh)) {
584 /* Prevent build on slopes if it isn't allowed */
585 if (_settings_game.construction.build_on_slopes) {
587 /* If we add foundation we've got to pay for it */
588 if ((other | existing) == ROAD_NONE) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
590 return CommandCost();
592 } else {
593 if (HasExactlyOneBit(existing) && GetRoadFoundation(tileh, existing) == FOUNDATION_NONE) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
594 return CommandCost();
597 return CMD_ERROR;
601 * Build a piece of road.
602 * @param flags operation to perform
603 * @param tile tile where to build road
604 * @param pieces road pieces to build (RoadBits)
605 * @param rt road type
606 * @param toggle_drd disallowed directions to toggle
607 * @param town_id the town that is building the road (0 if not applicable)
608 * @return the cost of this operation or an error
610 CommandCost CmdBuildRoad(DoCommandFlag flags, TileIndex tile, RoadBits pieces, RoadType rt, DisallowedRoadDirections toggle_drd, TownID town_id)
612 CompanyID company = _current_company;
613 CommandCost cost(EXPENSES_CONSTRUCTION);
615 RoadBits existing = ROAD_NONE;
616 RoadBits other_bits = ROAD_NONE;
618 /* Road pieces are max 4 bitset values (NE, NW, SE, SW) and town can only be non-zero
619 * if a non-company is building the road */
620 if ((Company::IsValidID(company) && town_id != 0) || (company == OWNER_TOWN && !Town::IsValidID(town_id)) || (company == OWNER_DEITY && town_id != 0)) return CMD_ERROR;
621 if (company != OWNER_TOWN) {
622 const Town *town = CalcClosestTownFromTile(tile);
623 town_id = (town != nullptr) ? town->index : INVALID_TOWN;
625 if (company == OWNER_DEITY) {
626 company = OWNER_TOWN;
628 /* If we are not within a town, we are not owned by the town */
629 if (town == nullptr || DistanceSquare(tile, town->xy) > town->cache.squared_town_zone_radius[HZB_TOWN_EDGE]) {
630 company = OWNER_NONE;
635 /* do not allow building 'zero' road bits, code wouldn't handle it */
636 if (pieces == ROAD_NONE || !IsValidRoadBits(pieces) || !IsValidDisallowedRoadDirections(toggle_drd)) return CMD_ERROR;
637 if (!ValParamRoadType(rt)) return CMD_ERROR;
639 Slope tileh = GetTileSlope(tile);
640 RoadTramType rtt = GetRoadTramType(rt);
642 bool need_to_clear = false;
643 switch (GetTileType(tile)) {
644 case MP_ROAD:
645 switch (GetRoadTileType(tile)) {
646 case ROAD_TILE_NORMAL: {
647 if (HasRoadWorks(tile)) return_cmd_error(STR_ERROR_ROAD_WORKS_IN_PROGRESS);
649 other_bits = GetRoadBits(tile, OtherRoadTramType(rtt));
650 if (!HasTileRoadType(tile, rtt)) break;
652 existing = GetRoadBits(tile, rtt);
653 bool crossing = !IsStraightRoad(existing | pieces);
654 if (rtt == RTT_ROAD && (GetDisallowedRoadDirections(tile) != DRD_NONE || toggle_drd != DRD_NONE) && crossing) {
655 /* Junctions cannot be one-way */
656 return_cmd_error(STR_ERROR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);
658 if ((existing & pieces) == pieces) {
659 /* We only want to set the (dis)allowed road directions */
660 if (toggle_drd != DRD_NONE && rtt == RTT_ROAD) {
661 if (crossing) return_cmd_error(STR_ERROR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);
663 Owner owner = GetRoadOwner(tile, rtt);
664 if (owner != OWNER_NONE) {
665 CommandCost ret = CheckOwnership(owner, tile);
666 if (ret.Failed()) return ret;
669 DisallowedRoadDirections dis_existing = GetDisallowedRoadDirections(tile);
670 DisallowedRoadDirections dis_new = dis_existing ^ toggle_drd;
672 /* We allow removing disallowed directions to break up
673 * deadlocks, but adding them can break articulated
674 * vehicles. As such, only when less is disallowed,
675 * i.e. bits are removed, we skip the vehicle check. */
676 if (CountBits(dis_existing) <= CountBits(dis_new)) {
677 CommandCost ret = EnsureNoVehicleOnGround(tile);
678 if (ret.Failed()) return ret;
681 /* Ignore half built tiles */
682 if ((flags & DC_EXEC) && IsStraightRoad(existing)) {
683 SetDisallowedRoadDirections(tile, dis_new);
684 MarkTileDirtyByTile(tile);
686 return CommandCost();
688 return_cmd_error(STR_ERROR_ALREADY_BUILT);
690 /* Disallow breaking end-of-line of someone else
691 * so trams can still reverse on this tile. */
692 if (rtt == RTT_TRAM && HasExactlyOneBit(existing)) {
693 Owner owner = GetRoadOwner(tile, rtt);
694 if (Company::IsValidID(owner)) {
695 CommandCost ret = CheckOwnership(owner);
696 if (ret.Failed()) return ret;
699 break;
702 case ROAD_TILE_CROSSING:
703 if (RoadNoLevelCrossing(rt)) {
704 return_cmd_error(STR_ERROR_CROSSING_DISALLOWED_ROAD);
707 other_bits = GetCrossingRoadBits(tile);
708 if (pieces & ComplementRoadBits(other_bits)) goto do_clear;
709 pieces = other_bits; // we need to pay for both roadbits
711 if (HasTileRoadType(tile, rtt)) return_cmd_error(STR_ERROR_ALREADY_BUILT);
712 break;
714 case ROAD_TILE_DEPOT:
715 if ((GetAnyRoadBits(tile, rtt) & pieces) == pieces) return_cmd_error(STR_ERROR_ALREADY_BUILT);
716 goto do_clear;
718 default: NOT_REACHED();
720 break;
722 case MP_RAILWAY: {
723 if (IsSteepSlope(tileh)) {
724 return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
727 /* Level crossings may only be built on these slopes */
728 if (!HasBit(VALID_LEVEL_CROSSING_SLOPES, tileh)) {
729 return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
732 if (!_settings_game.construction.crossing_with_competitor && company != OWNER_TOWN && company != OWNER_DEITY) {
733 CommandCost ret = CheckTileOwnership(tile);
734 if (ret.Failed()) return ret;
737 if (GetRailTileType(tile) != RAIL_TILE_NORMAL) goto do_clear;
739 if (RoadNoLevelCrossing(rt)) {
740 return_cmd_error(STR_ERROR_CROSSING_DISALLOWED_ROAD);
743 if (RailNoLevelCrossings(GetRailType(tile))) {
744 return_cmd_error(STR_ERROR_CROSSING_DISALLOWED_RAIL);
747 Axis roaddir;
748 switch (GetTrackBits(tile)) {
749 case TRACK_BIT_X:
750 if (pieces & ROAD_X) goto do_clear;
751 roaddir = AXIS_Y;
752 break;
754 case TRACK_BIT_Y:
755 if (pieces & ROAD_Y) goto do_clear;
756 roaddir = AXIS_X;
757 break;
759 default: goto do_clear;
762 CommandCost ret = EnsureNoVehicleOnGround(tile);
763 if (ret.Failed()) return ret;
765 if (flags & DC_EXEC) {
766 Track railtrack = AxisToTrack(OtherAxis(roaddir));
767 YapfNotifyTrackLayoutChange(tile, railtrack);
768 /* Update company infrastructure counts. A level crossing has two road bits. */
769 UpdateCompanyRoadInfrastructure(rt, company, 2);
771 /* Update rail count for level crossings. The plain track is already
772 * counted, so only add the difference to the level crossing cost. */
773 Company *c = Company::GetIfValid(GetTileOwner(tile));
774 if (c != nullptr) {
775 c->infrastructure.rail[GetRailType(tile)] += LEVELCROSSING_TRACKBIT_FACTOR - 1;
776 DirtyCompanyInfrastructureWindows(c->index);
779 /* Always add road to the roadtypes (can't draw without it) */
780 bool reserved = HasBit(GetRailReservationTrackBits(tile), railtrack);
781 MakeRoadCrossing(tile, company, company, GetTileOwner(tile), roaddir, GetRailType(tile), rtt == RTT_ROAD ? rt : INVALID_ROADTYPE, (rtt == RTT_TRAM) ? rt : INVALID_ROADTYPE, town_id);
782 SetCrossingReservation(tile, reserved);
783 UpdateLevelCrossing(tile, false);
784 MarkDirtyAdjacentLevelCrossingTiles(tile, GetCrossingRoadAxis(tile));
785 MarkTileDirtyByTile(tile);
787 return CommandCost(EXPENSES_CONSTRUCTION, 2 * RoadBuildCost(rt));
790 case MP_STATION: {
791 if ((GetAnyRoadBits(tile, rtt) & pieces) == pieces) return_cmd_error(STR_ERROR_ALREADY_BUILT);
792 if (!IsDriveThroughStopTile(tile)) goto do_clear;
794 RoadBits curbits = AxisToRoadBits(GetDriveThroughStopAxis(tile));
795 if (pieces & ~curbits) goto do_clear;
796 pieces = curbits; // we need to pay for both roadbits
798 if (HasTileRoadType(tile, rtt)) return_cmd_error(STR_ERROR_ALREADY_BUILT);
799 break;
802 case MP_TUNNELBRIDGE: {
803 if (GetTunnelBridgeTransportType(tile) != TRANSPORT_ROAD) goto do_clear;
804 /* Only allow building the outern roadbit, so building long roads stops at existing bridges */
805 if (MirrorRoadBits(DiagDirToRoadBits(GetTunnelBridgeDirection(tile))) != pieces) goto do_clear;
806 if (HasTileRoadType(tile, rtt)) return_cmd_error(STR_ERROR_ALREADY_BUILT);
807 /* Don't allow adding roadtype to the bridge/tunnel when vehicles are already driving on it */
808 CommandCost ret = TunnelBridgeIsFree(tile, GetOtherTunnelBridgeEnd(tile));
809 if (ret.Failed()) return ret;
810 break;
813 default: {
814 do_clear:;
815 need_to_clear = true;
816 break;
820 if (need_to_clear) {
821 CommandCost ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
822 if (ret.Failed()) return ret;
823 cost.AddCost(ret);
826 if (other_bits != pieces) {
827 /* Check the foundation/slopes when adding road/tram bits */
828 CommandCost ret = CheckRoadSlope(tileh, &pieces, existing, other_bits);
829 /* Return an error if we need to build a foundation (ret != 0) but the
830 * current setting is turned off */
831 if (ret.Failed() || (ret.GetCost() != 0 && !_settings_game.construction.build_on_slopes)) {
832 return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
834 cost.AddCost(ret);
837 if (!need_to_clear) {
838 if (IsTileType(tile, MP_ROAD)) {
839 /* Don't put the pieces that already exist */
840 pieces &= ComplementRoadBits(existing);
842 /* Check if new road bits will have the same foundation as other existing road types */
843 if (IsNormalRoad(tile)) {
844 Slope slope = GetTileSlope(tile);
845 Foundation found_new = GetRoadFoundation(slope, pieces | existing);
847 RoadBits bits = GetRoadBits(tile, OtherRoadTramType(rtt));
848 /* do not check if there are not road bits of given type */
849 if (bits != ROAD_NONE && GetRoadFoundation(slope, bits) != found_new) {
850 return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
855 CommandCost ret = EnsureNoVehicleOnGround(tile);
856 if (ret.Failed()) return ret;
858 if (IsNormalRoadTile(tile)) {
859 /* If the road types don't match, try to convert only if vehicles of
860 * the new road type are not powered on the present road type and vehicles of
861 * the present road type are powered on the new road type. */
862 RoadType existing_rt = GetRoadType(tile, rtt);
863 if (existing_rt != INVALID_ROADTYPE && existing_rt != rt) {
864 if (HasPowerOnRoad(rt, existing_rt)) {
865 rt = existing_rt;
866 } else if (HasPowerOnRoad(existing_rt, rt)) {
867 ret = Command<CMD_CONVERT_ROAD>::Do(flags, tile, tile, rt);
868 if (ret.Failed()) return ret;
869 cost.AddCost(ret);
870 } else {
871 return CMD_ERROR;
877 uint num_pieces = (!need_to_clear && IsTileType(tile, MP_TUNNELBRIDGE)) ?
878 /* There are 2 pieces on *every* tile of the bridge or tunnel */
879 2 * (GetTunnelBridgeLength(GetOtherTunnelBridgeEnd(tile), tile) + 2) :
880 /* Count pieces */
881 CountBits(pieces);
883 cost.AddCost(num_pieces * RoadBuildCost(rt));
885 if (flags & DC_EXEC) {
886 switch (GetTileType(tile)) {
887 case MP_ROAD: {
888 RoadTileType rttype = GetRoadTileType(tile);
889 if (existing == ROAD_NONE || rttype == ROAD_TILE_CROSSING) {
890 SetRoadType(tile, rtt, rt);
891 SetRoadOwner(tile, rtt, company);
892 if (rtt == RTT_ROAD) SetTownIndex(tile, town_id);
894 if (rttype != ROAD_TILE_CROSSING) SetRoadBits(tile, existing | pieces, rtt);
895 break;
898 case MP_TUNNELBRIDGE: {
899 TileIndex other_end = GetOtherTunnelBridgeEnd(tile);
901 SetRoadType(other_end, rtt, rt);
902 SetRoadType(tile, rtt, rt);
903 SetRoadOwner(other_end, rtt, company);
904 SetRoadOwner(tile, rtt, company);
906 /* Mark tiles dirty that have been repaved */
907 if (IsBridge(tile)) {
908 MarkBridgeDirty(tile);
909 } else {
910 MarkTileDirtyByTile(other_end);
911 MarkTileDirtyByTile(tile);
913 break;
916 case MP_STATION: {
917 assert(IsDriveThroughStopTile(tile));
918 SetRoadType(tile, rtt, rt);
919 SetRoadOwner(tile, rtt, company);
920 break;
923 default:
924 MakeRoadNormal(tile, pieces, (rtt == RTT_ROAD) ? rt : INVALID_ROADTYPE, (rtt == RTT_TRAM) ? rt : INVALID_ROADTYPE, town_id, company, company);
925 break;
928 /* Update company infrastructure count. */
929 if (IsTileType(tile, MP_TUNNELBRIDGE)) num_pieces *= TUNNELBRIDGE_TRACKBIT_FACTOR;
930 UpdateCompanyRoadInfrastructure(rt, GetRoadOwner(tile, rtt), num_pieces);
932 if (rtt == RTT_ROAD && IsNormalRoadTile(tile)) {
933 existing |= pieces;
934 SetDisallowedRoadDirections(tile, IsStraightRoad(existing) ?
935 GetDisallowedRoadDirections(tile) ^ toggle_drd : DRD_NONE);
938 MarkTileDirtyByTile(tile);
940 return cost;
944 * Checks whether a road or tram connection can be found when building a new road or tram.
945 * @param tile Tile at which the road being built will end.
946 * @param rt Roadtype of the road being built.
947 * @param dir Direction that the road is following.
948 * @return True if the next tile at dir direction is suitable for being connected directly by a second roadbit at the end of the road being built.
950 static bool CanConnectToRoad(TileIndex tile, RoadType rt, DiagDirection dir)
952 tile += TileOffsByDiagDir(dir);
953 if (!IsValidTile(tile) || !MayHaveRoad(tile)) return false;
955 RoadTramType rtt = GetRoadTramType(rt);
956 RoadType existing = GetRoadType(tile, rtt);
957 if (existing == INVALID_ROADTYPE) return false;
958 if (!HasPowerOnRoad(existing, rt) && !HasPowerOnRoad(rt, existing)) return false;
960 RoadBits bits = GetAnyRoadBits(tile, rtt, false);
961 return (bits & DiagDirToRoadBits(ReverseDiagDir(dir))) != 0;
965 * Build a long piece of road.
966 * @param flags operation to perform
967 * @param end_tile end tile of drag
968 * @param start_tile start tile of drag
969 * @param rt road type
970 * @param axis direction
971 * @param drd set road direction
972 * @param start_half start tile starts in the 2nd half of tile (p2 & 1). Only used if \c is_ai is set or if we are building a single tile
973 * @param end_half end tile starts in the 2nd half of tile (p2 & 2). Only used if \c is_ai is set or if we are building a single tile
974 * @param is_ai defines two different behaviors for this command:
975 * - false = Build up to an obstacle. Do not build the first and last roadbits unless they can be connected to something, or if we are building a single tile
976 * - true = Fail if an obstacle is found. Always take into account start_half and end_half. This behavior is used for scripts
977 * @return the cost of this operation or an error
979 CommandCost CmdBuildLongRoad(DoCommandFlag flags, TileIndex end_tile, TileIndex start_tile, RoadType rt, Axis axis, DisallowedRoadDirections drd, bool start_half, bool end_half, bool is_ai)
981 if (start_tile >= Map::Size()) return CMD_ERROR;
983 if (!ValParamRoadType(rt) || !IsValidAxis(axis) || !IsValidDisallowedRoadDirections(drd)) return CMD_ERROR;
985 /* Only drag in X or Y direction dictated by the direction variable */
986 if (axis == AXIS_X && TileY(start_tile) != TileY(end_tile)) return CMD_ERROR; // x-axis
987 if (axis == AXIS_Y && TileX(start_tile) != TileX(end_tile)) return CMD_ERROR; // y-axis
989 DiagDirection dir = AxisToDiagDir(axis);
991 /* Swap direction, also the half-tile drag vars. */
992 if (start_tile > end_tile || (start_tile == end_tile && start_half)) {
993 dir = ReverseDiagDir(dir);
994 start_half = !start_half;
995 end_half = !end_half;
996 if (drd == DRD_NORTHBOUND || drd == DRD_SOUTHBOUND) drd ^= DRD_BOTH;
999 /* On the X-axis, we have to swap the initial bits, so they
1000 * will be interpreted correctly in the GTTS. Furthermore
1001 * when you just 'click' on one tile to build them. */
1002 if ((drd == DRD_NORTHBOUND || drd == DRD_SOUTHBOUND) && (axis == AXIS_Y) == (start_tile == end_tile && start_half == end_half)) drd ^= DRD_BOTH;
1004 CommandCost cost(EXPENSES_CONSTRUCTION);
1005 CommandCost last_error = CMD_ERROR;
1006 TileIndex tile = start_tile;
1007 bool had_bridge = false;
1008 bool had_tunnel = false;
1009 bool had_success = false;
1011 /* Start tile is the first tile clicked by the user. */
1012 for (;;) {
1013 RoadBits bits = AxisToRoadBits(axis);
1015 /* Determine which road parts should be built. */
1016 if (!is_ai && start_tile != end_tile) {
1017 /* Only build the first and last roadbit if they can connect to something. */
1018 if (tile == end_tile && !CanConnectToRoad(tile, rt, dir)) {
1019 bits = DiagDirToRoadBits(ReverseDiagDir(dir));
1020 } else if (tile == start_tile && !CanConnectToRoad(tile, rt, ReverseDiagDir(dir))) {
1021 bits = DiagDirToRoadBits(dir);
1023 } else {
1024 /* Road parts only have to be built at the start tile or at the end tile. */
1025 if (tile == end_tile && !end_half) bits &= DiagDirToRoadBits(ReverseDiagDir(dir));
1026 if (tile == start_tile && start_half) bits &= DiagDirToRoadBits(dir);
1029 CommandCost ret = Command<CMD_BUILD_ROAD>::Do(flags, tile, bits, rt, drd, 0);
1030 if (ret.Failed()) {
1031 last_error = ret;
1032 if (last_error.GetErrorMessage() != STR_ERROR_ALREADY_BUILT) {
1033 if (is_ai) return last_error;
1034 if (had_success) break; // Keep going if we haven't constructed any road yet, skipping the start of the drag
1036 } else {
1037 had_success = true;
1038 /* Only pay for the upgrade on one side of the bridges and tunnels */
1039 if (IsTileType(tile, MP_TUNNELBRIDGE)) {
1040 if (IsBridge(tile)) {
1041 if (!had_bridge || GetTunnelBridgeDirection(tile) == dir) {
1042 cost.AddCost(ret);
1044 had_bridge = true;
1045 } else { // IsTunnel(tile)
1046 if (!had_tunnel || GetTunnelBridgeDirection(tile) == dir) {
1047 cost.AddCost(ret);
1049 had_tunnel = true;
1051 } else {
1052 cost.AddCost(ret);
1056 if (tile == end_tile) break;
1058 tile += TileOffsByDiagDir(dir);
1061 return had_success ? cost : last_error;
1065 * Remove a long piece of road.
1066 * @param flags operation to perform
1067 * @param end_tile end tile of drag
1068 * @param start_tile start tile of drag
1069 * @param rt road type
1070 * @param axis direction
1071 * @param start_half start tile starts in the 2nd half of tile
1072 * @param end_half end tile starts in the 2nd half of tile (p2 & 2)
1073 * @return the cost of this operation or an error
1075 std::tuple<CommandCost, Money> CmdRemoveLongRoad(DoCommandFlag flags, TileIndex end_tile, TileIndex start_tile, RoadType rt, Axis axis, bool start_half, bool end_half)
1077 CommandCost cost(EXPENSES_CONSTRUCTION);
1079 if (start_tile >= Map::Size()) return { CMD_ERROR, 0 };
1080 if (!ValParamRoadType(rt) || !IsValidAxis(axis)) return { CMD_ERROR, 0 };
1082 /* Only drag in X or Y direction dictated by the direction variable */
1083 if (axis == AXIS_X && TileY(start_tile) != TileY(end_tile)) return { CMD_ERROR, 0 }; // x-axis
1084 if (axis == AXIS_Y && TileX(start_tile) != TileX(end_tile)) return { CMD_ERROR, 0 }; // y-axis
1086 /* Swap start and ending tile, also the half-tile drag vars. */
1087 if (start_tile > end_tile || (start_tile == end_tile && start_half)) {
1088 std::swap(start_tile, end_tile);
1089 std::swap(start_half, end_half);
1092 Money money_available = GetAvailableMoneyForCommand();
1093 Money money_spent = 0;
1094 TileIndex tile = start_tile;
1095 CommandCost last_error = CMD_ERROR;
1096 bool had_success = false;
1097 /* Start tile is the small number. */
1098 for (;;) {
1099 RoadBits bits = AxisToRoadBits(axis);
1101 if (tile == end_tile && !end_half) bits &= ROAD_NW | ROAD_NE;
1102 if (tile == start_tile && start_half) bits &= ROAD_SE | ROAD_SW;
1104 /* try to remove the halves. */
1105 if (bits != 0) {
1106 RoadTramType rtt = GetRoadTramType(rt);
1107 CommandCost ret = RemoveRoad(tile, flags & ~DC_EXEC, bits, rtt, true);
1108 if (ret.Succeeded()) {
1109 if (flags & DC_EXEC) {
1110 money_spent += ret.GetCost();
1111 if (money_spent > 0 && money_spent > money_available) {
1112 return { cost, std::get<0>(Command<CMD_REMOVE_LONG_ROAD>::Do(flags & ~DC_EXEC, end_tile, start_tile, rt, axis, start_half, end_half)).GetCost() };
1114 RemoveRoad(tile, flags, bits, rtt, false);
1116 cost.AddCost(ret);
1117 had_success = true;
1118 } else {
1119 /* Some errors are more equal than others. */
1120 switch (last_error.GetErrorMessage()) {
1121 case STR_ERROR_OWNED_BY:
1122 case STR_ERROR_LOCAL_AUTHORITY_REFUSES_TO_ALLOW_THIS:
1123 break;
1124 default:
1125 last_error = ret;
1130 if (tile == end_tile) break;
1132 tile += TileOffsByAxis(axis);
1135 return { had_success ? cost : last_error, 0 };
1139 * Build a road depot.
1140 * @param tile tile where to build the depot
1141 * @param flags operation to perform
1142 * @param rt road type
1143 * @param dir entrance direction
1144 * @return the cost of this operation or an error
1146 * @todo When checking for the tile slope,
1147 * distinguish between "Flat land required" and "land sloped in wrong direction"
1149 CommandCost CmdBuildRoadDepot(DoCommandFlag flags, TileIndex tile, RoadType rt, DiagDirection dir)
1151 if (!ValParamRoadType(rt) || !IsValidDiagDirection(dir)) return CMD_ERROR;
1153 CommandCost cost(EXPENSES_CONSTRUCTION);
1155 Slope tileh = GetTileSlope(tile);
1156 if (tileh != SLOPE_FLAT) {
1157 if (!_settings_game.construction.build_on_slopes || !CanBuildDepotByTileh(dir, tileh)) {
1158 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
1160 cost.AddCost(_price[PR_BUILD_FOUNDATION]);
1163 /* Allow the user to rotate the depot instead of having to destroy it and build it again */
1164 bool rotate_existing_depot = false;
1165 if (IsRoadDepotTile(tile) && (HasRoadTypeTram(tile) ? rt == GetRoadTypeTram(tile) : rt == GetRoadTypeRoad(tile)))
1167 CommandCost ret = CheckTileOwnership(tile);
1168 if (ret.Failed()) return ret;
1170 if (dir == GetRoadDepotDirection(tile)) return CommandCost();
1172 ret = EnsureNoVehicleOnGround(tile);
1173 if (ret.Failed()) return ret;
1175 rotate_existing_depot = true;
1178 if (!rotate_existing_depot) {
1179 cost.AddCost(Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile));
1180 if (cost.Failed()) return cost;
1182 if (IsBridgeAbove(tile)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
1184 if (!Depot::CanAllocateItem()) return CMD_ERROR;
1187 if (flags & DC_EXEC) {
1188 if (rotate_existing_depot) {
1189 SetRoadDepotExitDirection(tile, dir);
1190 } else {
1191 Depot *dep = new Depot(tile);
1192 dep->build_date = TimerGameCalendar::date;
1193 MakeRoadDepot(tile, _current_company, dep->index, dir, rt);
1194 MakeDefaultName(dep);
1196 /* A road depot has two road bits. */
1197 UpdateCompanyRoadInfrastructure(rt, _current_company, ROAD_DEPOT_TRACKBIT_FACTOR);
1200 MarkTileDirtyByTile(tile);
1203 cost.AddCost(_price[PR_BUILD_DEPOT_ROAD]);
1204 return cost;
1207 static CommandCost RemoveRoadDepot(TileIndex tile, DoCommandFlag flags)
1209 if (_current_company != OWNER_WATER) {
1210 CommandCost ret = CheckTileOwnership(tile);
1211 if (ret.Failed()) return ret;
1214 CommandCost ret = EnsureNoVehicleOnGround(tile);
1215 if (ret.Failed()) return ret;
1217 if (flags & DC_EXEC) {
1218 Company *c = Company::GetIfValid(GetTileOwner(tile));
1219 if (c != nullptr) {
1220 /* A road depot has two road bits. */
1221 RoadType rt = GetRoadTypeRoad(tile);
1222 if (rt == INVALID_ROADTYPE) rt = GetRoadTypeTram(tile);
1223 c->infrastructure.road[rt] -= ROAD_DEPOT_TRACKBIT_FACTOR;
1224 DirtyCompanyInfrastructureWindows(c->index);
1227 delete Depot::GetByTile(tile);
1228 DoClearSquare(tile);
1231 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_CLEAR_DEPOT_ROAD]);
1234 static CommandCost ClearTile_Road(TileIndex tile, DoCommandFlag flags)
1236 switch (GetRoadTileType(tile)) {
1237 case ROAD_TILE_NORMAL: {
1238 RoadBits b = GetAllRoadBits(tile);
1240 /* Clear the road if only one piece is on the tile OR we are not using the DC_AUTO flag */
1241 if ((HasExactlyOneBit(b) && GetRoadBits(tile, RTT_TRAM) == ROAD_NONE) || !(flags & DC_AUTO)) {
1242 CommandCost ret(EXPENSES_CONSTRUCTION);
1243 for (RoadTramType rtt : _roadtramtypes) {
1244 if (!MayHaveRoad(tile) || GetRoadType(tile, rtt) == INVALID_ROADTYPE) continue;
1246 CommandCost tmp_ret = RemoveRoad(tile, flags, GetRoadBits(tile, rtt), rtt, true);
1247 if (tmp_ret.Failed()) return tmp_ret;
1248 ret.AddCost(tmp_ret);
1250 return ret;
1252 return_cmd_error(STR_ERROR_MUST_REMOVE_ROAD_FIRST);
1255 case ROAD_TILE_CROSSING: {
1256 CommandCost ret(EXPENSES_CONSTRUCTION);
1258 if (flags & DC_AUTO) return_cmd_error(STR_ERROR_MUST_REMOVE_ROAD_FIRST);
1260 /* Must iterate over the roadtypes in a reverse manner because
1261 * tram tracks must be removed before the road bits. */
1262 for (RoadTramType rtt : { RTT_TRAM, RTT_ROAD }) {
1263 if (!MayHaveRoad(tile) || GetRoadType(tile, rtt) == INVALID_ROADTYPE) continue;
1265 CommandCost tmp_ret = RemoveRoad(tile, flags, GetCrossingRoadBits(tile), rtt, true);
1266 if (tmp_ret.Failed()) return tmp_ret;
1267 ret.AddCost(tmp_ret);
1270 if (flags & DC_EXEC) {
1271 Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
1273 return ret;
1276 default:
1277 case ROAD_TILE_DEPOT:
1278 if (flags & DC_AUTO) {
1279 return_cmd_error(STR_ERROR_BUILDING_MUST_BE_DEMOLISHED);
1281 return RemoveRoadDepot(tile, flags);
1286 struct DrawRoadTileStruct {
1287 uint16_t image;
1288 uint8_t subcoord_x;
1289 uint8_t subcoord_y;
1292 #include "table/road_land.h"
1295 * Get the foundationtype of a RoadBits Slope combination
1297 * @param tileh The Slope part
1298 * @param bits The RoadBits part
1299 * @return The resulting Foundation
1301 static Foundation GetRoadFoundation(Slope tileh, RoadBits bits)
1303 /* Flat land and land without a road doesn't require a foundation */
1304 if (tileh == SLOPE_FLAT || bits == ROAD_NONE) return FOUNDATION_NONE;
1306 /* Steep slopes behave the same as slopes with one corner raised. */
1307 if (IsSteepSlope(tileh)) {
1308 tileh = SlopeWithOneCornerRaised(GetHighestSlopeCorner(tileh));
1311 /* Leveled RoadBits on a slope */
1312 if ((_invalid_tileh_slopes_road[0][tileh] & bits) == ROAD_NONE) return FOUNDATION_LEVELED;
1314 /* Straight roads without foundation on a slope */
1315 if (!IsSlopeWithOneCornerRaised(tileh) &&
1316 (_invalid_tileh_slopes_road[1][tileh] & bits) == ROAD_NONE)
1317 return FOUNDATION_NONE;
1319 /* Roads on steep Slopes or on Slopes with one corner raised */
1320 return (bits == ROAD_X ? FOUNDATION_INCLINED_X : FOUNDATION_INCLINED_Y);
1323 const uint8_t _road_sloped_sprites[14] = {
1324 0, 0, 2, 0,
1325 0, 1, 0, 0,
1326 3, 0, 0, 0,
1327 0, 0
1331 * Get the sprite offset within a spritegroup.
1332 * @param slope Slope
1333 * @param bits Roadbits
1334 * @return Offset for the sprite within the spritegroup.
1336 static uint GetRoadSpriteOffset(Slope slope, RoadBits bits)
1338 if (slope != SLOPE_FLAT) {
1339 switch (slope) {
1340 case SLOPE_NE: return 11;
1341 case SLOPE_SE: return 12;
1342 case SLOPE_SW: return 13;
1343 case SLOPE_NW: return 14;
1344 default: NOT_REACHED();
1346 } else {
1347 static const uint offsets[] = {
1348 0, 18, 17, 7,
1349 16, 0, 10, 5,
1350 15, 8, 1, 4,
1351 9, 3, 6, 2
1353 return offsets[bits];
1358 * Should the road be drawn as a unpaved snow/desert road?
1359 * By default, roads are always drawn as unpaved if they are on desert or
1360 * above the snow line, but NewGRFs can override this for desert.
1362 * @param snow_or_desert Is snowy or desert tile
1363 * @param roadside What sort of road this is
1364 * @return True if snow/desert road sprites should be used.
1366 static bool DrawRoadAsSnowDesert(bool snow_or_desert, Roadside roadside)
1368 return (snow_or_desert &&
1369 !(_settings_game.game_creation.landscape == LT_TROPIC && HasGrfMiscBit(GMB_DESERT_PAVED_ROADS) &&
1370 roadside != ROADSIDE_BARREN && roadside != ROADSIDE_GRASS && roadside != ROADSIDE_GRASS_ROAD_WORKS));
1374 * Draws the catenary for the RoadType of the given tile
1375 * @param ti information about the tile (slopes, height etc)
1376 * @param rt road type to draw catenary for
1377 * @param rb the roadbits for the tram
1379 void DrawRoadTypeCatenary(const TileInfo *ti, RoadType rt, RoadBits rb)
1381 /* Don't draw the catenary under a low bridge */
1382 if (IsBridgeAbove(ti->tile) && !IsTransparencySet(TO_CATENARY)) {
1383 int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
1385 if (height <= GetTileMaxZ(ti->tile) + 1) return;
1388 if (CountBits(rb) > 2) {
1389 /* On junctions we check whether neighbouring tiles also have catenary, and possibly
1390 * do not draw catenary towards those neighbours, which do not have catenary. */
1391 RoadBits rb_new = ROAD_NONE;
1392 for (DiagDirection dir = DIAGDIR_BEGIN; dir < DIAGDIR_END; dir++) {
1393 if (rb & DiagDirToRoadBits(dir)) {
1394 TileIndex neighbour = TileAddByDiagDir(ti->tile, dir);
1395 if (MayHaveRoad(neighbour)) {
1396 RoadType rt_road = GetRoadTypeRoad(neighbour);
1397 RoadType rt_tram = GetRoadTypeTram(neighbour);
1399 if ((rt_road != INVALID_ROADTYPE && HasRoadCatenary(rt_road)) ||
1400 (rt_tram != INVALID_ROADTYPE && HasRoadCatenary(rt_tram))) {
1401 rb_new |= DiagDirToRoadBits(dir);
1406 if (CountBits(rb_new) >= 2) rb = rb_new;
1409 const RoadTypeInfo *rti = GetRoadTypeInfo(rt);
1410 SpriteID front = GetCustomRoadSprite(rti, ti->tile, ROTSG_CATENARY_FRONT);
1411 SpriteID back = GetCustomRoadSprite(rti, ti->tile, ROTSG_CATENARY_BACK);
1413 if (front != 0 || back != 0) {
1414 if (front != 0) front += GetRoadSpriteOffset(ti->tileh, rb);
1415 if (back != 0) back += GetRoadSpriteOffset(ti->tileh, rb);
1416 } else if (ti->tileh != SLOPE_FLAT) {
1417 back = SPR_TRAMWAY_BACK_WIRES_SLOPED + _road_sloped_sprites[ti->tileh - 1];
1418 front = SPR_TRAMWAY_FRONT_WIRES_SLOPED + _road_sloped_sprites[ti->tileh - 1];
1419 } else {
1420 back = SPR_TRAMWAY_BASE + _road_backpole_sprites_1[rb];
1421 front = SPR_TRAMWAY_BASE + _road_frontwire_sprites_1[rb];
1424 /* Catenary uses 1st company colour to help identify owner.
1425 * For tiles with OWNER_TOWN or OWNER_NONE, recolour CC to grey as a neutral colour. */
1426 Owner owner = GetRoadOwner(ti->tile, GetRoadTramType(rt));
1427 PaletteID pal = (owner == OWNER_NONE || owner == OWNER_TOWN ? GENERAL_SPRITE_COLOUR(COLOUR_GREY) : COMPANY_SPRITE_COLOUR(owner));
1428 int z_wires = (ti->tileh == SLOPE_FLAT ? 0 : TILE_HEIGHT) + BB_HEIGHT_UNDER_BRIDGE;
1429 if (back != 0) {
1430 /* The "back" sprite contains the west, north and east pillars.
1431 * We cut the sprite at 3/8 of the west/east edges to create 3 sprites.
1432 * 3/8 is chosen so that sprites can somewhat graphically extend into the tile. */
1433 static const int INF = 1000; ///< big number compared to sprite size
1434 static const SubSprite west = { -INF, -INF, -12, INF };
1435 static const SubSprite north = { -12, -INF, 12, INF };
1436 static const SubSprite east = { 12, -INF, INF, INF };
1437 AddSortableSpriteToDraw(back, pal, ti->x, ti->y, 16, 1, z_wires, ti->z, IsTransparencySet(TO_CATENARY), 15, 0, GetSlopePixelZInCorner(ti->tileh, CORNER_W), &west);
1438 AddSortableSpriteToDraw(back, pal, ti->x, ti->y, 1, 1, z_wires, ti->z, IsTransparencySet(TO_CATENARY), 0, 0, GetSlopePixelZInCorner(ti->tileh, CORNER_N), &north);
1439 AddSortableSpriteToDraw(back, pal, ti->x, ti->y, 1, 16, z_wires, ti->z, IsTransparencySet(TO_CATENARY), 0, 15, GetSlopePixelZInCorner(ti->tileh, CORNER_E), &east);
1441 if (front != 0) {
1442 /* Draw the "front" sprite (containing south pillar and wires) at a Z height that is both above the vehicles and above the "back" pillars. */
1443 AddSortableSpriteToDraw(front, pal, ti->x, ti->y, 16, 16, z_wires + 1, ti->z, IsTransparencySet(TO_CATENARY), 0, 0, z_wires);
1448 * Draws the catenary for the given tile
1449 * @param ti information about the tile (slopes, height etc)
1451 void DrawRoadCatenary(const TileInfo *ti)
1453 RoadBits road = ROAD_NONE;
1454 RoadBits tram = ROAD_NONE;
1456 if (IsTileType(ti->tile, MP_ROAD)) {
1457 if (IsNormalRoad(ti->tile)) {
1458 road = GetRoadBits(ti->tile, RTT_ROAD);
1459 tram = GetRoadBits(ti->tile, RTT_TRAM);
1460 } else if (IsLevelCrossing(ti->tile)) {
1461 tram = road = (GetCrossingRailAxis(ti->tile) == AXIS_Y ? ROAD_X : ROAD_Y);
1463 } else if (IsTileType(ti->tile, MP_STATION)) {
1464 if (IsAnyRoadStop(ti->tile)) {
1465 if (IsDriveThroughStopTile(ti->tile)) {
1466 Axis axis = GetDriveThroughStopAxis(ti->tile);
1467 tram = road = (axis == AXIS_X ? ROAD_X : ROAD_Y);
1468 } else {
1469 tram = road = DiagDirToRoadBits(GetBayRoadStopDir(ti->tile));
1472 } else {
1473 // No road here, no catenary to draw
1474 return;
1477 RoadType rt = GetRoadTypeRoad(ti->tile);
1478 if (rt != INVALID_ROADTYPE && HasRoadCatenaryDrawn(rt)) {
1479 DrawRoadTypeCatenary(ti, rt, road);
1482 rt = GetRoadTypeTram(ti->tile);
1483 if (rt != INVALID_ROADTYPE && HasRoadCatenaryDrawn(rt)) {
1484 DrawRoadTypeCatenary(ti, rt, tram);
1489 * Draws details on/around the road
1490 * @param img the sprite to draw
1491 * @param ti the tile to draw on
1492 * @param dx the offset from the top of the BB of the tile
1493 * @param dy the offset from the top of the BB of the tile
1494 * @param h the height of the sprite to draw
1495 * @param transparent whether the sprite should be transparent (used for roadside trees)
1497 static void DrawRoadDetail(SpriteID img, const TileInfo *ti, int dx, int dy, int h, bool transparent)
1499 int x = ti->x | dx;
1500 int y = ti->y | dy;
1501 int z = ti->z;
1502 if (ti->tileh != SLOPE_FLAT) z = GetSlopePixelZ(x, y);
1503 AddSortableSpriteToDraw(img, PAL_NONE, x, y, 2, 2, h, z, transparent);
1507 * Draw road underlay and overlay sprites.
1508 * @param ti TileInfo
1509 * @param road_rti Road road type information
1510 * @param tram_rti Tram road type information
1511 * @param road_offset Road sprite offset (based on road bits)
1512 * @param tram_offset Tram sprite offset (based on road bits)
1513 * @param draw_underlay Whether to draw underlays
1515 void DrawRoadOverlays(const TileInfo *ti, PaletteID pal, const RoadTypeInfo *road_rti, const RoadTypeInfo *tram_rti, uint road_offset, uint tram_offset, bool draw_underlay)
1517 if (draw_underlay) {
1518 /* Road underlay takes precedence over tram */
1519 if (road_rti != nullptr) {
1520 if (road_rti->UsesOverlay()) {
1521 SpriteID ground = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_GROUND);
1522 DrawGroundSprite(ground + road_offset, pal);
1524 } else {
1525 if (tram_rti->UsesOverlay()) {
1526 SpriteID ground = GetCustomRoadSprite(tram_rti, ti->tile, ROTSG_GROUND);
1527 DrawGroundSprite(ground + tram_offset, pal);
1528 } else {
1529 DrawGroundSprite(SPR_TRAMWAY_TRAM + tram_offset, pal);
1534 /* Draw road overlay */
1535 if (road_rti != nullptr) {
1536 if (road_rti->UsesOverlay()) {
1537 SpriteID ground = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_OVERLAY);
1538 if (ground != 0) DrawGroundSprite(ground + road_offset, pal);
1542 /* Draw tram overlay */
1543 if (tram_rti != nullptr) {
1544 if (tram_rti->UsesOverlay()) {
1545 SpriteID ground = GetCustomRoadSprite(tram_rti, ti->tile, ROTSG_OVERLAY);
1546 if (ground != 0) DrawGroundSprite(ground + tram_offset, pal);
1547 } else if (road_rti != nullptr) {
1548 DrawGroundSprite(SPR_TRAMWAY_OVERLAY + tram_offset, pal);
1554 * Get ground sprite to draw for a road tile.
1555 * @param ti TileInof
1556 * @param roadside Road side type
1557 * @param rti Road type info
1558 * @param offset Road sprite offset
1559 * @param snow_or_desert Whether to get snow/desert ground sprite
1560 * @param[out] pal Palette to draw.
1562 static SpriteID GetRoadGroundSprite(const TileInfo *ti, Roadside roadside, const RoadTypeInfo *rti, uint offset, bool snow_or_desert, PaletteID *pal)
1564 /* Draw bare ground sprite if no road or road uses overlay system. */
1565 if (rti == nullptr || rti->UsesOverlay()) {
1566 if (DrawRoadAsSnowDesert(snow_or_desert, roadside)) {
1567 return SPR_FLAT_SNOW_DESERT_TILE + SlopeToSpriteOffset(ti->tileh);
1570 switch (roadside) {
1571 case ROADSIDE_BARREN: *pal = PALETTE_TO_BARE_LAND;
1572 return SPR_FLAT_GRASS_TILE + SlopeToSpriteOffset(ti->tileh);
1573 case ROADSIDE_GRASS:
1574 case ROADSIDE_GRASS_ROAD_WORKS: return SPR_FLAT_GRASS_TILE + SlopeToSpriteOffset(ti->tileh);
1575 default: break; // Paved
1579 /* Draw original road base sprite */
1580 SpriteID image = SPR_ROAD_Y + offset;
1581 if (DrawRoadAsSnowDesert(snow_or_desert, roadside)) {
1582 image += 19;
1583 } else {
1584 switch (roadside) {
1585 case ROADSIDE_BARREN: *pal = PALETTE_TO_BARE_LAND; break;
1586 case ROADSIDE_GRASS: break;
1587 case ROADSIDE_GRASS_ROAD_WORKS: break;
1588 default: image -= 19; break; // Paved
1592 return image;
1596 * Draw road ground sprites.
1597 * @param ti TileInfo
1598 * @param road Road bits
1599 * @param tram Tram bits
1600 * @param road_rti Road road type information
1601 * @param tram_rti Tram road type information
1602 * @param roadside Roadside type
1603 * @param snow_or_desert Whether to draw snow/desert ground sprites
1605 void DrawRoadGroundSprites(const TileInfo *ti, RoadBits road, RoadBits tram, const RoadTypeInfo *road_rti, const RoadTypeInfo *tram_rti, Roadside roadside, bool snow_or_desert)
1607 /* Determine sprite offsets */
1608 uint road_offset = GetRoadSpriteOffset(ti->tileh, road);
1609 uint tram_offset = GetRoadSpriteOffset(ti->tileh, tram);
1611 /* Draw baseset underlay */
1612 PaletteID pal = PAL_NONE;
1613 SpriteID image = GetRoadGroundSprite(ti, roadside, road_rti, road == ROAD_NONE ? tram_offset : road_offset, snow_or_desert, &pal);
1614 DrawGroundSprite(image, pal);
1616 DrawRoadOverlays(ti, pal, road_rti, tram_rti, road_offset, tram_offset);
1620 * Draw ground sprite and road pieces
1621 * @param ti TileInfo
1623 static void DrawRoadBits(TileInfo *ti)
1625 RoadBits road = GetRoadBits(ti->tile, RTT_ROAD);
1626 RoadBits tram = GetRoadBits(ti->tile, RTT_TRAM);
1628 RoadType road_rt = GetRoadTypeRoad(ti->tile);
1629 RoadType tram_rt = GetRoadTypeTram(ti->tile);
1630 const RoadTypeInfo *road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
1631 const RoadTypeInfo *tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
1633 if (ti->tileh != SLOPE_FLAT) {
1634 DrawFoundation(ti, GetRoadFoundation(ti->tileh, road | tram));
1635 /* DrawFoundation() modifies ti. */
1638 DrawRoadGroundSprites(ti, road, tram, road_rti, tram_rti, GetRoadside(ti->tile), IsOnSnow(ti->tile));
1640 /* Draw one way */
1641 if (road_rti != nullptr) {
1642 DisallowedRoadDirections drd = GetDisallowedRoadDirections(ti->tile);
1643 if (drd != DRD_NONE) {
1644 SpriteID oneway = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_ONEWAY);
1646 if (oneway == 0) oneway = SPR_ONEWAY_BASE;
1648 if ((ti->tileh == SLOPE_NE) || (ti->tileh == SLOPE_NW)) {
1649 oneway += SPR_ONEWAY_SLOPE_N_OFFSET;
1650 } else if ((ti->tileh == SLOPE_SE) || (ti->tileh == SLOPE_SW)) {
1651 oneway += SPR_ONEWAY_SLOPE_S_OFFSET;
1654 DrawGroundSpriteAt(oneway + drd - 1 + ((road == ROAD_X) ? 0 : 3), PAL_NONE, 8, 8, GetPartialPixelZ(8, 8, ti->tileh));
1658 if (HasRoadWorks(ti->tile)) {
1659 /* Road works */
1660 DrawGroundSprite((road | tram) & ROAD_X ? SPR_EXCAVATION_X : SPR_EXCAVATION_Y, PAL_NONE);
1661 return;
1664 /* Draw road, tram catenary */
1665 DrawRoadCatenary(ti);
1667 /* Return if full detail is disabled, or we are zoomed fully out. */
1668 if (!HasBit(_display_opt, DO_FULL_DETAIL) || _cur_dpi->zoom > ZOOM_LVL_DETAIL) return;
1670 /* Do not draw details (street lights, trees) under low bridge */
1671 Roadside roadside = GetRoadside(ti->tile);
1672 if (IsBridgeAbove(ti->tile) && (roadside == ROADSIDE_TREES || roadside == ROADSIDE_STREET_LIGHTS)) {
1673 int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
1674 int minz = GetTileMaxZ(ti->tile) + 2;
1676 if (roadside == ROADSIDE_TREES) minz++;
1678 if (height < minz) return;
1681 /* If there are no road bits, return, as there is nothing left to do */
1682 if (HasAtMostOneBit(road)) return;
1684 /* Do not draw details when invisible. */
1685 if (roadside == ROADSIDE_TREES && IsInvisibilitySet(TO_TREES)) return;
1686 if (roadside == ROADSIDE_STREET_LIGHTS && IsInvisibilitySet(TO_HOUSES)) return;
1688 /* Check whether details should be transparent. */
1689 bool is_transparent = false;
1690 if (roadside == ROADSIDE_TREES && IsTransparencySet(TO_TREES)) {
1691 is_transparent = true;
1693 if (roadside == ROADSIDE_STREET_LIGHTS && IsTransparencySet(TO_HOUSES)) {
1694 is_transparent = true;
1697 /* Draw extra details. */
1698 for (const DrawRoadTileStruct *drts = _road_display_table[roadside][road | tram]; drts->image != 0; drts++) {
1699 DrawRoadDetail(drts->image, ti, drts->subcoord_x, drts->subcoord_y, 0x10, is_transparent);
1703 /** Tile callback function for rendering a road tile to the screen */
1704 static void DrawTile_Road(TileInfo *ti)
1706 switch (GetRoadTileType(ti->tile)) {
1707 case ROAD_TILE_NORMAL:
1708 DrawRoadBits(ti);
1709 break;
1711 case ROAD_TILE_CROSSING: {
1712 if (ti->tileh != SLOPE_FLAT) DrawFoundation(ti, FOUNDATION_LEVELED);
1714 Axis axis = GetCrossingRailAxis(ti->tile);
1716 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(ti->tile));
1718 RoadType road_rt = GetRoadTypeRoad(ti->tile);
1719 RoadType tram_rt = GetRoadTypeTram(ti->tile);
1720 const RoadTypeInfo *road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
1721 const RoadTypeInfo *tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
1723 PaletteID pal = PAL_NONE;
1725 /* Draw base ground */
1726 if (rti->UsesOverlay()) {
1727 SpriteID image = SPR_ROAD_Y + axis;
1729 Roadside roadside = GetRoadside(ti->tile);
1730 if (DrawRoadAsSnowDesert(IsOnSnow(ti->tile), roadside)) {
1731 image += 19;
1732 } else {
1733 switch (roadside) {
1734 case ROADSIDE_BARREN: pal = PALETTE_TO_BARE_LAND; break;
1735 case ROADSIDE_GRASS: break;
1736 default: image -= 19; break; // Paved
1740 DrawGroundSprite(image, pal);
1741 } else {
1742 SpriteID image = rti->base_sprites.crossing + axis;
1743 if (IsCrossingBarred(ti->tile)) image += 2;
1745 Roadside roadside = GetRoadside(ti->tile);
1746 if (DrawRoadAsSnowDesert(IsOnSnow(ti->tile), roadside)) {
1747 image += 8;
1748 } else {
1749 switch (roadside) {
1750 case ROADSIDE_BARREN: pal = PALETTE_TO_BARE_LAND; break;
1751 case ROADSIDE_GRASS: break;
1752 default: image += 4; break; // Paved
1756 DrawGroundSprite(image, pal);
1759 DrawRoadOverlays(ti, pal, road_rti, tram_rti, axis, axis);
1761 /* Draw rail/PBS overlay */
1762 bool draw_pbs = _game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasCrossingReservation(ti->tile);
1763 if (rti->UsesOverlay()) {
1764 pal = draw_pbs ? PALETTE_CRASH : PAL_NONE;
1765 SpriteID rail = GetCustomRailSprite(rti, ti->tile, RTSG_CROSSING) + axis;
1766 DrawGroundSprite(rail, pal);
1768 const Axis road_axis = GetCrossingRoadAxis(ti->tile);
1769 const DiagDirection dir1 = AxisToDiagDir(road_axis);
1770 const DiagDirection dir2 = ReverseDiagDir(dir1);
1771 uint adjacent_diagdirs = 0;
1772 for (DiagDirection dir : { dir1, dir2 }) {
1773 const TileIndex t = TileAddByDiagDir(ti->tile, dir);
1774 if (t < Map::Size() && IsLevelCrossingTile(t) && GetCrossingRoadAxis(t) == road_axis) {
1775 SetBit(adjacent_diagdirs, dir);
1779 switch (adjacent_diagdirs) {
1780 case 0:
1781 DrawRailTileSeq(ti, &_crossing_layout, TO_CATENARY, rail, 0, PAL_NONE);
1782 break;
1784 case (1 << DIAGDIR_NE):
1785 DrawRailTileSeq(ti, &_crossing_layout_SW, TO_CATENARY, rail, 0, PAL_NONE);
1786 break;
1788 case (1 << DIAGDIR_SE):
1789 DrawRailTileSeq(ti, &_crossing_layout_NW, TO_CATENARY, rail, 0, PAL_NONE);
1790 break;
1792 case (1 << DIAGDIR_SW):
1793 DrawRailTileSeq(ti, &_crossing_layout_NE, TO_CATENARY, rail, 0, PAL_NONE);
1794 break;
1796 case (1 << DIAGDIR_NW):
1797 DrawRailTileSeq(ti, &_crossing_layout_SE, TO_CATENARY, rail, 0, PAL_NONE);
1798 break;
1800 default:
1801 /* Show no sprites */
1802 break;
1804 } else if (draw_pbs || tram_rti != nullptr || road_rti->UsesOverlay()) {
1805 /* Add another rail overlay, unless there is only the base road sprite. */
1806 pal = draw_pbs ? PALETTE_CRASH : PAL_NONE;
1807 SpriteID rail = GetCrossingRoadAxis(ti->tile) == AXIS_Y ? GetRailTypeInfo(GetRailType(ti->tile))->base_sprites.single_x : GetRailTypeInfo(GetRailType(ti->tile))->base_sprites.single_y;
1808 DrawGroundSprite(rail, pal);
1811 /* Draw road, tram catenary */
1812 DrawRoadCatenary(ti);
1814 /* Draw rail catenary */
1815 if (HasRailCatenaryDrawn(GetRailType(ti->tile))) DrawRailCatenary(ti);
1817 break;
1820 default:
1821 case ROAD_TILE_DEPOT: {
1822 if (ti->tileh != SLOPE_FLAT) DrawFoundation(ti, FOUNDATION_LEVELED);
1824 PaletteID palette = COMPANY_SPRITE_COLOUR(GetTileOwner(ti->tile));
1826 RoadType road_rt = GetRoadTypeRoad(ti->tile);
1827 RoadType tram_rt = GetRoadTypeTram(ti->tile);
1828 const RoadTypeInfo *rti = GetRoadTypeInfo(road_rt == INVALID_ROADTYPE ? tram_rt : road_rt);
1830 int relocation = GetCustomRoadSprite(rti, ti->tile, ROTSG_DEPOT);
1831 bool default_gfx = relocation == 0;
1832 if (default_gfx) {
1833 if (HasBit(rti->flags, ROTF_CATENARY)) {
1834 if (_loaded_newgrf_features.tram == TRAMWAY_REPLACE_DEPOT_WITH_TRACK && road_rt == INVALID_ROADTYPE && !rti->UsesOverlay()) {
1835 /* Sprites with track only work for default tram */
1836 relocation = SPR_TRAMWAY_DEPOT_WITH_TRACK - SPR_ROAD_DEPOT;
1837 default_gfx = false;
1838 } else {
1839 /* Sprites without track are always better, if provided */
1840 relocation = SPR_TRAMWAY_DEPOT_NO_TRACK - SPR_ROAD_DEPOT;
1843 } else {
1844 relocation -= SPR_ROAD_DEPOT;
1847 DiagDirection dir = GetRoadDepotDirection(ti->tile);
1848 const DrawTileSprites *dts = &_road_depot[dir];
1849 DrawGroundSprite(dts->ground.sprite, PAL_NONE);
1851 if (default_gfx) {
1852 uint offset = GetRoadSpriteOffset(SLOPE_FLAT, DiagDirToRoadBits(dir));
1853 if (rti->UsesOverlay()) {
1854 SpriteID ground = GetCustomRoadSprite(rti, ti->tile, ROTSG_OVERLAY);
1855 if (ground != 0) DrawGroundSprite(ground + offset, PAL_NONE);
1856 } else if (road_rt == INVALID_ROADTYPE) {
1857 DrawGroundSprite(SPR_TRAMWAY_OVERLAY + offset, PAL_NONE);
1861 DrawRailTileSeq(ti, dts, TO_BUILDINGS, relocation, 0, palette);
1862 break;
1865 DrawBridgeMiddle(ti);
1869 * Draw the road depot sprite.
1870 * @param x The x offset to draw at.
1871 * @param y The y offset to draw at.
1872 * @param dir The direction the depot must be facing.
1873 * @param rt The road type of the depot to draw.
1875 void DrawRoadDepotSprite(int x, int y, DiagDirection dir, RoadType rt)
1877 PaletteID palette = COMPANY_SPRITE_COLOUR(_local_company);
1879 const RoadTypeInfo *rti = GetRoadTypeInfo(rt);
1880 int relocation = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_DEPOT);
1881 bool default_gfx = relocation == 0;
1882 if (default_gfx) {
1883 if (HasBit(rti->flags, ROTF_CATENARY)) {
1884 if (_loaded_newgrf_features.tram == TRAMWAY_REPLACE_DEPOT_WITH_TRACK && RoadTypeIsTram(rt) && !rti->UsesOverlay()) {
1885 /* Sprites with track only work for default tram */
1886 relocation = SPR_TRAMWAY_DEPOT_WITH_TRACK - SPR_ROAD_DEPOT;
1887 default_gfx = false;
1888 } else {
1889 /* Sprites without track are always better, if provided */
1890 relocation = SPR_TRAMWAY_DEPOT_NO_TRACK - SPR_ROAD_DEPOT;
1893 } else {
1894 relocation -= SPR_ROAD_DEPOT;
1897 const DrawTileSprites *dts = &_road_depot[dir];
1898 DrawSprite(dts->ground.sprite, PAL_NONE, x, y);
1900 if (default_gfx) {
1901 uint offset = GetRoadSpriteOffset(SLOPE_FLAT, DiagDirToRoadBits(dir));
1902 if (rti->UsesOverlay()) {
1903 SpriteID ground = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_OVERLAY);
1904 if (ground != 0) DrawSprite(ground + offset, PAL_NONE, x, y);
1905 } else if (RoadTypeIsTram(rt)) {
1906 DrawSprite(SPR_TRAMWAY_OVERLAY + offset, PAL_NONE, x, y);
1910 DrawRailTileSeqInGUI(x, y, dts, relocation, 0, palette);
1914 * Updates cached nearest town for all road tiles
1915 * @param invalidate are we just invalidating cached data?
1916 * @pre invalidate == true implies _generating_world == true
1918 void UpdateNearestTownForRoadTiles(bool invalidate)
1920 assert(!invalidate || _generating_world);
1922 for (TileIndex t = 0; t < Map::Size(); t++) {
1923 if (IsTileType(t, MP_ROAD) && !IsRoadDepot(t) && !HasTownOwnedRoad(t)) {
1924 TownID tid = INVALID_TOWN;
1925 if (!invalidate) {
1926 const Town *town = CalcClosestTownFromTile(t);
1927 if (town != nullptr) tid = town->index;
1929 SetTownIndex(t, tid);
1934 static int GetSlopePixelZ_Road(TileIndex tile, uint x, uint y, bool)
1937 if (IsNormalRoad(tile)) {
1938 auto [tileh, z] = GetTilePixelSlope(tile);
1939 if (tileh == SLOPE_FLAT) return z;
1941 Foundation f = GetRoadFoundation(tileh, GetAllRoadBits(tile));
1942 z += ApplyPixelFoundationToSlope(f, tileh);
1943 return z + GetPartialPixelZ(x & 0xF, y & 0xF, tileh);
1944 } else {
1945 return GetTileMaxPixelZ(tile);
1949 static Foundation GetFoundation_Road(TileIndex tile, Slope tileh)
1951 if (IsNormalRoad(tile)) {
1952 return GetRoadFoundation(tileh, GetAllRoadBits(tile));
1953 } else {
1954 return FlatteningFoundation(tileh);
1958 static const Roadside _town_road_types[][2] = {
1959 { ROADSIDE_GRASS, ROADSIDE_GRASS },
1960 { ROADSIDE_PAVED, ROADSIDE_PAVED },
1961 { ROADSIDE_PAVED, ROADSIDE_PAVED },
1962 { ROADSIDE_TREES, ROADSIDE_TREES },
1963 { ROADSIDE_STREET_LIGHTS, ROADSIDE_PAVED }
1966 static_assert(lengthof(_town_road_types) == HZB_END);
1968 static const Roadside _town_road_types_2[][2] = {
1969 { ROADSIDE_GRASS, ROADSIDE_GRASS },
1970 { ROADSIDE_PAVED, ROADSIDE_PAVED },
1971 { ROADSIDE_STREET_LIGHTS, ROADSIDE_PAVED },
1972 { ROADSIDE_STREET_LIGHTS, ROADSIDE_PAVED },
1973 { ROADSIDE_STREET_LIGHTS, ROADSIDE_PAVED }
1976 static_assert(lengthof(_town_road_types_2) == HZB_END);
1979 static void TileLoop_Road(TileIndex tile)
1981 switch (_settings_game.game_creation.landscape) {
1982 case LT_ARCTIC: {
1983 /* Roads on flat foundations use the snow level of the height they are elevated to. All others use the snow level of their minimum height. */
1984 int tile_z = (std::get<Slope>(GetFoundationSlope(tile)) == SLOPE_FLAT) ? GetTileMaxZ(tile) : GetTileZ(tile);
1985 if (IsOnSnow(tile) != (tile_z > GetSnowLine())) {
1986 ToggleSnow(tile);
1987 MarkTileDirtyByTile(tile);
1989 break;
1992 case LT_TROPIC:
1993 if (GetTropicZone(tile) == TROPICZONE_DESERT && !IsOnDesert(tile)) {
1994 ToggleDesert(tile);
1995 MarkTileDirtyByTile(tile);
1997 break;
2000 if (IsRoadDepot(tile)) return;
2002 const Town *t = ClosestTownFromTile(tile, UINT_MAX);
2003 if (!HasRoadWorks(tile)) {
2004 HouseZonesBits grp = HZB_TOWN_EDGE;
2006 if (t != nullptr) {
2007 grp = GetTownRadiusGroup(t, tile);
2009 /* Show an animation to indicate road work */
2010 if (t->road_build_months != 0 &&
2011 (DistanceManhattan(t->xy, tile) < 8 || grp != HZB_TOWN_EDGE) &&
2012 IsNormalRoad(tile) && !HasAtMostOneBit(GetAllRoadBits(tile))) {
2013 if (std::get<0>(GetFoundationSlope(tile)) == SLOPE_FLAT && EnsureNoVehicleOnGround(tile).Succeeded() && Chance16(1, 40)) {
2014 StartRoadWorks(tile);
2016 if (_settings_client.sound.ambient) SndPlayTileFx(SND_21_ROAD_WORKS, tile);
2017 CreateEffectVehicleAbove(
2018 TileX(tile) * TILE_SIZE + 7,
2019 TileY(tile) * TILE_SIZE + 7,
2021 EV_BULLDOZER);
2022 MarkTileDirtyByTile(tile);
2023 return;
2029 /* Adjust road ground type depending on 'grp' (grp is the distance to the center) */
2030 const Roadside *new_rs = (_settings_game.game_creation.landscape == LT_TOYLAND) ? _town_road_types_2[grp] : _town_road_types[grp];
2031 Roadside cur_rs = GetRoadside(tile);
2033 /* We have our desired type, do nothing */
2034 if (cur_rs == new_rs[0]) return;
2036 /* We have the pre-type of the desired type, switch to the desired type */
2037 if (cur_rs == new_rs[1]) {
2038 cur_rs = new_rs[0];
2039 /* We have barren land, install the pre-type */
2040 } else if (cur_rs == ROADSIDE_BARREN) {
2041 cur_rs = new_rs[1];
2042 /* We're totally off limits, remove any installation and make barren land */
2043 } else {
2044 cur_rs = ROADSIDE_BARREN;
2046 SetRoadside(tile, cur_rs);
2047 MarkTileDirtyByTile(tile);
2049 } else if (IncreaseRoadWorksCounter(tile)) {
2050 TerminateRoadWorks(tile);
2052 if (_settings_game.economy.mod_road_rebuild) {
2053 /* Generate a nicer town surface */
2054 const RoadBits old_rb = GetAnyRoadBits(tile, RTT_ROAD);
2055 const RoadBits new_rb = CleanUpRoadBits(tile, old_rb);
2057 if (old_rb != new_rb) {
2058 RemoveRoad(tile, DC_EXEC | DC_AUTO | DC_NO_WATER, (old_rb ^ new_rb), RTT_ROAD, true);
2060 /* If new_rb is 0, there are now no road pieces left and the tile is no longer a road tile */
2061 if (new_rb == 0) {
2062 MarkTileDirtyByTile(tile);
2063 return;
2068 /* Possibly change road type */
2069 if (GetRoadOwner(tile, RTT_ROAD) == OWNER_TOWN) {
2070 RoadType rt = GetTownRoadType();
2071 if (rt != GetRoadTypeRoad(tile)) {
2072 SetRoadType(tile, RTT_ROAD, rt);
2076 MarkTileDirtyByTile(tile);
2080 static bool ClickTile_Road(TileIndex tile)
2082 if (!IsRoadDepot(tile)) return false;
2084 ShowDepotWindow(tile, VEH_ROAD);
2085 return true;
2088 /* Converts RoadBits to TrackBits */
2089 static const TrackBits _road_trackbits[16] = {
2090 TRACK_BIT_NONE, // ROAD_NONE
2091 TRACK_BIT_NONE, // ROAD_NW
2092 TRACK_BIT_NONE, // ROAD_SW
2093 TRACK_BIT_LEFT, // ROAD_W
2094 TRACK_BIT_NONE, // ROAD_SE
2095 TRACK_BIT_Y, // ROAD_Y
2096 TRACK_BIT_LOWER, // ROAD_S
2097 TRACK_BIT_LEFT | TRACK_BIT_LOWER | TRACK_BIT_Y, // ROAD_Y | ROAD_SW
2098 TRACK_BIT_NONE, // ROAD_NE
2099 TRACK_BIT_UPPER, // ROAD_N
2100 TRACK_BIT_X, // ROAD_X
2101 TRACK_BIT_LEFT | TRACK_BIT_UPPER | TRACK_BIT_X, // ROAD_X | ROAD_NW
2102 TRACK_BIT_RIGHT, // ROAD_E
2103 TRACK_BIT_RIGHT | TRACK_BIT_UPPER | TRACK_BIT_Y, // ROAD_Y | ROAD_NE
2104 TRACK_BIT_RIGHT | TRACK_BIT_LOWER | TRACK_BIT_X, // ROAD_X | ROAD_SE
2105 TRACK_BIT_ALL, // ROAD_ALL
2108 static TrackStatus GetTileTrackStatus_Road(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
2110 TrackdirBits trackdirbits = TRACKDIR_BIT_NONE;
2111 TrackdirBits red_signals = TRACKDIR_BIT_NONE; // crossing barred
2112 switch (mode) {
2113 case TRANSPORT_RAIL:
2114 if (IsLevelCrossing(tile)) trackdirbits = TrackBitsToTrackdirBits(GetCrossingRailBits(tile));
2115 break;
2117 case TRANSPORT_ROAD: {
2118 RoadTramType rtt = (RoadTramType)sub_mode;
2119 if (!HasTileRoadType(tile, rtt)) break;
2120 switch (GetRoadTileType(tile)) {
2121 case ROAD_TILE_NORMAL: {
2122 const uint drd_to_multiplier[DRD_END] = { 0x101, 0x100, 0x1, 0x0 };
2123 RoadBits bits = GetRoadBits(tile, rtt);
2125 /* no roadbit at this side of tile, return 0 */
2126 if (side != INVALID_DIAGDIR && (DiagDirToRoadBits(side) & bits) == 0) break;
2128 uint multiplier = drd_to_multiplier[(rtt == RTT_TRAM) ? DRD_NONE : GetDisallowedRoadDirections(tile)];
2129 if (!HasRoadWorks(tile)) trackdirbits = (TrackdirBits)(_road_trackbits[bits] * multiplier);
2130 break;
2133 case ROAD_TILE_CROSSING: {
2134 Axis axis = GetCrossingRoadAxis(tile);
2136 if (side != INVALID_DIAGDIR && axis != DiagDirToAxis(side)) break;
2138 trackdirbits = TrackBitsToTrackdirBits(AxisToTrackBits(axis));
2139 if (IsCrossingBarred(tile)) {
2140 red_signals = trackdirbits;
2141 if (TrainOnCrossing(tile)) break;
2143 auto mask_red_signal_bits_if_crossing_barred = [&](TileIndex t, TrackdirBits mask) {
2144 if (IsLevelCrossingTile(t) && IsCrossingBarred(t)) red_signals &= mask;
2146 /* Check for blocked adjacent crossing to south, keep only southbound red signal trackdirs, allow northbound traffic */
2147 mask_red_signal_bits_if_crossing_barred(TileAddByDiagDir(tile, AxisToDiagDir(axis)), TRACKDIR_BIT_X_SW | TRACKDIR_BIT_Y_SE);
2148 /* Check for blocked adjacent crossing to north, keep only northbound red signal trackdirs, allow southbound traffic */
2149 mask_red_signal_bits_if_crossing_barred(TileAddByDiagDir(tile, ReverseDiagDir(AxisToDiagDir(axis))), TRACKDIR_BIT_X_NE | TRACKDIR_BIT_Y_NW);
2151 break;
2154 default:
2155 case ROAD_TILE_DEPOT: {
2156 DiagDirection dir = GetRoadDepotDirection(tile);
2158 if (side != INVALID_DIAGDIR && side != dir) break;
2160 trackdirbits = TrackBitsToTrackdirBits(DiagDirToDiagTrackBits(dir));
2161 break;
2164 break;
2167 default: break;
2169 return CombineTrackStatus(trackdirbits, red_signals);
2172 static const StringID _road_tile_strings[] = {
2173 STR_LAI_ROAD_DESCRIPTION_ROAD,
2174 STR_LAI_ROAD_DESCRIPTION_ROAD,
2175 STR_LAI_ROAD_DESCRIPTION_ROAD,
2176 STR_LAI_ROAD_DESCRIPTION_ROAD_WITH_STREETLIGHTS,
2177 STR_LAI_ROAD_DESCRIPTION_ROAD,
2178 STR_LAI_ROAD_DESCRIPTION_TREE_LINED_ROAD,
2179 STR_LAI_ROAD_DESCRIPTION_ROAD,
2180 STR_LAI_ROAD_DESCRIPTION_ROAD,
2183 static void GetTileDesc_Road(TileIndex tile, TileDesc *td)
2185 Owner rail_owner = INVALID_OWNER;
2186 Owner road_owner = INVALID_OWNER;
2187 Owner tram_owner = INVALID_OWNER;
2189 RoadType road_rt = GetRoadTypeRoad(tile);
2190 RoadType tram_rt = GetRoadTypeTram(tile);
2191 if (road_rt != INVALID_ROADTYPE) {
2192 const RoadTypeInfo *rti = GetRoadTypeInfo(road_rt);
2193 td->roadtype = rti->strings.name;
2194 td->road_speed = rti->max_speed / 2;
2195 road_owner = GetRoadOwner(tile, RTT_ROAD);
2197 if (tram_rt != INVALID_ROADTYPE) {
2198 const RoadTypeInfo *rti = GetRoadTypeInfo(tram_rt);
2199 td->tramtype = rti->strings.name;
2200 td->tram_speed = rti->max_speed / 2;
2201 tram_owner = GetRoadOwner(tile, RTT_TRAM);
2204 switch (GetRoadTileType(tile)) {
2205 case ROAD_TILE_CROSSING: {
2206 td->str = STR_LAI_ROAD_DESCRIPTION_ROAD_RAIL_LEVEL_CROSSING;
2207 rail_owner = GetTileOwner(tile);
2209 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
2210 td->railtype = rti->strings.name;
2211 td->rail_speed = rti->max_speed;
2213 break;
2216 case ROAD_TILE_DEPOT:
2217 td->str = STR_LAI_ROAD_DESCRIPTION_ROAD_VEHICLE_DEPOT;
2218 td->build_date = Depot::GetByTile(tile)->build_date;
2219 break;
2221 default: {
2222 td->str = (road_rt != INVALID_ROADTYPE ? _road_tile_strings[GetRoadside(tile)] : STR_LAI_ROAD_DESCRIPTION_TRAMWAY);
2223 break;
2227 /* Now we have to discover, if the tile has only one owner or many:
2228 * - Find a first_owner of the tile. (Currently road or tram must be present, but this will break when the third type becomes available)
2229 * - Compare the found owner with the other owners, and test if they differ.
2230 * Note: If road exists it will be the first_owner.
2232 Owner first_owner = (road_owner == INVALID_OWNER ? tram_owner : road_owner);
2233 bool mixed_owners = (tram_owner != INVALID_OWNER && tram_owner != first_owner) || (rail_owner != INVALID_OWNER && rail_owner != first_owner);
2235 if (mixed_owners) {
2236 /* Multiple owners */
2237 td->owner_type[0] = (rail_owner == INVALID_OWNER ? STR_NULL : STR_LAND_AREA_INFORMATION_RAIL_OWNER);
2238 td->owner[0] = rail_owner;
2239 td->owner_type[1] = (road_owner == INVALID_OWNER ? STR_NULL : STR_LAND_AREA_INFORMATION_ROAD_OWNER);
2240 td->owner[1] = road_owner;
2241 td->owner_type[2] = (tram_owner == INVALID_OWNER ? STR_NULL : STR_LAND_AREA_INFORMATION_TRAM_OWNER);
2242 td->owner[2] = tram_owner;
2243 } else {
2244 /* One to rule them all */
2245 td->owner[0] = first_owner;
2250 * Given the direction the road depot is pointing, this is the direction the
2251 * vehicle should be travelling in in order to enter the depot.
2253 static const uint8_t _roadveh_enter_depot_dir[4] = {
2254 TRACKDIR_X_SW, TRACKDIR_Y_NW, TRACKDIR_X_NE, TRACKDIR_Y_SE
2257 static VehicleEnterTileStatus VehicleEnter_Road(Vehicle *v, TileIndex tile, int, int)
2259 switch (GetRoadTileType(tile)) {
2260 case ROAD_TILE_DEPOT: {
2261 if (v->type != VEH_ROAD) break;
2263 RoadVehicle *rv = RoadVehicle::From(v);
2264 if (rv->frame == RVC_DEPOT_STOP_FRAME &&
2265 _roadveh_enter_depot_dir[GetRoadDepotDirection(tile)] == rv->state) {
2266 rv->state = RVSB_IN_DEPOT;
2267 rv->vehstatus |= VS_HIDDEN;
2268 rv->direction = ReverseDir(rv->direction);
2269 if (rv->Next() == nullptr) VehicleEnterDepot(rv->First());
2270 rv->tile = tile;
2272 InvalidateWindowData(WC_VEHICLE_DEPOT, rv->tile);
2273 return VETSB_ENTERED_WORMHOLE;
2275 break;
2278 default: break;
2280 return VETSB_CONTINUE;
2284 static void ChangeTileOwner_Road(TileIndex tile, Owner old_owner, Owner new_owner)
2286 if (IsRoadDepot(tile)) {
2287 if (GetTileOwner(tile) == old_owner) {
2288 if (new_owner == INVALID_OWNER) {
2289 Command<CMD_LANDSCAPE_CLEAR>::Do(DC_EXEC | DC_BANKRUPT, tile);
2290 } else {
2291 /* A road depot has two road bits. No need to dirty windows here, we'll redraw the whole screen anyway. */
2292 RoadType rt = GetRoadTypeRoad(tile);
2293 if (rt == INVALID_ROADTYPE) rt = GetRoadTypeTram(tile);
2294 Company::Get(old_owner)->infrastructure.road[rt] -= 2;
2295 Company::Get(new_owner)->infrastructure.road[rt] += 2;
2297 SetTileOwner(tile, new_owner);
2298 for (RoadTramType rtt : _roadtramtypes) {
2299 if (GetRoadOwner(tile, rtt) == old_owner) {
2300 SetRoadOwner(tile, rtt, new_owner);
2305 return;
2308 for (RoadTramType rtt : _roadtramtypes) {
2309 /* Update all roadtypes, no matter if they are present */
2310 if (GetRoadOwner(tile, rtt) == old_owner) {
2311 RoadType rt = GetRoadType(tile, rtt);
2312 if (rt != INVALID_ROADTYPE) {
2313 /* A level crossing has two road bits. No need to dirty windows here, we'll redraw the whole screen anyway. */
2314 uint num_bits = IsLevelCrossing(tile) ? 2 : CountBits(GetRoadBits(tile, rtt));
2315 Company::Get(old_owner)->infrastructure.road[rt] -= num_bits;
2316 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.road[rt] += num_bits;
2319 SetRoadOwner(tile, rtt, new_owner == INVALID_OWNER ? OWNER_NONE : new_owner);
2323 if (IsLevelCrossing(tile)) {
2324 if (GetTileOwner(tile) == old_owner) {
2325 if (new_owner == INVALID_OWNER) {
2326 Command<CMD_REMOVE_SINGLE_RAIL>::Do(DC_EXEC | DC_BANKRUPT, tile, GetCrossingRailTrack(tile));
2327 } else {
2328 /* Update infrastructure counts. No need to dirty windows here, we'll redraw the whole screen anyway. */
2329 Company::Get(old_owner)->infrastructure.rail[GetRailType(tile)] -= LEVELCROSSING_TRACKBIT_FACTOR;
2330 Company::Get(new_owner)->infrastructure.rail[GetRailType(tile)] += LEVELCROSSING_TRACKBIT_FACTOR;
2332 SetTileOwner(tile, new_owner);
2338 static CommandCost TerraformTile_Road(TileIndex tile, DoCommandFlag flags, int z_new, Slope tileh_new)
2340 if (_settings_game.construction.build_on_slopes && AutoslopeEnabled()) {
2341 switch (GetRoadTileType(tile)) {
2342 case ROAD_TILE_CROSSING:
2343 if (!IsSteepSlope(tileh_new) && (GetTileMaxZ(tile) == z_new + GetSlopeMaxZ(tileh_new)) && HasBit(VALID_LEVEL_CROSSING_SLOPES, tileh_new)) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
2344 break;
2346 case ROAD_TILE_DEPOT:
2347 if (AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, GetRoadDepotDirection(tile))) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
2348 break;
2350 case ROAD_TILE_NORMAL: {
2351 RoadBits bits = GetAllRoadBits(tile);
2352 RoadBits bits_copy = bits;
2353 /* Check if the slope-road_bits combination is valid at all, i.e. it is safe to call GetRoadFoundation(). */
2354 if (CheckRoadSlope(tileh_new, &bits_copy, ROAD_NONE, ROAD_NONE).Succeeded()) {
2355 /* CheckRoadSlope() sometimes changes the road_bits, if it does not agree with them. */
2356 if (bits == bits_copy) {
2357 auto [tileh_old, z_old] = GetTileSlopeZ(tile);
2359 /* Get the slope on top of the foundation */
2360 z_old += ApplyFoundationToSlope(GetRoadFoundation(tileh_old, bits), tileh_old);
2361 z_new += ApplyFoundationToSlope(GetRoadFoundation(tileh_new, bits), tileh_new);
2363 /* The surface slope must not be changed */
2364 if ((z_old == z_new) && (tileh_old == tileh_new)) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
2367 break;
2370 default: NOT_REACHED();
2374 return Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
2377 /** Update power of road vehicle under which is the roadtype being converted */
2378 static Vehicle *UpdateRoadVehPowerProc(Vehicle *v, void *data)
2380 if (v->type != VEH_ROAD) return nullptr;
2382 RoadVehicleList *affected_rvs = static_cast<RoadVehicleList*>(data);
2383 include(*affected_rvs, RoadVehicle::From(v)->First());
2385 return nullptr;
2389 * Checks the tile and returns whether the current player is allowed to convert the roadtype to another roadtype without taking ownership
2390 * @param owner the tile owner.
2391 * @param rtt Road/tram type.
2392 * @return whether the road is convertible
2394 static bool CanConvertUnownedRoadType(Owner owner, RoadTramType rtt)
2396 return (owner == OWNER_NONE || (owner == OWNER_TOWN && rtt == RTT_ROAD));
2400 * Convert the ownership of the RoadType of the tile if applicable
2401 * @param tile the tile of which convert ownership
2402 * @param num_pieces the count of the roadbits to assign to the new owner
2403 * @param owner the current owner of the RoadType
2404 * @param from_type the old road type
2405 * @param to_type the new road type
2407 static void ConvertRoadTypeOwner(TileIndex tile, uint num_pieces, Owner owner, RoadType from_type, RoadType to_type)
2409 // Scenario editor, maybe? Don't touch the owners when converting roadtypes...
2410 if (_current_company >= MAX_COMPANIES) return;
2412 // We can't get a company from invalid owners but we can get ownership of roads without an owner
2413 if (owner >= MAX_COMPANIES && owner != OWNER_NONE) return;
2415 Company *c;
2417 switch (owner) {
2418 case OWNER_NONE:
2419 SetRoadOwner(tile, GetRoadTramType(to_type), (Owner)_current_company);
2420 UpdateCompanyRoadInfrastructure(to_type, _current_company, num_pieces);
2421 break;
2423 default:
2424 c = Company::Get(owner);
2425 c->infrastructure.road[from_type] -= num_pieces;
2426 c->infrastructure.road[to_type] += num_pieces;
2427 DirtyCompanyInfrastructureWindows(c->index);
2428 break;
2433 * Convert one road subtype to another.
2434 * Not meant to convert from road to tram.
2436 * @param flags operation to perform
2437 * @param tile end tile of road conversion drag
2438 * @param area_start start tile of drag
2439 * @param to_type new roadtype to convert to.
2440 * @return the cost of this operation or an error
2442 CommandCost CmdConvertRoad(DoCommandFlag flags, TileIndex tile, TileIndex area_start, RoadType to_type)
2444 TileIndex area_end = tile;
2446 if (!ValParamRoadType(to_type)) return CMD_ERROR;
2447 if (area_start >= Map::Size()) return CMD_ERROR;
2449 RoadVehicleList affected_rvs;
2450 RoadTramType rtt = GetRoadTramType(to_type);
2452 CommandCost cost(EXPENSES_CONSTRUCTION);
2453 CommandCost error = CommandCost((rtt == RTT_TRAM) ? STR_ERROR_NO_SUITABLE_TRAMWAY : STR_ERROR_NO_SUITABLE_ROAD); // by default, there is no road to convert.
2454 bool found_convertible_road = false; // whether we actually did convert any road/tram (see bug #7633)
2456 std::unique_ptr<TileIterator> iter = std::make_unique<OrthogonalTileIterator>(area_start, area_end);
2457 for (; (tile = *iter) != INVALID_TILE; ++(*iter)) {
2458 /* Is road present on tile? */
2459 if (!MayHaveRoad(tile)) continue;
2461 /* Converting to the same subtype? */
2462 RoadType from_type = GetRoadType(tile, rtt);
2463 if (from_type == INVALID_ROADTYPE || from_type == to_type) continue;
2465 /* Check if there is any infrastructure on tile */
2466 TileType tt = GetTileType(tile);
2467 switch (tt) {
2468 case MP_STATION:
2469 if (!IsAnyRoadStop(tile)) continue;
2470 break;
2471 case MP_ROAD:
2472 if (IsLevelCrossing(tile) && RoadNoLevelCrossing(to_type)) {
2473 error.MakeError(STR_ERROR_CROSSING_DISALLOWED_ROAD);
2474 continue;
2476 break;
2477 case MP_TUNNELBRIDGE:
2478 if (GetTunnelBridgeTransportType(tile) != TRANSPORT_ROAD) continue;
2479 break;
2480 default: continue;
2483 /* Trying to convert other's road */
2484 Owner owner = GetRoadOwner(tile, rtt);
2485 if (!CanConvertUnownedRoadType(owner, rtt)) {
2486 CommandCost ret = CheckOwnership(owner, tile);
2487 if (ret.Failed()) {
2488 error = ret;
2489 continue;
2493 /* Base the ability to replace town roads and bridges on the town's
2494 * acceptance of destructive actions. */
2495 if (owner == OWNER_TOWN) {
2496 Town *t = ClosestTownFromTile(tile, _settings_game.economy.dist_local_authority);
2497 CommandCost ret = CheckforTownRating(DC_NONE, t, tt == MP_TUNNELBRIDGE ? TUNNELBRIDGE_REMOVE : ROAD_REMOVE);
2498 if (ret.Failed()) {
2499 error = ret;
2500 continue;
2504 /* Vehicle on the tile when not converting normal <-> powered
2505 * Tunnels and bridges have special check later */
2506 if (tt != MP_TUNNELBRIDGE) {
2507 if (!HasPowerOnRoad(from_type, to_type)) {
2508 CommandCost ret = EnsureNoVehicleOnGround(tile);
2509 if (ret.Failed()) {
2510 error = ret;
2511 continue;
2514 if (rtt == RTT_ROAD && owner == OWNER_TOWN) {
2515 SetDParamsForOwnedBy(OWNER_TOWN, tile);
2516 error.MakeError(STR_ERROR_OWNED_BY);
2517 continue;
2521 uint num_pieces = CountBits(GetAnyRoadBits(tile, rtt));
2522 if (tt == MP_STATION && IsBayRoadStopTile(tile)) {
2523 num_pieces *= ROAD_STOP_TRACKBIT_FACTOR;
2524 } else if (tt == MP_ROAD && IsRoadDepot(tile)) {
2525 num_pieces *= ROAD_DEPOT_TRACKBIT_FACTOR;
2528 found_convertible_road = true;
2529 cost.AddCost(num_pieces * RoadConvertCost(from_type, to_type));
2531 if (flags & DC_EXEC) { // we can safely convert, too
2532 /* Call ConvertRoadTypeOwner() to update the company infrastructure counters. */
2533 if (owner == _current_company) {
2534 ConvertRoadTypeOwner(tile, num_pieces, owner, from_type, to_type);
2537 /* Perform the conversion */
2538 SetRoadType(tile, rtt, to_type);
2539 MarkTileDirtyByTile(tile);
2541 /* update power of train on this tile */
2542 FindVehicleOnPos(tile, &affected_rvs, &UpdateRoadVehPowerProc);
2544 if (IsRoadDepotTile(tile)) {
2545 /* Update build vehicle window related to this depot */
2546 InvalidateWindowData(WC_VEHICLE_DEPOT, tile);
2547 InvalidateWindowData(WC_BUILD_VEHICLE, tile);
2550 } else {
2551 TileIndex endtile = GetOtherTunnelBridgeEnd(tile);
2553 /* If both ends of tunnel/bridge are in the range, do not try to convert twice -
2554 * it would cause assert because of different test and exec runs */
2555 if (endtile < tile) {
2556 if (OrthogonalTileArea(area_start, area_end).Contains(endtile)) continue;
2559 /* When not converting rail <-> el. rail, any vehicle cannot be in tunnel/bridge */
2560 if (!HasPowerOnRoad(from_type, to_type)) {
2561 CommandCost ret = TunnelBridgeIsFree(tile, endtile);
2562 if (ret.Failed()) {
2563 error = ret;
2564 continue;
2567 if (rtt == RTT_ROAD && owner == OWNER_TOWN) {
2568 SetDParamsForOwnedBy(OWNER_TOWN, tile);
2569 error.MakeError(STR_ERROR_OWNED_BY);
2570 continue;
2574 /* There are 2 pieces on *every* tile of the bridge or tunnel */
2575 uint num_pieces = (GetTunnelBridgeLength(tile, endtile) + 2) * 2;
2576 found_convertible_road = true;
2577 cost.AddCost(num_pieces * RoadConvertCost(from_type, to_type));
2579 if (flags & DC_EXEC) {
2580 /* Update the company infrastructure counters. */
2581 if (owner == _current_company) {
2582 /* Each piece should be counted TUNNELBRIDGE_TRACKBIT_FACTOR times
2583 * for the infrastructure counters (cause of #8297). */
2584 ConvertRoadTypeOwner(tile, num_pieces * TUNNELBRIDGE_TRACKBIT_FACTOR, owner, from_type, to_type);
2585 SetTunnelBridgeOwner(tile, endtile, _current_company);
2588 /* Perform the conversion */
2589 SetRoadType(tile, rtt, to_type);
2590 SetRoadType(endtile, rtt, to_type);
2592 FindVehicleOnPos(tile, &affected_rvs, &UpdateRoadVehPowerProc);
2593 FindVehicleOnPos(endtile, &affected_rvs, &UpdateRoadVehPowerProc);
2595 if (IsBridge(tile)) {
2596 MarkBridgeDirty(tile);
2597 } else {
2598 MarkTileDirtyByTile(tile);
2599 MarkTileDirtyByTile(endtile);
2605 if (flags & DC_EXEC) {
2606 /* Roadtype changed, update roadvehicles as when entering different track */
2607 for (RoadVehicle *v : affected_rvs) {
2608 v->CargoChanged();
2612 return found_convertible_road ? cost : error;
2616 /** Tile callback functions for road tiles */
2617 extern const TileTypeProcs _tile_type_road_procs = {
2618 DrawTile_Road, // draw_tile_proc
2619 GetSlopePixelZ_Road, // get_slope_z_proc
2620 ClearTile_Road, // clear_tile_proc
2621 nullptr, // add_accepted_cargo_proc
2622 GetTileDesc_Road, // get_tile_desc_proc
2623 GetTileTrackStatus_Road, // get_tile_track_status_proc
2624 ClickTile_Road, // click_tile_proc
2625 nullptr, // animate_tile_proc
2626 TileLoop_Road, // tile_loop_proc
2627 ChangeTileOwner_Road, // change_tile_owner_proc
2628 nullptr, // add_produced_cargo_proc
2629 VehicleEnter_Road, // vehicle_enter_tile_proc
2630 GetFoundation_Road, // get_foundation_proc
2631 TerraformTile_Road, // terraform_tile_proc