OpenTTD Source: src/news_gui.cpp Source File

OpenTTD Source 12.2

news_gui.cpp
Go to the documentation of this file.
1 /*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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/>.
6 */
7
10 #include "stdafx.h"
11 #include "gui.h"
12 #include "viewport_func.h"
13 #include "strings_func.h"
14 #include "window_func.h"
15 #include "date_func.h"
16 #include "vehicle_base.h"
17 #include "vehicle_func.h"
18 #include "vehicle_gui.h"
19 #include "roadveh.h"
20 #include "station_base.h"
21 #include "industry.h"
22 #include "town.h"
23 #include "sound_func.h"
24 #include "string_func.h"
25 #include "widgets/dropdown_func.h"
26 #include "statusbar_gui.h"
27 #include "company_manager_face.h"
28 #include "company_func.h"
29 #include "engine_base.h"
30 #include "engine_gui.h"
31 #include "core/geometry_func.hpp"
32 #include "command_func.h"
33 #include "company_base.h"
34 #include "settings_internal.h"
35 #include "guitimer_func.h"
36 #include "group_gui.h"
37 #include "zoom_func.h"
38
39 #include "widgets/news_widget.h"
40
41 #include "table/strings.h"
42
43 #include "safeguards.h"
44
45 const NewsItem *_statusbar_news_item = nullptr;
46
47 static uint MIN_NEWS_AMOUNT = 30;
48 static uint MAX_NEWS_AMOUNT = 1 << 10;
49 static uint _total_news = 0;
50 static NewsItem *_oldest_news = nullptr;
51 NewsItem *_latest_news = nullptr;
52
59 static const NewsItem *_forced_news = nullptr;
60
62 static const NewsItem *_current_news = nullptr;
63
64
71 static TileIndex GetReferenceTile(NewsReferenceType reftype, uint32 ref)
72 {
73 switch (reftype) {
74 case NR_TILE: return (TileIndex)ref;
75 case NR_STATION: return Station::Get((StationID)ref)->xy;
76 case NR_INDUSTRY: return Industry::Get((IndustryID)ref)->location.tile + TileDiffXY(1, 1);
77 case NR_TOWN: return Town::Get((TownID)ref)->xy;
78 default: return INVALID_TILE;
79 }
80 }
81
82 /* Normal news items. */
83 static const NWidgetPart _nested_normal_news_widgets[] = {
84 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
85 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
86 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
87 NWidget(NWID_SPACER), SetFill(1, 0),
88 NWidget(NWID_VERTICAL),
89 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_DATE), SetDataTip(STR_DATE_LONG_SMALL, STR_NULL),
90 NWidget(NWID_SPACER), SetFill(0, 1),
91 EndContainer(),
92 EndContainer(),
93 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(428, 154), SetPadding(0, 5, 1, 5),
94 EndContainer(),
95 };
96
97 static WindowDesc _normal_news_desc(
98 WDP_MANUAL, nullptr, 0, 0,
99 WC_NEWS_WINDOW, WC_NONE,
100 0,
101 _nested_normal_news_widgets, lengthof(_nested_normal_news_widgets)
102 );
103
104 /* New vehicles news items. */
105 static const NWidgetPart _nested_vehicle_news_widgets[] = {
106 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
107 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
108 NWidget(NWID_VERTICAL),
109 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
110 NWidget(NWID_SPACER), SetFill(0, 1),
111 EndContainer(),
112 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_VEH_TITLE), SetFill(1, 1), SetMinimalSize(419, 55), SetDataTip(STR_EMPTY, STR_NULL),
113 EndContainer(),
114 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_VEH_BKGND), SetPadding(0, 25, 1, 25),
115 NWidget(NWID_VERTICAL),
116 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_NAME), SetMinimalSize(369, 33), SetFill(1, 0),
117 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_SPR), SetMinimalSize(369, 32), SetFill(1, 0),
118 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_INFO), SetMinimalSize(369, 46), SetFill(1, 0),
119 EndContainer(),
120 EndContainer(),
121 EndContainer(),
122 };
123
124 static WindowDesc _vehicle_news_desc(
125 WDP_MANUAL, nullptr, 0, 0,
126 WC_NEWS_WINDOW, WC_NONE,
127 0,
128 _nested_vehicle_news_widgets, lengthof(_nested_vehicle_news_widgets)
129 );
130
131 /* Company news items. */
132 static const NWidgetPart _nested_company_news_widgets[] = {
133 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
134 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
135 NWidget(NWID_VERTICAL),
136 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
137 NWidget(NWID_SPACER), SetFill(0, 1),
138 EndContainer(),
139 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_TITLE), SetFill(1, 1), SetMinimalSize(410, 20), SetDataTip(STR_EMPTY, STR_NULL),
140 EndContainer(),
141 NWidget(NWID_HORIZONTAL), SetPadding(0, 1, 1, 1),
142 NWidget(NWID_VERTICAL),
143 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MGR_FACE), SetMinimalSize(93, 119), SetPadding(2, 6, 2, 1),
144 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MGR_NAME), SetMinimalSize(93, 24), SetPadding(0, 0, 0, 1),
145 NWidget(NWID_SPACER), SetFill(0, 1),
146 EndContainer(),
147 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_COMPANY_MSG), SetFill(1, 1), SetMinimalSize(328, 150),
148 EndContainer(),
149 EndContainer(),
150 };
151
152 static WindowDesc _company_news_desc(
153 WDP_MANUAL, nullptr, 0, 0,
154 WC_NEWS_WINDOW, WC_NONE,
155 0,
156 _nested_company_news_widgets, lengthof(_nested_company_news_widgets)
157 );
158
159 /* Thin news items. */
160 static const NWidgetPart _nested_thin_news_widgets[] = {
161 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
162 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
163 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
164 NWidget(NWID_SPACER), SetFill(1, 0),
165 NWidget(NWID_VERTICAL),
166 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_DATE), SetDataTip(STR_DATE_LONG_SMALL, STR_NULL),
167 NWidget(NWID_SPACER), SetFill(0, 1),
168 EndContainer(),
169 EndContainer(),
170 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(428, 48), SetFill(1, 0), SetPadding(0, 5, 0, 5),
171 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_N_VIEWPORT), SetMinimalSize(426, 70), SetPadding(1, 2, 2, 2),
172 EndContainer(),
173 };
174
175 static WindowDesc _thin_news_desc(
176 WDP_MANUAL, nullptr, 0, 0,
177 WC_NEWS_WINDOW, WC_NONE,
178 0,
179 _nested_thin_news_widgets, lengthof(_nested_thin_news_widgets)
180 );
181
182 /* Small news items. */
183 static const NWidgetPart _nested_small_news_widgets[] = {
184 /* Caption + close box. The caption is no WWT_CAPTION as the window shall not be moveable and so on. */
185 NWidget(NWID_HORIZONTAL),
186 NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE, WID_N_CLOSEBOX),
187 NWidget(WWT_EMPTY, COLOUR_LIGHT_BLUE, WID_N_CAPTION), SetFill(1, 0),
188 NWidget(WWT_TEXTBTN, COLOUR_LIGHT_BLUE, WID_N_SHOW_GROUP), SetMinimalSize(14, 11), SetResize(1, 0),
189 SetDataTip(STR_NULL /* filled in later */, STR_NEWS_SHOW_VEHICLE_GROUP_TOOLTIP),
190 EndContainer(),
191
192 /* Main part */
193 NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE, WID_N_HEADLINE),
194 NWidget(WWT_INSET, COLOUR_LIGHT_BLUE, WID_N_INSET), SetPadding(2, 2, 2, 2),
195 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_N_VIEWPORT), SetMinimalSize(274, 47), SetFill(1, 0),
196 EndContainer(),
197 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(275, 20), SetFill(1, 0), SetPadding(0, 5, 0, 5),
198 EndContainer(),
199 };
200
201 static WindowDesc _small_news_desc(
202 WDP_MANUAL, nullptr, 0, 0,
203 WC_NEWS_WINDOW, WC_NONE,
204 0,
205 _nested_small_news_widgets, lengthof(_nested_small_news_widgets)
206 );
207
211 static WindowDesc* _news_window_layout[] = {
212 &_thin_news_desc,
213 &_small_news_desc,
214 &_normal_news_desc,
215 &_vehicle_news_desc,
216 &_company_news_desc,
217 };
218
219 WindowDesc* GetNewsWindowLayout(NewsFlag flags)
220 {
221 uint layout = GB(flags, NFB_WINDOW_LAYOUT, NFB_WINDOW_LAYOUT_COUNT);
222 assert(layout < lengthof(_news_window_layout));
223 return _news_window_layout[layout];
224 }
225
229 static NewsTypeData _news_type_data[] = {
230 /* name, age, sound, */
231 NewsTypeData("news_display.arrival_player", 60, SND_1D_APPLAUSE ),
232 NewsTypeData("news_display.arrival_other", 60, SND_1D_APPLAUSE ),
233 NewsTypeData("news_display.accident", 90, SND_BEGIN ),
234 NewsTypeData("news_display.company_info", 60, SND_BEGIN ),
235 NewsTypeData("news_display.open", 90, SND_BEGIN ),
236 NewsTypeData("news_display.close", 90, SND_BEGIN ),
237 NewsTypeData("news_display.economy", 30, SND_BEGIN ),
238 NewsTypeData("news_display.production_player", 30, SND_BEGIN ),
239 NewsTypeData("news_display.production_other", 30, SND_BEGIN ),
240 NewsTypeData("news_display.production_nobody", 30, SND_BEGIN ),
241 NewsTypeData("news_display.advice", 150, SND_BEGIN ),
242 NewsTypeData("news_display.new_vehicles", 30, SND_1E_NEW_ENGINE),
243 NewsTypeData("news_display.acceptance", 90, SND_BEGIN ),
244 NewsTypeData("news_display.subsidies", 180, SND_BEGIN ),
245 NewsTypeData("news_display.general", 60, SND_BEGIN ),
246 };
247
248 static_assert(lengthof(_news_type_data) == NT_END);
249
254 NewsDisplay NewsTypeData::GetDisplay() const
255 {
256 const SettingDesc *sd = GetSettingFromName(this->name);
257 assert(sd != nullptr && sd->IsIntSetting());
258 return (NewsDisplay)sd->AsIntSetting()->Read(nullptr);
259 }
260
262 struct NewsWindow : Window {
263 uint16 chat_height;
264 uint16 status_height;
265 const NewsItem *ni;
266 static int duration;
267
268 GUITimer timer;
269
270 NewsWindow(WindowDesc *desc, const NewsItem *ni) : Window(desc), ni(ni)
271 {
272 NewsWindow::duration = 16650;
273 const Window *w = FindWindowByClass(WC_SEND_NETWORK_MSG);
274 this->chat_height = (w != nullptr) ? w->height : 0;
275 this->status_height = FindWindowById(WC_STATUS_BAR, 0)->height;
276
277 this->flags |= WF_DISABLE_VP_SCROLL;
278
279 this->timer.SetInterval(15);
280
281 this->CreateNestedTree();
282
283 /* For company news with a face we have a separate headline in param[0] */
284 if (desc == &_company_news_desc) this->GetWidget<NWidgetCore>(WID_N_TITLE)->widget_data = this->ni->params[0];
285
286 NWidgetCore *nwid = this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP);
287 if (ni->reftype1 == NR_VEHICLE && nwid != nullptr) {
288 const Vehicle *v = Vehicle::Get(ni->ref1);
289 switch (v->type) {
290 case VEH_TRAIN:
291 nwid->widget_data = STR_TRAIN;
292 break;
293 case VEH_ROAD:
294 nwid->widget_data = RoadVehicle::From(v)->IsBus() ? STR_BUS : STR_LORRY;
295 break;
296 case VEH_SHIP:
297 nwid->widget_data = STR_SHIP;
298 break;
299 case VEH_AIRCRAFT:
300 nwid->widget_data = STR_PLANE;
301 break;
302 default:
303 break; // Do nothing
304 }
305 }
306
307 this->FinishInitNested(0);
308
309 /* Initialize viewport if it exists. */
310 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_N_VIEWPORT);
311 if (nvp != nullptr) {
312 nvp->InitializeViewport(this, ni->reftype1 == NR_VEHICLE ? 0x80000000 | ni->ref1 : GetReferenceTile(ni->reftype1, ni->ref1), ZOOM_LVL_NEWS);
313 if (this->ni->flags & NF_NO_TRANSPARENT) nvp->disp_flags |= ND_NO_TRANSPARENCY;
314 if ((this->ni->flags & NF_INCOLOUR) == 0) {
315 nvp->disp_flags |= ND_SHADE_GREY;
316 } else if (this->ni->flags & NF_SHADE) {
317 nvp->disp_flags |= ND_SHADE_DIMMED;
318 }
319 }
320
321 PositionNewsMessage(this);
322 }
323
324 void DrawNewsBorder(const Rect &r) const
325 {
326 GfxFillRect(r.left, r.top, r.right, r.bottom, PC_WHITE);
327
328 GfxFillRect(r.left, r.top, r.left, r.bottom, PC_BLACK);
329 GfxFillRect(r.right, r.top, r.right, r.bottom, PC_BLACK);
330 GfxFillRect(r.left, r.top, r.right, r.top, PC_BLACK);
331 GfxFillRect(r.left, r.bottom, r.right, r.bottom, PC_BLACK);
332 }
333
334 Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
335 {
336 Point pt = { 0, _screen.height };
337 return pt;
338 }
339
340 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
341 {
342 StringID str = STR_NULL;
343 switch (widget) {
344 case WID_N_CAPTION: {
345 /* Caption is not a real caption (so that the window cannot be moved)
346 * thus it doesn't get the default sizing of a caption. */
347 Dimension d2 = GetStringBoundingBox(STR_NEWS_MESSAGE_CAPTION);
348 d2.height += WD_CAPTIONTEXT_TOP + WD_CAPTIONTEXT_BOTTOM;
349 *size = maxdim(*size, d2);
350 return;
351 }
352
353 case WID_N_MGR_FACE:
354 *size = maxdim(*size, GetSpriteSize(SPR_GRADIENT));
355 break;
356
357 case WID_N_MGR_NAME:
358 SetDParamStr(0, static_cast<const CompanyNewsInformation *>(this->ni->data.get())->president_name);
359 str = STR_JUST_RAW_STRING;
360 break;
361
362 case WID_N_MESSAGE:
363 CopyInDParam(0, this->ni->params, lengthof(this->ni->params));
364 str = this->ni->string_id;
365 break;
366
367 case WID_N_COMPANY_MSG:
368 str = this->GetCompanyMessageString();
369 break;
370
371 case WID_N_VEH_NAME:
372 case WID_N_VEH_TITLE:
373 str = this->GetNewVehicleMessageString(widget);
374 break;
375
376 case WID_N_VEH_INFO: {
377 assert(this->ni->reftype1 == NR_ENGINE);
378 EngineID engine = this->ni->ref1;
379 str = GetEngineInfoString(engine);
380 break;
381 }
382
383 case WID_N_SHOW_GROUP:
384 if (this->ni->reftype1 == NR_VEHICLE) {
385 Dimension d2 = GetStringBoundingBox(this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP)->widget_data);
386 d2.height += WD_CAPTIONTEXT_TOP + WD_CAPTIONTEXT_BOTTOM;
387 d2.width += WD_CAPTIONTEXT_LEFT + WD_CAPTIONTEXT_RIGHT;
388 *size = d2;
389 } else {
390 /* Hide 'Show group window' button if this news is not about a vehicle. */
391 size->width = 0;
392 size->height = 0;
393 resize->width = 0;
394 resize->height = 0;
395 fill->width = 0;
396 fill->height = 0;
397 }
398 return;
399
400 default:
401 return; // Do nothing
402 }
403
404 /* Update minimal size with length of the multi-line string. */
405 Dimension d = *size;
406 d.width = (d.width >= padding.width) ? d.width - padding.width : 0;
407 d.height = (d.height >= padding.height) ? d.height - padding.height : 0;
408 d = GetStringMultiLineBoundingBox(str, d);
409 d.width += padding.width;
410 d.height += padding.height;
411 *size = maxdim(*size, d);
412 }
413
414 void SetStringParameters(int widget) const override
415 {
416 if (widget == WID_N_DATE) SetDParam(0, this->ni->date);
417 }
418
419 void DrawWidget(const Rect &r, int widget) const override
420 {
421 switch (widget) {
422 case WID_N_CAPTION:
423 DrawCaption(r, COLOUR_LIGHT_BLUE, this->owner, TC_FROMSTRING, STR_NEWS_MESSAGE_CAPTION, SA_CENTER);
424 break;
425
426 case WID_N_PANEL:
427 this->DrawNewsBorder(r);
428 break;
429
430 case WID_N_MESSAGE:
431 CopyInDParam(0, this->ni->params, lengthof(this->ni->params));
432 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->ni->string_id, TC_FROMSTRING, SA_CENTER);
433 break;
434
435 case WID_N_MGR_FACE: {
436 const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
437 DrawCompanyManagerFace(cni->face, cni->colour, r.left, r.top);
438 GfxFillRect(r.left, r.top, r.right, r.bottom, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
439 break;
440 }
441 case WID_N_MGR_NAME: {
442 const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
443 SetDParamStr(0, cni->president_name);
444 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, STR_JUST_RAW_STRING, TC_FROMSTRING, SA_CENTER);
445 break;
446 }
447 case WID_N_COMPANY_MSG:
448 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->GetCompanyMessageString(), TC_FROMSTRING, SA_CENTER);
449 break;
450
451 case WID_N_VEH_BKGND:
452 GfxFillRect(r.left, r.top, r.right, r.bottom, PC_GREY);
453 break;
454
455 case WID_N_VEH_NAME:
456 case WID_N_VEH_TITLE:
457 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->GetNewVehicleMessageString(widget), TC_FROMSTRING, SA_CENTER);
458 break;
459
460 case WID_N_VEH_SPR: {
461 assert(this->ni->reftype1 == NR_ENGINE);
462 EngineID engine = this->ni->ref1;
463 DrawVehicleEngine(r.left, r.right, (r.left + r.right) / 2, (r.top + r.bottom) / 2, engine, GetEnginePalette(engine, _local_company), EIT_PREVIEW);
464 GfxFillRect(r.left, r.top, r.right, r.bottom, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
465 break;
466 }
467 case WID_N_VEH_INFO: {
468 assert(this->ni->reftype1 == NR_ENGINE);
469 EngineID engine = this->ni->ref1;
470 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, GetEngineInfoString(engine), TC_FROMSTRING, SA_CENTER);
471 break;
472 }
473 }
474 }
475
476 void OnClick(Point pt, int widget, int click_count) override
477 {
478 switch (widget) {
479 case WID_N_CLOSEBOX:
480 NewsWindow::duration = 0;
481 this->Close();
482 _forced_news = nullptr;
483 break;
484
485 case WID_N_CAPTION:
486 if (this->ni->reftype1 == NR_VEHICLE) {
487 const Vehicle *v = Vehicle::Get(this->ni->ref1);
488 ShowVehicleViewWindow(v);
489 }
490 break;
491
492 case WID_N_VIEWPORT:
493 break; // Ignore clicks
494
495 case WID_N_SHOW_GROUP:
496 if (this->ni->reftype1 == NR_VEHICLE) {
497 const Vehicle *v = Vehicle::Get(this->ni->ref1);
498 ShowCompanyGroupForVehicle(v);
499 }
500 break;
501 default:
502 if (this->ni->reftype1 == NR_VEHICLE) {
503 const Vehicle *v = Vehicle::Get(this->ni->ref1);
504 ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
505 } else {
506 TileIndex tile1 = GetReferenceTile(this->ni->reftype1, this->ni->ref1);
507 TileIndex tile2 = GetReferenceTile(this->ni->reftype2, this->ni->ref2);
508 if (_ctrl_pressed) {
509 if (tile1 != INVALID_TILE) ShowExtraViewportWindow(tile1);
510 if (tile2 != INVALID_TILE) ShowExtraViewportWindow(tile2);
511 } else {
512 if ((tile1 == INVALID_TILE || !ScrollMainWindowToTile(tile1)) && tile2 != INVALID_TILE) {
513 ScrollMainWindowToTile(tile2);
514 }
515 }
516 }
517 break;
518 }
519 }
520
526 void OnInvalidateData(int data = 0, bool gui_scope = true) override
527 {
528 if (!gui_scope) return;
529 /* The chatbar has notified us that is was either created or closed */
530 int newtop = this->top + this->chat_height - data;
531 this->chat_height = data;
532 this->SetWindowTop(newtop);
533 }
534
535 void OnRealtimeTick(uint delta_ms) override
536 {
537 int count = this->timer.CountElapsed(delta_ms);
538 if (count > 0) {
539 /* Scroll up newsmessages from the bottom */
540 int newtop = std::max(this->top - 2 * count, _screen.height - this->height - this->status_height - this->chat_height);
541 this->SetWindowTop(newtop);
542 }
543
544 /* Decrement the news timer. We don't need to action an elapsed event here,
545 * so no need to use TimerElapsed(). */
546 if (NewsWindow::duration > 0) NewsWindow::duration -= delta_ms;
547 }
548
549 private:
554 void SetWindowTop(int newtop)
555 {
556 if (this->top == newtop) return;
557
558 int mintop = std::min(newtop, this->top);
559 int maxtop = std::max(newtop, this->top);
560 if (this->viewport != nullptr) this->viewport->top += newtop - this->top;
561 this->top = newtop;
562
563 AddDirtyBlock(this->left, mintop, this->left + this->width, maxtop + this->height);
564 }
565
566 StringID GetCompanyMessageString() const
567 {
568 /* Company news with a face have a separate headline, so the normal message is shifted by two params */
569 CopyInDParam(0, this->ni->params + 2, lengthof(this->ni->params) - 2);
570 return this->ni->params[1];
571 }
572
573 StringID GetNewVehicleMessageString(int widget) const
574 {
575 assert(this->ni->reftype1 == NR_ENGINE);
576 EngineID engine = this->ni->ref1;
577
578 switch (widget) {
579 case WID_N_VEH_TITLE:
580 SetDParam(0, GetEngineCategoryName(engine));
581 return STR_NEWS_NEW_VEHICLE_NOW_AVAILABLE;
582
583 case WID_N_VEH_NAME:
584 SetDParam(0, engine);
585 return STR_NEWS_NEW_VEHICLE_TYPE;
586
587 default:
588 NOT_REACHED();
589 }
590 }
591 };
592
593 /* static */ int NewsWindow::duration = 0; // Instance creation.
594
596 static void ShowNewspaper(const NewsItem *ni)
597 {
598 SoundFx sound = _news_type_data[ni->type].sound;
599 if (sound != 0 && _settings_client.sound.news_full) SndPlayFx(sound);
600
601 new NewsWindow(GetNewsWindowLayout(ni->flags), ni);
602 }
603
605 static void ShowTicker(const NewsItem *ni)
606 {
607 if (_settings_client.sound.news_ticker) SndPlayFx(SND_16_NEWS_TICKER);
608
609 _statusbar_news_item = ni;
610 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_TICKER);
611 }
612
614 void InitNewsItemStructs()
615 {
616 for (NewsItem *ni = _oldest_news; ni != nullptr; ) {
617 NewsItem *next = ni->next;
618 delete ni;
619 ni = next;
620 }
621
622 _total_news = 0;
623 _oldest_news = nullptr;
624 _latest_news = nullptr;
625 _forced_news = nullptr;
626 _current_news = nullptr;
627 _statusbar_news_item = nullptr;
628 NewsWindow::duration = 0;
629 }
630
635 static bool ReadyForNextTickerItem()
636 {
637 const NewsItem *ni = _statusbar_news_item;
638 if (ni == nullptr) return true;
639
640 /* Ticker message
641 * Check if the status bar message is still being displayed? */
642 return !IsNewsTickerShown();
643 }
644
649 static bool ReadyForNextNewsItem()
650 {
651 const NewsItem *ni = _forced_news == nullptr ? _current_news : _forced_news;
652 if (ni == nullptr) return true;
653
654 /* neither newsticker nor newspaper are running */
655 return (NewsWindow::duration <= 0 || FindWindowById(WC_NEWS_WINDOW, 0) == nullptr);
656 }
657
659 static void MoveToNextTickerItem()
660 {
661 /* There is no status bar, so no reason to show news;
662 * especially important with the end game screen when
663 * there is no status bar but possible news. */
664 if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
665
666 /* if we're not at the last item, then move on */
667 while (_statusbar_news_item != _latest_news) {
668 _statusbar_news_item = (_statusbar_news_item == nullptr) ? _oldest_news : _statusbar_news_item->next;
669 const NewsItem *ni = _statusbar_news_item;
670 const NewsType type = ni->type;
671
672 /* check the date, don't show too old items */
673 if (_date - _news_type_data[type].age > ni->date) continue;
674
675 switch (_news_type_data[type].GetDisplay()) {
676 default: NOT_REACHED();
677 case ND_OFF: // Off - show nothing only a small reminder in the status bar
678 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_REMINDER);
679 break;
680
681 case ND_SUMMARY: // Summary - show ticker
682 ShowTicker(ni);
683 break;
684
685 case ND_FULL: // Full - show newspaper, skipped here
686 continue;
687 }
688 return;
689 }
690 }
691
693 static void MoveToNextNewsItem()
694 {
695 /* There is no status bar, so no reason to show news;
696 * especially important with the end game screen when
697 * there is no status bar but possible news. */
698 if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
699
700 CloseWindowById(WC_NEWS_WINDOW, 0); // close the newspapers window if shown
701 _forced_news = nullptr;
702
703 /* if we're not at the last item, then move on */
704 while (_current_news != _latest_news) {
705 _current_news = (_current_news == nullptr) ? _oldest_news : _current_news->next;
706 const NewsItem *ni = _current_news;
707 const NewsType type = ni->type;
708
709 /* check the date, don't show too old items */
710 if (_date - _news_type_data[type].age > ni->date) continue;
711
712 switch (_news_type_data[type].GetDisplay()) {
713 default: NOT_REACHED();
714 case ND_OFF: // Off - show nothing only a small reminder in the status bar, skipped here
715 continue;
716
717 case ND_SUMMARY: // Summary - show ticker, skipped here
718 continue;
719
720 case ND_FULL: // Full - show newspaper
721 ShowNewspaper(ni);
722 break;
723 }
724 return;
725 }
726 }
727
729 static void DeleteNewsItem(NewsItem *ni)
730 {
731 /* Delete the news from the news queue. */
732 if (ni->prev != nullptr) {
733 ni->prev->next = ni->next;
734 } else {
735 assert(_oldest_news == ni);
736 _oldest_news = ni->next;
737 }
738
739 if (ni->next != nullptr) {
740 ni->next->prev = ni->prev;
741 } else {
742 assert(_latest_news == ni);
743 _latest_news = ni->prev;
744 }
745
746 _total_news--;
747
748 if (_forced_news == ni || _current_news == ni) {
749 /* When we're the current news, go to the previous item first;
750 * we just possibly made that the last news item. */
751 if (_current_news == ni) _current_news = ni->prev;
752
753 /* About to remove the currently forced item (shown as newspapers) ||
754 * about to remove the currently displayed item (newspapers) */
755 MoveToNextNewsItem();
756 }
757
758 if (_statusbar_news_item == ni) {
759 /* When we're the current news, go to the previous item first;
760 * we just possibly made that the last news item. */
761 _statusbar_news_item = ni->prev;
762
763 /* About to remove the currently displayed item (ticker, or just a reminder) */
764 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED); // invalidate the statusbar
765 MoveToNextTickerItem();
766 }
767
768 delete ni;
769
770 SetWindowDirty(WC_MESSAGE_HISTORY, 0);
771 }
772
786 NewsItem::NewsItem(StringID string_id, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data) :
787 string_id(string_id), date(_date), type(type), flags(flags), reftype1(reftype1), reftype2(reftype2), ref1(ref1), ref2(ref2), data(data)
788 {
789 /* show this news message in colour? */
790 if (_cur_year >= _settings_client.gui.coloured_news_year) this->flags |= NF_INCOLOUR;
791 CopyOutDParam(this->params, 0, lengthof(this->params));
792 }
793
807 void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data)
808 {
809 if (_game_mode == GM_MENU) return;
810
811 /* Create new news item node */
812 NewsItem *ni = new NewsItem(string, type, flags, reftype1, ref1, reftype2, ref2, data);
813
814 if (_total_news++ == 0) {
815 assert(_oldest_news == nullptr);
816 _oldest_news = ni;
817 ni->prev = nullptr;
818 } else {
819 assert(_latest_news->next == nullptr);
820 _latest_news->next = ni;
821 ni->prev = _latest_news;
822 }
823
824 ni->next = nullptr;
825 _latest_news = ni;
826
827 /* Keep the number of stored news items to a managable number */
828 if (_total_news > MAX_NEWS_AMOUNT) {
829 DeleteNewsItem(_oldest_news);
830 }
831
832 SetWindowDirty(WC_MESSAGE_HISTORY, 0);
833 }
834
847 CommandCost CmdCustomNewsItem(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
848 {
849 if (_current_company != OWNER_DEITY) return CMD_ERROR;
850
851 NewsType type = (NewsType)GB(p1, 0, 8);
852 NewsReferenceType reftype1 = (NewsReferenceType)GB(p1, 8, 8);
853 CompanyID company = (CompanyID)GB(p1, 16, 8);
854
855 if (company != INVALID_OWNER && !Company::IsValidID(company)) return CMD_ERROR;
856 if (type >= NT_END) return CMD_ERROR;
857 if (text.empty()) return CMD_ERROR;
858
859 switch (reftype1) {
860 case NR_NONE: break;
861 case NR_TILE:
862 if (!IsValidTile(p2)) return CMD_ERROR;
863 break;
864
865 case NR_VEHICLE:
866 if (!Vehicle::IsValidID(p2)) return CMD_ERROR;
867 break;
868
869 case NR_STATION:
870 if (!Station::IsValidID(p2)) return CMD_ERROR;
871 break;
872
873 case NR_INDUSTRY:
874 if (!Industry::IsValidID(p2)) return CMD_ERROR;
875 break;
876
877 case NR_TOWN:
878 if (!Town::IsValidID(p2)) return CMD_ERROR;
879 break;
880
881 case NR_ENGINE:
882 if (!Engine::IsValidID(p2)) return CMD_ERROR;
883 break;
884
885 default: return CMD_ERROR;
886 }
887
888 if (company != INVALID_OWNER && company != _local_company) return CommandCost();
889
890 if (flags & DC_EXEC) {
891 NewsStringData *news = new NewsStringData(text);
892 SetDParamStr(0, news->string);
893 AddNewsItem(STR_NEWS_CUSTOM_ITEM, type, NF_NORMAL, reftype1, p2, NR_NONE, UINT32_MAX, news);
894 }
895
896 return CommandCost();
897 }
898
905 void DeleteVehicleNews(VehicleID vid, StringID news)
906 {
907 NewsItem *ni = _oldest_news;
908
909 while (ni != nullptr) {
910 NewsItem *next = ni->next;
911 if (((ni->reftype1 == NR_VEHICLE && ni->ref1 == vid) || (ni->reftype2 == NR_VEHICLE && ni->ref2 == vid)) &&
912 (news == INVALID_STRING_ID || ni->string_id == news)) {
913 DeleteNewsItem(ni);
914 }
915 ni = next;
916 }
917 }
918
924 void DeleteStationNews(StationID sid)
925 {
926 NewsItem *ni = _oldest_news;
927
928 while (ni != nullptr) {
929 NewsItem *next = ni->next;
930 if ((ni->reftype1 == NR_STATION && ni->ref1 == sid) || (ni->reftype2 == NR_STATION && ni->ref2 == sid)) {
931 DeleteNewsItem(ni);
932 }
933 ni = next;
934 }
935 }
936
941 void DeleteIndustryNews(IndustryID iid)
942 {
943 NewsItem *ni = _oldest_news;
944
945 while (ni != nullptr) {
946 NewsItem *next = ni->next;
947 if ((ni->reftype1 == NR_INDUSTRY && ni->ref1 == iid) || (ni->reftype2 == NR_INDUSTRY && ni->ref2 == iid)) {
948 DeleteNewsItem(ni);
949 }
950 ni = next;
951 }
952 }
953
957 void DeleteInvalidEngineNews()
958 {
959 NewsItem *ni = _oldest_news;
960
961 while (ni != nullptr) {
962 NewsItem *next = ni->next;
963 if ((ni->reftype1 == NR_ENGINE && (!Engine::IsValidID(ni->ref1) || !Engine::Get(ni->ref1)->IsEnabled())) ||
964 (ni->reftype2 == NR_ENGINE && (!Engine::IsValidID(ni->ref2) || !Engine::Get(ni->ref2)->IsEnabled()))) {
965 DeleteNewsItem(ni);
966 }
967 ni = next;
968 }
969 }
970
971 static void RemoveOldNewsItems()
972 {
973 NewsItem *next;
974 for (NewsItem *cur = _oldest_news; _total_news > MIN_NEWS_AMOUNT && cur != nullptr; cur = next) {
975 next = cur->next;
976 if (_date - _news_type_data[cur->type].age * _settings_client.gui.news_message_timeout > cur->date) DeleteNewsItem(cur);
977 }
978 }
979
986 void ChangeVehicleNews(VehicleID from_index, VehicleID to_index)
987 {
988 for (NewsItem *ni = _oldest_news; ni != nullptr; ni = ni->next) {
989 if (ni->reftype1 == NR_VEHICLE && ni->ref1 == from_index) ni->ref1 = to_index;
990 if (ni->reftype2 == NR_VEHICLE && ni->ref2 == from_index) ni->ref2 = to_index;
991 if (ni->flags & NF_VEHICLE_PARAM0 && ni->params[0] == from_index) ni->params[0] = to_index;
992 }
993 }
994
995 void NewsLoop()
996 {
997 /* no news item yet */
998 if (_total_news == 0) return;
999
1000 static byte _last_clean_month = 0;
1001
1002 if (_last_clean_month != _cur_month) {
1003 RemoveOldNewsItems();
1004 _last_clean_month = _cur_month;
1005 }
1006
1007 if (ReadyForNextTickerItem()) MoveToNextTickerItem();
1008 if (ReadyForNextNewsItem()) MoveToNextNewsItem();
1009 }
1010
1012 static void ShowNewsMessage(const NewsItem *ni)
1013 {
1014 assert(_total_news != 0);
1015
1016 /* Delete the news window */
1017 CloseWindowById(WC_NEWS_WINDOW, 0);
1018
1019 /* setup forced news item */
1020 _forced_news = ni;
1021
1022 if (_forced_news != nullptr) {
1023 CloseWindowById(WC_NEWS_WINDOW, 0);
1024 ShowNewspaper(ni);
1025 }
1026 }
1027
1032 bool HideActiveNewsMessage() {
1033 NewsWindow *w = (NewsWindow*)FindWindowById(WC_NEWS_WINDOW, 0);
1034 if (w == nullptr) return false;
1035 w->Close();
1036 return true;
1037 }
1038
1040 void ShowLastNewsMessage()
1041 {
1042 const NewsItem *ni = nullptr;
1043 if (_total_news == 0) {
1044 return;
1045 } else if (_forced_news == nullptr) {
1046 /* Not forced any news yet, show the current one, unless a news window is
1047 * open (which can only be the current one), then show the previous item */
1048 if (_current_news == nullptr) {
1049 /* No news were shown yet resp. the last shown one was already deleted.
1050 * Threat this as if _forced_news reached _oldest_news; so, wrap around and start anew with the latest. */
1051 ni = _latest_news;
1052 } else {
1053 const Window *w = FindWindowById(WC_NEWS_WINDOW, 0);
1054 ni = (w == nullptr || (_current_news == _oldest_news)) ? _current_news : _current_news->prev;
1055 }
1056 } else if (_forced_news == _oldest_news) {
1057 /* We have reached the oldest news, start anew with the latest */
1058 ni = _latest_news;
1059 } else {
1060 /* 'Scrolling' through news history show each one in turn */
1061 ni = _forced_news->prev;
1062 }
1063 bool wrap = false;
1064 for (;;) {
1065 if (_news_type_data[ni->type].GetDisplay() != ND_OFF) {
1066 ShowNewsMessage(ni);
1067 break;
1068 }
1069
1070 ni = ni->prev;
1071 if (ni == nullptr) {
1072 if (wrap) break;
1073 /* We have reached the oldest news, start anew with the latest */
1074 ni = _latest_news;
1075 wrap = true;
1076 }
1077 }
1078 }
1079
1080
1090 static void DrawNewsString(uint left, uint right, int y, TextColour colour, const NewsItem *ni)
1091 {
1092 char buffer[512], buffer2[512];
1093 StringID str;
1094
1095 CopyInDParam(0, ni->params, lengthof(ni->params));
1096 str = ni->string_id;
1097
1098 GetString(buffer, str, lastof(buffer));
1099 /* Copy the just gotten string to another buffer to remove any formatting
1100 * from it such as big fonts, etc. */
1101 const char *ptr = buffer;
1102 char *dest = buffer2;
1103 WChar c_last = '\0';
1104 for (;;) {
1105 WChar c = Utf8Consume(&ptr);
1106 if (c == 0) break;
1107 /* Make a space from a newline, but ignore multiple newlines */
1108 if (c == '\n' && c_last != '\n') {
1109 dest[0] = ' ';
1110 dest++;
1111 } else if (c == '\r') {
1112 dest[0] = dest[1] = dest[2] = dest[3] = ' ';
1113 dest += 4;
1114 } else if (IsPrintable(c)) {
1115 dest += Utf8Encode(dest, c);
1116 }
1117 c_last = c;
1118 }
1119
1120 *dest = '\0';
1121 /* Truncate and show string; postfixed by '...' if necessary */
1122 DrawString(left, right, y, buffer2, colour);
1123 }
1124
1125 struct MessageHistoryWindow : Window {
1126 static const int top_spacing;
1127 static const int bottom_spacing;
1128
1129 int line_height;
1130 int date_width;
1131
1132 Scrollbar *vscroll;
1133
1134 MessageHistoryWindow(WindowDesc *desc) : Window(desc)
1135 {
1136 this->CreateNestedTree();
1137 this->vscroll = this->GetScrollbar(WID_MH_SCROLLBAR);
1138 this->FinishInitNested(); // Initializes 'this->line_height' and 'this->date_width'.
1139 this->OnInvalidateData(0);
1140 }
1141
1142 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1143 {
1144 if (widget == WID_MH_BACKGROUND) {
1145 this->line_height = FONT_HEIGHT_NORMAL + 2;
1146 resize->height = this->line_height;
1147
1148 /* Months are off-by-one, so it's actually 8. Not using
1149 * month 12 because the 1 is usually less wide. */
1150 SetDParam(0, ConvertYMDToDate(ORIGINAL_MAX_YEAR, 7, 30));
1151 this->date_width = GetStringBoundingBox(STR_SHORT_DATE).width;
1152
1153 size->height = 4 * resize->height + this->top_spacing + this->bottom_spacing; // At least 4 lines are visible.
1154 size->width = std::max(200u, size->width); // At least 200 pixels wide.
1155 }
1156 }
1157
1158 void OnPaint() override
1159 {
1160 this->OnInvalidateData(0);
1161 this->DrawWidgets();
1162 }
1163
1164 void DrawWidget(const Rect &r, int widget) const override
1165 {
1166 if (widget != WID_MH_BACKGROUND || _total_news == 0) return;
1167
1168 /* Find the first news item to display. */
1169 NewsItem *ni = _latest_news;
1170 for (int n = this->vscroll->GetPosition(); n > 0; n--) {
1171 ni = ni->prev;
1172 if (ni == nullptr) return;
1173 }
1174
1175 /* Fill the widget with news items. */
1176 int y = r.top + this->top_spacing;
1177 bool rtl = _current_text_dir == TD_RTL;
1178 uint date_left = rtl ? r.right - WD_FRAMERECT_RIGHT - this->date_width : r.left + WD_FRAMERECT_LEFT;
1179 uint date_right = rtl ? r.right - WD_FRAMERECT_RIGHT : r.left + WD_FRAMERECT_LEFT + this->date_width;
1180 uint news_left = rtl ? r.left + WD_FRAMERECT_LEFT : r.left + WD_FRAMERECT_LEFT + this->date_width + WD_FRAMERECT_RIGHT + ScaleFontTrad(5);
1181 uint news_right = rtl ? r.right - WD_FRAMERECT_RIGHT - this->date_width - WD_FRAMERECT_RIGHT - ScaleFontTrad(5) : r.right - WD_FRAMERECT_RIGHT;
1182 for (int n = this->vscroll->GetCapacity(); n > 0; n--) {
1183 SetDParam(0, ni->date);
1184 DrawString(date_left, date_right, y, STR_SHORT_DATE);
1185
1186 DrawNewsString(news_left, news_right, y, TC_WHITE, ni);
1187 y += this->line_height;
1188
1189 ni = ni->prev;
1190 if (ni == nullptr) return;
1191 }
1192 }
1193
1199 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1200 {
1201 if (!gui_scope) return;
1202 this->vscroll->SetCount(_total_news);
1203 }
1204
1205 void OnClick(Point pt, int widget, int click_count) override
1206 {
1207 if (widget == WID_MH_BACKGROUND) {
1208 NewsItem *ni = _latest_news;
1209 if (ni == nullptr) return;
1210
1211 for (int n = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_MH_BACKGROUND, WD_FRAMERECT_TOP); n > 0; n--) {
1212 ni = ni->prev;
1213 if (ni == nullptr) return;
1214 }
1215
1216 ShowNewsMessage(ni);
1217 }
1218 }
1219
1220 void OnResize() override
1221 {
1222 this->vscroll->SetCapacityFromWidget(this, WID_MH_BACKGROUND);
1223 }
1224 };
1225
1226 const int MessageHistoryWindow::top_spacing = WD_FRAMERECT_TOP + 4;
1227 const int MessageHistoryWindow::bottom_spacing = WD_FRAMERECT_BOTTOM;
1228
1229 static const NWidgetPart _nested_message_history[] = {
1230 NWidget(NWID_HORIZONTAL),
1231 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1232 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_MESSAGE_HISTORY, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1233 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1234 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1235 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1236 EndContainer(),
1237
1238 NWidget(NWID_HORIZONTAL),
1239 NWidget(WWT_PANEL, COLOUR_BROWN, WID_MH_BACKGROUND), SetMinimalSize(200, 125), SetDataTip(0x0, STR_MESSAGE_HISTORY_TOOLTIP), SetResize(1, 12), SetScrollbar(WID_MH_SCROLLBAR),
1240 EndContainer(),
1241 NWidget(NWID_VERTICAL),
1242 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_MH_SCROLLBAR),
1243 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
1244 EndContainer(),
1245 EndContainer(),
1246 };
1247
1248 static WindowDesc _message_history_desc(
1249 WDP_AUTO, "list_news", 400, 140,
1250 WC_MESSAGE_HISTORY, WC_NONE,
1251 0,
1252 _nested_message_history, lengthof(_nested_message_history)
1253 );
1254
1256 void ShowMessageHistory()
1257 {
1258 CloseWindowById(WC_MESSAGE_HISTORY, 0);
1259 new MessageHistoryWindow(&_message_history_desc);
1260 }
VEH_AIRCRAFT
@ VEH_AIRCRAFT
Aircraft vehicle type.
Definition: vehicle_type.h:27
GetEngineInfoString
StringID GetEngineInfoString(EngineID engine)
Get a multi-line string with some technical data, describing the engine.
Definition: engine_gui.cpp:266
NewsWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: news_gui.cpp:414
PC_WHITE
static const uint8 PC_WHITE
White palette colour.
Definition: gfx_func.h:195
WID_N_PANEL
@ WID_N_PANEL
Panel of the window.
Definition: news_widget.h:17
MessageHistoryWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: news_gui.cpp:1199
WID_MH_SCROLLBAR
@ WID_MH_SCROLLBAR
Scrollbar for the list.
Definition: news_widget.h:41
WD_FRAMERECT_TOP
@ WD_FRAMERECT_TOP
Offset at top to draw the frame rectangular area.
Definition: window_gui.h:64
NewsWindow::chat_height
uint16 chat_height
Height of the chat window.
Definition: news_gui.cpp:263
TileIndex
uint32 TileIndex
The index/ID of a Tile.
Definition: tile_type.h:83
NewsItem::NewsItem
NewsItem(StringID string_id, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data)
Create a new newsitem to be shown.
Definition: news_gui.cpp:786
InvalidateWindowData
void InvalidateWindowData(WindowClass cls, WindowNumber number, int data, bool gui_scope)
Mark window data of the window of a given class and specific window number as invalid (in need of re-...
Definition: window.cpp:3234
EIT_PREVIEW
@ EIT_PREVIEW
Vehicle drawn in preview window, news, ...
Definition: vehicle_type.h:91
sound_func.h
DeleteStationNews
void DeleteStationNews(StationID sid)
Remove news regarding given station so there are no 'unknown station now accepts Mail' or 'First trai...
Definition: news_gui.cpp:924
Pool::PoolItem<&_industry_pool >::Get
static Titem * Get(size_t index)
Returns Titem with given index.
Definition: pool_type.hpp:337
ScrollMainWindowToTile
bool ScrollMainWindowToTile(TileIndex tile, bool instant)
Scrolls the viewport of the main window to a given location.
Definition: viewport.cpp:2445
vehicle_gui.h
NewsItem::data
std::unique_ptr< const NewsAllocatedData > data
Custom data for the news item that will be deallocated (deleted) when the news item has reached its e...
Definition: news_type.h:138
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
AddDirtyBlock
void AddDirtyBlock(int left, int top, int right, int bottom)
Extend the internal _invalid_rect rectangle to contain the rectangle defined by the given parameters.
Definition: gfx.cpp:1708
Vehicle::y_pos
int32 y_pos
y coordinate.
Definition: vehicle_base.h:281
CompanyNewsInformation::colour
byte colour
The colour related to the company.
Definition: news_type.h:163
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3136
NewsWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: news_gui.cpp:340
CopyOutDParam
void CopyOutDParam(uint64 *dst, int offs, int num)
Copy num string parameters from the global string parameter array to the dst array.
Definition: strings.cpp:139
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1188
ShowExtraViewportWindow
void ShowExtraViewportWindow(TileIndex tile=INVALID_TILE)
Show a new Extra Viewport window.
Definition: viewport_gui.cpp:168
GB
static uint GB(const T x, const uint8 s, const uint8 n)
Fetch n bits from x, started at bit s.
Definition: bitmath_func.hpp:32
NewsWindow::duration
static int duration
Remaining time for showing the current news message (may only be access while a news item is displaye...
Definition: news_gui.cpp:266
Vehicle::x_pos
int32 x_pos
x coordinate.
Definition: vehicle_base.h:280
NewsWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: news_gui.cpp:419
ScaleFontTrad
static int ScaleFontTrad(int value)
Scale traditional pixel dimensions to Font zoom level.
Definition: zoom_func.h:96
Dimension
Dimensions (a width and height) of a rectangle in 2D.
Definition: geometry_type.hpp:27
Scrollbar::GetCapacity
uint16 GetCapacity() const
Gets the number of visible elements of the scrollbar.
Definition: widget_type.h:662
command_func.h
MessageHistoryWindow::bottom_spacing
static const int bottom_spacing
Additional spacing at the bottom of the WID_MH_BACKGROUND widget.
Definition: news_gui.cpp:1127
WID_N_MGR_FACE
@ WID_N_MGR_FACE
Face of the manager.
Definition: news_widget.h:27
DrawNewsString
static void DrawNewsString(uint left, uint right, int y, TextColour colour, const NewsItem *ni)
Draw an unformatted news message truncated to a maximum length.
Definition: news_gui.cpp:1090
WWT_STICKYBOX
@ WWT_STICKYBOX
Sticky box (at top-right of a window, after WWT_DEFSIZEBOX)
Definition: widget_type.h:64
SetPadding
static NWidgetPart SetPadding(uint8 top, uint8 right, uint8 bottom, uint8 left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1139
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:23
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:320
dropdown_func.h
GetSettingFromName
static const SettingDesc * GetSettingFromName(const std::string_view name, const SettingTable &settings)
Given a name of setting, return a setting description from the table.
Definition: settings.cpp:1419
_news_window_layout
static WindowDesc * _news_window_layout[]
Window layouts for news items.
Definition: news_gui.cpp:211
guitimer_func.h
statusbar_gui.h
NewsItem
Information about a single item of news.
Definition: news_type.h:125
company_base.h
_cur_year
Year _cur_year
Current year, starting at 0.
Definition: date.cpp:26
WID_N_SHOW_GROUP
@ WID_N_SHOW_GROUP
Show vehicle's group.
Definition: news_widget.h:34
CompanyNewsInformation::president_name
std::string president_name
The name of the president.
Definition: news_type.h:159
NWidgetViewport
Nested widget to display a viewport in a window.
Definition: widget_type.h:615
WWT_CAPTION
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:59
Vehicle::z_pos
int32 z_pos
z coordinate.
Definition: vehicle_base.h:282
NewsAllocatedData
Container for any custom data that must be deleted after the news item has reached end-of-life.
Definition: news_type.h:119
NewsItem::ref2
uint32 ref2
Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news ...
Definition: news_type.h:136
NewsTypeData
Per-NewsType data.
Definition: news_type.h:97
NR_STATION
@ NR_STATION
Reference station. Scroll to station when clicking on the news. Delete news when station is deleted.
Definition: news_type.h:53
WF_DISABLE_VP_SCROLL
@ WF_DISABLE_VP_SCROLL
Window does not do autoscroll,.
Definition: window_gui.h:241
Window::viewport
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:321
ND_SHADE_DIMMED
@ ND_SHADE_DIMMED
Bit value of the 'dimmed colours' flag.
Definition: widget_type.h:299
WWT_LABEL
@ WWT_LABEL
Centered label.
Definition: widget_type.h:55
FILLRECT_RECOLOUR
@ FILLRECT_RECOLOUR
Apply a recolour sprite to the screen content.
Definition: gfx_type.h:289
WWT_DEFSIZEBOX
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:63
group_gui.h
Window::CreateNestedTree
void CreateNestedTree(bool fill_nested=true)
Perform the first part of the initialization of a nested widget tree.
Definition: window.cpp:1760
company_manager_face.h
NWID_HORIZONTAL
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:73
Viewport::top
int top
Screen coordinate top edge of the viewport.
Definition: viewport_type.h:24
WID_N_MESSAGE
@ WID_N_MESSAGE
Space for displaying the message. Only used in small news items.
Definition: news_widget.h:26
maxdim
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Definition: geometry_func.cpp:22
FindWindowById
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
Definition: window.cpp:1146
ND_FULL
@ ND_FULL
Show newspaper.
Definition: news_type.h:91
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:710
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:36
Utf8Encode
size_t Utf8Encode(T buf, WChar c)
Encode a unicode character and place it in the buffer.
Definition: string.cpp:616
WID_N_VEH_BKGND
@ WID_N_VEH_BKGND
Dark background of new vehicle news.
Definition: news_widget.h:30
GetEngineCategoryName
StringID GetEngineCategoryName(EngineID engine)
Return the category of an engine.
Definition: engine_gui.cpp:38
ShowMessageHistory
void ShowMessageHistory()
Display window with news messages history.
Definition: news_gui.cpp:1256
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:250
vehicle_base.h
ChangeVehicleNews
void ChangeVehicleNews(VehicleID from_index, VehicleID to_index)
Report a change in vehicle IDs (due to autoreplace) to affected vehicle news.
Definition: news_gui.cpp:986
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:993
zoom_func.h
WID_N_CLOSEBOX
@ WID_N_CLOSEBOX
Close the window.
Definition: news_widget.h:20
WC_MESSAGE_HISTORY
@ WC_MESSAGE_HISTORY
News history list; Window numbers:
Definition: window_type.h:264
SpecializedStation< Station, false >::Get
static Station * Get(size_t index)
Gets station with given index.
Definition: base_station_base.h:219
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:52
DrawString
int DrawString(int left, int right, int top, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
Definition: gfx.cpp:643
SpecializedStation< Station, false >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index is a valid index for station of this type.
Definition: base_station_base.h:210
WWT_EMPTY
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:46
town.h
Window::owner
Owner owner
The owner of the content shown in this window. Company colour is acquired from this variable.
Definition: window_gui.h:319
NFB_WINDOW_LAYOUT
@ NFB_WINDOW_LAYOUT
First bit for window layout.
Definition: news_type.h:67
NewsItem::reftype2
NewsReferenceType reftype2
Type of ref2.
Definition: news_type.h:134
NF_VEHICLE_PARAM0
@ NF_VEHICLE_PARAM0
Bit value for specifying that string param 0 contains a vehicle ID. (special autoreplace behaviour)
Definition: news_type.h:74
MessageHistoryWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: news_gui.cpp:1220
NewsWindow::SetWindowTop
void SetWindowTop(int newtop)
Moves the window to a new top coordinate.
Definition: news_gui.cpp:554
settings_internal.h
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:221
IsNewsTickerShown
bool IsNewsTickerShown()
Checks whether the news ticker is currently being used.
Definition: statusbar_gui.cpp:265
WID_N_INSET
@ WID_N_INSET
Inset around the viewport in the window. Only used in small news items.
Definition: news_widget.h:23
Scrollbar::GetScrolledRowFromWidget
int GetScrolledRowFromWidget(int clickpos, const Window *const w, int widget, int padding=0) const
Compute the row of a scrolled widget that a user clicked in.
Definition: widget.cpp:2098
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:629
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:348
GetEnginePalette
PaletteID GetEnginePalette(EngineID engine_type, CompanyID company)
Get the colour map for an engine.
Definition: vehicle.cpp:2052
SetDParam
static void SetDParam(uint n, uint64 v)
Set a string parameter v at index n in the global string parameter array.
Definition: strings_func.h:196
NWidgetPart
Partial widget specification to allow NWidgets to be written nested.
Definition: widget_type.h:971
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:346
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1107
NWidgetCore::widget_data
uint32 widget_data
Data of the widget.
Definition: widget_type.h:335
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:889
DrawStringMultiLine
int DrawStringMultiLine(int left, int right, int top, int bottom, const char *str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
Definition: gfx.cpp:788
NewsWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: news_gui.cpp:526
SND_1E_NEW_ENGINE
@ SND_1E_NEW_ENGINE
28 == 0x1C News: new engine available
Definition: sound_type.h:67
MessageHistoryWindow::vscroll
Scrollbar * vscroll
< Width needed for the date part.
Definition: news_gui.cpp:1132
NewsItem::flags
NewsFlag flags
NewsFlags bits.
Definition: news_type.h:131
NF_NO_TRANSPARENT
@ NF_NO_TRANSPARENT
Bit value for disabling transparency.
Definition: news_type.h:72
NewsTypeData::age
const byte age
Maximum age of news items (in days)
Definition: news_type.h:99
NewsTypeData::sound
const SoundFx sound
Sound.
Definition: news_type.h:100
WindowDesc
High level window description.
Definition: window_gui.h:168
WID_N_VEH_SPR
@ WID_N_VEH_SPR
Graphical display of the new vehicle.
Definition: news_widget.h:32
_total_news
static uint _total_news
current number of news items
Definition: news_gui.cpp:49
NewsWindow
Window class displaying a news item.
Definition: news_gui.cpp:262
NewsItem::type
NewsType type
Type of the news.
Definition: news_type.h:130
PositionNewsMessage
int PositionNewsMessage(Window *w)
(Re)position news message window at the screen.
Definition: window.cpp:3420
EngineID
uint16 EngineID
Unique identification number of an engine.
Definition: engine_type.h:21
GUITimer
Definition: guitimer_func.h:13
WDP_AUTO
@ WDP_AUTO
Find a place automatically.
Definition: window_gui.h:156
DeleteVehicleNews
void DeleteVehicleNews(VehicleID vid, StringID news)
Delete a news item type about a vehicle.
Definition: news_gui.cpp:905
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:317
CommandCost
Common return value for all commands.
Definition: command_type.h:23
_date
Date _date
Current date in days (day counter)
Definition: date.cpp:28
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:597
NF_INCOLOUR
@ NF_INCOLOUR
Bit value for coloured news.
Definition: news_type.h:71
NWID_VIEWPORT
@ NWID_VIEWPORT
Nested widget containing a viewport.
Definition: widget_type.h:79
ShowCompanyGroupForVehicle
void ShowCompanyGroupForVehicle(const Vehicle *v)
Show the group window for the given vehicle.
Definition: group_gui.cpp:1124
WID_N_MGR_NAME
@ WID_N_MGR_NAME
Name of the manager.
Definition: news_widget.h:28
Window::height
int height
Height of the window (number of pixels down in y direction)
Definition: window_gui.h:315
WD_FRAMERECT_LEFT
@ WD_FRAMERECT_LEFT
Offset at left to draw the frame rectangular area.
Definition: window_gui.h:62
SBI_NEWS_DELETED
@ SBI_NEWS_DELETED
abort current news display (active news were deleted)
Definition: statusbar_gui.h:19
CmdCustomNewsItem
CommandCost CmdCustomNewsItem(TileIndex tile, DoCommandFlag flags, uint32 p1, uint32 p2, const std::string &text)
Create a new custom news item.
Definition: news_gui.cpp:847
ConvertYMDToDate
Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
Definition: date.cpp:149
INVALID_OWNER
@ INVALID_OWNER
An invalid owner.
Definition: company_type.h:29
MIN_NEWS_AMOUNT
static uint MIN_NEWS_AMOUNT
preferred minimum amount of news messages
Definition: news_gui.cpp:47
WD_FRAMERECT_RIGHT
@ WD_FRAMERECT_RIGHT
Offset at right to draw the frame rectangular area.
Definition: window_gui.h:63
WID_N_TITLE
@ WID_N_TITLE
Title of the company news.
Definition: news_widget.h:18
WD_FRAMERECT_BOTTOM
@ WD_FRAMERECT_BOTTOM
Offset at bottom to draw the frame rectangular area.
Definition: window_gui.h:65
NewsTypeData::name
const char *const name
Name.
Definition: news_type.h:98
SoundSettings::news_full
bool news_full
Play sound effects associated to certain news types.
Definition: settings_type.h:208
DeleteNewsItem
static void DeleteNewsItem(NewsItem *ni)
Delete a news item from the queue.
Definition: news_gui.cpp:729
MessageHistoryWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: news_gui.cpp:1158
NewsType
NewsType
Type of news.
Definition: news_type.h:21
PALETTE_NEWSPAPER
static const PaletteID PALETTE_NEWSPAPER
Recolour sprite for newspaper-greying.
Definition: sprites.h:1599
MoveToNextTickerItem
static void MoveToNextTickerItem()
Move to the next ticker item.
Definition: news_gui.cpp:659
MAX_NEWS_AMOUNT
static uint MAX_NEWS_AMOUNT
Do not exceed this number of news messages.
Definition: news_gui.cpp:48
NewsWindow::OnInitialPosition
Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
Compute the initial position of the window.
Definition: news_gui.cpp:334
NewsWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: news_gui.cpp:476
WID_N_VEH_TITLE
@ WID_N_VEH_TITLE
Vehicle new title.
Definition: news_widget.h:29
NewsStringData
Container for a single string to be passed as NewsAllocatedData.
Definition: news_type.h:146
NewsTypeData::GetDisplay
NewsDisplay GetDisplay() const
Return the news display option.
Definition: news_gui.cpp:254
_local_company
CompanyID _local_company
Company controlled by the human player at this client. Can also be COMPANY_SPECTATOR.
Definition: company_cmd.cpp:46
ShowTicker
static void ShowTicker(const NewsItem *ni)
Show news item in the ticker.
Definition: news_gui.cpp:605
industry.h
WID_N_DATE
@ WID_N_DATE
Date of the news item.
Definition: news_widget.h:21
safeguards.h
Window::left
int left
x position of left edge of the window
Definition: window_gui.h:312
NewsWindow::status_height
uint16 status_height
Height of the status bar window.
Definition: news_gui.cpp:264
IsValidTile
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:161
NewsItem::string_id
StringID string_id
Message text.
Definition: news_type.h:128
NewsItem::prev
NewsItem * prev
Previous news item.
Definition: news_type.h:126
MessageHistoryWindow
Definition: news_gui.cpp:1125
ND_OFF
@ ND_OFF
Only show a reminder in the status bar.
Definition: news_type.h:89
GetStringMultiLineBoundingBox
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:754
Point
Coordinates of a point in 2D.
Definition: geometry_type.hpp:21
ScrollMainWindowTo
bool ScrollMainWindowTo(int x, int y, int z, bool instant)
Scrolls the main window to given coordinates.
Definition: smallmap_gui.cpp:1879
_forced_news
static const NewsItem * _forced_news
Forced news item.
Definition: news_gui.cpp:59
WID_N_HEADLINE
@ WID_N_HEADLINE
The news headline.
Definition: news_widget.h:19
date_func.h
MessageHistoryWindow::UpdateWidgetSize
void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
Update size and resize step of a widget in the window.
Definition: news_gui.cpp:1142
DeleteIndustryNews
void DeleteIndustryNews(IndustryID iid)
Remove news regarding given industry.
Definition: news_gui.cpp:941
stdafx.h
NewsItem::next
NewsItem * next
Next news item.
Definition: news_type.h:127
NR_NONE
@ NR_NONE
Empty reference.
Definition: news_type.h:50
MessageHistoryWindow::top_spacing
static const int top_spacing
Additional spacing at the top of the WID_MH_BACKGROUND widget.
Definition: news_gui.cpp:1126
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:192
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:307
SBI_SHOW_REMINDER
@ SBI_SHOW_REMINDER
show a reminder (dot on the right side of the statusbar)
Definition: statusbar_gui.h:18
GfxFillRect
void GfxFillRect(int left, int top, int right, int bottom, int colour, FillRectMode mode)
Applies a certain FillRectMode-operation to a rectangle [left, right] x [top, bottom] on the screen.
Definition: gfx.cpp:117
SoundFx
SoundFx
Sound effects from baseset.
Definition: sound_type.h:37
viewport_func.h
NF_NORMAL
@ NF_NORMAL
Normal news item. (Newspaper with text only)
Definition: news_type.h:78
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:37
NewsDisplay
NewsDisplay
News display options.
Definition: news_type.h:88
PC_GREY
static const uint8 PC_GREY
Grey palette colour.
Definition: gfx_func.h:194
NWID_VERTICAL
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:75
GetSpriteSize
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:977
NewsWindow::OnRealtimeTick
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition: news_gui.cpp:535
WWT_CLOSEBOX
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:67
WWT_RESIZEBOX
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:66
news_widget.h
ND_SUMMARY
@ ND_SUMMARY
Show ticker.
Definition: news_type.h:90
NewsReferenceType
NewsReferenceType
References to objects in news.
Definition: news_type.h:49
string_func.h
NR_TOWN
@ NR_TOWN
Reference town. Scroll to town when clicking on the news.
Definition: news_type.h:55
NR_TILE
@ NR_TILE
Reference tile. Scroll to tile when clicking on the news.
Definition: news_type.h:51
StringID
uint32 StringID
Numeric value that represents a string, independent of the selected language.
Definition: strings_type.h:16
_current_company
CompanyID _current_company
Company currently doing an action.
Definition: company_cmd.cpp:47
ORIGINAL_MAX_YEAR
static const Year ORIGINAL_MAX_YEAR
The maximum year of the original TTD.
Definition: date_type.h:54
vehicle_func.h
GetReferenceTile
static TileIndex GetReferenceTile(NewsReferenceType reftype, uint32 ref)
Get the position a news-reference is referencing.
Definition: news_gui.cpp:71
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1092
station_base.h
CompanyNewsInformation
Data that needs to be stored for company news messages.
Definition: news_type.h:157
engine_gui.h
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
NWidgetCore::disp_flags
NWidgetDisplay disp_flags
Flags that affect display and interaction with the widget.
Definition: widget_type.h:332
NewsWindow::ni
const NewsItem * ni
News item to display.
Definition: news_gui.cpp:265
WID_N_VEH_INFO
@ WID_N_VEH_INFO
Some technical data of the new vehicle.
Definition: news_widget.h:33
ShowNewsMessage
static void ShowNewsMessage(const NewsItem *ni)
Do a forced show of a specific message.
Definition: news_gui.cpp:1012
SettingDesc
Properties of config file settings.
Definition: settings_internal.h:72
WID_N_CAPTION
@ WID_N_CAPTION
Title bar of the window. Only used in small news items.
Definition: news_widget.h:22
SpecializedVehicle< RoadVehicle, Type >::From
static RoadVehicle * From(Vehicle *v)
Converts a Vehicle to SpecializedVehicle with type checking.
Definition: vehicle_base.h:1166
WID_MH_BACKGROUND
@ WID_MH_BACKGROUND
Background of the window.
Definition: news_widget.h:40
WD_CAPTIONTEXT_TOP
@ WD_CAPTIONTEXT_TOP
Offset of the caption text at the top.
Definition: window_gui.h:129
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:167
ShowNewspaper
static void ShowNewspaper(const NewsItem *ni)
Open up an own newspaper window for the news item.
Definition: news_gui.cpp:596
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1207
MessageHistoryWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: news_gui.cpp:1164
geometry_func.hpp
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1010
NWidgetViewport::InitializeViewport
void InitializeViewport(Window *w, uint32 follow_flags, ZoomLevel zoom)
Initialize the viewport of the window.
Definition: widget.cpp:2067
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
ShowLastNewsMessage
void ShowLastNewsMessage()
Show previous news item.
Definition: news_gui.cpp:1040
CompanyNewsInformation::face
uint32 face
The face of the president.
Definition: news_type.h:162
DrawCompanyManagerFace
void DrawCompanyManagerFace(CompanyManagerFace cmf, int colour, int x, int y)
Draws the face of a company manager's face.
Definition: company_gui.cpp:1110
TileDiffXY
static TileIndexDiff TileDiffXY(int x, int y)
Calculates an offset for the given coordinate(-offset).
Definition: map_func.h:179
MessageHistoryWindow::date_width
int date_width
< Height of a single line in the news history window including spacing.
Definition: news_gui.cpp:1130
NFB_WINDOW_LAYOUT_COUNT
@ NFB_WINDOW_LAYOUT_COUNT
Number of bits for window layout.
Definition: news_type.h:68
WID_N_COMPANY_MSG
@ WID_N_COMPANY_MSG
Message in company news items.
Definition: news_widget.h:25
Scrollbar::GetPosition
uint16 GetPosition() const
Gets the position of the first visible element in the list.
Definition: widget_type.h:671
FindWindowByClass
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition: window.cpp:1161
GUITimer::CountElapsed
uint CountElapsed(uint delta)
Count how many times the interval has elapsed.
Definition: guitimer_func.h:40
OWNER_DEITY
@ OWNER_DEITY
The object is owned by a superuser / goal script.
Definition: company_type.h:27
_current_news
static const NewsItem * _current_news
Current news item (last item shown regularly).
Definition: news_gui.cpp:62
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1776
BaseStation::xy
TileIndex xy
Base tile of the station.
Definition: base_station_base.h:53
NWID_SPACER
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:77
GUISettings::news_message_timeout
byte news_message_timeout
how much longer than the news message "age" should we keep the message in the history
Definition: settings_type.h:158
IntSettingDesc::Read
int32 Read(const void *object) const
Read the integer from the the actual setting.
Definition: settings.cpp:518
company_func.h
WWT_INSET
@ WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:49
Window::top
int top
y position of top edge of the window
Definition: window_gui.h:313
NR_VEHICLE
@ NR_VEHICLE
Reference vehicle. Scroll to vehicle when clicking on the news. Delete news when vehicle is deleted.
Definition: news_type.h:52
VehicleID
uint32 VehicleID
The type all our vehicle IDs have.
Definition: vehicle_type.h:16
WID_N_VEH_NAME
@ WID_N_VEH_NAME
Name of the new vehicle.
Definition: news_widget.h:31
NewsItem::date
Date date
Date of the news.
Definition: news_type.h:129
SoundSettings::news_ticker
bool news_ticker
Play a ticker sound when a news item is published.
Definition: settings_type.h:207
WC_SEND_NETWORK_MSG
@ WC_SEND_NETWORK_MSG
Chatbox; Window numbers:
Definition: window_type.h:489
ShowVehicleViewWindow
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
Definition: vehicle_gui.cpp:3084
window_func.h
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_type.h:338
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:378
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:314
_latest_news
NewsItem * _latest_news
tail of news items queue
Definition: news_gui.cpp:51
Scrollbar::SetCapacityFromWidget
void SetCapacityFromWidget(Window *w, int widget, int padding=0)
Set capacity of visible elements from the size and resize properties of a widget.
Definition: widget.cpp:2172
WD_CAPTIONTEXT_BOTTOM
@ WD_CAPTIONTEXT_BOTTOM
Offset of the caption text at the bottom.
Definition: window_gui.h:130
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:155
ReadyForNextNewsItem
static bool ReadyForNextNewsItem()
Are we ready to show another news item? Only if no newspaper is displayed.
Definition: news_gui.cpp:649
ZOOM_LVL_NEWS
@ ZOOM_LVL_NEWS
Default zoom level for the news messages.
Definition: zoom_type.h:36
CloseWindowById
void CloseWindowById(WindowClass cls, WindowNumber number, bool force)
Close a window by its class and window number (if it is open).
Definition: window.cpp:1176
NF_SHADE
@ NF_SHADE
Bit value for enabling shading.
Definition: news_type.h:73
INVALID_TILE
static const TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:88
RoadVehicle::IsBus
bool IsBus() const
Check whether a roadvehicle is a bus.
Definition: roadveh_cmd.cpp:79
engine_base.h
NewsItem::params
uint64 params[10]
Parameters for string resolving.
Definition: news_type.h:140
HideActiveNewsMessage
bool HideActiveNewsMessage()
Close active news message window.
Definition: news_gui.cpp:1032
MoveToNextNewsItem
static void MoveToNextNewsItem()
Move to the next news item.
Definition: news_gui.cpp:693
ND_SHADE_GREY
@ ND_SHADE_GREY
Bit value of the 'shade to grey' flag.
Definition: widget_type.h:298
NewsStringData::string
std::string string
The string to retain.
Definition: news_type.h:147
NewsFlag
NewsFlag
Various OR-able news-item flags.
Definition: news_type.h:63
_oldest_news
static NewsItem * _oldest_news
head of news items queue
Definition: news_gui.cpp:50
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1076
_news_type_data
static NewsTypeData _news_type_data[]
Per-NewsType data.
Definition: news_gui.cpp:229
DrawCaption
void DrawCaption(const Rect &r, Colours colour, Owner owner, TextColour text_colour, StringID str, StringAlignment align)
Draw a caption bar.
Definition: widget.cpp:583
gui.h
AddNewsItem
void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data)
Add a new newsitem to be shown.
Definition: news_gui.cpp:807
WID_N_VIEWPORT
@ WID_N_VIEWPORT
Viewport in the window.
Definition: news_widget.h:24
Window
Data structure for an opened window.
Definition: window_gui.h:279
WD_CAPTIONTEXT_LEFT
@ WD_CAPTIONTEXT_LEFT
Offset of the caption text at the left.
Definition: window_gui.h:127
VEH_TRAIN
@ VEH_TRAIN
Train vehicle type.
Definition: vehicle_type.h:24
Pool::PoolItem<&_company_pool >::IsValidID
static bool IsValidID(size_t index)
Tests whether given index can be used to get valid (non-nullptr) Titem.
Definition: pool_type.hpp:326
WC_STATUS_BAR
@ WC_STATUS_BAR
Statusbar (at the bottom of your screen); Window numbers:
Definition: window_type.h:56
BaseVehicle::type
VehicleType type
Type of vehicle.
Definition: vehicle_type.h:52
DeleteInvalidEngineNews
void DeleteInvalidEngineNews()
Remove engine announcements for invalid engines.
Definition: news_gui.cpp:957
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:636
WC_NEWS_WINDOW
@ WC_NEWS_WINDOW
News window; Window numbers:
Definition: window_type.h:240
SettingDesc::IsIntSetting
virtual bool IsIntSetting() const
Check whether this setting is an integer type setting.
Definition: settings_internal.h:97
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:311
InitNewsItemStructs
void InitNewsItemStructs()
Initialize the news-items data structures.
Definition: news_gui.cpp:614
VEH_SHIP
@ VEH_SHIP
Ship vehicle type.
Definition: vehicle_type.h:26
NewsItem::ref1
uint32 ref1
Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news,...
Definition: news_type.h:135
NR_INDUSTRY
@ NR_INDUSTRY
Reference industry. Scroll to industry when clicking on the news. Delete news when industry is delete...
Definition: news_type.h:54
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:47
_cur_month
Month _cur_month
Current month (0..11)
Definition: date.cpp:27
NT_END
@ NT_END
end-of-array marker
Definition: news_type.h:37
SND_1D_APPLAUSE
@ SND_1D_APPLAUSE
27 == 0x1B News: first vehicle at station
Definition: sound_type.h:66
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:394
TD_RTL
@ TD_RTL
Text is written right-to-left by default.
Definition: strings_type.h:24
_current_text_dir
TextDirection _current_text_dir
Text direction of the currently selected language.
Definition: strings.cpp:48
DrawVehicleEngine
void DrawVehicleEngine(int left, int right, int preferred_x, int y, EngineID engine, PaletteID pal, EngineImageType image_type)
Draw an engine.
Definition: engine_gui.cpp:296
SBI_SHOW_TICKER
@ SBI_SHOW_TICKER
start scrolling news
Definition: statusbar_gui.h:17
CopyInDParam
void CopyInDParam(int offs, const uint64 *src, int num)
Copy num string parameters from array src into the global string parameter array.
Definition: strings.cpp:128
SetDParamStr
void SetDParamStr(uint n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
Definition: strings.cpp:296
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
NR_ENGINE
@ NR_ENGINE
Reference engine.
Definition: news_type.h:56
GUISettings::coloured_news_year
Year coloured_news_year
when does newspaper become coloured?
Definition: settings_type.h:151
INVALID_STRING_ID
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
Definition: strings_type.h:17
ClientSettings::gui
GUISettings gui
settings related to the GUI
Definition: settings_type.h:594
MessageHistoryWindow::OnClick
void OnClick(Point pt, int widget, int click_count) override
A click with the left mouse button has been made on the window.
Definition: news_gui.cpp:1205
NewsItem::reftype1
NewsReferenceType reftype1
Type of ref1.
Definition: news_type.h:133
SettingDesc::AsIntSetting
const struct IntSettingDesc * AsIntSetting() const
Get the setting description of this setting as an integer setting.
Definition: settings.cpp:832
SND_16_NEWS_TICKER
@ SND_16_NEWS_TICKER
20 == 0x14 News ticker
Definition: sound_type.h:59
ND_NO_TRANSPARENCY
@ ND_NO_TRANSPARENCY
Bit value of the 'no transparency' flag.
Definition: widget_type.h:297
WD_CAPTIONTEXT_RIGHT
@ WD_CAPTIONTEXT_RIGHT
Offset of the caption text at the right.
Definition: window_gui.h:128
roadveh.h
ReadyForNextTickerItem
static bool ReadyForNextTickerItem()
Are we ready to show another ticker item? Only if nothing is in the newsticker is displayed.
Definition: news_gui.cpp:635
WWT_SHADEBOX
@ WWT_SHADEBOX
Shade box (at top-right of a window, between WWT_DEBUGBOX and WWT_DEFSIZEBOX)
Definition: widget_type.h:62
Window::Close
virtual void Close()
Hide the window and all its child windows, and mark them for a later deletion.
Definition: window.cpp:1092