summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorterkhen <terkhen@openttd.org>2011-01-14 11:55:40 +0000
committerterkhen <terkhen@openttd.org>2011-01-14 11:55:40 +0000
commit998246430aec028eb78b30c187bf872ea521c0f5 (patch)
treecd8485634e675f033da6e7c4ef36bdca57bfbc20
parente8e535f58c74c47de40df3aad32f1857e438ec9f (diff)
downloadopenttd-998246430aec028eb78b30c187bf872ea521c0f5.tar.xz
(svn r21776) -Codechange: Give a more appropriate name to the road connection function.
-Document: Add doxygen comments to the function.
-rw-r--r--src/road_gui.cpp13
-rw-r--r--src/road_gui.h1
2 files changed, 10 insertions, 4 deletions
diff --git a/src/road_gui.cpp b/src/road_gui.cpp
index eda9c95df..520da319e 100644
--- a/src/road_gui.cpp
+++ b/src/road_gui.cpp
@@ -135,7 +135,12 @@ static const RoadTypeInfo _road_type_infos[] = {
},
};
-static void BuildRoadOutsideStation(TileIndex tile, DiagDirection direction)
+/**
+ * If required, connects a new structure to an existing road or tram by building the missing roadbit.
+ * @param tile Tile containing the structure to connect.
+ * @param direction Direction to check.
+ */
+void ConnectRoadToStructure(TileIndex tile, DiagDirection direction)
{
tile += TileOffsByDiagDir(direction);
/* if there is a roadpiece just outside of the station entrance, build a connecting route */
@@ -153,7 +158,7 @@ void CcRoadDepot(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2
DiagDirection dir = (DiagDirection)GB(p1, 0, 2);
SndPlayTileFx(SND_1F_SPLAT, tile);
if (!_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
- BuildRoadOutsideStation(tile, dir);
+ ConnectRoadToStructure(tile, dir);
}
/**
@@ -179,9 +184,9 @@ void CcRoadStop(const CommandCost &result, TileIndex tile, uint32 p1, uint32 p2)
if (!_settings_client.gui.persistent_buildingtools) ResetObjectToPlace();
TileArea roadstop_area(tile, GB(p1, 0, 8), GB(p1, 8, 8));
TILE_AREA_LOOP(cur_tile, roadstop_area) {
- BuildRoadOutsideStation(cur_tile, dir);
+ ConnectRoadToStructure(cur_tile, dir);
/* For a drive-through road stop build connecting road for other entrance. */
- if (HasBit(p2, 1)) BuildRoadOutsideStation(cur_tile, ReverseDiagDir(dir));
+ if (HasBit(p2, 1)) ConnectRoadToStructure(cur_tile, ReverseDiagDir(dir));
}
}
diff --git a/src/road_gui.h b/src/road_gui.h
index 929610dde..a2c1ae6b2 100644
--- a/src/road_gui.h
+++ b/src/road_gui.h
@@ -16,5 +16,6 @@
struct Window *ShowBuildRoadToolbar(RoadType roadtype);
struct Window *ShowBuildRoadScenToolbar();
+void ConnectRoadToStructure(TileIndex tile, DiagDirection direction);
#endif /* ROAD_GUI_H */