diff options
author | rubidium <rubidium@openttd.org> | 2007-04-03 21:51:40 +0000 |
---|---|---|
committer | rubidium <rubidium@openttd.org> | 2007-04-03 21:51:40 +0000 |
commit | a403f32e5978cc9a9e72c623c4d5c618fce77b10 (patch) | |
tree | ea9b531b01e420c159b56459136ac0d87c81faf7 /src/road_map.h | |
parent | d2634aaeec98456390a4052503853117a17bbb89 (diff) | |
download | openttd-a403f32e5978cc9a9e72c623c4d5c618fce77b10.tar.xz |
(svn r9554) -Documentation: add documentation to some map accessors.
Diffstat (limited to 'src/road_map.h')
-rw-r--r-- | src/road_map.h | 13 |
1 files changed, 11 insertions, 2 deletions
diff --git a/src/road_map.h b/src/road_map.h index 6385b0cc8..88e0a0295 100644 --- a/src/road_map.h +++ b/src/road_map.h @@ -173,10 +173,19 @@ static inline DiagDirection GetRoadDepotDirection(TileIndex t) * - 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 + * @param tile the tile to get the road bits for + * @return the road bits of the given tile */ -RoadBits GetAnyRoadBits(TileIndex); - +RoadBits GetAnyRoadBits(TileIndex tile); +/** + * Get the accessible track bits for the given tile. + * Special behaviour: + * - road depots: no track bits + * - non-drive-through stations: no track bits + * @param tile the tile to get the track bits for + * @return the track bits for the given tile + */ TrackBits GetAnyRoadTrackBits(TileIndex tile); |