1

/* $Id$ */

     2

     3

/** @file news.h */

     4

     5

#ifndef NEWS_H

     6

#define NEWS_H

     7

    13

struct NewsItem {

    14

	StringID string_id; ///< Message text (sometimes also used for storing other info)

    15

	uint16 duration;    ///< Remaining time for showing this news message

    16

	Date date;          ///< Date of the news

    17

	byte flags;         ///< NewsFlags bits @see NewsFlags

    18

	byte display_mode;  ///< Display mode value @see NewsMode

    19

	byte type;          ///< News category @see NewsType

    20

	byte callback;      ///< Call-back function

    21

    22

	TileIndex data_a;   ///< Reference to tile or vehicle

    23

	TileIndex data_b;   ///< Reference to second tile or vehicle

    24

    25

	uint64 params[10];

    26

};

    27

    28

typedef bool ValidationProc ( uint data_a, uint data_b );

    29

typedef void DrawNewsCallbackProc(Window *w);

    30

typedef StringID GetNewsStringCallbackProc(const NewsItem *ni);

    31

    32

/**

    33

 * Macro for creating news flags.

    34

 * @param mode (bits 0 - 7) Display_mode, one of the NewsMode enums (NM_)

    35

 * @param flag (bits 8 - 15) OR-able news flags, any of the NewsFlags enums (NF_)

    36

 * @param type (bits 16-23) News category, one of the NewsType enums (NT_)

    37

 * @param cb (bits 24-31) Call-back function, one of the NewsCallback enums (DNC_) or 0 if no callback

    38

 * @see NewsMode

    39

 * @see NewsFlags

    40

 * @see NewsType

    41

 * @see NewsCallback

    42

 * @see AddNewsItem

    43

 */

    44

#define NEWS_FLAGS(mode, flag, type, cb) ((cb) << 24 | (type) << 16 | (flag) << 8 | (mode))

    45

    46

void AddNewsItem(StringID string, uint32 flags, uint data_a, uint data_b);

    47

void NewsLoop();

    48

void DrawNewsBorder(const Window *w);

    49

void InitNewsItemStructs();

    50

    51

VARDEF NewsItem _statusbar_news_item;

    52

    53

/** Type of news. */

    54

enum NewsType {

    55

	NT_ARRIVAL_PLAYER,  ///< Cargo arrived for player

    56

	NT_ARRIVAL_OTHER,   ///< Cargo arrived for competitor

    57

	NT_ACCIDENT,        ///< An accident or disaster has occurred

    58

	NT_COMPANY_INFO,    ///< Company info (new companies, bankrupcy messages)

    59

	NT_OPENCLOSE,       ///< Opening and closing of industries

    60

	NT_ECONOMY,         ///< Economic changes (recession, industry up/dowm)

    61

	NT_INDUSTRY_PLAYER, ///< Production changes of industry serviced by local player

    62

	NT_INDUSTRY_OTHER,  ///< Production changes of industry serviced by competitor(s)

    63

	NT_INDUSTRY_NOBODY, ///< Other industry production changes

    64

	NT_ADVICE,          ///< Bits of news about vehicles of the player

    65

	NT_NEW_VEHICLES,    ///< New vehicle has become available

    66

	NT_ACCEPTANCE,      ///< A type of cargo is (no longer) accepted

    67

	NT_SUBSIDIES,       ///< News about subsidies (announcements, expirations, acceptance)

    68

	NT_GENERAL,         ///< General news (from towns)

    69

	NT_END,             ///< end-of-array marker

    70

};

    71

    72

extern const char *_news_display_name[NT_END];

    73

    74

/**

    75

 * News mode.

    76

 * @see NEWS_FLAGS

    77

 */

    78

enum NewsMode {

    79

	NM_SMALL    = 0, ///< Show only a small popup informing us about vehicle age for example

    80

	NM_NORMAL   = 1, ///< Show a simple news message (height 170 pixels)

    81

	NM_THIN     = 2, ///< Show a simple news message (height 130 pixels)

    82

	NM_CALLBACK = 3, ///< Do some special processing before displaying news message. Which callback to call is in NewsCallback

    83

};

    84

    85

/**

    86

 * Various OR-able news-item flags.

    87

 * note: NF_INCOLOR is set automatically if needed

    88

 * @see NEWS_FLAGS

    89

 */

    90

enum NewsFlags {

    91

	NF_VIEWPORT  = (1 << 1), ///< Does the news message have a viewport? (ingame picture of happening)

    92

	NF_TILE      = (1 << 2), ///< When clicked on the news message scroll to a given tile? Tile is in data_a/data_b

    93

	NF_VEHICLE   = (1 << 3), ///< When clicked on the message scroll to the vehicle? VehicleID is in data_a

    94

	NF_FORCE_BIG = (1 << 4), ///< Force the appearance of a news message if it has already been shown (internal)

    95

	NF_INCOLOR   = (1 << 5), ///< Show the newsmessage in colour, otherwise it defaults to black & white

    96

};

    97

    98

/** Special news items */

    99

enum NewsCallback {

   100

	DNC_VEHICLEAVAIL  = 0, ///< Show new vehicle available message. StringID is EngineID

   101

	DNC_BANKRUPCY     = 1, ///< Show bankrupcy message. StringID is PlayerID (0-3) and NewsBankrupcy (4-7)

   102

};

   103

   104

/** Kinds of bankrupcy */

   105

enum NewsBankrupcy {

   106

	NB_BTROUBLE    = (1 << 4), ///< Company is in trouble (warning)

   107

	NB_BMERGER     = (2 << 4), ///< Company has been bought by another company

   108

	NB_BBANKRUPT   = (3 << 4), ///< Company has gone bankrupt

   109

	NB_BNEWCOMPANY = (4 << 4), ///< A new company has been started

   110

};

   111

   112

/**

   113

 * Delete a news item type about a vehicle

   114

 * if the news item type is INVALID_STRING_ID all news about the vehicle get

   115

 * deleted

   116

 */

   117

void DeleteVehicleNews(VehicleID, StringID news);

   118

   119

#endif /* NEWS_H */