OpenTTD Source 20260218-master-g2123fca5ea
elrail.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
54
55#include "stdafx.h"
56#include "station_map.h"
57#include "viewport_func.h"
58#include "train.h"
59#include "rail_gui.h"
60#include "tunnelbridge_map.h"
61#include "tunnelbridge.h"
62#include "elrail_func.h"
63#include "company_base.h"
64#include "newgrf_railtype.h"
65
66#include "table/elrail_data.h"
67
68#include "safeguards.h"
69
76{
77 return static_cast<TileLocationGroup>((GB(TileX(t), 0, 1) << 1) + GB(TileY(t), 0, 1));
78}
79
86static TrackBits GetRailTrackBitsUniversal(TileIndex t, DiagDirections *override)
87{
88 switch (GetTileType(t)) {
91 switch (GetRailTileType(t)) {
93 return GetTrackBits(t);
94 default:
95 return TRACK_BIT_NONE;
96 }
97 break;
98
102 if (override != nullptr && (IsTunnel(t) || GetTunnelBridgeLength(t, GetOtherBridgeEnd(t)) > 0)) {
103 *override = GetTunnelBridgeDirection(t);
104 }
106
107 case TileType::Road:
108 if (!IsLevelCrossing(t)) return TRACK_BIT_NONE;
110 return GetCrossingRailBits(t);
111
113 if (!HasStationRail(t)) return TRACK_BIT_NONE;
116
117 default:
118 return TRACK_BIT_NONE;
119 }
120}
121
129{
130 /* Single track bits are never masked out. */
131 if (HasAtMostOneBit(tracks)) [[likely]] return tracks;
132
133 if (!IsPlainRailTile(t)) return tracks;
134
135 TrackdirBits neighbour_tdb = TRACKDIR_BIT_NONE;
136 for (DiagDirection d = DIAGDIR_BEGIN; d < DIAGDIR_END; d++) {
137 /* If the neighbour tile is either not electrified or has no tracks that can be reached
138 * from this tile, mark all trackdirs that can be reached from the neighbour tile
139 * as needing no catenary. We make an exception for blocked station tiles with a matching
140 * axis that still display wires to preserve visual continuity. */
141 TileIndex next_tile = TileAddByDiagDir(t, d);
142 RailType rt = GetTileRailType(next_tile);
143 if (rt == INVALID_RAILTYPE || !HasRailCatenary(rt) ||
145 (!HasStationTileRail(next_tile) || GetRailStationAxis(next_tile) != DiagDirToAxis(d) || !CanStationTileHaveWires(next_tile)))) {
146 neighbour_tdb |= DiagdirReachesTrackdirs(ReverseDiagDir(d));
147 }
148 }
149
150 /* If the tracks from either a diagonal crossing or don't overlap, both
151 * trackdirs have to be marked to mask the corresponding track bit. Else
152 * one marked trackdir is enough the mask the track bit. */
153 TrackBits mask;
154 if (tracks == TRACK_BIT_CROSS || !TracksOverlap(tracks)) {
155 /* If the tracks form either a diagonal crossing or don't overlap, both
156 * trackdirs have to be marked to mask the corresponding track bit. */
157 mask = ~(TrackBits)((neighbour_tdb & (neighbour_tdb >> 8)) & TRACK_BIT_MASK);
158 /* If that results in no masked tracks and it is not a diagonal crossing,
159 * require only one marked trackdir to mask. */
160 if (tracks != TRACK_BIT_CROSS && (mask & TRACK_BIT_MASK) == TRACK_BIT_MASK) mask = ~TrackdirBitsToTrackBits(neighbour_tdb);
161 } else {
162 /* Require only one marked trackdir to mask the track. */
163 mask = ~TrackdirBitsToTrackBits(neighbour_tdb);
164 /* If that results in an empty set, require both trackdirs for diagonal track. */
165 if ((tracks & mask) == TRACK_BIT_NONE) {
166 if ((neighbour_tdb & TRACKDIR_BIT_X_NE) == 0 || (neighbour_tdb & TRACKDIR_BIT_X_SW) == 0) mask |= TRACK_BIT_X;
167 if ((neighbour_tdb & TRACKDIR_BIT_Y_NW) == 0 || (neighbour_tdb & TRACKDIR_BIT_Y_SE) == 0) mask |= TRACK_BIT_Y;
168 /* If that still is not enough, require both trackdirs for any track. */
169 if ((tracks & mask) == TRACK_BIT_NONE) mask = ~(TrackBits)((neighbour_tdb & (neighbour_tdb >> 8)) & TRACK_BIT_MASK);
170 }
171 }
172
173 /* Mask the tracks only if at least one track bit would remain. */
174 return (tracks & mask) != TRACK_BIT_NONE ? tracks & mask : tracks;
175}
176
184{
185 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
186 SpriteID wires = GetCustomRailSprite(rti, tile, RTSG_WIRES, context);
187 return wires == 0 ? SPR_WIRE_BASE : wires;
188}
189
197{
198 const RailTypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
199 SpriteID pylons = GetCustomRailSprite(rti, tile, RTSG_PYLONS, context);
200 return pylons == 0 ? SPR_PYLON_BASE : pylons;
201}
202
208static void AdjustTileh(TileIndex tile, Slope *tileh)
209{
211 if (IsTunnel(tile)) {
212 *tileh = SLOPE_STEEP; // XXX - Hack to make tunnel entrances to always have a pylon
213 } else if (*tileh != SLOPE_FLAT) {
214 *tileh = SLOPE_FLAT;
215 } else {
217 }
218 }
219}
220
228static int GetPCPElevation(TileIndex tile, DiagDirection pcp_pos)
229{
230 /* The elevation of the "pylon"-sprite should be the elevation at the PCP.
231 * PCPs are always on a tile edge.
232 *
233 * This position can be outside of the tile, i.e. ?_pcp_offset == TILE_SIZE > TILE_SIZE - 1.
234 * So we have to move it inside the tile, because if the neighboured tile has a foundation,
235 * that does not smoothly connect to the current tile, we will get a wrong elevation from GetSlopePixelZ().
236 *
237 * When we move the position inside the tile, we will get a wrong elevation if we have a slope.
238 * To catch all cases we round the Z position to the next (TILE_HEIGHT / 2).
239 * This will return the correct elevation for slopes and will also detect non-continuous elevation on edges.
240 *
241 * Also note that the result of GetSlopePixelZ() is very special on bridge-ramps.
242 */
243
244 int z = GetSlopePixelZ(TileX(tile) * TILE_SIZE + std::min<int8_t>(_x_pcp_offsets[pcp_pos], TILE_SIZE - 1),
245 TileY(tile) * TILE_SIZE + std::min<int8_t>(_y_pcp_offsets[pcp_pos], TILE_SIZE - 1), true);
246 /* Round the Z to the nearest half tile height. */
247 static const uint HALF_TILE_HEIGHT = TILE_HEIGHT / 2;
248 return (z + HALF_TILE_HEIGHT / 2) / HALF_TILE_HEIGHT * HALF_TILE_HEIGHT;
249}
250
259{
261
262 SpriteID wire_base = GetWireBase(ti->tile);
263
264 const SortableSpriteStruct &sss = _rail_catenary_sprite_data_tunnel[dir];
265 AddSortableSpriteToDraw(wire_base + sss.image_offset, PAL_NONE, ti->x, ti->y, GetTilePixelZ(ti->tile), sss, IsTransparencySet(TO_CATENARY));
266}
267
272static void DrawRailCatenaryRailway(const TileInfo *ti)
273{
274 /* Pylons are placed on a tile edge, so we need to take into account
275 * the track configuration of 2 adjacent tiles. trackconfig[0] stores the
276 * current tile (home tile) while [1] holds the neighbour */
277 TrackBits track_config[TS_END];
278 TrackBits wire_config[TS_END];
279 bool is_flat[TS_END];
280 /* Note that ti->tileh has already been adjusted for Foundations */
281 Slope tileh[TS_END] = { ti->tileh, SLOPE_FLAT };
282
283 /* Half tile slopes coincide only with horizontal/vertical track.
284 * Faking a flat slope results in the correct sprites on positions. */
285 Corner halftile_corner = CORNER_INVALID;
286 if (IsHalftileSlope(tileh[TS_HOME])) {
287 halftile_corner = GetHalftileSlopeCorner(tileh[TS_HOME]);
288 tileh[TS_HOME] = SLOPE_FLAT;
289 }
290
292 DiagDirections pcp_status{};
293 DiagDirections override_pcp{};
294 std::array<Directions, DIAGDIR_END> ppp_preferred{};
295 std::array<Directions, DIAGDIR_END> ppp_allowed{};
296
297 /* Find which rail bits are present, and select the override points.
298 * We don't draw a pylon:
299 * 1) INSIDE a tunnel (we wouldn't see it anyway)
300 * 2) on the "far" end of a bridge head (the one that connects to bridge middle),
301 * because that one is drawn on the bridge. Exception is for length 0 bridges
302 * which have no middle tiles */
303 track_config[TS_HOME] = GetRailTrackBitsUniversal(ti->tile, &override_pcp);
304 wire_config[TS_HOME] = MaskWireBits(ti->tile, track_config[TS_HOME]);
305 /* If a track bit is present that is not in the main direction, the track is level */
306 is_flat[TS_HOME] = ((track_config[TS_HOME] & (TRACK_BIT_HORZ | TRACK_BIT_VERT)) != 0);
307
308 AdjustTileh(ti->tile, &tileh[TS_HOME]);
309
310 SpriteID pylon_normal = GetPylonBase(ti->tile);
311 SpriteID pylon_halftile = (halftile_corner != CORNER_INVALID) ? GetPylonBase(ti->tile, TCX_UPPER_HALFTILE) : pylon_normal;
312
313 for (DiagDirection i = DIAGDIR_BEGIN; i < DIAGDIR_END; i++) {
314 static const uint edge_corners[] = {
315 1 << CORNER_N | 1 << CORNER_E, // DIAGDIR_NE
316 1 << CORNER_S | 1 << CORNER_E, // DIAGDIR_SE
317 1 << CORNER_S | 1 << CORNER_W, // DIAGDIR_SW
318 1 << CORNER_N | 1 << CORNER_W, // DIAGDIR_NW
319 };
320 SpriteID pylon_base = (halftile_corner != CORNER_INVALID && HasBit(edge_corners[i], halftile_corner)) ? pylon_halftile : pylon_normal;
321 TileIndex neighbour = ti->tile + TileOffsByDiagDir(i);
322 int elevation = GetPCPElevation(ti->tile, i);
323
324 /* Here's one of the main headaches. GetTileSlope does not correct for possibly
325 * existing foundataions, so we do have to do that manually later on.*/
326 tileh[TS_NEIGHBOUR] = GetTileSlope(neighbour);
327 track_config[TS_NEIGHBOUR] = GetRailTrackBitsUniversal(neighbour, nullptr);
328 wire_config[TS_NEIGHBOUR] = MaskWireBits(neighbour, track_config[TS_NEIGHBOUR]);
329 if (IsTunnelTile(neighbour) && i != GetTunnelBridgeDirection(neighbour)) wire_config[TS_NEIGHBOUR] = track_config[TS_NEIGHBOUR] = TRACK_BIT_NONE;
330
331 /* Ignore station tiles that allow neither wires nor pylons. */
332 if (IsRailStationTile(neighbour) && !CanStationTileHavePylons(neighbour) && !CanStationTileHaveWires(neighbour)) wire_config[TS_NEIGHBOUR] = track_config[TS_NEIGHBOUR] = TRACK_BIT_NONE;
333
334 /* If the neighboured tile does not smoothly connect to the current tile (because of a foundation),
335 * we have to draw all pillars on the current tile. */
336 if (elevation != GetPCPElevation(neighbour, ReverseDiagDir(i))) wire_config[TS_NEIGHBOUR] = track_config[TS_NEIGHBOUR] = TRACK_BIT_NONE;
337
338 is_flat[TS_NEIGHBOUR] = ((track_config[TS_NEIGHBOUR] & (TRACK_BIT_HORZ | TRACK_BIT_VERT)) != 0);
339
340 ppp_preferred[i] = DIRECTIONS_ALL; // We start with preferring everything (end-of-line in any direction)
341 ppp_allowed[i] = _allowed_ppp_on_pcp[i];
342
343 /* We cycle through all the existing tracks at a PCP and see what
344 * PPPs we want to have, or may not have at all */
345 for (uint k = 0; k < NUM_TRACKS_AT_PCP; k++) {
346 /* Next to us, we have a bridge head, don't worry about that one, if it shows away from us */
347 if (_track_source_tile[i][k] == TS_NEIGHBOUR &&
348 IsBridgeTile(neighbour) &&
349 GetTunnelBridgeDirection(neighbour) == ReverseDiagDir(i)) {
350 continue;
351 }
352
353 /* We check whether the track in question (k) is present in the tile
354 * (TrackSourceTile) */
355 DiagDirection pcp_pos = i;
356 if (HasBit(wire_config[_track_source_tile[i][k]], _tracks_at_pcp[i][k])) {
357 /* track found, if track is in the neighbour tile, adjust the number
358 * of the PCP for preferred/allowed determination*/
359 pcp_pos = (_track_source_tile[i][k] == TS_HOME) ? i : ReverseDiagDir(i);
360 pcp_status.Set(i); // This PCP is in use
361 ppp_preferred[i] &= _preferred_ppp_of_track_at_pcp[_tracks_at_pcp[i][k]][pcp_pos];
362 }
363
364 if (HasBit(track_config[_track_source_tile[i][k]], _tracks_at_pcp[i][k])) {
365 ppp_allowed[i].Reset(_disallowed_ppp_of_track_at_pcp[_tracks_at_pcp[i][k]][pcp_pos]);
366 }
367 }
368
369 /* Deactivate all PPPs if PCP is not used */
370 if (!pcp_status.Test(i)) {
371 ppp_preferred[i].Reset();
372 ppp_allowed[i].Reset();
373 }
374
375 Foundation foundation = FOUNDATION_NONE;
376
377 /* Station and road crossings are always "flat", so adjust the tileh accordingly */
378 if (IsTileType(neighbour, TileType::Station) || IsTileType(neighbour, TileType::Road)) tileh[TS_NEIGHBOUR] = SLOPE_FLAT;
379
380 /* Read the foundations if they are present, and adjust the tileh */
381 if (track_config[TS_NEIGHBOUR] != TRACK_BIT_NONE && IsTileType(neighbour, TileType::Railway) && HasRailCatenary(GetRailType(neighbour))) foundation = GetRailFoundation(tileh[TS_NEIGHBOUR], track_config[TS_NEIGHBOUR]);
382 if (IsBridgeTile(neighbour)) {
383 foundation = GetBridgeFoundation(tileh[TS_NEIGHBOUR], DiagDirToAxis(GetTunnelBridgeDirection(neighbour)));
384 }
385
386 ApplyFoundationToSlope(foundation, tileh[TS_NEIGHBOUR]);
387
388 /* Half tile slopes coincide only with horizontal/vertical track.
389 * Faking a flat slope results in the correct sprites on positions. */
390 if (IsHalftileSlope(tileh[TS_NEIGHBOUR])) tileh[TS_NEIGHBOUR] = SLOPE_FLAT;
391
392 AdjustTileh(neighbour, &tileh[TS_NEIGHBOUR]);
393
394 /* If we have a straight (and level) track, we want a pylon only every 2 tiles
395 * Delete the PCP if this is the case.
396 * Level means that the slope is the same, or the track is flat */
397 if (tileh[TS_HOME] == tileh[TS_NEIGHBOUR] || (is_flat[TS_HOME] && is_flat[TS_NEIGHBOUR])) {
398 for (uint k = 0; k < NUM_IGNORE_GROUPS; k++) {
399 if (ppp_preferred[i] == _ignored_pcp[k][tlg][i]) pcp_status.Reset(i);
400 }
401 }
402
403 /* Now decide where we draw our pylons. First try the preferred PPPs, but they may not exist.
404 * In that case, we try the any of the allowed ones. if they don't exist either, don't draw
405 * anything. Note that the preferred PPPs still contain the end-of-line markers.
406 * Remove those (simply by ANDing with allowed, since these markers are never allowed) */
407 if (ppp_allowed[i].Any(ppp_preferred[i])) ppp_allowed[i] &= ppp_preferred[i];
408
409 if (IsBridgeAbove(ti->tile)) {
410 Track bridgetrack = GetBridgeAxis(ti->tile) == AXIS_X ? TRACK_X : TRACK_Y;
411 int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
412
413 if ((height <= GetTileMaxZ(ti->tile) + 1) &&
414 (i == _pcp_positions[bridgetrack][0] || i == _pcp_positions[bridgetrack][1])) {
415 override_pcp.Set(i);
416 }
417 }
418
419 if (ppp_allowed[i].Any() && pcp_status.Test(i) && !override_pcp.Test(i) &&
421
422 const auto &ppp_orders = _ppp_order[i][GetTileLocationGroup(ti->tile)];
423 for (Direction k = DIR_BEGIN; k < DIR_END; k++) {
424 Direction temp = ppp_orders[k];
425
426 if (ppp_allowed[i].Test(temp)) {
427 uint x = ti->x + _x_pcp_offsets[i] + _x_ppp_offsets[temp];
428 uint y = ti->y + _y_pcp_offsets[i] + _y_ppp_offsets[temp];
429
430 /* Don't build the pylon if it would be outside the tile */
431 if (!_owned_ppp_on_pcp[i].Test(temp)) {
432 /* We have a neighbour that will draw it, bail out */
433 if (track_config[TS_NEIGHBOUR] != TRACK_BIT_NONE) break;
434 continue; // No neighbour, go looking for a better position
435 }
436
437 AddSortableSpriteToDraw(pylon_base + _pylon_sprites[temp], PAL_NONE, x, y, elevation,
438 {{-1, -1, 0}, {1, 1, BB_HEIGHT_UNDER_BRIDGE}, {1, 1, 0}}, IsTransparencySet(TO_CATENARY));
439
440 break; // We already have drawn a pylon, bail out
441 }
442 }
443 }
444 }
445
446 /* The wire above the tunnel is drawn together with the tunnel-roof (see DrawRailCatenaryOnTunnel()) */
447 if (IsTunnelTile(ti->tile)) return;
448
449 /* Don't draw a wire under a low bridge */
451 int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
452
453 if (height <= GetTileMaxZ(ti->tile) + 1) return;
454 }
455
456 /* Don't draw a wire if the station tile does not want any */
457 if (IsRailStationTile(ti->tile) && !CanStationTileHaveWires(ti->tile)) return;
458
459 SpriteID wire_normal = GetWireBase(ti->tile);
460 SpriteID wire_halftile = (halftile_corner != CORNER_INVALID) ? GetWireBase(ti->tile, TCX_UPPER_HALFTILE) : wire_normal;
461 Track halftile_track;
462 switch (halftile_corner) {
463 case CORNER_W: halftile_track = TRACK_LEFT; break;
464 case CORNER_S: halftile_track = TRACK_LOWER; break;
465 case CORNER_E: halftile_track = TRACK_RIGHT; break;
466 case CORNER_N: halftile_track = TRACK_UPPER; break;
467 default: halftile_track = INVALID_TRACK; break;
468 }
469
470 /* Drawing of pylons is finished, now draw the wires */
471 for (Track t : SetTrackBitIterator(wire_config[TS_HOME])) {
472 SpriteID wire_base = (t == halftile_track) ? wire_halftile : wire_normal;
473 uint8_t pcp_config = pcp_status.Test(_pcp_positions[t][0]) +
474 (pcp_status.Test(_pcp_positions[t][1]) << 1);
475 int tileh_selector = !(tileh[TS_HOME] % 3) * tileh[TS_HOME] / 3; // tileh for the slopes, 0 otherwise
476
477 assert(pcp_config != 0); // We have a pylon on neither end of the wire, that doesn't work (since we have no sprites for that)
478 assert(!IsSteepSlope(tileh[TS_HOME]));
479 const SortableSpriteStruct &sss = _rail_catenary_sprite_data[_rail_wires[tileh_selector][t][pcp_config]];
480
481 /*
482 * The "wire"-sprite position is inside the tile, i.e. 0 <= sss->?_offset < TILE_SIZE.
483 * Therefore it is safe to use GetSlopePixelZ() for the elevation.
484 * Also note that the result of GetSlopePixelZ() is very special for bridge-ramps, so we round the result up or
485 * down to the nearest full height change.
486 */
487 int z = (GetSlopePixelZ(ti->x + sss.origin.x, ti->y + sss.origin.y, true) + 4) / 8 * 8;
488 AddSortableSpriteToDraw(wire_base + sss.image_offset, PAL_NONE, ti->x, ti->y, z, sss, IsTransparencySet(TO_CATENARY));
489 }
490}
491
500{
502 TileIndex start = GetOtherBridgeEnd(end);
503
504 uint length = GetTunnelBridgeLength(start, end);
505 uint num = GetTunnelBridgeLength(ti->tile, start) + 1;
506
507 Axis axis = GetBridgeAxis(ti->tile);
509
510 RailCatenarySprite offset = (RailCatenarySprite)(axis == AXIS_X ? 0 : WIRE_Y_FLAT_BOTH - WIRE_X_FLAT_BOTH);
511
512 const SortableSpriteStruct *sss;
513 if ((length % 2) && num == length) {
514 /* Draw the "short" wire on the southern end of the bridge
515 * only needed if the length of the bridge is odd */
516 sss = &_rail_catenary_sprite_data[WIRE_X_FLAT_BOTH + offset];
517 } else {
518 /* Draw "long" wires on all other tiles of the bridge (one pylon every two tiles) */
519 sss = &_rail_catenary_sprite_data[WIRE_X_FLAT_SW + (num % 2) + offset];
520 }
521
522 uint height = GetBridgePixelHeight(end);
523
524 SpriteID wire_base = GetWireBase(end, TCX_ON_BRIDGE);
525
526 AddSortableSpriteToDraw(wire_base + sss->image_offset, PAL_NONE, ti->x, ti->y, height, *sss, IsTransparencySet(TO_CATENARY));
527
528 SpriteID pylon_base = GetPylonBase(end, TCX_ON_BRIDGE);
529
530 static constexpr SpriteBounds pylon_bounds{{-1, -1, 0}, {1, 1, BB_HEIGHT_UNDER_BRIDGE}, {1, 1, 0}};
531
532 /* Finished with wires, draw pylons
533 * every other tile needs a pylon on the northern end */
534 if (num % 2) {
535 DiagDirection pcp_pos = (axis == AXIS_X ? DIAGDIR_NE : DIAGDIR_NW);
536 Direction ppp_pos = (axis == AXIS_X ? DIR_NW : DIR_NE);
537 if (HasBit(tlg, (axis == AXIS_X ? 0 : 1))) ppp_pos = ReverseDir(ppp_pos);
538 uint x = ti->x + _x_pcp_offsets[pcp_pos] + _x_ppp_offsets[ppp_pos];
539 uint y = ti->y + _y_pcp_offsets[pcp_pos] + _y_ppp_offsets[ppp_pos];
540 AddSortableSpriteToDraw(pylon_base + _pylon_sprites[ppp_pos], PAL_NONE, x, y, height, pylon_bounds, IsTransparencySet(TO_CATENARY));
541 }
542
543 /* need a pylon on the southern end of the bridge */
544 if (GetTunnelBridgeLength(ti->tile, start) + 1 == length) {
545 DiagDirection pcp_pos = (axis == AXIS_X ? DIAGDIR_SW : DIAGDIR_SE);
546 Direction ppp_pos = (axis == AXIS_X ? DIR_NW : DIR_NE);
547 if (HasBit(tlg, (axis == AXIS_X ? 0 : 1))) ppp_pos = ReverseDir(ppp_pos);
548 uint x = ti->x + _x_pcp_offsets[pcp_pos] + _x_ppp_offsets[ppp_pos];
549 uint y = ti->y + _y_pcp_offsets[pcp_pos] + _y_ppp_offsets[ppp_pos];
550 AddSortableSpriteToDraw(pylon_base + _pylon_sprites[ppp_pos], PAL_NONE, x, y, height, pylon_bounds, IsTransparencySet(TO_CATENARY));
551 }
552}
553
560{
561 switch (GetTileType(ti->tile)) {
563 if (IsRailDepot(ti->tile)) {
564 const SortableSpriteStruct &sss = _rail_catenary_sprite_data_depot[GetRailDepotDirection(ti->tile)];
565
566 SpriteID wire_base = GetWireBase(ti->tile);
567
568 /* This wire is not visible with the default depot sprites */
569 AddSortableSpriteToDraw(wire_base + sss.image_offset, PAL_NONE, ti->x, ti->y, GetTileMaxPixelZ(ti->tile), sss, IsTransparencySet(TO_CATENARY));
570 return;
571 }
572 break;
573
575 case TileType::Road:
577 break;
578
579 default: return;
580 }
582}
583
585void SettingsDisableElrail(int32_t new_value)
586{
587 bool disable = (new_value != 0);
588 UpdateDisableElrailSettingState(disable, true);
589}
590
591void UpdateDisableElrailSettingState(bool disable, bool update_vehicles)
592{
593 /* walk through all train engines */
595 RailVehicleInfo *rv_info = &e->VehInfo<RailVehicleInfo>();
596 /* update railtype of engines intended to use elrail */
598 rv_info->railtypes.Set(RAILTYPE_ELECTRIC, !disable);
599 rv_info->railtypes.Set(RAILTYPE_RAIL, disable || rv_info->intended_railtypes.Test(RAILTYPE_RAIL));
600 }
601 }
602
603 /* when disabling elrails, make sure that all existing trains can run on
604 * normal rail too */
605 if (disable) {
606 for (Train *t : Train::Iterate()) {
607 if (t->railtypes.Test(RAILTYPE_ELECTRIC)) {
608 /* this railroad vehicle is now compatible only with elrail,
609 * so add there also normal rail compatibility */
610 t->compatible_railtypes.Set(RAILTYPE_RAIL);
611 t->railtypes.Reset(RAILTYPE_ELECTRIC);
612 t->railtypes.Set(RAILTYPE_RAIL);
614 }
615 }
616 }
617
618 /* Fix the total power and acceleration for trains */
619 if (update_vehicles) {
620 for (Train *t : Train::Iterate()) {
621 /* power and acceleration is cached only for front engines */
622 if (t->IsFrontEngine()) {
623 t->ConsistChanged(CCF_TRACK);
624 }
625 }
626 }
627
628 for (Company *c : Company::Iterate()) c->avail_railtypes = GetCompanyRailTypes(c->index);
629
630 /* This resets the _last_built_railtype, which will be invalid for electric
631 * rails. It may have unintended consequences if that function is ever
632 * extended, though. */
634}
static constexpr uint GB(const T x, const uint8_t s, const uint8_t n)
Fetch n bits from x, started at bit s.
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
constexpr bool HasAtMostOneBit(T value)
Test whether value has at most 1 bit set.
Foundation GetBridgeFoundation(Slope tileh, Axis axis)
Get the foundation for a bridge.
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.
bool IsBridgeTile(Tile t)
checks if there is a bridge on this tile
Definition bridge_map.h:35
int GetBridgePixelHeight(TileIndex tile)
Get the height ('z') of a bridge in pixels.
Definition bridge_map.h:84
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
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.
static Pool::IterateWrapperFiltered< Engine, EngineTypeFilter > IterateType(VehicleType vt, size_t from=0)
Returns an iterable ensemble of all valid engines of the given type.
This struct contains all the info that is needed to draw and construct tracks.
Definition rail.h:115
Definition of stuff that is very close to a company, like the company struct itself.
DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
Direction ReverseDir(Direction d)
Return the reverse of a direction.
Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
Direction
Defines the 8 directions on the map.
@ DIR_BEGIN
Used to iterate.
@ DIR_NW
Northwest.
@ DIR_NE
Northeast.
@ DIR_END
Used to iterate.
Axis
Allow incrementing of DiagDirDiff variables.
@ AXIS_X
The X 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.
@ DIAGDIR_BEGIN
Used for iterations.
@ DIAGDIR_SW
Southwest.
static constexpr Directions DIRECTIONS_ALL
All possible directions.
static SpriteID GetPylonBase(TileIndex tile, TileContext context=TCX_NORMAL)
Get the base pylon sprite to use.
Definition elrail.cpp:196
void SettingsDisableElrail(int32_t new_value)
Callback for changes to the electrified rails setting.
Definition elrail.cpp:585
void DrawRailCatenaryOnBridge(const TileInfo *ti)
Draws wires on a tunnel tile.
Definition elrail.cpp:499
static SpriteID GetWireBase(TileIndex tile, TileContext context=TCX_NORMAL)
Get the base wire sprite to use.
Definition elrail.cpp:183
static TileLocationGroup GetTileLocationGroup(TileIndex t)
Get the tile location group of a tile.
Definition elrail.cpp:75
void DrawRailCatenaryOnTunnel(const TileInfo *ti)
Draws wires on a tunnel tile.
Definition elrail.cpp:258
static TrackBits MaskWireBits(TileIndex t, TrackBits tracks)
Masks out track bits when neighbouring tiles are unelectrified.
Definition elrail.cpp:128
void DrawRailCatenary(const TileInfo *ti)
Draws overhead wires and pylons for electric railways.
Definition elrail.cpp:559
static void AdjustTileh(TileIndex tile, Slope *tileh)
Corrects the tileh for certain tile types.
Definition elrail.cpp:208
static void DrawRailCatenaryRailway(const TileInfo *ti)
Draws wires and, if required, pylons on a given tile.
Definition elrail.cpp:272
static int GetPCPElevation(TileIndex tile, DiagDirection pcp_pos)
Returns the Z position of a Pylon Control Point.
Definition elrail.cpp:228
static TrackBits GetRailTrackBitsUniversal(TileIndex t, DiagDirections *override)
Finds which Electrified Rail Bits are present on a given tile.
Definition elrail.cpp:86
Stores all the data for overhead wire and pylon drawing.
RailCatenarySprite
Refers to a certain element of the catenary.
static const Directions _owned_ppp_on_pcp[DIAGDIR_END]
Which of the PPPs are inside the tile.
Definition elrail_data.h:55
static const Directions _disallowed_ppp_of_track_at_pcp[TRACK_END][DIAGDIR_END]
Which pylons can definitely NOT be built.
static const DiagDirection _pcp_positions[TRACK_END][2]
Maps a track bit onto two PCP positions.
Definition elrail_data.h:63
static const Directions _ignored_pcp[NUM_IGNORE_GROUPS][TLG_END][DIAGDIR_END]
In case we have a straight line, we place pylon only every two tiles, so there are certain tiles whic...
static const Directions _preferred_ppp_of_track_at_pcp[TRACK_END][DIAGDIR_END]
Preferred points of each trackbit.
Definition elrail_data.h:78
static const Directions _allowed_ppp_on_pcp[DIAGDIR_END]
Which PPPs are possible at all on a given PCP.
Definition elrail_data.h:43
TileLocationGroup
Tile Location group.
Definition elrail_data.h:20
Header file for electrified rail specific functions.
bool HasRailCatenary(RailType rt)
Test if a rail type has catenary.
Definition elrail_func.h:22
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition gfx_type.h:17
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
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.
TileIndex TileAddByDiagDir(TileIndex tile, DiagDirection dir)
Adds a DiagDir to a tile.
Definition map_func.h:616
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition map_func.h:430
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition map_func.h:420
TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition map_func.h:575
TileContext
Context for tile accesses.
@ TCX_UPPER_HALFTILE
Querying information about the upper part of a tile with halftile foundation.
@ 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.
RailTypes GetCompanyRailTypes(CompanyID company, bool introduces)
Get the rail types the given company can build.
Definition rail.cpp:135
RailType GetTileRailType(Tile tile)
Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
Definition rail.cpp:37
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition rail.h:300
@ RTSG_PYLONS
Catenary pylons.
Definition rail.h:46
@ RTSG_WIRES
Catenary wires.
Definition rail.h:45
Foundation GetRailFoundation(Slope tileh, TrackBits bits)
Checks if a track combination is valid on a specific slope and returns the needed foundation.
Definition rail_cmd.cpp:309
void ReinitGuiAfterToggleElrail(bool disable)
Re-initialize rail-build toolbar after toggling support for electric trains.
Functions/types etc.
static RailTileType GetRailTileType(Tile t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition rail_map.h:36
RailType GetRailType(Tile t)
Gets the rail type of the given tile.
Definition rail_map.h:115
static bool IsRailDepot(Tile t)
Is this rail tile a rail depot?
Definition rail_map.h:95
TrackBits GetTrackBits(Tile tile)
Gets the track bits of the given tile.
Definition rail_map.h:136
static bool IsPlainRailTile(Tile t)
Checks whether the tile is a rail tile or rail tile with signals.
Definition rail_map.h:60
@ Normal
Normal rail tile without signals.
Definition rail_map.h:24
@ Signals
Normal rail tile with signals.
Definition rail_map.h:25
DiagDirection GetRailDepotDirection(Tile t)
Returns the direction the depot is facing to.
Definition rail_map.h:171
RailType
Enumeration for all possible railtypes.
Definition rail_type.h:25
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition rail_type.h:32
@ RAILTYPE_ELECTRIC
Electric rails.
Definition rail_type.h:28
@ RAILTYPE_RAIL
Standard non-electric rails.
Definition rail_type.h:27
TrackBits GetCrossingRailBits(Tile tile)
Get the rail track bits of a level crossing.
Definition road_map.h:378
bool IsLevelCrossing(Tile t)
Return whether a tile is a level crossing.
Definition road_map.h:69
A number of safeguards to prevent using unsafe methods.
static constexpr Corner GetHalftileSlopeCorner(Slope s)
Returns the leveled halftile of a halftile slope.
Definition slope_func.h:148
static constexpr bool IsSteepSlope(Slope s)
Checks if a slope is steep.
Definition slope_func.h:36
static constexpr bool IsHalftileSlope(Slope s)
Checks for non-continuous slope on halftile foundations.
Definition slope_func.h:47
Slope InclinedSlope(DiagDirection dir)
Returns the slope that is inclined in a specific direction.
Definition slope_func.h:256
Corner
Enumeration of tile corners.
Definition slope_type.h:21
Slope
Enumeration for the slope-type.
Definition slope_type.h:47
@ SLOPE_FLAT
a flat tile
Definition slope_type.h:48
@ SLOPE_STEEP
indicates the slope is steep
Definition slope_type.h:53
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
Maps accessors for stations.
bool IsRailStationTile(Tile t)
Is this tile a station tile and a rail station?
Track GetRailStationTrack(Tile t)
Get the rail track of a rail station tile.
bool HasStationTileRail(Tile t)
Has this station tile a rail?
bool CanStationTileHaveWires(Tile t)
Can tile t have catenary wires?
Axis GetRailStationAxis(Tile t)
Get the rail direction of a rail station.
bool HasStationRail(Tile t)
Has this station tile a rail?
bool CanStationTileHavePylons(Tile t)
Can tile t have catenary pylons?
Definition of base types and functions in a cross-platform compatible way.
T x
X coordinate.
T y
Y coordinate.
static Pool::IterateWrapper< Vehicle > Iterate(size_t from=0)
Information about a rail vehicle.
Definition engine_type.h:74
RailTypes railtypes
Railtypes, mangled if elrail is disabled.
Definition engine_type.h:78
RailTypes intended_railtypes
Intended railtypes, regardless of elrail being enabled or disabled.
Definition engine_type.h:79
Coord3D< int8_t > origin
Position of northern corner within tile.
Definition sprite.h:19
Tile information, used while rendering the tile.
Definition tile_cmd.h:32
Slope tileh
Slope of the tile.
Definition tile_cmd.h:33
TileIndex tile
Tile index.
Definition tile_cmd.h:34
'Train' is either a loco or a wagon.
Definition train.h:91
int GetTileMaxZ(TileIndex t)
Get top height of the tile inside the map.
Definition tile_map.cpp:135
static bool IsTileType(Tile tile, TileType type)
Checks if a tile is a given tiletype.
Definition tile_map.h:150
int GetTilePixelZ(TileIndex tile)
Get bottom height of the tile.
Definition tile_map.h:302
int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
Definition tile_map.h:312
Slope GetTileSlope(TileIndex tile)
Return the slope of a given tile inside the map.
Definition tile_map.h:279
static TileType GetTileType(Tile tile)
Get the tiletype of a given tile.
Definition tile_map.h:96
StrongType::Typedef< uint32_t, struct TileIndexTag, StrongType::Compare, StrongType::Integer, StrongType::Compatible< int32_t >, StrongType::Compatible< int64_t > > TileIndex
The index/ID of a Tile.
Definition tile_type.h:92
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
@ TunnelBridge
Tunnel entry/exit and bridge heads.
Definition tile_type.h:58
@ Station
A tile of a station or airport.
Definition tile_type.h:54
@ Railway
A tile with railway.
Definition tile_type.h:50
@ Road
A tile with road and/or tram tracks.
Definition tile_type.h:51
TrackBits TrackToTrackBits(Track track)
Maps a Track to the corresponding TrackBits value.
Definition track_func.h:77
bool TracksOverlap(TrackBits bits)
Checks if the given tracks overlap, ie form a crossing.
Definition track_func.h:645
TrackdirBits DiagdirReachesTrackdirs(DiagDirection diagdir)
Returns all trackdirs that can be reached when entering a tile from a given (diagonal) direction.
Definition track_func.h:555
TrackBits DiagdirReachesTracks(DiagDirection diagdir)
Returns all tracks that can be reached when entering a tile from a given (diagonal) direction.
Definition track_func.h:573
TrackBits DiagDirToDiagTrackBits(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track bits incidating with that diagdir.
Definition track_func.h:524
TrackBits TrackStatusToTrackBits(TrackStatus ts)
Returns the present-track-information of a TrackStatus.
Definition track_func.h:363
TrackBits TrackdirBitsToTrackBits(TrackdirBits bits)
Discards all directional information from a TrackdirBits value.
Definition track_func.h:308
TrackBits
Allow incrementing of Track variables.
Definition track_type.h:35
@ TRACK_BIT_Y
Y-axis track.
Definition track_type.h:38
@ TRACK_BIT_CROSS
X-Y-axis cross.
Definition track_type.h:43
@ TRACK_BIT_HORZ
Upper and lower track.
Definition track_type.h:44
@ TRACK_BIT_NONE
No track.
Definition track_type.h:36
@ TRACK_BIT_X
X-axis track.
Definition track_type.h:37
@ TRACK_BIT_MASK
Bitmask for the first 6 bits.
Definition track_type.h:51
@ TRACK_BIT_VERT
Left and right track.
Definition track_type.h:45
TrackdirBits
Allow incrementing of Trackdir variables.
Definition track_type.h:97
@ TRACKDIR_BIT_Y_NW
Track y-axis, direction north-west.
Definition track_type.h:107
@ TRACKDIR_BIT_X_NE
Track x-axis, direction north-east.
Definition track_type.h:99
@ TRACKDIR_BIT_Y_SE
Track y-axis, direction south-east.
Definition track_type.h:100
@ TRACKDIR_BIT_NONE
No track build.
Definition track_type.h:98
@ TRACKDIR_BIT_X_SW
Track x-axis, direction south-west.
Definition track_type.h:106
Track
These are used to specify a single track.
Definition track_type.h:19
@ INVALID_TRACK
Flag for an invalid track.
Definition track_type.h:28
@ TRACK_Y
Track along the y-axis (north-west to south-east).
Definition track_type.h:22
@ TRACK_LOWER
Track in the lower corner of the tile (south).
Definition track_type.h:24
@ TRACK_LEFT
Track in the left corner of the tile (west).
Definition track_type.h:25
@ TRACK_RIGHT
Track in the right corner of the tile (east).
Definition track_type.h:26
@ TRACK_X
Track along the x-axis (north-east to south-west).
Definition track_type.h:21
@ TRACK_UPPER
Track in the upper corner of the tile (north).
Definition track_type.h:23
Base for the train class.
static constexpr ConsistChangeFlags CCF_TRACK
Valid changes while vehicle is driving, and possibly changing tracks.
Definition train.h:52
@ AllowedOnNormalRail
Electric train engine is allowed to run on normal rail. *‍/.
Definition train.h:30
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...
@ TO_BRIDGES
bridges
@ TO_CATENARY
catenary
@ TRANSPORT_RAIL
Transport by train.
bool IsTunnelTile(Tile t)
Is this a tunnel (entrance)?
Definition tunnel_map.h:34
bool IsTunnel(Tile t)
Is this a tunnel (entrance)?
Definition tunnel_map.h:23
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).
Functions that have tunnels and bridges in common.
DiagDirection GetTunnelBridgeDirection(Tile t)
Get the direction pointing to the other end.
TransportType GetTunnelBridgeTransportType(Tile t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
@ VEH_TRAIN
Train vehicle type.
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:658
Functions related to (drawing on) viewports.
static constexpr int BB_HEIGHT_UNDER_BRIDGE
Some values for constructing bounding boxes (BB).