(svn r22406) -Document: some more "random-ish" tidbits

This commit is contained in:
rubidium
2011-05-01 19:51:52 +00:00
parent 87272273b5
commit 6e9122828e
33 changed files with 132 additions and 20 deletions

View File

@@ -20,7 +20,7 @@ void GetShipSpriteSize(EngineID engine, uint &width, uint &height);
* All ships have this type.
*/
struct Ship: public SpecializedVehicle<Ship, VEH_SHIP> {
TrackBitsByte state;
TrackBitsByte state; ///< The "track" the ship is following.
/** We don't want GCC to zero our struct! It already is zeroed and has an index! */
Ship() : SpecializedVehicleBase() {}
@@ -45,6 +45,10 @@ struct Ship: public SpecializedVehicle<Ship, VEH_SHIP> {
void UpdateCache();
};
/**
* Iterate over all ships.
* @param var The variable used for iteration.
*/
#define FOR_ALL_SHIPS(var) FOR_ALL_VEHICLES_OF_TYPE(Ship, var)
#endif /* SHIP_H */