author | richk |
Sun, 20 Apr 2008 15:27:28 +0000 | |
branch | NewGRF_ports |
changeset 10274 | b3c58f3df92b |
parent 10210 | a2131f7a315d |
child 10513 | 33cb70ff2f5d |
child 10724 | 68a692eacf22 |
permissions | -rw-r--r-- |
10184
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
1 |
/* $Id$ */ |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
2 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
3 |
/** @file news_type.h Types related to news. */ |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
4 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
5 |
#ifndef NEWS_TYPE_H |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
6 |
#define NEWS_TYPE_H |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
7 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
8 |
#include "window_type.h" |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
9 |
#include "date_type.h" |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
10 |
#include "strings_type.h" |
10274
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
11 |
#include "sound_type.h" |
10184
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
12 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
13 |
/** |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
14 |
* Type of news. |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
15 |
*/ |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
16 |
enum NewsType { |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
17 |
NT_ARRIVAL_PLAYER, ///< Cargo arrived for player |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
18 |
NT_ARRIVAL_OTHER, ///< Cargo arrived for competitor |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
19 |
NT_ACCIDENT, ///< An accident or disaster has occurred |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
20 |
NT_COMPANY_INFO, ///< Company info (new companies, bankrupcy messages) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
21 |
NT_OPENCLOSE, ///< Opening and closing of industries |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
22 |
NT_ECONOMY, ///< Economic changes (recession, industry up/dowm) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
23 |
NT_INDUSTRY_PLAYER, ///< Production changes of industry serviced by local player |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
24 |
NT_INDUSTRY_OTHER, ///< Production changes of industry serviced by competitor(s) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
25 |
NT_INDUSTRY_NOBODY, ///< Other industry production changes |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
26 |
NT_ADVICE, ///< Bits of news about vehicles of the player |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
27 |
NT_NEW_VEHICLES, ///< New vehicle has become available |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
28 |
NT_ACCEPTANCE, ///< A type of cargo is (no longer) accepted |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
29 |
NT_SUBSIDIES, ///< News about subsidies (announcements, expirations, acceptance) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
30 |
NT_GENERAL, ///< General news (from towns) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
31 |
NT_END, ///< end-of-array marker |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
32 |
}; |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
33 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
34 |
/** |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
35 |
* News mode. |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
36 |
*/ |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
37 |
enum NewsMode { |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
38 |
NM_SMALL = 0, ///< Show only a small popup informing us about vehicle age for example |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
39 |
NM_NORMAL = 1, ///< Show a simple news message (height 170 pixels) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
40 |
NM_THIN = 2, ///< Show a simple news message (height 130 pixels) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
41 |
NM_CALLBACK = 3, ///< Do some special processing before displaying news message. Which callback to call is in NewsCallback |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
42 |
}; |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
43 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
44 |
/** |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
45 |
* Various OR-able news-item flags. |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
46 |
* note: NF_INCOLOR is set automatically if needed |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
47 |
*/ |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
48 |
enum NewsFlag { |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
49 |
NF_NONE = 0, ///< No flag is set. |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
50 |
NF_VIEWPORT = (1 << 1), ///< Does the news message have a viewport? (ingame picture of happening) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
51 |
NF_TILE = (1 << 2), ///< When clicked on the news message scroll to a given tile? Tile is in data_a/data_b |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
52 |
NF_VEHICLE = (1 << 3), ///< When clicked on the message scroll to the vehicle? VehicleID is in data_a |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
53 |
NF_FORCE_BIG = (1 << 4), ///< Force the appearance of a news message if it has already been shown (internal) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
54 |
NF_INCOLOR = (1 << 5), ///< Show the newsmessage in colour, otherwise it defaults to black & white |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
55 |
}; |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
56 |
DECLARE_ENUM_AS_BIT_SET(NewsFlag); |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
57 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
58 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
59 |
/** |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
60 |
* Special news items |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
61 |
*/ |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
62 |
enum NewsCallback { |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
63 |
DNC_VEHICLEAVAIL = 0, ///< Show new vehicle available message. StringID is EngineID |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
64 |
DNC_BANKRUPCY = 1, ///< Show bankrupcy message. StringID is PlayerID (0-3) and NewsBankrupcy (4-7) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
65 |
DNC_NONE = 0xFF, ///< No news callback. |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
66 |
}; |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
67 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
68 |
/** |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
69 |
* Kinds of bankrupcy |
10210
a2131f7a315d
(svn r12742) [NewGRF_ports] -Sync: with trunk r12673:12705.
richk
parents:
10184
diff
changeset
|
70 |
* @note These flags are or'd with player index |
10184
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
71 |
*/ |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
72 |
enum NewsBankrupcy { |
10210
a2131f7a315d
(svn r12742) [NewGRF_ports] -Sync: with trunk r12673:12705.
richk
parents:
10184
diff
changeset
|
73 |
NB_BTROUBLE = (1 << 4), ///< Company is in trouble (warning) |
a2131f7a315d
(svn r12742) [NewGRF_ports] -Sync: with trunk r12673:12705.
richk
parents:
10184
diff
changeset
|
74 |
NB_BMERGER = (2 << 4), ///< Company has been bought by another company |
a2131f7a315d
(svn r12742) [NewGRF_ports] -Sync: with trunk r12673:12705.
richk
parents:
10184
diff
changeset
|
75 |
NB_BBANKRUPT = (3 << 4), ///< Company has gone bankrupt |
a2131f7a315d
(svn r12742) [NewGRF_ports] -Sync: with trunk r12673:12705.
richk
parents:
10184
diff
changeset
|
76 |
NB_BNEWCOMPANY = (4 << 4), ///< A new company has been started |
10184
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
77 |
}; |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
78 |
|
10274
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
79 |
/** |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
80 |
* News display options |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
81 |
*/ |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
82 |
enum NewsDisplay { |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
83 |
ND_OFF, ///< Only show a reminder in the status bar |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
84 |
ND_SUMMARY, ///< Show ticker |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
85 |
ND_FULL, ///< Show newspaper |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
86 |
}; |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
87 |
|
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
88 |
/** |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
89 |
* Per-NewsType data |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
90 |
*/ |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
91 |
struct NewsTypeData { |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
92 |
const char *const name; ///< Name |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
93 |
const byte age; ///< Maximum age of news items (in days) |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
94 |
const SoundFx sound; ///< Sound |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
95 |
NewsDisplay display; ///< Display mode (off, summary, full) |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
96 |
}; |
b3c58f3df92b
(svn r12806) [NewGRF_ports] -Sync: with trunk r12773:12805.
richk
parents:
10210
diff
changeset
|
97 |
|
10184
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
98 |
struct NewsItem { |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
99 |
StringID string_id; ///< Message text (sometimes also used for storing other info) |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
100 |
uint16 duration; ///< Remaining time for showing this news message |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
101 |
Date date; ///< Date of the news |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
102 |
NewsFlag flags; ///< NewsFlags bits @see NewsFlag |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
103 |
NewsMode display_mode; ///< Display mode value @see NewsMode |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
104 |
NewsType type; ///< News category @see NewsType |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
105 |
NewsCallback callback; ///< Call-back function |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
106 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
107 |
uint data_a; ///< Reference to tile or vehicle |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
108 |
uint data_b; ///< Reference to second tile or vehicle |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
109 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
110 |
uint64 params[10]; |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
111 |
}; |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
112 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
113 |
typedef bool ValidationProc(uint data_a, uint data_b); |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
114 |
typedef void DrawNewsCallbackProc(Window *w, const NewsItem *ni); |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
115 |
typedef StringID GetNewsStringCallbackProc(const NewsItem *ni); |
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
116 |
|
fcf5fb2548eb
(svn r12715) [NewGRF_ports] -Sync: with trunk r12351:12644.
richk
parents:
diff
changeset
|
117 |
#endif /* NEWS_TYPE_H */ |