1

/* $Id$ */

     2

     3

/** @file news_type.h Types related to news. */

     4

     5

#ifndef NEWS_TYPE_H

     6

#define NEWS_TYPE_H

     7

     8

#include "window_type.h"

     9

#include "date_type.h"

    10

#include "strings_type.h"

    11

#include "sound_type.h"

    12

    13

/**

    14

 * Type of news.

    15

 */

    16

enum NewsType {

    17

	NT_ARRIVAL_PLAYER,  ///< Cargo arrived for player

    18

	NT_ARRIVAL_OTHER,   ///< Cargo arrived for competitor

    19

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

    20

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

    21

	NT_OPENCLOSE,       ///< Opening and closing of industries

    22

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

    23

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

    24

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

    25

	NT_INDUSTRY_NOBODY, ///< Other industry production changes

    26

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

    27

	NT_NEW_VEHICLES,    ///< New vehicle has become available

    28

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

    29

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

    30

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

    31

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

    32

};

    33

    34

/**

    35

 * News mode.

    36

 */

    37

enum NewsMode {

    38

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

    39

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

    40

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

    41

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

    42

};

    43

    44

/**

    45

 * Various OR-able news-item flags.

    46

 * note: NF_INCOLOR is set automatically if needed

    47

 */

    48

enum NewsFlag {

    49

	NF_NONE      = 0,        ///< No flag is set.

    50

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

    51

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

    52

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

    53

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

    54

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

    55

};

    56

DECLARE_ENUM_AS_BIT_SET(NewsFlag);

    57

    58

    59

/**

    60

 * Special news items

    61

 */

    62

enum NewsCallback {

    63

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

    64

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

    65

	DNC_NONE          = 0xFF, ///< No news callback.

    66

};

    67

    68

/**

    69

 * Kinds of bankrupcy

    70

 * @note These flags are or'd with player index

    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

/**

    89

 * Per-NewsType data

    90

 */

    91

struct NewsTypeData {

    92

	const char *const name; ///< Name

    93

	const byte age;         ///< Maximum age of news items (in days)

    94

	const SoundFx sound;    ///< Sound

    96

};

    97

    98

struct NewsItem {

    99

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

   100

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

   101

	Date date;             ///< Date of the news

   102

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

   103

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

   104

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

   105

	NewsCallback callback; ///< Call-back function

   106

   107

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

   108

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

   109

   110

	uint64 params[10];

   111

};

   112

   113

typedef bool ValidationProc(uint data_a, uint data_b);

   114

typedef void DrawNewsCallbackProc(Window *w, const NewsItem *ni);

   115

typedef StringID GetNewsStringCallbackProc(const NewsItem *ni);

   116

   117

#endif /* NEWS_TYPE_H */