OpenTTD Source  20241108-master-g80f628063a
rail.h
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 
10 #ifndef RAIL_H
11 #define RAIL_H
12 
13 #include "rail_type.h"
14 #include "track_type.h"
15 #include "gfx_type.h"
16 #include "core/bitmath_func.hpp"
17 #include "economy_func.h"
18 #include "slope_type.h"
19 #include "strings_type.h"
21 #include "signal_type.h"
22 #include "settings_type.h"
23 
28  RTF_HIDDEN = 2,
32 };
33 
35 enum RailTypeFlags : uint8_t {
36  RTFB_NONE = 0,
43 };
45 
46 struct SpriteGroup;
47 
63  RTSG_END,
64 };
65 
87 };
88 
96 };
97 
119 };
120 
122 typedef std::vector<RailTypeLabel> RailTypeLabelList;
123 
128 public:
133  struct {
147 
152  struct {
161  SpriteID signals[SIGTYPE_END][2][2];
163 
164  struct {
173  } cursor;
174 
175  struct {
183 
186 
189 
192 
197 
202 
206  uint8_t curve_speed;
207 
212 
216  uint16_t cost_multiplier;
217 
222 
227 
231  uint16_t max_speed;
232 
236  RailTypeLabel label;
237 
242 
246  uint8_t map_colour;
247 
256 
262 
267 
271  uint8_t sorting_order;
272 
276  const GRFFile *grffile[RTSG_END];
277 
281  const SpriteGroup *group[RTSG_END];
282 
283  inline bool UsesOverlay() const
284  {
285  return this->group[RTSG_GROUND] != nullptr;
286  }
287 
295  inline uint GetRailtypeSpriteOffset() const
296  {
297  return 82 * this->fallback_railtype;
298  }
299 };
300 
301 
307 inline const RailTypeInfo *GetRailTypeInfo(RailType railtype)
308 {
309  extern RailTypeInfo _railtypes[RAILTYPE_END];
310  assert(railtype < RAILTYPE_END);
311  return &_railtypes[railtype];
312 }
313 
322 inline bool IsCompatibleRail(RailType enginetype, RailType tiletype)
323 {
324  return HasBit(GetRailTypeInfo(enginetype)->compatible_railtypes, tiletype);
325 }
326 
335 inline bool HasPowerOnRail(RailType enginetype, RailType tiletype)
336 {
337  return HasBit(GetRailTypeInfo(enginetype)->powered_railtypes, tiletype);
338 }
339 
346 {
347  return HasBit(GetRailTypeInfo(rt)->flags, RTF_NO_LEVEL_CROSSING);
348 }
349 
358 {
359  if (rt1 == INVALID_RAILTYPE || rt2 == INVALID_RAILTYPE) return def;
360 
361  const RailTypeInfo *rti1 = GetRailTypeInfo(rt1);
362  const RailTypeInfo *rti2 = GetRailTypeInfo(rt2);
363 
364  bool rt1_90deg = HasBit(rti1->flags, RTF_DISALLOW_90DEG) || (!HasBit(rti1->flags, RTF_ALLOW_90DEG) && def);
365  bool rt2_90deg = HasBit(rti2->flags, RTF_DISALLOW_90DEG) || (!HasBit(rti2->flags, RTF_ALLOW_90DEG) && def);
366 
367  return rt1_90deg || rt2_90deg;
368 }
369 
375 inline Money RailBuildCost(RailType railtype)
376 {
377  assert(railtype < RAILTYPE_END);
378  return (_price[PR_BUILD_RAIL] * GetRailTypeInfo(railtype)->cost_multiplier) >> 3;
379 }
380 
386 inline Money RailClearCost(RailType railtype)
387 {
388  /* Clearing rail in fact earns money, but if the build cost is set
389  * very low then a loophole exists where money can be made.
390  * In this case we limit the removal earnings to 3/4s of the build
391  * cost.
392  */
393  assert(railtype < RAILTYPE_END);
394  return std::max(_price[PR_CLEAR_RAIL], -RailBuildCost(railtype) * 3 / 4);
395 }
396 
404 {
405  /* Get the costs for removing and building anew
406  * A conversion can never be more costly */
407  Money rebuildcost = RailBuildCost(to) + RailClearCost(from);
408 
409  /* Conversion between somewhat compatible railtypes:
410  * Pay 1/8 of the target rail cost (labour costs) and additionally any difference in the
411  * build costs, if the target type is more expensive (material upgrade costs).
412  * Upgrade can never be more expensive than re-building. */
413  if (HasPowerOnRail(from, to) || HasPowerOnRail(to, from)) {
414  Money upgradecost = RailBuildCost(to) / 8 + std::max((Money)0, RailBuildCost(to) - RailBuildCost(from));
415  return std::min(upgradecost, rebuildcost);
416  }
417 
418  /* make the price the same as remove + build new type for rail types
419  * which are not compatible in any way */
420  return rebuildcost;
421 }
422 
430 inline Money RailMaintenanceCost(RailType railtype, uint32_t num, uint32_t total_num)
431 {
432  assert(railtype < RAILTYPE_END);
433  return (_price[PR_INFRASTRUCTURE_RAIL] * GetRailTypeInfo(railtype)->maintenance_multiplier * num * (1 + IntSqrt(total_num))) >> 11; // 4 bits fraction for the multiplier and 7 bits scaling.
434 }
435 
441 inline Money SignalMaintenanceCost(uint32_t num)
442 {
443  return (_price[PR_INFRASTRUCTURE_RAIL] * 15 * num * (1 + IntSqrt(num))) >> 8; // 1 bit fraction for the multiplier and 7 bits scaling.
444 }
445 
446 void DrawTrainDepotSprite(int x, int y, int image, RailType railtype);
447 int TicksToLeaveDepot(const Train *v);
448 
450 
451 
452 bool HasRailTypeAvail(const CompanyID company, const RailType railtype);
453 bool HasAnyRailTypesAvail(const CompanyID company);
454 bool ValParamRailType(const RailType rail);
455 
456 RailTypes AddDateIntroducedRailTypes(RailTypes current, TimerGameCalendar::Date date);
457 
458 RailTypes GetCompanyRailTypes(CompanyID company, bool introduces = true);
459 RailTypes GetRailTypes(bool introduces);
460 
461 RailType GetRailTypeByLabel(RailTypeLabel label, bool allow_alternate_labels = true);
462 
463 void ResetRailTypes();
464 void InitRailTypes();
465 RailType AllocateRailType(RailTypeLabel label);
466 
467 extern std::vector<RailType> _sorted_railtypes;
468 extern RailTypes _railtypes_hidden_mask;
469 
470 #endif /* RAIL_H */
Functions related to bit mathematics.
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
This struct contains all the info that is needed to draw and construct tracks.
Definition: rail.h:127
SpriteID single_x
single piece of rail in X direction, without ground
Definition: rail.h:137
struct RailTypeInfo::@25 cursor
Cursors associated with the rail type.
SpriteID bridge_offset
Bridge offset.
Definition: rail.h:196
uint16_t max_speed
Maximum speed for vehicles travelling on this rail type.
Definition: rail.h:231
SpriteID build_tunnel
button for building a tunnel
Definition: rail.h:159
CursorID rail_swne
Cursor for building rail in X direction.
Definition: rail.h:166
SpriteID convert_rail
button for converting rail
Definition: rail.h:160
CursorID convert
Cursor for converting track.
Definition: rail.h:172
struct RailTypeInfo::@23 base_sprites
Struct containing the main sprites.
CursorID depot
Cursor for building a depot.
Definition: rail.h:170
TimerGameCalendar::Date introduction_date
Introduction date.
Definition: rail.h:255
struct RailTypeInfo::@26 strings
Strings associated with the rail type.
RailTypes powered_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype generates power
Definition: rail.h:188
RailTypes introduces_railtypes
Bitmask of which other railtypes are introduced when this railtype is introduced.
Definition: rail.h:266
SpriteID ground
ground sprite for a 3-way switch
Definition: rail.h:136
CursorID rail_nwse
Cursor for building rail in Y direction.
Definition: rail.h:168
RailTypes introduction_required_railtypes
Bitmask of railtypes that are required for this railtype to be introduced at a given introduction_dat...
Definition: rail.h:261
SpriteID build_x_rail
button for building single rail in X direction
Definition: rail.h:154
uint8_t sorting_order
The sorting order of this railtype for the toolbar dropdown.
Definition: rail.h:271
RailTypeLabel label
Unique 32 bit rail type identifier.
Definition: rail.h:236
SpriteID single_n
single piece of rail in the northern corner
Definition: rail.h:139
CursorID tunnel
Cursor for building a tunnel.
Definition: rail.h:171
uint16_t maintenance_multiplier
Cost multiplier for maintenance of this rail type.
Definition: rail.h:221
SpriteID crossing
level crossing, rail in X direction
Definition: rail.h:144
const SpriteGroup * group[RTSG_END]
Sprite groups for resolving sprites.
Definition: rail.h:281
uint8_t map_colour
Colour on mini-map.
Definition: rail.h:246
CursorID rail_ew
Cursor for building rail in E-W direction.
Definition: rail.h:167
SpriteID auto_rail
button for the autorail construction
Definition: rail.h:157
CursorID autorail
Cursor for autorail tool.
Definition: rail.h:169
SpriteID single_y
single piece of rail in Y direction, without ground
Definition: rail.h:138
StringID menu_text
Name of this rail type in the main toolbar dropdown.
Definition: rail.h:178
StringID name
Name of this rail type.
Definition: rail.h:176
RailTypes compatible_railtypes
bitmask to the OTHER railtypes on which an engine of THIS railtype can physically travel
Definition: rail.h:191
uint8_t fallback_railtype
Original railtype number to use when drawing non-newgrf railtypes, or when drawing stations.
Definition: rail.h:201
uint GetRailtypeSpriteOffset() const
Offset between the current railtype and normal rail.
Definition: rail.h:295
StringID toolbar_caption
Caption in the construction toolbar GUI for this rail type.
Definition: rail.h:177
SpriteID single_s
single piece of rail in the southern corner
Definition: rail.h:140
RailTypeFlags flags
Bit mask of rail type flags.
Definition: rail.h:211
uint8_t curve_speed
Multiplier for curve maximum speed advantage.
Definition: rail.h:206
SpriteID signals[SIGTYPE_END][2][2]
signal GUI sprites (type, variant, state)
Definition: rail.h:161
SpriteID build_ew_rail
button for building single rail in E-W direction
Definition: rail.h:155
SpriteID build_y_rail
button for building single rail in Y direction
Definition: rail.h:156
uint16_t cost_multiplier
Cost multiplier for building this rail type.
Definition: rail.h:216
SpriteID track_ns
two pieces of rail in North and South corner (East-West direction)
Definition: rail.h:135
StringID replace_text
Text used in the autoreplace GUI.
Definition: rail.h:180
RailTypeLabelList alternate_labels
Rail type labels this type provides in addition to the main label.
Definition: rail.h:241
StringID build_caption
Caption of the build vehicle GUI for this rail type.
Definition: rail.h:179
SpriteID snow_offset
sprite number difference between a piece of track on a snowy ground and the corresponding one on norm...
Definition: rail.h:185
SpriteID track_y
single piece of rail in Y direction, with ground
Definition: rail.h:134
SpriteID build_depot
button for building depots
Definition: rail.h:158
struct RailTypeInfo::@24 gui_sprites
struct containing the sprites for the rail GUI.
SpriteID single_w
single piece of rail in the western corner
Definition: rail.h:142
SpriteID single_e
single piece of rail in the eastern corner
Definition: rail.h:141
SpriteID build_ns_rail
button for building single rail in N-S direction
Definition: rail.h:153
CursorID rail_ns
Cursor for building rail in N-S direction.
Definition: rail.h:165
StringID new_loco
Name of an engine for this type of rail in the engine preview GUI.
Definition: rail.h:181
const GRFFile * grffile[RTSG_END]
NewGRF providing the Action3 for the railtype.
Definition: rail.h:276
SpriteID tunnel
tunnel sprites base
Definition: rail.h:145
SpriteID single_sloped
single piece of rail for slopes
Definition: rail.h:143
uint8_t acceleration_type
Acceleration type of this rail type.
Definition: rail.h:226
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Owner
Enum for all companies/owners.
Definition: company_type.h:18
uint32_t IntSqrt(uint32_t num)
Compute the integer square root.
Definition: math_func.cpp:42
Functions related to the economy.
Types related to the graphics and/or input devices.
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:18
uint32_t CursorID
The number of the cursor (sprite)
Definition: gfx_type.h:20
Money RailConvertCost(RailType from, RailType to)
Calculates the cost of rail conversion.
Definition: rail.h:403
int TicksToLeaveDepot(const Train *v)
Compute number of ticks when next wagon will leave a depot.
Definition: rail_cmd.cpp:2916
RailTypeSpriteGroup
Sprite groups for a railtype.
Definition: rail.h:49
@ RTSG_GROUND
Main group of ground images.
Definition: rail.h:52
@ RTSG_PYLONS
Catenary pylons.
Definition: rail.h:55
@ RTSG_CURSORS
Cursor and toolbar icon images.
Definition: rail.h:50
@ RTSG_GROUND_COMPLETE
Complete ground images.
Definition: rail.h:62
@ RTSG_CROSSING
Level crossing overlay images.
Definition: rail.h:57
@ RTSG_TUNNEL
Main group of ground images for snow or desert.
Definition: rail.h:53
@ RTSG_WIRES
Catenary wires.
Definition: rail.h:54
@ RTSG_OVERLAY
Images for overlaying track.
Definition: rail.h:51
@ RTSG_SIGNALS
Signal images.
Definition: rail.h:61
@ RTSG_DEPOT
Depot images.
Definition: rail.h:58
@ RTSG_BRIDGE
Bridge surface images.
Definition: rail.h:56
@ RTSG_TUNNEL_PORTAL
Tunnel portal overlay.
Definition: rail.h:60
@ RTSG_FENCES
Fence images.
Definition: rail.h:59
RailTrackBridgeOffset
Offsets for sprites within a bridge surface overlay set.
Definition: rail.h:92
@ RTBO_Y
Piece of rail in Y direction.
Definition: rail.h:94
@ RTBO_X
Piece of rail in X direction.
Definition: rail.h:93
@ RTBO_SLOPE
Sloped rail pieces, in order NE, SE, SW, NW.
Definition: rail.h:95
Money RailClearCost(RailType railtype)
Returns the 'cost' of clearing the specified railtype.
Definition: rail.h:386
Money RailBuildCost(RailType railtype)
Returns the cost of building the specified railtype.
Definition: rail.h:375
RailType AllocateRailType(RailTypeLabel label)
Allocate a new rail type label.
Definition: rail_cmd.cpp:150
const RailTypeInfo * GetRailTypeInfo(RailType railtype)
Returns a pointer to the Railtype information for a given railtype.
Definition: rail.h:307
bool HasAnyRailTypesAvail(const CompanyID company)
Test if any buildable railtype is available for a company.
Definition: rail.cpp:196
Money RailMaintenanceCost(RailType railtype, uint32_t num, uint32_t total_num)
Calculates the maintenance cost of a number of track bits.
Definition: rail.h:430
bool HasRailTypeAvail(const CompanyID company, const RailType railtype)
Finds out if a company has a certain buildable railtype available.
Definition: rail.cpp:186
bool IsCompatibleRail(RailType enginetype, RailType tiletype)
Checks if an engine of the given RailType can drive on a tile with a given RailType.
Definition: rail.h:322
void InitRailTypes()
Resolve sprites of custom rail types.
Definition: rail_cmd.cpp:130
bool HasPowerOnRail(RailType enginetype, RailType tiletype)
Checks if an engine of the given RailType got power on a tile with a given RailType.
Definition: rail.h:335
std::vector< RailTypeLabel > RailTypeLabelList
List of rail type labels.
Definition: rail.h:122
RailTrackOffset
Offsets for sprites within an overlay/underlay set.
Definition: rail.h:70
@ RTO_Y
Piece of rail in Y direction.
Definition: rail.h:72
@ RTO_S
Piece of rail in southern corner.
Definition: rail.h:74
@ RTO_JUNCTION_NE
Ballast for junction 'pointing' NE.
Definition: rail.h:83
@ RTO_JUNCTION_NSEW
Ballast for full junction.
Definition: rail.h:86
@ RTO_JUNCTION_SW
Ballast for junction 'pointing' SW.
Definition: rail.h:82
@ RTO_SLOPE_SE
Piece of rail on slope with south-east raised.
Definition: rail.h:78
@ RTO_E
Piece of rail in eastern corner.
Definition: rail.h:75
@ RTO_W
Piece of rail in western corner.
Definition: rail.h:76
@ RTO_CROSSING_XY
Crossing of X and Y rail, with ballast.
Definition: rail.h:81
@ RTO_SLOPE_SW
Piece of rail on slope with south-west raised.
Definition: rail.h:79
@ RTO_SLOPE_NW
Piece of rail on slope with north-west raised.
Definition: rail.h:80
@ RTO_JUNCTION_NW
Ballast for junction 'pointing' NW.
Definition: rail.h:85
@ RTO_JUNCTION_SE
Ballast for junction 'pointing' SE.
Definition: rail.h:84
@ RTO_SLOPE_NE
Piece of rail on slope with north-east raised.
Definition: rail.h:77
@ RTO_X
Piece of rail in X direction.
Definition: rail.h:71
@ RTO_N
Piece of rail in northern corner.
Definition: rail.h:73
RailTypes AddDateIntroducedRailTypes(RailTypes current, TimerGameCalendar::Date date)
Add the rail types that are to be introduced at the given date.
Definition: rail.cpp:218
void ResetRailTypes()
Reset all rail type information to its default values.
Definition: rail_cmd.cpp:65
Money SignalMaintenanceCost(uint32_t num)
Calculates the maintenance cost of a number of signals.
Definition: rail.h:441
bool Rail90DegTurnDisallowed(RailType rt1, RailType rt2, bool def=_settings_game.pf.forbid_90_deg)
Test if 90 degree turns are disallowed between two railtypes.
Definition: rail.h:357
RailTypes GetCompanyRailTypes(CompanyID company, bool introduces=true)
Get the rail types the given company can build.
Definition: rail.cpp:251
RailFenceOffset
Offsets from base sprite for fence sprites.
Definition: rail.h:102
@ RFO_FLAT_RIGHT
Slope FLAT, Track RIGHT, Fence W.
Definition: rail.h:113
@ RFO_FLAT_Y_NE
Slope FLAT, Track Y, Fence NE.
Definition: rail.h:104
@ RFO_SLOPE_NW_SW
Slope NW, Track Y, Fence SW.
Definition: rail.h:118
@ RFO_FLAT_X_SE
Slope FLAT, Track X, Fence SE.
Definition: rail.h:111
@ RFO_SLOPE_NW_NE
Slope NW, Track Y, Fence NE.
Definition: rail.h:110
@ RFO_SLOPE_SE_SW
Slope SE, Track Y, Fence SW.
Definition: rail.h:116
@ RFO_SLOPE_NE_SE
Slope NE, Track X, Fence SE.
Definition: rail.h:117
@ RFO_FLAT_LOWER
Slope FLAT, Track LOWER, Fence N.
Definition: rail.h:114
@ RFO_SLOPE_SW_SE
Slope SW, Track X, Fence SE.
Definition: rail.h:115
@ RFO_FLAT_UPPER
Slope FLAT, Track UPPER, Fence S.
Definition: rail.h:106
@ RFO_SLOPE_SE_NE
Slope SE, Track Y, Fence NE.
Definition: rail.h:108
@ RFO_FLAT_Y_SW
Slope FLAT, Track Y, Fence SW.
Definition: rail.h:112
@ RFO_FLAT_LEFT
Slope FLAT, Track LEFT, Fence E.
Definition: rail.h:105
@ RFO_SLOPE_NE_NW
Slope NE, Track X, Fence NW.
Definition: rail.h:109
@ RFO_FLAT_X_NW
Slope FLAT, Track X, Fence NW.
Definition: rail.h:103
@ RFO_SLOPE_SW_NW
Slope SW, Track X, Fence NW.
Definition: rail.h:107
RailTypeFlag
Railtype flag bit numbers.
Definition: rail.h:25
@ RTF_NO_LEVEL_CROSSING
Bit number for disallowing level crossings.
Definition: rail.h:27
@ RTF_HIDDEN
Bit number for hiding from selection.
Definition: rail.h:28
@ RTF_NO_SPRITE_COMBINE
Bit number for using non-combined junctions.
Definition: rail.h:29
@ RTF_ALLOW_90DEG
Bit number for always allowed 90 degree turns, regardless of setting.
Definition: rail.h:30
@ RTF_DISALLOW_90DEG
Bit number for never allowed 90 degree turns, regardless of setting.
Definition: rail.h:31
@ RTF_CATENARY
Bit number for drawing a catenary.
Definition: rail.h:26
RailTypes GetRailTypes(bool introduces)
Get list of rail types, regardless of company availability.
Definition: rail.cpp:282
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:312
bool RailNoLevelCrossings(RailType rt)
Test if a RailType disallows build of level crossings.
Definition: rail.h:345
RailTypeFlags
Railtype flags.
Definition: rail.h:35
@ RTFB_NO_LEVEL_CROSSING
Value for disallowing level crossings.
Definition: rail.h:38
@ RTFB_ALLOW_90DEG
Value for always allowed 90 degree turns, regardless of setting.
Definition: rail.h:41
@ RTFB_DISALLOW_90DEG
Value for never allowed 90 degree turns, regardless of setting.
Definition: rail.h:42
@ RTFB_NO_SPRITE_COMBINE
Value for using non-combined junctions.
Definition: rail.h:40
@ RTFB_CATENARY
Value for drawing a catenary.
Definition: rail.h:37
@ RTFB_NONE
All flags cleared.
Definition: rail.h:36
@ RTFB_HIDDEN
Value for hiding from selection.
Definition: rail.h:39
RailType GetRailTypeByLabel(RailTypeLabel label, bool allow_alternate_labels=true)
Get the rail type for a given label.
Definition: rail.cpp:311
bool ValParamRailType(const RailType rail)
Validate functions for rail building.
Definition: rail.cpp:206
The different types of rail.
RailTypes
Allow incrementing of Track variables.
Definition: rail_type.h:44
RailType
Enumeration for all possible railtypes.
Definition: rail_type.h:27
@ RAILTYPE_END
Used for iterations.
Definition: rail_type.h:33
@ INVALID_RAILTYPE
Flag for invalid railtype.
Definition: rail_type.h:34
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:57
Types related to global configuration settings.
Types and classes related to signals.
Definitions of a slope.
Slope
Enumeration for the slope-type.
Definition: slope_type.h:48
Foundation
Enumeration for Foundations.
Definition: slope_type.h:93
Types related to strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Dynamic data of a loaded NewGRF.
Definition: newgrf.h:108
PathfinderSettings pf
settings for all pathfinders
bool forbid_90_deg
forbid trains to make 90 deg turns
Templated helper to make a type-safe 'typedef' representing a single POD value.
'Train' is either a loco or a wagon.
Definition: train.h:89
Definition of the game-calendar-timer.
All types related to tracks.
TrackBits
Allow incrementing of Track variables.
Definition: track_type.h:35