1

/* $Id$ */

     2

     3

/** @file news.h */

     4

     5

#ifndef NEWS_H

     6

#define NEWS_H

     7

     8

struct NewsItem {

     9

	StringID string_id;

    10

	uint16 duration;

    11

	Date date;

    12

	byte flags;

    13

	byte display_mode;

    14

	byte type;

    15

	byte callback;

    16

    17

	TileIndex data_a;

    18

	TileIndex data_b;

    19

    20

	uint32 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

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

    28

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

    29

void NewsLoop();

    30

void DrawNewsBorder(const Window *w);

    31

void InitNewsItemStructs();

    32

    33

VARDEF NewsItem _statusbar_news_item;

    34

    35

enum NewsType {

    36

	NT_ARRIVAL_PLAYER,

    37

	NT_ARRIVAL_OTHER,

    38

	NT_ACCIDENT,

    39

	NT_COMPANY_INFO,

    40

	NT_OPENCLOSE,

    41

	NT_ECONOMY,

    42

	NT_ADVICE,

    43

	NT_NEW_VEHICLES,

    44

	NT_ACCEPTANCE,

    45

	NT_SUBSIDIES,

    46

	NT_GENERAL,

    47

	NT_END,

    48

};

    49

    50

extern const char *_news_display_name[NT_END];

    51

    52

enum NewsMode {

    53

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

    54

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

    55

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

    56

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

    57

};

    58

    59

enum NewsFlags {

    60

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

    61

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

    62

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

    63

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

    64

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

    65

};

    66

    67

enum NewsCallback {

    68

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

    69

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

    70

};

    71

    72

enum NewsBankrupcy {

    73

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

    74

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

    75

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

    76

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

    77

};

    78

    79

/**

    80

 * Delete a news item type about a vehicle

    81

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

    82

 * deleted

    83

 */

    84

void DeleteVehicleNews(VehicleID, StringID news);

    85

    86

#endif /* NEWS_H */