Mercurial > hg > openttd

changeset 16787:530915d6b2c5 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r21520) -Document: Complete the comments of GroundVehicleCache.
author terkhen <terkhen@openttd.org>
date Tue, 14 Dec 2010 21:31:45 +0000
parents e69d11fd38e7
children efb0333e5aad
files src/ground_vehicle.hpp
diffstat 1 files changed, 7 insertions(+), 7 deletions(-) [+]
line wrap: on
line diff
--- a/src/ground_vehicle.hpp
+++ b/src/ground_vehicle.hpp
@@ -22,20 +22,20 @@
 };
 
 /**
- * Cached values.
+ * Cached, frequently calculated values.
  * All of these values except cached_slope_resistance are set only for the first part of a vehicle.
  */
 struct GroundVehicleCache {
 	/* Cached acceleration values, recalculated when the cargo on a vehicle changes (in addition to the conditions below) */
-	uint32 cached_weight;           ///< Total weight of the consist.
+	uint32 cached_weight;           ///< Total weight of the consist (valid only for the first engine).
 	uint32 cached_slope_resistance; ///< Resistance caused by weight when this vehicle part is at a slope.
-	uint32 cached_max_te;           ///< Maximum tractive effort of consist.
-	uint16 cached_axle_resistance;  ///< Resistance caused by the axles of the vehicle.
+	uint32 cached_max_te;           ///< Maximum tractive effort of consist (valid only for the first engine).
+	uint16 cached_axle_resistance;  ///< Resistance caused by the axles of the vehicle (valid only for the first engine).
 
 	/* Cached acceleration values, recalculated on load and each time a vehicle is added to/removed from the consist. */
-	uint16 cached_max_track_speed;  ///< Maximum consist speed limited by track type.
-	uint32 cached_power;            ///< Total power of the consist.
-	uint32 cached_air_drag;         ///< Air drag coefficient of the vehicle.
+	uint16 cached_max_track_speed;  ///< Maximum consist speed limited by track type (valid only for the first engine).
+	uint32 cached_power;            ///< Total power of the consist (valid only for the first engine).
+	uint32 cached_air_drag;         ///< Air drag coefficient of the vehicle (valid only for the first engine).
 };
 
 /** Ground vehicle flags. */