diff options
| author | rubidium <rubidium@openttd.org> | 2010-02-05 16:11:23 +0000 |
|---|---|---|
| committer | rubidium <rubidium@openttd.org> | 2010-02-05 16:11:23 +0000 |
| commit | 7c1170668a715ec11d21bcb58e2ae005e1202768 (patch) | |
| tree | d5e046c5be918f8204a9da0c9329bac3e0cde9b2 /src/ai/api | |
| parent | 9cf602c7c13b8e58564a7ae8e9d90a74e63fc1a7 (diff) | |
| download | openttd-7c1170668a715ec11d21bcb58e2ae005e1202768.tar.xz | |
(svn r19017) -Doc: [NoAI] A parameter wasn't documented
Diffstat (limited to 'src/ai/api')
| -rw-r--r-- | src/ai/api/ai_order.hpp | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/src/ai/api/ai_order.hpp b/src/ai/api/ai_order.hpp index fe0dcd826..ae9ea6f88 100644 --- a/src/ai/api/ai_order.hpp +++ b/src/ai/api/ai_order.hpp @@ -352,9 +352,11 @@ public: * Sets the stoplocation of the given order for the given train. * @param vehicle_id The vehicle to get the value for. * @param order_position The order to get the value for. + * @param stop_location The relative position where a train will stop inside a station. * @pre IsValidVehicleOrder(vehicle_id, order_position). * @pre AIVehicle::GetVehicleType(vehicle_id) == AIVehicle::VT_RAIL. * @pre IsGotoStationOrder(vehicle_id, order_position). + * @pre stop_location >= STOPLOCATION_NEAR && stop_location <= STOPLOCATION_FAR * @return Whether the order has been/can be changed. */ static bool SetStopLocation(VehicleID vehicle_id, OrderPosition order_position, StopLocation stop_location); |