Changeset - r14742:6197538199dc
[Not reviewed]
master
0 1 0
terkhen - 14 years ago 2010-03-06 12:45:47
terkhen@openttd.org
(svn r19340) -Documentation: Add a list of required functions to GroundVehicle.
1 file changed with 15 insertions and 0 deletions:
0 comments (0 inline, 0 general)
src/ground_vehicle.hpp
Show inline comments
 
@@ -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> {
0 comments (0 inline, 0 general)