1

/* $Id$ */

     2

     3

#ifndef NEWS_H

     4

#define NEWS_H

     5

     6

struct NewsItem {

     7

	StringID string_id;

     8

	uint16 duration;

     9

	Date date;

    10

	byte flags;

    11

	byte display_mode;

    12

	byte type;

    13

	byte callback;

    14

    15

	TileIndex data_a;

    16

	TileIndex data_b;

    17

    18

	uint32 params[10];

    19

};

    20

    21

typedef bool ValidationProc ( uint data_a, uint data_b );

    22

typedef void DrawNewsCallbackProc(Window *w);

    23

typedef StringID GetNewsStringCallbackProc(const NewsItem *ni);

    24

    25

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

    26

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

    27

void NewsLoop(void);

    28

void DrawNewsBorder(const Window *w);

    29

void InitNewsItemStructs(void);

    30

    31

VARDEF NewsItem _statusbar_news_item;

    32

    33

enum NewsType {

    34

	NT_ARRIVAL_PLAYER = 0,

    35

	NT_ARRIVAL_OTHER  = 1,

    36

	NT_ACCIDENT       = 2,

    37

	NT_COMPANY_INFO   = 3,

    38

	NT_ECONOMY        = 4,

    39

	NT_ADVICE         = 5,

    40

	NT_NEW_VEHICLES   = 6,

    41

	NT_ACCEPTANCE     = 7,

    42

	NT_SUBSIDIES      = 8,

    43

	NT_GENERAL        = 9,

    44

};

    45

    46

enum NewsMode {

    47

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

    48

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

    49

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

    50

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

    51

};

    52

    53

enum NewsFlags {

    54

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

    55

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

    56

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

    57

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

    58

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

    59

};

    60

    61

enum NewsCallback {

    62

	DNC_TRAINAVAIL    = 0, ///< Show new train available message. StringID is EngineID

    63

	DNC_ROADAVAIL     = 1, ///< Show new road vehicle available message. StringID is EngineID

    64

	DNC_SHIPAVAIL     = 2, ///< Show new ship available message. StringID is EngineID

    65

	DNC_AIRCRAFTAVAIL = 3, ///< Show new aircraft available message. StringID is EngineID

    66

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

    67

};

    68

    69

enum NewsBankrupcy {

    70

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

    71

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

    72

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

    73

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

    74

};

    75

    76

/**

    77

 * Delete a news item type about a vehicle

    78

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

    79

 * deleted

    80

 */

    81

void DeleteVehicleNews(VehicleID, StringID news);

    82

    83

#endif /* NEWS_H */