Codefix: [Script] Mention ScriptError::ERR_STATION_TOO_SPREAD_OUT in API doc (#14562)

This commit is contained in:
Loïc Guilloux
2025-08-31 17:18:51 +02:00
committed by GitHub
parent 80666a0d51
commit 4b9afbe35b
4 changed files with 8 additions and 1 deletions

View File

@@ -263,6 +263,7 @@ public:
* @exception ScriptStation::ERR_STATION_TOO_MANY_STATIONS
* @exception ScriptStation::ERR_STATION_TOO_MANY_STATIONS_IN_TOWN
* @exception ScriptError::ERR_BRIDGE_TOO_LOW
* @exception ScriptError::ERR_STATION_TOO_SPREAD_OUT
* @return Whether the station has been/can be build or not.
*/
static bool BuildRailStation(TileIndex tile, RailTrack direction, SQInteger num_platforms, SQInteger platform_length, StationID station_id);
@@ -301,6 +302,7 @@ public:
* @exception ScriptStation::ERR_STATION_TOO_MANY_STATIONS
* @exception ScriptStation::ERR_STATION_TOO_MANY_STATIONS_IN_TOWN
* @exception ScriptError::ERR_BRIDGE_TOO_LOW
* @exception ScriptError::ERR_STATION_TOO_SPREAD_OUT
* @return Whether the station has been/can be build or not.
*/
static bool BuildNewGRFRailStation(TileIndex tile, RailTrack direction, SQInteger num_platforms, SQInteger platform_length, StationID station_id, CargoType cargo_type, IndustryType source_industry, IndustryType goal_industry, SQInteger distance, bool source_station);
@@ -315,6 +317,7 @@ public:
* @game @pre ScriptCompanyMode::IsValid().
* @exception ScriptError::ERR_FLAT_LAND_REQUIRED
* @exception ScriptError::ERR_BRIDGE_TOO_LOW
* @exception ScriptError::ERR_STATION_TOO_SPREAD_OUT
* @return Whether the rail waypoint has been/can be build or not.
*/
static bool BuildRailWaypoint(TileIndex tile);