src/news_func.h

   1 /* $Id$ */
   2
   3 /*
   4  * This file is part of OpenTTD.
   5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
   6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
   7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
   8  */
   9
  10 /** @file news_func.h Functions related to news. */
  11
  12 #ifndef NEWS_FUNC_H
  13 #define NEWS_FUNC_H
  14
  15 #include "news_type.h"
  16 #include "vehicle_type.h"
  17 #include "station_type.h"
  18 #include "industry_type.h"
  19
  20 void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1 = NR_NONE, uint32 ref1 = UINT32_MAX, NewsReferenceType reftype2 = NR_NONE, uint32 ref2 = UINT32_MAX, void *free_data = NULL);
  21
  22 static inline void AddCompanyNewsItem(StringID string, CompanyNewsInformation *cni)
  23 {
  24         AddNewsItem(string, NT_COMPANY_INFO, NF_COMPANY, NR_NONE, UINT32_MAX, NR_NONE, UINT32_MAX, cni);
  25 }
  26
  27 /**
  28  * Adds a newsitem referencing a vehicle.
  29  *
  30  * @warning The DParams may not reference the vehicle due to autoreplace stuff. See AddVehicleAdviceNewsItem for how that can be done.
  31  */
  32 static inline void AddVehicleNewsItem(StringID string, NewsType type, VehicleID vehicle, StationID station = INVALID_STATION)
  33 {
  34         AddNewsItem(string, type, NF_NO_TRANSPARENT | NF_SHADE | NF_THIN, NR_VEHICLE, vehicle, station == INVALID_STATION ? NR_NONE : NR_STATION, station);
  35 }
  36
  37 /**
  38  * Adds a vehicle-advice news item.
  39  *
  40  * @warning DParam 0 must reference the vehicle!
  41  */
  42 static inline void AddVehicleAdviceNewsItem(StringID string, VehicleID vehicle)
  43 {
  44         AddNewsItem(string, NT_ADVICE, NF_INCOLOUR | NF_SMALL | NF_VEHICLE_PARAM0, NR_VEHICLE, vehicle);
  45 }
  46
  47 static inline void AddTileNewsItem(StringID string, NewsType type, TileIndex tile, void *free_data = NULL)
  48 {
  49         AddNewsItem(string, type, NF_NO_TRANSPARENT | NF_SHADE | NF_THIN, NR_TILE, tile, NR_NONE, UINT32_MAX, free_data);
  50 }
  51
  52 static inline void AddIndustryNewsItem(StringID string, NewsType type, IndustryID industry)
  53 {
  54         AddNewsItem(string, type, NF_NO_TRANSPARENT | NF_SHADE | NF_THIN, NR_INDUSTRY, industry);
  55 }
  56
  57 void NewsLoop();
  58 void InitNewsItemStructs();
  59
  60 extern const NewsItem *_statusbar_news_item;
  61
  62 void DeleteInvalidEngineNews();
  63 void DeleteVehicleNews(VehicleID vid, StringID news);
  64 void DeleteStationNews(StationID sid);
  65 void DeleteIndustryNews(IndustryID iid);
  66
  67 #endif /* NEWS_FUNC_H */