OpenTTD
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 <http://www.gnu.org/licenses/>.
6  */
7 
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 
75 static inline TLG GetTLG(TileIndex t)
76 {
77  return (TLG)((HasBit(TileX(t), 0) << 1) + HasBit(TileY(t), 0));
78 }
79 
87 {
88  switch (GetTileType(t)) {
89  case MP_RAILWAY:
91  switch (GetRailTileType(t)) {
93  return GetTrackBits(t);
94  default:
95  return TRACK_BIT_NONE;
96  }
97  break;
98 
99  case MP_TUNNELBRIDGE:
101  if (!HasRailCatenary(GetRailType(t))) return TRACK_BIT_NONE;
102  if (override != nullptr && (IsTunnel(t) || GetTunnelBridgeLength(t, GetOtherBridgeEnd(t)) > 0)) {
103  *override = 1 << GetTunnelBridgeDirection(t);
104  }
106 
107  case MP_ROAD:
108  if (!IsLevelCrossing(t)) return TRACK_BIT_NONE;
109  if (!HasRailCatenary(GetRailType(t))) return TRACK_BIT_NONE;
110  return GetCrossingRailBits(t);
111 
112  case MP_STATION:
113  if (!HasStationRail(t)) return TRACK_BIT_NONE;
114  if (!HasRailCatenary(GetRailType(t))) return TRACK_BIT_NONE;
116 
117  default:
118  return TRACK_BIT_NONE;
119  }
120 }
121 
126 {
127  if (!IsPlainRailTile(t)) return tracks;
128 
129  TrackdirBits neighbour_tdb = TRACKDIR_BIT_NONE;
130  for (DiagDirection d = DIAGDIR_BEGIN; d < DIAGDIR_END; d++) {
131  /* If the neighbour tile is either not electrified or has no tracks that can be reached
132  * from this tile, mark all trackdirs that can be reached from the neighbour tile
133  * as needing no catenary. We make an exception for blocked station tiles with a matching
134  * axis that still display wires to preserve visual continuity. */
135  TileIndex next_tile = TileAddByDiagDir(t, d);
136  RailType rt = GetTileRailType(next_tile);
137  if (rt == INVALID_RAILTYPE || !HasRailCatenary(rt) ||
139  (!HasStationTileRail(next_tile) || GetRailStationAxis(next_tile) != DiagDirToAxis(d) || !CanStationTileHaveWires(next_tile)))) {
140  neighbour_tdb |= DiagdirReachesTrackdirs(ReverseDiagDir(d));
141  }
142  }
143 
144  /* If the tracks from either a diagonal crossing or don't overlap, both
145  * trackdirs have to be marked to mask the corresponding track bit. Else
146  * one marked trackdir is enough the mask the track bit. */
147  TrackBits mask;
148  if (tracks == TRACK_BIT_CROSS || !TracksOverlap(tracks)) {
149  /* If the tracks form either a diagonal crossing or don't overlap, both
150  * trackdirs have to be marked to mask the corresponding track bit. */
151  mask = ~(TrackBits)((neighbour_tdb & (neighbour_tdb >> 8)) & TRACK_BIT_MASK);
152  /* If that results in no masked tracks and it is not a diagonal crossing,
153  * require only one marked trackdir to mask. */
154  if (tracks != TRACK_BIT_CROSS && (mask & TRACK_BIT_MASK) == TRACK_BIT_MASK) mask = ~TrackdirBitsToTrackBits(neighbour_tdb);
155  } else {
156  /* Require only one marked trackdir to mask the track. */
157  mask = ~TrackdirBitsToTrackBits(neighbour_tdb);
158  /* If that results in an empty set, require both trackdirs for diagonal track. */
159  if ((tracks & mask) == TRACK_BIT_NONE) {
160  if ((neighbour_tdb & TRACKDIR_BIT_X_NE) == 0 || (neighbour_tdb & TRACKDIR_BIT_X_SW) == 0) mask |= TRACK_BIT_X;
161  if ((neighbour_tdb & TRACKDIR_BIT_Y_NW) == 0 || (neighbour_tdb & TRACKDIR_BIT_Y_SE) == 0) mask |= TRACK_BIT_Y;
162  /* If that still is not enough, require both trackdirs for any track. */
163  if ((tracks & mask) == TRACK_BIT_NONE) mask = ~(TrackBits)((neighbour_tdb & (neighbour_tdb >> 8)) & TRACK_BIT_MASK);
164  }
165  }
166 
167  /* Mask the tracks only if at least one track bit would remain. */
168  return (tracks & mask) != TRACK_BIT_NONE ? tracks & mask : tracks;
169 }
170 
174 static inline SpriteID GetWireBase(TileIndex tile, TileContext context = TCX_NORMAL)
175 {
176  const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
177  SpriteID wires = GetCustomRailSprite(rti, tile, RTSG_WIRES, context);
178  return wires == 0 ? SPR_WIRE_BASE : wires;
179 }
180 
184 static inline SpriteID GetPylonBase(TileIndex tile, TileContext context = TCX_NORMAL)
185 {
186  const RailtypeInfo *rti = GetRailTypeInfo(GetRailType(tile));
187  SpriteID pylons = GetCustomRailSprite(rti, tile, RTSG_PYLONS, context);
188  return pylons == 0 ? SPR_PYLON_BASE : pylons;
189 }
190 
196 static void AdjustTileh(TileIndex tile, Slope *tileh)
197 {
198  if (IsTileType(tile, MP_TUNNELBRIDGE)) {
199  if (IsTunnel(tile)) {
200  *tileh = SLOPE_STEEP; // XXX - Hack to make tunnel entrances to always have a pylon
201  } else if (*tileh != SLOPE_FLAT) {
202  *tileh = SLOPE_FLAT;
203  } else {
204  *tileh = InclinedSlope(GetTunnelBridgeDirection(tile));
205  }
206  }
207 }
208 
216 static int GetPCPElevation(TileIndex tile, DiagDirection PCPpos)
217 {
218  /* The elevation of the "pylon"-sprite should be the elevation at the PCP.
219  * PCPs are always on a tile edge.
220  *
221  * This position can be outside of the tile, i.e. ?_pcp_offset == TILE_SIZE > TILE_SIZE - 1.
222  * So we have to move it inside the tile, because if the neighboured tile has a foundation,
223  * that does not smoothly connect to the current tile, we will get a wrong elevation from GetSlopePixelZ().
224  *
225  * When we move the position inside the tile, we will get a wrong elevation if we have a slope.
226  * To catch all cases we round the Z position to the next (TILE_HEIGHT / 2).
227  * This will return the correct elevation for slopes and will also detect non-continuous elevation on edges.
228  *
229  * Also note that the result of GetSlopePixelZ() is very special on bridge-ramps.
230  */
231 
232  int z = GetSlopePixelZ(TileX(tile) * TILE_SIZE + min(x_pcp_offsets[PCPpos], TILE_SIZE - 1), TileY(tile) * TILE_SIZE + min(y_pcp_offsets[PCPpos], TILE_SIZE - 1));
233  return (z + 2) & ~3; // this means z = (z + TILE_HEIGHT / 4) / (TILE_HEIGHT / 2) * (TILE_HEIGHT / 2);
234 }
235 
244 {
245  /* xmin, ymin, xmax + 1, ymax + 1 of BB */
246  static const int _tunnel_wire_BB[4][4] = {
247  { 0, 1, 16, 15 }, // NE
248  { 1, 0, 15, 16 }, // SE
249  { 0, 1, 16, 15 }, // SW
250  { 1, 0, 15, 16 }, // NW
251  };
252 
254 
255  SpriteID wire_base = GetWireBase(ti->tile);
256 
257  const SortableSpriteStruct *sss = &RailCatenarySpriteData_Tunnel[dir];
258  const int *BB_data = _tunnel_wire_BB[dir];
260  wire_base + sss->image_offset, PAL_NONE, ti->x + sss->x_offset, ti->y + sss->y_offset,
261  BB_data[2] - sss->x_offset, BB_data[3] - sss->y_offset, BB_Z_SEPARATOR - sss->z_offset + 1,
262  GetTilePixelZ(ti->tile) + sss->z_offset,
264  BB_data[0] - sss->x_offset, BB_data[1] - sss->y_offset, BB_Z_SEPARATOR - sss->z_offset
265  );
266 }
267 
272 static 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 trackconfig[TS_END];
278  TrackBits wireconfig[TS_END];
279  bool isflat[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 
291  TLG tlg = GetTLG(ti->tile);
292  byte PCPstatus = 0;
293  byte OverridePCP = 0;
294  byte PPPpreferred[DIAGDIR_END];
295  byte PPPallowed[DIAGDIR_END];
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  trackconfig[TS_HOME] = GetRailTrackBitsUniversal(ti->tile, &OverridePCP);
304  wireconfig[TS_HOME] = MaskWireBits(ti->tile, trackconfig[TS_HOME]);
305  /* If a track bit is present that is not in the main direction, the track is level */
306  isflat[TS_HOME] = ((trackconfig[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  trackconfig[TS_NEIGHBOUR] = GetRailTrackBitsUniversal(neighbour, nullptr);
328  wireconfig[TS_NEIGHBOUR] = MaskWireBits(neighbour, trackconfig[TS_NEIGHBOUR]);
329  if (IsTunnelTile(neighbour) && i != GetTunnelBridgeDirection(neighbour)) wireconfig[TS_NEIGHBOUR] = trackconfig[TS_NEIGHBOUR] = TRACK_BIT_NONE;
330 
331  /* Ignore station tiles that allow neither wires nor pylons. */
332  if (IsRailStationTile(neighbour) && !CanStationTileHavePylons(neighbour) && !CanStationTileHaveWires(neighbour)) wireconfig[TS_NEIGHBOUR] = trackconfig[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))) wireconfig[TS_NEIGHBOUR] = trackconfig[TS_NEIGHBOUR] = TRACK_BIT_NONE;
337 
338  isflat[TS_NEIGHBOUR] = ((trackconfig[TS_NEIGHBOUR] & (TRACK_BIT_HORZ | TRACK_BIT_VERT)) != 0);
339 
340  PPPpreferred[i] = 0xFF; // We start with preferring everything (end-of-line in any direction)
341  PPPallowed[i] = AllowedPPPonPCP[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 (TrackSourceTile[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 PCPpos = i;
356  if (HasBit(wireconfig[TrackSourceTile[i][k]], TracksAtPCP[i][k])) {
357  /* track found, if track is in the neighbour tile, adjust the number
358  * of the PCP for preferred/allowed determination*/
359  PCPpos = (TrackSourceTile[i][k] == TS_HOME) ? i : ReverseDiagDir(i);
360  SetBit(PCPstatus, i); // This PCP is in use
361  PPPpreferred[i] &= PreferredPPPofTrackAtPCP[TracksAtPCP[i][k]][PCPpos];
362  }
363 
364  if (HasBit(trackconfig[TrackSourceTile[i][k]], TracksAtPCP[i][k])) {
365  PPPallowed[i] &= ~DisallowedPPPofTrackAtPCP[TracksAtPCP[i][k]][PCPpos];
366  }
367  }
368 
369  /* Deactivate all PPPs if PCP is not used */
370  if (!HasBit(PCPstatus, i)) {
371  PPPpreferred[i] = 0;
372  PPPallowed[i] = 0;
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, MP_STATION) || IsTileType(neighbour, MP_ROAD)) tileh[TS_NEIGHBOUR] = SLOPE_FLAT;
379 
380  /* Read the foundations if they are present, and adjust the tileh */
381  if (trackconfig[TS_NEIGHBOUR] != TRACK_BIT_NONE && IsTileType(neighbour, MP_RAILWAY) && HasRailCatenary(GetRailType(neighbour))) foundation = GetRailFoundation(tileh[TS_NEIGHBOUR], trackconfig[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] || (isflat[TS_HOME] && isflat[TS_NEIGHBOUR])) {
398  for (uint k = 0; k < NUM_IGNORE_GROUPS; k++) {
399  if (PPPpreferred[i] == IgnoredPCP[k][tlg][i]) ClrBit(PCPstatus, 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 ((PPPallowed[i] & PPPpreferred[i]) != 0) PPPallowed[i] &= PPPpreferred[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 == PCPpositions[bridgetrack][0] || i == PCPpositions[bridgetrack][1])) {
415  SetBit(OverridePCP, i);
416  }
417  }
418 
419  if (PPPallowed[i] != 0 && HasBit(PCPstatus, i) && !HasBit(OverridePCP, i) &&
421  for (Direction k = DIR_BEGIN; k < DIR_END; k++) {
422  byte temp = PPPorder[i][GetTLG(ti->tile)][k];
423 
424  if (HasBit(PPPallowed[i], temp)) {
425  uint x = ti->x + x_pcp_offsets[i] + x_ppp_offsets[temp];
426  uint y = ti->y + y_pcp_offsets[i] + y_ppp_offsets[temp];
427 
428  /* Don't build the pylon if it would be outside the tile */
429  if (!HasBit(OwnedPPPonPCP[i], temp)) {
430  /* We have a neighbour that will draw it, bail out */
431  if (trackconfig[TS_NEIGHBOUR] != TRACK_BIT_NONE) break;
432  continue; // No neighbour, go looking for a better position
433  }
434 
435  AddSortableSpriteToDraw(pylon_base + pylon_sprites[temp], PAL_NONE, x, y, 1, 1, BB_HEIGHT_UNDER_BRIDGE,
436  elevation, IsTransparencySet(TO_CATENARY), -1, -1);
437 
438  break; // We already have drawn a pylon, bail out
439  }
440  }
441  }
442  }
443 
444  /* The wire above the tunnel is drawn together with the tunnel-roof (see DrawRailCatenaryOnTunnel()) */
445  if (IsTunnelTile(ti->tile)) return;
446 
447  /* Don't draw a wire under a low bridge */
449  int height = GetBridgeHeight(GetNorthernBridgeEnd(ti->tile));
450 
451  if (height <= GetTileMaxZ(ti->tile) + 1) return;
452  }
453 
454  /* Don't draw a wire if the station tile does not want any */
455  if (IsRailStationTile(ti->tile) && !CanStationTileHaveWires(ti->tile)) return;
456 
457  SpriteID wire_normal = GetWireBase(ti->tile);
458  SpriteID wire_halftile = (halftile_corner != CORNER_INVALID) ? GetWireBase(ti->tile, TCX_UPPER_HALFTILE) : wire_normal;
459  Track halftile_track;
460  switch (halftile_corner) {
461  case CORNER_W: halftile_track = TRACK_LEFT; break;
462  case CORNER_S: halftile_track = TRACK_LOWER; break;
463  case CORNER_E: halftile_track = TRACK_RIGHT; break;
464  case CORNER_N: halftile_track = TRACK_UPPER; break;
465  default: halftile_track = INVALID_TRACK; break;
466  }
467 
468  /* Drawing of pylons is finished, now draw the wires */
469  Track t;
470  FOR_EACH_SET_TRACK(t, wireconfig[TS_HOME]) {
471  SpriteID wire_base = (t == halftile_track) ? wire_halftile : wire_normal;
472  byte PCPconfig = HasBit(PCPstatus, PCPpositions[t][0]) +
473  (HasBit(PCPstatus, PCPpositions[t][1]) << 1);
474 
475  const SortableSpriteStruct *sss;
476  int tileh_selector = !(tileh[TS_HOME] % 3) * tileh[TS_HOME] / 3; // tileh for the slopes, 0 otherwise
477 
478  assert(PCPconfig != 0); // We have a pylon on neither end of the wire, that doesn't work (since we have no sprites for that)
479  assert(!IsSteepSlope(tileh[TS_HOME]));
480  sss = &RailCatenarySpriteData[Wires[tileh_selector][t][PCPconfig]];
481 
482  /*
483  * The "wire"-sprite position is inside the tile, i.e. 0 <= sss->?_offset < TILE_SIZE.
484  * Therefore it is safe to use GetSlopePixelZ() for the elevation.
485  * Also note that the result of GetSlopePixelZ() is very special for bridge-ramps.
486  */
487  AddSortableSpriteToDraw(wire_base + sss->image_offset, PAL_NONE, ti->x + sss->x_offset, ti->y + sss->y_offset,
488  sss->x_size, sss->y_size, sss->z_size, GetSlopePixelZ(ti->x + sss->x_offset, ti->y + sss->y_offset) + sss->z_offset,
490  }
491 }
492 
501 {
503  TileIndex start = GetOtherBridgeEnd(end);
504 
505  uint length = GetTunnelBridgeLength(start, end);
506  uint num = GetTunnelBridgeLength(ti->tile, start) + 1;
507  uint height;
508 
509  const SortableSpriteStruct *sss;
510  Axis axis = GetBridgeAxis(ti->tile);
511  TLG tlg = GetTLG(ti->tile);
512 
513  RailCatenarySprite offset = (RailCatenarySprite)(axis == AXIS_X ? 0 : WIRE_Y_FLAT_BOTH - WIRE_X_FLAT_BOTH);
514 
515  if ((length % 2) && num == length) {
516  /* Draw the "short" wire on the southern end of the bridge
517  * only needed if the length of the bridge is odd */
518  sss = &RailCatenarySpriteData[WIRE_X_FLAT_BOTH + offset];
519  } else {
520  /* Draw "long" wires on all other tiles of the bridge (one pylon every two tiles) */
521  sss = &RailCatenarySpriteData[WIRE_X_FLAT_SW + (num % 2) + offset];
522  }
523 
524  height = GetBridgePixelHeight(end);
525 
526  SpriteID wire_base = GetWireBase(end, TCX_ON_BRIDGE);
527 
528  AddSortableSpriteToDraw(wire_base + sss->image_offset, PAL_NONE, ti->x + sss->x_offset, ti->y + sss->y_offset,
529  sss->x_size, sss->y_size, sss->z_size, height + sss->z_offset,
531  );
532 
533  SpriteID pylon_base = GetPylonBase(end, TCX_ON_BRIDGE);
534 
535  /* Finished with wires, draw pylons
536  * every other tile needs a pylon on the northern end */
537  if (num % 2) {
538  DiagDirection PCPpos = (axis == AXIS_X ? DIAGDIR_NE : DIAGDIR_NW);
539  Direction PPPpos = (axis == AXIS_X ? DIR_NW : DIR_NE);
540  if (HasBit(tlg, (axis == AXIS_X ? 0 : 1))) PPPpos = ReverseDir(PPPpos);
541  uint x = ti->x + x_pcp_offsets[PCPpos] + x_ppp_offsets[PPPpos];
542  uint y = ti->y + y_pcp_offsets[PCPpos] + y_ppp_offsets[PPPpos];
543  AddSortableSpriteToDraw(pylon_base + pylon_sprites[PPPpos], PAL_NONE, x, y, 1, 1, BB_HEIGHT_UNDER_BRIDGE, height, IsTransparencySet(TO_CATENARY), -1, -1);
544  }
545 
546  /* need a pylon on the southern end of the bridge */
547  if (GetTunnelBridgeLength(ti->tile, start) + 1 == length) {
548  DiagDirection PCPpos = (axis == AXIS_X ? DIAGDIR_SW : DIAGDIR_SE);
549  Direction PPPpos = (axis == AXIS_X ? DIR_NW : DIR_NE);
550  if (HasBit(tlg, (axis == AXIS_X ? 0 : 1))) PPPpos = ReverseDir(PPPpos);
551  uint x = ti->x + x_pcp_offsets[PCPpos] + x_ppp_offsets[PPPpos];
552  uint y = ti->y + y_pcp_offsets[PCPpos] + y_ppp_offsets[PPPpos];
553  AddSortableSpriteToDraw(pylon_base + pylon_sprites[PPPpos], PAL_NONE, x, y, 1, 1, BB_HEIGHT_UNDER_BRIDGE, height, IsTransparencySet(TO_CATENARY), -1, -1);
554  }
555 }
556 
562 void DrawRailCatenary(const TileInfo *ti)
563 {
564  switch (GetTileType(ti->tile)) {
565  case MP_RAILWAY:
566  if (IsRailDepot(ti->tile)) {
567  const SortableSpriteStruct *sss = &RailCatenarySpriteData_Depot[GetRailDepotDirection(ti->tile)];
568 
569  SpriteID wire_base = GetWireBase(ti->tile);
570 
571  /* This wire is not visible with the default depot sprites */
573  wire_base + sss->image_offset, PAL_NONE, ti->x + sss->x_offset, ti->y + sss->y_offset,
574  sss->x_size, sss->y_size, sss->z_size,
575  GetTileMaxPixelZ(ti->tile) + sss->z_offset,
577  );
578  return;
579  }
580  break;
581 
582  case MP_TUNNELBRIDGE:
583  case MP_ROAD:
584  case MP_STATION:
585  break;
586 
587  default: return;
588  }
590 }
591 
592 bool SettingsDisableElrail(int32 p1)
593 {
594  bool disable = (p1 != 0);
595 
596  /* we will now walk through all electric train engines and change their railtypes if it is the wrong one*/
597  const RailType old_railtype = disable ? RAILTYPE_ELECTRIC : RAILTYPE_RAIL;
598  const RailType new_railtype = disable ? RAILTYPE_RAIL : RAILTYPE_ELECTRIC;
599 
600  /* walk through all train engines */
601  for (Engine *e : Engine::IterateType(VEH_TRAIN)) {
602  RailVehicleInfo *rv_info = &e->u.rail;
603  /* if it is an electric rail engine and its railtype is the wrong one */
604  if (rv_info->engclass == 2 && rv_info->railtype == old_railtype) {
605  /* change it to the proper one */
606  rv_info->railtype = new_railtype;
607  }
608  }
609 
610  /* when disabling elrails, make sure that all existing trains can run on
611  * normal rail too */
612  if (disable) {
613  for (Train *t : Train::Iterate()) {
614  if (t->railtype == RAILTYPE_ELECTRIC) {
615  /* this railroad vehicle is now compatible only with elrail,
616  * so add there also normal rail compatibility */
617  t->compatible_railtypes |= RAILTYPES_RAIL;
618  t->railtype = RAILTYPE_RAIL;
620  }
621  }
622  }
623 
624  /* Fix the total power and acceleration for trains */
625  for (Train *t : Train::Iterate()) {
626  /* power and acceleration is cached only for front engines */
627  if (t->IsFrontEngine()) {
628  t->ConsistChanged(CCF_TRACK);
629  }
630  }
631 
632  for (Company *c : Company::Iterate()) c->avail_railtypes = GetCompanyRailtypes(c->index);
633 
634  /* This resets the _last_built_railtype, which will be invalid for electric
635  * rails. It may have unintended consequences if that function is ever
636  * extended, though. */
638  return true;
639 }
TileIndex GetOtherBridgeEnd(TileIndex tile)
Starting at one bridge end finds the other bridge end.
Definition: bridge_map.cpp:59
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
Definition: tile_map.h:96
static bool IsHalftileSlope(Slope s)
Checks for non-continuous slope on halftile foundations.
Definition: slope_func.h:47
uint ApplyFoundationToSlope(Foundation f, Slope *s)
Applies a foundation to a slope.
Definition: landscape.cpp:162
Corner
Enumeration of tile corners.
Definition: slope_type.h:22
Definition of stuff that is very close to a company, like the company struct itself.
Used to iterate.
NewGRF handling of rail types.
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:304
TrackdirBits
Enumeration of bitmasks for the TrackDirs.
Definition: track_type.h:101
static TransportType GetTunnelBridgeTransportType(TileIndex t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
No track build.
Definition: track_type.h:102
Tile information, used while rendering the tile.
Definition: tile_cmd.h:42
Flag for an invalid track.
Definition: track_type.h:28
void DrawRailCatenaryOnBridge(const TileInfo *ti)
Draws wires on a tunnel tile.
Definition: elrail.cpp:500
Maps accessors for stations.
Track along the x-axis (north-east to south-west)
Definition: track_type.h:21
static const byte AllowedPPPonPCP[DIAGDIR_END]
Which PPPs are possible at all on a given PCP.
Definition: elrail_data.h:43
Track in the lower corner of the tile (south)
Definition: track_type.h:24
Train vehicle type.
Definition: vehicle_type.h:24
static int GetTilePixelZ(TileIndex tile)
Get bottom height of the tile.
Definition: tile_map.h:294
static bool IsBridgeTile(TileIndex t)
checks if there is a bridge on this tile
Definition: bridge_map.h:35
Northwest.
Bitmask for the first 6 bits.
Definition: track_type.h:54
Base for the train class.
static const byte DisallowedPPPofTrackAtPCP[TRACK_END][DIAGDIR_END]
Which pylons can definitely NOT be built.
Definition: elrail_data.h:197
Used for iterations.
static T SetBit(T &x, const uint8 y)
Set a bit in a variable.
bool CanStationTileHaveWires(TileIndex tile)
Check if a rail station tile shall have wires when electrified.
static TrackBits GetCrossingRailBits(TileIndex tile)
Get the rail track bits of a level crossing.
Definition: road_map.h:368
A tile with road (or tram tracks)
Definition: tile_type.h:43
Slope tileh
Slope of the tile.
Definition: tile_cmd.h:45
static const uint BB_Z_SEPARATOR
Separates the bridge/tunnel from the things under/above it.
Definition: viewport_type.h:93
Flag for invalid railtype.
Definition: rail_type.h:34
X-axis track.
Definition: track_type.h:40
static TrackBits DiagDirToDiagTrackBits(DiagDirection diagdir)
Maps a (4-way) direction to the diagonal track bits incidating with that diagdir. ...
Definition: track_func.h:532
static uint TileX(TileIndex tile)
Get the X component of a tile.
Definition: map_func.h:205
static TileIndex TileAddByDiagDir(TileIndex tile, DiagDirection dir)
Adds a DiagDir to a tile.
Definition: map_func.h:382
static SpriteID GetPylonBase(TileIndex tile, TileContext context=TCX_NORMAL)
Get the base pylon sprite to use.
Definition: elrail.cpp:184
static void DrawRailCatenaryRailway(const TileInfo *ti)
Draws wires and, if required, pylons on a given tile.
Definition: elrail.cpp:272
static const byte PreferredPPPofTrackAtPCP[TRACK_END][DIAGDIR_END]
Preferred points of each trackbit.
Definition: elrail_data.h:79
static bool IsSteepSlope(Slope s)
Checks if a slope is steep.
Definition: slope_func.h:36
int GetBridgeHeight(TileIndex t)
Get the height (&#39;z&#39;) of a bridge.
Definition: bridge_map.cpp:70
static Corner GetHalftileSlopeCorner(Slope s)
Returns the leveled halftile of a halftile slope.
Definition: slope_func.h:148
A railway.
Definition: tile_type.h:42
static Track GetRailStationTrack(TileIndex t)
Get the rail track of a rail station tile.
Definition: station_map.h:349
Nothing special.
static const byte OwnedPPPonPCP[DIAGDIR_END]
Which of the PPPs are inside the tile.
Definition: elrail_data.h:55
static TrackdirBits DiagdirReachesTrackdirs(DiagDirection diagdir)
Returns all trackdirs that can be reached when entering a tile from a given (diagonal) direction...
Definition: track_func.h:563
static bool IsLevelCrossing(TileIndex t)
Return whether a tile is a level crossing.
Definition: road_map.h:84
a flat tile
Definition: slope_type.h:49
static const uint TILE_SIZE
Tile size in world coordinates.
Definition: tile_type.h:13
Non-electrified rails.
Definition: rail_type.h:48
Functions/types etc.
Catenary pylons.
Definition: rail.h:52
TileIndex GetNorthernBridgeEnd(TileIndex t)
Finds the northern end of a bridge starting at a middle tile.
Definition: bridge_map.cpp:39
This struct contains all the info that is needed to draw and construct tracks.
Definition: rail.h:124
Functions related to (drawing on) viewports.
Normal rail tile with signals.
Definition: rail_map.h:25
Used to iterate.
X-Y-axis cross.
Definition: track_type.h:46
static bool HasStationRail(TileIndex t)
Has this station tile a rail? In other words, is this station tile a rail station or rail waypoint...
Definition: station_map.h:135
Slope GetTileSlope(TileIndex tile, int *h)
Return the slope of a given tile inside the map.
Definition: tile_map.cpp:59
Track in the right corner of the tile (east)
Definition: track_type.h:26
static bool IsBridgeAbove(TileIndex t)
checks if a bridge is set above the ground of this tile
Definition: bridge_map.h:45
Querying information about stuff on the bridge (via some bridgehead).
indicates the slope is steep
Definition: slope_type.h:54
SpriteID GetCustomRailSprite(const RailtypeInfo *rti, TileIndex tile, RailTypeSpriteGroup rtsg, TileContext context, uint *num_results)
Get the sprite to draw for the given tile.
uint x
X position of the tile in unit coordinates.
Definition: tile_cmd.h:43
Electric rails.
Definition: rail_type.h:30
static TileIndexDiff TileOffsByDiagDir(DiagDirection dir)
Convert a DiagDirection to a TileIndexDiff.
Definition: map_func.h:341
Querying information about the upper part of a tile with halftile foundation.
Foundation
Enumeration for Foundations.
Definition: slope_type.h:93
static bool IsTileType(TileIndex tile, TileType type)
Checks if a tile is a given tiletype.
Definition: tile_map.h:150
Southeast.
TileIndex tile
Tile index.
Definition: tile_cmd.h:46
static int GetPCPElevation(TileIndex tile, DiagDirection PCPpos)
Returns the Z position of a Pylon Control Point.
Definition: elrail.cpp:216
static bool IsRailStationTile(TileIndex t)
Is this tile a station tile and a rail station?
Definition: station_map.h:102
Header file for things common for tunnels and bridges.
void ReinitGuiAfterToggleElrail(bool disable)
Re-initialize rail-build toolbar after toggling support for electric trains.
Definition: rail_gui.cpp:1894
EngineClass engclass
Class of engine for this vehicle.
Definition: engine_type.h:52
Foundation GetBridgeFoundation(Slope tileh, Axis axis)
Get the foundation for a bridge.
static DiagDirection GetRailDepotDirection(TileIndex t)
Returns the direction the depot is facing to.
Definition: rail_map.h:171
static DiagDirection ReverseDiagDir(DiagDirection d)
Returns the reverse direction of the given DiagDirection.
static uint GetTunnelBridgeLength(TileIndex begin, TileIndex end)
Calculates the length of a tunnel or a bridge (without end tiles)
Definition: tunnelbridge.h:25
static TrackBits GetRailTrackBitsUniversal(TileIndex t, byte *override)
Finds which Electrified Rail Bits are present on a given tile.
Definition: elrail.cpp:86
Standard non-electric rails.
Definition: rail_type.h:29
Left and right track.
Definition: track_type.h:48
static bool HasStationTileRail(TileIndex t)
Has this station tile a rail? In other words, is this station tile a rail station or rail waypoint...
Definition: station_map.h:146
Definition of base types and functions in a cross-platform compatible way.
Track y-axis, direction south-east.
Definition: track_type.h:104
static const DiagDirection PCPpositions[TRACK_END][2]
Maps a track bit onto two PCP positions.
Definition: elrail_data.h:63
static const uint BB_HEIGHT_UNDER_BRIDGE
Some values for constructing bounding boxes (BB).
Definition: viewport_type.h:92
A number of safeguards to prevent using unsafe methods.
#define FOR_EACH_SET_TRACK(var, track_bits)
Iterate through each set Track in a TrackBits value.
Definition: track_func.h:27
Direction
Defines the 8 directions on the map.
static Axis GetRailStationAxis(TileIndex t)
Get the rail direction of a rail station.
Definition: station_map.h:337
uint y
Y position of the tile in unit coordinates.
Definition: tile_cmd.h:44
void DrawRailCatenaryOnTunnel(const TileInfo *ti)
Draws wires on a tunnel tile.
Definition: elrail.cpp:243
TrackBits
Bitfield corresponding to Track.
Definition: track_type.h:38
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:329
static bool HasRailCatenary(RailType rt)
Test if a rail type has catenary.
Definition: elrail_func.h:21
static T min(const T a, const T b)
Returns the minimum of two values.
Definition: math_func.hpp:40
TileIndex GetSouthernBridgeEnd(TileIndex t)
Finds the southern end of a bridge starting at a middle tile.
Definition: bridge_map.cpp:49
static DiagDirection GetTunnelBridgeDirection(TileIndex t)
Get the direction pointing to the other end.
static bool IsPlainRailTile(TileIndex t)
Checks whether the tile is a rail tile or rail tile with signals.
Definition: rail_map.h:60
static SpriteID GetWireBase(TileIndex tile, TileContext context=TCX_NORMAL)
Get the base wire sprite to use.
Definition: elrail.cpp:174
static Axis GetBridgeAxis(TileIndex t)
Get the axis of the bridge that goes over the tile.
Definition: bridge_map.h:68
void AddSortableSpriteToDraw(SpriteID image, PaletteID pal, int x, int y, int w, int h, int dz, int z, bool transparent, int bb_offset_x, int bb_offset_y, int bb_offset_z, const SubSprite *sub)
Draw a (transparent) sprite at given coordinates with a given bounding box.
Definition: viewport.cpp:659
catenary
Definition: transparency.h:30
Information about a rail vehicle.
Definition: engine_type.h:42
TrackStatus GetTileTrackStatus(TileIndex tile, TransportType mode, uint sub_mode, DiagDirection side)
Returns information about trackdirs and signal states.
Definition: landscape.cpp:589
TLG
Tile Location group.
Definition: elrail_data.h:20
static TrackBits DiagdirReachesTracks(DiagDirection diagdir)
Returns all tracks that can be reached when entering a tile from a given (diagonal) direction...
Definition: track_func.h:581
&#39;Train&#39; is either a loco or a wagon.
Definition: train.h:85
static RailTileType GetRailTileType(TileIndex t)
Returns the RailTileType (normal with or without signals, waypoint or depot).
Definition: rail_map.h:36
static TrackBits GetTrackBits(TileIndex tile)
Gets the track bits of the given tile.
Definition: rail_map.h:136
The X axis.
static Axis DiagDirToAxis(DiagDirection d)
Convert a DiagDirection to the axis.
Transport by train.
static TrackBits TrackToTrackBits(Track track)
Maps a Track to the corresponding TrackBits value.
Definition: track_func.h:85
static Slope InclinedSlope(DiagDirection dir)
Returns the slope that is inclined in a specific direction.
Definition: slope_func.h:256
RailType GetTileRailType(TileIndex tile)
Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
Definition: rail.cpp:155
Electric train engine is allowed to run on normal rail. */.
Definition: train.h:30
No track.
Definition: track_type.h:39
Track along the y-axis (north-west to south-east)
Definition: track_type.h:22
static T ClrBit(T &x, const uint8 y)
Clears a bit in a variable.
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
static bool IsRailDepot(TileIndex t)
Is this rail tile a rail depot?
Definition: rail_map.h:95
Tunnel entry/exit and bridge heads.
Definition: tile_type.h:50
static Pool::IterateWrapper< Titem > Iterate(size_t from=0)
Returns an iterable ensemble of all valid Titem.
Definition: pool_type.hpp:340
static void AdjustTileh(TileIndex tile, Slope *tileh)
Corrects the tileh for certain tile types.
Definition: elrail.cpp:196
static TLG GetTLG(TileIndex t)
Get the tile location group of a tile.
Definition: elrail.cpp:75
uint32 SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:17
int GetTileMaxZ(TileIndex t)
Get top height of the tile inside the map.
Definition: tile_map.cpp:141
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:78
Used for iterations.
static const byte IgnoredPCP[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...
Definition: elrail_data.h:122
static int GetBridgePixelHeight(TileIndex tile)
Get the height (&#39;z&#39;) of a bridge in pixels.
Definition: bridge_map.h:84
Track
These are used to specify a single track.
Definition: track_type.h:19
static uint TileY(TileIndex tile)
Get the Y component of a tile.
Definition: map_func.h:215
RailCatenarySprite
Refers to a certain element of the catenary.
Definition: elrail_data.h:420
The tile has no foundation, the slope remains unchanged.
Definition: slope_type.h:94
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
A tile of a station.
Definition: tile_type.h:46
void DrawRailCatenary(const TileInfo *ti)
Draws overhead wires and pylons for electric railways.
Definition: elrail.cpp:562
Normal rail tile without signals.
Definition: rail_map.h:24
static TrackBits TrackStatusToTrackBits(TrackStatus ts)
Returns the present-track-information of a TrackStatus.
Definition: track_func.h:371
Northwest.
bool CanStationTileHavePylons(TileIndex tile)
Check if a rail station tile shall have pylons when electrified.
Catenary wires.
Definition: rail.h:51
Track x-axis, direction south-west.
Definition: track_type.h:110
Track y-axis, direction north-west.
Definition: track_type.h:111
Northeast.
header file for electrified rail specific functions
Functions that have tunnels and bridges in common.
static Pool::IterateWrapper< Train > Iterate(size_t from=0)
Returns an iterable ensemble of all valid vehicles of type T.
static bool IsTunnelTile(TileIndex t)
Is this a tunnel (entrance)?
Definition: tunnel_map.h:33
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
DiagDirection
Enumeration for diagonal directions.
Northeast, upper right on your monitor.
static TrackBits TrackdirBitsToTrackBits(TrackdirBits bits)
Discards all directional information from a TrackdirBits value.
Definition: track_func.h:316
RailTypes GetCompanyRailtypes(CompanyID company, bool introduces)
Get the rail types the given company can build.
Definition: rail.cpp:251
Stores all the data for overhead wire and pylon drawing.
Track x-axis, direction north-east.
Definition: track_type.h:103
Track in the left corner of the tile (west)
Definition: track_type.h:25
bridges
Definition: transparency.h:28
static Direction ReverseDir(Direction d)
Return the reverse of a direction.
static TrackBits MaskWireBits(TileIndex t, TrackBits tracks)
Masks out track bits when neighbouring tiles are unelectrified.
Definition: elrail.cpp:125
Y-axis track.
Definition: track_type.h:41
static bool IsTunnel(TileIndex t)
Is this a tunnel (entrance)?
Definition: tunnel_map.h:22
Valid changes while vehicle is driving, and possibly changing tracks.
Definition: train.h:48
static bool IsTransparencySet(TransparencyOption to)
Check if the transparency option bit is set and if we aren&#39;t in the game menu (there&#39;s never transpar...
Definition: transparency.h:48
Axis
Allow incrementing of DiagDirDiff variables.
static RailType GetRailType(TileIndex t)
Gets the rail type of the given tile.
Definition: rail_map.h:115
static bool TracksOverlap(TrackBits bits)
Checks if the given tracks overlap, ie form a crossing.
Definition: track_func.h:653
Track in the upper corner of the tile (north)
Definition: track_type.h:23
Southwest.
Upper and lower track.
Definition: track_type.h:47
static int GetTileMaxPixelZ(TileIndex tile)
Get top height of the tile.
Definition: tile_map.h:304
bool SettingsDisableElrail(int32 p1)
_settings_game.disable_elrail callback
Definition: elrail.cpp:592
TileContext
Context for tile accesses.
static Pool::IterateWrapper< Engine > IterateType(VehicleType vt, size_t from=0)
Returns an iterable ensemble of all valid engines of the given type.
Definition: engine_base.h:151