1

/* $Id$ */

     2

     3

/** @file news.h */

     4

     5

#ifndef NEWS_H

     6

#define NEWS_H

     7

     8

#include "window.h"

     9

    10

struct NewsItem {

    11

	StringID string_id;

    12

	uint16 duration;

    13

	Date date;

    14

	byte flags;

    15

	byte display_mode;

    16

	byte type;

    17

	byte callback;

    18

    19

	TileIndex data_a;

    20

	TileIndex data_b;

    21

    22

	uint32 params[10];

    23

};

    24

    25

typedef bool ValidationProc ( uint data_a, uint data_b );

    26

typedef void DrawNewsCallbackProc(BaseWindow *w);

    27

typedef StringID GetNewsStringCallbackProc(const NewsItem *ni);

    28

    30

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

    31

void NewsLoop();

    32

void DrawNewsBorder(const BaseWindow *w);

    33

void InitNewsItemStructs();

    34

    35

VARDEF NewsItem _statusbar_news_item;

    36

    37

enum NewsType {

    38

	NT_ARRIVAL_PLAYER,

    39

	NT_ARRIVAL_OTHER,

    40

	NT_ACCIDENT,

    41

	NT_COMPANY_INFO,

    42

	NT_OPENCLOSE,

    43

	NT_ECONOMY,

    44

	NT_ADVICE,

    45

	NT_NEW_VEHICLES,

    46

	NT_ACCEPTANCE,

    47

	NT_SUBSIDIES,

    48

	NT_GENERAL,

    49

	NT_END,

    50

};

    51

    52

extern const char *_news_display_name[NT_END];

    53

    54

enum NewsMode {

    55

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

    56

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

    57

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

    58

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

    59

};

    60

    61

enum NewsFlags {

    62

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

    63

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

    64

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

    65

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

    66

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

    67

};

    68

    69

enum NewsCallback {

    70

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

    71

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

    72

};

    73

    74

enum NewsBankrupcy {

    75

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

    76

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

    77

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

    78

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

    79

};

    80

    81

/**

    82

 * Delete a news item type about a vehicle

    83

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

    84

 * deleted

    85

 */

    86

void DeleteVehicleNews(VehicleID, StringID news);

    87

    88

#endif /* NEWS_H */