From 24217d5c8d1a1d586083e75cc64a4cf52e05f80b Mon Sep 17 00:00:00 2001 From: peter1138 Date: Wed, 1 Mar 2006 17:35:01 +0000 Subject: (svn r3701) [2cc] move vehicle/engine palette functions out of header file and document the remaining definitions --- vehicle.h | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) (limited to 'vehicle.h') diff --git a/vehicle.h b/vehicle.h index 9e001d7bc..fb9329aee 100644 --- a/vehicle.h +++ b/vehicle.h @@ -422,19 +422,20 @@ VARDEF uint16 _returned_refit_capacity; #define INVALID_VEHICLE 0xFFFF -// XXX Temporary interface -- will be expanded -PalSpriteID GetEngineColourMap(PlayerID player); - -static inline PalSpriteID GetEnginePalette(EngineID engine_type, PlayerID player) -{ - return GetEngineColourMap(player); -} - -static inline PalSpriteID GetVehiclePalette(const Vehicle *v) -{ - return GetEngineColourMap(v->owner); -} +/** + * Get the colour map for an engine. This used for unbuilt engines in the user interface. + * @param engine_type ID of engine + * @param player ID of player + * @return A ready-to-use palette modifier + */ +PalSpriteID GetEnginePalette(EngineID engine_type, PlayerID player); +/** + * Get the colour map for a vehicle. + * @param v Vehicle to get colour map for + * @return A ready-to-use palette modifier + */ +PalSpriteID GetVehiclePalette(const Vehicle *v); /* A lot of code calls for the invalidation of the status bar, which is widget 5. * Best is to have a virtual value for it when it needs to change again */ -- cgit v1.2.3-54-g00ecf