OpenTTD
news_type.h
Go to the documentation of this file.
1 /* $Id$ */
2 
3 /*
4  * This file is part of OpenTTD.
5  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
6  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
7  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
8  */
9 
12 #ifndef NEWS_TYPE_H
13 #define NEWS_TYPE_H
14 
15 #include "core/enum_type.hpp"
16 #include "date_type.h"
17 #include "strings_type.h"
18 #include "sound_type.h"
19 
23 enum NewsType {
40 };
41 
59 };
60 
65 enum NewsFlag {
68  NFB_SHADE = 2,
72 
77 
83 };
85 
86 
87 
94 };
95 
99 struct NewsTypeData {
100  const char * const name;
101  const byte age;
102  const SoundFx sound;
103 
110  NewsTypeData(const char *name, byte age, SoundFx sound) :
111  name(name),
112  age(age),
113  sound(sound)
114  {
115  }
116 
117  NewsDisplay GetDisplay() const;
118 };
119 
121 struct NewsItem {
128 
131  uint32 ref1;
132  uint32 ref2;
133 
134  void *free_data;
135 
136  ~NewsItem()
137  {
138  free(this->free_data);
139  }
140 
141  uint64 params[10];
142 };
143 
151  char company_name[64];
152  char president_name[64];
153  char other_company_name[64];
154 
155  uint32 face;
156  byte colour;
157 
158  void FillData(const struct Company *c, const struct Company *other = NULL);
159 };
160 
161 #endif /* NEWS_TYPE_H */
Closing of industries.
Definition: news_type.h:29
DECLARE_ENUM_AS_BIT_SET(GenderEthnicity) enum CompanyManagerFaceVariable
Bitgroups of the CompanyManagerFace variable.
First vehicle arrived for competitor.
Definition: news_type.h:25
News about subsidies (announcements, expirations, acceptance)
Definition: news_type.h:37
Thin news item. (Newspaper with headline and viewport)
Definition: news_type.h:78
Show newspaper.
Definition: news_type.h:93
Reference station. Scroll to station when clicking on the news. Delete news when station is deleted...
Definition: news_type.h:55
end-of-array marker
Definition: news_type.h:39
NewsReferenceType reftype2
Type of ref2.
Definition: news_type.h:130
const char *const name
Name.
Definition: news_type.h:100
Bits of news about vehicles of the company.
Definition: news_type.h:34
Other industry production changes.
Definition: news_type.h:33
NewsTypeData(const char *name, byte age, SoundFx sound)
Construct this entry.
Definition: news_type.h:110
First bit for window layout.
Definition: news_type.h:69
New vehicle has become available.
Definition: news_type.h:35
Opening of industries.
Definition: news_type.h:28
Data that needs to be stored for company news messages.
Definition: news_type.h:150
NewsReferenceType reftype1
Type of ref1.
Definition: news_type.h:129
Per-NewsType data.
Definition: news_type.h:99
Type (helpers) for enums.
Bit value for specifying that string param 0 contains a vehicle ID. (special autoreplace behaviour) ...
Definition: news_type.h:76
void * free_data
Data to be freed when the news item has reached its end.
Definition: news_type.h:134
Date date
Date of the news.
Definition: news_type.h:125
Only show a reminder in the status bar.
Definition: news_type.h:91
StringID string_id
Message text.
Definition: news_type.h:124
uint32 ref1
Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news...
Definition: news_type.h:131
NewsDisplay
News display options.
Definition: news_type.h:90
General news (from towns)
Definition: news_type.h:38
Bit value for disabling transparency.
Definition: news_type.h:74
NewsFlag
Various OR-able news-item flags.
Definition: news_type.h:65
Reference tile. Scroll to tile when clicking on the news.
Definition: news_type.h:53
Empty reference.
Definition: news_type.h:52
Normal news item. (Newspaper with text only)
Definition: news_type.h:80
NewsItem * prev
Previous news item.
Definition: news_type.h:122
uint32 ref2
Reference 2 to some object: Used for scrolling after clicking on the news, and for deleteing the news...
Definition: news_type.h:132
Bit value for coloured news.
Definition: news_type.h:73
News item is shown in colour (otherwise it is shown in black & white).
Definition: news_type.h:66
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:18
NewsDisplay GetDisplay() const
Return the news display option.
Definition: news_gui.cpp:250
Company news item. (Newspaper with face)
Definition: news_type.h:82
Number of bits for window layout.
Definition: news_type.h:70
uint32 face
The face of the president.
Definition: news_type.h:155
Show ticker.
Definition: news_type.h:92
NewsItem * next
Next news item.
Definition: news_type.h:123
Reference town. Scroll to town when clicking on the news.
Definition: news_type.h:57
Production changes of industry serviced by local company.
Definition: news_type.h:31
Company info (new companies, bankruptcy messages)
Definition: news_type.h:27
First vehicle arrived for company.
Definition: news_type.h:24
const SoundFx sound
Sound.
Definition: news_type.h:102
A type of cargo is (no longer) accepted.
Definition: news_type.h:36
NewsFlag flags
NewsFlags bits.
Definition: news_type.h:127
An accident or disaster has occurred.
Definition: news_type.h:26
Types related to sounds.
News item disables transparency in the viewport.
Definition: news_type.h:67
Types related to strings.
Types related to the dates in OpenTTD.
Reference engine.
Definition: news_type.h:58
NewsReferenceType
References to objects in news.
Definition: news_type.h:51
String param 0 contains a vehicle ID. (special autoreplace behaviour)
Definition: news_type.h:71
int32 Date
The type to store our dates in.
Definition: date_type.h:16
static void free(const void *ptr)
Version of the standard free that accepts const pointers.
Definition: depend.cpp:114
Reference industry. Scroll to industry when clicking on the news. Delete news when industry is delete...
Definition: news_type.h:56
NewsType type
Type of the news.
Definition: news_type.h:126
Small news item. (Information window with text and viewport)
Definition: news_type.h:79
Production changes of industry serviced by competitor(s)
Definition: news_type.h:32
NewsType
Type of news.
Definition: news_type.h:23
News item uses shaded colours.
Definition: news_type.h:68
Vehicle news item. (new engine available)
Definition: news_type.h:81
const byte age
Maximum age of news items (in days)
Definition: news_type.h:101
Reference vehicle. Scroll to vehicle when clicking on the news. Delete news when vehicle is deleted...
Definition: news_type.h:54
Bit value for enabling shading.
Definition: news_type.h:75
SoundFx
Sound effects from baseset.
Definition: sound_type.h:39
Information about a single item of news.
Definition: news_type.h:121
Economic changes (recession, industry up/dowm)
Definition: news_type.h:30
byte colour
The colour related to the company.
Definition: news_type.h:156