dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r24581) -Doc [FS#5318]: Indicate that the return value for script related order distances is the square of the distance

Browse Source
This commit is contained in:
planetmaker
2012-10-09 20:37:20 +00:00
parent de770d7563
commit 60335b7b79
3 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/script/api/script_vehicle.hpp
View File

@@ -551,8 +551,8 @@ public:
* Get the maximum allowed distance between two orders for a vehicle.
* @param vehicle_id The vehicle to get the distance for.
* @pre IsValidVehicle(vehicle_id).
* @return The maximum distance between two orders for this vehicle
* or 0 if the distance is unlimited.
* @return The square of the maximum distance between two orders for
* this vehicle or 0 if the distance is unlimited.
* @see ScriptOrder::GetOrderDistance
*/
static uint GetMaximumOrderDistance(VehicleID vehicle_id);