OpenTTD Source: src/news_func.h File Reference

OpenTTD Source 15.3

Functions
news_func.h File Reference

Functions related to news. More...

`#include "news_type.h"`
`#include "vehicle_type.h"`
`#include "station_type.h"`
`#include "industry_type.h"`

Go to the source code of this file.

## Functions
void | AddNewsItem (EncodedString &&headline, NewsType type, NewsStyle style, NewsFlags flags, NewsReference ref1={}, NewsReference ref2={}, std::unique_ptr< NewsAllocatedData > &&data=nullptr, AdviceType advice_type=AdviceType::Invalid)
| Add a new newsitem to be shown.
void | AddCompanyNewsItem (EncodedString &&headline, std::unique_ptr< CompanyNewsInformation > cni)
void | AddVehicleNewsItem (EncodedString &&headline, NewsType type, VehicleID vehicle, StationID station=StationID::Invalid())
| Adds a newsitem referencing a vehicle.
void | AddVehicleAdviceNewsItem (AdviceType advice_type, EncodedString &&headline, VehicleID vehicle)
| Adds a vehicle-advice news item.
void | AddTileNewsItem (EncodedString &&headline, NewsType type, TileIndex tile, StationID station=StationID::Invalid())
void | AddIndustryNewsItem (EncodedString &&headline, NewsType type, IndustryID industry)
void | NewsLoop ()
void | InitNewsItemStructs ()
| Initialize the news-items data structures.
const NewsItem * | GetStatusbarNews ()
| Get pointer to the current status bar news item.
void | DeleteInvalidEngineNews ()
| Remove engine announcements for invalid engines.
void | DeleteVehicleNews (VehicleID vid, AdviceType advice_type=AdviceType::Invalid)
| Delete news with a given advice type about a vehicle.
void | DeleteStationNews (StationID sid)
| Remove news regarding given station so there are no 'unknown station now accepts Mail' or 'First train arrived at unknown station' news items.
void | DeleteIndustryNews (IndustryID iid)
| Remove news regarding given industry.
uint32_t | SerialiseNewsReference (const NewsReference &reference)
| Encode a NewsReference for serialisation, e.g.

## Detailed Description

Functions related to news.

Definition in file news_func.h.

## Function Documentation

## ◆ AddCompanyNewsItem()

void AddCompanyNewsItem | ( | EncodedString && | headline,
|  | std::unique_ptr< CompanyNewsInformation > | cni
| ) |  |
| inline

Definition at line 20 of file news_func.h.

## ◆ AddIndustryNewsItem()

void AddIndustryNewsItem | ( | EncodedString && | headline,
|  | NewsType | type,
|  | IndustryID | industry
| ) |  |
| inline

Definition at line 50 of file news_func.h.

## ◆ AddNewsItem()

void AddNewsItem | ( | EncodedString && | headline,
|  | NewsType | type,
|  | NewsStyle | style,
|  | NewsFlags | flags,
|  | NewsReference | ref1,
|  | NewsReference | ref2,
|  | std::unique_ptr< NewsAllocatedData > && | data,
|  | AdviceType | advice_type
| ) |  |

Add a new newsitem to be shown.

Parameters

  string | String to display
  type | news category
  flags | display flags for the news
  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.
  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.
  advice_type | Sub-type in case the news type is NewsType::Advice.

See also
  NewsSubtype

Definition at line 900 of file news_gui.cpp.

References _news, DeleteNewsItem(), InvalidateWindowData(), MAX_NEWS_AMOUNT, and WC_MESSAGE_HISTORY.

Referenced by AddVehicleAdviceNewsItem(), AddVehicleNewsItem(), Subsidy::AwardTo(), CmdCustomNewsItem(), CreateSubsidy(), GenerateCompanyName(), NewVehicleAvailable(), ShowRejectOrAcceptNews(), TownActionBuyRights(), and TownActionRoadRebuild().

## ◆ AddTileNewsItem()

void AddTileNewsItem | ( | EncodedString && | headline,
|  | NewsType | type,
|  | TileIndex | tile,
|  | StationID | station = `StationID::Invalid()`
| ) |  |
| inline

Definition at line 45 of file news_func.h.

## ◆ AddVehicleAdviceNewsItem()

void AddVehicleAdviceNewsItem | ( | AdviceType | advice_type,
|  | EncodedString && | headline,
|  | VehicleID | vehicle
| ) |  |
| inline

Adds a vehicle-advice news item.

Warning
  DParam 0 must reference the vehicle!

Definition at line 40 of file news_func.h.

References AddNewsItem(), Advice, InColour, Small, and VehicleParam0.

Referenced by AgeVehicle(), AircraftHandleDestTooFar(), BuildReplacementVehicle(), CheckOrders(), Vehicle::HandlePathfindingResult(), and VehicleEnterDepot().

## ◆ AddVehicleNewsItem()

void AddVehicleNewsItem | ( | EncodedString && | headline,
|  | NewsType | type,
|  | VehicleID | vehicle,
|  | StationID | station = `StationID::Invalid()`
| ) |  |
| inline

Adds a newsitem referencing a vehicle.

Warning
  The DParams may not reference the vehicle due to autoreplace stuff. See AddVehicleAdviceNewsItem for how that can be done.

Definition at line 30 of file news_func.h.

References AddNewsItem(), NoTransparency, Shaded, and Thin.

Referenced by AircraftEntersTerminal(), RoadVehArrivesAt(), ShipArrivesAt(), and TrainEnterStation().

## ◆ DeleteIndustryNews()

void DeleteIndustryNews | ( | IndustryID | iid | ) |

Remove news regarding given industry.

Parameters

  iid | industry to remove news about

Definition at line 1038 of file news_gui.cpp.

References DeleteNews().

## ◆ DeleteInvalidEngineNews()

void DeleteInvalidEngineNews | ( |  | ) |

Remove engine announcements for invalid engines.

Definition at line 1056 of file news_gui.cpp.

References DeleteNews(), NewsItem::ref1, and NewsItem::ref2.

Referenced by ReloadNewGRFData().

## ◆ DeleteStationNews()

void DeleteStationNews | ( | StationID | sid | ) |

Remove news regarding given station so there are no 'unknown station now accepts Mail' or 'First train arrived at unknown station' news items.

Parameters

  sid | station to remove news about

Definition at line 1027 of file news_gui.cpp.

References DeleteNews().

Referenced by Station::~Station().

## ◆ DeleteVehicleNews()

void DeleteVehicleNews | ( | VehicleID | vid,
|  | AdviceType | advice_type
| ) |  |

Delete news with a given advice type about a vehicle.

When the advice_type is AdviceType::Invalid all news about the vehicle gets deleted.

Parameters

  vid | The vehicle to remove the news for.
  advice_type | The advice type to remove for.

Definition at line 1015 of file news_gui.cpp.

References NewsItem::advice_type, and DeleteNews().

Referenced by AircraftHandleDestTooFar(), CmdStartStopVehicle(), DeleteOrderWarnings(), Vehicle::HandlePathfindingResult(), and Vehicle::~Vehicle().

## ◆ GetStatusbarNews()

const NewsItem * GetStatusbarNews | ( |  | ) |

Get pointer to the current status bar news item.

Returns
  Pointer to the current status bar news item, or nullptr if there is none.

Definition at line 70 of file news_gui.cpp.

References _news, and _statusbar_news.

Referenced by StatusBarWindow::DrawWidget(), and ReadyForNextTickerItem().

## ◆ InitNewsItemStructs()

void InitNewsItemStructs | ( |  | ) |

Initialize the news-items data structures.

Definition at line 714 of file news_gui.cpp.

References _current_news, _forced_news, _news, _statusbar_news, and NewsWindow::duration.

Referenced by DeleteAllMessages().

## ◆ NewsLoop()

void NewsLoop | ( |  | ) |

Definition at line 1092 of file news_gui.cpp.

## ◆ SerialiseNewsReference()

uint32_t SerialiseNewsReference | ( | const NewsReference & | reference | ) |

Encode a NewsReference for serialisation, e.g.

for writing in the crash log.

Parameters

  reference | The reference to serialise.

Returns
  Reference serialised into a single uint32_t.

Definition at line 920 of file news_gui.cpp.

Referenced by SurveyRecentNews().