?  search:
summary | log | graphiclog1 | graphiclog2 | commit | commitdiff | tree | refs | edit | fork
blame | history | raw | HEAD
Fix: Violation of strict weak ordering in engine name sorter
[openttd-github.git] / src / road_cmd.cpp
blob5a9efb85678d00f6e5ac43653aa36c98e6c81857
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 */
7
8 /** @file road_cmd.cpp Commands related to road tiles. */
9
10 #include "stdafx.h"
11 #include "cmd_helper.h"
12 #include "road.h"
13 #include "road_internal.h"
14 #include "viewport_func.h"
15 #include "command_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 "town.h"
31 #include "company_base.h"
32 #include "core/random_func.hpp"
33 #include "newgrf_debug.h"
34 #include "newgrf_railtype.h"
35 #include "newgrf_roadtype.h"
36 #include "date_func.h"
37 #include "genworld.h"
38 #include "company_gui.h"
39 #include "road_func.h"
40
41 #include "table/strings.h"
42 #include "table/roadtypes.h"
43
44 #include "safeguards.h"
45
46 /** Helper type for lists/vectors of road vehicles */
47 typedef std::vector<RoadVehicle *> RoadVehicleList;
48
49 RoadTypeInfo _roadtypes[ROADTYPE_END];
50 std::vector<RoadType> _sorted_roadtypes;
51 RoadTypes _roadtypes_hidden_mask;
52
53 /**
54 * Bitmap of road/tram types.
55 * Bit if set if a roadtype is tram.
56 */
57 RoadTypes _roadtypes_type;
58
59 /**
60 * Reset all road type information to its default values.
61 */
62 void ResetRoadTypes()
63 {
64 assert_compile(lengthof(_original_roadtypes) <= lengthof(_roadtypes));
65
66 uint i = 0;
67 for (; i < lengthof(_original_roadtypes); i++) _roadtypes[i] = _original_roadtypes[i];
68
69 static const RoadTypeInfo empty_roadtype = {
70 { 0, 0, 0, 0, 0, 0 },
71 { 0, 0, 0, 0, 0, 0 },
72 { 0, 0, 0, 0, 0, 0, 0, 0, 0, {}, {}, 0, {}, {} },
73 ROADTYPES_NONE, ROTFB_NONE, 0, 0, 0, 0,
74 RoadTypeLabelList(), 0, 0, ROADTYPES_NONE, ROADTYPES_NONE, 0,
75 {}, {} };
76 for (; i < lengthof(_roadtypes); i++) _roadtypes[i] = empty_roadtype;
77
78 _roadtypes_hidden_mask = ROADTYPES_NONE;
79 _roadtypes_type = ROADTYPES_TRAM;
80 }
81
82 void ResolveRoadTypeGUISprites(RoadTypeInfo *rti)
83 {
84 SpriteID cursors_base = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_CURSORS);
85 if (cursors_base != 0) {
86 rti->gui_sprites.build_y_road = cursors_base + 0;
87 rti->gui_sprites.build_x_road = cursors_base + 1;
88 rti->gui_sprites.auto_road = cursors_base + 2;
89 rti->gui_sprites.build_depot = cursors_base + 3;
90 rti->gui_sprites.build_tunnel = cursors_base + 4;
91 rti->gui_sprites.convert_road = cursors_base + 5;
92 rti->cursor.road_swne = cursors_base + 6;
93 rti->cursor.road_nwse = cursors_base + 7;
94 rti->cursor.autoroad = cursors_base + 8;
95 rti->cursor.depot = cursors_base + 9;
96 rti->cursor.tunnel = cursors_base + 10;
97 rti->cursor.convert_road = cursors_base + 11;
98 }
99 }
100
101 /**
102 * Compare roadtypes based on their sorting order.
103 * @param first The roadtype to compare to.
104 * @param second The roadtype to compare.
105 * @return True iff the first should be sorted before the second.
106 */
107 static bool CompareRoadTypes(const RoadType &first, const RoadType &second)
108 {
109 if (RoadTypeIsRoad(first) == RoadTypeIsRoad(second)) {
110 return GetRoadTypeInfo(first)->sorting_order < GetRoadTypeInfo(second)->sorting_order;
111 }
112 return RoadTypeIsTram(first) < RoadTypeIsTram(second);
113 }
114
115 /**
116 * Resolve sprites of custom road types
117 */
118 void InitRoadTypes()
119 {
120 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
121 RoadTypeInfo *rti = &_roadtypes[rt];
122 ResolveRoadTypeGUISprites(rti);
123 if (HasBit(rti->flags, ROTF_HIDDEN)) SetBit(_roadtypes_hidden_mask, rt);
124 }
125
126 _sorted_roadtypes.clear();
127 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
128 if (_roadtypes[rt].label != 0 && !HasBit(_roadtypes_hidden_mask, rt)) {
129 _sorted_roadtypes.push_back(rt);
130 }
131 }
132 std::sort(_sorted_roadtypes.begin(), _sorted_roadtypes.end(), CompareRoadTypes);
133 }
134
135 /**
136 * Allocate a new road type label
137 */
138 RoadType AllocateRoadType(RoadTypeLabel label, RoadTramType rtt)
139 {
140 for (RoadType rt = ROADTYPE_BEGIN; rt != ROADTYPE_END; rt++) {
141 RoadTypeInfo *rti = &_roadtypes[rt];
142
143 if (rti->label == 0) {
144 /* Set up new road type */
145 *rti = _original_roadtypes[(rtt == RTT_TRAM) ? ROADTYPE_TRAM : ROADTYPE_ROAD];
146 rti->label = label;
147 rti->alternate_labels.clear();
148 rti->flags = ROTFB_NONE;
149 rti->introduction_date = INVALID_DATE;
150
151 /* Make us compatible with ourself. */
152 rti->powered_roadtypes = (RoadTypes)(1ULL << rt);
153
154 /* We also introduce ourself. */
155 rti->introduces_roadtypes = (RoadTypes)(1ULL << rt);
156
157 /* Default sort order; order of allocation, but with some
158 * offsets so it's easier for NewGRF to pick a spot without
159 * changing the order of other (original) road types.
160 * The << is so you can place other roadtypes in between the
161 * other roadtypes, the 7 is to be able to place something
162 * before the first (default) road type. */
163 rti->sorting_order = rt << 2 | 7;
164
165 /* Set bitmap of road/tram types */
166 if (rtt == RTT_TRAM) {
167 SetBit(_roadtypes_type, rt);
168 } else {
169 ClrBit(_roadtypes_type, rt);
170 }
171
172 return rt;
173 }
174 }
175
176 return INVALID_ROADTYPE;
177 }
178
179 /**
180 * Verify whether a road vehicle is available.
181 * @return \c true if at least one road vehicle is available, \c false if not
182 */
183 bool RoadVehiclesAreBuilt()
184 {
185 return !RoadVehicle::Iterate().empty();
186 }
187
188 /**
189 * Update road infrastructure counts for a company.
190 * @param rt Road type to update count of.
191 * @param o Owner of road piece.
192 * @param count Number of road pieces to adjust.
193 */
194 void UpdateCompanyRoadInfrastructure(RoadType rt, Owner o, int count)
195 {
196 if (rt == INVALID_ROADTYPE) return;
197
198 Company *c = Company::GetIfValid(o);
199 if (c == nullptr) return;
200
201 c->infrastructure.road[rt] += count;
202 DirtyCompanyInfrastructureWindows(c->index);
203 }
204
205 /** Invalid RoadBits on slopes. */
206 static const RoadBits _invalid_tileh_slopes_road[2][15] = {
207 /* The inverse of the mixable RoadBits on a leveled slope */
208 {
209 ROAD_NONE, // SLOPE_FLAT
210 ROAD_NE | ROAD_SE, // SLOPE_W
211 ROAD_NE | ROAD_NW, // SLOPE_S
212
213 ROAD_NE, // SLOPE_SW
214 ROAD_NW | ROAD_SW, // SLOPE_E
215 ROAD_NONE, // SLOPE_EW
216
217 ROAD_NW, // SLOPE_SE
218 ROAD_NONE, // SLOPE_WSE
219 ROAD_SE | ROAD_SW, // SLOPE_N
220
221 ROAD_SE, // SLOPE_NW
222 ROAD_NONE, // SLOPE_NS
223 ROAD_NONE, // SLOPE_ENW
224
225 ROAD_SW, // SLOPE_NE
226 ROAD_NONE, // SLOPE_SEN
227 ROAD_NONE // SLOPE_NWS
228 },
229 /* The inverse of the allowed straight roads on a slope
230 * (with and without a foundation). */
231 {
232 ROAD_NONE, // SLOPE_FLAT
233 ROAD_NONE, // SLOPE_W Foundation
234 ROAD_NONE, // SLOPE_S Foundation
235
236 ROAD_Y, // SLOPE_SW
237 ROAD_NONE, // SLOPE_E Foundation
238 ROAD_ALL, // SLOPE_EW
239
240 ROAD_X, // SLOPE_SE
241 ROAD_ALL, // SLOPE_WSE
242 ROAD_NONE, // SLOPE_N Foundation
243
244 ROAD_X, // SLOPE_NW
245 ROAD_ALL, // SLOPE_NS
246 ROAD_ALL, // SLOPE_ENW
247
248 ROAD_Y, // SLOPE_NE
249 ROAD_ALL, // SLOPE_SEN
250 ROAD_ALL // SLOPE_NW
251 }
252 };
253
254 static Foundation GetRoadFoundation(Slope tileh, RoadBits bits);
255
256 /**
257 * Is it allowed to remove the given road bits from the given tile?
258 * @param tile the tile to remove the road from
259 * @param remove the roadbits that are going to be removed
260 * @param owner the actual owner of the roadbits of the tile
261 * @param rt the road type to remove the bits from
262 * @param flags command flags
263 * @param town_check Shall the town rating checked/affected
264 * @return A succeeded command when it is allowed to remove the road bits, a failed command otherwise.
265 */
266 CommandCost CheckAllowRemoveRoad(TileIndex tile, RoadBits remove, Owner owner, RoadTramType rtt, DoCommandFlag flags, bool town_check)
267 {
268 if (_game_mode == GM_EDITOR || remove == ROAD_NONE) return CommandCost();
269
270 /* Water can always flood and towns can always remove "normal" road pieces.
271 * Towns are not be allowed to remove non "normal" road pieces, like tram
272 * tracks as that would result in trams that cannot turn. */
273 if (_current_company == OWNER_WATER ||
274 (rtt == RTT_ROAD && !Company::IsValidID(_current_company))) return CommandCost();
275
276 /* Only do the special processing if the road is owned
277 * by a town */
278 if (owner != OWNER_TOWN) {
279 if (owner == OWNER_NONE) return CommandCost();
280 CommandCost ret = CheckOwnership(owner);
281 return ret;
282 }
283
284 if (!town_check) return CommandCost();
285
286 if (_cheats.magic_bulldozer.value) return CommandCost();
287
288 Town *t = ClosestTownFromTile(tile, UINT_MAX);
289 if (t == nullptr) return CommandCost();
290
291 /* check if you're allowed to remove the street owned by a town
292 * removal allowance depends on difficulty setting */
293 CommandCost ret = CheckforTownRating(flags, t, ROAD_REMOVE);
294 if (ret.Failed()) return ret;
295
296 /* Get a bitmask of which neighbouring roads has a tile */
297 RoadBits n = ROAD_NONE;
298 RoadBits present = GetAnyRoadBits(tile, rtt);
299 if ((present & ROAD_NE) && (GetAnyRoadBits(TILE_ADDXY(tile, -1, 0), rtt) & ROAD_SW)) n |= ROAD_NE;
300 if ((present & ROAD_SE) && (GetAnyRoadBits(TILE_ADDXY(tile, 0, 1), rtt) & ROAD_NW)) n |= ROAD_SE;
301 if ((present & ROAD_SW) && (GetAnyRoadBits(TILE_ADDXY(tile, 1, 0), rtt) & ROAD_NE)) n |= ROAD_SW;
302 if ((present & ROAD_NW) && (GetAnyRoadBits(TILE_ADDXY(tile, 0, -1), rtt) & ROAD_SE)) n |= ROAD_NW;
303
304 int rating_decrease = RATING_ROAD_DOWN_STEP_EDGE;
305 /* If 0 or 1 bits are set in n, or if no bits that match the bits to remove,
306 * then allow it */
307 if (KillFirstBit(n) != ROAD_NONE && (n & remove) != ROAD_NONE) {
308 /* you can remove all kind of roads with extra dynamite */
309 if (!_settings_game.construction.extra_dynamite) {
310 SetDParam(0, t->index);
311 return_cmd_error(STR_ERROR_LOCAL_AUTHORITY_REFUSES_TO_ALLOW_THIS);
312 }
313 rating_decrease = RATING_ROAD_DOWN_STEP_INNER;
314 }
315 ChangeTownRating(t, rating_decrease, RATING_ROAD_MINIMUM, flags);
316
317 return CommandCost();
318 }
319
320
321 /**
322 * Delete a piece of road.
323 * @param tile tile where to remove road from
324 * @param flags operation to perform
325 * @param pieces roadbits to remove
326 * @param rt roadtype to remove
327 * @param crossing_check should we check if there is a tram track when we are removing road from crossing?
328 * @param town_check should we check if the town allows removal?
329 */
330 static CommandCost RemoveRoad(TileIndex tile, DoCommandFlag flags, RoadBits pieces, RoadTramType rtt, bool crossing_check, bool town_check = true)
331 {
332 assert(pieces != ROAD_NONE);
333
334 RoadType existing_rt = MayHaveRoad(tile) ? GetRoadType(tile, rtt) : INVALID_ROADTYPE;
335 /* The tile doesn't have the given road type */
336 if (existing_rt == INVALID_ROADTYPE) return_cmd_error((rtt == RTT_TRAM) ? STR_ERROR_THERE_IS_NO_TRAMWAY : STR_ERROR_THERE_IS_NO_ROAD);
337
338 switch (GetTileType(tile)) {
339 case MP_ROAD: {
340 CommandCost ret = EnsureNoVehicleOnGround(tile);
341 if (ret.Failed()) return ret;
342 break;
343 }
344
345 case MP_STATION: {
346 if (!IsDriveThroughStopTile(tile)) return CMD_ERROR;
347
348 CommandCost ret = EnsureNoVehicleOnGround(tile);
349 if (ret.Failed()) return ret;
350 break;
351 }
352
353 case MP_TUNNELBRIDGE: {
354 if (GetTunnelBridgeTransportType(tile) != TRANSPORT_ROAD) return CMD_ERROR;
355 CommandCost ret = TunnelBridgeIsFree(tile, GetOtherTunnelBridgeEnd(tile));
356 if (ret.Failed()) return ret;
357 break;
358 }
359
360 default:
361 return CMD_ERROR;
362 }
363
364 CommandCost ret = CheckAllowRemoveRoad(tile, pieces, GetRoadOwner(tile, rtt), rtt, flags, town_check);
365 if (ret.Failed()) return ret;
366
367 if (!IsTileType(tile, MP_ROAD)) {
368 /* If it's the last roadtype, just clear the whole tile */
369 if (GetRoadType(tile, OtherRoadTramType(rtt)) == INVALID_ROADTYPE) return DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
370
371 CommandCost cost(EXPENSES_CONSTRUCTION);
372 if (IsTileType(tile, MP_TUNNELBRIDGE)) {
373 /* Removing any roadbit in the bridge axis removes the roadtype (that's the behaviour remove-long-roads needs) */
374 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);
375
376 TileIndex other_end = GetOtherTunnelBridgeEnd(tile);
377 /* Pay for *every* tile of the bridge or tunnel */
378 uint len = GetTunnelBridgeLength(other_end, tile) + 2;
379 cost.AddCost(len * 2 * RoadClearCost(existing_rt));
380 if (flags & DC_EXEC) {
381 /* A full diagonal road tile has two road bits. */
382 UpdateCompanyRoadInfrastructure(existing_rt, GetRoadOwner(tile, rtt), -(int)(len * 2 * TUNNELBRIDGE_TRACKBIT_FACTOR));
383
384 SetRoadType(other_end, rtt, INVALID_ROADTYPE);
385 SetRoadType(tile, rtt, INVALID_ROADTYPE);
386
387 /* If the owner of the bridge sells all its road, also move the ownership
388 * to the owner of the other roadtype, unless the bridge owner is a town. */
389 Owner other_owner = GetRoadOwner(tile, OtherRoadTramType(rtt));
390 if (!IsTileOwner(tile, other_owner) && !IsTileOwner(tile, OWNER_TOWN)) {
391 SetTileOwner(tile, other_owner);
392 SetTileOwner(other_end, other_owner);
393 }
394
395 /* Mark tiles dirty that have been repaved */
396 if (IsBridge(tile)) {
397 MarkBridgeDirty(tile);
398 } else {
399 MarkTileDirtyByTile(tile);
400 MarkTileDirtyByTile(other_end);
401 }
402 }
403 } else {
404 assert(IsDriveThroughStopTile(tile));
405 cost.AddCost(RoadClearCost(existing_rt) * 2);
406 if (flags & DC_EXEC) {
407 /* A full diagonal road tile has two road bits. */
408 UpdateCompanyRoadInfrastructure(existing_rt, GetRoadOwner(tile, rtt), -2);
409 SetRoadType(tile, rtt, INVALID_ROADTYPE);
410 MarkTileDirtyByTile(tile);
411 }
412 }
413 return cost;
414 }
415
416 switch (GetRoadTileType(tile)) {
417 case ROAD_TILE_NORMAL: {
418 Slope tileh = GetTileSlope(tile);
419
420 /* Steep slopes behave the same as slopes with one corner raised. */
421 if (IsSteepSlope(tileh)) {
422 tileh = SlopeWithOneCornerRaised(GetHighestSlopeCorner(tileh));
423 }
424
425 RoadBits present = GetRoadBits(tile, rtt);
426 const RoadBits other = GetRoadBits(tile, OtherRoadTramType(rtt));
427 const Foundation f = GetRoadFoundation(tileh, present);
428
429 if (HasRoadWorks(tile) && _current_company != OWNER_WATER) return_cmd_error(STR_ERROR_ROAD_WORKS_IN_PROGRESS);
430
431 /* Autocomplete to a straight road
432 * @li if the bits of the other roadtypes result in another foundation
433 * @li if build on slopes is disabled */
434 if ((IsStraightRoad(other) && (other & _invalid_tileh_slopes_road[0][tileh & SLOPE_ELEVATED]) != ROAD_NONE) ||
435 (tileh != SLOPE_FLAT && !_settings_game.construction.build_on_slopes)) {
436 pieces |= MirrorRoadBits(pieces);
437 }
438
439 /* limit the bits to delete to the existing bits. */
440 pieces &= present;
441 if (pieces == ROAD_NONE) return_cmd_error((rtt == RTT_TRAM) ? STR_ERROR_THERE_IS_NO_TRAMWAY : STR_ERROR_THERE_IS_NO_ROAD);
442
443 /* Now set present what it will be after the remove */
444 present ^= pieces;
445
446 /* Check for invalid RoadBit combinations on slopes */
447 if (tileh != SLOPE_FLAT && present != ROAD_NONE &&
448 (present & _invalid_tileh_slopes_road[0][tileh & SLOPE_ELEVATED]) == present) {
449 return CMD_ERROR;
450 }
451
452 if (flags & DC_EXEC) {
453 if (HasRoadWorks(tile)) {
454 /* flooding tile with road works, don't forget to remove the effect vehicle too */
455 assert(_current_company == OWNER_WATER);
456 for (EffectVehicle *v : EffectVehicle::Iterate()) {
457 if (TileVirtXY(v->x_pos, v->y_pos) == tile) {
458 delete v;
459 }
460 }
461 }
462
463 UpdateCompanyRoadInfrastructure(existing_rt, GetRoadOwner(tile, rtt), -(int)CountBits(pieces));
464
465 if (present == ROAD_NONE) {
466 /* No other road type, just clear tile. */
467 if (GetRoadType(tile, OtherRoadTramType(rtt)) == INVALID_ROADTYPE) {
468 /* Includes MarkTileDirtyByTile() */
469 DoClearSquare(tile);
470 } else {
471 if (rtt == RTT_ROAD && IsRoadOwner(tile, rtt, OWNER_TOWN)) {
472 /* Update nearest-town index */
473 const Town *town = CalcClosestTownFromTile(tile);
474 SetTownIndex(tile, town == nullptr ? INVALID_TOWN : town->index);
475 }
476 SetRoadBits(tile, ROAD_NONE, rtt);
477 SetRoadType(tile, rtt, INVALID_ROADTYPE);
478 MarkTileDirtyByTile(tile);
479 }
480 } else {
481 /* When bits are removed, you *always* end up with something that
482 * is not a complete straight road tile. However, trams do not have
483 * onewayness, so they cannot remove it either. */
484 if (rtt == RTT_ROAD) SetDisallowedRoadDirections(tile, DRD_NONE);
485 SetRoadBits(tile, present, rtt);
486 MarkTileDirtyByTile(tile);
487 }
488 }
489
490 CommandCost cost(EXPENSES_CONSTRUCTION, CountBits(pieces) * RoadClearCost(existing_rt));
491 /* If we build a foundation we have to pay for it. */
492 if (f == FOUNDATION_NONE && GetRoadFoundation(tileh, present) != FOUNDATION_NONE) cost.AddCost(_price[PR_BUILD_FOUNDATION]);
493
494 return cost;
495 }
496
497 case ROAD_TILE_CROSSING: {
498 if (pieces & ComplementRoadBits(GetCrossingRoadBits(tile))) {
499 return CMD_ERROR;
500 }
501
502 if (flags & DC_EXEC) {
503 /* A full diagonal road tile has two road bits. */
504 UpdateCompanyRoadInfrastructure(existing_rt, GetRoadOwner(tile, rtt), -2);
505
506 Track railtrack = GetCrossingRailTrack(tile);
507 if (GetRoadType(tile, OtherRoadTramType(rtt)) == INVALID_ROADTYPE) {
508 TrackBits tracks = GetCrossingRailBits(tile);
509 bool reserved = HasCrossingReservation(tile);
510 MakeRailNormal(tile, GetTileOwner(tile), tracks, GetRailType(tile));
511 if (reserved) SetTrackReservation(tile, tracks);
512
513 /* Update rail count for level crossings. The plain track should still be accounted
514 * for, so only subtract the difference to the level crossing cost. */
515 Company *c = Company::GetIfValid(GetTileOwner(tile));
516 if (c != nullptr) {
517 c->infrastructure.rail[GetRailType(tile)] -= LEVELCROSSING_TRACKBIT_FACTOR - 1;
518 DirtyCompanyInfrastructureWindows(c->index);
519 }
520 } else {
521 SetRoadType(tile, rtt, INVALID_ROADTYPE);
522 }
523 MarkTileDirtyByTile(tile);
524 YapfNotifyTrackLayoutChange(tile, railtrack);
525 }
526 return CommandCost(EXPENSES_CONSTRUCTION, RoadClearCost(existing_rt) * 2);
527 }
528
529 default:
530 case ROAD_TILE_DEPOT:
531 return CMD_ERROR;
532 }
533 }
534
535
536 /**
537 * Calculate the costs for roads on slopes
538 * Aside modify the RoadBits to fit on the slopes
539 *
540 * @note The RoadBits are modified too!
541 * @param tileh The current slope
542 * @param pieces The RoadBits we want to add
543 * @param existing The existent RoadBits of the current type
544 * @param other The other existent RoadBits
545 * @return The costs for these RoadBits on this slope
546 */
547 static CommandCost CheckRoadSlope(Slope tileh, RoadBits *pieces, RoadBits existing, RoadBits other)
548 {
549 /* Remove already build pieces */
550 CLRBITS(*pieces, existing);
551
552 /* If we can't build anything stop here */
553 if (*pieces == ROAD_NONE) return CMD_ERROR;
554
555 /* All RoadBit combos are valid on flat land */
556 if (tileh == SLOPE_FLAT) return CommandCost();
557
558 /* Steep slopes behave the same as slopes with one corner raised. */
559 if (IsSteepSlope(tileh)) {
560 tileh = SlopeWithOneCornerRaised(GetHighestSlopeCorner(tileh));
561 }
562
563 /* Save the merge of all bits of the current type */
564 RoadBits type_bits = existing | *pieces;
565
566 /* Roads on slopes */
567 if (_settings_game.construction.build_on_slopes && (_invalid_tileh_slopes_road[0][tileh] & (other | type_bits)) == ROAD_NONE) {
568
569 /* If we add leveling we've got to pay for it */
570 if ((other | existing) == ROAD_NONE) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
571
572 return CommandCost();
573 }
574
575 /* Autocomplete uphill roads */
576 *pieces |= MirrorRoadBits(*pieces);
577 type_bits = existing | *pieces;
578
579 /* Uphill roads */
580 if (IsStraightRoad(type_bits) && (other == type_bits || other == ROAD_NONE) &&
581 (_invalid_tileh_slopes_road[1][tileh] & (other | type_bits)) == ROAD_NONE) {
582
583 /* Slopes with foundation ? */
584 if (IsSlopeWithOneCornerRaised(tileh)) {
585
586 /* Prevent build on slopes if it isn't allowed */
587 if (_settings_game.construction.build_on_slopes) {
588
589 /* If we add foundation we've got to pay for it */
590 if ((other | existing) == ROAD_NONE) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
591
592 return CommandCost();
593 }
594 } else {
595 if (HasExactlyOneBit(existing) && GetRoadFoundation(tileh, existing) == FOUNDATION_NONE) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
596 return CommandCost();
597 }
598 }
599 return CMD_ERROR;
600 }
601
602 /**
603 * Build a piece of road.
604 * @param tile tile where to build road
605 * @param flags operation to perform
606 * @param p1 bit 0..3 road pieces to build (RoadBits)
607 * bit 4..9 road type
608 * bit 11..12 disallowed directions to toggle
609 * @param p2 the town that is building the road (0 if not applicable)
610 * @param text unused
611 * @return the cost of this operation or an error
612 */
613 CommandCost CmdBuildRoad(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
614 {
615 CompanyID company = _current_company;
616 CommandCost cost(EXPENSES_CONSTRUCTION);
617
618 RoadBits existing = ROAD_NONE;
619 RoadBits other_bits = ROAD_NONE;
620
621 /* Road pieces are max 4 bitset values (NE, NW, SE, SW) and town can only be non-zero
622 * if a non-company is building the road */
623 if ((Company::IsValidID(company) && p2 != 0) || (company == OWNER_TOWN && !Town::IsValidID(p2)) || (company == OWNER_DEITY && p2 != 0)) return CMD_ERROR;
624 if (company != OWNER_TOWN) {
625 const Town *town = CalcClosestTownFromTile(tile);
626 p2 = (town != nullptr) ? town->index : INVALID_TOWN;
627
628 if (company == OWNER_DEITY) {
629 company = OWNER_TOWN;
630
631 /* If we are not within a town, we are not owned by the town */
632 if (town == nullptr || DistanceSquare(tile, town->xy) > town->cache.squared_town_zone_radius[HZB_TOWN_EDGE]) {
633 company = OWNER_NONE;
634 }
635 }
636 }
637
638 RoadBits pieces = Extract<RoadBits, 0, 4>(p1);
639
640 /* do not allow building 'zero' road bits, code wouldn't handle it */
641 if (pieces == ROAD_NONE) return CMD_ERROR;
642
643 RoadType rt = Extract<RoadType, 4, 6>(p1);
644 if (!ValParamRoadType(rt)) return CMD_ERROR;
645
646 DisallowedRoadDirections toggle_drd = Extract<DisallowedRoadDirections, 11, 2>(p1);
647
648 Slope tileh = GetTileSlope(tile);
649 RoadTramType rtt = GetRoadTramType(rt);
650
651 bool need_to_clear = false;
652 switch (GetTileType(tile)) {
653 case MP_ROAD:
654 switch (GetRoadTileType(tile)) {
655 case ROAD_TILE_NORMAL: {
656 if (HasRoadWorks(tile)) return_cmd_error(STR_ERROR_ROAD_WORKS_IN_PROGRESS);
657
658 other_bits = GetRoadBits(tile, OtherRoadTramType(rtt));
659 if (!HasTileRoadType(tile, rtt)) break;
660
661 existing = GetRoadBits(tile, rtt);
662 bool crossing = !IsStraightRoad(existing | pieces);
663 if (rtt == RTT_ROAD && (GetDisallowedRoadDirections(tile) != DRD_NONE || toggle_drd != DRD_NONE) && crossing) {
664 /* Junctions cannot be one-way */
665 return_cmd_error(STR_ERROR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);
666 }
667 if ((existing & pieces) == pieces) {
668 /* We only want to set the (dis)allowed road directions */
669 if (toggle_drd != DRD_NONE && rtt == RTT_ROAD) {
670 if (crossing) return_cmd_error(STR_ERROR_ONEWAY_ROADS_CAN_T_HAVE_JUNCTION);
671
672 Owner owner = GetRoadOwner(tile, rtt);
673 if (owner != OWNER_NONE) {
674 CommandCost ret = CheckOwnership(owner, tile);
675 if (ret.Failed()) return ret;
676 }
677
678 DisallowedRoadDirections dis_existing = GetDisallowedRoadDirections(tile);
679 DisallowedRoadDirections dis_new = dis_existing ^ toggle_drd;
680
681 /* We allow removing disallowed directions to break up
682 * deadlocks, but adding them can break articulated
683 * vehicles. As such, only when less is disallowed,
684 * i.e. bits are removed, we skip the vehicle check. */
685 if (CountBits(dis_existing) <= CountBits(dis_new)) {
686 CommandCost ret = EnsureNoVehicleOnGround(tile);
687 if (ret.Failed()) return ret;
688 }
689
690 /* Ignore half built tiles */
691 if ((flags & DC_EXEC) && IsStraightRoad(existing)) {
692 SetDisallowedRoadDirections(tile, dis_new);
693 MarkTileDirtyByTile(tile);
694 }
695 return CommandCost();
696 }
697 return_cmd_error(STR_ERROR_ALREADY_BUILT);
698 }
699 /* Disallow breaking end-of-line of someone else
700 * so trams can still reverse on this tile. */
701 if (rtt == RTT_TRAM && HasExactlyOneBit(existing)) {
702 Owner owner = GetRoadOwner(tile, rtt);
703 if (Company::IsValidID(owner)) {
704 CommandCost ret = CheckOwnership(owner);
705 if (ret.Failed()) return ret;
706 }
707 }
708 break;
709 }
710
711 case ROAD_TILE_CROSSING:
712 if (RoadNoLevelCrossing(rt)) {
713 return_cmd_error(STR_ERROR_CROSSING_DISALLOWED_ROAD);
714 }
715
716 other_bits = GetCrossingRoadBits(tile);
717 if (pieces & ComplementRoadBits(other_bits)) goto do_clear;
718 pieces = other_bits; // we need to pay for both roadbits
719
720 if (HasTileRoadType(tile, rtt)) return_cmd_error(STR_ERROR_ALREADY_BUILT);
721 break;
722
723 case ROAD_TILE_DEPOT:
724 if ((GetAnyRoadBits(tile, rtt) & pieces) == pieces) return_cmd_error(STR_ERROR_ALREADY_BUILT);
725 goto do_clear;
726
727 default: NOT_REACHED();
728 }
729 break;
730
731 case MP_RAILWAY: {
732 if (IsSteepSlope(tileh)) {
733 return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
734 }
735
736 /* Level crossings may only be built on these slopes */
737 if (!HasBit(VALID_LEVEL_CROSSING_SLOPES, tileh)) {
738 return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
739 }
740
741 if (GetRailTileType(tile) != RAIL_TILE_NORMAL) goto do_clear;
742
743 if (RoadNoLevelCrossing(rt)) {
744 return_cmd_error(STR_ERROR_CROSSING_DISALLOWED_ROAD);
745 }
746
747 if (RailNoLevelCrossings(GetRailType(tile))) {
748 return_cmd_error(STR_ERROR_CROSSING_DISALLOWED_RAIL);
749 }
750
751 Axis roaddir;
752 switch (GetTrackBits(tile)) {
753 case TRACK_BIT_X:
754 if (pieces & ROAD_X) goto do_clear;
755 roaddir = AXIS_Y;
756 break;
757
758 case TRACK_BIT_Y:
759 if (pieces & ROAD_Y) goto do_clear;
760 roaddir = AXIS_X;
761 break;
762
763 default: goto do_clear;
764 }
765
766 CommandCost ret = EnsureNoVehicleOnGround(tile);
767 if (ret.Failed()) return ret;
768
769 if (flags & DC_EXEC) {
770 Track railtrack = AxisToTrack(OtherAxis(roaddir));
771 YapfNotifyTrackLayoutChange(tile, railtrack);
772 /* Update company infrastructure counts. A level crossing has two road bits. */
773 UpdateCompanyRoadInfrastructure(rt, company, 2);
774
775 /* Update rail count for level crossings. The plain track is already
776 * counted, so only add the difference to the level crossing cost. */
777 Company *c = Company::GetIfValid(GetTileOwner(tile));
778 if (c != nullptr) {
779 c->infrastructure.rail[GetRailType(tile)] += LEVELCROSSING_TRACKBIT_FACTOR - 1;
780 DirtyCompanyInfrastructureWindows(c->index);
781 }
782
783 /* Always add road to the roadtypes (can't draw without it) */
784 bool reserved = HasBit(GetRailReservationTrackBits(tile), railtrack);
785 MakeRoadCrossing(tile, company, company, GetTileOwner(tile), roaddir, GetRailType(tile), rtt == RTT_ROAD ? rt : INVALID_ROADTYPE, (rtt == RTT_TRAM) ? rt : INVALID_ROADTYPE, p2);
786 SetCrossingReservation(tile, reserved);
787 UpdateLevelCrossing(tile, false);
788 MarkTileDirtyByTile(tile);
789 }
790 return CommandCost(EXPENSES_CONSTRUCTION, 2 * RoadBuildCost(rt));
791 }
792
793 case MP_STATION: {
794 if ((GetAnyRoadBits(tile, rtt) & pieces) == pieces) return_cmd_error(STR_ERROR_ALREADY_BUILT);
795 if (!IsDriveThroughStopTile(tile)) goto do_clear;
796
797 RoadBits curbits = AxisToRoadBits(DiagDirToAxis(GetRoadStopDir(tile)));
798 if (pieces & ~curbits) goto do_clear;
799 pieces = curbits; // we need to pay for both roadbits
800
801 if (HasTileRoadType(tile, rtt)) return_cmd_error(STR_ERROR_ALREADY_BUILT);
802 break;
803 }
804
805 case MP_TUNNELBRIDGE: {
806 if (GetTunnelBridgeTransportType(tile) != TRANSPORT_ROAD) goto do_clear;
807 /* Only allow building the outern roadbit, so building long roads stops at existing bridges */
808 if (MirrorRoadBits(DiagDirToRoadBits(GetTunnelBridgeDirection(tile))) != pieces) goto do_clear;
809 if (HasTileRoadType(tile, rtt)) return_cmd_error(STR_ERROR_ALREADY_BUILT);
810 /* Don't allow adding roadtype to the bridge/tunnel when vehicles are already driving on it */
811 CommandCost ret = TunnelBridgeIsFree(tile, GetOtherTunnelBridgeEnd(tile));
812 if (ret.Failed()) return ret;
813 break;
814 }
815
816 default: {
817 do_clear:;
818 need_to_clear = true;
819 break;
820 }
821 }
822
823 if (need_to_clear) {
824 CommandCost ret = DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
825 if (ret.Failed()) return ret;
826 cost.AddCost(ret);
827 }
828
829 if (other_bits != pieces) {
830 /* Check the foundation/slopes when adding road/tram bits */
831 CommandCost ret = CheckRoadSlope(tileh, &pieces, existing, other_bits);
832 /* Return an error if we need to build a foundation (ret != 0) but the
833 * current setting is turned off */
834 if (ret.Failed() || (ret.GetCost() != 0 && !_settings_game.construction.build_on_slopes)) {
835 return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
836 }
837 cost.AddCost(ret);
838 }
839
840 if (!need_to_clear) {
841 if (IsTileType(tile, MP_ROAD)) {
842 /* Don't put the pieces that already exist */
843 pieces &= ComplementRoadBits(existing);
844
845 /* Check if new road bits will have the same foundation as other existing road types */
846 if (IsNormalRoad(tile)) {
847 Slope slope = GetTileSlope(tile);
848 Foundation found_new = GetRoadFoundation(slope, pieces | existing);
849
850 RoadBits bits = GetRoadBits(tile, OtherRoadTramType(rtt));
851 /* do not check if there are not road bits of given type */
852 if (bits != ROAD_NONE && GetRoadFoundation(slope, bits) != found_new) {
853 return_cmd_error(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
854 }
855 }
856 }
857
858 CommandCost ret = EnsureNoVehicleOnGround(tile);
859 if (ret.Failed()) return ret;
860
861 if (IsNormalRoadTile(tile)) {
862 /* If the road types don't match, try to convert only if vehicles of
863 * the new road type are not powered on the present road type and vehicles of
864 * the present road type are powered on the new road type. */
865 RoadType existing_rt = GetRoadType(tile, rtt);
866 if (existing_rt != INVALID_ROADTYPE && existing_rt != rt) {
867 if (HasPowerOnRoad(rt, existing_rt)) {
868 rt = existing_rt;
869 } else if (HasPowerOnRoad(existing_rt, rt)) {
870 CommandCost ret = DoCommand(tile, tile, rt, flags, CMD_CONVERT_ROAD);
871 if (ret.Failed()) return ret;
872 cost.AddCost(ret);
873 } else {
874 return CMD_ERROR;
875 }
876 }
877 }
878 }
879
880 uint num_pieces = (!need_to_clear && IsTileType(tile, MP_TUNNELBRIDGE)) ?
881 /* There are 2 pieces on *every* tile of the bridge or tunnel */
882 2 * (GetTunnelBridgeLength(GetOtherTunnelBridgeEnd(tile), tile) + 2) :
883 /* Count pieces */
884 CountBits(pieces);
885
886 cost.AddCost(num_pieces * RoadBuildCost(rt));
887
888 if (flags & DC_EXEC) {
889 switch (GetTileType(tile)) {
890 case MP_ROAD: {
891 RoadTileType rttype = GetRoadTileType(tile);
892 if (existing == ROAD_NONE || rttype == ROAD_TILE_CROSSING) {
893 SetRoadType(tile, rtt, rt);
894 SetRoadOwner(tile, rtt, company);
895 if (rtt == RTT_ROAD) SetTownIndex(tile, p2);
896 }
897 if (rttype != ROAD_TILE_CROSSING) SetRoadBits(tile, existing | pieces, rtt);
898 break;
899 }
900
901 case MP_TUNNELBRIDGE: {
902 TileIndex other_end = GetOtherTunnelBridgeEnd(tile);
903
904 SetRoadType(other_end, rtt, rt);
905 SetRoadType(tile, rtt, rt);
906 SetRoadOwner(other_end, rtt, company);
907 SetRoadOwner(tile, rtt, company);
908
909 /* Mark tiles dirty that have been repaved */
910 if (IsBridge(tile)) {
911 MarkBridgeDirty(tile);
912 } else {
913 MarkTileDirtyByTile(other_end);
914 MarkTileDirtyByTile(tile);
915 }
916 break;
917 }
918
919 case MP_STATION: {
920 assert(IsDriveThroughStopTile(tile));
921 SetRoadType(tile, rtt, rt);
922 SetRoadOwner(tile, rtt, company);
923 break;
924 }
925
926 default:
927 MakeRoadNormal(tile, pieces, (rtt == RTT_ROAD) ? rt : INVALID_ROADTYPE, (rtt == RTT_TRAM) ? rt : INVALID_ROADTYPE, p2, company, company);
928 break;
929 }
930
931 /* Update company infrastructure count. */
932 if (IsTileType(tile, MP_TUNNELBRIDGE)) num_pieces *= TUNNELBRIDGE_TRACKBIT_FACTOR;
933 UpdateCompanyRoadInfrastructure(rt, GetRoadOwner(tile, rtt), num_pieces);
934
935 if (rtt == RTT_ROAD && IsNormalRoadTile(tile)) {
936 existing |= pieces;
937 SetDisallowedRoadDirections(tile, IsStraightRoad(existing) ?
938 GetDisallowedRoadDirections(tile) ^ toggle_drd : DRD_NONE);
939 }
940
941 MarkTileDirtyByTile(tile);
942 }
943 return cost;
944 }
945
946 /**
947 * Checks whether a road or tram connection can be found when building a new road or tram.
948 * @param tile Tile at which the road being built will end.
949 * @param rt Roadtype of the road being built.
950 * @param dir Direction that the road is following.
951 * @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.
952 */
953 static bool CanConnectToRoad(TileIndex tile, RoadType rt, DiagDirection dir)
954 {
955 tile += TileOffsByDiagDir(dir);
956 if (!IsValidTile(tile) || !MayHaveRoad(tile)) return false;
957
958 RoadTramType rtt = GetRoadTramType(rt);
959 RoadType existing = GetRoadType(tile, rtt);
960 if (existing == INVALID_ROADTYPE) return false;
961 if (!HasPowerOnRoad(existing, rt) && !HasPowerOnRoad(rt, existing)) return false;
962
963 RoadBits bits = GetAnyRoadBits(tile, rtt, false);
964 return (bits & DiagDirToRoadBits(ReverseDiagDir(dir))) != 0;
965 }
966
967 /**
968 * Build a long piece of road.
969 * @param start_tile start tile of drag (the building cost will appear over this tile)
970 * @param flags operation to perform
971 * @param p1 end tile of drag
972 * @param p2 various bitstuffed elements
973 * - p2 = (bit 0) - start tile starts in the 2nd half of tile (p2 & 1). Only used if bit 6 is set or if we are building a single tile
974 * - p2 = (bit 1) - end tile starts in the 2nd half of tile (p2 & 2). Only used if bit 6 is set or if we are building a single tile
975 * - p2 = (bit 2) - direction: 0 = along x-axis, 1 = along y-axis (p2 & 4)
976 * - p2 = (bit 3..8) - road type
977 * - p2 = (bit 10) - set road direction
978 * - p2 = (bit 11) - defines two different behaviors for this command:
979 * - 0 = 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
980 * - 1 = Fail if an obstacle is found. Always take into account bit 0 and 1. This behavior is used for scripts
981 * @param text unused
982 * @return the cost of this operation or an error
983 */
984 CommandCost CmdBuildLongRoad(TileIndex start_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
985 {
986 DisallowedRoadDirections drd = DRD_NORTHBOUND;
987
988 if (p1 >= MapSize()) return CMD_ERROR;
989 TileIndex end_tile = p1;
990
991 RoadType rt = Extract<RoadType, 3, 6>(p2);
992 if (!ValParamRoadType(rt)) return CMD_ERROR;
993
994 Axis axis = Extract<Axis, 2, 1>(p2);
995 /* Only drag in X or Y direction dictated by the direction variable */
996 if (axis == AXIS_X && TileY(start_tile) != TileY(end_tile)) return CMD_ERROR; // x-axis
997 if (axis == AXIS_Y && TileX(start_tile) != TileX(end_tile)) return CMD_ERROR; // y-axis
998
999 DiagDirection dir = AxisToDiagDir(axis);
1000
1001 /* Swap direction, also the half-tile drag var (bit 0 and 1) */
1002 if (start_tile > end_tile || (start_tile == end_tile && HasBit(p2, 0))) {
1003 dir = ReverseDiagDir(dir);
1004 p2 ^= 3;
1005 drd = DRD_SOUTHBOUND;
1006 }
1007
1008 /* On the X-axis, we have to swap the initial bits, so they
1009 * will be interpreted correctly in the GTTS. Furthermore
1010 * when you just 'click' on one tile to build them. */
1011 if ((axis == AXIS_Y) == (start_tile == end_tile && HasBit(p2, 0) == HasBit(p2, 1))) drd ^= DRD_BOTH;
1012 /* No disallowed direction bits have to be toggled */
1013 if (!HasBit(p2, 10)) drd = DRD_NONE;
1014
1015 CommandCost cost(EXPENSES_CONSTRUCTION);
1016 CommandCost last_error = CMD_ERROR;
1017 TileIndex tile = start_tile;
1018 bool had_bridge = false;
1019 bool had_tunnel = false;
1020 bool had_success = false;
1021 bool is_ai = HasBit(p2, 11);
1022
1023 /* Start tile is the first tile clicked by the user. */
1024 for (;;) {
1025 RoadBits bits = AxisToRoadBits(axis);
1026
1027 /* Determine which road parts should be built. */
1028 if (!is_ai && start_tile != end_tile) {
1029 /* Only build the first and last roadbit if they can connect to something. */
1030 if (tile == end_tile && !CanConnectToRoad(tile, rt, dir)) {
1031 bits = DiagDirToRoadBits(ReverseDiagDir(dir));
1032 } else if (tile == start_tile && !CanConnectToRoad(tile, rt, ReverseDiagDir(dir))) {
1033 bits = DiagDirToRoadBits(dir);
1034 }
1035 } else {
1036 /* Road parts only have to be built at the start tile or at the end tile. */
1037 if (tile == end_tile && !HasBit(p2, 1)) bits &= DiagDirToRoadBits(ReverseDiagDir(dir));
1038 if (tile == start_tile && HasBit(p2, 0)) bits &= DiagDirToRoadBits(dir);
1039 }
1040
1041 CommandCost ret = DoCommand(tile, drd << 11 | rt << 4 | bits, 0, flags, CMD_BUILD_ROAD);
1042 if (ret.Failed()) {
1043 last_error = ret;
1044 if (last_error.GetErrorMessage() != STR_ERROR_ALREADY_BUILT) {
1045 if (is_ai) return last_error;
1046 break;
1047 }
1048 } else {
1049 had_success = true;
1050 /* Only pay for the upgrade on one side of the bridges and tunnels */
1051 if (IsTileType(tile, MP_TUNNELBRIDGE)) {
1052 if (IsBridge(tile)) {
1053 if (!had_bridge || GetTunnelBridgeDirection(tile) == dir) {
1054 cost.AddCost(ret);
1055 }
1056 had_bridge = true;
1057 } else { // IsTunnel(tile)
1058 if (!had_tunnel || GetTunnelBridgeDirection(tile) == dir) {
1059 cost.AddCost(ret);
1060 }
1061 had_tunnel = true;
1062 }
1063 } else {
1064 cost.AddCost(ret);
1065 }
1066 }
1067
1068 if (tile == end_tile) break;
1069
1070 tile += TileOffsByDiagDir(dir);
1071 }
1072
1073 return had_success ? cost : last_error;
1074 }
1075
1076 /**
1077 * Remove a long piece of road.
1078 * @param start_tile start tile of drag
1079 * @param flags operation to perform
1080 * @param p1 end tile of drag
1081 * @param p2 various bitstuffed elements
1082 * - p2 = (bit 0) - start tile starts in the 2nd half of tile (p2 & 1)
1083 * - p2 = (bit 1) - end tile starts in the 2nd half of tile (p2 & 2)
1084 * - p2 = (bit 2) - direction: 0 = along x-axis, 1 = along y-axis (p2 & 4)
1085 * - p2 = (bit 3 - 8) - road type
1086 * @param text unused
1087 * @return the cost of this operation or an error
1088 */
1089 CommandCost CmdRemoveLongRoad(TileIndex start_tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1090 {
1091 CommandCost cost(EXPENSES_CONSTRUCTION);
1092
1093 if (p1 >= MapSize()) return CMD_ERROR;
1094
1095 TileIndex end_tile = p1;
1096 RoadType rt = Extract<RoadType, 3, 6>(p2);
1097 if (!ValParamRoadType(rt)) return CMD_ERROR;
1098
1099 Axis axis = Extract<Axis, 2, 1>(p2);
1100 /* Only drag in X or Y direction dictated by the direction variable */
1101 if (axis == AXIS_X && TileY(start_tile) != TileY(end_tile)) return CMD_ERROR; // x-axis
1102 if (axis == AXIS_Y && TileX(start_tile) != TileX(end_tile)) return CMD_ERROR; // y-axis
1103
1104 /* Swap start and ending tile, also the half-tile drag var (bit 0 and 1) */
1105 if (start_tile > end_tile || (start_tile == end_tile && HasBit(p2, 0))) {
1106 TileIndex t = start_tile;
1107 start_tile = end_tile;
1108 end_tile = t;
1109 p2 ^= IsInsideMM(p2 & 3, 1, 3) ? 3 : 0;
1110 }
1111
1112 Money money = GetAvailableMoneyForCommand();
1113 TileIndex tile = start_tile;
1114 CommandCost last_error = CMD_ERROR;
1115 bool had_success = false;
1116 /* Start tile is the small number. */
1117 for (;;) {
1118 RoadBits bits = AxisToRoadBits(axis);
1119
1120 if (tile == end_tile && !HasBit(p2, 1)) bits &= ROAD_NW | ROAD_NE;
1121 if (tile == start_tile && HasBit(p2, 0)) bits &= ROAD_SE | ROAD_SW;
1122
1123 /* try to remove the halves. */
1124 if (bits != 0) {
1125 RoadTramType rtt = GetRoadTramType(rt);
1126 CommandCost ret = RemoveRoad(tile, flags & ~DC_EXEC, bits, rtt, true);
1127 if (ret.Succeeded()) {
1128 if (flags & DC_EXEC) {
1129 money -= ret.GetCost();
1130 if (money < 0) {
1131 _additional_cash_required = DoCommand(start_tile, end_tile, p2, flags & ~DC_EXEC, CMD_REMOVE_LONG_ROAD).GetCost();
1132 return cost;
1133 }
1134 RemoveRoad(tile, flags, bits, rtt, true, false);
1135 }
1136 cost.AddCost(ret);
1137 had_success = true;
1138 } else {
1139 /* Ownership errors are more important. */
1140 if (last_error.GetErrorMessage() != STR_ERROR_OWNED_BY) last_error = ret;
1141 }
1142 }
1143
1144 if (tile == end_tile) break;
1145
1146 tile += (axis == AXIS_Y) ? TileDiffXY(0, 1) : TileDiffXY(1, 0);
1147 }
1148
1149 return had_success ? cost : last_error;
1150 }
1151
1152 /**
1153 * Build a road depot.
1154 * @param tile tile where to build the depot
1155 * @param flags operation to perform
1156 * @param p1 bit 0..1 entrance direction (DiagDirection)
1157 * bit 2..7 road type
1158 * @param p2 unused
1159 * @param text unused
1160 * @return the cost of this operation or an error
1161 *
1162 * @todo When checking for the tile slope,
1163 * distinguish between "Flat land required" and "land sloped in wrong direction"
1164 */
1165 CommandCost CmdBuildRoadDepot(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
1166 {
1167 DiagDirection dir = Extract<DiagDirection, 0, 2>(p1);
1168
1169 RoadType rt = Extract<RoadType, 2, 6>(p1);
1170 if (!ValParamRoadType(rt)) return CMD_ERROR;
1171
1172 CommandCost cost(EXPENSES_CONSTRUCTION);
1173
1174 Slope tileh = GetTileSlope(tile);
1175 if (tileh != SLOPE_FLAT) {
1176 if (!_settings_game.construction.build_on_slopes || !CanBuildDepotByTileh(dir, tileh)) {
1177 return_cmd_error(STR_ERROR_FLAT_LAND_REQUIRED);
1178 }
1179 cost.AddCost(_price[PR_BUILD_FOUNDATION]);
1180 }
1181
1182 cost.AddCost(DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR));
1183 if (cost.Failed()) return cost;
1184
1185 if (IsBridgeAbove(tile)) return_cmd_error(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
1186
1187 if (!Depot::CanAllocateItem()) return CMD_ERROR;
1188
1189 if (flags & DC_EXEC) {
1190 Depot *dep = new Depot(tile);
1191 dep->build_date = _date;
1192
1193 /* A road depot has two road bits. */
1194 UpdateCompanyRoadInfrastructure(rt, _current_company, 2);
1195
1196 MakeRoadDepot(tile, _current_company, dep->index, dir, rt);
1197 MarkTileDirtyByTile(tile);
1198 MakeDefaultName(dep);
1199 }
1200 cost.AddCost(_price[PR_BUILD_DEPOT_ROAD]);
1201 return cost;
1202 }
1203
1204 static CommandCost RemoveRoadDepot(TileIndex tile, DoCommandFlag flags)
1205 {
1206 if (_current_company != OWNER_WATER) {
1207 CommandCost ret = CheckTileOwnership(tile);
1208 if (ret.Failed()) return ret;
1209 }
1210
1211 CommandCost ret = EnsureNoVehicleOnGround(tile);
1212 if (ret.Failed()) return ret;
1213
1214 if (flags & DC_EXEC) {
1215 Company *c = Company::GetIfValid(GetTileOwner(tile));
1216 if (c != nullptr) {
1217 /* A road depot has two road bits. */
1218 RoadType rt = GetRoadTypeRoad(tile);
1219 if (rt == INVALID_ROADTYPE) rt = GetRoadTypeTram(tile);
1220 c->infrastructure.road[rt] -= 2;
1221 DirtyCompanyInfrastructureWindows(c->index);
1222 }
1223
1224 delete Depot::GetByTile(tile);
1225 DoClearSquare(tile);
1226 }
1227
1228 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_CLEAR_DEPOT_ROAD]);
1229 }
1230
1231 static CommandCost ClearTile_Road(TileIndex tile, DoCommandFlag flags)
1232 {
1233 switch (GetRoadTileType(tile)) {
1234 case ROAD_TILE_NORMAL: {
1235 RoadBits b = GetAllRoadBits(tile);
1236
1237 /* Clear the road if only one piece is on the tile OR we are not using the DC_AUTO flag */
1238 if ((HasExactlyOneBit(b) && GetRoadBits(tile, RTT_TRAM) == ROAD_NONE) || !(flags & DC_AUTO)) {
1239 CommandCost ret(EXPENSES_CONSTRUCTION);
1240 FOR_ALL_ROADTRAMTYPES(rtt) {
1241 if (!MayHaveRoad(tile) || GetRoadType(tile, rtt) == INVALID_ROADTYPE) continue;
1242
1243 CommandCost tmp_ret = RemoveRoad(tile, flags, GetRoadBits(tile, rtt), rtt, true);
1244 if (tmp_ret.Failed()) return tmp_ret;
1245 ret.AddCost(tmp_ret);
1246 }
1247 return ret;
1248 }
1249 return_cmd_error(STR_ERROR_MUST_REMOVE_ROAD_FIRST);
1250 }
1251
1252 case ROAD_TILE_CROSSING: {
1253 CommandCost ret(EXPENSES_CONSTRUCTION);
1254
1255 if (flags & DC_AUTO) return_cmd_error(STR_ERROR_MUST_REMOVE_ROAD_FIRST);
1256
1257 /* Must iterate over the roadtypes in a reverse manner because
1258 * tram tracks must be removed before the road bits. */
1259 for (RoadTramType rtt : { RTT_TRAM, RTT_ROAD }) {
1260 if (!MayHaveRoad(tile) || GetRoadType(tile, rtt) == INVALID_ROADTYPE) continue;
1261
1262 CommandCost tmp_ret = RemoveRoad(tile, flags, GetCrossingRoadBits(tile), rtt, false);
1263 if (tmp_ret.Failed()) return tmp_ret;
1264 ret.AddCost(tmp_ret);
1265 }
1266
1267 if (flags & DC_EXEC) {
1268 DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
1269 }
1270 return ret;
1271 }
1272
1273 default:
1274 case ROAD_TILE_DEPOT:
1275 if (flags & DC_AUTO) {
1276 return_cmd_error(STR_ERROR_BUILDING_MUST_BE_DEMOLISHED);
1277 }
1278 return RemoveRoadDepot(tile, flags);
1279 }
1280 }
1281
1282
1283 struct DrawRoadTileStruct {
1284 uint16 image;
1285 byte subcoord_x;
1286 byte subcoord_y;
1287 };
1288
1289 #include "table/road_land.h"
1290
1291 /**
1292 * Get the foundationtype of a RoadBits Slope combination
1293 *
1294 * @param tileh The Slope part
1295 * @param bits The RoadBits part
1296 * @return The resulting Foundation
1297 */
1298 static Foundation GetRoadFoundation(Slope tileh, RoadBits bits)
1299 {
1300 /* Flat land and land without a road doesn't require a foundation */
1301 if (tileh == SLOPE_FLAT || bits == ROAD_NONE) return FOUNDATION_NONE;
1302
1303 /* Steep slopes behave the same as slopes with one corner raised. */
1304 if (IsSteepSlope(tileh)) {
1305 tileh = SlopeWithOneCornerRaised(GetHighestSlopeCorner(tileh));
1306 }
1307
1308 /* Leveled RoadBits on a slope */
1309 if ((_invalid_tileh_slopes_road[0][tileh] & bits) == ROAD_NONE) return FOUNDATION_LEVELED;
1310
1311 /* Straight roads without foundation on a slope */
1312 if (!IsSlopeWithOneCornerRaised(tileh) &&
1313 (_invalid_tileh_slopes_road[1][tileh] & bits) == ROAD_NONE)
1314 return FOUNDATION_NONE;
1315
1316 /* Roads on steep Slopes or on Slopes with one corner raised */
1317 return (bits == ROAD_X ? FOUNDATION_INCLINED_X : FOUNDATION_INCLINED_Y);
1318 }
1319
1320 const byte _road_sloped_sprites[14] = {
1321 0, 0, 2, 0,
1322 0, 1, 0, 0,
1323 3, 0, 0, 0,
1324 0, 0
1325 };
1326
1327 /**
1328 * Get the sprite offset within a spritegroup.
1329 * @param slope Slope
1330 * @param bits Roadbits
1331 * @return Offset for the sprite within the spritegroup.
1332 */
1333 static uint GetRoadSpriteOffset(Slope slope, RoadBits bits)
1334 {
1335 if (slope != SLOPE_FLAT) {
1336 switch (slope) {
1337 case SLOPE_NE: return 11;
1338 case SLOPE_SE: return 12;
1339 case SLOPE_SW: return 13;
1340 case SLOPE_NW: return 14;
1341 default: NOT_REACHED();
1342 }
1343 } else {
1344 static const uint offsets[] = {
1345 0, 18, 17, 7,
1346 16, 0, 10, 5,
1347 15, 8, 1, 4,
1348 9, 3, 6, 2
1349 };
1350 return offsets[bits];
1351 }
1352 }
1353
1354 /**
1355 * Should the road be drawn as a unpaved snow/desert road?
1356 * By default, roads are always drawn as unpaved if they are on desert or
1357 * above the snow line, but NewGRFs can override this for desert.
1358 *
1359 * @param tile The tile the road is on
1360 * @param roadside What sort of road this is
1361 * @return True if snow/desert road sprites should be used.
1362 */
1363 static bool DrawRoadAsSnowDesert(TileIndex tile, Roadside roadside)
1364 {
1365 return (IsOnSnow(tile) &&
1366 !(_settings_game.game_creation.landscape == LT_TROPIC && HasGrfMiscBit(GMB_DESERT_PAVED_ROADS) &&
1367 roadside != ROADSIDE_BARREN && roadside != ROADSIDE_GRASS && roadside != ROADSIDE_GRASS_ROAD_WORKS));
1368 }
1369
1370 /**
1371 * Draws the catenary for the RoadType of the given tile
1372 * @param ti information about the tile (slopes, height etc)
1373 * @param rt road type to draw catenary for
1374 * @param rb the roadbits for the tram
1375 */
1376 void DrawRoadTypeCatenary(const TileInfo *ti, RoadType rt, RoadBits rb)
1377 {
1378 /* Don't draw the catenary under a low bridge */
1379 if (IsBridgeAbove(ti->tile) && !IsTransparencySet(TO_CATENARY)) {
1380 int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
1381
1382 if (height <= GetTileMaxZ(ti->tile) + 1) return;
1383 }
1384
1385 if (CountBits(rb) > 2) {
1386 /* On junctions we check whether neighbouring tiles also have catenary, and possibly
1387 * do not draw catenary towards those neighbours, which do not have catenary. */
1388 RoadBits rb_new = ROAD_NONE;
1389 for (DiagDirection dir = DIAGDIR_BEGIN; dir < DIAGDIR_END; dir++) {
1390 if (rb & DiagDirToRoadBits(dir)) {
1391 TileIndex neighbour = TileAddByDiagDir(ti->tile, dir);
1392 if (MayHaveRoad(neighbour)) {
1393 RoadType rt_road = GetRoadTypeRoad(neighbour);
1394 RoadType rt_tram = GetRoadTypeTram(neighbour);
1395
1396 if ((rt_road != INVALID_ROADTYPE && HasRoadCatenary(rt_road)) ||
1397 (rt_tram != INVALID_ROADTYPE && HasRoadCatenary(rt_tram))) {
1398 rb_new |= DiagDirToRoadBits(dir);
1399 }
1400 }
1401 }
1402 }
1403 if (CountBits(rb_new) >= 2) rb = rb_new;
1404 }
1405
1406 const RoadTypeInfo* rti = GetRoadTypeInfo(rt);
1407 SpriteID front = GetCustomRoadSprite(rti, ti->tile, ROTSG_CATENARY_FRONT);
1408 SpriteID back = GetCustomRoadSprite(rti, ti->tile, ROTSG_CATENARY_BACK);
1409
1410 if (front != 0 || back != 0) {
1411 if (front != 0) front += GetRoadSpriteOffset(ti->tileh, rb);
1412 if (back != 0) back += GetRoadSpriteOffset(ti->tileh, rb);
1413 } else if (ti->tileh != SLOPE_FLAT) {
1414 back = SPR_TRAMWAY_BACK_WIRES_SLOPED + _road_sloped_sprites[ti->tileh - 1];
1415 front = SPR_TRAMWAY_FRONT_WIRES_SLOPED + _road_sloped_sprites[ti->tileh - 1];
1416 } else {
1417 back = SPR_TRAMWAY_BASE + _road_backpole_sprites_1[rb];
1418 front = SPR_TRAMWAY_BASE + _road_frontwire_sprites_1[rb];
1419 }
1420
1421 /* Catenary uses 1st company colour to help identify owner.
1422 * For tiles with OWNER_TOWN or OWNER_NONE, recolour CC to grey as a neutral colour. */
1423 Owner owner = GetRoadOwner(ti->tile, GetRoadTramType(rt));
1424 PaletteID pal = (owner == OWNER_NONE || owner == OWNER_TOWN ? GENERAL_SPRITE_COLOUR(COLOUR_GREY) : COMPANY_SPRITE_COLOUR(owner));
1425 if (back != 0) AddSortableSpriteToDraw(back, pal, ti->x, ti->y, 16, 16, TILE_HEIGHT + BB_HEIGHT_UNDER_BRIDGE, ti->z, IsTransparencySet(TO_CATENARY));
1426 if (front != 0) AddSortableSpriteToDraw(front, pal, ti->x, ti->y, 16, 16, TILE_HEIGHT + BB_HEIGHT_UNDER_BRIDGE, ti->z, IsTransparencySet(TO_CATENARY));
1427 }
1428
1429 /**
1430 * Draws the catenary for the given tile
1431 * @param ti information about the tile (slopes, height etc)
1432 */
1433 void DrawRoadCatenary(const TileInfo *ti)
1434 {
1435 RoadBits road = ROAD_NONE;
1436 RoadBits tram = ROAD_NONE;
1437
1438 if (IsTileType(ti->tile, MP_ROAD)) {
1439 if (IsNormalRoad(ti->tile)) {
1440 road = GetRoadBits(ti->tile, RTT_ROAD);
1441 tram = GetRoadBits(ti->tile, RTT_TRAM);
1442 } else if (IsLevelCrossing(ti->tile)) {
1443 tram = road = (GetCrossingRailAxis(ti->tile) == AXIS_Y ? ROAD_X : ROAD_Y);
1444 }
1445 } else if (IsTileType(ti->tile, MP_STATION)) {
1446 if (IsRoadStop(ti->tile)) {
1447 if (IsDriveThroughStopTile(ti->tile)) {
1448 Axis axis = GetRoadStopDir(ti->tile) == DIAGDIR_NE ? AXIS_X : AXIS_Y;
1449 tram = road = (axis == AXIS_X ? ROAD_X : ROAD_Y);
1450 } else {
1451 tram = road = DiagDirToRoadBits(GetRoadStopDir(ti->tile));
1452 }
1453 }
1454 } else {
1455 // No road here, no catenary to draw
1456 return;
1457 }
1458
1459 RoadType rt = GetRoadTypeRoad(ti->tile);
1460 if (rt != INVALID_ROADTYPE && HasRoadCatenaryDrawn(rt)) {
1461 DrawRoadTypeCatenary(ti, rt, road);
1462 }
1463
1464 rt = GetRoadTypeTram(ti->tile);
1465 if (rt != INVALID_ROADTYPE && HasRoadCatenaryDrawn(rt)) {
1466 DrawRoadTypeCatenary(ti, rt, tram);
1467 }
1468 }
1469
1470 /**
1471 * Draws details on/around the road
1472 * @param img the sprite to draw
1473 * @param ti the tile to draw on
1474 * @param dx the offset from the top of the BB of the tile
1475 * @param dy the offset from the top of the BB of the tile
1476 * @param h the height of the sprite to draw
1477 */
1478 static void DrawRoadDetail(SpriteID img, const TileInfo *ti, int dx, int dy, int h)
1479 {
1480 int x = ti->x | dx;
1481 int y = ti->y | dy;
1482 int z = ti->z;
1483 if (ti->tileh != SLOPE_FLAT) z = GetSlopePixelZ(x, y);
1484 AddSortableSpriteToDraw(img, PAL_NONE, x, y, 2, 2, h, z);
1485 }
1486
1487 /**
1488 * Draw road underlay and overlay sprites.
1489 * @param ti TileInfo
1490 * @param road_rti Road road type information
1491 * @param tram_rti Tram road type information
1492 * @param road_offset Road sprite offset (based on road bits)
1493 * @param tram_offset Tram sprite offset (based on road bits)
1494 */
1495 void DrawRoadOverlays(const TileInfo *ti, PaletteID pal, const RoadTypeInfo *road_rti, const RoadTypeInfo *tram_rti, uint road_offset, uint tram_offset)
1496 {
1497 /* Road underlay takes precedence over tram */
1498 if (road_rti != nullptr) {
1499 if (road_rti->UsesOverlay()) {
1500 SpriteID ground = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_GROUND);
1501 DrawGroundSprite(ground + road_offset, pal);
1502 }
1503 } else {
1504 if (tram_rti->UsesOverlay()) {
1505 SpriteID ground = GetCustomRoadSprite(tram_rti, ti->tile, ROTSG_GROUND);
1506 DrawGroundSprite(ground + tram_offset, pal);
1507 } else {
1508 DrawGroundSprite(SPR_TRAMWAY_TRAM + tram_offset, pal);
1509 }
1510 }
1511
1512 /* Draw road overlay */
1513 if (road_rti != nullptr) {
1514 if (road_rti->UsesOverlay()) {
1515 SpriteID ground = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_OVERLAY);
1516 if (ground != 0) DrawGroundSprite(ground + road_offset, pal);
1517 }
1518 }
1519
1520 /* Draw tram overlay */
1521 if (tram_rti != nullptr) {
1522 if (tram_rti->UsesOverlay()) {
1523 SpriteID ground = GetCustomRoadSprite(tram_rti, ti->tile, ROTSG_OVERLAY);
1524 if (ground != 0) DrawGroundSprite(ground + tram_offset, pal);
1525 } else if (road_rti != nullptr) {
1526 DrawGroundSprite(SPR_TRAMWAY_OVERLAY + tram_offset, pal);
1527 }
1528 }
1529 }
1530
1531 /**
1532 * Get ground sprite to draw for a road tile.
1533 * @param ti TileInof
1534 * @param roadside Road side type
1535 * @param rti Road type info
1536 * @param offset Road sprite offset
1537 * @param[out] pal Palette to draw.
1538 */
1539 static SpriteID GetRoadGroundSprite(const TileInfo *ti, Roadside roadside, const RoadTypeInfo *rti, uint offset, PaletteID *pal)
1540 {
1541 /* Draw bare ground sprite if no road or road uses overlay system. */
1542 if (rti == nullptr || rti->UsesOverlay()) {
1543 if (DrawRoadAsSnowDesert(ti->tile, roadside)) {
1544 return SPR_FLAT_SNOW_DESERT_TILE + SlopeToSpriteOffset(ti->tileh);
1545 }
1546
1547 switch (roadside) {
1548 case ROADSIDE_BARREN: *pal = PALETTE_TO_BARE_LAND;
1549 return SPR_FLAT_GRASS_TILE + SlopeToSpriteOffset(ti->tileh);
1550 case ROADSIDE_GRASS:
1551 case ROADSIDE_GRASS_ROAD_WORKS: return SPR_FLAT_GRASS_TILE + SlopeToSpriteOffset(ti->tileh);
1552 default: break; // Paved
1553 }
1554 }
1555
1556 /* Draw original road base sprite */
1557 SpriteID image = SPR_ROAD_Y + offset;
1558 if (DrawRoadAsSnowDesert(ti->tile, roadside)) {
1559 image += 19;
1560 } else {
1561 switch (roadside) {
1562 case ROADSIDE_BARREN: *pal = PALETTE_TO_BARE_LAND; break;
1563 case ROADSIDE_GRASS: break;
1564 case ROADSIDE_GRASS_ROAD_WORKS: break;
1565 default: image -= 19; break; // Paved
1566 }
1567 }
1568
1569 return image;
1570 }
1571
1572 /**
1573 * Draw ground sprite and road pieces
1574 * @param ti TileInfo
1575 */
1576 static void DrawRoadBits(TileInfo *ti)
1577 {
1578 RoadBits road = GetRoadBits(ti->tile, RTT_ROAD);
1579 RoadBits tram = GetRoadBits(ti->tile, RTT_TRAM);
1580
1581 RoadType road_rt = GetRoadTypeRoad(ti->tile);
1582 RoadType tram_rt = GetRoadTypeTram(ti->tile);
1583 const RoadTypeInfo *road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
1584 const RoadTypeInfo *tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
1585
1586 if (ti->tileh != SLOPE_FLAT) {
1587 DrawFoundation(ti, GetRoadFoundation(ti->tileh, road | tram));
1588 /* DrawFoundation() modifies ti. */
1589 }
1590
1591 /* Determine sprite offsets */
1592 uint road_offset = GetRoadSpriteOffset(ti->tileh, road);
1593 uint tram_offset = GetRoadSpriteOffset(ti->tileh, tram);
1594
1595 /* Draw baseset underlay */
1596 Roadside roadside = GetRoadside(ti->tile);
1597
1598 PaletteID pal = PAL_NONE;
1599 SpriteID image = GetRoadGroundSprite(ti, roadside, road_rti, road == ROAD_NONE ? tram_offset : road_offset, &pal);
1600 DrawGroundSprite(image, pal);
1601
1602 DrawRoadOverlays(ti, pal, road_rti, tram_rti, road_offset, tram_offset);
1603
1604 /* Draw one way */
1605 if (road_rti != nullptr) {
1606 DisallowedRoadDirections drd = GetDisallowedRoadDirections(ti->tile);
1607 if (drd != DRD_NONE) {
1608 DrawGroundSpriteAt(SPR_ONEWAY_BASE + drd - 1 + ((road == ROAD_X) ? 0 : 3), PAL_NONE, 8, 8, GetPartialPixelZ(8, 8, ti->tileh));
1609 }
1610 }
1611
1612 if (HasRoadWorks(ti->tile)) {
1613 /* Road works */
1614 DrawGroundSprite((road | tram) & ROAD_X ? SPR_EXCAVATION_X : SPR_EXCAVATION_Y, PAL_NONE);
1615 return;
1616 }
1617
1618 /* Draw road, tram catenary */
1619 DrawRoadCatenary(ti);
1620
1621 /* Return if full detail is disabled, or we are zoomed fully out. */
1622 if (!HasBit(_display_opt, DO_FULL_DETAIL) || _cur_dpi->zoom > ZOOM_LVL_DETAIL) return;
1623
1624 /* Do not draw details (street lights, trees) under low bridge */
1625 if (IsBridgeAbove(ti->tile) && (roadside == ROADSIDE_TREES || roadside == ROADSIDE_STREET_LIGHTS)) {
1626 int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
1627 int minz = GetTileMaxZ(ti->tile) + 2;
1628
1629 if (roadside == ROADSIDE_TREES) minz++;
1630
1631 if (height < minz) return;
1632 }
1633
1634 /* If there are no road bits, return, as there is nothing left to do */
1635 if (HasAtMostOneBit(road)) return;
1636
1637 /* Draw extra details. */
1638 for (const DrawRoadTileStruct *drts = _road_display_table[roadside][road | tram]; drts->image != 0; drts++) {
1639 DrawRoadDetail(drts->image, ti, drts->subcoord_x, drts->subcoord_y, 0x10);
1640 }
1641 }
1642
1643 /** Tile callback function for rendering a road tile to the screen */
1644 static void DrawTile_Road(TileInfo *ti)
1645 {
1646 switch (GetRoadTileType(ti->tile)) {
1647 case ROAD_TILE_NORMAL:
1648 DrawRoadBits(ti);
1649 break;
1650
1651 case ROAD_TILE_CROSSING: {
1652 if (ti->tileh != SLOPE_FLAT) DrawFoundation(ti, FOUNDATION_LEVELED);
1653
1654 Axis axis = GetCrossingRailAxis(ti->tile);
1655
1656 const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(ti->tile));
1657
1658 RoadType road_rt = GetRoadTypeRoad(ti->tile);
1659 RoadType tram_rt = GetRoadTypeTram(ti->tile);
1660 const RoadTypeInfo *road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
1661 const RoadTypeInfo *tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
1662
1663 PaletteID pal = PAL_NONE;
1664
1665 /* Draw base ground */
1666 if (rti->UsesOverlay()) {
1667 SpriteID image = SPR_ROAD_Y + axis;
1668
1669 Roadside roadside = GetRoadside(ti->tile);
1670 if (DrawRoadAsSnowDesert(ti->tile, roadside)) {
1671 image += 19;
1672 } else {
1673 switch (roadside) {
1674 case ROADSIDE_BARREN: pal = PALETTE_TO_BARE_LAND; break;
1675 case ROADSIDE_GRASS: break;
1676 default: image -= 19; break; // Paved
1677 }
1678 }
1679
1680 DrawGroundSprite(image, pal);
1681 } else {
1682 SpriteID image = rti->base_sprites.crossing + axis;
1683 if (IsCrossingBarred(ti->tile)) image += 2;
1684
1685 Roadside roadside = GetRoadside(ti->tile);
1686 if (DrawRoadAsSnowDesert(ti->tile, roadside)) {
1687 image += 8;
1688 } else {
1689 switch (roadside) {
1690 case ROADSIDE_BARREN: pal = PALETTE_TO_BARE_LAND; break;
1691 case ROADSIDE_GRASS: break;
1692 default: image += 4; break; // Paved
1693 }
1694 }
1695
1696 DrawGroundSprite(image, pal);
1697 }
1698
1699 DrawRoadOverlays(ti, pal, road_rti, tram_rti, axis, axis);
1700
1701 /* Draw rail/PBS overlay */
1702 bool draw_pbs = _game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasCrossingReservation(ti->tile);
1703 if (rti->UsesOverlay()) {
1704 PaletteID pal = draw_pbs ? PALETTE_CRASH : PAL_NONE;
1705 SpriteID rail = GetCustomRailSprite(rti, ti->tile, RTSG_CROSSING) + axis;
1706 DrawGroundSprite(rail, pal);
1707
1708 DrawRailTileSeq(ti, &_crossing_layout, TO_CATENARY, rail, 0, PAL_NONE);
1709 } else if (draw_pbs || tram_rti != nullptr || road_rti->UsesOverlay()) {
1710 /* Add another rail overlay, unless there is only the base road sprite. */
1711 PaletteID pal = draw_pbs ? PALETTE_CRASH : PAL_NONE;
1712 SpriteID rail = GetCrossingRoadAxis(ti->tile) == AXIS_Y ? GetRailTypeInfo(GetRailType(ti->tile))->base_sprites.single_x : GetRailTypeInfo(GetRailType(ti->tile))->base_sprites.single_y;
1713 DrawGroundSprite(rail, pal);
1714 }
1715
1716 /* Draw road, tram catenary */
1717 DrawRoadCatenary(ti);
1718
1719 /* Draw rail catenary */
1720 if (HasRailCatenaryDrawn(GetRailType(ti->tile))) DrawRailCatenary(ti);
1721
1722 break;
1723 }
1724
1725 default:
1726 case ROAD_TILE_DEPOT: {
1727 if (ti->tileh != SLOPE_FLAT) DrawFoundation(ti, FOUNDATION_LEVELED);
1728
1729 PaletteID palette = COMPANY_SPRITE_COLOUR(GetTileOwner(ti->tile));
1730
1731 RoadType road_rt = GetRoadTypeRoad(ti->tile);
1732 RoadType tram_rt = GetRoadTypeTram(ti->tile);
1733 const RoadTypeInfo *rti = GetRoadTypeInfo(road_rt == INVALID_ROADTYPE ? tram_rt : road_rt);
1734
1735 int relocation = GetCustomRoadSprite(rti, ti->tile, ROTSG_DEPOT);
1736 bool default_gfx = relocation == 0;
1737 if (default_gfx) {
1738 if (HasBit(rti->flags, ROTF_CATENARY)) {
1739 if (_loaded_newgrf_features.tram == TRAMWAY_REPLACE_DEPOT_WITH_TRACK && road_rt == INVALID_ROADTYPE && !rti->UsesOverlay()) {
1740 /* Sprites with track only work for default tram */
1741 relocation = SPR_TRAMWAY_DEPOT_WITH_TRACK - SPR_ROAD_DEPOT;
1742 default_gfx = false;
1743 } else {
1744 /* Sprites without track are always better, if provided */
1745 relocation = SPR_TRAMWAY_DEPOT_NO_TRACK - SPR_ROAD_DEPOT;
1746 }
1747 }
1748 } else {
1749 relocation -= SPR_ROAD_DEPOT;
1750 }
1751
1752 DiagDirection dir = GetRoadDepotDirection(ti->tile);
1753 const DrawTileSprites *dts = &_road_depot[dir];
1754 DrawGroundSprite(dts->ground.sprite, PAL_NONE);
1755
1756 if (default_gfx) {
1757 uint offset = GetRoadSpriteOffset(SLOPE_FLAT, DiagDirToRoadBits(dir));
1758 if (rti->UsesOverlay()) {
1759 SpriteID ground = GetCustomRoadSprite(rti, ti->tile, ROTSG_OVERLAY);
1760 if (ground != 0) DrawGroundSprite(ground + offset, PAL_NONE);
1761 } else if (road_rt == INVALID_ROADTYPE) {
1762 DrawGroundSprite(SPR_TRAMWAY_OVERLAY + offset, PAL_NONE);
1763 }
1764 }
1765
1766 DrawRailTileSeq(ti, dts, TO_BUILDINGS, relocation, 0, palette);
1767 break;
1768 }
1769 }
1770 DrawBridgeMiddle(ti);
1771 }
1772
1773 /**
1774 * Draw the road depot sprite.
1775 * @param x The x offset to draw at.
1776 * @param y The y offset to draw at.
1777 * @param dir The direction the depot must be facing.
1778 * @param rt The road type of the depot to draw.
1779 */
1780 void DrawRoadDepotSprite(int x, int y, DiagDirection dir, RoadType rt)
1781 {
1782 PaletteID palette = COMPANY_SPRITE_COLOUR(_local_company);
1783
1784 const RoadTypeInfo* rti = GetRoadTypeInfo(rt);
1785 int relocation = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_DEPOT);
1786 bool default_gfx = relocation == 0;
1787 if (default_gfx) {
1788 if (HasBit(rti->flags, ROTF_CATENARY)) {
1789 if (_loaded_newgrf_features.tram == TRAMWAY_REPLACE_DEPOT_WITH_TRACK && RoadTypeIsTram(rt) && !rti->UsesOverlay()) {
1790 /* Sprites with track only work for default tram */
1791 relocation = SPR_TRAMWAY_DEPOT_WITH_TRACK - SPR_ROAD_DEPOT;
1792 default_gfx = false;
1793 } else {
1794 /* Sprites without track are always better, if provided */
1795 relocation = SPR_TRAMWAY_DEPOT_NO_TRACK - SPR_ROAD_DEPOT;
1796 }
1797 }
1798 } else {
1799 relocation -= SPR_ROAD_DEPOT;
1800 }
1801
1802 const DrawTileSprites *dts = &_road_depot[dir];
1803 DrawSprite(dts->ground.sprite, PAL_NONE, x, y);
1804
1805 if (default_gfx) {
1806 uint offset = GetRoadSpriteOffset(SLOPE_FLAT, DiagDirToRoadBits(dir));
1807 if (rti->UsesOverlay()) {
1808 SpriteID ground = GetCustomRoadSprite(rti, INVALID_TILE, ROTSG_OVERLAY);
1809 if (ground != 0) DrawSprite(ground + offset, PAL_NONE, x, y);
1810 } else if (RoadTypeIsTram(rt)) {
1811 DrawSprite(SPR_TRAMWAY_OVERLAY + offset, PAL_NONE, x, y);
1812 }
1813 }
1814
1815 DrawRailTileSeqInGUI(x, y, dts, relocation, 0, palette);
1816 }
1817
1818 /**
1819 * Updates cached nearest town for all road tiles
1820 * @param invalidate are we just invalidating cached data?
1821 * @pre invalidate == true implies _generating_world == true
1822 */
1823 void UpdateNearestTownForRoadTiles(bool invalidate)
1824 {
1825 assert(!invalidate || _generating_world);
1826
1827 for (TileIndex t = 0; t < MapSize(); t++) {
1828 if (IsTileType(t, MP_ROAD) && !IsRoadDepot(t) && !HasTownOwnedRoad(t)) {
1829 TownID tid = INVALID_TOWN;
1830 if (!invalidate) {
1831 const Town *town = CalcClosestTownFromTile(t);
1832 if (town != nullptr) tid = town->index;
1833 }
1834 SetTownIndex(t, tid);
1835 }
1836 }
1837 }
1838
1839 static int GetSlopePixelZ_Road(TileIndex tile, uint x, uint y)
1840 {
1841
1842 if (IsNormalRoad(tile)) {
1843 int z;
1844 Slope tileh = GetTilePixelSlope(tile, &z);
1845 if (tileh == SLOPE_FLAT) return z;
1846
1847 Foundation f = GetRoadFoundation(tileh, GetAllRoadBits(tile));
1848 z += ApplyPixelFoundationToSlope(f, &tileh);
1849 return z + GetPartialPixelZ(x & 0xF, y & 0xF, tileh);
1850 } else {
1851 return GetTileMaxPixelZ(tile);
1852 }
1853 }
1854
1855 static Foundation GetFoundation_Road(TileIndex tile, Slope tileh)
1856 {
1857 if (IsNormalRoad(tile)) {
1858 return GetRoadFoundation(tileh, GetAllRoadBits(tile));
1859 } else {
1860 return FlatteningFoundation(tileh);
1861 }
1862 }
1863
1864 static const Roadside _town_road_types[][2] = {
1865 { ROADSIDE_GRASS, ROADSIDE_GRASS },
1866 { ROADSIDE_PAVED, ROADSIDE_PAVED },
1867 { ROADSIDE_PAVED, ROADSIDE_PAVED },
1868 { ROADSIDE_TREES, ROADSIDE_TREES },
1869 { ROADSIDE_STREET_LIGHTS, ROADSIDE_PAVED }
1870 };
1871
1872 static const Roadside _town_road_types_2[][2] = {
1873 { ROADSIDE_GRASS, ROADSIDE_GRASS },
1874 { ROADSIDE_PAVED, ROADSIDE_PAVED },
1875 { ROADSIDE_STREET_LIGHTS, ROADSIDE_PAVED },
1876 { ROADSIDE_STREET_LIGHTS, ROADSIDE_PAVED },
1877 { ROADSIDE_STREET_LIGHTS, ROADSIDE_PAVED }
1878 };
1879
1880
1881 static void TileLoop_Road(TileIndex tile)
1882 {
1883 switch (_settings_game.game_creation.landscape) {
1884 case LT_ARCTIC:
1885 if (IsOnSnow(tile) != (GetTileZ(tile) > GetSnowLine())) {
1886 ToggleSnow(tile);
1887 MarkTileDirtyByTile(tile);
1888 }
1889 break;
1890
1891 case LT_TROPIC:
1892 if (GetTropicZone(tile) == TROPICZONE_DESERT && !IsOnDesert(tile)) {
1893 ToggleDesert(tile);
1894 MarkTileDirtyByTile(tile);
1895 }
1896 break;
1897 }
1898
1899 if (IsRoadDepot(tile)) return;
1900
1901 const Town *t = ClosestTownFromTile(tile, UINT_MAX);
1902 if (!HasRoadWorks(tile)) {
1903 HouseZonesBits grp = HZB_TOWN_EDGE;
1904
1905 if (t != nullptr) {
1906 grp = GetTownRadiusGroup(t, tile);
1907
1908 /* Show an animation to indicate road work */
1909 if (t->road_build_months != 0 &&
1910 (DistanceManhattan(t->xy, tile) < 8 || grp != HZB_TOWN_EDGE) &&
1911 IsNormalRoad(tile) && !HasAtMostOneBit(GetAllRoadBits(tile))) {
1912 if (GetFoundationSlope(tile) == SLOPE_FLAT && EnsureNoVehicleOnGround(tile).Succeeded() && Chance16(1, 40)) {
1913 StartRoadWorks(tile);
1914
1915 if (_settings_client.sound.ambient) SndPlayTileFx(SND_21_JACKHAMMER, tile);
1916 CreateEffectVehicleAbove(
1917 TileX(tile) * TILE_SIZE + 7,
1918 TileY(tile) * TILE_SIZE + 7,
1919 0,
1920 EV_BULLDOZER);
1921 MarkTileDirtyByTile(tile);
1922 return;
1923 }
1924 }
1925 }
1926
1927 {
1928 /* Adjust road ground type depending on 'grp' (grp is the distance to the center) */
1929 const Roadside *new_rs = (_settings_game.game_creation.landscape == LT_TOYLAND) ? _town_road_types_2[grp] : _town_road_types[grp];
1930 Roadside cur_rs = GetRoadside(tile);
1931
1932 /* We have our desired type, do nothing */
1933 if (cur_rs == new_rs[0]) return;
1934
1935 /* We have the pre-type of the desired type, switch to the desired type */
1936 if (cur_rs == new_rs[1]) {
1937 cur_rs = new_rs[0];
1938 /* We have barren land, install the pre-type */
1939 } else if (cur_rs == ROADSIDE_BARREN) {
1940 cur_rs = new_rs[1];
1941 /* We're totally off limits, remove any installation and make barren land */
1942 } else {
1943 cur_rs = ROADSIDE_BARREN;
1944 }
1945 SetRoadside(tile, cur_rs);
1946 MarkTileDirtyByTile(tile);
1947 }
1948 } else if (IncreaseRoadWorksCounter(tile)) {
1949 TerminateRoadWorks(tile);
1950
1951 if (_settings_game.economy.mod_road_rebuild) {
1952 /* Generate a nicer town surface */
1953 const RoadBits old_rb = GetAnyRoadBits(tile, RTT_ROAD);
1954 const RoadBits new_rb = CleanUpRoadBits(tile, old_rb);
1955
1956 if (old_rb != new_rb) {
1957 RemoveRoad(tile, DC_EXEC | DC_AUTO | DC_NO_WATER, (old_rb ^ new_rb), RTT_ROAD, true);
1958
1959 /* If new_rb is 0, there are now no road pieces left and the tile is no longer a road tile */
1960 if (new_rb == 0) {
1961 MarkTileDirtyByTile(tile);
1962 return;
1963 }
1964 }
1965 }
1966
1967 /* Possibly change road type */
1968 if (GetRoadOwner(tile, RTT_ROAD) == OWNER_TOWN) {
1969 RoadType rt = GetTownRoadType(t);
1970 if (rt != GetRoadTypeRoad(tile)) {
1971 SetRoadType(tile, RTT_ROAD, rt);
1972 }
1973 }
1974
1975 MarkTileDirtyByTile(tile);
1976 }
1977 }
1978
1979 static bool ClickTile_Road(TileIndex tile)
1980 {
1981 if (!IsRoadDepot(tile)) return false;
1982
1983 ShowDepotWindow(tile, VEH_ROAD);
1984 return true;
1985 }
1986
1987 /* Converts RoadBits to TrackBits */
1988 static const TrackBits _road_trackbits[16] = {
1989 TRACK_BIT_NONE, // ROAD_NONE
1990 TRACK_BIT_NONE, // ROAD_NW
1991 TRACK_BIT_NONE, // ROAD_SW
1992 TRACK_BIT_LEFT, // ROAD_W
1993 TRACK_BIT_NONE, // ROAD_SE
1994 TRACK_BIT_Y, // ROAD_Y
1995 TRACK_BIT_LOWER, // ROAD_S
1996 TRACK_BIT_LEFT | TRACK_BIT_LOWER | TRACK_BIT_Y, // ROAD_Y | ROAD_SW
1997 TRACK_BIT_NONE, // ROAD_NE
1998 TRACK_BIT_UPPER, // ROAD_N
1999 TRACK_BIT_X, // ROAD_X
2000 TRACK_BIT_LEFT | TRACK_BIT_UPPER | TRACK_BIT_X, // ROAD_X | ROAD_NW
2001 TRACK_BIT_RIGHT, // ROAD_E
2002 TRACK_BIT_RIGHT | TRACK_BIT_UPPER | TRACK_BIT_Y, // ROAD_Y | ROAD_NE
2003 TRACK_BIT_RIGHT | TRACK_BIT_LOWER | TRACK_BIT_X, // ROAD_X | ROAD_SE
2004 TRACK_BIT_ALL, // ROAD_ALL
2005 };
2006
2007 static TrackStatus GetTileTrackStatus_Road(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
2008 {
2009 TrackdirBits trackdirbits = TRACKDIR_BIT_NONE;
2010 TrackdirBits red_signals = TRACKDIR_BIT_NONE; // crossing barred
2011 switch (mode) {
2012 case TRANSPORT_RAIL:
2013 if (IsLevelCrossing(tile)) trackdirbits = TrackBitsToTrackdirBits(GetCrossingRailBits(tile));
2014 break;
2015
2016 case TRANSPORT_ROAD: {
2017 RoadTramType rtt = (RoadTramType)sub_mode;
2018 if (!HasTileRoadType(tile, rtt)) break;
2019 switch (GetRoadTileType(tile)) {
2020 case ROAD_TILE_NORMAL: {
2021 const uint drd_to_multiplier[DRD_END] = { 0x101, 0x100, 0x1, 0x0 };
2022 RoadBits bits = GetRoadBits(tile, rtt);
2023
2024 /* no roadbit at this side of tile, return 0 */
2025 if (side != INVALID_DIAGDIR && (DiagDirToRoadBits(side) & bits) == 0) break;
2026
2027 uint multiplier = drd_to_multiplier[(rtt == RTT_TRAM) ? DRD_NONE : GetDisallowedRoadDirections(tile)];
2028 if (!HasRoadWorks(tile)) trackdirbits = (TrackdirBits)(_road_trackbits[bits] * multiplier);
2029 break;
2030 }
2031
2032 case ROAD_TILE_CROSSING: {
2033 Axis axis = GetCrossingRoadAxis(tile);
2034
2035 if (side != INVALID_DIAGDIR && axis != DiagDirToAxis(side)) break;
2036
2037 trackdirbits = TrackBitsToTrackdirBits(AxisToTrackBits(axis));
2038 if (IsCrossingBarred(tile)) red_signals = trackdirbits;
2039 break;
2040 }
2041
2042 default:
2043 case ROAD_TILE_DEPOT: {
2044 DiagDirection dir = GetRoadDepotDirection(tile);
2045
2046 if (side != INVALID_DIAGDIR && side != dir) break;
2047
2048 trackdirbits = TrackBitsToTrackdirBits(DiagDirToDiagTrackBits(dir));
2049 break;
2050 }
2051 }
2052 break;
2053 }
2054
2055 default: break;
2056 }
2057 return CombineTrackStatus(trackdirbits, red_signals);
2058 }
2059
2060 static const StringID _road_tile_strings[] = {
2061 STR_LAI_ROAD_DESCRIPTION_ROAD,
2062 STR_LAI_ROAD_DESCRIPTION_ROAD,
2063 STR_LAI_ROAD_DESCRIPTION_ROAD,
2064 STR_LAI_ROAD_DESCRIPTION_ROAD_WITH_STREETLIGHTS,
2065 STR_LAI_ROAD_DESCRIPTION_ROAD,
2066 STR_LAI_ROAD_DESCRIPTION_TREE_LINED_ROAD,
2067 STR_LAI_ROAD_DESCRIPTION_ROAD,
2068 STR_LAI_ROAD_DESCRIPTION_ROAD,
2069 };
2070
2071 static void GetTileDesc_Road(TileIndex tile, TileDesc *td)
2072 {
2073 Owner rail_owner = INVALID_OWNER;
2074 Owner road_owner = INVALID_OWNER;
2075 Owner tram_owner = INVALID_OWNER;
2076
2077 RoadType road_rt = GetRoadTypeRoad(tile);
2078 RoadType tram_rt = GetRoadTypeTram(tile);
2079 if (road_rt != INVALID_ROADTYPE) {
2080 const RoadTypeInfo *rti = GetRoadTypeInfo(road_rt);
2081 td->roadtype = rti->strings.name;
2082 td->road_speed = rti->max_speed / 2;
2083 road_owner = GetRoadOwner(tile, RTT_ROAD);
2084 }
2085 if (tram_rt != INVALID_ROADTYPE) {
2086 const RoadTypeInfo *rti = GetRoadTypeInfo(tram_rt);
2087 td->tramtype = rti->strings.name;
2088 td->tram_speed = rti->max_speed / 2;
2089 tram_owner = GetRoadOwner(tile, RTT_TRAM);
2090 }
2091
2092 switch (GetRoadTileType(tile)) {
2093 case ROAD_TILE_CROSSING: {
2094 td->str = STR_LAI_ROAD_DESCRIPTION_ROAD_RAIL_LEVEL_CROSSING;
2095 rail_owner = GetTileOwner(tile);
2096
2097 const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
2098 td->railtype = rti->strings.name;
2099 td->rail_speed = rti->max_speed;
2100
2101 break;
2102 }
2103
2104 case ROAD_TILE_DEPOT:
2105 td->str = STR_LAI_ROAD_DESCRIPTION_ROAD_VEHICLE_DEPOT;
2106 td->build_date = Depot::GetByTile(tile)->build_date;
2107 break;
2108
2109 default: {
2110 td->str = (road_rt != INVALID_ROADTYPE ? _road_tile_strings[GetRoadside(tile)] : STR_LAI_ROAD_DESCRIPTION_TRAMWAY);
2111 break;
2112 }
2113 }
2114
2115 /* Now we have to discover, if the tile has only one owner or many:
2116 * - Find a first_owner of the tile. (Currently road or tram must be present, but this will break when the third type becomes available)
2117 * - Compare the found owner with the other owners, and test if they differ.
2118 * Note: If road exists it will be the first_owner.
2119 */
2120 Owner first_owner = (road_owner == INVALID_OWNER ? tram_owner : road_owner);
2121 bool mixed_owners = (tram_owner != INVALID_OWNER && tram_owner != first_owner) || (rail_owner != INVALID_OWNER && rail_owner != first_owner);
2122
2123 if (mixed_owners) {
2124 /* Multiple owners */
2125 td->owner_type[0] = (rail_owner == INVALID_OWNER ? STR_NULL : STR_LAND_AREA_INFORMATION_RAIL_OWNER);
2126 td->owner[0] = rail_owner;
2127 td->owner_type[1] = (road_owner == INVALID_OWNER ? STR_NULL : STR_LAND_AREA_INFORMATION_ROAD_OWNER);
2128 td->owner[1] = road_owner;
2129 td->owner_type[2] = (tram_owner == INVALID_OWNER ? STR_NULL : STR_LAND_AREA_INFORMATION_TRAM_OWNER);
2130 td->owner[2] = tram_owner;
2131 } else {
2132 /* One to rule them all */
2133 td->owner[0] = first_owner;
2134 }
2135 }
2136
2137 /**
2138 * Given the direction the road depot is pointing, this is the direction the
2139 * vehicle should be travelling in in order to enter the depot.
2140 */
2141 static const byte _roadveh_enter_depot_dir[4] = {
2142 TRACKDIR_X_SW, TRACKDIR_Y_NW, TRACKDIR_X_NE, TRACKDIR_Y_SE
2143 };
2144
2145 static VehicleEnterTileStatus VehicleEnter_Road(Vehicle *v, TileIndex tile, int x, int y)
2146 {
2147 switch (GetRoadTileType(tile)) {
2148 case ROAD_TILE_DEPOT: {
2149 if (v->type != VEH_ROAD) break;
2150
2151 RoadVehicle *rv = RoadVehicle::From(v);
2152 if (rv->frame == RVC_DEPOT_STOP_FRAME &&
2153 _roadveh_enter_depot_dir[GetRoadDepotDirection(tile)] == rv->state) {
2154 rv->state = RVSB_IN_DEPOT;
2155 rv->vehstatus |= VS_HIDDEN;
2156 rv->direction = ReverseDir(rv->direction);
2157 if (rv->Next() == nullptr) VehicleEnterDepot(rv->First());
2158 rv->tile = tile;
2159
2160 InvalidateWindowData(WC_VEHICLE_DEPOT, rv->tile);
2161 return VETSB_ENTERED_WORMHOLE;
2162 }
2163 break;
2164 }
2165
2166 default: break;
2167 }
2168 return VETSB_CONTINUE;
2169 }
2170
2171
2172 static void ChangeTileOwner_Road(TileIndex tile, Owner old_owner, Owner new_owner)
2173 {
2174 if (IsRoadDepot(tile)) {
2175 if (GetTileOwner(tile) == old_owner) {
2176 if (new_owner == INVALID_OWNER) {
2177 DoCommand(tile, 0, 0, DC_EXEC | DC_BANKRUPT, CMD_LANDSCAPE_CLEAR);
2178 } else {
2179 /* A road depot has two road bits. No need to dirty windows here, we'll redraw the whole screen anyway. */
2180 RoadType rt = GetRoadTypeRoad(tile);
2181 if (rt == INVALID_ROADTYPE) rt = GetRoadTypeTram(tile);
2182 Company::Get(old_owner)->infrastructure.road[rt] -= 2;
2183 Company::Get(new_owner)->infrastructure.road[rt] += 2;
2184
2185 SetTileOwner(tile, new_owner);
2186 FOR_ALL_ROADTRAMTYPES(rtt) {
2187 if (GetRoadOwner(tile, rtt) == old_owner) {
2188 SetRoadOwner(tile, rtt, new_owner);
2189 }
2190 }
2191 }
2192 }
2193 return;
2194 }
2195
2196 FOR_ALL_ROADTRAMTYPES(rtt) {
2197 /* Update all roadtypes, no matter if they are present */
2198 if (GetRoadOwner(tile, rtt) == old_owner) {
2199 RoadType rt = GetRoadType(tile, rtt);
2200 if (rt != INVALID_ROADTYPE) {
2201 /* A level crossing has two road bits. No need to dirty windows here, we'll redraw the whole screen anyway. */
2202 uint num_bits = IsLevelCrossing(tile) ? 2 : CountBits(GetRoadBits(tile, rtt));
2203 Company::Get(old_owner)->infrastructure.road[rt] -= num_bits;
2204 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.road[rt] += num_bits;
2205 }
2206
2207 SetRoadOwner(tile, rtt, new_owner == INVALID_OWNER ? OWNER_NONE : new_owner);
2208 }
2209 }
2210
2211 if (IsLevelCrossing(tile)) {
2212 if (GetTileOwner(tile) == old_owner) {
2213 if (new_owner == INVALID_OWNER) {
2214 DoCommand(tile, 0, GetCrossingRailTrack(tile), DC_EXEC | DC_BANKRUPT, CMD_REMOVE_SINGLE_RAIL);
2215 } else {
2216 /* Update infrastructure counts. No need to dirty windows here, we'll redraw the whole screen anyway. */
2217 Company::Get(old_owner)->infrastructure.rail[GetRailType(tile)] -= LEVELCROSSING_TRACKBIT_FACTOR;
2218 Company::Get(new_owner)->infrastructure.rail[GetRailType(tile)] += LEVELCROSSING_TRACKBIT_FACTOR;
2219
2220 SetTileOwner(tile, new_owner);
2221 }
2222 }
2223 }
2224 }
2225
2226 static CommandCost TerraformTile_Road(TileIndex tile, DoCommandFlag flags, int z_new, Slope tileh_new)
2227 {
2228 if (_settings_game.construction.build_on_slopes && AutoslopeEnabled()) {
2229 switch (GetRoadTileType(tile)) {
2230 case ROAD_TILE_CROSSING:
2231 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]);
2232 break;
2233
2234 case ROAD_TILE_DEPOT:
2235 if (AutoslopeCheckForEntranceEdge(tile, z_new, tileh_new, GetRoadDepotDirection(tile))) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
2236 break;
2237
2238 case ROAD_TILE_NORMAL: {
2239 RoadBits bits = GetAllRoadBits(tile);
2240 RoadBits bits_copy = bits;
2241 /* Check if the slope-road_bits combination is valid at all, i.e. it is safe to call GetRoadFoundation(). */
2242 if (CheckRoadSlope(tileh_new, &bits_copy, ROAD_NONE, ROAD_NONE).Succeeded()) {
2243 /* CheckRoadSlope() sometimes changes the road_bits, if it does not agree with them. */
2244 if (bits == bits_copy) {
2245 int z_old;
2246 Slope tileh_old = GetTileSlope(tile, &z_old);
2247
2248 /* Get the slope on top of the foundation */
2249 z_old += ApplyFoundationToSlope(GetRoadFoundation(tileh_old, bits), &tileh_old);
2250 z_new += ApplyFoundationToSlope(GetRoadFoundation(tileh_new, bits), &tileh_new);
2251
2252 /* The surface slope must not be changed */
2253 if ((z_old == z_new) && (tileh_old == tileh_new)) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
2254 }
2255 }
2256 break;
2257 }
2258
2259 default: NOT_REACHED();
2260 }
2261 }
2262
2263 return DoCommand(tile, 0, 0, flags, CMD_LANDSCAPE_CLEAR);
2264 }
2265
2266 /** Update power of road vehicle under which is the roadtype being converted */
2267 static Vehicle *UpdateRoadVehPowerProc(Vehicle *v, void *data)
2268 {
2269 if (v->type != VEH_ROAD) return nullptr;
2270
2271 RoadVehicleList *affected_rvs = static_cast<RoadVehicleList*>(data);
2272 include(*affected_rvs, RoadVehicle::From(v)->First());
2273
2274 return nullptr;
2275 }
2276
2277 /**
2278 * Checks the tile and returns whether the current player is allowed to convert the roadtype to another roadtype without taking ownership
2279 * @param owner the tile owner.
2280 * @param rtt Road/tram type.
2281 * @return whether the road is convertible
2282 */
2283 static bool CanConvertUnownedRoadType(Owner owner, RoadTramType rtt)
2284 {
2285 return (owner == OWNER_NONE || (owner == OWNER_TOWN && rtt == RTT_ROAD));
2286 }
2287
2288 /**
2289 * Convert the ownership of the RoadType of the tile if applyable
2290 * @param tile the tile of which convert ownership
2291 * @param num_pieces the count of the roadbits to assign to the new owner
2292 * @param owner the current owner of the RoadType
2293 * @param from_type the old road type
2294 * @param to_type the new road type
2295 */
2296 static void ConvertRoadTypeOwner(TileIndex tile, uint num_pieces, Owner owner, RoadType from_type, RoadType to_type)
2297 {
2298 // Scenario editor, maybe? Don't touch the owners when converting roadtypes...
2299 if (_current_company >= MAX_COMPANIES) return;
2300
2301 // We can't get a company from invalid owners but we can get ownership of roads without an owner
2302 if (owner >= MAX_COMPANIES && owner != OWNER_NONE) return;
2303
2304 Company *c;
2305
2306 switch (owner) {
2307 case OWNER_NONE:
2308 SetRoadOwner(tile, GetRoadTramType(to_type), (Owner)_current_company);
2309 UpdateCompanyRoadInfrastructure(to_type, _current_company, num_pieces);
2310 break;
2311
2312 default:
2313 c = Company::Get(owner);
2314 c->infrastructure.road[from_type] -= num_pieces;
2315 c->infrastructure.road[to_type] += num_pieces;
2316 DirtyCompanyInfrastructureWindows(c->index);
2317 break;
2318 }
2319 }
2320
2321 /**
2322 * Convert one road subtype to another.
2323 * Not meant to convert from road to tram.
2324 *
2325 * @param tile end tile of road conversion drag
2326 * @param flags operation to perform
2327 * @param p1 start tile of drag
2328 * @param p2 various bitstuffed elements:
2329 * - p2 = (bit 0..5) new roadtype to convert to.
2330 * @param text unused
2331 * @return the cost of this operation or an error
2332 */
2333 CommandCost CmdConvertRoad(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const char *text)
2334 {
2335 RoadType to_type = Extract<RoadType, 0, 6>(p2);
2336
2337 TileIndex area_start = p1;
2338 TileIndex area_end = tile;
2339
2340 if (!ValParamRoadType(to_type)) return CMD_ERROR;
2341 if (area_start >= MapSize()) return CMD_ERROR;
2342
2343 RoadVehicleList affected_rvs;
2344 RoadTramType rtt = GetRoadTramType(to_type);
2345
2346 CommandCost cost(EXPENSES_CONSTRUCTION);
2347 CommandCost error = CommandCost((rtt == RTT_TRAM) ? STR_ERROR_NO_SUITABLE_TRAMWAY : STR_ERROR_NO_SUITABLE_ROAD); // by default, there is no road to convert.
2348 bool found_convertible_road = false; // whether we actually did convert any road/tram (see bug #7633)
2349
2350 TileIterator *iter = new OrthogonalTileIterator(area_start, area_end);
2351 for (; (tile = *iter) != INVALID_TILE; ++(*iter)) {
2352 /* Is road present on tile? */
2353 if (!MayHaveRoad(tile)) continue;
2354
2355 /* Converting to the same subtype? */
2356 RoadType from_type = GetRoadType(tile, rtt);
2357 if (from_type == INVALID_ROADTYPE || from_type == to_type) continue;
2358
2359 /* Check if there is any infrastructure on tile */
2360 TileType tt = GetTileType(tile);
2361 switch (tt) {
2362 case MP_STATION:
2363 if (!IsRoadStop(tile)) continue;
2364 break;
2365 case MP_ROAD:
2366 if (IsLevelCrossing(tile) && RoadNoLevelCrossing(to_type)) {
2367 error.MakeError(STR_ERROR_CROSSING_DISALLOWED_ROAD);
2368 continue;
2369 }
2370 break;
2371 case MP_TUNNELBRIDGE:
2372 if (GetTunnelBridgeTransportType(tile) != TRANSPORT_ROAD) continue;
2373 break;
2374 default: continue;
2375 }
2376
2377 /* Trying to convert other's road */
2378 Owner owner = GetRoadOwner(tile, rtt);
2379 if (!CanConvertUnownedRoadType(owner, rtt)) {
2380 CommandCost ret = CheckOwnership(owner, tile);
2381 if (ret.Failed()) {
2382 error = ret;
2383 continue;
2384 }
2385 }
2386
2387 /* Vehicle on the tile when not converting normal <-> powered
2388 * Tunnels and bridges have special check later */
2389 if (tt != MP_TUNNELBRIDGE) {
2390 if (!HasPowerOnRoad(from_type, to_type)) {
2391 CommandCost ret = EnsureNoVehicleOnGround(tile);
2392 if (ret.Failed()) {
2393 error = ret;
2394 continue;
2395 }
2396
2397 if (rtt == RTT_ROAD && owner == OWNER_TOWN) {
2398 error.MakeError(STR_ERROR_INCOMPATIBLE_ROAD);
2399 continue;
2400 }
2401 }
2402
2403 uint num_pieces = CountBits(GetAnyRoadBits(tile, rtt));;
2404 found_convertible_road = true;
2405 cost.AddCost(num_pieces * RoadConvertCost(from_type, to_type));
2406
2407 if (flags & DC_EXEC) { // we can safely convert, too
2408 /* Update the company infrastructure counters. */
2409 if (!IsRoadStopTile(tile) && owner == _current_company) {
2410 ConvertRoadTypeOwner(tile, num_pieces, owner, from_type, to_type);
2411 }
2412
2413 /* Perform the conversion */
2414 SetRoadType(tile, rtt, to_type);
2415 MarkTileDirtyByTile(tile);
2416
2417 /* update power of train on this tile */
2418 FindVehicleOnPos(tile, &affected_rvs, &UpdateRoadVehPowerProc);
2419
2420 if (IsRoadDepotTile(tile)) {
2421 /* Update build vehicle window related to this depot */
2422 InvalidateWindowData(WC_VEHICLE_DEPOT, tile);
2423 InvalidateWindowData(WC_BUILD_VEHICLE, tile);
2424 }
2425 }
2426 } else {
2427 TileIndex endtile = GetOtherTunnelBridgeEnd(tile);
2428
2429 /* If both ends of tunnel/bridge are in the range, do not try to convert twice -
2430 * it would cause assert because of different test and exec runs */
2431 if (endtile < tile) {
2432 if (OrthogonalTileArea(area_start, area_end).Contains(endtile)) continue;
2433 }
2434
2435 /* When not converting rail <-> el. rail, any vehicle cannot be in tunnel/bridge */
2436 if (!HasPowerOnRoad(from_type, to_type)) {
2437 CommandCost ret = TunnelBridgeIsFree(tile, endtile);
2438 if (ret.Failed()) {
2439 error = ret;
2440 continue;
2441 }
2442
2443 if (rtt == RTT_ROAD && owner == OWNER_TOWN) {
2444 error.MakeError(STR_ERROR_INCOMPATIBLE_ROAD);
2445 continue;
2446 }
2447 }
2448
2449 /* There are 2 pieces on *every* tile of the bridge or tunnel */
2450 uint num_pieces = (GetTunnelBridgeLength(tile, endtile) + 2) * 2;
2451 found_convertible_road = true;
2452 cost.AddCost(num_pieces * RoadConvertCost(from_type, to_type));
2453
2454 if (flags & DC_EXEC) {
2455 /* Update the company infrastructure counters. */
2456 if (owner == _current_company) {
2457 ConvertRoadTypeOwner(tile, num_pieces, owner, from_type, to_type);
2458 ConvertRoadTypeOwner(endtile, num_pieces, owner, from_type, to_type);
2459 SetTunnelBridgeOwner(tile, endtile, _current_company);
2460 }
2461
2462 /* Perform the conversion */
2463 SetRoadType(tile, rtt, to_type);
2464 SetRoadType(endtile, rtt, to_type);
2465
2466 FindVehicleOnPos(tile, &affected_rvs, &UpdateRoadVehPowerProc);
2467 FindVehicleOnPos(endtile, &affected_rvs, &UpdateRoadVehPowerProc);
2468
2469 if (IsBridge(tile)) {
2470 MarkBridgeDirty(tile);
2471 } else {
2472 MarkTileDirtyByTile(tile);
2473 MarkTileDirtyByTile(endtile);
2474 }
2475 }
2476 }
2477 }
2478
2479 if (flags & DC_EXEC) {
2480 /* Roadtype changed, update roadvehicles as when entering different track */
2481 for (RoadVehicle *v : affected_rvs) {
2482 v->CargoChanged();
2483 }
2484 }
2485
2486 delete iter;
2487 return found_convertible_road ? cost : error;
2488 }
2489
2490
2491 /** Tile callback functions for road tiles */
2492 extern const TileTypeProcs _tile_type_road_procs = {
2493 DrawTile_Road, // draw_tile_proc
2494 GetSlopePixelZ_Road, // get_slope_z_proc
2495 ClearTile_Road, // clear_tile_proc
2496 nullptr, // add_accepted_cargo_proc
2497 GetTileDesc_Road, // get_tile_desc_proc
2498 GetTileTrackStatus_Road, // get_tile_track_status_proc
2499 ClickTile_Road, // click_tile_proc
2500 nullptr, // animate_tile_proc
2501 TileLoop_Road, // tile_loop_proc
2502 ChangeTileOwner_Road, // change_tile_owner_proc
2503 nullptr, // add_produced_cargo_proc
2504 VehicleEnter_Road, // vehicle_enter_tile_proc
2505 GetFoundation_Road, // get_foundation_proc
2506 TerraformTile_Road, // terraform_tile_proc
2507 };
OpenTTD is an open source simulation game based upon Transport Tycoon Deluxe