OpenTTD Source  20241108-master-g80f628063a
news_type.h
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * 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.
4  * 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.
5  * 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/>.
6  */
7 
10 #ifndef NEWS_TYPE_H
11 #define NEWS_TYPE_H
12 
13 #include "core/enum_type.hpp"
14 #include "gfx_type.h"
17 #include "strings_type.h"
18 #include "sound_type.h"
19 
23 enum NewsType : uint8_t {
41 };
42 
52 enum NewsReferenceType : uint8_t {
60 };
61 
66 enum NewsFlag {
69  NFB_SHADE = 2,
73 
78 
84 };
86 
87 
88 
95 };
96 
100 struct NewsTypeData {
101  const char * const name;
102  const uint8_t age;
103  const SoundFx sound;
104 
111  NewsTypeData(const char *name, uint8_t age, SoundFx sound) :
112  name(name),
113  age(age),
114  sound(sound)
115  {
116  }
117 
118  NewsDisplay GetDisplay() const;
119 };
120 
123  virtual ~NewsAllocatedData() = default;
124 };
125 
126 
128 struct NewsItem {
134 
137  uint32_t ref1;
138  uint32_t ref2;
139 
140  std::unique_ptr<const NewsAllocatedData> data;
141 
142  std::vector<StringParameterData> params;
143 
145 };
146 
154  std::string company_name;
155  std::string president_name;
156  std::string other_company_name;
157 
158  uint32_t face;
159  Colours colour;
160 
161  CompanyNewsInformation(const struct Company *c, const struct Company *other = nullptr);
162 };
163 
164 using NewsContainer = std::list<NewsItem>;
165 using NewsIterator = NewsContainer::const_iterator;
166 
167 #endif /* NEWS_TYPE_H */
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
Type (helpers) for enums.
Types related to the graphics and/or input devices.
NewsType
Type of news.
Definition: news_type.h:23
@ NT_INDUSTRY_NOBODY
Other industry production changes.
Definition: news_type.h:34
@ NT_INDUSTRY_COMPANY
Production changes of industry serviced by local company.
Definition: news_type.h:32
@ NT_INDUSTRY_OPEN
Opening of industries.
Definition: news_type.h:29
@ NT_NEW_VEHICLES
New vehicle has become available.
Definition: news_type.h:36
@ NT_ECONOMY
Economic changes (recession, industry up/dowm)
Definition: news_type.h:31
@ NT_ACCEPTANCE
A type of cargo is (no longer) accepted.
Definition: news_type.h:37
@ NT_END
end-of-array marker
Definition: news_type.h:40
@ NT_INDUSTRY_CLOSE
Closing of industries.
Definition: news_type.h:30
@ NT_ACCIDENT_OTHER
An accident or disaster has occurred.
Definition: news_type.h:27
@ NT_SUBSIDIES
News about subsidies (announcements, expirations, acceptance)
Definition: news_type.h:38
@ NT_ARRIVAL_COMPANY
First vehicle arrived for company.
Definition: news_type.h:24
@ NT_ARRIVAL_OTHER
First vehicle arrived for competitor.
Definition: news_type.h:25
@ NT_INDUSTRY_OTHER
Production changes of industry serviced by competitor(s)
Definition: news_type.h:33
@ NT_ACCIDENT
An accident or disaster has occurred.
Definition: news_type.h:26
@ NT_ADVICE
Bits of news about vehicles of the company.
Definition: news_type.h:35
@ NT_COMPANY_INFO
Company info (new companies, bankruptcy messages)
Definition: news_type.h:28
@ NT_GENERAL
General news (from towns)
Definition: news_type.h:39
NewsReferenceType
References to objects in news.
Definition: news_type.h:52
@ NR_TILE
Reference tile. Scroll to tile when clicking on the news.
Definition: news_type.h:54
@ NR_STATION
Reference station. Scroll to station when clicking on the news. Delete news when station is deleted.
Definition: news_type.h:56
@ NR_ENGINE
Reference engine.
Definition: news_type.h:59
@ NR_TOWN
Reference town. Scroll to town when clicking on the news.
Definition: news_type.h:58
@ NR_INDUSTRY
Reference industry. Scroll to industry when clicking on the news. Delete news when industry is delete...
Definition: news_type.h:57
@ NR_NONE
Empty reference.
Definition: news_type.h:53
@ NR_VEHICLE
Reference vehicle. Scroll to vehicle when clicking on the news. Delete news when vehicle is deleted.
Definition: news_type.h:55
NewsContainer::const_iterator NewsIterator
Iterator type for news items.
Definition: news_type.h:165
NewsDisplay
News display options.
Definition: news_type.h:91
@ ND_SUMMARY
Show ticker.
Definition: news_type.h:93
@ ND_OFF
Only show a reminder in the status bar.
Definition: news_type.h:92
@ ND_FULL
Show newspaper.
Definition: news_type.h:94
std::list< NewsItem > NewsContainer
Container type for storing news items.
Definition: news_type.h:164
NewsFlag
Various OR-able news-item flags.
Definition: news_type.h:66
@ NF_NO_TRANSPARENT
Bit value for disabling transparency.
Definition: news_type.h:75
@ NF_SHADE
Bit value for enabling shading.
Definition: news_type.h:76
@ NFB_NO_TRANSPARENT
News item disables transparency in the viewport.
Definition: news_type.h:68
@ NFB_INCOLOUR
News item is shown in colour (otherwise it is shown in black & white).
Definition: news_type.h:67
@ NFB_SHADE
News item uses shaded colours.
Definition: news_type.h:69
@ NF_VEHICLE_PARAM0
Bit value for specifying that string param 0 contains a vehicle ID. (special autoreplace behaviour)
Definition: news_type.h:77
@ NFB_WINDOW_LAYOUT
First bit for window layout.
Definition: news_type.h:70
@ NFB_VEHICLE_PARAM0
String param 0 contains a vehicle ID. (special autoreplace behaviour)
Definition: news_type.h:72
@ NF_THIN
Thin news item. (Newspaper with headline and viewport)
Definition: news_type.h:79
@ NF_COMPANY
Company news item. (Newspaper with face)
Definition: news_type.h:83
@ NF_NORMAL
Normal news item. (Newspaper with text only)
Definition: news_type.h:81
@ NF_VEHICLE
Vehicle news item. (new engine available)
Definition: news_type.h:82
@ NF_INCOLOUR
Bit value for coloured news.
Definition: news_type.h:74
@ NFB_WINDOW_LAYOUT_COUNT
Number of bits for window layout.
Definition: news_type.h:71
@ NF_SMALL
Small news item. (Information window with text and viewport)
Definition: news_type.h:80
Types related to sounds.
SoundFx
Sound effects from baseset.
Definition: sound_type.h:37
Types related to strings.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
Data that needs to be stored for company news messages.
Definition: news_type.h:153
uint32_t face
The face of the president.
Definition: news_type.h:158
CompanyNewsInformation(const struct Company *c, const struct Company *other=nullptr)
Fill the CompanyNewsInformation struct with the required data.
Colours colour
The colour related to the company.
Definition: news_type.h:159
std::string president_name
The name of the president.
Definition: news_type.h:155
std::string company_name
The name of the company.
Definition: news_type.h:154
std::string other_company_name
The name of the company taking over this one.
Definition: news_type.h:156
Container for any custom data that must be deleted after the news item has reached end-of-life.
Definition: news_type.h:122
Information about a single item of news.
Definition: news_type.h:128
TimerGameCalendar::Date date
Calendar date to show for the news.
Definition: news_type.h:130
std::vector< StringParameterData > params
Parameters for string resolving.
Definition: news_type.h:142
NewsType type
Type of the news.
Definition: news_type.h:132
uint32_t ref1
Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news,...
Definition: news_type.h:137
NewsReferenceType reftype1
Type of ref1.
Definition: news_type.h:135
TimerGameEconomy::Date economy_date
Economy date of the news item, never shown but used to calculate age.
Definition: news_type.h:131
std::unique_ptr< const NewsAllocatedData > data
Custom data for the news item that will be deallocated (deleted) when the news item has reached its e...
Definition: news_type.h:140
uint32_t ref2
Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news ...
Definition: news_type.h:138
StringID string_id
Message text.
Definition: news_type.h:129
NewsItem(StringID string_id, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32_t ref1, NewsReferenceType reftype2, uint32_t ref2, const NewsAllocatedData *data)
Create a new newsitem to be shown.
Definition: news_gui.cpp:808
NewsFlag flags
NewsFlags bits.
Definition: news_type.h:133
NewsReferenceType reftype2
Type of ref2.
Definition: news_type.h:136
Per-NewsType data.
Definition: news_type.h:100
NewsDisplay GetDisplay() const
Return the news display option.
Definition: news_gui.cpp:274
const char *const name
Name.
Definition: news_type.h:101
NewsTypeData(const char *name, uint8_t age, SoundFx sound)
Construct this entry.
Definition: news_type.h:111
const SoundFx sound
Sound.
Definition: news_type.h:103
const uint8_t age
Maximum age of news items (in days)
Definition: news_type.h:102
Templated helper to make a type-safe 'typedef' representing a single POD value.
Definition of the game-calendar-timer.
Definition of the game-economy-timer.