OpenTTD Source
20241120-master-g6d3adc6169
|
Information about a single item of news. More...
#include <news_type.h>
Public Member Functions | |
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. More... | |
Data Fields | |
StringID | string_id |
Message text. | |
TimerGameCalendar::Date | date |
Calendar date to show for the news. | |
TimerGameEconomy::Date | economy_date |
Economy date of the news item, never shown but used to calculate age. | |
NewsType | type |
Type of the news. | |
NewsFlag | flags |
NewsFlags bits. More... | |
NewsReferenceType | reftype1 |
Type of ref1. | |
NewsReferenceType | reftype2 |
Type of ref2. | |
uint32_t | ref1 |
Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news, and for deleting the news when the object is deleted. | |
uint32_t | ref2 |
Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news when the object is deleted. | |
std::unique_ptr< const NewsAllocatedData > | data |
Custom data for the news item that will be deallocated (deleted) when the news item has reached its end. | |
std::vector< StringParameterData > | params |
Parameters for string resolving. | |
Information about a single item of news.
Definition at line 128 of file news_type.h.
NewsItem::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.
string_id | String to display. |
type | The type of news. |
flags | Flags related to how to display the news. |
reftype1 | Type of ref1. |
ref1 | Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news, and for deleting the news when the object is deleted. |
reftype2 | Type of ref2. |
ref2 | Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news when the object is deleted. |
data | Pointer to data that must be released once the news message is cleared. |
Definition at line 808 of file news_gui.cpp.
References _settings_client, GUISettings::coloured_news_year, CopyOutDParam(), ClientSettings::gui, NF_INCOLOUR, params, and TimerGameCalendar::year.
NewsFlag NewsItem::flags |
NewsFlags bits.
Definition at line 133 of file news_type.h.
Referenced by ChangeVehicleNews().