From 1c3b7c35a7efbd05da32c97d0a6b4fc49fed087a Mon Sep 17 00:00:00 2001
From: terkhen <terkhen@openttd.org>
Date: Sat, 6 Mar 2010 12:45:47 +0000
Subject: [PATCH] (svn r19340) -Documentation: Add a list of required functions
 to GroundVehicle.

---
 src/ground_vehicle.hpp | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/src/ground_vehicle.hpp b/src/ground_vehicle.hpp
index c87dbf76f1..106b0b954a 100644
--- a/src/ground_vehicle.hpp
+++ b/src/ground_vehicle.hpp
@@ -39,6 +39,21 @@ struct AccelerationCache {
 
 /**
  * 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> {