Enumerations | Functions

rail_map.h File Reference

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 "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  SignalState { SIGNAL_STATE_RED = 0, SIGNAL_STATE_GREEN = 1, SIGNAL_STATE_MAX = SIGNAL_STATE_GREEN }
 

These are states in which a signal can be.

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 RailTileType GetRailTileType (TileIndex t)
 Returns the RailTileType (normal with or without signals, waypoint or depot).
static bool IsPlainRail (TileIndex t)
 Returns whether this is plain rails, with or without signals.
static bool IsPlainRailTile (TileIndex t)
 Checks whether the tile is a rail tile or rail tile with signals.
static bool HasSignals (TileIndex t)
 Checks if a rail tile has signals.
static void SetHasSignals (TileIndex tile, bool signals)
 Add/remove the 'has signal' bit from the RailTileType.
static bool IsRailDepot (TileIndex t)
 Is this rail tile a rail depot?
static bool IsRailDepotTile (TileIndex t)
 Is this tile rail tile and a rail depot?
static RailType GetRailType (TileIndex t)
 Gets the rail type of the given tile.
static void SetRailType (TileIndex t, RailType r)
 Sets the rail type of the given tile.
static TrackBits GetTrackBits (TileIndex tile)
 Gets the track bits of the given tile.
static void SetTrackBits (TileIndex t, TrackBits b)
 Sets the track bits of the given tile.
static bool HasTrack (TileIndex tile, Track track)
 Returns whether the given track is present on the given tile.
static DiagDirection GetRailDepotDirection (TileIndex t)
 Returns the direction the depot is facing to.
static Track GetRailDepotTrack (TileIndex t)
 Returns the track of a depot, ignoring direction.
static TrackBits GetRailReservationTrackBits (TileIndex t)
 Returns the reserved track bits of the tile.
static void SetTrackReservation (TileIndex t, TrackBits b)
 Sets the reserved track bits of the tile.
static bool TryReserveTrack (TileIndex tile, Track t)
 Try to reserve a specific track on a tile.
static void UnreserveTrack (TileIndex tile, Track t)
 Lift the reservation of a specific track on a tile.
static bool HasDepotReservation (TileIndex t)
 Get the reservation state of the depot.
static void SetDepotReservation (TileIndex t, bool b)
 Set the reservation state of the depot.
static TrackBits GetDepotReservationTrackBits (TileIndex t)
 Get the reserved track bits for a depot.
static SignalType GetSignalType (TileIndex t, Track track)
static void SetSignalType (TileIndex t, Track track, SignalType s)
static bool IsPresignalEntry (TileIndex t, Track track)
static bool IsPresignalExit (TileIndex t, Track track)
static bool IsPresignalCombo (TileIndex t, Track track)
static bool IsPresignalProgrammable (TileIndex t, Track track)
static bool IsSpeedSignal (TileIndex t, Track track)
static bool IsOnewaySignal (TileIndex t, Track track)
 One-way signals can't be passed the 'wrong' way.
static void CycleSignalSide (TileIndex t, Track track)
static SignalVariant GetSignalVariant (TileIndex t, Track track)
static void SetSignalVariant (TileIndex t, Track track, SignalVariant v)
static void SetSignalStates (TileIndex tile, uint state)
 Set the states of the signals (Along/AgainstTrackDir).
static uint GetSignalStates (TileIndex tile)
 Set the states of the signals (Along/AgainstTrackDir).
static SignalState GetSingleSignalState (TileIndex t, byte signalbit)
 Get the state of a single signal.
static void SetPresentSignals (TileIndex tile, uint signals)
 Set whether the given signals are present (Along/AgainstTrackDir).
static uint GetPresentSignals (TileIndex tile)
 Get whether the given signals are present (Along/AgainstTrackDir).
static bool IsSignalPresent (TileIndex t, byte signalbit)
 Checks whether the given signals is present.
static bool HasSignalOnTrack (TileIndex tile, Track track)
 Checks for the presence of signals (either way) on the given track on the given rail tile.
static bool HasSignalOnTrackdir (TileIndex tile, Trackdir trackdir)
 Checks for the presence of signals along the given trackdir on the given rail tile.
static SignalState GetSignalStateByTrackdir (TileIndex tile, Trackdir trackdir)
 Gets the state of the signal along the given trackdir.
static void SetSignalStateByTrackdir (TileIndex tile, Trackdir trackdir, SignalState state)
 Sets the state of the signal along the given trackdir.
static bool HasPbsSignalOnTrackdir (TileIndex tile, Trackdir td)
 Is a pbs signal present along the trackdir?
static bool HasOnewaySignalBlockingTrackdir (TileIndex 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.
RailType GetTileRailType (TileIndex tile)
 Return the rail type of tile, or INVALID_RAILTYPE if this is no rail tile.
static void SetRailGroundType (TileIndex t, RailGroundType rgt)
static RailGroundType GetRailGroundType (TileIndex t)
static bool IsSnowRailGround (TileIndex t)
static void MakeRailNormal (TileIndex t, Owner o, TrackBits b, RailType r)
static void MakeRailDepot (TileIndex t, Owner o, DepotID did, DiagDirection d, RailType r)
static void IncreaseStuckCounter (TileIndex t)
static void ReduceStuckCounter (TileIndex t)
static byte GetStuckCounter (TileIndex t)

Detailed Description

Hides the direct accesses to the map array with map accessors.

Definition in file rail_map.h.


Enumeration Type Documentation

The ground 'under' the rail.

Enumerator:
RAIL_GROUND_BARREN 

Nothing (dirt).

RAIL_GROUND_GRASS 

Grassy.

RAIL_GROUND_FENCE_NW 

Grass with a fence at the NW edge.

RAIL_GROUND_FENCE_SE 

Grass with a fence at the SE edge.

RAIL_GROUND_FENCE_SENW 

Grass with a fence at the NW and SE edges.

RAIL_GROUND_FENCE_NE 

Grass with a fence at the NE edge.

RAIL_GROUND_FENCE_SW 

Grass with a fence at the SW edge.

RAIL_GROUND_FENCE_NESW 

Grass with a fence at the NE and SW edges.

RAIL_GROUND_FENCE_VERT1 

Grass with a fence at the eastern side.

RAIL_GROUND_FENCE_VERT2 

Grass with a fence at the western side.

RAIL_GROUND_FENCE_HORIZ1 

Grass with a fence at the southern side.

RAIL_GROUND_FENCE_HORIZ2 

Grass with a fence at the northern side.

RAIL_GROUND_ICE_DESERT 

Icy or sandy.

RAIL_GROUND_WATER 

Grass with a fence and shore or water on the free halftile.

RAIL_GROUND_HALF_SNOW 

Snow only on higher part of slope (steep or one corner raised).

Definition at line 505 of file rail_map.h.

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 24 of file rail_map.h.

These are states in which a signal can be.

Currently these are only two, so simple boolean logic will do. But do try to compare to this enum instead of normal boolean evaluation, since that will make future additions easier.

Enumerator:
SIGNAL_STATE_RED 

The signal is red.

SIGNAL_STATE_GREEN 

The signal is green.

Definition at line 361 of file rail_map.h.


Function Documentation

static TrackBits GetDepotReservationTrackBits ( TileIndex  t  )  [inline, static]

Get the reserved track bits for a depot.

Precondition:
IsRailDepot(t)
Parameters:
t the tile
Returns:
reserved track bits

Definition at line 281 of file rail_map.h.

References GetRailDepotTrack(), HasDepotReservation(), and TrackToTrackBits().

Referenced by FollowTrainReservation(), and GetReservedTrackbits().

static uint GetPresentSignals ( TileIndex  tile  )  [inline, static]

Get whether the given signals are present (Along/AgainstTrackDir).

Parameters:
tile the tile to get the present signals for
Returns:
the signals that are present

Definition at line 414 of file rail_map.h.

References _m, and GB().

Referenced by CmdBuildSingleSignal(), CmdRemoveSingleSignal(), CmdSignalTrackHelper(), HasSignalOnTrack(), HasSignalOnTrackdir(), and IsSignalPresent().

static DiagDirection GetRailDepotDirection ( TileIndex  t  )  [inline, static]

Returns the direction the depot is facing to.

Parameters:
t the tile to get the depot facing from
Precondition:
IsRailDepotTile(t)
Returns:
the direction the depot is facing

Definition at line 171 of file rail_map.h.

References _m, and GB().

Referenced by CmdBuildRailVehicle(), CmdBuildRailWagon(), DrawCatenary(), ExploreSegment(), GetDepotDirection(), AIRail::GetRailDepotFrontTile(), GetRailDepotTrack(), Train::GetVehicleTrackdir(), TicksToLeaveDepot(), TrainCanLeaveTile(), TryPathReserve(), UpdateSignalsInBuffer(), and VehicleEnter_Track().

static Track GetRailDepotTrack ( TileIndex  t  )  [inline, static]

Returns the track of a depot, ignoring direction.

Precondition:
IsRailDepotTile(t)
Parameters:
t the tile to get the depot track from
Returns:
the track of the depot

Definition at line 182 of file rail_map.h.

References DiagDirToDiagTrack(), and GetRailDepotDirection().

Referenced by AdvanceWagonsAfterSwap(), CmdConvertRail(), and GetDepotReservationTrackBits().

static TrackBits GetRailReservationTrackBits ( TileIndex  t  )  [inline, static]

Returns the reserved track bits of the tile.

Precondition:
IsPlainRailTile(t)
Parameters:
t the tile to query
Returns:
the track bits

Definition at line 193 of file rail_map.h.

References _m, GB(), HasBit(), IsPlainRailTile(), TrackToOppositeTrack(), and TrackToTrackBits().

Referenced by CheckFlatLandRailStation(), CmdBuildRailWaypoint(), CmdBuildRoad(), CmdBuildSingleSignal(), CmdRemoveSingleRail(), DrawTrackBits(), GetReservedTrackbits(), TryReserveTrack(), and UnreserveTrack().

static RailTileType GetRailTileType ( TileIndex  t  )  [inline, static]

Returns the RailTileType (normal with or without signals, waypoint or depot).

Parameters:
t the tile to get the information from
Precondition:
IsTileType(t, MP_RAILWAY)
Returns:
the RailTileType

Definition at line 37 of file rail_map.h.

References _m, GB(), IsTileType(), and MP_RAILWAY.

Referenced by CmdBuildRoad(), CmdConvertRail(), CopyPaste::CopyArea(), GetAxisForNewWaypoint(), GetRailTrackBitsUniversal(), HasSignalOnTrack(), HasSignalOnTrackdir(), HasSignals(), IsPlainRail(), IsPossibleCrossing(), IsRailDepot(), MoveWaypointsToBaseStations(), and PlaceExtraDepotRail().

static RailType GetRailType ( TileIndex  t  )  [inline, static]
static SignalState GetSignalStateByTrackdir ( TileIndex  tile,
Trackdir  trackdir 
) [inline, static]

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 459 of file rail_map.h.

References GetSignalStates(), HasSignalOnTrack(), IsValidTrackdir(), SIGNAL_STATE_GREEN, SignalAlongTrackdir(), and TrackdirToTrack().

Referenced by CheckNextTrainTile(), ExploreSegment(), FreeTrainTrackReservation(), CYapfCostRailT< Types >::PfCalcCost(), and UpdateSignalsAroundSegment().

static uint GetSignalStates ( TileIndex  tile  )  [inline, static]

Set the states of the signals (Along/AgainstTrackDir).

Parameters:
tile the tile to set the states for
Returns:
the state of the signals

Definition at line 383 of file rail_map.h.

References _m, and GB().

Referenced by CmdBuildSingleSignal(), GetSignalStateByTrackdir(), GetSingleSignalState(), and SetSignalStateByTrackdir().

static SignalState GetSingleSignalState ( TileIndex  t,
byte  signalbit 
) [inline, static]

Get the state of a single signal.

Parameters:
t the tile to get the signal state for
signalbit the signal
Returns:
the state of the signal

Definition at line 394 of file rail_map.h.

References GetSignalStates(), and HasBit().

static TrackBits GetTrackBits ( TileIndex  tile  )  [inline, static]
static bool HasDepotReservation ( TileIndex  t  )  [inline, static]

Get the reservation state of the depot.

Precondition:
IsRailDepot(t)
Parameters:
t the depot tile
Returns:
reservation state

Definition at line 257 of file rail_map.h.

References _m, HasBit(), and IsRailDepot().

Referenced by GetDepotReservationTrackBits(), TryPathReserve(), and TryReserveRailTrack().

static bool HasOnewaySignalBlockingTrackdir ( TileIndex  tile,
Trackdir  td 
) [inline, static]

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.

Parameters:
tile the tile to check
td the trackdir to check

Definition at line 496 of file rail_map.h.

References HasSignalOnTrackdir(), IsOnewaySignal(), IsSpeedSignal(), IsTileType(), MP_RAILWAY, ReverseTrackdir(), and TrackdirToTrack().

Referenced by ExtendTrainReservation(), FollowReservation(), GetTrainForReservation(), and CYapfCostRailT< Types >::PfCalcCost().

static bool HasPbsSignalOnTrackdir ( TileIndex  tile,
Trackdir  td 
) [inline, static]

Is a pbs signal present along the trackdir?

Parameters:
tile the tile to check
td the trackdir to check

Definition at line 484 of file rail_map.h.

References HasSignalOnTrackdir(), IsPbsSignal(), IsTileType(), MP_RAILWAY, and TrackdirToTrack().

Referenced by CheckNextTrainTile(), FreeTrainTrackReservation(), GetTrainForReservation(), IsSafeWaitingPosition(), and CYapfCostRailT< Types >::PfCalcCost().

static bool HasSignalOnTrackdir ( TileIndex  tile,
Trackdir  trackdir 
) [inline, static]

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 447 of file rail_map.h.

References GetPresentSignals(), GetRailTileType(), IsValidTrackdir(), RAIL_TILE_SIGNALS, and SignalAlongTrackdir().

Referenced by CheckNextTrainTile(), CmdModifySignalInstruction(), CmdRemoveSingleSignal(), CopyPaste::CopyArea(), ExploreSegment(), FollowReservation(), FreeTrainTrackReservation(), AIRail::GetSignalType(), HasOnewaySignalBlockingTrackdir(), HasPbsSignalOnTrackdir(), IsSafeWaitingPosition(), IsWaitingPositionFree(), ProgramWindow::OnPlaceObject(), CYapfCostRailT< Types >::PfCalcCost(), and UpdateSignalsAroundSegment().

static bool HasSignals ( TileIndex  t  )  [inline, static]

Checks if a rail tile has signals.

Parameters:
t the tile to get the information from
Precondition:
IsTileType(t, MP_RAILWAY)
Returns:
true if and only if the tile has signals

Definition at line 73 of file rail_map.h.

References GetRailTileType().

Referenced by AfterLoadGame(), CheckFlatLandRailStation(), CheckRemoveSignalsFromTile(), CheckTrackCombination(), CmdBuildSingleSignal(), ExploreSegment(), AIRail::GetSignalType(), and UpdateAllBlockSignals().

static bool HasTrack ( TileIndex  tile,
Track  track 
) [inline, static]

Returns whether the given track is present on the given tile.

Parameters:
tile the tile to check the track presence of
track the track to search for on the tile
Precondition:
IsPlainRailTile(tile)
Returns:
true if and only if the given track exists on the tile

Definition at line 160 of file rail_map.h.

References GetTrackBits(), and HasBit().

Referenced by CmdBuildSingleSignal(), CmdInsertSignalInstruction(), CmdModifySignalInstruction(), CmdRemoveSignalInstruction(), CmdRemoveSingleSignal(), CmdSetSignalSpeedLimit(), CmdSignalTrackHelper(), CopyPaste::CopyArea(), GenericPlaceSignals(), TryReserveTrack(), and UnreserveTrack().

static bool IsOnewaySignal ( TileIndex  t,
Track  track 
) [inline, static]

One-way signals can't be passed the 'wrong' way.

Definition at line 327 of file rail_map.h.

References SIGTYPE_PBS.

Referenced by ExploreSegment(), FreeTrainTrackReservation(), and HasOnewaySignalBlockingTrackdir().

static bool IsPlainRail ( TileIndex  t  )  [inline, static]

Returns whether this is plain rails, with or without signals.

Iow, if this tiles RailTileType is RAIL_TILE_NORMAL or RAIL_TILE_SIGNALS.

Parameters:
t the tile to get the information from
Precondition:
IsTileType(t, MP_RAILWAY)
Returns:
true if and only if the tile is normal rail (with or without signals)

Definition at line 50 of file rail_map.h.

References GetRailTileType(), and RAIL_TILE_NORMAL.

Referenced by AfterLoadGame(), CheckTrackCombination(), CmdBuildBridge(), CmdBuildSingleRail(), CmdRemoveSingleRail(), DoDryUp(), DoFloodTile(), ExtendTrainReservation(), GetReservedTrackbits(), IsPlainRailTile(), IsWateredTile(), TryReserveRailTrack(), and UnreserveRailTrack().

static bool IsPlainRailTile ( TileIndex  t  )  [inline, static]
static bool IsRailDepot ( TileIndex  t  )  [inline, static]

Is this rail tile a rail depot?

Parameters:
t the tile to get the information from
Precondition:
IsTileType(t, MP_RAILWAY)
Returns:
true if and only if the tile is a rail depot

Definition at line 96 of file rail_map.h.

References GetRailTileType().

Referenced by AfterLoadGame(), AIVehicleList_Depot::AIVehicleList_Depot(), DrawCatenary(), ExploreSegment(), GetOrderTypeByTile(), GetReservedTrackbits(), HasDepotReservation(), IsRailDepotTile(), AIRail::IsRailTile(), NPFMarkTile(), CYapfCostRailT< Types >::PfCalcCost(), SetDepotReservation(), TryReserveRailTrack(), UnreserveRailTrack(), and UpdateSignalsInBuffer().

static bool IsRailDepotTile ( TileIndex  t  )  [inline, static]
static bool IsSignalPresent ( TileIndex  t,
byte  signalbit 
) [inline, static]

Checks whether the given signals is present.

Parameters:
t the tile to check on
signalbit the signal
Returns:
true if and only if the signal is present

Definition at line 425 of file rail_map.h.

References GetPresentSignals(), and HasBit().

static void SetDepotReservation ( TileIndex  t,
bool  b 
) [inline, static]

Set the reservation state of the depot.

Precondition:
IsRailDepot(t)
Parameters:
t the depot tile
b the reservation state

Definition at line 269 of file rail_map.h.

References _m, IsRailDepot(), and SB().

Referenced by AfterLoadGame(), TryPathReserve(), TryReserveRailTrack(), UnreserveRailTrack(), and VehicleEnterDepot().

static void SetHasSignals ( TileIndex  tile,
bool  signals 
) [inline, static]

Add/remove the 'has signal' bit from the RailTileType.

Parameters:
tile the tile to add/remove the signals to/from
signals whether the rail tile should have signals or not
Precondition:
IsPlainRailTile(tile)

Definition at line 84 of file rail_map.h.

References _m, IsPlainRailTile(), and SB().

Referenced by CmdBuildSingleSignal(), and CmdRemoveSingleSignal().

static void SetPresentSignals ( TileIndex  tile,
uint  signals 
) [inline, static]

Set whether the given signals are present (Along/AgainstTrackDir).

Parameters:
tile the tile to set the present signals for
signals the signals that have to be present

Definition at line 404 of file rail_map.h.

References _m, and SB().

Referenced by CmdBuildSingleSignal(), and CmdRemoveSingleSignal().

static void SetRailType ( TileIndex  t,
RailType  r 
) [inline, static]

Sets the rail type of the given tile.

Parameters:
t the tile to set the rail type of
r the new rail type for the tile

Definition at line 126 of file rail_map.h.

References _m, and SB().

Referenced by AfterLoadGame(), CmdConvertRail(), MakeRailStation(), and MakeRailWaypoint().

static void SetSignalStates ( TileIndex  tile,
uint  state 
) [inline, static]

Set the states of the signals (Along/AgainstTrackDir).

Parameters:
tile the tile to set the states for
state the new state

Definition at line 373 of file rail_map.h.

References _m, and SB().

Referenced by AfterLoadGame(), CmdBuildSingleSignal(), CmdRemoveSingleSignal(), and SetSignalStateByTrackdir().

static void SetTrackBits ( TileIndex  t,
TrackBits  b 
) [inline, static]

Sets the track bits of the given tile.

Parameters:
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 _m, IsPlainRailTile(), and SB().

Referenced by CmdBuildSingleRail(), and CmdRemoveSingleRail().

static void SetTrackReservation ( TileIndex  t,
TrackBits  b 
) [inline, static]

Sets the reserved track bits of the tile.

Precondition:
IsPlainRailTile(t) && !TracksOverlap(b)
Parameters:
t the tile to change
b the track bits

Definition at line 208 of file rail_map.h.

References _m, INVALID_TRACK, INVALID_TRACK_BIT, IsPlainRailTile(), RemoveFirstTrack(), SB(), TRACK_BIT_NONE, and TracksOverlap().

Referenced by AfterLoadGame(), CmdRemoveSingleRail(), RemoveRoad(), TryReserveTrack(), and UnreserveTrack().

static bool TryReserveTrack ( TileIndex  tile,
Track  t 
) [inline, static]

Try to reserve a specific track on a tile.

Precondition:
IsPlainRailTile(t) && HasTrack(tile, t)
Parameters:
tile the tile
t the rack to reserve
Returns:
true if successful

Definition at line 225 of file rail_map.h.

References GetRailReservationTrackBits(), HasTrack(), SetTrackReservation(), TRACK_BIT_NONE, TracksOverlap(), and TrackToTrackBits().

Referenced by TryReserveRailTrack().

static void UnreserveTrack ( TileIndex  tile,
Track  t 
) [inline, static]

Lift the reservation of a specific track on a tile.

Precondition:
IsPlainRailTile(t) && HasTrack(tile, t)
Parameters:
tile the tile
t the track to free

Definition at line 243 of file rail_map.h.

References GetRailReservationTrackBits(), HasTrack(), SetTrackReservation(), and TrackToTrackBits().

Referenced by UnreserveRailTrack().