OpenTTD Source 20260107-master-g88a467db19
tunnelbridge_cmd.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
6 */
7
13#include "stdafx.h"
14#include "viewport_func.h"
15#include "command_func.h"
16#include "town.h"
17#include "train.h"
18#include "ship.h"
19#include "roadveh.h"
21#include "newgrf_sound.h"
22#include "autoslope.h"
23#include "tunnelbridge_map.h"
24#include "strings_func.h"
26#include "clear_func.h"
27#include "vehicle_func.h"
28#include "sound_func.h"
29#include "tunnelbridge.h"
30#include "cheat_type.h"
31#include "elrail_func.h"
32#include "pbs.h"
33#include "company_base.h"
34#include "newgrf_railtype.h"
35#include "newgrf_roadtype.h"
36#include "object_base.h"
37#include "water.h"
38#include "company_gui.h"
39#include "tunnelbridge_cmd.h"
40#include "landscape_cmd.h"
41#include "terraform_cmd.h"
42
43#include "table/strings.h"
44#include "table/bridge_land.h"
45
46#include "safeguards.h"
47
50
52static const int BRIDGE_Z_START = 3;
53
54
63void MarkBridgeDirty(TileIndex begin, TileIndex end, DiagDirection direction, uint bridge_height)
64{
65 TileIndexDiff delta = TileOffsByDiagDir(direction);
66 for (TileIndex t = begin; t != end; t += delta) {
67 MarkTileDirtyByTile(t, bridge_height - TileHeight(t));
68 }
70}
71
80
83{
84 std::ranges::copy(_orig_bridge, std::begin(_bridge));
85}
86
94{
95 if (length < 2) return length;
96
97 length -= 2;
98 int sum = 2;
99 for (int delta = 1;; delta++) {
100 for (int count = 0; count < delta; count++) {
101 if (length == 0) return sum;
102 sum += delta;
103 length--;
104 }
105 }
106}
107
115{
116 if (tileh == SLOPE_FLAT ||
117 ((tileh == SLOPE_NE || tileh == SLOPE_SW) && axis == AXIS_X) ||
118 ((tileh == SLOPE_NW || tileh == SLOPE_SE) && axis == AXIS_Y)) return FOUNDATION_NONE;
119
120 return (HasSlopeHighestCorner(tileh) ? InclinedFoundation(axis) : FlatteningFoundation(tileh));
121}
122
130bool HasBridgeFlatRamp(Slope tileh, Axis axis)
131{
132 ApplyFoundationToSlope(GetBridgeFoundation(tileh, axis), tileh);
133 /* If the foundation slope is flat the bridge has a non-flat ramp and vice versa. */
134 return (tileh != SLOPE_FLAT);
135}
136
144{
145 assert(piece < NUM_BRIDGE_PIECES);
146 const BridgeSpec *bridge = GetBridgeSpec(bridge_type);
147 return piece < bridge->sprite_table.size() && !bridge->sprite_table[piece].empty();
148}
149
156static std::span<const PalSpriteID> GetBridgeSpriteTable(BridgeType bridge_type, BridgePieces piece)
157{
158 assert(piece < NUM_BRIDGE_PIECES);
159
160 const BridgeSpec *bridge = GetBridgeSpec(bridge_type);
161 if (piece < bridge->sprite_table.size() && !bridge->sprite_table[piece].empty()) return bridge->sprite_table[piece];
162
163 return _bridge_sprite_table[bridge_type][piece];
164}
165
172static uint8_t GetBridgeSpriteTableBaseOffset(TransportType transport_type, TileIndex ramp)
173{
174 switch (transport_type) {
176 case TRANSPORT_ROAD: return 8;
177 default: NOT_REACHED();
178 }
179}
180
187{
188 /* Bridge ramps are ordered SW, SE, NE, NW instead of NE, SE, SW, NW. */
189 static constexpr uint8_t ramp_offsets[DIAGDIR_END] = {2, 1, 0, 3};
190 return ramp_offsets[diagdir];
191}
192
199{
200 return axis == AXIS_X ? 0 : 4;
201}
202
212static CommandCost CheckBridgeSlope(BridgePieces bridge_piece, Axis axis, Slope &tileh, int &z)
213{
214 assert(bridge_piece == BRIDGE_PIECE_NORTH || bridge_piece == BRIDGE_PIECE_SOUTH);
215
216 Foundation f = GetBridgeFoundation(tileh, axis);
217 z += ApplyFoundationToSlope(f, tileh);
218
219 Slope valid_inclined;
220 if (bridge_piece == BRIDGE_PIECE_NORTH) {
221 valid_inclined = (axis == AXIS_X ? SLOPE_NE : SLOPE_NW);
222 } else {
223 valid_inclined = (axis == AXIS_X ? SLOPE_SW : SLOPE_SE);
224 }
225 if ((tileh != SLOPE_FLAT) && (tileh != valid_inclined)) return CMD_ERROR;
226
227 if (f == FOUNDATION_NONE) return CommandCost();
228
229 return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
230}
231
240{
241 if (flags.Test(DoCommandFlag::QueryCost)) {
242 if (bridge_len <= _settings_game.construction.max_bridge_length) return CommandCost();
243 return CommandCost(STR_ERROR_BRIDGE_TOO_LONG);
244 }
245
246 if (bridge_type >= MAX_BRIDGES) return CMD_ERROR;
247
248 const BridgeSpec *b = GetBridgeSpec(bridge_type);
250
252
253 if (b->min_length > bridge_len) return CMD_ERROR;
254 if (bridge_len <= max) return CommandCost();
255 return CommandCost(STR_ERROR_BRIDGE_TOO_LONG);
256}
257
264{
265 Money base_cost = _price[base_price];
266
267 /* Add the cost of the transport that is on the tunnel/bridge. */
268 switch (GetTunnelBridgeTransportType(tile)) {
269 case TRANSPORT_ROAD: {
270 RoadType road_rt = GetRoadTypeRoad(tile);
271 RoadType tram_rt = GetRoadTypeTram(tile);
272
273 if (road_rt != INVALID_ROADTYPE) {
274 base_cost += 2 * RoadClearCost(road_rt);
275 }
276 if (tram_rt != INVALID_ROADTYPE) {
277 base_cost += 2 * RoadClearCost(tram_rt);
278 }
279 } break;
280
281 case TRANSPORT_RAIL: base_cost += RailClearCost(GetRailType(tile)); break;
282 /* Aqueducts have their own clear price. */
283 case TRANSPORT_WATER: base_cost = _price[PR_CLEAR_AQUEDUCT]; break;
284 default: break;
285 }
286
287 return base_cost;
288}
289
290static CommandCost CheckBuildAbove(TileIndex tile, DoCommandFlags flags, Axis axis, int height)
291{
292 if (_tile_type_procs[GetTileType(tile)]->check_build_above_proc != nullptr) {
293 return _tile_type_procs[GetTileType(tile)]->check_build_above_proc(tile, flags, axis, height);
294 }
295 /* A tile without a handler must be cleared. */
296 return Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
297}
298
309CommandCost CmdBuildBridge(DoCommandFlags flags, TileIndex tile_end, TileIndex tile_start, TransportType transport_type, BridgeType bridge_type, uint8_t road_rail_type)
310{
311 CompanyID company = _current_company;
312
313 RailType railtype = INVALID_RAILTYPE;
314 RoadType roadtype = INVALID_ROADTYPE;
315
316 if (!IsValidTile(tile_start)) return CommandCost(STR_ERROR_BRIDGE_THROUGH_MAP_BORDER);
317
318 /* type of bridge */
319 switch (transport_type) {
320 case TRANSPORT_ROAD:
321 roadtype = (RoadType)road_rail_type;
322 if (!ValParamRoadType(roadtype)) return CMD_ERROR;
323 break;
324
325 case TRANSPORT_RAIL:
326 railtype = (RailType)road_rail_type;
327 if (!ValParamRailType(railtype)) return CMD_ERROR;
328 break;
329
330 case TRANSPORT_WATER:
331 break;
332
333 default:
334 /* Airports don't have bridges. */
335 return CMD_ERROR;
336 }
337
338 if (company == OWNER_DEITY) {
339 if (transport_type != TRANSPORT_ROAD) return CMD_ERROR;
340 const Town *town = CalcClosestTownFromTile(tile_start);
341
342 company = OWNER_TOWN;
343
344 /* If we are not within a town, we are not owned by the town */
345 if (town == nullptr || DistanceSquare(tile_start, town->xy) > town->cache.squared_town_zone_radius[to_underlying(HouseZone::TownEdge)]) {
346 company = OWNER_NONE;
347 }
348 }
349
350 if (tile_start == tile_end) {
351 return CommandCost(STR_ERROR_CAN_T_START_AND_END_ON);
352 }
353
354 Axis direction;
355 if (TileX(tile_start) == TileX(tile_end)) {
356 direction = AXIS_Y;
357 } else if (TileY(tile_start) == TileY(tile_end)) {
358 direction = AXIS_X;
359 } else {
360 return CommandCost(STR_ERROR_START_AND_END_MUST_BE_IN);
361 }
362
363 if (tile_end < tile_start) std::swap(tile_start, tile_end);
364
365 uint bridge_len = GetTunnelBridgeLength(tile_start, tile_end);
366 if (transport_type != TRANSPORT_WATER) {
367 /* set and test bridge length, availability */
368 CommandCost ret = CheckBridgeAvailability(bridge_type, bridge_len, flags);
369 if (ret.Failed()) return ret;
370 } else {
371 if (bridge_len > _settings_game.construction.max_bridge_length) return CommandCost(STR_ERROR_BRIDGE_TOO_LONG);
372 }
373 bridge_len += 2; // begin and end tiles/ramps
374
375 auto [tileh_start, z_start] = GetTileSlopeZ(tile_start);
376 auto [tileh_end, z_end] = GetTileSlopeZ(tile_end);
377 bool pbs_reservation = false;
378
379 CommandCost terraform_cost_north = CheckBridgeSlope(BRIDGE_PIECE_NORTH, direction, tileh_start, z_start);
380 CommandCost terraform_cost_south = CheckBridgeSlope(BRIDGE_PIECE_SOUTH, direction, tileh_end, z_end);
381
382 /* Aqueducts can't be built of flat land. */
383 if (transport_type == TRANSPORT_WATER && (tileh_start == SLOPE_FLAT || tileh_end == SLOPE_FLAT)) return CommandCost(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
384 if (z_start != z_end) return CommandCost(STR_ERROR_BRIDGEHEADS_NOT_SAME_HEIGHT);
385
387 Owner owner;
388 bool is_new_owner;
389 RoadType road_rt = INVALID_ROADTYPE;
390 RoadType tram_rt = INVALID_ROADTYPE;
391 if (IsBridgeTile(tile_start) && IsBridgeTile(tile_end) &&
392 GetOtherBridgeEnd(tile_start) == tile_end &&
393 GetTunnelBridgeTransportType(tile_start) == transport_type) {
394 /* Replace a current bridge. */
395
396 switch (transport_type) {
397 case TRANSPORT_RAIL:
398 /* Keep the reservation, the path stays valid. */
399 pbs_reservation = HasTunnelBridgeReservation(tile_start);
400 break;
401
402 case TRANSPORT_ROAD:
403 /* Do not remove road types when upgrading a bridge */
404 road_rt = GetRoadTypeRoad(tile_start);
405 tram_rt = GetRoadTypeTram(tile_start);
406 break;
407
408 default: break;
409 }
410
411 /* If this is a railway bridge, make sure the railtypes match. */
412 if (transport_type == TRANSPORT_RAIL && GetRailType(tile_start) != railtype) {
413 return CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
414 }
415
416 /* If this is a road bridge, make sure the roadtype matches. */
417 if (transport_type == TRANSPORT_ROAD) {
418 RoadType existing_rt = RoadTypeIsRoad(roadtype) ? road_rt : tram_rt;
419 if (existing_rt != roadtype && existing_rt != INVALID_ROADTYPE) {
420 return CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
421 }
422 }
423
424 if (!flags.Test(DoCommandFlag::QueryCost)) {
425 /* Do not replace the bridge with the same bridge type. */
426 if ((bridge_type == GetBridgeType(tile_start)) && (transport_type != TRANSPORT_ROAD || road_rt == roadtype || tram_rt == roadtype)) {
427 return CommandCost(STR_ERROR_ALREADY_BUILT);
428 }
429
430 /* Do not replace town bridges with lower speed bridges, unless in scenario editor. */
431 if (IsTileOwner(tile_start, OWNER_TOWN) && _game_mode != GM_EDITOR) {
432 Town *t = ClosestTownFromTile(tile_start, UINT_MAX);
433 if (t == nullptr) return CMD_ERROR;
434
435 if (GetBridgeSpec(bridge_type)->speed < GetBridgeSpec(GetBridgeType(tile_start))->speed) {
436 return CommandCostWithParam(STR_ERROR_LOCAL_AUTHORITY_REFUSES_TO_ALLOW_THIS, t->index);
437 } else {
438 ChangeTownRating(t, RATING_TUNNEL_BRIDGE_UP_STEP, RATING_MAXIMUM, flags);
439 }
440 }
441 }
442
443 /* Do not allow replacing another company's bridges. */
444 if (!IsTileOwner(tile_start, company) && !IsTileOwner(tile_start, OWNER_TOWN) && !IsTileOwner(tile_start, OWNER_NONE)) {
445 return CommandCost(STR_ERROR_AREA_IS_OWNED_BY_ANOTHER);
446 }
447
448 /* The cost of clearing the current bridge. */
449 cost.AddCost(bridge_len * TunnelBridgeClearCost(tile_start, PR_CLEAR_BRIDGE));
450 owner = GetTileOwner(tile_start);
451
452 /* If bridge belonged to bankrupt company, it has a new owner now */
453 is_new_owner = (owner == OWNER_NONE);
454 if (is_new_owner) owner = company;
455
456 /* Check if the new bridge is compatible with tiles underneath. */
457 TileIndexDiff delta = (direction == AXIS_X ? TileDiffXY(1, 0) : TileDiffXY(0, 1));
458 for (TileIndex tile = tile_start + delta; tile != tile_end; tile += delta) {
459 CommandCost ret = CheckBuildAbove(tile, flags, direction, z_start + 1);
460 if (ret.Failed()) return ret;
461 cost.AddCost(ret.GetCost());
462 }
463 } else {
464 /* Build a new bridge. */
465
466 bool allow_on_slopes = (_settings_game.construction.build_on_slopes && transport_type != TRANSPORT_WATER);
467
468 /* Try and clear the start landscape */
469 CommandCost ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile_start);
470 if (ret.Failed()) return ret;
471 cost = ret;
472
473 if (terraform_cost_north.Failed() || (terraform_cost_north.GetCost() != 0 && !allow_on_slopes)) return CommandCost(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
474 cost.AddCost(terraform_cost_north.GetCost());
475
476 /* Try and clear the end landscape */
477 ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile_end);
478 if (ret.Failed()) return ret;
479 cost.AddCost(ret.GetCost());
480
481 /* false - end tile slope check */
482 if (terraform_cost_south.Failed() || (terraform_cost_south.GetCost() != 0 && !allow_on_slopes)) return CommandCost(STR_ERROR_LAND_SLOPED_IN_WRONG_DIRECTION);
483 cost.AddCost(terraform_cost_south.GetCost());
484
485 /* Check for bridges above the bridge ramps. */
486 for (TileIndex tile : {tile_start, tile_end}) {
487 if (!IsBridgeAbove(tile)) continue;
488
489 if (direction == GetBridgeAxis(tile)) return CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
490
491 if (z_start + 1 == GetBridgeHeight(GetNorthernBridgeEnd(tile))) return CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
492 }
493
494 TileIndexDiff delta = TileOffsByAxis(direction);
495 for (TileIndex tile = tile_start + delta; tile != tile_end; tile += delta) {
496 if (GetTileMaxZ(tile) > z_start) return CommandCost(STR_ERROR_BRIDGE_TOO_LOW_FOR_TERRAIN);
497
498 if (z_start >= (GetTileZ(tile) + _settings_game.construction.max_bridge_height)) {
499 /*
500 * Disallow too high bridges.
501 * Properly rendering a map where very high bridges (might) exist is expensive.
502 * See http://www.tt-forums.net/viewtopic.php?f=33&t=40844&start=980#p1131762
503 * for a detailed discussion. z_start here is one heightlevel below the bridge level.
504 */
505 return CommandCost(STR_ERROR_BRIDGE_TOO_HIGH_FOR_TERRAIN);
506 }
507
508 if (IsBridgeAbove(tile)) {
509 /* Disallow crossing bridges for the time being */
510 return CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
511 }
512
513 ret = CheckBuildAbove(tile, flags, direction, z_start + 1);
514 if (ret.Failed()) return ret;
515 cost.AddCost(ret.GetCost());
516
517 if (flags.Test(DoCommandFlag::Execute)) {
518 /* We do this here because when replacing a bridge with another
519 * type calling SetBridgeMiddle isn't needed. After all, the
520 * tile already has the has_bridge_above bits set. */
521 SetBridgeMiddle(tile, direction);
522 }
523 }
524
525 owner = company;
526 is_new_owner = true;
527 }
528
529 bool hasroad = road_rt != INVALID_ROADTYPE;
530 bool hastram = tram_rt != INVALID_ROADTYPE;
531 if (transport_type == TRANSPORT_ROAD) {
532 if (RoadTypeIsRoad(roadtype)) road_rt = roadtype;
533 if (RoadTypeIsTram(roadtype)) tram_rt = roadtype;
534 }
535
536 /* do the drill? */
537 if (flags.Test(DoCommandFlag::Execute)) {
538 DiagDirection dir = AxisToDiagDir(direction);
539
540 Company *c = Company::GetIfValid(company);
541 switch (transport_type) {
542 case TRANSPORT_RAIL:
543 /* Add to company infrastructure count if required. */
544 if (is_new_owner && c != nullptr) c->infrastructure.rail[railtype] += bridge_len * TUNNELBRIDGE_TRACKBIT_FACTOR;
545 MakeRailBridgeRamp(tile_start, owner, bridge_type, dir, railtype);
546 MakeRailBridgeRamp(tile_end, owner, bridge_type, ReverseDiagDir(dir), railtype);
547 SetTunnelBridgeReservation(tile_start, pbs_reservation);
548 SetTunnelBridgeReservation(tile_end, pbs_reservation);
549 break;
550
551 case TRANSPORT_ROAD: {
552 if (is_new_owner) {
553 /* Also give unowned present roadtypes to new owner */
554 if (hasroad && GetRoadOwner(tile_start, RTT_ROAD) == OWNER_NONE) hasroad = false;
555 if (hastram && GetRoadOwner(tile_start, RTT_TRAM) == OWNER_NONE) hastram = false;
556 }
557 if (c != nullptr) {
558 /* Add all new road types to the company infrastructure counter. */
559 if (!hasroad && road_rt != INVALID_ROADTYPE) {
560 /* A full diagonal road tile has two road bits. */
561 c->infrastructure.road[road_rt] += bridge_len * 2 * TUNNELBRIDGE_TRACKBIT_FACTOR;
562 }
563 if (!hastram && tram_rt != INVALID_ROADTYPE) {
564 /* A full diagonal road tile has two road bits. */
565 c->infrastructure.road[tram_rt] += bridge_len * 2 * TUNNELBRIDGE_TRACKBIT_FACTOR;
566 }
567 }
568 Owner owner_road = hasroad ? GetRoadOwner(tile_start, RTT_ROAD) : company;
569 Owner owner_tram = hastram ? GetRoadOwner(tile_start, RTT_TRAM) : company;
570 MakeRoadBridgeRamp(tile_start, owner, owner_road, owner_tram, bridge_type, dir, road_rt, tram_rt);
571 MakeRoadBridgeRamp(tile_end, owner, owner_road, owner_tram, bridge_type, ReverseDiagDir(dir), road_rt, tram_rt);
572 break;
573 }
574
575 case TRANSPORT_WATER:
576 if (is_new_owner && c != nullptr) c->infrastructure.water += bridge_len * TUNNELBRIDGE_TRACKBIT_FACTOR;
577 MakeAqueductBridgeRamp(tile_start, owner, dir);
578 MakeAqueductBridgeRamp(tile_end, owner, ReverseDiagDir(dir));
579 CheckForDockingTile(tile_start);
580 CheckForDockingTile(tile_end);
581 break;
582
583 default:
584 NOT_REACHED();
585 }
586
587 /* Mark all tiles dirty */
588 MarkBridgeDirty(tile_start, tile_end, AxisToDiagDir(direction), z_start);
590 }
591
592 if (flags.Test(DoCommandFlag::Execute) && transport_type == TRANSPORT_RAIL) {
593 Track track = AxisToTrack(direction);
594 AddSideToSignalBuffer(tile_start, INVALID_DIAGDIR, company);
595 YapfNotifyTrackLayoutChange(tile_start, track);
596 }
597
598 /* Human players that build bridges get a selection to choose from (DoCommandFlag::QueryCost)
599 * It's unnecessary to execute this command every time for every bridge.
600 * So it is done only for humans and cost is computed in bridge_gui.cpp.
601 * For (non-spectated) AI, Towns this has to be of course calculated. */
602 Company *c = Company::GetIfValid(company);
603 if (!flags.Test(DoCommandFlag::QueryCost) || (c != nullptr && c->is_ai && company != _local_company)) {
604 switch (transport_type) {
605 case TRANSPORT_ROAD:
606 if (road_rt != INVALID_ROADTYPE) {
607 cost.AddCost(bridge_len * 2 * RoadBuildCost(road_rt));
608 }
609 if (tram_rt != INVALID_ROADTYPE) {
610 cost.AddCost(bridge_len * 2 * RoadBuildCost(tram_rt));
611 }
612 break;
613
614 case TRANSPORT_RAIL: cost.AddCost(bridge_len * RailBuildCost(railtype)); break;
615 default: break;
616 }
617
618 if (c != nullptr) bridge_len = CalcBridgeLenCostFactor(bridge_len);
619
620 if (transport_type != TRANSPORT_WATER) {
621 cost.AddCost((int64_t)bridge_len * _price[PR_BUILD_BRIDGE] * GetBridgeSpec(bridge_type)->price >> 8);
622 } else {
623 /* Aqueducts use a separate base cost. */
624 cost.AddCost((int64_t)bridge_len * _price[PR_BUILD_AQUEDUCT]);
625 }
626
627 }
628
629 return cost;
630}
631
632
641CommandCost CmdBuildTunnel(DoCommandFlags flags, TileIndex start_tile, TransportType transport_type, uint8_t road_rail_type)
642{
643 CompanyID company = _current_company;
644
645 RailType railtype = INVALID_RAILTYPE;
646 RoadType roadtype = INVALID_ROADTYPE;
648 switch (transport_type) {
649 case TRANSPORT_RAIL:
650 railtype = (RailType)road_rail_type;
651 if (!ValParamRailType(railtype)) return CMD_ERROR;
652 break;
653
654 case TRANSPORT_ROAD:
655 roadtype = (RoadType)road_rail_type;
656 if (!ValParamRoadType(roadtype)) return CMD_ERROR;
657 break;
658
659 default: return CMD_ERROR;
660 }
661
662 if (company == OWNER_DEITY) {
663 if (transport_type != TRANSPORT_ROAD) return CMD_ERROR;
664 const Town *town = CalcClosestTownFromTile(start_tile);
665
666 company = OWNER_TOWN;
667
668 /* If we are not within a town, we are not owned by the town */
669 if (town == nullptr || DistanceSquare(start_tile, town->xy) > town->cache.squared_town_zone_radius[to_underlying(HouseZone::TownEdge)]) {
670 company = OWNER_NONE;
671 }
672 }
673
674 auto [start_tileh, start_z] = GetTileSlopeZ(start_tile);
675 DiagDirection direction = GetInclinedSlopeDirection(start_tileh);
676 if (direction == INVALID_DIAGDIR) return CommandCost(STR_ERROR_SITE_UNSUITABLE_FOR_TUNNEL);
677
678 if (HasTileWaterGround(start_tile)) return CommandCost(STR_ERROR_CAN_T_BUILD_ON_WATER);
679
680 CommandCost ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, start_tile);
681 if (ret.Failed()) return ret;
682
683 /* XXX - do NOT change 'ret' in the loop, as it is used as the price
684 * for the clearing of the entrance of the tunnel. Assigning it to
685 * cost before the loop will yield different costs depending on start-
686 * position, because of increased-cost-by-length: 'cost += cost >> 3' */
687
688 TileIndexDiff delta = TileOffsByDiagDir(direction);
689 DiagDirection tunnel_in_way_dir;
690 if (DiagDirToAxis(direction) == AXIS_Y) {
691 tunnel_in_way_dir = (TileX(start_tile) < (Map::MaxX() / 2)) ? DIAGDIR_SW : DIAGDIR_NE;
692 } else {
693 tunnel_in_way_dir = (TileY(start_tile) < (Map::MaxX() / 2)) ? DIAGDIR_SE : DIAGDIR_NW;
694 }
695
696 TileIndex end_tile = start_tile;
697
698 /* Tile shift coefficient. Will decrease for very long tunnels to avoid exponential growth of price*/
699 int tiles_coef = 3;
700 /* Number of tiles from start of tunnel */
701 int tiles = 0;
702 /* Number of tiles at which the cost increase coefficient per tile is halved */
703 int tiles_bump = 25;
704
706 Slope end_tileh;
707 int end_z;
708 for (;;) {
709 end_tile += delta;
710 if (!IsValidTile(end_tile)) return CommandCost(STR_ERROR_TUNNEL_THROUGH_MAP_BORDER);
711 std::tie(end_tileh, end_z) = GetTileSlopeZ(end_tile);
712
713 if (start_z == end_z) break;
714
715 if (!_cheats.crossing_tunnels.value && IsTunnelInWayDir(end_tile, start_z, tunnel_in_way_dir)) {
716 return CommandCost(STR_ERROR_ANOTHER_TUNNEL_IN_THE_WAY);
717 }
718
719 tiles++;
720 if (tiles == tiles_bump) {
721 tiles_coef++;
722 tiles_bump *= 2;
723 }
724
725 cost.AddCost(_price[PR_BUILD_TUNNEL]);
726 cost.AddCost(cost.GetCost() >> tiles_coef); // add a multiplier for longer tunnels
727 }
728
729 /* Add the cost of the entrance */
730 cost.AddCost(_price[PR_BUILD_TUNNEL]);
731 cost.AddCost(ret.GetCost());
732
733 /* if the command fails from here on we want the end tile to be highlighted */
734 _build_tunnel_endtile = end_tile;
735
736 if (tiles > _settings_game.construction.max_tunnel_length) return CommandCost(STR_ERROR_TUNNEL_TOO_LONG);
737
738 if (HasTileWaterGround(end_tile)) return CommandCost(STR_ERROR_CAN_T_BUILD_ON_WATER);
739
740 /* Clear the tile in any case */
741 ret = Command<CMD_LANDSCAPE_CLEAR>::Do(flags, end_tile);
742 if (ret.Failed()) return CommandCost(STR_ERROR_UNABLE_TO_EXCAVATE_LAND);
743 cost.AddCost(ret.GetCost());
744
745 /* slope of end tile must be complementary to the slope of the start tile */
746 if (end_tileh != ComplementSlope(start_tileh)) {
747 /* Mark the tile as already cleared for the terraform command.
748 * Do this for all tiles (like trees), not only objects. */
749 ClearedObjectArea *coa = FindClearedObject(end_tile);
750 if (coa == nullptr) {
751 coa = &_cleared_object_areas.emplace_back(end_tile, TileArea(end_tile, 1, 1));
752 }
753
754 /* Hide the tile from the terraforming command */
755 TileIndex old_first_tile = coa->first_tile;
757
758 /* CMD_TERRAFORM_LAND may append further items to _cleared_object_areas,
759 * however it will never erase or re-order existing items.
760 * _cleared_object_areas is a value-type self-resizing vector, therefore appending items
761 * may result in a backing-store re-allocation, which would invalidate the coa pointer.
762 * The index of the coa pointer into the _cleared_object_areas vector remains valid,
763 * and can be used safely after the CMD_TERRAFORM_LAND operation.
764 * Deliberately clear the coa pointer to avoid leaving dangling pointers which could
765 * inadvertently be dereferenced.
766 */
767 ClearedObjectArea *begin = _cleared_object_areas.data();
768 assert(coa >= begin && coa < begin + _cleared_object_areas.size());
769 size_t coa_index = coa - begin;
770 assert(coa_index < UINT_MAX); // more than 2**32 cleared areas would be a bug in itself
771 coa = nullptr;
772
773 ret = std::get<0>(Command<CMD_TERRAFORM_LAND>::Do(flags, end_tile, end_tileh & start_tileh, false));
774 _cleared_object_areas[(uint)coa_index].first_tile = old_first_tile;
775 if (ret.Failed()) return CommandCost(STR_ERROR_UNABLE_TO_EXCAVATE_LAND);
776 cost.AddCost(ret.GetCost());
777 }
778 cost.AddCost(_price[PR_BUILD_TUNNEL]);
779
780 /* Pay for the rail/road in the tunnel including entrances */
781 switch (transport_type) {
782 case TRANSPORT_ROAD: cost.AddCost((tiles + 2) * RoadBuildCost(roadtype) * 2); break;
783 case TRANSPORT_RAIL: cost.AddCost((tiles + 2) * RailBuildCost(railtype)); break;
784 default: NOT_REACHED();
785 }
786
787 if (flags.Test(DoCommandFlag::Execute)) {
788 Company *c = Company::GetIfValid(company);
789 uint num_pieces = (tiles + 2) * TUNNELBRIDGE_TRACKBIT_FACTOR;
790 if (transport_type == TRANSPORT_RAIL) {
791 if (c != nullptr) c->infrastructure.rail[railtype] += num_pieces;
792 MakeRailTunnel(start_tile, company, direction, railtype);
793 MakeRailTunnel(end_tile, company, ReverseDiagDir(direction), railtype);
794 AddSideToSignalBuffer(start_tile, INVALID_DIAGDIR, company);
795 YapfNotifyTrackLayoutChange(start_tile, DiagDirToDiagTrack(direction));
796 } else {
797 if (c != nullptr) c->infrastructure.road[roadtype] += num_pieces * 2; // A full diagonal road has two road bits.
798 RoadType road_rt = RoadTypeIsRoad(roadtype) ? roadtype : INVALID_ROADTYPE;
799 RoadType tram_rt = RoadTypeIsTram(roadtype) ? roadtype : INVALID_ROADTYPE;
800 MakeRoadTunnel(start_tile, company, direction, road_rt, tram_rt);
801 MakeRoadTunnel(end_tile, company, ReverseDiagDir(direction), road_rt, tram_rt);
802 }
804 }
805
806 return cost;
807}
808
809
816{
817 /* Floods can remove anything as well as the scenario editor */
818 if (_current_company == OWNER_WATER || _game_mode == GM_EDITOR) return CommandCost();
819
820 switch (GetTunnelBridgeTransportType(tile)) {
821 case TRANSPORT_ROAD: {
822 RoadType road_rt = GetRoadTypeRoad(tile);
823 RoadType tram_rt = GetRoadTypeTram(tile);
824 Owner road_owner = _current_company;
825 Owner tram_owner = _current_company;
826
827 if (road_rt != INVALID_ROADTYPE) road_owner = GetRoadOwner(tile, RTT_ROAD);
828 if (tram_rt != INVALID_ROADTYPE) tram_owner = GetRoadOwner(tile, RTT_TRAM);
829
830 /* We can remove unowned road and if the town allows it */
832 /* Town does not allow */
833 return CheckTileOwnership(tile);
834 }
835 if (road_owner == OWNER_NONE || road_owner == OWNER_TOWN) road_owner = _current_company;
836 if (tram_owner == OWNER_NONE) tram_owner = _current_company;
837
838 CommandCost ret = CheckOwnership(road_owner, tile);
839 if (ret.Succeeded()) ret = CheckOwnership(tram_owner, tile);
840 return ret;
841 }
842
843 case TRANSPORT_RAIL:
844 return CheckOwnership(GetTileOwner(tile));
845
846 case TRANSPORT_WATER: {
847 /* Always allow to remove aqueducts without owner. */
848 Owner aqueduct_owner = GetTileOwner(tile);
849 if (aqueduct_owner == OWNER_NONE) aqueduct_owner = _current_company;
850 return CheckOwnership(aqueduct_owner);
851 }
852
853 default: NOT_REACHED();
854 }
855}
856
864{
866 if (ret.Failed()) return ret;
867
868 TileIndex endtile = GetOtherTunnelEnd(tile);
869
870 ret = TunnelBridgeIsFree(tile, endtile);
871 if (ret.Failed()) return ret;
872
873 _build_tunnel_endtile = endtile;
874
875 Town *t = nullptr;
876 if (IsTileOwner(tile, OWNER_TOWN) && _game_mode != GM_EDITOR) {
877 t = ClosestTownFromTile(tile, UINT_MAX); // town penalty rating
878
879 /* Check if you are allowed to remove the tunnel owned by a town
880 * Removal depends on difficulty settings */
882 if (ret.Failed()) return ret;
883 }
884
885 /* checks if the owner is town then decrease town rating by RATING_TUNNEL_BRIDGE_DOWN_STEP until
886 * you have a "Poor" (0) town rating */
887 if (IsTileOwner(tile, OWNER_TOWN) && _game_mode != GM_EDITOR) {
889 }
890
891 Money base_cost = TunnelBridgeClearCost(tile, PR_CLEAR_TUNNEL);
892 uint len = GetTunnelBridgeLength(tile, endtile) + 2; // Don't forget the end tiles.
893
894 if (flags.Test(DoCommandFlag::Execute)) {
896 /* We first need to request values before calling DoClearSquare */
898 Track track = DiagDirToDiagTrack(dir);
899 Owner owner = GetTileOwner(tile);
900
901 Train *v = nullptr;
902 if (HasTunnelBridgeReservation(tile)) {
903 v = GetTrainForReservation(tile, track);
904 if (v != nullptr) FreeTrainTrackReservation(v);
905 }
906
907 if (Company::IsValidID(owner)) {
908 Company::Get(owner)->infrastructure.rail[GetRailType(tile)] -= len * TUNNELBRIDGE_TRACKBIT_FACTOR;
910 }
911
912 DoClearSquare(tile);
913 DoClearSquare(endtile);
914
915 /* cannot use INVALID_DIAGDIR for signal update because the tunnel doesn't exist anymore */
916 AddSideToSignalBuffer(tile, ReverseDiagDir(dir), owner);
917 AddSideToSignalBuffer(endtile, dir, owner);
918
919 YapfNotifyTrackLayoutChange(tile, track);
920 YapfNotifyTrackLayoutChange(endtile, track);
921
922 if (v != nullptr) TryPathReserve(v);
923 } else {
924 /* A full diagonal road tile has two road bits. */
925 UpdateCompanyRoadInfrastructure(GetRoadTypeRoad(tile), GetRoadOwner(tile, RTT_ROAD), -(int)(len * 2 * TUNNELBRIDGE_TRACKBIT_FACTOR));
926 UpdateCompanyRoadInfrastructure(GetRoadTypeTram(tile), GetRoadOwner(tile, RTT_TRAM), -(int)(len * 2 * TUNNELBRIDGE_TRACKBIT_FACTOR));
927
928 DoClearSquare(tile);
929 DoClearSquare(endtile);
930 }
931 }
932
933 return CommandCost(EXPENSES_CONSTRUCTION, len * base_cost);
934}
935
936
944{
946 if (ret.Failed()) return ret;
947
948 TileIndex endtile = GetOtherBridgeEnd(tile);
949
950 ret = TunnelBridgeIsFree(tile, endtile);
951 if (ret.Failed()) return ret;
952
953 DiagDirection direction = GetTunnelBridgeDirection(tile);
954 TileIndexDiff delta = TileOffsByDiagDir(direction);
955
956 Town *t = nullptr;
957 if (IsTileOwner(tile, OWNER_TOWN) && _game_mode != GM_EDITOR) {
958 t = ClosestTownFromTile(tile, UINT_MAX); // town penalty rating
959
960 /* Check if you are allowed to remove the bridge owned by a town
961 * Removal depends on difficulty settings */
963 if (ret.Failed()) return ret;
964 }
965
966 /* checks if the owner is town then decrease town rating by RATING_TUNNEL_BRIDGE_DOWN_STEP until
967 * you have a "Poor" (0) town rating */
968 if (IsTileOwner(tile, OWNER_TOWN) && _game_mode != GM_EDITOR) {
970 }
971
972 Money base_cost = TunnelBridgeClearCost(tile, PR_CLEAR_BRIDGE);
973 uint len = GetTunnelBridgeLength(tile, endtile) + 2; // Don't forget the end tiles.
974
975 if (flags.Test(DoCommandFlag::Execute)) {
976 /* read this value before actual removal of bridge */
977 bool rail = GetTunnelBridgeTransportType(tile) == TRANSPORT_RAIL;
978 Owner owner = GetTileOwner(tile);
979 int height = GetBridgeHeight(tile);
980 Train *v = nullptr;
981
982 if (rail && HasTunnelBridgeReservation(tile)) {
983 v = GetTrainForReservation(tile, DiagDirToDiagTrack(direction));
984 if (v != nullptr) FreeTrainTrackReservation(v);
985 }
986
987 /* Update company infrastructure counts. */
988 if (rail) {
989 if (Company::IsValidID(owner)) Company::Get(owner)->infrastructure.rail[GetRailType(tile)] -= len * TUNNELBRIDGE_TRACKBIT_FACTOR;
990 } else if (GetTunnelBridgeTransportType(tile) == TRANSPORT_ROAD) {
991 /* A full diagonal road tile has two road bits. */
992 UpdateCompanyRoadInfrastructure(GetRoadTypeRoad(tile), GetRoadOwner(tile, RTT_ROAD), -(int)(len * 2 * TUNNELBRIDGE_TRACKBIT_FACTOR));
993 UpdateCompanyRoadInfrastructure(GetRoadTypeTram(tile), GetRoadOwner(tile, RTT_TRAM), -(int)(len * 2 * TUNNELBRIDGE_TRACKBIT_FACTOR));
994 } else { // Aqueduct
995 if (Company::IsValidID(owner)) Company::Get(owner)->infrastructure.water -= len * TUNNELBRIDGE_TRACKBIT_FACTOR;
996 }
998
999 DoClearSquare(tile);
1000 DoClearSquare(endtile);
1001
1002 for (TileIndex c = tile + delta; c != endtile; c += delta) {
1003 /* do not let trees appear from 'nowhere' after removing bridge */
1005 int minz = GetTileMaxZ(c) + 3;
1006 if (height < minz) SetRoadside(c, Roadside::Paved);
1007 }
1009 MarkTileDirtyByTile(c, height - TileHeight(c));
1010 }
1011
1012 if (rail) {
1013 /* cannot use INVALID_DIAGDIR for signal update because the bridge doesn't exist anymore */
1014 AddSideToSignalBuffer(tile, ReverseDiagDir(direction), owner);
1015 AddSideToSignalBuffer(endtile, direction, owner);
1016
1017 Track track = DiagDirToDiagTrack(direction);
1018 YapfNotifyTrackLayoutChange(tile, track);
1019 YapfNotifyTrackLayoutChange(endtile, track);
1020
1021 if (v != nullptr) TryPathReserve(v, true);
1022 }
1023 }
1024
1025 return CommandCost(EXPENSES_CONSTRUCTION, len * base_cost);
1026}
1027
1035{
1036 if (IsTunnel(tile)) {
1037 if (flags.Test(DoCommandFlag::Auto)) return CommandCost(STR_ERROR_MUST_DEMOLISH_TUNNEL_FIRST);
1038 return DoClearTunnel(tile, flags);
1039 } else { // IsBridge(tile)
1040 if (flags.Test(DoCommandFlag::Auto)) return CommandCost(STR_ERROR_MUST_DEMOLISH_BRIDGE_FIRST);
1041 return DoClearBridge(tile, flags);
1042 }
1043}
1044
1055static inline void DrawPillar(const PalSpriteID &psid, int x, int y, int z, uint8_t w, uint8_t h, const SubSprite *subsprite)
1056{
1057 static const int PILLAR_Z_OFFSET = TILE_HEIGHT - BRIDGE_Z_START;
1058 AddSortableSpriteToDraw(psid.sprite, psid.pal, x, y, z, {{0, 0, -PILLAR_Z_OFFSET}, {w, h, BB_HEIGHT_UNDER_BRIDGE}, {0, 0, PILLAR_Z_OFFSET}}, IsTransparencySet(TO_BRIDGES), subsprite);
1059}
1060
1072static int DrawPillarColumn(int z_bottom, int z_top, const PalSpriteID &psid, int x, int y, int w, int h)
1073{
1074 int cur_z;
1075 for (cur_z = z_top; cur_z >= z_bottom; cur_z -= TILE_HEIGHT) {
1076 DrawPillar(psid, x, y, cur_z, w, h, nullptr);
1077 }
1078 return cur_z;
1079}
1080
1092static void DrawBridgePillars(const PalSpriteID &psid, const TileInfo *ti, Axis axis, bool drawfarpillar, int x, int y, int z_bridge)
1093{
1094 static const int bounding_box_size[2] = {16, 2};
1095 static const int back_pillar_offset[2] = { 0, 9};
1096
1097 static const int INF = 1000;
1098 static const SubSprite half_pillar_sub_sprite[2][2] = {
1099 { { -14, -INF, INF, INF }, { -INF, -INF, -15, INF } }, // X axis, north and south
1100 { { -INF, -INF, 15, INF }, { 16, -INF, INF, INF } }, // Y axis, north and south
1101 };
1102
1103 if (psid.sprite == 0) return;
1104
1105 /* Determine ground height under pillars */
1106 DiagDirection south_dir = AxisToDiagDir(axis);
1107 int z_front_north = ti->z;
1108 int z_back_north = ti->z;
1109 int z_front_south = ti->z;
1110 int z_back_south = ti->z;
1111 GetSlopePixelZOnEdge(ti->tileh, south_dir, z_front_south, z_back_south);
1112 GetSlopePixelZOnEdge(ti->tileh, ReverseDiagDir(south_dir), z_front_north, z_back_north);
1113
1114 /* Shared height of pillars */
1115 int z_front = std::max(z_front_north, z_front_south);
1116 int z_back = std::max(z_back_north, z_back_south);
1117
1118 /* x and y size of bounding-box of pillars */
1119 int w = bounding_box_size[axis];
1120 int h = bounding_box_size[OtherAxis(axis)];
1121 /* sprite position of back facing pillar */
1122 int x_back = x - back_pillar_offset[axis];
1123 int y_back = y - back_pillar_offset[OtherAxis(axis)];
1124
1125 /* Draw front pillars */
1126 int bottom_z = DrawPillarColumn(z_front, z_bridge, psid, x, y, w, h);
1127 if (z_front_north < z_front) DrawPillar(psid, x, y, bottom_z, w, h, &half_pillar_sub_sprite[axis][0]);
1128 if (z_front_south < z_front) DrawPillar(psid, x, y, bottom_z, w, h, &half_pillar_sub_sprite[axis][1]);
1129
1130 /* Draw back pillars, skip top two parts, which are hidden by the bridge */
1131 int z_bridge_back = z_bridge - 2 * (int)TILE_HEIGHT;
1132 if (drawfarpillar && (z_back_north <= z_bridge_back || z_back_south <= z_bridge_back)) {
1133 bottom_z = DrawPillarColumn(z_back, z_bridge_back, psid, x_back, y_back, w, h);
1134 if (z_back_north < z_back) DrawPillar(psid, x_back, y_back, bottom_z, w, h, &half_pillar_sub_sprite[axis][0]);
1135 if (z_back_south < z_back) DrawPillar(psid, x_back, y_back, bottom_z, w, h, &half_pillar_sub_sprite[axis][1]);
1136 }
1137}
1138
1148static void GetBridgeRoadCatenary(const RoadTypeInfo *rti, TileIndex head_tile, int offset, bool head, SpriteID &spr_back, SpriteID &spr_front)
1149{
1150 static const SpriteID back_offsets[6] = { 95, 96, 99, 102, 100, 101 };
1151 static const SpriteID front_offsets[6] = { 97, 98, 103, 106, 104, 105 };
1152
1153 /* Simplified from DrawRoadTypeCatenary() to remove all the special cases required for regular ground road */
1154 spr_back = GetCustomRoadSprite(rti, head_tile, ROTSG_CATENARY_BACK, head ? TCX_NORMAL : TCX_ON_BRIDGE);
1155 spr_front = GetCustomRoadSprite(rti, head_tile, ROTSG_CATENARY_FRONT, head ? TCX_NORMAL : TCX_ON_BRIDGE);
1156 if (spr_back == 0 && spr_front == 0) {
1157 spr_back = SPR_TRAMWAY_BASE + back_offsets[offset];
1158 spr_front = SPR_TRAMWAY_BASE + front_offsets[offset];
1159 } else {
1160 if (spr_back != 0) spr_back += 23 + offset;
1161 if (spr_front != 0) spr_front += 23 + offset;
1162 }
1163}
1164
1175static void DrawBridgeRoadBits(TileIndex head_tile, int x, int y, int z, int offset, bool head, bool is_custom_layout)
1176{
1177 RoadType road_rt = GetRoadTypeRoad(head_tile);
1178 RoadType tram_rt = GetRoadTypeTram(head_tile);
1179 const RoadTypeInfo *road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
1180 const RoadTypeInfo *tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
1181
1182 SpriteID seq_back[4] = { 0 };
1183 bool trans_back[4] = { false };
1184 SpriteID seq_front[4] = { 0 };
1185 bool trans_front[4] = { false };
1186
1187 static const SpriteID overlay_offsets[6] = { 0, 1, 11, 12, 13, 14 };
1188 if (head || !IsInvisibilitySet(TO_BRIDGES)) {
1189 /* Road underlay takes precedence over tram */
1190 trans_back[0] = !head && IsTransparencySet(TO_BRIDGES);
1191 if (road_rti != nullptr) {
1192 if (road_rti->UsesOverlay()) {
1193 seq_back[0] = GetCustomRoadSprite(road_rti, head_tile, ROTSG_BRIDGE, head ? TCX_NORMAL : TCX_ON_BRIDGE) + offset;
1194 } else if (is_custom_layout) {
1195 /* For custom layouts draw a custom bridge deck. */
1196 seq_back[0] = SPR_BRIDGE_DECKS_ROAD + offset;
1197 }
1198 } else if (tram_rti != nullptr) {
1199 if (tram_rti->UsesOverlay()) {
1200 seq_back[0] = GetCustomRoadSprite(tram_rti, head_tile, ROTSG_BRIDGE, head ? TCX_NORMAL : TCX_ON_BRIDGE) + offset;
1201 } else {
1202 seq_back[0] = SPR_TRAMWAY_BRIDGE + offset;
1203 }
1204 }
1205
1206 /* Draw road overlay */
1207 trans_back[1] = !head && IsTransparencySet(TO_BRIDGES);
1208 if (road_rti != nullptr) {
1209 if (road_rti->UsesOverlay()) {
1210 seq_back[1] = GetCustomRoadSprite(road_rti, head_tile, ROTSG_OVERLAY, head ? TCX_NORMAL : TCX_ON_BRIDGE);
1211 if (seq_back[1] != 0) seq_back[1] += overlay_offsets[offset];
1212 }
1213 }
1214
1215 /* Draw tram overlay */
1216 trans_back[2] = !head && IsTransparencySet(TO_BRIDGES);
1217 if (tram_rti != nullptr) {
1218 if (tram_rti->UsesOverlay()) {
1219 seq_back[2] = GetCustomRoadSprite(tram_rti, head_tile, ROTSG_OVERLAY, head ? TCX_NORMAL : TCX_ON_BRIDGE);
1220 if (seq_back[2] != 0) seq_back[2] += overlay_offsets[offset];
1221 } else if (road_rti != nullptr) {
1222 seq_back[2] = SPR_TRAMWAY_OVERLAY + overlay_offsets[offset];
1223 }
1224 }
1225
1226 /* Road catenary takes precedence over tram */
1227 trans_back[3] = IsTransparencySet(TO_CATENARY);
1228 trans_front[0] = IsTransparencySet(TO_CATENARY);
1229 if (road_rti != nullptr && HasRoadCatenaryDrawn(road_rt)) {
1230 GetBridgeRoadCatenary(road_rti, head_tile, offset, head, seq_back[3], seq_front[0]);
1231 } else if (tram_rti != nullptr && HasRoadCatenaryDrawn(tram_rt)) {
1232 GetBridgeRoadCatenary(tram_rti, head_tile, offset, head, seq_back[3], seq_front[0]);
1233 }
1234 }
1235
1236 static constexpr SpriteBounds back_bounds[6] = {
1237 {{}, {0, TILE_SIZE, 40}, {}},
1238 {{}, {TILE_SIZE, 0, 40}, {}},
1239 {{}, {TILE_SIZE, 0, 40}, {}},
1240 {{}, {0, TILE_SIZE, 40}, {}},
1241 {{}, {TILE_SIZE, 0, 40}, {}},
1242 {{}, {0, TILE_SIZE, 40}, {}},
1243 };
1244
1245 /* The sprites under the vehicles are drawn as SpriteCombine. StartSpriteCombine() has already been called
1246 * The bounding boxes here are the same as for bridge front/roof */
1247 for (uint i = 0; i < lengthof(seq_back); ++i) {
1248 if (seq_back[i] != 0) {
1249 AddSortableSpriteToDraw(seq_back[i], PAL_NONE, x, y, z, back_bounds[offset], trans_back[i]);
1250 }
1251 }
1252
1253 /* Start a new SpriteCombine for the front part */
1256
1257 static constexpr SpriteBounds front_bounds[6] = {
1258 {{15, 0, 0}, {0, TILE_SIZE, 40}, {-15, 0, 0}},
1259 {{0, 15, 0}, {TILE_SIZE, 0, 40}, {0, -15, 0}},
1260 {{0, 15, 0}, {TILE_SIZE, 0, 40}, {0, -15, 0}},
1261 {{15, 0, 0}, {0, TILE_SIZE, 40}, {-15, 0, 0}},
1262 {{0, 15, 0}, {TILE_SIZE, 0, 40}, {0, -15, 0}},
1263 {{15, 0, 0}, {0, TILE_SIZE, 40}, {-15, 0, 0}},
1264 };
1265
1266 for (uint i = 0; i < lengthof(seq_front); ++i) {
1267 if (seq_front[i] != 0) {
1268 AddSortableSpriteToDraw(seq_front[i], PAL_NONE, x, y, z, front_bounds[offset], trans_front[i]);
1269 }
1270 }
1271}
1272
1287{
1288 TransportType transport_type = GetTunnelBridgeTransportType(ti->tile);
1289 DiagDirection tunnelbridge_direction = GetTunnelBridgeDirection(ti->tile);
1290
1291 if (IsTunnel(ti->tile)) {
1292 /* Front view of tunnel bounding boxes:
1293 *
1294 * 122223 <- BB_Z_SEPARATOR
1295 * 1 3
1296 * 1 3 1,3 = empty helper BB
1297 * 1 3 2 = SpriteCombine of tunnel-roof and catenary (tram & elrail)
1298 *
1299 */
1300
1301 /* Tunnel sprites are positioned at 15,15, but the bounding box covers most of the tile. */
1302 static constexpr SpriteBounds roof_bounds[DIAGDIR_END] = {
1303 {{0, 1, BB_Z_SEPARATOR}, {TILE_SIZE, TILE_SIZE - 1, 1}, {TILE_SIZE - 1, TILE_SIZE - 2, -BB_Z_SEPARATOR}}, // NE
1304 {{1, 0, BB_Z_SEPARATOR}, {TILE_SIZE - 1, TILE_SIZE, 1}, {TILE_SIZE - 2, TILE_SIZE - 1, -BB_Z_SEPARATOR}}, // SE
1305 {{0, 1, BB_Z_SEPARATOR}, {TILE_SIZE, TILE_SIZE - 1, 1}, {TILE_SIZE - 1, TILE_SIZE - 2, -BB_Z_SEPARATOR}}, // SW
1306 {{1, 0, BB_Z_SEPARATOR}, {TILE_SIZE - 1, TILE_SIZE, 1}, {TILE_SIZE - 2, TILE_SIZE - 1, -BB_Z_SEPARATOR}}, // NW
1307 };
1308
1309 /* Catenary sprites are positioned at 0,0, with the same bounding box as above. */
1310 static constexpr SpriteBounds catenary_bounds[DIAGDIR_END] = {
1311 {{0, 1, BB_Z_SEPARATOR}, {TILE_SIZE, TILE_SIZE - 1, 1}, {0, -1, -BB_Z_SEPARATOR}}, // NE
1312 {{1, 0, BB_Z_SEPARATOR}, {TILE_SIZE - 1, TILE_SIZE, 1}, {-1, 0, -BB_Z_SEPARATOR}}, // SE
1313 {{0, 1, BB_Z_SEPARATOR}, {TILE_SIZE, TILE_SIZE - 1, 1}, {0, -1, -BB_Z_SEPARATOR}}, // SW
1314 {{1, 0, BB_Z_SEPARATOR}, {TILE_SIZE - 1, TILE_SIZE, 1}, {-1, 0, -BB_Z_SEPARATOR}}, // NW
1315 };
1316
1317 static constexpr SpriteBounds rear_sep[DIAGDIR_END] = {
1318 {{}, {TILE_SIZE, 1, TILE_HEIGHT}, {}}, // NE
1319 {{}, {1, TILE_SIZE, TILE_HEIGHT}, {}}, // SE
1320 {{}, {TILE_SIZE, 1, TILE_HEIGHT}, {}}, // SW
1321 {{}, {1, TILE_SIZE, TILE_HEIGHT}, {}}, // NW
1322 };
1323
1324 static constexpr SpriteBounds front_sep[DIAGDIR_END] = {
1325 {{0, TILE_SIZE - 1, 0}, {TILE_SIZE, 1, TILE_HEIGHT}, {}}, // NE
1326 {{TILE_SIZE - 1, 0, 0}, {1, TILE_SIZE, TILE_HEIGHT}, {}}, // SE
1327 {{0, TILE_SIZE - 1, 0}, {TILE_SIZE, 1, TILE_HEIGHT}, {}}, // SW
1328 {{TILE_SIZE - 1, 0, 0}, {1, TILE_SIZE, TILE_HEIGHT}, {}}, // NW
1329 };
1330
1331 bool catenary = false;
1332
1333 SpriteID image;
1334 SpriteID railtype_overlay = 0;
1335 if (transport_type == TRANSPORT_RAIL) {
1336 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(ti->tile));
1337 image = rti->base_sprites.tunnel;
1338 if (rti->UsesOverlay()) {
1339 /* Check if the railtype has custom tunnel portals. */
1340 railtype_overlay = GetCustomRailSprite(rti, ti->tile, RTSG_TUNNEL_PORTAL);
1341 if (railtype_overlay != 0) image = SPR_RAILTYPE_TUNNEL_BASE; // Draw blank grass tunnel base.
1342 }
1343 } else {
1344 image = SPR_TUNNEL_ENTRY_REAR_ROAD;
1345 }
1346
1347 if (HasTunnelBridgeSnowOrDesert(ti->tile)) image += railtype_overlay != 0 ? 8 : 32;
1348
1349 image += tunnelbridge_direction * 2;
1350 DrawGroundSprite(image, PAL_NONE);
1351
1352 if (transport_type == TRANSPORT_ROAD) {
1353 RoadType road_rt = GetRoadTypeRoad(ti->tile);
1354 RoadType tram_rt = GetRoadTypeTram(ti->tile);
1355 const RoadTypeInfo *road_rti = road_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(road_rt);
1356 const RoadTypeInfo *tram_rti = tram_rt == INVALID_ROADTYPE ? nullptr : GetRoadTypeInfo(tram_rt);
1357 uint sprite_offset = DiagDirToAxis(tunnelbridge_direction) == AXIS_X ? 1 : 0;
1358 bool draw_underlay = true;
1359
1360 /* Road underlay takes precedence over tram */
1361 if (road_rti != nullptr) {
1362 if (road_rti->UsesOverlay()) {
1363 SpriteID ground = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_TUNNEL);
1364 if (ground != 0) {
1365 DrawGroundSprite(ground + tunnelbridge_direction, PAL_NONE);
1366 draw_underlay = false;
1367 }
1368 }
1369 } else {
1370 if (tram_rti->UsesOverlay()) {
1371 SpriteID ground = GetCustomRoadSprite(tram_rti, ti->tile, ROTSG_TUNNEL);
1372 if (ground != 0) {
1373 DrawGroundSprite(ground + tunnelbridge_direction, PAL_NONE);
1374 draw_underlay = false;
1375 }
1376 }
1377 }
1378
1379 DrawRoadOverlays(ti, PAL_NONE, road_rti, tram_rti, sprite_offset, sprite_offset, draw_underlay);
1380
1381 /* Road catenary takes precedence over tram */
1382 SpriteID catenary_sprite_base = 0;
1383 if (road_rti != nullptr && HasRoadCatenaryDrawn(road_rt)) {
1384 catenary_sprite_base = GetCustomRoadSprite(road_rti, ti->tile, ROTSG_CATENARY_FRONT);
1385 if (catenary_sprite_base == 0) {
1386 catenary_sprite_base = SPR_TRAMWAY_TUNNEL_WIRES;
1387 } else {
1388 catenary_sprite_base += 19;
1389 }
1390 } else if (tram_rti != nullptr && HasRoadCatenaryDrawn(tram_rt)) {
1391 catenary_sprite_base = GetCustomRoadSprite(tram_rti, ti->tile, ROTSG_CATENARY_FRONT);
1392 if (catenary_sprite_base == 0) {
1393 catenary_sprite_base = SPR_TRAMWAY_TUNNEL_WIRES;
1394 } else {
1395 catenary_sprite_base += 19;
1396 }
1397 }
1398
1399 if (catenary_sprite_base != 0) {
1400 catenary = true;
1402 AddSortableSpriteToDraw(catenary_sprite_base + tunnelbridge_direction, PAL_NONE, *ti, catenary_bounds[tunnelbridge_direction], IsTransparencySet(TO_CATENARY));
1403 }
1404 } else {
1405 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(ti->tile));
1406 if (rti->UsesOverlay()) {
1407 SpriteID surface = GetCustomRailSprite(rti, ti->tile, RTSG_TUNNEL);
1408 if (surface != 0) DrawGroundSprite(surface + tunnelbridge_direction, PAL_NONE);
1409 }
1410
1411 /* PBS debugging, draw reserved tracks darker */
1412 if (_game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasTunnelBridgeReservation(ti->tile)) {
1413 if (rti->UsesOverlay()) {
1414 SpriteID overlay = GetCustomRailSprite(rti, ti->tile, RTSG_OVERLAY);
1415 DrawGroundSprite(overlay + RTO_X + DiagDirToAxis(tunnelbridge_direction), PALETTE_CRASH);
1416 } else {
1418 }
1419 }
1420
1422 /* Maybe draw pylons on the entry side */
1423 DrawRailCatenary(ti);
1424
1425 catenary = true;
1427 /* Draw wire above the ramp */
1429 }
1430 }
1431
1432 if (railtype_overlay != 0 && !catenary) StartSpriteCombine();
1433
1434 AddSortableSpriteToDraw(image + 1, PAL_NONE, *ti, roof_bounds[tunnelbridge_direction], false);
1435 /* Draw railtype tunnel portal overlay if defined. */
1436 if (railtype_overlay != 0) AddSortableSpriteToDraw(railtype_overlay + tunnelbridge_direction, PAL_NONE, *ti, roof_bounds[tunnelbridge_direction], false);
1437
1438 if (catenary || railtype_overlay != 0) EndSpriteCombine();
1439
1440 /* Add helper BB for sprite sorting that separates the tunnel from things beside of it. */
1441 AddSortableSpriteToDraw(SPR_EMPTY_BOUNDING_BOX, PAL_NONE, *ti, rear_sep[tunnelbridge_direction]);
1442 AddSortableSpriteToDraw(SPR_EMPTY_BOUNDING_BOX, PAL_NONE, *ti, front_sep[tunnelbridge_direction]);
1443
1444 DrawBridgeMiddle(ti, BridgePillarFlag::EdgeNE + tunnelbridge_direction);
1445 } else { // IsBridge(ti->tile)
1446 DrawFoundation(ti, GetBridgeFoundation(ti->tileh, DiagDirToAxis(tunnelbridge_direction)));
1447 bool is_custom_layout = false; // Set if rail/road bridge uses a custom layout.
1448
1449 uint base_offset = GetBridgeRampDirectionBaseOffset(tunnelbridge_direction);
1450 std::span<const PalSpriteID> psid;
1451 if (transport_type != TRANSPORT_WATER) {
1452 BridgeType bridge_type = GetBridgeType(ti->tile);
1453 if (ti->tileh == SLOPE_FLAT) base_offset += 4; // sloped bridge head
1454 base_offset += GetBridgeSpriteTableBaseOffset(transport_type, ti->tile);
1455 psid = GetBridgeSpriteTable(bridge_type, BRIDGE_PIECE_HEAD);
1456 is_custom_layout = BridgeHasCustomSpriteTable(bridge_type, BRIDGE_PIECE_HEAD);
1457 } else {
1458 psid = _aqueduct_sprite_table_heads;
1459 }
1460 psid = psid.subspan(base_offset, 1);
1461
1463 TileIndex next = ti->tile + TileOffsByDiagDir(tunnelbridge_direction);
1464 if (ti->tileh != SLOPE_FLAT && ti->z == 0 && HasTileWaterClass(next) && GetWaterClass(next) == WaterClass::Sea) {
1465 DrawShoreTile(ti->tileh);
1466 } else {
1467 DrawClearLandTile(ti, 3);
1468 }
1469 } else {
1470 DrawGroundSprite(SPR_FLAT_SNOW_DESERT_TILE + SlopeToSpriteOffset(ti->tileh), PAL_NONE);
1471 }
1472
1473 /* draw ramp */
1474
1475 /* Draw Trambits and PBS Reservation as SpriteCombine */
1476 if (transport_type == TRANSPORT_ROAD || transport_type == TRANSPORT_RAIL) StartSpriteCombine();
1477
1478 /* HACK set the height of the BB of a sloped ramp to 1 so a vehicle on
1479 * it doesn't disappear behind it
1480 */
1481 /* Bridge heads are drawn solid no matter how invisibility/transparency is set */
1482 AddSortableSpriteToDraw(psid[0].sprite, psid[0].pal, *ti, {{}, {TILE_SIZE, TILE_SIZE, static_cast<uint8_t>(ti->tileh == SLOPE_FLAT ? 0 : TILE_HEIGHT)}, {}});
1483
1484 if (transport_type == TRANSPORT_ROAD) {
1485 uint offset = tunnelbridge_direction;
1486 int z = ti->z;
1487 if (ti->tileh != SLOPE_FLAT) {
1488 offset = (offset + 1) & 1;
1489 z += TILE_HEIGHT;
1490 } else {
1491 offset += 2;
1492 }
1493
1494 /* DrawBridgeRoadBits() calls EndSpriteCombine() and StartSpriteCombine() */
1495 DrawBridgeRoadBits(ti->tile, ti->x, ti->y, z, offset, true, is_custom_layout);
1496
1498 } else if (transport_type == TRANSPORT_RAIL) {
1499 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(ti->tile));
1500 if (is_custom_layout || rti->UsesOverlay()) {
1501 SpriteID surface = rti->UsesOverlay() ? GetCustomRailSprite(rti, ti->tile, RTSG_BRIDGE) : rti->base_sprites.bridge_deck;
1502 if (surface != 0) {
1503 if (HasBridgeFlatRamp(ti->tileh, DiagDirToAxis(tunnelbridge_direction))) {
1504 AddSortableSpriteToDraw(surface + ((DiagDirToAxis(tunnelbridge_direction) == AXIS_X) ? RTBO_X : RTBO_Y), PAL_NONE, *ti, {{0, 0, TILE_HEIGHT}, {TILE_SIZE, TILE_SIZE, 0}, {}});
1505 } else {
1506 AddSortableSpriteToDraw(surface + RTBO_SLOPE + tunnelbridge_direction, PAL_NONE, *ti, {{}, {TILE_SIZE, TILE_SIZE, TILE_HEIGHT}, {}});
1507 }
1508 }
1509 }
1510
1511 /* PBS debugging, draw reserved tracks darker */
1512 if (_game_mode != GM_MENU && _settings_client.gui.show_track_reservation && HasTunnelBridgeReservation(ti->tile)) {
1513 if (rti->UsesOverlay()) {
1514 SpriteID overlay = GetCustomRailSprite(rti, ti->tile, RTSG_OVERLAY);
1515 if (HasBridgeFlatRamp(ti->tileh, DiagDirToAxis(tunnelbridge_direction))) {
1516 AddSortableSpriteToDraw(overlay + RTO_X + DiagDirToAxis(tunnelbridge_direction), PALETTE_CRASH, *ti, {{0, 0, TILE_HEIGHT}, {TILE_SIZE, TILE_SIZE, 0}, {}});
1517 } else {
1518 AddSortableSpriteToDraw(overlay + RTO_SLOPE_NE + tunnelbridge_direction, PALETTE_CRASH, *ti, {{}, {TILE_SIZE, TILE_SIZE, TILE_HEIGHT}, {}});
1519 }
1520 } else {
1521 if (HasBridgeFlatRamp(ti->tileh, DiagDirToAxis(tunnelbridge_direction))) {
1522 AddSortableSpriteToDraw(DiagDirToAxis(tunnelbridge_direction) == AXIS_X ? rti->base_sprites.single_x : rti->base_sprites.single_y, PALETTE_CRASH, *ti, {{0, 0, TILE_HEIGHT}, {TILE_SIZE, TILE_SIZE, 0}, {}});
1523 } else {
1524 AddSortableSpriteToDraw(rti->base_sprites.single_sloped + tunnelbridge_direction, PALETTE_CRASH, *ti, {{}, {TILE_SIZE, TILE_SIZE, TILE_HEIGHT}, {}});
1525 }
1526 }
1527 }
1528
1531 DrawRailCatenary(ti);
1532 }
1533 }
1534
1535 BridgePillarFlags blocked_pillars;
1536 if (DiagDirToAxis(tunnelbridge_direction) == AXIS_X) {
1538 } else {
1540 }
1541 DrawBridgeMiddle(ti, blocked_pillars);
1542 }
1543}
1544
1545
1564static BridgePieces CalcBridgePiece(uint north, uint south)
1565{
1566 if (north == 1) {
1567 return BRIDGE_PIECE_NORTH;
1568 } else if (south == 1) {
1569 return BRIDGE_PIECE_SOUTH;
1570 } else if (north < south) {
1571 return north & 1 ? BRIDGE_PIECE_INNER_SOUTH : BRIDGE_PIECE_INNER_NORTH;
1572 } else if (north > south) {
1573 return south & 1 ? BRIDGE_PIECE_INNER_NORTH : BRIDGE_PIECE_INNER_SOUTH;
1574 } else {
1575 return north & 1 ? BRIDGE_PIECE_MIDDLE_EVEN : BRIDGE_PIECE_MIDDLE_ODD;
1576 }
1577}
1578
1589{
1590 if (transport_type == TRANSPORT_WATER) return BRIDGEPILLARFLAGS_ALL_CORNERS;
1591
1592 const BridgeSpec *spec = GetBridgeSpec(type);
1594 BridgePieces piece = CalcBridgePiece(GetTunnelBridgeLength(tile, rampnorth) + 1, GetTunnelBridgeLength(tile, rampsouth) + 1);
1595 Axis axis = TileX(rampnorth) == TileX(rampsouth) ? AXIS_Y : AXIS_X;
1596
1597 return spec->pillar_flags[piece][axis == AXIS_Y ? 1 : 0];
1598 }
1599
1600 return BRIDGEPILLARFLAGS_ALL_CORNERS;
1601}
1602
1608void DrawBridgeMiddle(const TileInfo *ti, BridgePillarFlags blocked_pillars)
1609{
1610 /* Sectional view of bridge bounding boxes:
1611 *
1612 * 1 2 1,2 = SpriteCombine of Bridge front/(back&floor) and RoadCatenary
1613 * 1 2 3 = empty helper BB
1614 * 1 7 2 4,5 = pillars under higher bridges
1615 * 1 6 88888 6 2 6 = elrail-pylons
1616 * 1 6 88888 6 2 7 = elrail-wire
1617 * 1 6 88888 6 2 <- TILE_HEIGHT 8 = rail-vehicle on bridge
1618 * 3333333333333 <- BB_Z_SEPARATOR
1619 * <- unused
1620 * 4 5 <- BB_HEIGHT_UNDER_BRIDGE
1621 * 4 5
1622 * 4 5
1623 *
1624 */
1625
1626 if (!IsBridgeAbove(ti->tile)) return;
1627
1628 TileIndex rampnorth = GetNorthernBridgeEnd(ti->tile);
1629 TileIndex rampsouth = GetSouthernBridgeEnd(ti->tile);
1630 TransportType transport_type = GetTunnelBridgeTransportType(rampsouth);
1631 Axis axis = GetBridgeAxis(ti->tile);
1632 BridgePillarFlags pillars;
1633 bool is_custom_layout; // Set if rail/road bridge uses a custom layout.
1634
1635 uint base_offset = GetBridgeMiddleAxisBaseOffset(axis);
1636 std::span<const PalSpriteID> psid;
1637 bool drawfarpillar;
1638 if (transport_type != TRANSPORT_WATER) {
1639 BridgeType bridge_type = GetBridgeType(rampsouth);
1640 BridgePieces bridge_piece = CalcBridgePiece(GetTunnelBridgeLength(ti->tile, rampnorth) + 1, GetTunnelBridgeLength(ti->tile, rampsouth) + 1);
1641 drawfarpillar = !HasBit(GetBridgeSpec(bridge_type)->flags, 0);
1642 base_offset += GetBridgeSpriteTableBaseOffset(transport_type, rampsouth);
1643 psid = GetBridgeSpriteTable(bridge_type, bridge_piece);
1644 pillars = GetBridgeTilePillarFlags(ti->tile, rampnorth, rampsouth, bridge_type, transport_type);
1645 is_custom_layout = BridgeHasCustomSpriteTable(bridge_type, bridge_piece);
1646 } else {
1647 drawfarpillar = true;
1648 psid = _aqueduct_sprite_table_middle;
1649 pillars = BRIDGEPILLARFLAGS_ALL_CORNERS;
1650 }
1651 psid = psid.subspan(base_offset, 3);
1652
1653 int x = ti->x;
1654 int y = ti->y;
1655 uint bridge_z = GetBridgePixelHeight(rampsouth);
1656 int z = bridge_z - BRIDGE_Z_START;
1657
1658 /* Add a bounding box that separates the bridge from things below it. */
1659 AddSortableSpriteToDraw(SPR_EMPTY_BOUNDING_BOX, PAL_NONE, x, y, bridge_z - TILE_HEIGHT + BB_Z_SEPARATOR, {{}, {TILE_SIZE, TILE_SIZE, 1}, {}});
1660
1661 /* Draw Trambits as SpriteCombine */
1662 if (transport_type == TRANSPORT_ROAD || transport_type == TRANSPORT_RAIL) StartSpriteCombine();
1663
1664 /* Draw floor and far part of bridge*/
1666 if (axis == AXIS_X) {
1667 AddSortableSpriteToDraw(psid[0].sprite, psid[0].pal, x, y, z, {{0, 0, BRIDGE_Z_START}, {TILE_SIZE, 1, 40}, {0, 0, -BRIDGE_Z_START}}, IsTransparencySet(TO_BRIDGES));
1668 } else {
1669 AddSortableSpriteToDraw(psid[0].sprite, psid[0].pal, x, y, z, {{0, 0, BRIDGE_Z_START}, {1, TILE_SIZE, 40}, {0, 0, -BRIDGE_Z_START}}, IsTransparencySet(TO_BRIDGES));
1670 }
1671 }
1672
1673 if (transport_type == TRANSPORT_ROAD) {
1674 /* DrawBridgeRoadBits() calls EndSpriteCombine() and StartSpriteCombine() */
1675 DrawBridgeRoadBits(rampsouth, x, y, bridge_z, axis ^ 1, false, is_custom_layout);
1676 } else if (transport_type == TRANSPORT_RAIL) {
1677 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(rampsouth));
1678 if ((is_custom_layout || rti->UsesOverlay()) && !IsInvisibilitySet(TO_BRIDGES)) {
1679 SpriteID surface = rti->UsesOverlay() ? GetCustomRailSprite(rti, rampsouth, RTSG_BRIDGE, TCX_ON_BRIDGE) : rti->base_sprites.bridge_deck;
1680 if (surface != 0) {
1681 AddSortableSpriteToDraw(surface + axis, PAL_NONE, x, y, bridge_z, {{}, {TILE_SIZE, TILE_SIZE, 0}, {}}, IsTransparencySet(TO_BRIDGES));
1682 }
1683 }
1684
1686 if (rti->UsesOverlay()) {
1687 SpriteID overlay = GetCustomRailSprite(rti, ti->tile, RTSG_OVERLAY);
1688 AddSortableSpriteToDraw(overlay + RTO_X + axis, PALETTE_CRASH, ti->x, ti->y, bridge_z, {{}, {TILE_SIZE, TILE_SIZE, 0}, {}}, IsTransparencySet(TO_BRIDGES));
1689 } else {
1691 }
1692 }
1693
1695
1696 if (HasRailCatenaryDrawn(GetRailType(rampsouth))) {
1698 }
1699 }
1700
1701 /* draw roof, the component of the bridge which is logically between the vehicle and the camera */
1703 if (axis == AXIS_X) {
1704 y += 12;
1705 if (psid[1].sprite & SPRITE_MASK) AddSortableSpriteToDraw(psid[1].sprite, psid[1].pal, x, y, z, {{0, 3, BRIDGE_Z_START}, {TILE_SIZE, 1, 40}, {0, -3, -BRIDGE_Z_START}}, IsTransparencySet(TO_BRIDGES));
1706 } else {
1707 x += 12;
1708 if (psid[1].sprite & SPRITE_MASK) AddSortableSpriteToDraw(psid[1].sprite, psid[1].pal, x, y, z, {{3, 0, BRIDGE_Z_START}, {1, TILE_SIZE, 40}, {-3, 0, -BRIDGE_Z_START}}, IsTransparencySet(TO_BRIDGES));
1709 }
1710 }
1711
1712 /* Draw TramFront as SpriteCombine */
1713 if (transport_type == TRANSPORT_ROAD) EndSpriteCombine();
1714
1715 /* Do not draw anything more if bridges are invisible */
1716 if (IsInvisibilitySet(TO_BRIDGES)) return;
1717
1718 if (blocked_pillars.Any(pillars)) return;
1719 DrawBridgePillars(psid[2], ti, axis, drawfarpillar, x, y, z);
1720}
1721
1722
1723static int GetSlopePixelZ_TunnelBridge(TileIndex tile, uint x, uint y, bool ground_vehicle)
1724{
1725 auto [tileh, z] = GetTilePixelSlope(tile);
1726
1727 x &= 0xF;
1728 y &= 0xF;
1729
1730 if (IsTunnel(tile)) {
1731 /* In the tunnel entrance? */
1732 if (ground_vehicle) return z;
1733 } else { // IsBridge(tile)
1736
1737 /* On the bridge ramp? */
1738 if (ground_vehicle) {
1739 if (tileh != SLOPE_FLAT) return z + TILE_HEIGHT;
1740
1741 switch (dir) {
1742 default: NOT_REACHED();
1743 case DIAGDIR_NE: tileh = SLOPE_NE; break;
1744 case DIAGDIR_SE: tileh = SLOPE_SE; break;
1745 case DIAGDIR_SW: tileh = SLOPE_SW; break;
1746 case DIAGDIR_NW: tileh = SLOPE_NW; break;
1747 }
1748 }
1749 }
1750
1751 return z + GetPartialPixelZ(x, y, tileh);
1752}
1753
1754static Foundation GetFoundation_TunnelBridge(TileIndex tile, Slope tileh)
1755{
1757}
1758
1759static void GetTileDesc_TunnelBridge(TileIndex tile, TileDesc &td)
1760{
1762
1763 if (IsTunnel(tile)) {
1764 td.str = (tt == TRANSPORT_RAIL) ? STR_LAI_TUNNEL_DESCRIPTION_RAILROAD : STR_LAI_TUNNEL_DESCRIPTION_ROAD;
1765 } else { // IsBridge(tile)
1766 td.str = (tt == TRANSPORT_WATER) ? STR_LAI_BRIDGE_DESCRIPTION_AQUEDUCT : GetBridgeSpec(GetBridgeType(tile))->transport_name[tt];
1767 }
1768 td.owner[0] = GetTileOwner(tile);
1769
1770 Owner road_owner = INVALID_OWNER;
1771 Owner tram_owner = INVALID_OWNER;
1772 RoadType road_rt = (tt == TRANSPORT_ROAD) ? GetRoadTypeRoad(tile) : INVALID_ROADTYPE;
1773 RoadType tram_rt = (tt == TRANSPORT_ROAD) ? GetRoadTypeTram(tile) : INVALID_ROADTYPE;
1774 if (road_rt != INVALID_ROADTYPE) {
1775 const RoadTypeInfo *rti = GetRoadTypeInfo(road_rt);
1776 td.roadtype = rti->strings.name;
1777 td.road_speed = rti->max_speed / 2;
1778 road_owner = GetRoadOwner(tile, RTT_ROAD);
1779 }
1780 if (tram_rt != INVALID_ROADTYPE) {
1781 const RoadTypeInfo *rti = GetRoadTypeInfo(tram_rt);
1782 td.tramtype = rti->strings.name;
1783 td.tram_speed = rti->max_speed / 2;
1784 tram_owner = GetRoadOwner(tile, RTT_TRAM);
1785 }
1786
1787 /* Is there a mix of owners? */
1788 if ((tram_owner != INVALID_OWNER && tram_owner != td.owner[0]) ||
1789 (road_owner != INVALID_OWNER && road_owner != td.owner[0])) {
1790 uint i = 1;
1791 if (road_owner != INVALID_OWNER) {
1792 td.owner_type[i] = STR_LAND_AREA_INFORMATION_ROAD_OWNER;
1793 td.owner[i] = road_owner;
1794 i++;
1795 }
1796 if (tram_owner != INVALID_OWNER) {
1797 td.owner_type[i] = STR_LAND_AREA_INFORMATION_TRAM_OWNER;
1798 td.owner[i] = tram_owner;
1799 }
1800 }
1801
1802 if (tt == TRANSPORT_RAIL) {
1803 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
1804 td.rail_speed = rti->max_speed;
1805 td.railtype = rti->strings.name;
1806
1807 if (!IsTunnel(tile)) {
1808 uint16_t spd = GetBridgeSpec(GetBridgeType(tile))->speed;
1809 /* rail speed special-cases 0 as unlimited, hides display of limit etc. */
1810 if (spd == UINT16_MAX) spd = 0;
1811 if (td.rail_speed == 0 || spd < td.rail_speed) {
1812 td.rail_speed = spd;
1813 }
1814 }
1815 } else if (tt == TRANSPORT_ROAD && !IsTunnel(tile)) {
1816 uint16_t spd = GetBridgeSpec(GetBridgeType(tile))->speed;
1817 /* road speed special-cases 0 as unlimited, hides display of limit etc. */
1818 if (spd == UINT16_MAX) spd = 0;
1819 if (road_rt != INVALID_ROADTYPE && (td.road_speed == 0 || spd < td.road_speed)) td.road_speed = spd;
1820 if (tram_rt != INVALID_ROADTYPE && (td.tram_speed == 0 || spd < td.tram_speed)) td.tram_speed = spd;
1821 }
1822}
1823
1824
1825static void TileLoop_TunnelBridge(TileIndex tile)
1826{
1827 bool snow_or_desert = HasTunnelBridgeSnowOrDesert(tile);
1829 case LandscapeType::Arctic: {
1830 /* As long as we do not have a snow density, we want to use the density
1831 * from the entry edge. For tunnels this is the lowest point for bridges the highest point.
1832 * (Independent of foundations) */
1833 int z = IsBridge(tile) ? GetTileMaxZ(tile) : GetTileZ(tile);
1834 if (snow_or_desert != (z > GetSnowLine())) {
1835 SetTunnelBridgeSnowOrDesert(tile, !snow_or_desert);
1836 MarkTileDirtyByTile(tile);
1837 }
1838 break;
1839 }
1840
1841 case LandscapeType::Tropic:
1842 if (GetTropicZone(tile) == TROPICZONE_DESERT && !snow_or_desert) {
1843 SetTunnelBridgeSnowOrDesert(tile, true);
1844 MarkTileDirtyByTile(tile);
1845 }
1846 break;
1847
1848 default:
1849 break;
1850 }
1851}
1852
1853static TrackStatus GetTileTrackStatus_TunnelBridge(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
1854{
1855 TransportType transport_type = GetTunnelBridgeTransportType(tile);
1856 if (transport_type != mode || (transport_type == TRANSPORT_ROAD && !HasTileRoadType(tile, (RoadTramType)sub_mode))) return 0;
1857
1859 if (side != INVALID_DIAGDIR && side != ReverseDiagDir(dir)) return 0;
1861}
1862
1863static void ChangeTileOwner_TunnelBridge(TileIndex tile, Owner old_owner, Owner new_owner)
1864{
1865 TileIndex other_end = GetOtherTunnelBridgeEnd(tile);
1866 /* Set number of pieces to zero if it's the southern tile as we
1867 * don't want to update the infrastructure counts twice. */
1868 uint num_pieces = tile < other_end ? (GetTunnelBridgeLength(tile, other_end) + 2) * TUNNELBRIDGE_TRACKBIT_FACTOR : 0;
1869
1871
1872 if (tt == TRANSPORT_ROAD) {
1873 for (RoadTramType rtt : _roadtramtypes) {
1874 /* Update all roadtypes, no matter if they are present */
1875 if (GetRoadOwner(tile, rtt) == old_owner) {
1876 RoadType rt = GetRoadType(tile, rtt);
1877 if (rt != INVALID_ROADTYPE) {
1878 /* Update company infrastructure counts. A full diagonal road tile has two road bits.
1879 * No need to dirty windows here, we'll redraw the whole screen anyway. */
1880 Company::Get(old_owner)->infrastructure.road[rt] -= num_pieces * 2;
1881 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.road[rt] += num_pieces * 2;
1882 }
1883
1884 SetRoadOwner(tile, rtt, new_owner == INVALID_OWNER ? OWNER_NONE : new_owner);
1885 }
1886 }
1887 }
1888
1889 if (!IsTileOwner(tile, old_owner)) return;
1890
1891 /* Update company infrastructure counts for rail and water as well.
1892 * No need to dirty windows here, we'll redraw the whole screen anyway. */
1893 Company *old = Company::Get(old_owner);
1894 if (tt == TRANSPORT_RAIL) {
1895 old->infrastructure.rail[GetRailType(tile)] -= num_pieces;
1896 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.rail[GetRailType(tile)] += num_pieces;
1897 } else if (tt == TRANSPORT_WATER) {
1898 old->infrastructure.water -= num_pieces;
1899 if (new_owner != INVALID_OWNER) Company::Get(new_owner)->infrastructure.water += num_pieces;
1900 }
1901
1902 if (new_owner != INVALID_OWNER) {
1903 SetTileOwner(tile, new_owner);
1904 } else {
1905 if (tt == TRANSPORT_RAIL) {
1906 /* Since all of our vehicles have been removed, it is safe to remove the rail
1907 * bridge / tunnel. */
1909 assert(ret.Succeeded());
1910 } else {
1911 /* In any other case, we can safely reassign the ownership to OWNER_NONE. */
1912 SetTileOwner(tile, OWNER_NONE);
1913 }
1914 }
1915}
1916
1929template <typename T>
1930static void PrepareToEnterBridge(T *gv)
1931{
1932 if (HasBit(gv->gv_flags, GVF_GOINGUP_BIT)) {
1933 gv->z_pos++;
1934 ClrBit(gv->gv_flags, GVF_GOINGUP_BIT);
1935 } else {
1936 ClrBit(gv->gv_flags, GVF_GOINGDOWN_BIT);
1937 }
1938}
1939
1945static const uint8_t TUNNEL_SOUND_FRAME = 1;
1946
1955extern const uint8_t _tunnel_visibility_frame[DIAGDIR_END] = {12, 8, 8, 12};
1956
1957static VehicleEnterTileStates VehicleEnter_TunnelBridge(Vehicle *v, TileIndex tile, int x, int y)
1958{
1959 int z = GetSlopePixelZ(x, y, true) - v->z_pos;
1960
1961 if (abs(z) > 2) return VehicleEnterTileState::CannotEnter;
1962 /* Direction into the wormhole */
1963 const DiagDirection dir = GetTunnelBridgeDirection(tile);
1964 /* Direction of the vehicle */
1965 const DiagDirection vdir = DirToDiagDir(v->direction);
1966 /* New position of the vehicle on the tile */
1967 uint8_t pos = (DiagDirToAxis(vdir) == AXIS_X ? x : y) & TILE_UNIT_MASK;
1968 /* Number of units moved by the vehicle since entering the tile */
1969 uint8_t frame = (vdir == DIAGDIR_NE || vdir == DIAGDIR_NW) ? TILE_SIZE - 1 - pos : pos;
1970
1971 if (IsTunnel(tile)) {
1972 if (v->type == VEH_TRAIN) {
1973 Train *t = Train::From(v);
1974
1975 if (t->track != TRACK_BIT_WORMHOLE && dir == vdir) {
1976 if (t->IsFrontEngine() && frame == TUNNEL_SOUND_FRAME) {
1977 if (!PlayVehicleSound(t, VSE_TUNNEL) && RailVehInfo(t->engine_type)->engclass == 0) {
1978 SndPlayVehicleFx(SND_05_TRAIN_THROUGH_TUNNEL, v);
1979 }
1980 return {};
1981 }
1982 if (frame == _tunnel_visibility_frame[dir]) {
1983 t->tile = tile;
1984 t->track = TRACK_BIT_WORMHOLE;
1987 }
1988 }
1989
1990 if (dir == ReverseDiagDir(vdir) && frame == TILE_SIZE - _tunnel_visibility_frame[dir] && z == 0) {
1991 /* We're at the tunnel exit ?? */
1992 t->tile = tile;
1993 t->track = DiagDirToDiagTrackBits(vdir);
1994 assert(t->track);
1997 }
1998 } else if (v->type == VEH_ROAD) {
2000
2001 /* Enter tunnel? */
2002 if (rv->state != RVSB_WORMHOLE && dir == vdir) {
2003 if (frame == _tunnel_visibility_frame[dir]) {
2004 /* Frame should be equal to the next frame number in the RV's movement */
2005 assert(frame == rv->frame + 1);
2006 rv->tile = tile;
2007 rv->state = RVSB_WORMHOLE;
2010 } else {
2011 return {};
2012 }
2013 }
2014
2015 /* We're at the tunnel exit ?? */
2016 if (dir == ReverseDiagDir(vdir) && frame == TILE_SIZE - _tunnel_visibility_frame[dir] && z == 0) {
2017 rv->tile = tile;
2018 rv->state = DiagDirToDiagTrackdir(vdir);
2019 rv->frame = frame;
2022 }
2023 }
2024 } else { // IsBridge(tile)
2025 if (v->type != VEH_SHIP) {
2026 /* modify speed of vehicle */
2027 uint16_t spd = GetBridgeSpec(GetBridgeType(tile))->speed;
2028
2029 if (v->type == VEH_ROAD) spd *= 2;
2030 Vehicle *first = v->First();
2031 first->cur_speed = std::min(first->cur_speed, spd);
2032 }
2033
2034 if (vdir == dir) {
2035 /* Vehicle enters bridge at the last frame inside this tile. */
2036 if (frame != TILE_SIZE - 1) return {};
2037 switch (v->type) {
2038 case VEH_TRAIN: {
2039 Train *t = Train::From(v);
2040 t->track = TRACK_BIT_WORMHOLE;
2042 break;
2043 }
2044
2045 case VEH_ROAD: {
2047 rv->state = RVSB_WORMHOLE;
2049 break;
2050 }
2051
2052 case VEH_SHIP:
2054 break;
2055
2056 default: NOT_REACHED();
2057 }
2059 } else if (vdir == ReverseDiagDir(dir)) {
2060 v->tile = tile;
2061 switch (v->type) {
2062 case VEH_TRAIN: {
2063 Train *t = Train::From(v);
2064 if (t->track == TRACK_BIT_WORMHOLE) {
2065 t->track = DiagDirToDiagTrackBits(vdir);
2067 }
2068 break;
2069 }
2070
2071 case VEH_ROAD: {
2073 if (rv->state == RVSB_WORMHOLE) {
2074 rv->state = DiagDirToDiagTrackdir(vdir);
2075 rv->frame = 0;
2077 }
2078 break;
2079 }
2080
2081 case VEH_SHIP: {
2082 Ship *ship = Ship::From(v);
2083 if (ship->state == TRACK_BIT_WORMHOLE) {
2084 ship->state = DiagDirToDiagTrackBits(vdir);
2086 }
2087 break;
2088 }
2089
2090 default: NOT_REACHED();
2091 }
2092 }
2093 }
2094 return {};
2095}
2096
2097static CommandCost TerraformTile_TunnelBridge(TileIndex tile, DoCommandFlags flags, int z_new, Slope tileh_new)
2098{
2100 DiagDirection direction = GetTunnelBridgeDirection(tile);
2101 Axis axis = DiagDirToAxis(direction);
2102 CommandCost res;
2103 auto [tileh_old, z_old] = GetTileSlopeZ(tile);
2104
2105 /* Check if new slope is valid for bridges in general (so we can safely call GetBridgeFoundation()) */
2106 if ((direction == DIAGDIR_NW) || (direction == DIAGDIR_NE)) {
2107 CheckBridgeSlope(BRIDGE_PIECE_SOUTH, axis, tileh_old, z_old);
2108 res = CheckBridgeSlope(BRIDGE_PIECE_SOUTH, axis, tileh_new, z_new);
2109 } else {
2110 CheckBridgeSlope(BRIDGE_PIECE_NORTH, axis, tileh_old, z_old);
2111 res = CheckBridgeSlope(BRIDGE_PIECE_NORTH, axis, tileh_new, z_new);
2112 }
2113
2114 /* Surface slope is valid and remains unchanged? */
2115 if (res.Succeeded() && (z_old == z_new) && (tileh_old == tileh_new)) return CommandCost(EXPENSES_CONSTRUCTION, _price[PR_BUILD_FOUNDATION]);
2116 }
2117
2118 return Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
2119}
2120
2121static CommandCost CheckBuildAbove_TunnelBridge(TileIndex tile, DoCommandFlags flags, Axis axis, int height)
2122{
2123 if (IsTunnel(tile)) return CommandCost();
2124
2125 if (axis != DiagDirToAxis(GetTunnelBridgeDirection(tile)) && height > GetBridgeHeight(tile)) {
2126 return CommandCost();
2127 }
2128
2129 return Command<CMD_LANDSCAPE_CLEAR>::Do(flags, tile);
2130}
2131
2132extern const TileTypeProcs _tile_type_tunnelbridge_procs = {
2133 DrawTile_TunnelBridge, // draw_tile_proc
2134 GetSlopePixelZ_TunnelBridge, // get_slope_z_proc
2135 ClearTile_TunnelBridge, // clear_tile_proc
2136 nullptr, // add_accepted_cargo_proc
2137 GetTileDesc_TunnelBridge, // get_tile_desc_proc
2138 GetTileTrackStatus_TunnelBridge, // get_tile_track_status_proc
2139 nullptr, // click_tile_proc
2140 nullptr, // animate_tile_proc
2141 TileLoop_TunnelBridge, // tile_loop_proc
2142 ChangeTileOwner_TunnelBridge, // change_tile_owner_proc
2143 nullptr, // add_produced_cargo_proc
2144 VehicleEnter_TunnelBridge, // vehicle_enter_tile_proc
2145 GetFoundation_TunnelBridge, // get_foundation_proc
2146 TerraformTile_TunnelBridge, // terraform_tile_proc
2147 CheckBuildAbove_TunnelBridge, // check_build_above_proc
2148};
Functions related to autoslope.
bool AutoslopeEnabled()
Tests if autoslope is enabled for _current_company.
Definition autoslope.h:65
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
const BridgeSpec * GetBridgeSpec(BridgeType i)
Get the specification of a bridge type.
Definition bridge.h:60
static const uint MAX_BRIDGES
Maximal number of available bridge specs.
Definition bridge.h:18
This file contains all the sprites for bridges.
TileIndex GetSouthernBridgeEnd(TileIndex t)
Finds the southern end of a bridge starting at a middle tile.
TileIndex GetOtherBridgeEnd(TileIndex tile)
Starting at one bridge end finds the other bridge end.
TileIndex GetNorthernBridgeEnd(TileIndex t)
Finds the northern end of a bridge starting at a middle tile.
int GetBridgeHeight(TileIndex t)
Get the height ('z') of a bridge.
void SetBridgeMiddle(Tile t, Axis a)
Set that there is a bridge over the given axis.
Definition bridge_map.h:114
void MakeAqueductBridgeRamp(Tile t, Owner o, DiagDirection d)
Make a bridge ramp for aqueducts.
Definition bridge_map.h:182
bool IsBridgeTile(Tile t)
checks if there is a bridge on this tile
Definition bridge_map.h:35
void MakeRailBridgeRamp(Tile t, Owner o, BridgeType bridgetype, DiagDirection d, RailType rt)
Make a bridge ramp for rails.
Definition bridge_map.h:170
int GetBridgePixelHeight(TileIndex tile)
Get the height ('z') of a bridge in pixels.
Definition bridge_map.h:84
void ClearBridgeMiddle(Tile t)
Removes bridges from the given, that is bridges along the X and Y axis.
Definition bridge_map.h:103
void MakeRoadBridgeRamp(Tile t, Owner o, Owner owner_road, Owner owner_tram, BridgeType bridgetype, DiagDirection d, RoadType road_rt, RoadType tram_rt)
Make a bridge ramp for roads.
Definition bridge_map.h:154
BridgeType GetBridgeType(Tile t)
Determines the type of bridge on a tile.
Definition bridge_map.h:56
bool IsBridgeAbove(Tile t)
checks if a bridge is set above the ground of this tile
Definition bridge_map.h:45
Axis GetBridgeAxis(Tile t)
Get the axis of the bridge that goes over the tile.
Definition bridge_map.h:68
bool IsBridge(Tile t)
Checks if this is a bridge, instead of a tunnel.
Definition bridge_map.h:24
BridgePieces
This enum is related to the definition of bridge pieces, which is used to determine the proper sprite...
Definition bridge_type.h:22
@ EdgeNE
Northeast edge is obstructed.
@ EdgeSW
Southwest edge is obstructed.
@ EdgeNW
Northwest edge is obstructed.
@ EdgeSE
Southeast edge is obstructed.
uint BridgeType
Bridge spec number.
Definition bridge_type.h:15
Cheats _cheats
All the cheats.
Definition cheat.cpp:16
Types related to cheating.
constexpr bool Test(Tvalue_type value) const
Test if the value-th bit is set.
constexpr Timpl & Reset()
Reset all bits.
constexpr Timpl & Set()
Set all bits.
Common return value for all commands.
bool Succeeded() const
Did this command succeed?
void AddCost(const Money &cost)
Adds the given cost to the cost of the command.
Money GetCost() const
The costs as made up to this moment.
bool Failed() const
Did this command fail?
Enum-as-bit-set wrapper.
This struct contains all the info that is needed to draw and construct tracks.
Definition rail.h:115
SpriteID single_x
single piece of rail in X direction, without ground
Definition rail.h:125
uint16_t max_speed
Maximum speed for vehicles travelling on this rail type.
Definition rail.h:220
SpriteID bridge_deck
bridge deck sprites base
Definition rail.h:134
SpriteID single_y
single piece of rail in Y direction, without ground
Definition rail.h:126
StringID name
Name of this rail type.
Definition rail.h:165
struct RailTypeInfo::@22 strings
Strings associated with the rail type.
uint8_t bridge_offset
Bridge offset.
Definition rail.h:185
struct RailTypeInfo::@19 base_sprites
Struct containing the main sprites.
SpriteID tunnel
tunnel sprites base
Definition rail.h:133
SpriteID single_sloped
single piece of rail for slopes
Definition rail.h:131
struct RoadTypeInfo::@25 strings
Strings associated with the rail type.
uint16_t max_speed
Maximum speed for vehicles travelling on this road type.
Definition road.h:116
StringID name
Name of this rail type.
Definition road.h:77
static Year year
Current year, starting at 0.
Functions related to clear (MP_CLEAR) land.
CommandCost CommandCostWithParam(StringID str, uint64_t value)
Return an error status, with string and parameter.
Definition command.cpp:417
Functions related to commands.
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
@ Auto
don't allow building on structures
@ QueryCost
query cost only, don't build.
@ Execute
execute the given command
@ Bankrupt
company bankrupts, skip money check, skip vehicle on tile check in some cases
Definition of stuff that is very close to a company, like the company struct itself.
CommandCost CheckTileOwnership(TileIndex tile)
Check whether the current owner owns the stuff on the given tile.
CommandCost CheckOwnership(Owner owner, TileIndex tile)
Check whether the current owner owns something.
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
CompanyID _current_company
Company currently doing an action.
void DirtyCompanyInfrastructureWindows(CompanyID company)
Redraw all windows with company infrastructure counts.
GUI Functions related to companies.
static constexpr Owner OWNER_DEITY
The object is owned by a superuser / goal script.
static constexpr Owner OWNER_TOWN
A town owns the tile, or a town is expanding.
static constexpr Owner OWNER_NONE
The tile has no ownership.
static constexpr Owner INVALID_OWNER
An invalid owner.
static constexpr Owner OWNER_WATER
The tile/execution is done by "water".
DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
DiagDirection AxisToDiagDir(Axis a)
Converts an Axis to a DiagDirection.
Axis OtherAxis(Axis a)
Select the other axis as provided.
Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
DiagDirection DirToDiagDir(Direction dir)
Convert a Direction to a DiagDirection.
Axis
Allow incrementing of DiagDirDiff variables.
@ AXIS_X
The X axis.
@ AXIS_Y
The y axis.
DiagDirection
Enumeration for diagonal directions.
@ DIAGDIR_NE
Northeast, upper right on your monitor.
@ DIAGDIR_NW
Northwest.
@ DIAGDIR_SE
Southeast.
@ DIAGDIR_END
Used for iterations.
@ INVALID_DIAGDIR
Flag for an invalid DiagDirection.
@ DIAGDIR_SW
Southwest.
@ EXPENSES_CONSTRUCTION
Construction costs.
static const uint TUNNELBRIDGE_TRACKBIT_FACTOR
Multiplier for how many regular track bits a tunnel/bridge counts.
Price
Enumeration of all base prices for use with Prices.
void DrawRailCatenaryOnBridge(const TileInfo *ti)
Draws wires on a tunnel tile.
Definition elrail.cpp:490
void DrawRailCatenaryOnTunnel(const TileInfo *ti)
Draws wires on a tunnel tile.
Definition elrail.cpp:249
void DrawRailCatenary(const TileInfo *ti)
Draws overhead wires and pylons for electric railways.
Definition elrail.cpp:550
Header file for electrified rail specific functions.
bool HasRailCatenaryDrawn(RailType rt)
Test if we should draw rail catenary.
Definition elrail_func.h:30
constexpr std::underlying_type_t< enum_type > to_underlying(enum_type e)
Implementation of std::to_underlying (from C++23)
Definition enum_type.hpp:17
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
@ GVF_GOINGDOWN_BIT
Vehicle is currently going downhill. (Cached track information for acceleration)
@ GVF_GOINGUP_BIT
Vehicle is currently going uphill. (Cached track information for acceleration)
uint8_t GetSnowLine()
Get the current snow line, either variable or static.
void MarkTileDirtyByTile(TileIndex tile, int bridge_level_offset, int tile_height_override)
Mark a tile given by its index dirty for repaint.
uint GetPartialPixelZ(int x, int y, Slope corners)
Determines height at given coordinate of a slope.
void DrawFoundation(TileInfo *ti, Foundation f)
Draw foundation f at tile ti.
void GetSlopePixelZOnEdge(Slope tileh, DiagDirection edge, int &z1, int &z2)
Determine the Z height of the corners of a specific tile edge.
const TileTypeProcs *const _tile_type_procs[16]
Tile callback functions for each type of tile.
Definition landscape.cpp:69
uint ApplyFoundationToSlope(Foundation f, Slope &s)
Applies a foundation to a slope.
int GetSlopePixelZ(int x, int y, bool ground_vehicle)
Return world Z coordinate of a given point of a tile.
uint ApplyPixelFoundationToSlope(Foundation f, Slope &s)
Applies a foundation to a slope.
Definition landscape.h:128
Command definitions related to landscape (slopes etc.).
uint DistanceSquare(TileIndex t0, TileIndex t1)
Gets the 'Square' distance between the two given tiles.
Definition map.cpp:175
TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition map_func.h:401
TileIndexDiff TileOffsByAxis(Axis axis)
Convert an Axis to a TileIndexDiff.
Definition map_func.h:567
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:437
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:427
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:582
int32_t TileIndexDiff
An offset value between two tiles.
Definition map_type.h:23
constexpr T abs(const T a)
Returns the absolute value of (scalar) variable.
Definition math_func.hpp:23
@ TCX_ON_BRIDGE
Querying information about stuff on the bridge (via some bridgehead).
@ TCX_NORMAL
Nothing special.
SpriteID GetCustomRailSprite(const RailTypeInfo *rti, TileIndex tile, RailTypeSpriteGroup rtsg, TileContext context, uint *num_results)
Get the sprite to draw for the given tile.
NewGRF handling of rail types.
SpriteID GetCustomRoadSprite(const RoadTypeInfo *rti, TileIndex tile, RoadTypeSpriteGroup rtsg, TileContext context, uint *num_results)
Get the sprite to draw for the given tile.
NewGRF handling of road types.
bool PlayVehicleSound(const Vehicle *v, VehicleSoundEvent event, bool force)
Checks whether a NewGRF wants to play a different vehicle sound effect.
Functions related to NewGRF provided sounds.
@ VSE_TUNNEL
Train entering a tunnel.
Base for all objects.
ClearedObjectArea * FindClearedObject(TileIndex tile)
Find the entry in _cleared_object_areas which occupies a certain tile.
Train * GetTrainForReservation(TileIndex tile, Track track)
Find the train which has reserved a specific path.
Definition pbs.cpp:331
PBS support routines.
bool ValParamRailType(const RailType rail)
Validate functions for rail building.
Definition rail.cpp:90
@ RTBO_Y
Piece of rail in Y direction.
Definition rail.h:85
@ RTBO_X
Piece of rail in X direction.
Definition rail.h:84
@ RTBO_SLOPE
Sloped rail pieces, in order NE, SE, SW, NW.
Definition rail.h:86
Money RailClearCost(RailType railtype)
Returns the 'cost' of clearing the specified railtype.
Definition rail.h:439
Money RailBuildCost(RailType railtype)
Returns the cost of building the specified railtype.
Definition rail.h:428
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition rail.h:300
@ RTSG_TUNNEL
Main group of ground images for snow or desert.
Definition rail.h:44
@ RTSG_OVERLAY
Images for overlaying track.
Definition rail.h:42
@ RTSG_BRIDGE
Bridge surface images.
Definition rail.h:47
@ RTSG_TUNNEL_PORTAL
Tunnel portal overlay.
Definition rail.h:51
@ RTO_SLOPE_NE
Piece of rail on slope with north-east raised.
Definition rail.h:68
@ RTO_X
Piece of rail in X direction.
Definition rail.h:62
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:25
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition rail_type.h:32
bool ValParamRoadType(RoadType roadtype)
Validate functions for rail building.
Definition road.cpp:164
Money RoadClearCost(RoadType roadtype)
Returns the cost of clearing the specified roadtype.
Definition road.h:251
const RoadTypeInfo * GetRoadTypeInfo(RoadType roadtype)
Returns a pointer to the Roadtype information for a given roadtype.
Definition road.h:215
@ ROTSG_OVERLAY
Optional: Images for overlaying track.
Definition road.h:38
@ ROTSG_CATENARY_BACK
Optional: Catenary back.
Definition road.h:42
@ ROTSG_BRIDGE
Required: Bridge surface images.
Definition road.h:43
@ ROTSG_CATENARY_FRONT
Optional: Catenary front.
Definition road.h:41
@ ROTSG_TUNNEL
Optional: Ground images for tunnels.
Definition road.h:40
Money RoadBuildCost(RoadType roadtype)
Returns the cost of building the specified roadtype.
Definition road.h:240
void UpdateCompanyRoadInfrastructure(RoadType rt, Owner o, int count)
Update road infrastructure counts for a company.
Definition road_cmd.cpp:180
void DrawRoadOverlays(const TileInfo *ti, PaletteID pal, const RoadTypeInfo *road_rti, const RoadTypeInfo *tram_rti, uint road_offset, uint tram_offset, bool draw_underlay)
Draw road underlay and overlay sprites.
bool HasRoadCatenaryDrawn(RoadType roadtype)
Test if we should draw road catenary.
Definition road_func.h:145
void SetRoadOwner(Tile t, RoadTramType rtt, Owner o)
Set the owner of a specific road type.
Definition road_map.h:235
bool HasTileRoadType(Tile t, RoadTramType rtt)
Check if a tile has a road or a tram road type.
Definition road_map.h:195
Roadside GetRoadside(Tile tile)
Get the decorations of a road.
Definition road_map.h:473
static bool IsNormalRoadTile(Tile t)
Return whether a tile is a normal road tile.
Definition road_map.h:58
Owner GetRoadOwner(Tile t, RoadTramType rtt)
Get the owner of a specific road type.
Definition road_map.h:218
void SetRoadside(Tile tile, Roadside s)
Set the decorations of a road.
Definition road_map.h:483
@ Paved
Road with paved sidewalks.
@ Trees
Road with trees on paved sidewalks.
RoadTramType
The different types of road type.
Definition road_type.h:37
@ RTT_ROAD
Road road type.
Definition road_type.h:38
@ RTT_TRAM
Tram road type.
Definition road_type.h:39
RoadType
The different roadtypes we support.
Definition road_type.h:23
@ INVALID_ROADTYPE
flag for invalid roadtype
Definition road_type.h:28
Road vehicle states.
@ RVSB_WORMHOLE
The vehicle is in a tunnel and/or bridge.
Definition roadveh.h:39
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition settings.cpp:61
ClientSettings _settings_client
The current settings for this game.
Definition settings.cpp:60
Base for ships.
void AddSideToSignalBuffer(TileIndex tile, DiagDirection side, Owner owner)
Add side of tile to signal update buffer.
Definition signal.cpp:621
uint SlopeToSpriteOffset(Slope s)
Returns the Sprite offset for a given Slope.
Definition slope_func.h:415
bool HasSlopeHighestCorner(Slope s)
Tests if a slope has a highest corner (i.e.
Definition slope_func.h:113
Foundation FlatteningFoundation(Slope s)
Returns the foundation needed to flatten a slope.
Definition slope_func.h:369
DiagDirection GetInclinedSlopeDirection(Slope s)
Returns the direction of an inclined slope.
Definition slope_func.h:239
Foundation InclinedFoundation(Axis axis)
Returns the along a specific axis inclined foundation.
Definition slope_func.h:380
Slope ComplementSlope(Slope s)
Return the complement of a slope.
Definition slope_func.h:76
Slope
Enumeration for the slope-type.
Definition slope_type.h:47
@ SLOPE_SW
south and west corner are raised
Definition slope_type.h:55
@ SLOPE_FLAT
a flat tile
Definition slope_type.h:48
@ SLOPE_NE
north and east corner are raised
Definition slope_type.h:57
@ SLOPE_SE
south and east corner are raised
Definition slope_type.h:56
@ SLOPE_NW
north and west corner are raised
Definition slope_type.h:54
Foundation
Enumeration for Foundations.
Definition slope_type.h:92
@ FOUNDATION_NONE
The tile has no foundation, the slope remains unchanged.
Definition slope_type.h:93
Functions related to sound.
@ SND_05_TRAIN_THROUGH_TUNNEL
3 == 0x03 Train enters tunnel: steam engine
Definition sound_type.h:50
static constexpr uint32_t SPRITE_MASK
The mask to for the main sprite.
Definition sprites.h:1570
static const PaletteID PALETTE_CRASH
Recolour sprite greying of crashed vehicles.
Definition sprites.h:1619
static const SpriteID SPR_RAILTYPE_TUNNEL_BASE
Tunnel sprites with grass only for custom railtype tunnel.
Definition sprites.h:301
static const SpriteID SPR_TRAMWAY_BASE
Tramway sprites.
Definition sprites.h:274
Definition of base types and functions in a cross-platform compatible way.
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:271
Functions related to OTTD's strings.
VehicleType type
Type of vehicle.
Struct containing information about a single bridge type.
Definition bridge.h:27
ControlFlags ctrl_flags
control flags
Definition bridge.h:46
@ InvalidPillarFlags
Bridge pillar flags are not valid, i.e. only the tile layout has been modified.
uint8_t min_length
the minimum length (not counting start and end tile)
Definition bridge.h:36
BridgeMiddlePillarFlags pillar_flags
bridge pillar flags.
Definition bridge.h:47
std::vector< std::vector< PalSpriteID > > sprite_table
table of sprites for drawing the bridge
Definition bridge.h:44
TimerGameCalendar::Year avail_year
the year where it becomes available
Definition bridge.h:35
uint16_t speed
maximum travel speed (1 unit = 1/1.6 mph = 1 km-ish/h)
Definition bridge.h:39
uint16_t max_length
the maximum length (not counting start and end tile)
Definition bridge.h:37
bool value
tells if the bool cheat is active or not
Definition cheat_type.h:18
Cheat crossing_tunnels
allow tunnels that cross each other
Definition cheat_type.h:30
Cheat magic_bulldozer
dynamite industries, objects
Definition cheat_type.h:27
Keeps track of removed objects during execution/testruns of commands.
Definition object_base.h:85
TileIndex first_tile
The first tile being cleared, which then causes the whole object to be cleared.
Definition object_base.h:86
GUISettings gui
settings related to the GUI
std::array< uint32_t, ROADTYPE_END > road
Count of company owned track bits for each road type.
std::array< uint32_t, RAILTYPE_END > rail
Count of company owned track bits for each rail type.
uint32_t water
Count of company owned track bits for canals.
bool is_ai
If true, the company is (also) controlled by the computer (a NoAI program).
CompanyInfrastructure infrastructure
NOSAVE: Counts of company owned infrastructure.
uint8_t max_bridge_height
maximum height of bridges
bool build_on_slopes
allow building on slopes
bool extra_dynamite
extra dynamite
uint16_t max_bridge_length
maximum length of bridges
uint16_t max_tunnel_length
maximum length of tunnels
T x
X coordinate.
T y
Y coordinate.
T z
Z coordinate.
bool show_track_reservation
highlight reserved tracks.
LandscapeType landscape
the landscape we're currently in
ConstructionSettings construction
construction of things in-game
GameCreationSettings game_creation
settings used during the creation of a game (map)
static uint MaxX()
Gets the maximum X coordinate within the map, including MP_VOID.
Definition map_func.h:299
Combination of a palette sprite and a 'real' sprite.
Definition gfx_type.h:22
SpriteID sprite
The 'real' sprite.
Definition gfx_type.h:23
PaletteID pal
The palette (use PAL_NONE) if not needed)
Definition gfx_type.h:24
static Titem * Get(auto index)
Returns Titem with given index.
static bool IsValidID(auto index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
const Tindex index
Index of this pool item.
static Titem * GetIfValid(auto index)
Returns Titem with given index.
EngineClass engclass
Class of engine for this vehicle.
Definition engine_type.h:86
Buses, trucks and trams belong to this class.
Definition roadveh.h:98
uint8_t state
Definition roadveh.h:100
All ships have this type.
Definition ship.h:32
TrackBits state
The "track" the ship is following.
Definition ship.h:34
static T * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Used to only draw a part of the sprite.
Definition gfx_type.h:278
Tile description for the 'land area information' tool.
Definition tile_cmd.h:36
uint16_t rail_speed
Speed limit of rail (bridges and track)
Definition tile_cmd.h:49
StringID str
Description of the tile.
Definition tile_cmd.h:37
std::array< Owner, 4 > owner
Name of the owner(s)
Definition tile_cmd.h:39
uint16_t tram_speed
Speed limit of tram (bridges and track)
Definition tile_cmd.h:53
StringID roadtype
Type of road on the tile.
Definition tile_cmd.h:50
StringID tramtype
Type of tram on the tile.
Definition tile_cmd.h:52
StringID railtype
Type of rail on the tile.
Definition tile_cmd.h:48
uint16_t road_speed
Speed limit of road (bridges and track)
Definition tile_cmd.h:51
std::array< StringID, 4 > owner_type
Type of each owner.
Definition tile_cmd.h:40
Tile information, used while rendering the tile.
Definition tile_cmd.h:30
Slope tileh
Slope of the tile.
Definition tile_cmd.h:31
TileIndex tile
Tile index.
Definition tile_cmd.h:32
Set of callback functions for performing tile operations of a given tile type.
Definition tile_cmd.h:152
std::array< uint32_t, NUM_HOUSE_ZONES > squared_town_zone_radius
UpdateTownRadius updates this given the house count.
Definition town.h:56
Town data structure.
Definition town.h:63
TileIndex xy
town center tile
Definition town.h:64
TownCache cache
Container for all cacheable data.
Definition town.h:66
'Train' is either a loco or a wagon.
Definition train.h:91
Vehicle data structure.
EngineID engine_type
The type of engine used for this vehicle.
int32_t z_pos
z coordinate.
Direction direction
facing
VehStates vehstatus
Status.
Vehicle * First() const
Get the first vehicle of this vehicle chain.
uint16_t cur_speed
current speed
bool IsFrontEngine() const
Check if the vehicle is a front engine.
TileIndex tile
Current tile index.
Command definitions related to terraforming.
@ CannotEnter
The vehicle cannot enter the tile.
@ EnteredWormhole
The vehicle either entered a bridge, tunnel or depot tile (this includes the last tile of the bridge/...
std::tuple< Slope, int > GetTileSlopeZ(TileIndex tile)
Return the slope of a given tile inside the map.
Definition tile_map.cpp:55
int GetTileMaxZ(TileIndex t)
Get top height of the tile inside the map.
Definition tile_map.cpp:136
int GetTileZ(TileIndex tile)
Get bottom height of the tile.
Definition tile_map.cpp:116
static uint TileHeight(Tile tile)
Returns the height of a tile.
Definition tile_map.h:29
bool IsTileOwner(Tile tile, Owner owner)
Checks if a tile belongs to the given owner.
Definition tile_map.h:214
Owner GetTileOwner(Tile tile)
Returns the owner of a tile.
Definition tile_map.h:178
void SetTileOwner(Tile tile, Owner owner)
Sets the owner of a tile.
Definition tile_map.h:198
std::tuple< Slope, int > GetTilePixelSlope(TileIndex tile)
Return the slope of a given tile.
Definition tile_map.h:289
bool IsValidTile(Tile tile)
Checks if a tile is valid.
Definition tile_map.h:161
TropicZone GetTropicZone(Tile tile)
Get the tropic zone.
Definition tile_map.h:238
static TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
static constexpr uint TILE_UNIT_MASK
For masking in/out the inner-tile world coordinate units.
Definition tile_type.h:16
@ TROPICZONE_DESERT
Tile is desert.
Definition tile_type.h:78
constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition tile_type.h:95
static constexpr uint TILE_SIZE
Tile size in world coordinates.
Definition tile_type.h:15
static constexpr uint TILE_HEIGHT
Height of a height level in world coordinate AND in pixels in ZOOM_BASE.
Definition tile_type.h:18
OrthogonalTileArea TileArea
Shorthand for the much more common orthogonal tile area.
Definition of the game-calendar-timer.
Base of the town class.
void ChangeTownRating(Town *t, int add, int max, DoCommandFlags flags)
Changes town rating of the current company.
@ TunnelBridgeRemove
Removal of a tunnel or bridge owned by the town.
Town * ClosestTownFromTile(TileIndex tile, uint threshold)
Return the town closest (in distance or ownership) to a given tile, within a given threshold.
Town * CalcClosestTownFromTile(TileIndex tile, uint threshold=UINT_MAX)
Return the town closest to the given tile within threshold.
CommandCost CheckforTownRating(DoCommandFlags flags, Town *t, TownRatingCheckType type)
Does the town authority allow the (destructive) action of the current company?
static constexpr int RATING_TUNNEL_BRIDGE_UP_STEP
rating increase for improving a town-owned bridge
Definition town_type.h:58
static constexpr int RATING_TUNNEL_BRIDGE_MINIMUM
minimum rating after removing tunnel or bridge
Definition town_type.h:60
static constexpr int RATING_TUNNEL_BRIDGE_DOWN_STEP
penalty for removing town owned tunnel or bridge
Definition town_type.h:59
TrackdirBits TrackBitsToTrackdirBits(TrackBits bits)
Converts TrackBits to TrackdirBits while allowing both directions.
Definition track_func.h:319
TrackStatus CombineTrackStatus(TrackdirBits trackdirbits, TrackdirBits red_signals)
Builds a TrackStatus.
Definition track_func.h:388
TrackBits DiagDirToDiagTrackBits(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track bits incidating with that diagdir.
Definition track_func.h:524
Trackdir DiagDirToDiagTrackdir(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal trackdir that runs in that direction.
Definition track_func.h:537
Track AxisToTrack(Axis a)
Convert an Axis to the corresponding Track AXIS_X -> TRACK_X AXIS_Y -> TRACK_Y Uses the fact that the...
Definition track_func.h:66
Track DiagDirToDiagTrack(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track incidating with that diagdir.
Definition track_func.h:512
@ TRACK_BIT_WORMHOLE
Bitflag for a wormhole (used for tunnels)
Definition track_type.h:52
@ TRACKDIR_BIT_NONE
No track build.
Definition track_type.h:98
Track
These are used to specify a single track.
Definition track_type.h:19
Base for the train class.
bool TryPathReserve(Train *v, bool mark_as_stuck=false, bool first_tile_okay=false)
Try to reserve a path to a safe position.
void FreeTrainTrackReservation(const Train *v)
Free the reserved path in front of a vehicle.
bool IsTransparencySet(TransparencyOption to)
Check if the transparency option bit is set and if we aren't in the game menu (there's never transpar...
bool IsInvisibilitySet(TransparencyOption to)
Check if the invisibility option bit is set and if we aren't in the game menu (there's never transpar...
@ TO_BRIDGES
bridges
@ TO_CATENARY
catenary
TransportType
Available types of transport.
@ TRANSPORT_RAIL
Transport by train.
@ TRANSPORT_ROAD
Transport by road vehicle.
@ TRANSPORT_WATER
Transport over water.
bool IsTunnelInWayDir(TileIndex tile, int z, DiagDirection dir)
Is there a tunnel in the way in the given direction?
TileIndex GetOtherTunnelEnd(TileIndex tile)
Gets the other end of the tunnel.
void MakeRailTunnel(Tile t, Owner o, DiagDirection d, RailType r)
Makes a rail tunnel entrance.
Definition tunnel_map.h:73
bool IsTunnel(Tile t)
Is this a tunnel (entrance)?
Definition tunnel_map.h:23
void MakeRoadTunnel(Tile t, Owner o, DiagDirection d, RoadType road_rt, RoadType tram_rt)
Makes a road tunnel entrance.
Definition tunnel_map.h:50
Header file for things common for tunnels and bridges.
uint GetTunnelBridgeLength(TileIndex begin, TileIndex end)
Calculates the length of a tunnel or a bridge (without end tiles)
CommandCost CmdBuildBridge(DoCommandFlags flags, TileIndex tile_end, TileIndex tile_start, TransportType transport_type, BridgeType bridge_type, uint8_t road_rail_type)
Build a Bridge.
static CommandCost ClearTile_TunnelBridge(TileIndex tile, DoCommandFlags flags)
Remove a tunnel or a bridge from the game.
CommandCost CmdBuildTunnel(DoCommandFlags flags, TileIndex start_tile, TransportType transport_type, uint8_t road_rail_type)
Build Tunnel.
static void DrawBridgePillars(const PalSpriteID &psid, const TileInfo *ti, Axis axis, bool drawfarpillar, int x, int y, int z_bridge)
Draws the pillars under high bridges.
static BridgePieces CalcBridgePiece(uint north, uint south)
Compute bridge piece.
static bool BridgeHasCustomSpriteTable(BridgeType bridge_type, BridgePieces piece)
Test if bridge piece uses a custom sprite table.
static CommandCost CheckAllowRemoveTunnelBridge(TileIndex tile)
Are we allowed to remove the tunnel or bridge at tile?
static Money TunnelBridgeClearCost(TileIndex tile, Price base_price)
Calculate the base cost of clearing a tunnel/bridge per tile.
Foundation GetBridgeFoundation(Slope tileh, Axis axis)
Get the foundation for a bridge.
const uint8_t _tunnel_visibility_frame[DIAGDIR_END]
Frame when a vehicle should be hidden in a tunnel with a certain direction.
static CommandCost DoClearTunnel(TileIndex tile, DoCommandFlags flags)
Remove a tunnel from the game, update town rating, etc.
static CommandCost DoClearBridge(TileIndex tile, DoCommandFlags flags)
Remove a bridge from the game, update town rating, etc.
static int DrawPillarColumn(int z_bottom, int z_top, const PalSpriteID &psid, int x, int y, int w, int h)
Draw two bridge pillars (north and south).
static BridgePillarFlags GetBridgeTilePillarFlags(TileIndex tile, TileIndex rampnorth, TileIndex rampsouth, BridgeType type, TransportType transport_type)
Get pillar information for a bridge middle tile.
static void DrawPillar(const PalSpriteID &psid, int x, int y, int z, uint8_t w, uint8_t h, const SubSprite *subsprite)
Draw a single pillar sprite.
static uint8_t GetBridgeRampDirectionBaseOffset(DiagDirection diagdir)
Get bridge sprite table base offset for the ramp part of bridge.
CommandCost CheckBridgeAvailability(BridgeType bridge_type, uint bridge_len, DoCommandFlags flags)
Is a bridge of the specified type and length available?
void MarkBridgeDirty(TileIndex begin, TileIndex end, DiagDirection direction, uint bridge_height)
Mark bridge tiles dirty.
bool HasBridgeFlatRamp(Slope tileh, Axis axis)
Determines if the track on a bridge ramp is flat or goes up/down.
static void DrawTile_TunnelBridge(TileInfo *ti)
Draws a tunnel of bridge tile.
void DrawBridgeMiddle(const TileInfo *ti, BridgePillarFlags blocked_pillars)
Draw the middle bits of a bridge.
static std::span< const PalSpriteID > GetBridgeSpriteTable(BridgeType bridge_type, BridgePieces piece)
Get the sprite table for a rail/road bridge piece.
static const int BRIDGE_Z_START
Z position of the bridge sprites relative to bridge height (downwards)
static uint8_t GetBridgeMiddleAxisBaseOffset(Axis axis)
Get bridge sprite table base offset for the middle part of bridge.
TileIndex _build_tunnel_endtile
The end of a tunnel; as hidden return from the tunnel build command for GUI purposes.
BridgeSpec _bridge[MAX_BRIDGES]
The specification of all bridges.
static void GetBridgeRoadCatenary(const RoadTypeInfo *rti, TileIndex head_tile, int offset, bool head, SpriteID &spr_back, SpriteID &spr_front)
Retrieve the sprites required for catenary on a road/tram bridge.
int CalcBridgeLenCostFactor(int length)
Calculate the price factor for building a long bridge.
static void PrepareToEnterBridge(T *gv)
Helper to prepare the ground vehicle when entering a bridge.
static uint8_t GetBridgeSpriteTableBaseOffset(TransportType transport_type, TileIndex ramp)
Get the sprite table transport type base offset for a rail/road bridge.
void ResetBridges()
Reset the data been eventually changed by the grf loaded.
static CommandCost CheckBridgeSlope(BridgePieces bridge_piece, Axis axis, Slope &tileh, int &z)
Determines the foundation for the bridge head, and tests if the resulting slope is valid.
static void DrawBridgeRoadBits(TileIndex head_tile, int x, int y, int z, int offset, bool head, bool is_custom_layout)
Draws the road and trambits over an already drawn (lower end) of a bridge.
static const uint8_t TUNNEL_SOUND_FRAME
Frame when the 'enter tunnel' sound should be played.
Command definitions related to tunnels and bridges.
Functions that have tunnels and bridges in common.
void SetTunnelBridgeSnowOrDesert(Tile t, bool snow_or_desert)
Tunnel: Places this tunnel entrance in a snowy or desert area, or takes it out of there.
DiagDirection GetTunnelBridgeDirection(Tile t)
Get the direction pointing to the other end.
bool HasTunnelBridgeSnowOrDesert(Tile t)
Tunnel: Is this tunnel entrance in a snowy or desert area? Bridge: Does the bridge ramp lie in a snow...
bool HasTunnelBridgeReservation(Tile t)
Get the reservation state of the rail tunnel/bridge.
TransportType GetTunnelBridgeTransportType(Tile t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
TileIndex GetOtherTunnelBridgeEnd(Tile t)
Determines type of the wormhole and returns its other end.
void SetTunnelBridgeReservation(Tile t, bool b)
Set the reservation state of the rail tunnel/bridge.
CommandCost TunnelBridgeIsFree(TileIndex tile, TileIndex endtile, const Vehicle *ignore)
Finds vehicle in tunnel / bridge.
Definition vehicle.cpp:552
@ Hidden
Vehicle is not visible.
Functions related to vehicles.
@ VEH_ROAD
Road vehicle type.
@ VEH_SHIP
Ship vehicle type.
@ VEH_TRAIN
Train vehicle type.
void StartSpriteCombine()
Starts a block of sprites, which are "combined" into a single bounding box.
Definition viewport.cpp:764
void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int z, const SpriteBounds &bounds, bool transparent, const SubSprite *sub)
Draw a (transparent) sprite at given coordinates with a given bounding box.
Definition viewport.cpp:663
void EndSpriteCombine()
Terminates a block of sprites started by StartSpriteCombine.
Definition viewport.cpp:774
void DrawGroundSprite(SpriteID image, PaletteID pal, const SubSprite *sub, int extra_offs_x, int extra_offs_y)
Draws a ground sprite for the current tile.
Definition viewport.cpp:579
Functions related to (drawing on) viewports.
static constexpr int BB_Z_SEPARATOR
Separates the bridge/tunnel from the things under/above it.
Functions related to water management.
void CheckForDockingTile(TileIndex t)
Mark the supplied tile as a docking tile if it is suitable for docking.
bool HasTileWaterGround(Tile t)
Checks whether the tile has water at the ground.
Definition water_map.h:352
bool HasTileWaterClass(Tile t)
Checks whether the tile has an waterclass associated.
Definition water_map.h:103
WaterClass GetWaterClass(Tile t)
Get the water class at a tile.
Definition water_map.h:114
Entry point for OpenTTD to YAPF's cache.
void YapfNotifyTrackLayoutChange(TileIndex tile, Track track)
Use this function to notify YAPF that track layout (or signal configuration) has change.