(svn r21843) -Codechange: move documentation towards the code to make it more likely to be updates [t-z].

This commit is contained in:
rubidium
2011-01-18 21:58:22 +00:00
parent abc1828d30
commit 3dd1cf6049
7 changed files with 77 additions and 88 deletions

View File

@@ -105,19 +105,7 @@ static inline bool IsCompanyBuildableVehicleType(const BaseVehicle *v)
LiveryScheme GetEngineLiveryScheme(EngineID engine_type, EngineID parent_engine_type, const Vehicle *v);
const struct Livery *GetEngineLivery(EngineID engine_type, CompanyID company, EngineID parent_engine_type, const Vehicle *v, byte livery_setting);
/**
* Get the colour map for an engine. This used for unbuilt engines in the user interface.
* @param engine_type ID of engine
* @param company ID of company
* @return A ready-to-use palette modifier
*/
SpriteID GetEnginePalette(EngineID engine_type, CompanyID company);
/**
* Get the colour map for a vehicle.
* @param v Vehicle to get colour map for
* @return A ready-to-use palette modifier
*/
SpriteID GetVehiclePalette(const Vehicle *v);
uint GetVehicleCapacity(const Vehicle *v, uint16 *mail_capacity = NULL);