gronod/OpenTTD
1
0
Fork 0
mirror of https://github.com/OpenTTD/OpenTTD.git synced 2025-03-10 08:00:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

(svn r24582) -Fix (r24581): Order distances are not supposed to be compared to map distances

Browse Source
This commit is contained in:
planetmaker 2012-10-09 20:59:29 +00:00
parent 60335b7b79
commit e0529d4861
3 changed files with 12 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
src/script/api/script_engine.hpp
View File

@ -257,8 +257,10 @@ public:
* Get the maximum allowed distance between two orders for an engine. * Get the maximum allowed distance between two orders for an engine.
* @param engine_id The engine to get the max distance for. * @param engine_id The engine to get the max distance for.
* @pre IsValidEngine(engine_id). * @pre IsValidEngine(engine_id).
* @return The square of the maximum distance between two orders for * @return The maximum distance between two orders for the engine
* the engine or 0 if the distance is unlimited. * or 0 if the distance is unlimited.
* @note The unit of the order distances is unspecified and should
* not be compared with map distances
* @see ScriptOrder::GetOrderDistance * @see ScriptOrder::GetOrderDistance
*/ */
static uint GetMaximumOrderDistance(EngineID engine_id); static uint GetMaximumOrderDistance(EngineID engine_id);

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

@ -588,8 +588,10 @@ public:
* @param vehicle_type The vehicle type to get the distance for. * @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 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. * @param dest_tile Destination, ca be any tile or a tile of a specific station.
* @return The square of the distance between the origin and the * @return The distance between the origin and the destination for a
* destination for a vehicle of the given vehicle type. * vehicle of the given vehicle type.
* @note The unit of the order distances is unspecified and should
* not be compared with map distances
* @see ScriptEngine::GetMaximumOrderDistance and ScriptVehicle::GetMaximumOrderDistance * @see ScriptEngine::GetMaximumOrderDistance and ScriptVehicle::GetMaximumOrderDistance
*/ */
static uint GetOrderDistance(ScriptVehicle::VehicleType vehicle_type, TileIndex origin_tile, TileIndex dest_tile); static uint GetOrderDistance(ScriptVehicle::VehicleType vehicle_type, TileIndex origin_tile, TileIndex dest_tile);

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

@ -551,8 +551,10 @@ public:
* Get the maximum allowed distance between two orders for a vehicle. * Get the maximum allowed distance between two orders for a vehicle.
* @param vehicle_id The vehicle to get the distance for. * @param vehicle_id The vehicle to get the distance for.
* @pre IsValidVehicle(vehicle_id). * @pre IsValidVehicle(vehicle_id).
* @return The square of the maximum distance between two orders for * @return The maximum distance between two orders for this vehicle
* this vehicle or 0 if the distance is unlimited. * or 0 if the distance is unlimited.
* @note The unit of the order distances is unspecified and should
* not be compared with map distances
* @see ScriptOrder::GetOrderDistance * @see ScriptOrder::GetOrderDistance
*/ */
static uint GetMaximumOrderDistance(VehicleID vehicle_id); static uint GetMaximumOrderDistance(VehicleID vehicle_id);