OpenTTD

news_func.h
Go to the documentation of this file.
1 /* $Id: news_func.h 24845 2012-12-23 21:08:42Z frosch $ */
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
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
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
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 */
NF_THIN
Thin news item. (Newspaper with headline and viewport)
Definition: news_type.h:91
industry_type.h
Types related to the industry.
NR_STATION
Reference station. Scroll to station when clicking on the news. Delete news when station is deleted...
Definition: news_type.h:68
DeleteIndustryNews
void DeleteIndustryNews(IndustryID iid)
Remove news regarding given industry.
Definition: news_gui.cpp:824
NT_ADVICE
Bits of news about vehicles of the company.
Definition: news_type.h:47
AddVehicleAdviceNewsItem
static void AddVehicleAdviceNewsItem(StringID string, VehicleID vehicle)
Adds a vehicle-advice news item.
Definition: news_func.h:42
DeleteStationNews
void DeleteStationNews(StationID sid)
Remove news regarding given station so there are no &#39;unknown station now accepts Mail&#39; or &#39;First trai...
Definition: news_gui.cpp:807
CompanyNewsInformation
Data that needs to be stored for company news messages.
Definition: news_type.h:163
NF_VEHICLE_PARAM0
Bit value for specifying that string param 0 contains a vehicle ID. (special autoreplace behaviour) ...
Definition: news_type.h:89
station_type.h
Types related to stations.
DeleteVehicleNews
void DeleteVehicleNews(VehicleID vid, StringID news)
Delete a news item type about a vehicle.
Definition: news_gui.cpp:788
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:18
InitNewsItemStructs
void InitNewsItemStructs()
Initialize the news-items data structures.
Definition: news_gui.cpp:561
NF_NO_TRANSPARENT
Bit value for disabling transparency.
Definition: news_type.h:87
NewsFlag
NewsFlag
Various OR-able news-item flags.
Definition: news_type.h:78
NR_TILE
Reference tile. Scroll to tile when clicking on the news.
Definition: news_type.h:66
NR_NONE
Empty reference.
Definition: news_type.h:65
NF_INCOLOUR
Bit value for coloured news.
Definition: news_type.h:86
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
NF_COMPANY
Company news item. (Newspaper with face)
Definition: news_type.h:95
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:80
AddNewsItem
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)
Add a new newsitem to be shown.
Definition: news_gui.cpp:645
NT_COMPANY_INFO
Company info (new companies, bankruptcy messages)
Definition: news_type.h:40
vehicle_type.h
Types related to vehicles.
news_type.h
Types related to news.
NewsReferenceType
NewsReferenceType
References to objects in news.
Definition: news_type.h:64
NR_INDUSTRY
Reference industry. Scroll to industry when clicking on the news. Delete news when industry is delete...
Definition: news_type.h:69
NF_SMALL
Small news item. (Information window with text and viewport)
Definition: news_type.h:92
DeleteInvalidEngineNews
void DeleteInvalidEngineNews()
Remove engine announcements for invalid engines.
Definition: news_gui.cpp:840
NewsType
NewsType
Type of news.
Definition: news_type.h:36
NR_VEHICLE
Reference vehicle. Scroll to vehicle when clicking on the news. Delete news when vehicle is deleted...
Definition: news_type.h:67
NF_SHADE
Bit value for enabling shading.
Definition: news_type.h:88
NewsItem
Information about a single item of news.
Definition: news_type.h:134
AddVehicleNewsItem
static void AddVehicleNewsItem(StringID string, NewsType type, VehicleID vehicle, StationID station=INVALID_STATION)
Adds a newsitem referencing a vehicle.
Definition: news_func.h:32