OpenTTD Source
20241108-master-g80f628063a
|
Hides the direct accesses to the map array with map accessors. More...
#include "rail_type.h"
#include "depot_type.h"
#include "signal_func.h"
#include "track_func.h"
#include "tile_map.h"
#include "water_map.h"
#include "signal_type.h"
Go to the source code of this file.
Enumerations | |
enum | RailTileType { RAIL_TILE_NORMAL = 0 , RAIL_TILE_SIGNALS = 1 , RAIL_TILE_DEPOT = 3 } |
Different types of Rail-related tiles. More... | |
enum | RailGroundType { RAIL_GROUND_BARREN = 0 , RAIL_GROUND_GRASS = 1 , RAIL_GROUND_FENCE_NW = 2 , RAIL_GROUND_FENCE_SE = 3 , RAIL_GROUND_FENCE_SENW = 4 , RAIL_GROUND_FENCE_NE = 5 , RAIL_GROUND_FENCE_SW = 6 , RAIL_GROUND_FENCE_NESW = 7 , RAIL_GROUND_FENCE_VERT1 = 8 , RAIL_GROUND_FENCE_VERT2 = 9 , RAIL_GROUND_FENCE_HORIZ1 = 10 , RAIL_GROUND_FENCE_HORIZ2 = 11 , RAIL_GROUND_ICE_DESERT = 12 , RAIL_GROUND_WATER = 13 , RAIL_GROUND_HALF_SNOW = 14 } |
The ground 'under' the rail. More... | |
Functions | |
static debug_inline RailTileType | GetRailTileType (Tile t) |
Returns the RailTileType (normal with or without signals, waypoint or depot). More... | |
static debug_inline bool | IsPlainRail (Tile t) |
Returns whether this is plain rails, with or without signals. More... | |
static debug_inline bool | IsPlainRailTile (Tile t) |
Checks whether the tile is a rail tile or rail tile with signals. More... | |
bool | HasSignals (Tile t) |
Checks if a rail tile has signals. More... | |
void | SetHasSignals (Tile tile, bool signals) |
Add/remove the 'has signal' bit from the RailTileType. More... | |
static debug_inline bool | IsRailDepot (Tile t) |
Is this rail tile a rail depot? More... | |
static debug_inline bool | IsRailDepotTile (Tile t) |
Is this tile rail tile and a rail depot? More... | |
RailType | GetRailType (Tile t) |
Gets the rail type of the given tile. More... | |
void | SetRailType (Tile t, RailType r) |
Sets the rail type of the given tile. More... | |
TrackBits | GetTrackBits (Tile tile) |
Gets the track bits of the given tile. More... | |
void | SetTrackBits (Tile t, TrackBits b) |
Sets the track bits of the given tile. More... | |
bool | HasTrack (Tile tile, Track track) |
Returns whether the given track is present on the given tile. More... | |
DiagDirection | GetRailDepotDirection (Tile t) |
Returns the direction the depot is facing to. More... | |
Track | GetRailDepotTrack (Tile t) |
Returns the track of a depot, ignoring direction. More... | |
TrackBits | GetRailReservationTrackBits (Tile t) |
Returns the reserved track bits of the tile. More... | |
void | SetTrackReservation (Tile t, TrackBits b) |
Sets the reserved track bits of the tile. More... | |
bool | TryReserveTrack (Tile tile, Track t) |
Try to reserve a specific track on a tile. More... | |
void | UnreserveTrack (Tile tile, Track t) |
Lift the reservation of a specific track on a tile. More... | |
bool | HasDepotReservation (Tile t) |
Get the reservation state of the depot. More... | |
void | SetDepotReservation (Tile t, bool b) |
Set the reservation state of the depot. More... | |
TrackBits | GetDepotReservationTrackBits (Tile t) |
Get the reserved track bits for a depot. More... | |
bool | IsPbsSignal (SignalType s) |
SignalType | GetSignalType (Tile t, Track track) |
void | SetSignalType (Tile t, Track track, SignalType s) |
bool | IsPresignalEntry (Tile t, Track track) |
bool | IsPresignalExit (Tile t, Track track) |
bool | IsOnewaySignal (Tile t, Track track) |
One-way signals can't be passed the 'wrong' way. | |
void | CycleSignalSide (Tile t, Track track) |
SignalVariant | GetSignalVariant (Tile t, Track track) |
void | SetSignalVariant (Tile t, Track track, SignalVariant v) |
void | SetSignalStates (Tile tile, uint state) |
Set the states of the signals (Along/AgainstTrackDir) More... | |
uint | GetSignalStates (Tile tile) |
Set the states of the signals (Along/AgainstTrackDir) More... | |
SignalState | GetSingleSignalState (Tile t, uint8_t signalbit) |
Get the state of a single signal. More... | |
void | SetPresentSignals (Tile tile, uint signals) |
Set whether the given signals are present (Along/AgainstTrackDir) More... | |
uint | GetPresentSignals (Tile tile) |
Get whether the given signals are present (Along/AgainstTrackDir) More... | |
bool | IsSignalPresent (Tile t, uint8_t signalbit) |
Checks whether the given signals is present. More... | |
bool | HasSignalOnTrack (Tile tile, Track track) |
Checks for the presence of signals (either way) on the given track on the given rail tile. | |
bool | HasSignalOnTrackdir (Tile tile, Trackdir trackdir) |
Checks for the presence of signals along the given trackdir on the given rail tile. More... | |
SignalState | GetSignalStateByTrackdir (Tile tile, Trackdir trackdir) |
Gets the state of the signal along the given trackdir. More... | |
void | SetSignalStateByTrackdir (Tile tile, Trackdir trackdir, SignalState state) |
Sets the state of the signal along the given trackdir. | |
bool | HasPbsSignalOnTrackdir (Tile tile, Trackdir td) |
Is a pbs signal present along the trackdir? More... | |
bool | HasOnewaySignalBlockingTrackdir (Tile tile, Trackdir td) |
Is a one-way signal blocking the trackdir? A one-way signal on the trackdir against will block, but signals on both trackdirs won't. More... | |
RailType | GetTileRailType (Tile tile) |
Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile. | |
void | SetRailGroundType (Tile t, RailGroundType rgt) |
RailGroundType | GetRailGroundType (Tile t) |
bool | IsSnowRailGround (Tile t) |
void | MakeRailNormal (Tile t, Owner o, TrackBits b, RailType r) |
void | SetRailDepotExitDirection (Tile tile, DiagDirection dir) |
Sets the exit direction of a rail depot. More... | |
void | MakeRailDepot (Tile tile, Owner owner, DepotID depot_id, DiagDirection dir, RailType rail_type) |
Make a rail depot. More... | |
Hides the direct accesses to the map array with map accessors.
Definition in file rail_map.h.
enum RailGroundType |
The ground 'under' the rail.
Definition at line 485 of file rail_map.h.
enum RailTileType |
Different types of Rail-related tiles.
Enumerator | |
---|---|
RAIL_TILE_NORMAL | Normal rail tile without signals. |
RAIL_TILE_SIGNALS | Normal rail tile with signals. |
RAIL_TILE_DEPOT | Depot (one entrance) |
Definition at line 23 of file rail_map.h.
Get the reserved track bits for a depot.
t | the tile |
Definition at line 282 of file rail_map.h.
References GetRailDepotTrack(), HasDepotReservation(), TRACK_BIT_NONE, and TrackToTrackBits().
Referenced by FollowTrainReservation(), and GetReservedTrackbits().
|
inline |
Get whether the given signals are present (Along/AgainstTrackDir)
tile | the tile to get the present signals for |
Definition at line 393 of file rail_map.h.
References GB(), and Tile::m3().
Referenced by AfterLoadCompanyStats(), HasSignalOnTrack(), HasSignalOnTrackdir(), and IsSignalPresent().
|
inline |
Returns the direction the depot is facing to.
t | the tile to get the depot facing from |
Definition at line 171 of file rail_map.h.
References GB(), and Tile::m5().
Referenced by CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::CanEnterNewTile(), CmdBuildRailVehicle(), CmdBuildRailWagon(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::ForcedReverse(), GetRailDepotTrack(), Train::GetVehicleTrackdir(), TicksToLeaveDepot(), TrainCanLeaveTile(), TryPathReserve(), and UpdateSignalsInBuffer().
Returns the track of a depot, ignoring direction.
t | the tile to get the depot track from |
Definition at line 182 of file rail_map.h.
References DiagDirToDiagTrack(), and GetRailDepotDirection().
Referenced by AdvanceWagonsAfterSwap(), CmdConvertRail(), and GetDepotReservationTrackBits().
Returns the reserved track bits of the tile.
t | the tile to query |
Definition at line 194 of file rail_map.h.
References GB(), HasBit(), IsPlainRailTile(), Tile::m2(), TRACK_BIT_NONE, TrackToOppositeTrack(), and TrackToTrackBits().
Referenced by GetReservedTrackbits(), TryReserveTrack(), and UnreserveTrack().
|
static |
Returns the RailTileType (normal with or without signals, waypoint or depot).
t | the tile to get the information from |
Definition at line 36 of file rail_map.h.
Referenced by CmdConvertRail(), GetAxisForNewRailWaypoint(), GetRailTrackBitsUniversal(), HasSignalOnTrack(), HasSignalOnTrackdir(), HasSignals(), IsPossibleCrossing(), MoveWaypointsToBaseStations(), and PlaceExtraDepotRail().
Gets the rail type of the given tile.
t | the tile to get the rail type from |
Definition at line 115 of file rail_map.h.
References GB(), and Tile::m8().
Referenced by AfterLoadCompanyStats(), CmdBuildRailVehicle(), CmdBuildRailWagon(), CmdConvertRail(), DrawBridgeMiddle(), DrawTile_Road(), DrawTile_TunnelBridge(), DrawTrackBits(), GetPylonBase(), GetRailTrackBitsUniversal(), GetTileRailType(), GetWireBase(), IsCompatibleTrainStationTile(), and MoveWaypointsToBaseStations().
|
inline |
Gets the state of the signal along the given trackdir.
Along meaning if you are currently driving on the given trackdir, this is the signal that is facing us (for which we stop when it's red).
Definition at line 438 of file rail_map.h.
References GetSignalStates(), HasSignalOnTrack(), IsValidTrackdir(), SIGNAL_STATE_GREEN, SIGNAL_STATE_RED, SignalAlongTrackdir(), and TrackdirToTrack().
Referenced by ExtendTrainReservation(), and CYapfReserveTrack< Types >::ReserveSingleTrack().
|
inline |
Set the states of the signals (Along/AgainstTrackDir)
tile | the tile to set the states for |
Definition at line 362 of file rail_map.h.
References GB(), and Tile::m4().
Referenced by GetSignalStateByTrackdir(), GetSingleSignalState(), and SetSignalStateByTrackdir().
|
inline |
Get the state of a single signal.
t | the tile to get the signal state for |
signalbit | the signal |
Definition at line 373 of file rail_map.h.
References GetSignalStates(), and HasBit().
Gets the track bits of the given tile.
tile | the tile to get the track bits from |
Definition at line 136 of file rail_map.h.
References GB(), IsPlainRailTile(), and Tile::m5().
Referenced by AfterLoadCompanyStats(), CheckTrackCombination(), CmdConvertRail(), GetAxisForNewRailWaypoint(), GetRailTrackBitsUniversal(), HasTrack(), IsPossibleCrossing(), PlaceExtraDepotRail(), and CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::QueryNewTileTrackStatus().
|
inline |
Get the reservation state of the depot.
t | the depot tile |
Definition at line 258 of file rail_map.h.
References HasBit(), IsRailDepot(), and Tile::m5().
Referenced by CheckTrainStayInDepot(), GetDepotReservationTrackBits(), TryPathReserve(), and TryReserveRailTrack().
Is a one-way signal blocking the trackdir? A one-way signal on the trackdir against will block, but signals on both trackdirs won't.
tile | the tile to check |
td | the trackdir to check |
Definition at line 475 of file rail_map.h.
References HasSignalOnTrackdir(), IsOnewaySignal(), IsTileType(), MP_RAILWAY, ReverseTrackdir(), and TrackdirToTrack().
Referenced by ExtendTrainReservation(), FollowReservation(), and GetTrainForReservation().
Is a pbs signal present along the trackdir?
tile | the tile to check |
td | the trackdir to check |
Definition at line 463 of file rail_map.h.
References HasSignalOnTrackdir(), IsTileType(), and MP_RAILWAY.
Referenced by ExtendTrainReservation(), GetTrainForReservation(), and CYapfReserveTrack< Types >::ReserveSingleTrack().
Checks for the presence of signals along the given trackdir on the given rail tile.
Along meaning if you are currently driving on the given trackdir, this is the signal that is facing us (for which we stop when it's red).
Definition at line 426 of file rail_map.h.
References GetPresentSignals(), GetRailTileType(), IsValidTrackdir(), RAIL_TILE_SIGNALS, and SignalAlongTrackdir().
Referenced by FollowReservation(), HasOnewaySignalBlockingTrackdir(), HasPbsSignalOnTrackdir(), IsSafeWaitingPosition(), IsWaitingPositionFree(), and UpdateSignalsAroundSegment().
|
inline |
Checks if a rail tile has signals.
t | the tile to get the information from |
Definition at line 72 of file rail_map.h.
References GetRailTileType(), and RAIL_TILE_SIGNALS.
Referenced by AfterLoadCompanyStats().
Returns whether the given track is present on the given tile.
tile | the tile to check the track presence of |
track | the track to search for on the tile |
Definition at line 160 of file rail_map.h.
References GetTrackBits(), and HasBit().
Referenced by TryReserveRailTrack(), TryReserveTrack(), UnreserveRailTrack(), and UnreserveTrack().
|
static |
Returns whether this is plain rails, with or without signals.
Iow, if this tiles RailTileType is RAIL_TILE_NORMAL or RAIL_TILE_SIGNALS.
t | the tile to get the information from |
Definition at line 49 of file rail_map.h.
Referenced by AfterLoadCompanyStats(), CheckTrackCombination(), DoDryUp(), DoFloodTile(), ExtendTrainReservation(), GetReservedTrackbits(), TryReserveRailTrack(), and UnreserveRailTrack().
|
static |
Checks whether the tile is a rail tile or rail tile with signals.
t | the tile to get the information from |
Definition at line 60 of file rail_map.h.
Referenced by CmdConvertRail(), FixOwnerOfRailTrack(), FloodHalftile(), GetRailReservationTrackBits(), GetTrackBits(), GrowTownWithBridge(), MaskWireBits(), CFollowTrackT< Ttr_type_, VehicleType, T90deg_turns_allowed_, Tmask_reserved_tracks >::QueryNewTileTrackStatus(), SetHasSignals(), SetTrackBits(), and SetTrackReservation().
|
static |
Is this rail tile a rail depot?
t | the tile to get the information from |
Definition at line 95 of file rail_map.h.
Referenced by DrawRailCatenary(), GetReservedTrackbits(), HasDepotReservation(), SetDepotReservation(), TryReserveRailTrack(), UnreserveRailTrack(), and UpdateSignalsInBuffer().
|
static |
Is this tile rail tile and a rail depot?
t | the tile to get the information from |
Definition at line 105 of file rail_map.h.
Referenced by FindClosestTrainDepot(), FollowReservation(), FollowTrainReservation(), GetDepotIndex(), IsDepotTile(), IsSafeWaitingPosition(), IsWaitingPositionFree(), CYapfDestinationAnyDepotRailT< Types >::PfDetectDestination(), ReverseTrainDirection(), SetRailDepotExitDirection(), and TrainCanLeaveTile().
|
inline |
Checks whether the given signals is present.
t | the tile to check on |
signalbit | the signal |
Definition at line 404 of file rail_map.h.
References GetPresentSignals(), and HasBit().
|
inline |
Make a rail depot.
tile | Tile to make a depot on. |
owner | New owner of the depot. |
depot_id | New depot ID. |
dir | Direction of the depot exit. |
rail_type | Rail type of the depot. |
Definition at line 552 of file rail_map.h.
References Tile::m2(), Tile::m3(), Tile::m4(), Tile::m5(), Tile::m6(), Tile::m7(), Tile::m8(), MP_RAILWAY, RAIL_TILE_DEPOT, SB(), SetDockingTile(), SetTileOwner(), and SetTileType().
|
inline |
Set the reservation state of the depot.
t | the depot tile |
b | the reservation state |
Definition at line 270 of file rail_map.h.
References AssignBit(), IsRailDepot(), and Tile::m5().
Referenced by TryPathReserve(), TryReserveRailTrack(), UnreserveRailTrack(), and VehicleEnterDepot().
|
inline |
Add/remove the 'has signal' bit from the RailTileType.
tile | the tile to add/remove the signals to/from |
signals | whether the rail tile should have signals or not |
Definition at line 83 of file rail_map.h.
References AssignBit(), IsPlainRailTile(), and Tile::m5().
|
inline |
Set whether the given signals are present (Along/AgainstTrackDir)
tile | the tile to set the present signals for |
signals | the signals that have to be present |
Definition at line 383 of file rail_map.h.
References Tile::m3(), and SB().
|
inline |
Sets the exit direction of a rail depot.
tile | Tile of the depot. |
dir | Direction of the depot exit. |
Definition at line 538 of file rail_map.h.
References IsRailDepotTile(), Tile::m5(), and SB().
Sets the rail type of the given tile.
t | the tile to set the rail type of |
r | the new rail type for the tile |
Definition at line 125 of file rail_map.h.
References Tile::m8(), and SB().
Referenced by CmdConvertRail(), MakeRailBridgeRamp(), and MakeRailTunnel().
|
inline |
Set the states of the signals (Along/AgainstTrackDir)
tile | the tile to set the states for |
state | the new state |
Definition at line 352 of file rail_map.h.
References Tile::m4(), and SB().
Referenced by SetSignalStateByTrackdir().
Sets the track bits of the given tile.
t | the tile to set the track bits of |
b | the new track bits for the tile |
Definition at line 147 of file rail_map.h.
References IsPlainRailTile(), Tile::m5(), and SB().
Sets the reserved track bits of the tile.
t | the tile to change |
b | the track bits |
Definition at line 209 of file rail_map.h.
References AssignBit(), INVALID_TRACK, INVALID_TRACK_BIT, IsPlainRailTile(), Tile::m2(), RemoveFirstTrack(), SB(), TRACK_BIT_NONE, and TracksOverlap().
Referenced by TryReserveTrack(), and UnreserveTrack().
Try to reserve a specific track on a tile.
tile | the tile |
t | the rack to reserve |
Definition at line 226 of file rail_map.h.
References GetRailReservationTrackBits(), HasTrack(), SetTrackReservation(), TRACK_BIT_NONE, TracksOverlap(), and TrackToTrackBits().
Referenced by TryReserveRailTrack().
Lift the reservation of a specific track on a tile.
tile | the tile |
t | the track to free |
Definition at line 244 of file rail_map.h.
References GetRailReservationTrackBits(), HasTrack(), SetTrackReservation(), and TrackToTrackBits().
Referenced by UnreserveRailTrack().