Mercurial > hg > openttd

diff src/script/api/script_rail.hpp @ 20658:2177d4fcd67f draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r25614) -Fix [FS#5651]: [Script] Give a slightly less generic error when removing inexisting rail -Fix [FS#5650]: [Script] Be more specific that a non-NewGRF station can be built when asking for a NewGRF station
author rubidium <rubidium@openttd.org>
date Mon, 15 Jul 2013 18:19:26 +0000 (2013-07-15)
parents 0dba7f49118c
children
line wrap: on
line diff
--- a/src/script/api/script_rail.hpp
+++ b/src/script/api/script_rail.hpp
@@ -32,8 +32,8 @@
 		/** One-way roads cannot have crossings */
 		ERR_CROSSING_ON_ONEWAY_ROAD,       // [STR_ERROR_CROSSING_ON_ONEWAY_ROAD]
 
-		/** Track not suitable for signals */
-		ERR_UNSUITABLE_TRACK,              // [STR_ERROR_NO_SUITABLE_RAILROAD_TRACK]
+		/** No suitable track could be found */
+		ERR_UNSUITABLE_TRACK,              // [STR_ERROR_NO_SUITABLE_RAILROAD_TRACK, STR_ERROR_THERE_IS_NO_RAILROAD_TRACK, STR_ERROR_THERE_ARE_NO_SIGNALS, STR_ERROR_THERE_IS_NO_STATION]
 
 		/** This railtype cannot have crossings */
 		ERR_RAILTYPE_DISALLOWS_CROSSING,   // [STR_ERROR_CROSSING_DISALLOWED]
@@ -268,6 +268,9 @@
 	 * Build a NewGRF rail station. This calls callback 18 to let a NewGRF
 	 *  provide the station class / id to build, so we don't end up with
 	 *  only the default stations on the map.
+	 * When no NewGRF provides a rail station, or an unbuildable rail station is
+	 *  returned by a NewGRF, this function will fall back to building a default
+	 *  non-NewGRF station as if ScriptRail::BuildRailStation was called.
 	 * @param tile Place to build the station.
 	 * @param direction The direction to build the station.
 	 * @param num_platforms The number of platforms to build.
@@ -319,6 +322,7 @@
 	 * @pre IsValidTile(tile).
 	 * @pre IsValidTile(tile2).
 	 * @game @pre Valid ScriptCompanyMode active in scope.
+	 * @exception ScriptRail::ERR_UNSUITABLE_TRACK
 	 * @return Whether at least one tile has been/can be cleared or not.
 	 */
 	static bool RemoveRailWaypointTileRectangle(TileIndex tile, TileIndex tile2, bool keep_rail);
@@ -331,6 +335,7 @@
 	 * @pre IsValidTile(tile).
 	 * @pre IsValidTile(tile2).
 	 * @game @pre Valid ScriptCompanyMode active in scope.
+	 * @exception ScriptRail::ERR_UNSUITABLE_TRACK
 	 * @return Whether at least one tile has been/can be cleared or not.
 	 */
 	static bool RemoveRailStationTileRectangle(TileIndex tile, TileIndex tile2, bool keep_rail);
@@ -369,6 +374,7 @@
 	 * @pre ScriptMap::IsValidTile(tile).
 	 * @pre (GetRailTracks(tile) & rail_track) != 0.
 	 * @game @pre Valid ScriptCompanyMode active in scope.
+	 * @exception ScriptRail::ERR_UNSUITABLE_TRACK
 	 * @return Whether the rail has been/can be removed or not.
 	 * @note You can only remove a single track with this function so do not
 	 *   use the values from RailTrack as bitmask.
@@ -424,6 +430,7 @@
 	 *      (ScriptMap::GetTileX(from) == ScriptMap::GetTileX(tile) && ScriptMap::GetTileX(tile) == ScriptMap::GetTileX(to)) ||
 	 *      (ScriptMap::GetTileY(from) == ScriptMap::GetTileY(tile) && ScriptMap::GetTileY(tile) == ScriptMap::GetTileY(to)).
 	 * @game @pre Valid ScriptCompanyMode active in scope.
+	 * @exception ScriptRail::ERR_UNSUITABLE_TRACK
 	 * @return Whether the rail has been/can be removed or not.
 	 */
 	static bool RemoveRail(TileIndex from, TileIndex tile, TileIndex to);
@@ -457,6 +464,7 @@
 	 * @pre ScriptMap::DistanceManhattan(tile, front) == 1.
 	 * @pre GetSignalType(tile, front) != SIGNALTYPE_NONE.
 	 * @game @pre Valid ScriptCompanyMode active in scope.
+	 * @exception ScriptRail::ERR_UNSUITABLE_TRACK
 	 * @return Whether the signal has been/can be removed or not.
 	 */
 	static bool RemoveSignal(TileIndex tile, TileIndex front);