mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

(svn r21087) -Doc: Align and make existing comments available for doxygen.

release/1.1
alberth 2010-11-05 15:48:30 +00:00
parent 399eedd884
commit 5e3991e20e
1 changed files with 55 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

42
src/vehicle_base.h
View File

@ -44,7 +44,7 @@ enum VehicleFlags {
VF_STOP_LOADING, ///< Don't load anymore during the next load cycle. VF_STOP_LOADING, ///< Don't load anymore during the next load cycle.
}; };
/** Cached oftenly queried (NewGRF) values */ /** Cached often queried (NewGRF) values */
struct VehicleCache { struct VehicleCache {
uint8 cache_valid; ///< Whether the caches are valid uint8 cache_valid; ///< Whether the caches are valid
uint32 cached_var40; ///< Cache for NewGRF var 40 uint32 cached_var40; ///< Cache for NewGRF var 40
@ -109,12 +109,12 @@ public:
Vehicle *next_new_hash, **prev_new_hash; Vehicle *next_new_hash, **prev_new_hash;
Vehicle **old_new_hash; Vehicle **old_new_hash;
SpriteID colourmap; // NOSAVE: cached colour mapping SpriteID colourmap; ///< NOSAVE: cached colour mapping
/* Related to age and service time */ /* Related to age and service time */
Year build_year; Year build_year;
Date age; // Age in days Date age; ///< Age in days
Date max_age; // Maximum age Date max_age; ///< Maximum age
Date date_of_last_service; Date date_of_last_service;
Date service_interval; Date service_interval;
uint16 reliability; uint16 reliability;
@ -124,25 +124,25 @@ public:
byte breakdowns_since_last_service; byte breakdowns_since_last_service;
byte breakdown_chance; byte breakdown_chance;
int32 x_pos; // coordinates int32 x_pos; ///< x coordinate.
int32 y_pos; int32 y_pos; ///< y coordinate.
byte z_pos; byte z_pos; ///< z coordinate.
DirectionByte direction; // facing DirectionByte direction; ///< facing
OwnerByte owner; // which company owns the vehicle? OwnerByte owner; ///< Which company owns the vehicle?
byte spritenum; // currently displayed sprite index byte spritenum; ///< currently displayed sprite index
// 0xfd == custom sprite, 0xfe == custom second head sprite ///< 0xfd == custom sprite, 0xfe == custom second head sprite
// 0xff == reserved for another custom sprite ///< 0xff == reserved for another custom sprite
uint16 cur_image; // sprite number for this vehicle uint16 cur_image; ///< sprite number for this vehicle
byte x_extent; // x-extent of vehicle bounding box byte x_extent; ///< x-extent of vehicle bounding box
byte y_extent; // y-extent of vehicle bounding box byte y_extent; ///< y-extent of vehicle bounding box
byte z_extent; // z-extent of vehicle bounding box byte z_extent; ///< z-extent of vehicle bounding box
int8 x_offs; // x offset for vehicle sprite int8 x_offs; ///< x offset for vehicle sprite
int8 y_offs; // y offset for vehicle sprite int8 y_offs; ///< y offset for vehicle sprite
EngineID engine_type; EngineID engine_type;
TextEffectID fill_percent_te_id; // a text-effect id to a loading indicator object TextEffectID fill_percent_te_id; ///< a text-effect id to a loading indicator object
UnitID unitnumber; // unit number, for display purposes only UnitID unitnumber; ///< unit number, for display purposes only
uint16 max_speed; ///< maximum speed uint16 max_speed; ///< maximum speed
uint16 cur_speed; ///< current speed uint16 cur_speed; ///< current speed
@ -184,7 +184,7 @@ public:
GroupID group_id; ///< Index of group Pool array GroupID group_id; ///< Index of group Pool array
byte subtype; ///< subtype (Filled with values from EffectVehicles/TrainSubTypes/AircraftSubTypes) byte subtype; ///< subtype (Filled with values from #EffectVehicles/#TrainSubTypes/#AircraftSubTypes)
VehicleCache vcache; ///< Cache of often used calculated values VehicleCache vcache; ///< Cache of often used calculated values