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

3
src/script/api/script_order.hpp
View File

@@ -588,7 +588,8 @@ public:
* @param vehicle_type The vehicle type to get the distance for.
* @param origin_tile Origin, can be any tile or a tile of a specific station.
* @param dest_tile Destination, ca be any tile or a tile of a specific station.
* @return The distance between the origin and the destination for a vehicle of the given vehicle type.
* @return The square of the distance between the origin and the
* destination for a vehicle of the given vehicle type.
* @see ScriptEngine::GetMaximumOrderDistance and ScriptVehicle::GetMaximumOrderDistance
*/
static uint GetOrderDistance(ScriptVehicle::VehicleType vehicle_type, TileIndex origin_tile, TileIndex dest_tile);