dave/openttd
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

(svn r24282) -Codechange: Add AddVehicleAdviceNewsItem function to preemptively deduplicate code.

Browse Source
This commit is contained in:
frosch
2012-05-26 14:15:52 +00:00
parent 6f35cf016b
commit ae4681ab4c
5 changed files with 20 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
src/news_func.h
View File

@@ -27,17 +27,23 @@ static inline void AddCompanyNewsItem(StringID string, CompanyNewsInformation *c
/**
* Adds a newsitem referencing a vehicle.
*
* @warning
* Be careful!
* Vehicles are a special case, as news are kept when vehicles are autoreplaced/renewed.
* You have to make sure, #ChangeVehicleNews catches the DParams of your message.
* This is NOT ensured by the references.
* @warning The DParams may not reference the vehicle due to autoreplace stuff. See AddVehicleAdviceNewsItem for how that can be done.
*/
static inline void AddVehicleNewsItem(StringID string, NewsSubtype subtype, VehicleID vehicle, StationID station = INVALID_STATION)
{
AddNewsItem(string, subtype, NR_VEHICLE, vehicle, station == INVALID_STATION ? NR_NONE : NR_STATION, station);
}
/**
* Adds a vehicle-advice news item.
*
* @warning DParam 0 must reference the vehicle!
*/
static inline void AddVehicleAdviceNewsItem(StringID string, VehicleID vehicle)
{
AddNewsItem(string, NS_ADVICE, NR_VEHICLE, vehicle);
}
static inline void AddIndustryNewsItem(StringID string, NewsSubtype subtype, IndustryID industry)
{
AddNewsItem(string, subtype, NR_INDUSTRY, industry);