# news_type.h File Reference

Types related to news. More...

`#include "core/enum_type.hpp"`
`#include "date_type.h"`
`#include "strings_type.h"`
`#include "sound_type.h"`

Go to the source code of this file.

## Data Structures

struct | NewsTypeData
| Per-NewsType data. More...
struct | NewsItem
struct | CompanyNewsInformation
| Data that needs to be stored for company news messages. More...

## Enumerations

enum | NewsType { NT_ARRIVAL_COMPANY, NT_ARRIVAL_OTHER, NT_ACCIDENT, NT_COMPANY_INFO, NT_INDUSTRY_OPEN, NT_INDUSTRY_CLOSE, NT_ECONOMY, NT_INDUSTRY_COMPANY, NT_INDUSTRY_OTHER, NT_INDUSTRY_NOBODY, NT_ADVICE, NT_NEW_VEHICLES, NT_ACCEPTANCE, NT_SUBSIDIES, NT_GENERAL, NT_END }
| Type of news. More...
enum | NewsSubtype { NS_ARRIVAL_COMPANY, NS_ARRIVAL_OTHER, NS_ACCIDENT, NS_COMPANY_TROUBLE, NS_COMPANY_MERGER, NS_COMPANY_BANKRUPT, NS_COMPANY_NEW, NS_INDUSTRY_OPEN, NS_INDUSTRY_CLOSE, NS_ECONOMY, NS_INDUSTRY_COMPANY, NS_INDUSTRY_OTHER, NS_INDUSTRY_NOBODY, NS_ADVICE, NS_NEW_VEHICLES, NS_ACCEPTANCE, NS_SUBSIDIES, NS_GENERAL, NS_END }
| News subtypes. More...
enum | NewsReferenceType { NR_NONE, NR_TILE, NR_VEHICLE, NR_STATION, NR_INDUSTRY, NR_TOWN, NR_ENGINE }
| References to objects in news. More...
enum | NewsFlag { NFB_INCOLOUR = 0, NFB_NO_TRANSPARENT = 1, NFB_SHADE = 2, NF_NONE = 0, NF_INCOLOUR = 1 << 0, NF_NO_TRANSPARENT = 1 << 1, NF_SHADE = 1 << 2 }
| Various OR-able news-item flags. More...
enum | NewsDisplay { ND_OFF, ND_SUMMARY, ND_FULL }
| News display options. More...

## Functions

| DECLARE_ENUM_AS_BIT_SET (NewsFlag)

## Detailed Description

Types related to news.

Definition in file news_type.h.

## Enumeration Type Documentation

enum NewsDisplay

News display options.

Enumerator:

  ND_OFF | Only show a reminder in the status bar.
  ND_SUMMARY | Show ticker.
  ND_FULL | Show newspaper.

Definition at line 106 of file news_type.h.

enum NewsFlag

Various OR-able news-item flags.

Note:
  NF_INCOLOUR is set automatically if needed.

Enumerator:

  NFB_INCOLOUR | News item is shown in colour (otherwise it is shown in black & white).
  NFB_NO_TRANSPARENT | News item disables transparency in the viewport.
  NFB_SHADE | News item uses shaded colours.
  NF_NONE | No flag is set.
  NF_INCOLOUR | Bit value for coloured news.
  NF_NO_TRANSPARENT | Bit value for disabling transparency.
  NF_SHADE | Bit value for enabling shading.

Definition at line 90 of file news_type.h.

enum NewsReferenceType

References to objects in news.

Warning:
  Be careful! Vehicles are a special case, as news are kept when vehicles are autoreplaced/renewed. You have to make sure, ChangeVehicleNews catches the DParams of your message. This is NOT ensured by the references.

Enumerator:

  NR_NONE | Empty reference.
  NR_TILE | Reference tile. Scroll to tile when clicking on the news.
  NR_VEHICLE | Reference vehicle. Scroll to vehicle when clicking on the news. Delete news when vehicle is deleted.
  NR_STATION | Reference station. Scroll to station when clicking on the news. Delete news when station is deleted.
  NR_INDUSTRY | Reference industry. Scroll to industry when clicking on the news. Delete news when industry is deleted.
  NR_TOWN | Reference town. Scroll to town when clicking on the news.
  NR_ENGINE | Reference engine.

Definition at line 76 of file news_type.h.

enum NewsSubtype

News subtypes.

Enumerator:

  NS_ARRIVAL_COMPANY | NT_ARRIVAL_COMPANY.
  NS_ARRIVAL_OTHER | NT_ARRIVAL_OTHER.
  NS_ACCIDENT | NT_ACCIDENT.
  NS_COMPANY_TROUBLE | NT_COMPANY_INFO (trouble).
  NS_COMPANY_MERGER | NT_COMPANY_INFO (merger).
  NS_COMPANY_BANKRUPT | NT_COMPANY_INFO (bankrupt).
  NS_COMPANY_NEW | NT_COMPANY_INFO (new company).
  NS_INDUSTRY_OPEN | NT_INDUSTRY_OPEN.
  NS_INDUSTRY_CLOSE | NT_INDUSTRY_CLOSE.
  NS_ECONOMY | NT_ECONOMY.
  NS_INDUSTRY_COMPANY | NT_INDUSTRY_COMPANY.
  NS_INDUSTRY_OTHER | NT_INDUSTRY_OTHER.
  NS_INDUSTRY_NOBODY | NT_INDUSTRY_NOBODY.
  NS_ADVICE | NT_ADVICE.
  NS_NEW_VEHICLES | NT_NEW_VEHICLES.
  NS_ACCEPTANCE | NT_ACCEPTANCE.
  NS_SUBSIDIES | NT_SUBSIDIES.
  NS_GENERAL | NT_GENERAL.
  NS_END | end-of-array marker

Definition at line 45 of file news_type.h.

enum NewsType

Type of news.

Enumerator:

  NT_ARRIVAL_COMPANY | Cargo arrived for company.
  NT_ARRIVAL_OTHER | Cargo arrived for competitor.
  NT_ACCIDENT | An accident or disaster has occurred.
  NT_COMPANY_INFO | Company info (new companies, bankruptcy messages).
  NT_INDUSTRY_OPEN | Opening of industries.
  NT_INDUSTRY_CLOSE | Closing of industries.
  NT_ECONOMY | Economic changes (recession, industry up/dowm).
  NT_INDUSTRY_COMPANY | Production changes of industry serviced by local company.
  NT_INDUSTRY_OTHER | Production changes of industry serviced by competitor(s).
  NT_INDUSTRY_NOBODY | Other industry production changes.
  NT_ADVICE | Bits of news about vehicles of the company.
  NT_NEW_VEHICLES | New vehicle has become available.
  NT_ACCEPTANCE | A type of cargo is (no longer) accepted.
  NT_SUBSIDIES | News about subsidies (announcements, expirations, acceptance).
  NT_GENERAL | General news (from towns).
  NT_END | end-of-array marker

Definition at line 23 of file news_type.h.