Mercurial > hg > openttd

changeset 14752:fd1a3d7dda38 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(svn r19340) -Documentation: Add a list of required functions to GroundVehicle.
author terkhen <terkhen@openttd.org>
date Sat, 06 Mar 2010 12:45:47 +0000
parents 60e23daa56cb
children 3e27a2798ca0
files src/ground_vehicle.hpp
diffstat 1 files changed, 15 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/src/ground_vehicle.hpp
+++ b/src/ground_vehicle.hpp
@@ -39,6 +39,21 @@
 
 /**
  * Base class for all vehicles that move through ground.
+ *
+ * Child classes must define all of the following functions.
+ * These functions are not defined as pure virtual functions at this class to improve performance.
+ *
+ * virtual uint16      GetPower() const = 0;
+ * virtual uint16      GetPoweredPartPower(const T *head) const = 0;
+ * virtual uint16      GetWeight() const = 0;
+ * virtual byte        GetTractiveEffort() const = 0;
+ * virtual AccelStatus GetAccelerationStatus() const = 0;
+ * virtual uint16      GetCurrentSpeed() const = 0;
+ * virtual uint32      GetRollingFriction() const = 0;
+ * virtual int         GetAccelerationType() const = 0;
+ * virtual int32       GetSlopeSteepness() const = 0;
+ * virtual uint16      GetInitialMaxSpeed() const = 0;
+ * virtual uint16      GetMaxTrackSpeed() const = 0;
  */
 template <class T, VehicleType Type>
 struct GroundVehicle : public SpecializedVehicle<T, Type> {