1

/* $Id$ */

     2

     3

/** @file news.h */

     4

     5

#ifndef NEWS_H

     6

#define NEWS_H

     7

     8

struct NewsItem {

     9

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

    10

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

    11

	Date date;          ///< Date of the news

    12

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

    13

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

    14

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

    15

	byte callback;      ///< Call-back function

    16

    17

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

    18

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

    19

    20

	uint64 params[10];

    21

};

    22

    23

typedef bool ValidationProc ( uint data_a, uint data_b );

    24

typedef void DrawNewsCallbackProc(Window *w);

    25

typedef StringID GetNewsStringCallbackProc(const NewsItem *ni);

    26

    27

/**

    28

 * Macro for creating news flags.

    29

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

    30

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

    31

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

    32

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

    33

 * @see NewsMode

    34

 * @see NewsFlags

    35

 * @see NewsType

    36

 * @see NewsCallback

    37

 * @see AddNewsItem

    38

 */

    39

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

    40

    41

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

    42

void NewsLoop();

    43

void DrawNewsBorder(const Window *w);

    44

void InitNewsItemStructs();

    45

    46

VARDEF NewsItem _statusbar_news_item;

    47

    48

/** Type of news. */

    49

enum NewsType {

    50

	NT_ARRIVAL_PLAYER,  ///< Cargo arrived for player

    51

	NT_ARRIVAL_OTHER,   ///< Cargo arrived for competitor

    52

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

    53

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

    54

	NT_OPENCLOSE,       ///< Opening and closing of industries

    55

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

    56

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

    57

	NT_NEW_VEHICLES,    ///< New vehicle has become available

    58

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

    59

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

    60

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

    61

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

    62

};

    63

    64

extern const char *_news_display_name[NT_END];

    65

    66

/**

    67

 * News mode.

    68

 * @see NEWS_FLAGS

    69

 */

    70

enum NewsMode {

    71

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

    72

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

    73

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

    74

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

    75

};

    76

    77

/**

    78

 * Various OR-able news-item flags.

    79

 * note: NF_INCOLOR is set automatically if needed

    80

 * @see NEWS_FLAGS

    81

 */

    82

enum NewsFlags {

    83

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

    84

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

    85

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

    86

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

    87

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

    88

};

    89

    90

/** Special news items */

    91

enum NewsCallback {

    92

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

    93

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

    94

};

    95

    96

/** Kinds of bankrupcy */

    97

enum NewsBankrupcy {

    98

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

    99

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

   100

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

   101

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

   102

};

   103

   104

/**

   105

 * Delete a news item type about a vehicle

   106

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

   107

 * deleted

   108

 */

   109

void DeleteVehicleNews(VehicleID, StringID news);

   110

   111

#endif /* NEWS_H */