author | rubidium |
Thu, 08 May 2008 22:53:49 +0000 | |
changeset 9158 | b2de54b781eb |
parent 9010 | fa1aa6008a59 |
child 9199 | ce9fbdff6581 |
permissions | -rw-r--r-- |
2186 | 1 |
/* $Id$ */ |
2 |
||
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
3 |
/** @file news_type.h Types related to news. */ |
6348
6dd01da7a02b
(svn r9385) -Cleanup: doxygen changes. Today, we are exploring the letter N.
belugas
parents:
6283
diff
changeset
|
4 |
|
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
5 |
#ifndef NEWS_TYPE_H |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
6 |
#define NEWS_TYPE_H |
0 | 7 |
|
8106
e6790dd9e750
(svn r11667) -Codechange: split window.h into a header that defines some 'global' window related types, on that defined 'global' window functions and one that defines functions and types only used by *_gui.cpps.
rubidium
parents:
7891
diff
changeset
|
8 |
#include "window_type.h" |
8140
0d0d8c94f84b
(svn r11702) -Codechange: move all date related stuff to date*.
rubidium
parents:
8138
diff
changeset
|
9 |
#include "date_type.h" |
8264
b1e85998c7d3
(svn r11828) -Codechange: include table/* as the last includes and remove an unneeded include from openttd.h.
rubidium
parents:
8140
diff
changeset
|
10 |
#include "strings_type.h" |
8990
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
11 |
#include "sound_type.h" |
8106
e6790dd9e750
(svn r11667) -Codechange: split window.h into a header that defines some 'global' window related types, on that defined 'global' window functions and one that defines functions and types only used by *_gui.cpps.
rubidium
parents:
7891
diff
changeset
|
12 |
|
7598
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
13 |
/** |
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
14 |
* Type of news. |
7598
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
15 |
*/ |
4873
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
16 |
enum NewsType { |
7598
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
17 |
NT_ARRIVAL_PLAYER, ///< Cargo arrived for player |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
18 |
NT_ARRIVAL_OTHER, ///< Cargo arrived for competitor |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
19 |
NT_ACCIDENT, ///< An accident or disaster has occurred |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
20 |
NT_COMPANY_INFO, ///< Company info (new companies, bankrupcy messages) |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
21 |
NT_OPENCLOSE, ///< Opening and closing of industries |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
22 |
NT_ECONOMY, ///< Economic changes (recession, industry up/dowm) |
7891
aef0c16244d7
(svn r11442) -Feature: make news messages related to the industry (production) changes better configurable; you can now disable news messages popping up for industries you are not servicing. Patch by Alberth.
rubidium
parents:
7598
diff
changeset
|
23 |
NT_INDUSTRY_PLAYER, ///< Production changes of industry serviced by local player |
aef0c16244d7
(svn r11442) -Feature: make news messages related to the industry (production) changes better configurable; you can now disable news messages popping up for industries you are not servicing. Patch by Alberth.
rubidium
parents:
7598
diff
changeset
|
24 |
NT_INDUSTRY_OTHER, ///< Production changes of industry serviced by competitor(s) |
aef0c16244d7
(svn r11442) -Feature: make news messages related to the industry (production) changes better configurable; you can now disable news messages popping up for industries you are not servicing. Patch by Alberth.
rubidium
parents:
7598
diff
changeset
|
25 |
NT_INDUSTRY_NOBODY, ///< Other industry production changes |
7598
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
26 |
NT_ADVICE, ///< Bits of news about vehicles of the player |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
27 |
NT_NEW_VEHICLES, ///< New vehicle has become available |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
28 |
NT_ACCEPTANCE, ///< A type of cargo is (no longer) accepted |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
29 |
NT_SUBSIDIES, ///< News about subsidies (announcements, expirations, acceptance) |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
30 |
NT_GENERAL, ///< General news (from towns) |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
31 |
NT_END, ///< end-of-array marker |
0 | 32 |
}; |
33 |
||
7598
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
34 |
/** |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
35 |
* News mode. |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
36 |
*/ |
0 | 37 |
enum NewsMode { |
4873
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
38 |
NM_SMALL = 0, ///< Show only a small popup informing us about vehicle age for example |
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
39 |
NM_NORMAL = 1, ///< Show a simple news message (height 170 pixels) |
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
40 |
NM_THIN = 2, ///< Show a simple news message (height 130 pixels) |
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
41 |
NM_CALLBACK = 3, ///< Do some special processing before displaying news message. Which callback to call is in NewsCallback |
0 | 42 |
}; |
43 |
||
7598
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
44 |
/** |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
45 |
* Various OR-able news-item flags. |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
46 |
* note: NF_INCOLOR is set automatically if needed |
626c6a804e6d
(svn r11125) -Documentation: add/update the documentation of news*. Based on a patch by Progman.
rubidium
parents:
7006
diff
changeset
|
47 |
*/ |
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
48 |
enum NewsFlag { |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
49 |
NF_NONE = 0, ///< No flag is set. |
4873
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
50 |
NF_VIEWPORT = (1 << 1), ///< Does the news message have a viewport? (ingame picture of happening) |
9158
b2de54b781eb
(svn r13021) -Codechange: free data_b for other uses when it is not used to store a second tile to skip to (in news messages). Patch by cirdan.
rubidium
parents:
9010
diff
changeset
|
51 |
NF_TILE = (1 << 2), ///< When clicked on the news message scroll to a given tile? Tile is in data_a |
4873
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
52 |
NF_VEHICLE = (1 << 3), ///< When clicked on the message scroll to the vehicle? VehicleID is in data_a |
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
53 |
NF_FORCE_BIG = (1 << 4), ///< Force the appearance of a news message if it has already been shown (internal) |
4874
afafed841c6d
(svn r6804) -Codechange: Remove the unused NF_NOEXPIRE flag.
Darkvater
parents:
4873
diff
changeset
|
54 |
NF_INCOLOR = (1 << 5), ///< Show the newsmessage in colour, otherwise it defaults to black & white |
9158
b2de54b781eb
(svn r13021) -Codechange: free data_b for other uses when it is not used to store a second tile to skip to (in news messages). Patch by cirdan.
rubidium
parents:
9010
diff
changeset
|
55 |
NF_TILE2 = (1 << 6), ///< There is a second tile to scroll to; tile is in data_b |
0 | 56 |
}; |
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
57 |
DECLARE_ENUM_AS_BIT_SET(NewsFlag); |
0 | 58 |
|
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
59 |
|
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
60 |
/** |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
61 |
* Special news items |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
62 |
*/ |
4873
11880cbbc9f6
(svn r6803) -Codechange: Substitute magic numbers by an enum for the news windows
Darkvater
parents:
4344
diff
changeset
|
63 |
enum NewsCallback { |
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
64 |
DNC_VEHICLEAVAIL = 0, ///< Show new vehicle available message. StringID is EngineID |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
65 |
DNC_BANKRUPCY = 1, ///< Show bankrupcy message. StringID is PlayerID (0-3) and NewsBankrupcy (4-7) |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
66 |
DNC_NONE = 0xFF, ///< No news callback. |
0 | 67 |
}; |
68 |
||
3139
b17abef09e15
(svn r3757) -Feature: Delete news items about vehicles, when they get stale
tron
parents:
2186
diff
changeset
|
69 |
/** |
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
70 |
* Kinds of bankrupcy |
8921
9dfe5ee27bac
(svn r12691) -Fix (r12459): all company related news displayed the 'company is in trouble' message
glx
parents:
8763
diff
changeset
|
71 |
* @note These flags are or'd with player index |
3139
b17abef09e15
(svn r3757) -Feature: Delete news items about vehicles, when they get stale
tron
parents:
2186
diff
changeset
|
72 |
*/ |
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
73 |
enum NewsBankrupcy { |
8921
9dfe5ee27bac
(svn r12691) -Fix (r12459): all company related news displayed the 'company is in trouble' message
glx
parents:
8763
diff
changeset
|
74 |
NB_BTROUBLE = (1 << 4), ///< Company is in trouble (warning) |
9dfe5ee27bac
(svn r12691) -Fix (r12459): all company related news displayed the 'company is in trouble' message
glx
parents:
8763
diff
changeset
|
75 |
NB_BMERGER = (2 << 4), ///< Company has been bought by another company |
9dfe5ee27bac
(svn r12691) -Fix (r12459): all company related news displayed the 'company is in trouble' message
glx
parents:
8763
diff
changeset
|
76 |
NB_BBANKRUPT = (3 << 4), ///< Company has gone bankrupt |
9dfe5ee27bac
(svn r12691) -Fix (r12459): all company related news displayed the 'company is in trouble' message
glx
parents:
8763
diff
changeset
|
77 |
NB_BNEWCOMPANY = (4 << 4), ///< A new company has been started |
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
78 |
}; |
3139
b17abef09e15
(svn r3757) -Feature: Delete news items about vehicles, when they get stale
tron
parents:
2186
diff
changeset
|
79 |
|
8990
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
80 |
/** |
9010
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
81 |
* News display options |
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
82 |
*/ |
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
83 |
enum NewsDisplay { |
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
84 |
ND_OFF, ///< Only show a reminder in the status bar |
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
85 |
ND_SUMMARY, ///< Show ticker |
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
86 |
ND_FULL, ///< Show newspaper |
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
87 |
}; |
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
88 |
|
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
89 |
/** |
8990
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
90 |
* Per-NewsType data |
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
91 |
*/ |
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
92 |
struct NewsTypeData { |
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
93 |
const char *const name; ///< Name |
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
94 |
const byte age; ///< Maximum age of news items (in days) |
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
95 |
const SoundFx sound; ///< Sound |
9010
fa1aa6008a59
(svn r12805) -Codechange: remove some bit magic related to the news display states. Patch by cirdan.
rubidium
parents:
8990
diff
changeset
|
96 |
NewsDisplay display; ///< Display mode (off, summary, full) |
8990
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
97 |
}; |
0d5bb1c2a4a6
(svn r12785) -Codechange: put all news-type related constants in the same array. Patch by cirdan.
rubidium
parents:
8921
diff
changeset
|
98 |
|
8763
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
99 |
struct NewsItem { |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
100 |
StringID string_id; ///< Message text (sometimes also used for storing other info) |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
101 |
uint16 duration; ///< Remaining time for showing this news message |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
102 |
Date date; ///< Date of the news |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
103 |
NewsFlag flags; ///< NewsFlags bits @see NewsFlag |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
104 |
NewsMode display_mode; ///< Display mode value @see NewsMode |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
105 |
NewsType type; ///< News category @see NewsType |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
106 |
NewsCallback callback; ///< Call-back function |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
107 |
|
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
108 |
uint data_a; ///< Reference to tile or vehicle |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
109 |
uint data_b; ///< Reference to second tile or vehicle |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
110 |
|
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
111 |
uint64 params[10]; |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
112 |
}; |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
113 |
|
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
114 |
typedef bool ValidationProc(uint data_a, uint data_b); |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
115 |
typedef void DrawNewsCallbackProc(Window *w, const NewsItem *ni); |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
116 |
typedef StringID GetNewsStringCallbackProc(const NewsItem *ni); |
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
117 |
|
81fadd257f67
(svn r12459) -Codechange: split news.h into news_type.h and news_func.h.
rubidium
parents:
8270
diff
changeset
|
118 |
#endif /* NEWS_TYPE_H */ |