summaryrefslogtreecommitdiff
path: root/src/road_map.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/road_map.cpp')
-rw-r--r--src/road_map.cpp16
1 files changed, 16 insertions, 0 deletions
diff --git a/src/road_map.cpp b/src/road_map.cpp
index e995f17f2..2c24582ee 100644
--- a/src/road_map.cpp
+++ b/src/road_map.cpp
@@ -14,6 +14,22 @@
#include "tunnelbridge_map.h"
+/**
+ * Returns the RoadBits on an arbitrary tile
+ * Special behaviour:
+ * - road depots: entrance is treated as road piece
+ * - road tunnels: entrance is treated as road piece
+ * - bridge ramps: start of the ramp is treated as road piece
+ * - bridge middle parts: bridge itself is ignored
+ *
+ * If straight_tunnel_bridge_entrance is set a ROAD_X or ROAD_Y
+ * for bridge ramps and tunnel entrances is returned depending
+ * on the orientation of the tunnel or bridge.
+ * @param tile the tile to get the road bits for
+ * @param rt the road type to get the road bits form
+ * @param straight_tunnel_bridge_entrance whether to return straight road bits for tunnels/bridges.
+ * @return the road bits of the given tile
+ */
RoadBits GetAnyRoadBits(TileIndex tile, RoadType rt, bool straight_tunnel_bridge_entrance)
{
if (!HasTileRoadType(tile, rt)) return ROAD_NONE;