cpp/openttd-patchpack/source Changeset - r19650:50e501711479

Changeset - r19650:50e501711479

Parent rev.

Child rev.

[Not reviewed]

master

0 3 0

planetmaker - 12 years ago 2012-10-09 20:37:20
planetmaker@openttd.org

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

3 files changed with 6 insertions and 5 deletions:

src/script/api/script_engine.hpp

src/script/api/script_order.hpp

src/script/api/script_vehicle.hpp

0 comments (0 inline, 0 general)

src/script/api/script_engine.hpp

➞

Show inline comments

@@ @@ -257,8 +257,8 @@ public: @@
 	 * Get the maximum allowed distance between two orders for an engine.
 	 * @param engine_id The engine to get the max distance for.
 	 * @pre IsValidEngine(engine_id).
 	 * @return The maximum distance between two orders for the engine
 	 *  or 0 if the distance is unlimited.
 	 * @return The square of the maximum distance between two orders for
 	 *         the engine or 0 if the distance is unlimited.
 	 * @see ScriptOrder::GetOrderDistance
 	 */
 	static uint GetMaximumOrderDistance(EngineID engine_id);

src/script/api/script_order.hpp

➞

Show inline comments

@@ @@ -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);

src/script/api/script_vehicle.hpp

➞

Show inline comments

@@ @@ -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);

0 comments (0 inline, 0 general)