OpenTTD
rail.cpp
Go to the documentation of this file.
1 /* $Id: rail.cpp 27808 2017-03-19 22:30:47Z peter1138 $ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * 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.
6  * 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.
7  * 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/>.
8  */
9 
12 #include "stdafx.h"
13 #include "station_map.h"
14 #include "tunnelbridge_map.h"
15 #include "date_func.h"
16 #include "company_func.h"
17 #include "company_base.h"
18 #include "engine_base.h"
19 
20 #include "safeguards.h"
21 
22 /* XXX: Below 3 tables store duplicate data. Maybe remove some? */
23 /* Maps a trackdir to the bit that stores its status in the map arrays, in the
24  * direction along with the trackdir */
25 extern const byte _signal_along_trackdir[TRACKDIR_END] = {
26  0x8, 0x8, 0x8, 0x2, 0x4, 0x1, 0, 0,
27  0x4, 0x4, 0x4, 0x1, 0x8, 0x2
28 };
29 
30 /* Maps a trackdir to the bit that stores its status in the map arrays, in the
31  * direction against the trackdir */
32 extern const byte _signal_against_trackdir[TRACKDIR_END] = {
33  0x4, 0x4, 0x4, 0x1, 0x8, 0x2, 0, 0,
34  0x8, 0x8, 0x8, 0x2, 0x4, 0x1
35 };
36 
37 /* Maps a Track to the bits that store the status of the two signals that can
38  * be present on the given track */
39 extern const byte _signal_on_track[] = {
40  0xC, 0xC, 0xC, 0x3, 0xC, 0x3
41 };
42 
43 /* Maps a diagonal direction to the all trackdirs that are connected to any
44  * track entering in this direction (including those making 90 degree turns)
45  */
46 extern const TrackdirBits _exitdir_reaches_trackdirs[] = {
51 };
52 
53 extern const Trackdir _next_trackdir[TRACKDIR_END] = {
56 };
57 
58 /* Maps a trackdir to all trackdirs that make 90 deg turns with it. */
59 extern const TrackdirBits _track_crosses_trackdirs[TRACK_END] = {
66 };
67 
68 /* Maps a track to all tracks that make 90 deg turns with it. */
69 extern const TrackBits _track_crosses_tracks[] = {
70  TRACK_BIT_Y, // TRACK_X
71  TRACK_BIT_X, // TRACK_Y
72  TRACK_BIT_VERT, // TRACK_UPPER
73  TRACK_BIT_VERT, // TRACK_LOWER
74  TRACK_BIT_HORZ, // TRACK_LEFT
75  TRACK_BIT_HORZ // TRACK_RIGHT
76 };
77 
78 /* Maps a trackdir to the (4-way) direction the tile is exited when following
79  * that trackdir */
80 extern const DiagDirection _trackdir_to_exitdir[TRACKDIR_END] = {
83 };
84 
85 extern const Trackdir _track_exitdir_to_trackdir[][DIAGDIR_END] = {
86  {TRACKDIR_X_NE, INVALID_TRACKDIR, TRACKDIR_X_SW, INVALID_TRACKDIR},
92 };
93 
94 extern const Trackdir _track_enterdir_to_trackdir[][DIAGDIR_END] = {
95  {TRACKDIR_X_NE, INVALID_TRACKDIR, TRACKDIR_X_SW, INVALID_TRACKDIR},
99  {TRACKDIR_LEFT_N, TRACKDIR_LEFT_S, INVALID_TRACKDIR, INVALID_TRACKDIR},
101 };
102 
103 extern const Trackdir _track_direction_to_trackdir[][DIR_END] = {
110 };
111 
112 extern const Trackdir _dir_to_diag_trackdir[] = {
114 };
115 
116 extern const TrackBits _corner_to_trackbits[] = {
118 };
119 
120 extern const TrackdirBits _uphill_trackdirs[] = {
144  TRACKDIR_BIT_X_SW | TRACKDIR_BIT_Y_SE,
148  TRACKDIR_BIT_X_SW | TRACKDIR_BIT_Y_NW,
150  TRACKDIR_BIT_X_NE | TRACKDIR_BIT_Y_NW,
151  TRACKDIR_BIT_X_NE | TRACKDIR_BIT_Y_SE,
152 };
153 
158 {
159  switch (GetTileType(tile)) {
160  case MP_RAILWAY:
161  return GetRailType(tile);
162 
163  case MP_ROAD:
164  /* rail/road crossing */
165  if (IsLevelCrossing(tile)) return GetRailType(tile);
166  break;
167 
168  case MP_STATION:
169  if (HasStationRail(tile)) return GetRailType(tile);
170  break;
171 
172  case MP_TUNNELBRIDGE:
173  if (GetTunnelBridgeTransportType(tile) == TRANSPORT_RAIL) return GetRailType(tile);
174  break;
175 
176  default:
177  break;
178  }
179  return INVALID_RAILTYPE;
180 }
181 
188 bool HasRailtypeAvail(const CompanyID company, const RailType railtype)
189 {
190  return HasBit(Company::Get(company)->avail_railtypes, railtype);
191 }
192 
198 bool ValParamRailtype(const RailType rail)
199 {
200  return rail < RAILTYPE_END && HasRailtypeAvail(_current_company, rail);
201 }
202 
211 {
212  if (HasRailtypeAvail(company, RAILTYPE_MAGLEV)) return RAILTYPE_MAGLEV;
213  if (HasRailtypeAvail(company, RAILTYPE_MONO)) return RAILTYPE_MONO;
215  return RAILTYPE_RAIL;
216 }
217 
226 {
227  RailTypes rts = current;
228 
229  for (RailType rt = RAILTYPE_BEGIN; rt != RAILTYPE_END; rt++) {
230  const RailtypeInfo *rti = GetRailTypeInfo(rt);
231  /* Unused rail type. */
232  if (rti->label == 0) continue;
233 
234  /* Not date introduced. */
235  if (!IsInsideMM(rti->introduction_date, 0, MAX_DAY)) continue;
236 
237  /* Not yet introduced at this date. */
238  if (rti->introduction_date > date) continue;
239 
240  /* Have we introduced all required railtypes? */
242  if ((rts & required) != required) continue;
243 
244  rts |= rti->introduces_railtypes;
245  }
246 
247  /* When we added railtypes we need to run this method again; the added
248  * railtypes might enable more rail types to become introduced. */
249  return rts == current ? rts : AddDateIntroducedRailTypes(rts, date);
250 }
251 
258 {
260 
261  Engine *e;
262  FOR_ALL_ENGINES_OF_TYPE(e, VEH_TRAIN) {
263  const EngineInfo *ei = &e->info;
264 
266  (HasBit(e->company_avail, company) || _date >= e->intro_date + DAYS_IN_YEAR)) {
267  const RailVehicleInfo *rvi = &e->u.rail;
268 
269  if (rvi->railveh_type != RAILVEH_WAGON) {
270  assert(rvi->railtype < RAILTYPE_END);
271  rts |= GetRailTypeInfo(rvi->railtype)->introduces_railtypes;
272  }
273  }
274  }
275 
276  return AddDateIntroducedRailTypes(rts, _date);
277 }
278 
285 RailType GetRailTypeByLabel(RailTypeLabel label, bool allow_alternate_labels)
286 {
287  /* Loop through each rail type until the label is found */
288  for (RailType r = RAILTYPE_BEGIN; r != RAILTYPE_END; r++) {
289  const RailtypeInfo *rti = GetRailTypeInfo(r);
290  if (rti->label == label) return r;
291  }
292 
293  if (allow_alternate_labels) {
294  /* Test if any rail type defines the label as an alternate. */
295  for (RailType r = RAILTYPE_BEGIN; r != RAILTYPE_END; r++) {
296  const RailtypeInfo *rti = GetRailTypeInfo(r);
297  if (rti->alternate_labels.Contains(label)) return r;
298  }
299  }
300 
301  /* No matching label was found, so it is invalid */
302  return INVALID_RAILTYPE;
303 }
Used for iterations.
Definition: rail_type.h:35
static TileType GetTileType(TileIndex tile)
Get the tiletype of a given tile.
Definition: tile_map.h:89
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:77
Definition of stuff that is very close to a company, like the company struct itself.
static const RailtypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:296
static const int DAYS_IN_YEAR
days per year
Definition: date_type.h:31
static TransportType GetTunnelBridgeTransportType(TileIndex t)
Tunnel: Get the transport type of the tunnel (road or rail) Bridge: Get the transport type of the bri...
RailTypes
The different roadtypes we support, but then a bitmask of them.
Definition: rail_type.h:52
Monorail.
Definition: rail_type.h:33
byte landscape
the landscape we&#39;re currently in
Maps accessors for stations.
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:29
Y-axis and direction to north-west.
Definition: track_type.h:85
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:246
Functions related to dates.
static bool IsInsideMM(const T x, const uint min, const uint max)
Checks if a value is in an interval.
Definition: math_func.hpp:266
Maglev.
Definition: rail_type.h:34
Used for iterations.
Definition: track_type.h:92
RailTypes introduction_required_railtypes
Bitmask of railtypes that are required for this railtype to be introduced at a given introduction_dat...
Definition: rail.h:250
A tile with road (or tram tracks)
Definition: tile_type.h:45
Date intro_date
Date of introduction of the engine.
Definition: engine_base.h:25
Right track and direction to north.
Definition: track_type.h:89
Track right, direction south.
Definition: track_type.h:113
bool ValParamRailtype(const RailType rail)
Validate functions for rail building.
Definition: rail.cpp:198
X-axis and direction to south-west.
Definition: track_type.h:84
RailTypeLabelList alternate_labels
Rail type labels this type provides in addition to the main label.
Definition: rail.h:230
Northeast, upper right on your monitor.
A railway.
Definition: tile_type.h:44
Standard non-electric rails.
Definition: rail_type.h:31
static bool IsLevelCrossing(TileIndex t)
Return whether a tile is a level crossing.
Definition: road_map.h:68
This struct contains all the info that is needed to draw and construct tracks.
Definition: rail.h:116
Used for iterations.
Definition: track_type.h:29
Track upper, direction east.
Definition: track_type.h:110
RailType GetBestRailtype(const CompanyID company)
Returns the "best" railtype a company can build.
Definition: rail.cpp:210
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:136
Right track.
Definition: track_type.h:48
Track right, direction north.
Definition: track_type.h:120
TrackBits
Bitfield corresponding to Track.
Definition: track_type.h:41
Track x-axis, direction north-east.
Definition: track_type.h:108
Left and right track.
Definition: track_type.h:51
Information about a vehicle.
Definition: engine_type.h:132
Track upper, direction west.
Definition: track_type.h:117
Track lower, direction west.
Definition: track_type.h:118
X-axis track.
Definition: track_type.h:43
bool Contains(const T &item) const
Tests whether a item is present in the vector.
Southeast.
Southwest.
simple wagon, not motorized
Definition: engine_type.h:30
Definition of base types and functions in a cross-platform compatible way.
A number of safeguards to prevent using unsafe methods.
RailTypes introduces_railtypes
Bitmask of which other railtypes are introduced when this railtype is introduced. ...
Definition: rail.h:255
Trackdir
Enumeration for tracks and directions.
Definition: track_type.h:74
Used for iterations.
CompanyMask company_avail
Bit for each company whether the engine is available for that company.
Definition: engine_base.h:39
Northwest.
DiagDirection
Enumeration for diagonal directions.
RailTypeLabel label
Unique 32 bit rail type identifier.
Definition: rail.h:225
RailTypes GetCompanyRailtypes(CompanyID company)
Get the rail types the given company can build.
Definition: rail.cpp:257
Used to iterate.
Information about a rail vehicle.
Definition: engine_type.h:43
Left track and direction to north.
Definition: track_type.h:88
Upper track and direction to west.
Definition: track_type.h:86
Y-axis and direction to south-east.
Definition: track_type.h:77
Transport by train.
Lower track and direction to east.
Definition: track_type.h:79
Functions related to companies.
RailType GetTileRailType(TileIndex tile)
Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
Definition: rail.cpp:157
Date introduction_date
Introduction date.
Definition: rail.h:244
Base class for engines.
Tunnel entry/exit and bridge heads.
Definition: tile_type.h:52
Left track and direction to south.
Definition: track_type.h:80
Lower track.
Definition: track_type.h:46
Electric rails.
Definition: rail_type.h:32
Upper track.
Definition: track_type.h:45
Track x-axis, direction south-west.
Definition: track_type.h:115
CompanyByte _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
Upper and lower track.
Definition: track_type.h:50
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
Right track and direction to south.
Definition: track_type.h:81
bool HasRailtypeAvail(const CompanyID company, const RailType railtype)
Finds out if a company has a certain railtype available.
Definition: rail.cpp:188
Track y-axis, direction north-west.
Definition: track_type.h:116
Lower track and direction to west.
Definition: track_type.h:87
A tile of a station.
Definition: tile_type.h:48
No rail types.
Definition: rail_type.h:53
#define MAX_DAY
The number of days till the last day.
Definition: date_type.h:97
TrackdirBits
Enumeration of bitmasks for the TrackDirs.
Definition: track_type.h:106
Functions that have tunnels and bridges in common.
int32 Date
The type to store our dates in.
Definition: date_type.h:16
Upper track and direction to east.
Definition: track_type.h:78
Track y-axis, direction south-east.
Definition: track_type.h:109
static bool HasBit(const T x, const uint8 y)
Checks if a bit in a value is set.
Track left, direction south.
Definition: track_type.h:112
Used for iterations.
Definition: rail_type.h:30
GameCreationSettings game_creation
settings used during the creation of a game (map)
No track build.
Definition: track_type.h:107
Track left, direction north.
Definition: track_type.h:119
Left track.
Definition: track_type.h:47
Flag for invalid railtype.
Definition: rail_type.h:36
Owner
Enum for all companies/owners.
Definition: company_type.h:20
Flag for an invalid trackdir.
Definition: track_type.h:93
RailType GetRailTypeByLabel(RailTypeLabel label, bool allow_alternate_labels)
Get the rail type for a given label.
Definition: rail.cpp:285
Track lower, direction east.
Definition: track_type.h:111
byte climates
Climates supported by the engine.
Definition: engine_type.h:138
Date _date
Current date in days (day counter)
Definition: date.cpp:28
X-axis and direction to north-east.
Definition: track_type.h:76
RailTypes AddDateIntroducedRailTypes(RailTypes current, Date date)
Add the rail types that are to be introduced at the given date.
Definition: rail.cpp:225
static RailType GetRailType(TileIndex t)
Gets the rail type of the given tile.
Definition: rail_map.h:116
Y-axis track.
Definition: track_type.h:44
Train vehicle type.
Definition: vehicle_type.h:24