OpenTTD Source: src/news_gui.cpp Source File

OpenTTD Source 13.1

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 #include "news_cmd.h"
39
40 #include "widgets/news_widget.h"
41
42 #include "table/strings.h"
43
44 #include "safeguards.h"
45
46 const NewsItem *_statusbar_news_item = nullptr;
47
48 static uint MIN_NEWS_AMOUNT = 30;
49 static uint MAX_NEWS_AMOUNT = 1 << 10;
50 static uint _total_news = 0;
51 static NewsItem *_oldest_news = nullptr;
52 NewsItem *_latest_news = nullptr;
53
60 static const NewsItem *_forced_news = nullptr;
61
63 static const NewsItem *_current_news = nullptr;
64
65
72 static TileIndex GetReferenceTile(NewsReferenceType reftype, uint32 ref)
73 {
74 switch (reftype) {
75 case NR_TILE: return (TileIndex)ref;
76 case NR_STATION: return Station::Get((StationID)ref)->xy;
77 case NR_INDUSTRY: return Industry::Get((IndustryID)ref)->location.tile + TileDiffXY(1, 1);
78 case NR_TOWN: return Town::Get((TownID)ref)->xy;
79 default: return INVALID_TILE;
80 }
81 }
82
83 /* Normal news items. */
84 static const NWidgetPart _nested_normal_news_widgets[] = {
85 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
86 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
87 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
88 NWidget(NWID_SPACER), SetFill(1, 0),
89 NWidget(NWID_VERTICAL),
90 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_DATE), SetDataTip(STR_DATE_LONG_SMALL, STR_NULL),
91 NWidget(NWID_SPACER), SetFill(0, 1),
92 EndContainer(),
93 EndContainer(),
94 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(428, 154), SetPadding(0, 5, 1, 5),
95 EndContainer(),
96 };
97
98 static WindowDesc _normal_news_desc(
99 WDP_MANUAL, nullptr, 0, 0,
100 WC_NEWS_WINDOW, WC_NONE,
101 0,
102 _nested_normal_news_widgets, lengthof(_nested_normal_news_widgets)
103 );
104
105 /* New vehicles news items. */
106 static const NWidgetPart _nested_vehicle_news_widgets[] = {
107 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
108 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
109 NWidget(NWID_VERTICAL),
110 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
111 NWidget(NWID_SPACER), SetFill(0, 1),
112 EndContainer(),
113 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_VEH_TITLE), SetFill(1, 1), SetMinimalSize(419, 55), SetDataTip(STR_EMPTY, STR_NULL),
114 EndContainer(),
115 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_VEH_BKGND), SetPadding(0, 25, 1, 25),
116 NWidget(NWID_VERTICAL),
117 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_NAME), SetMinimalSize(369, 33), SetFill(1, 0),
118 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_SPR), SetMinimalSize(369, 32), SetFill(1, 0),
119 NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_INFO), SetMinimalSize(369, 46), SetFill(1, 0),
120 EndContainer(),
121 EndContainer(),
122 EndContainer(),
123 };
124
125 static WindowDesc _vehicle_news_desc(
126 WDP_MANUAL, nullptr, 0, 0,
127 WC_NEWS_WINDOW, WC_NONE,
128 0,
129 _nested_vehicle_news_widgets, lengthof(_nested_vehicle_news_widgets)
130 );
131
132 /* Company news items. */
133 static const NWidgetPart _nested_company_news_widgets[] = {
134 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
135 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
136 NWidget(NWID_VERTICAL),
137 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
138 NWidget(NWID_SPACER), SetFill(0, 1),
139 EndContainer(),
140 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_TITLE), SetFill(1, 1), SetMinimalSize(410, 20), SetDataTip(STR_EMPTY, STR_NULL),
141 EndContainer(),
142 NWidget(NWID_HORIZONTAL), SetPadding(0, 1, 1, 1),
143 NWidget(NWID_VERTICAL),
144 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MGR_FACE), SetMinimalSize(93, 119), SetPadding(2, 6, 2, 1),
145 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MGR_NAME), SetMinimalSize(93, 24), SetPadding(0, 0, 0, 1),
146 NWidget(NWID_SPACER), SetFill(0, 1),
147 EndContainer(),
148 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_COMPANY_MSG), SetFill(1, 1), SetMinimalSize(328, 150),
149 EndContainer(),
150 EndContainer(),
151 };
152
153 static WindowDesc _company_news_desc(
154 WDP_MANUAL, nullptr, 0, 0,
155 WC_NEWS_WINDOW, WC_NONE,
156 0,
157 _nested_company_news_widgets, lengthof(_nested_company_news_widgets)
158 );
159
160 /* Thin news items. */
161 static const NWidgetPart _nested_thin_news_widgets[] = {
162 NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
163 NWidget(NWID_HORIZONTAL), SetPadding(1, 1, 0, 1),
164 NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX), SetPadding(0, 0, 0, 1),
165 NWidget(NWID_SPACER), SetFill(1, 0),
166 NWidget(NWID_VERTICAL),
167 NWidget(WWT_LABEL, COLOUR_WHITE, WID_N_DATE), SetDataTip(STR_DATE_LONG_SMALL, STR_NULL),
168 NWidget(NWID_SPACER), SetFill(0, 1),
169 EndContainer(),
170 EndContainer(),
171 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(428, 48), SetFill(1, 0), SetPadding(0, 5, 0, 5),
172 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_N_VIEWPORT), SetMinimalSize(426, 70), SetPadding(1, 2, 2, 2),
173 EndContainer(),
174 };
175
176 static WindowDesc _thin_news_desc(
177 WDP_MANUAL, nullptr, 0, 0,
178 WC_NEWS_WINDOW, WC_NONE,
179 0,
180 _nested_thin_news_widgets, lengthof(_nested_thin_news_widgets)
181 );
182
183 /* Small news items. */
184 static const NWidgetPart _nested_small_news_widgets[] = {
185 /* Caption + close box. The caption is no WWT_CAPTION as the window shall not be moveable and so on. */
186 NWidget(NWID_HORIZONTAL),
187 NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE, WID_N_CLOSEBOX),
188 NWidget(WWT_EMPTY, COLOUR_LIGHT_BLUE, WID_N_CAPTION), SetFill(1, 0),
189 NWidget(WWT_TEXTBTN, COLOUR_LIGHT_BLUE, WID_N_SHOW_GROUP), SetMinimalSize(14, 11), SetResize(1, 0),
190 SetDataTip(STR_NULL /* filled in later */, STR_NEWS_SHOW_VEHICLE_GROUP_TOOLTIP),
191 EndContainer(),
192
193 /* Main part */
194 NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE, WID_N_HEADLINE),
195 NWidget(WWT_INSET, COLOUR_LIGHT_BLUE, WID_N_INSET), SetPadding(2, 2, 2, 2),
196 NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_N_VIEWPORT), SetMinimalSize(274, 47), SetFill(1, 0),
197 EndContainer(),
198 NWidget(WWT_EMPTY, COLOUR_WHITE, WID_N_MESSAGE), SetMinimalSize(275, 20), SetFill(1, 0), SetPadding(0, 5, 0, 5),
199 EndContainer(),
200 };
201
202 static WindowDesc _small_news_desc(
203 WDP_MANUAL, nullptr, 0, 0,
204 WC_NEWS_WINDOW, WC_NONE,
205 0,
206 _nested_small_news_widgets, lengthof(_nested_small_news_widgets)
207 );
208
212 static WindowDesc* _news_window_layout[] = {
213 &_thin_news_desc,
214 &_small_news_desc,
215 &_normal_news_desc,
216 &_vehicle_news_desc,
217 &_company_news_desc,
218 };
219
220 WindowDesc* GetNewsWindowLayout(NewsFlag flags)
221 {
222 uint layout = GB(flags, NFB_WINDOW_LAYOUT, NFB_WINDOW_LAYOUT_COUNT);
223 assert(layout < lengthof(_news_window_layout));
224 return _news_window_layout[layout];
225 }
226
230 static NewsTypeData _news_type_data[] = {
231 /* name, age, sound, */
232 NewsTypeData("news_display.arrival_player", 60, SND_1D_APPLAUSE ),
233 NewsTypeData("news_display.arrival_other", 60, SND_1D_APPLAUSE ),
234 NewsTypeData("news_display.accident", 90, SND_BEGIN ),
235 NewsTypeData("news_display.accident_other", 90, SND_BEGIN ),
236 NewsTypeData("news_display.company_info", 60, SND_BEGIN ),
237 NewsTypeData("news_display.open", 90, SND_BEGIN ),
238 NewsTypeData("news_display.close", 90, SND_BEGIN ),
239 NewsTypeData("news_display.economy", 30, SND_BEGIN ),
240 NewsTypeData("news_display.production_player", 30, SND_BEGIN ),
241 NewsTypeData("news_display.production_other", 30, SND_BEGIN ),
242 NewsTypeData("news_display.production_nobody", 30, SND_BEGIN ),
243 NewsTypeData("news_display.advice", 150, SND_BEGIN ),
244 NewsTypeData("news_display.new_vehicles", 30, SND_1E_NEW_ENGINE),
245 NewsTypeData("news_display.acceptance", 90, SND_BEGIN ),
246 NewsTypeData("news_display.subsidies", 180, SND_BEGIN ),
247 NewsTypeData("news_display.general", 60, SND_BEGIN ),
248 };
249
250 static_assert(lengthof(_news_type_data) == NT_END);
251
256 NewsDisplay NewsTypeData::GetDisplay() const
257 {
258 const SettingDesc *sd = GetSettingFromName(this->name);
259 assert(sd != nullptr && sd->IsIntSetting());
260 return (NewsDisplay)sd->AsIntSetting()->Read(nullptr);
261 }
262
264 struct NewsWindow : Window {
265 uint16 chat_height;
266 uint16 status_height;
267 const NewsItem *ni;
268 static int duration;
269
270 static const uint TIMER_INTERVAL = 210;
271 GUITimer timer;
272
273 NewsWindow(WindowDesc *desc, const NewsItem *ni) : Window(desc), ni(ni)
274 {
275 NewsWindow::duration = 16650;
276 const Window *w = FindWindowByClass(WC_SEND_NETWORK_MSG);
277 this->chat_height = (w != nullptr) ? w->height : 0;
278 this->status_height = FindWindowById(WC_STATUS_BAR, 0)->height;
279
280 this->flags |= WF_DISABLE_VP_SCROLL;
281
282 this->CreateNestedTree();
283
284 /* For company news with a face we have a separate headline in param[0] */
285 if (desc == &_company_news_desc) this->GetWidget<NWidgetCore>(WID_N_TITLE)->widget_data = this->ni->params[0];
286
287 NWidgetCore *nwid = this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP);
288 if (ni->reftype1 == NR_VEHICLE && nwid != nullptr) {
289 const Vehicle *v = Vehicle::Get(ni->ref1);
290 switch (v->type) {
291 case VEH_TRAIN:
292 nwid->widget_data = STR_TRAIN;
293 break;
294 case VEH_ROAD:
295 nwid->widget_data = RoadVehicle::From(v)->IsBus() ? STR_BUS : STR_LORRY;
296 break;
297 case VEH_SHIP:
298 nwid->widget_data = STR_SHIP;
299 break;
300 case VEH_AIRCRAFT:
301 nwid->widget_data = STR_PLANE;
302 break;
303 default:
304 break; // Do nothing
305 }
306 }
307
308 this->FinishInitNested(0);
309
310 /* Initialize viewport if it exists. */
311 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_N_VIEWPORT);
312 if (nvp != nullptr) {
313 nvp->InitializeViewport(this, ni->reftype1 == NR_VEHICLE ? 0x80000000 | ni->ref1 : (uint32)GetReferenceTile(ni->reftype1, ni->ref1),ScaleZoomGUI(ZOOM_LVL_NEWS));
314 if (this->ni->flags & NF_NO_TRANSPARENT) nvp->disp_flags |= ND_NO_TRANSPARENCY;
315 if ((this->ni->flags & NF_INCOLOUR) == 0) {
316 nvp->disp_flags |= ND_SHADE_GREY;
317 } else if (this->ni->flags & NF_SHADE) {
318 nvp->disp_flags |= ND_SHADE_DIMMED;
319 }
320 }
321
322 PositionNewsMessage(this);
323 }
324
325 void OnInit() override
326 {
327 this->timer.SetInterval(TIMER_INTERVAL / FONT_HEIGHT_NORMAL);
328 }
329
330 void DrawNewsBorder(const Rect &r) const
331 {
332 Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
333 GfxFillRect(ir, PC_WHITE);
334
335 ir = ir.Expand(1);
336 GfxFillRect( r.left, r.top, ir.left, r.bottom, PC_BLACK);
337 GfxFillRect(ir.right, r.top, r.right, r.bottom, PC_BLACK);
338 GfxFillRect( r.left, r.top, r.right, ir.top, PC_BLACK);
339 GfxFillRect( r.left, ir.bottom, r.right, r.bottom, PC_BLACK);
340 }
341
342 Point OnInitialPosition(int16 sm_width, int16 sm_height, int window_number) override
343 {
344 Point pt = { 0, _screen.height };
345 return pt;
346 }
347
348 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
349 {
350 StringID str = STR_NULL;
351 switch (widget) {
352 case WID_N_CAPTION: {
353 /* Caption is not a real caption (so that the window cannot be moved)
354 * thus it doesn't get the default sizing of a caption. */
355 Dimension d2 = GetStringBoundingBox(STR_NEWS_MESSAGE_CAPTION);
356 d2.height += WidgetDimensions::scaled.captiontext.Vertical();
357 *size = maxdim(*size, d2);
358 return;
359 }
360
361 case WID_N_MGR_FACE:
362 *size = maxdim(*size, GetSpriteSize(SPR_GRADIENT));
363 break;
364
365 case WID_N_MGR_NAME:
366 SetDParamStr(0, static_cast<const CompanyNewsInformation *>(this->ni->data.get())->president_name);
367 str = STR_JUST_RAW_STRING;
368 break;
369
370 case WID_N_MESSAGE:
371 CopyInDParam(0, this->ni->params, lengthof(this->ni->params));
372 str = this->ni->string_id;
373 break;
374
375 case WID_N_COMPANY_MSG:
376 str = this->GetCompanyMessageString();
377 break;
378
379 case WID_N_VEH_NAME:
380 case WID_N_VEH_TITLE:
381 str = this->GetNewVehicleMessageString(widget);
382 break;
383
384 case WID_N_VEH_INFO: {
385 assert(this->ni->reftype1 == NR_ENGINE);
386 EngineID engine = this->ni->ref1;
387 str = GetEngineInfoString(engine);
388 break;
389 }
390
391 case WID_N_SHOW_GROUP:
392 if (this->ni->reftype1 == NR_VEHICLE) {
393 Dimension d2 = GetStringBoundingBox(this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP)->widget_data);
394 d2.height += WidgetDimensions::scaled.captiontext.Vertical();
395 d2.width += WidgetDimensions::scaled.captiontext.Horizontal();
396 *size = d2;
397 } else {
398 /* Hide 'Show group window' button if this news is not about a vehicle. */
399 size->width = 0;
400 size->height = 0;
401 resize->width = 0;
402 resize->height = 0;
403 fill->width = 0;
404 fill->height = 0;
405 }
406 return;
407
408 default:
409 return; // Do nothing
410 }
411
412 /* Update minimal size with length of the multi-line string. */
413 Dimension d = *size;
414 d.width = (d.width >= padding.width) ? d.width - padding.width : 0;
415 d.height = (d.height >= padding.height) ? d.height - padding.height : 0;
416 d = GetStringMultiLineBoundingBox(str, d);
417 d.width += padding.width;
418 d.height += padding.height;
419 *size = maxdim(*size, d);
420 }
421
422 void SetStringParameters(int widget) const override
423 {
424 if (widget == WID_N_DATE) SetDParam(0, this->ni->date);
425 }
426
427 void DrawWidget(const Rect &r, int widget) const override
428 {
429 switch (widget) {
430 case WID_N_CAPTION:
431 DrawCaption(r, COLOUR_LIGHT_BLUE, this->owner, TC_FROMSTRING, STR_NEWS_MESSAGE_CAPTION, SA_CENTER);
432 break;
433
434 case WID_N_PANEL:
435 this->DrawNewsBorder(r);
436 break;
437
438 case WID_N_MESSAGE:
439 CopyInDParam(0, this->ni->params, lengthof(this->ni->params));
440 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->ni->string_id, TC_FROMSTRING, SA_CENTER);
441 break;
442
443 case WID_N_MGR_FACE: {
444 const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
445 DrawCompanyManagerFace(cni->face, cni->colour, r.left, r.top);
446 GfxFillRect(r.left, r.top, r.right, r.bottom, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
447 break;
448 }
449 case WID_N_MGR_NAME: {
450 const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
451 SetDParamStr(0, cni->president_name);
452 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, STR_JUST_RAW_STRING, TC_FROMSTRING, SA_CENTER);
453 break;
454 }
455 case WID_N_COMPANY_MSG:
456 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->GetCompanyMessageString(), TC_FROMSTRING, SA_CENTER);
457 break;
458
459 case WID_N_VEH_BKGND:
460 GfxFillRect(r.left, r.top, r.right, r.bottom, PC_GREY);
461 break;
462
463 case WID_N_VEH_NAME:
464 case WID_N_VEH_TITLE:
465 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, this->GetNewVehicleMessageString(widget), TC_FROMSTRING, SA_CENTER);
466 break;
467
468 case WID_N_VEH_SPR: {
469 assert(this->ni->reftype1 == NR_ENGINE);
470 EngineID engine = this->ni->ref1;
471 DrawVehicleEngine(r.left, r.right, CenterBounds(r.left, r.right, 0), CenterBounds(r.top, r.bottom, 0), engine, GetEnginePalette(engine, _local_company), EIT_PREVIEW);
472 GfxFillRect(r.left, r.top, r.right, r.bottom, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
473 break;
474 }
475 case WID_N_VEH_INFO: {
476 assert(this->ni->reftype1 == NR_ENGINE);
477 EngineID engine = this->ni->ref1;
478 DrawStringMultiLine(r.left, r.right, r.top, r.bottom, GetEngineInfoString(engine), TC_FROMSTRING, SA_CENTER);
479 break;
480 }
481 }
482 }
483
484 void OnClick(Point pt, int widget, int click_count) override
485 {
486 switch (widget) {
487 case WID_N_CLOSEBOX:
488 NewsWindow::duration = 0;
489 this->Close();
490 _forced_news = nullptr;
491 break;
492
493 case WID_N_CAPTION:
494 if (this->ni->reftype1 == NR_VEHICLE) {
495 const Vehicle *v = Vehicle::Get(this->ni->ref1);
496 ShowVehicleViewWindow(v);
497 }
498 break;
499
500 case WID_N_VIEWPORT:
501 break; // Ignore clicks
502
503 case WID_N_SHOW_GROUP:
504 if (this->ni->reftype1 == NR_VEHICLE) {
505 const Vehicle *v = Vehicle::Get(this->ni->ref1);
506 ShowCompanyGroupForVehicle(v);
507 }
508 break;
509 default:
510 if (this->ni->reftype1 == NR_VEHICLE) {
511 const Vehicle *v = Vehicle::Get(this->ni->ref1);
512 ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
513 } else {
514 TileIndex tile1 = GetReferenceTile(this->ni->reftype1, this->ni->ref1);
515 TileIndex tile2 = GetReferenceTile(this->ni->reftype2, this->ni->ref2);
516 if (_ctrl_pressed) {
517 if (tile1 != INVALID_TILE) ShowExtraViewportWindow(tile1);
518 if (tile2 != INVALID_TILE) ShowExtraViewportWindow(tile2);
519 } else {
520 if ((tile1 == INVALID_TILE || !ScrollMainWindowToTile(tile1)) && tile2 != INVALID_TILE) {
521 ScrollMainWindowToTile(tile2);
522 }
523 }
524 }
525 break;
526 }
527 }
528
529 void OnResize() override
530 {
531 if (this->viewport != nullptr) {
532 NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_N_VIEWPORT);
533 nvp->UpdateViewportCoordinates(this);
534
535 if (ni->reftype1 != NR_VEHICLE) {
536 ScrollWindowToTile(GetReferenceTile(ni->reftype1, ni->ref1), this, true); // Re-center viewport.
537 }
538 }
539 }
540
546 void OnInvalidateData(int data = 0, bool gui_scope = true) override
547 {
548 if (!gui_scope) return;
549 /* The chatbar has notified us that is was either created or closed */
550 int newtop = this->top + this->chat_height - data;
551 this->chat_height = data;
552 this->SetWindowTop(newtop);
553 }
554
555 void OnRealtimeTick(uint delta_ms) override
556 {
557 int count = this->timer.CountElapsed(delta_ms);
558 if (count > 0) {
559 /* Scroll up newsmessages from the bottom */
560 int newtop = std::max(this->top - 2 * count, _screen.height - this->height - this->status_height - this->chat_height);
561 this->SetWindowTop(newtop);
562 }
563
564 /* Decrement the news timer. We don't need to action an elapsed event here,
565 * so no need to use TimerElapsed(). */
566 if (NewsWindow::duration > 0) NewsWindow::duration -= delta_ms;
567 }
568
569 private:
574 void SetWindowTop(int newtop)
575 {
576 if (this->top == newtop) return;
577
578 int mintop = std::min(newtop, this->top);
579 int maxtop = std::max(newtop, this->top);
580 if (this->viewport != nullptr) this->viewport->top += newtop - this->top;
581 this->top = newtop;
582
583 AddDirtyBlock(this->left, mintop, this->left + this->width, maxtop + this->height);
584 }
585
586 StringID GetCompanyMessageString() const
587 {
588 /* Company news with a face have a separate headline, so the normal message is shifted by two params */
589 CopyInDParam(0, this->ni->params + 2, lengthof(this->ni->params) - 2);
590 return this->ni->params[1];
591 }
592
593 StringID GetNewVehicleMessageString(int widget) const
594 {
595 assert(this->ni->reftype1 == NR_ENGINE);
596 EngineID engine = this->ni->ref1;
597
598 switch (widget) {
599 case WID_N_VEH_TITLE:
600 SetDParam(0, GetEngineCategoryName(engine));
601 return STR_NEWS_NEW_VEHICLE_NOW_AVAILABLE;
602
603 case WID_N_VEH_NAME:
604 SetDParam(0, PackEngineNameDParam(engine, EngineNameContext::PreviewNews));
605 return STR_NEWS_NEW_VEHICLE_TYPE;
606
607 default:
608 NOT_REACHED();
609 }
610 }
611 };
612
613 /* static */ int NewsWindow::duration = 0; // Instance creation.
614
616 static void ShowNewspaper(const NewsItem *ni)
617 {
618 SoundFx sound = _news_type_data[ni->type].sound;
619 if (sound != 0 && _settings_client.sound.news_full) SndPlayFx(sound);
620
621 new NewsWindow(GetNewsWindowLayout(ni->flags), ni);
622 }
623
625 static void ShowTicker(const NewsItem *ni)
626 {
627 if (_settings_client.sound.news_ticker) SndPlayFx(SND_16_NEWS_TICKER);
628
629 _statusbar_news_item = ni;
630 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_TICKER);
631 }
632
634 void InitNewsItemStructs()
635 {
636 for (NewsItem *ni = _oldest_news; ni != nullptr; ) {
637 NewsItem *next = ni->next;
638 delete ni;
639 ni = next;
640 }
641
642 _total_news = 0;
643 _oldest_news = nullptr;
644 _latest_news = nullptr;
645 _forced_news = nullptr;
646 _current_news = nullptr;
647 _statusbar_news_item = nullptr;
648 NewsWindow::duration = 0;
649 }
650
655 static bool ReadyForNextTickerItem()
656 {
657 const NewsItem *ni = _statusbar_news_item;
658 if (ni == nullptr) return true;
659
660 /* Ticker message
661 * Check if the status bar message is still being displayed? */
662 return !IsNewsTickerShown();
663 }
664
669 static bool ReadyForNextNewsItem()
670 {
671 const NewsItem *ni = _forced_news == nullptr ? _current_news : _forced_news;
672 if (ni == nullptr) return true;
673
674 /* neither newsticker nor newspaper are running */
675 return (NewsWindow::duration <= 0 || FindWindowById(WC_NEWS_WINDOW, 0) == nullptr);
676 }
677
679 static void MoveToNextTickerItem()
680 {
681 /* There is no status bar, so no reason to show news;
682 * especially important with the end game screen when
683 * there is no status bar but possible news. */
684 if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
685
686 /* if we're not at the last item, then move on */
687 while (_statusbar_news_item != _latest_news) {
688 _statusbar_news_item = (_statusbar_news_item == nullptr) ? _oldest_news : _statusbar_news_item->next;
689 const NewsItem *ni = _statusbar_news_item;
690 const NewsType type = ni->type;
691
692 /* check the date, don't show too old items */
693 if (_date - _news_type_data[type].age > ni->date) continue;
694
695 switch (_news_type_data[type].GetDisplay()) {
696 default: NOT_REACHED();
697 case ND_OFF: // Off - show nothing only a small reminder in the status bar
698 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_REMINDER);
699 break;
700
701 case ND_SUMMARY: // Summary - show ticker
702 ShowTicker(ni);
703 break;
704
705 case ND_FULL: // Full - show newspaper, skipped here
706 continue;
707 }
708 return;
709 }
710 }
711
713 static void MoveToNextNewsItem()
714 {
715 /* There is no status bar, so no reason to show news;
716 * especially important with the end game screen when
717 * there is no status bar but possible news. */
718 if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
719
720 CloseWindowById(WC_NEWS_WINDOW, 0); // close the newspapers window if shown
721 _forced_news = nullptr;
722
723 /* if we're not at the last item, then move on */
724 while (_current_news != _latest_news) {
725 _current_news = (_current_news == nullptr) ? _oldest_news : _current_news->next;
726 const NewsItem *ni = _current_news;
727 const NewsType type = ni->type;
728
729 /* check the date, don't show too old items */
730 if (_date - _news_type_data[type].age > ni->date) continue;
731
732 switch (_news_type_data[type].GetDisplay()) {
733 default: NOT_REACHED();
734 case ND_OFF: // Off - show nothing only a small reminder in the status bar, skipped here
735 continue;
736
737 case ND_SUMMARY: // Summary - show ticker, skipped here
738 continue;
739
740 case ND_FULL: // Full - show newspaper
741 ShowNewspaper(ni);
742 break;
743 }
744 return;
745 }
746 }
747
749 static void DeleteNewsItem(NewsItem *ni)
750 {
751 /* Delete the news from the news queue. */
752 if (ni->prev != nullptr) {
753 ni->prev->next = ni->next;
754 } else {
755 assert(_oldest_news == ni);
756 _oldest_news = ni->next;
757 }
758
759 if (ni->next != nullptr) {
760 ni->next->prev = ni->prev;
761 } else {
762 assert(_latest_news == ni);
763 _latest_news = ni->prev;
764 }
765
766 _total_news--;
767
768 if (_forced_news == ni || _current_news == ni) {
769 /* When we're the current news, go to the previous item first;
770 * we just possibly made that the last news item. */
771 if (_current_news == ni) _current_news = ni->prev;
772
773 /* About to remove the currently forced item (shown as newspapers) ||
774 * about to remove the currently displayed item (newspapers) */
775 MoveToNextNewsItem();
776 }
777
778 if (_statusbar_news_item == ni) {
779 /* When we're the current news, go to the previous item first;
780 * we just possibly made that the last news item. */
781 _statusbar_news_item = ni->prev;
782
783 /* About to remove the currently displayed item (ticker, or just a reminder) */
784 InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED); // invalidate the statusbar
785 MoveToNextTickerItem();
786 }
787
788 delete ni;
789
790 SetWindowDirty(WC_MESSAGE_HISTORY, 0);
791 }
792
806 NewsItem::NewsItem(StringID string_id, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data) :
807 string_id(string_id), date(_date), type(type), flags(flags), reftype1(reftype1), reftype2(reftype2), ref1(ref1), ref2(ref2), data(data)
808 {
809 /* show this news message in colour? */
810 if (_cur_year >= _settings_client.gui.coloured_news_year) this->flags |= NF_INCOLOUR;
811 CopyOutDParam(this->params, 0, lengthof(this->params));
812 }
813
827 void AddNewsItem(StringID string, NewsType type, NewsFlag flags, NewsReferenceType reftype1, uint32 ref1, NewsReferenceType reftype2, uint32 ref2, const NewsAllocatedData *data)
828 {
829 if (_game_mode == GM_MENU) return;
830
831 /* Create new news item node */
832 NewsItem *ni = new NewsItem(string, type, flags, reftype1, ref1, reftype2, ref2, data);
833
834 if (_total_news++ == 0) {
835 assert(_oldest_news == nullptr);
836 _oldest_news = ni;
837 ni->prev = nullptr;
838 } else {
839 assert(_latest_news->next == nullptr);
840 _latest_news->next = ni;
841 ni->prev = _latest_news;
842 }
843
844 ni->next = nullptr;
845 _latest_news = ni;
846
847 /* Keep the number of stored news items to a managable number */
848 if (_total_news > MAX_NEWS_AMOUNT) {
849 DeleteNewsItem(_oldest_news);
850 }
851
852 SetWindowDirty(WC_MESSAGE_HISTORY, 0);
853 }
854
865 CommandCost CmdCustomNewsItem(DoCommandFlag flags, NewsType type, NewsReferenceType reftype1, CompanyID company, uint32 reference, const std::string &text)
866 {
867 if (_current_company != OWNER_DEITY) return CMD_ERROR;
868
869 if (company != INVALID_OWNER && !Company::IsValidID(company)) return CMD_ERROR;
870 if (type >= NT_END) return CMD_ERROR;
871 if (text.empty()) return CMD_ERROR;
872
873 switch (reftype1) {
874 case NR_NONE: break;
875 case NR_TILE:
876 if (!IsValidTile(reference)) return CMD_ERROR;
877 break;
878
879 case NR_VEHICLE:
880 if (!Vehicle::IsValidID(reference)) return CMD_ERROR;
881 break;
882
883 case NR_STATION:
884 if (!Station::IsValidID(reference)) return CMD_ERROR;
885 break;
886
887 case NR_INDUSTRY:
888 if (!Industry::IsValidID(reference)) return CMD_ERROR;
889 break;
890
891 case NR_TOWN:
892 if (!Town::IsValidID(reference)) return CMD_ERROR;
893 break;
894
895 case NR_ENGINE:
896 if (!Engine::IsValidID(reference)) return CMD_ERROR;
897 break;
898
899 default: return CMD_ERROR;
900 }
901
902 if (company != INVALID_OWNER && company != _local_company) return CommandCost();
903
904 if (flags & DC_EXEC) {
905 NewsStringData *news = new NewsStringData(text);
906 SetDParamStr(0, news->string);
907 AddNewsItem(STR_NEWS_CUSTOM_ITEM, type, NF_NORMAL, reftype1, reference, NR_NONE, UINT32_MAX, news);
908 }
909
910 return CommandCost();
911 }
912
919 void DeleteVehicleNews(VehicleID vid, StringID news)
920 {
921 NewsItem *ni = _oldest_news;
922
923 while (ni != nullptr) {
924 NewsItem *next = ni->next;
925 if (((ni->reftype1 == NR_VEHICLE && ni->ref1 == vid) || (ni->reftype2 == NR_VEHICLE && ni->ref2 == vid)) &&
926 (news == INVALID_STRING_ID || ni->string_id == news)) {
927 DeleteNewsItem(ni);
928 }
929 ni = next;
930 }
931 }
932
938 void DeleteStationNews(StationID sid)
939 {
940 NewsItem *ni = _oldest_news;
941
942 while (ni != nullptr) {
943 NewsItem *next = ni->next;
944 if ((ni->reftype1 == NR_STATION && ni->ref1 == sid) || (ni->reftype2 == NR_STATION && ni->ref2 == sid)) {
945 DeleteNewsItem(ni);
946 }
947 ni = next;
948 }
949 }
950
955 void DeleteIndustryNews(IndustryID iid)
956 {
957 NewsItem *ni = _oldest_news;
958
959 while (ni != nullptr) {
960 NewsItem *next = ni->next;
961 if ((ni->reftype1 == NR_INDUSTRY && ni->ref1 == iid) || (ni->reftype2 == NR_INDUSTRY && ni->ref2 == iid)) {
962 DeleteNewsItem(ni);
963 }
964 ni = next;
965 }
966 }
967
971 void DeleteInvalidEngineNews()
972 {
973 NewsItem *ni = _oldest_news;
974
975 while (ni != nullptr) {
976 NewsItem *next = ni->next;
977 if ((ni->reftype1 == NR_ENGINE && (!Engine::IsValidID(ni->ref1) || !Engine::Get(ni->ref1)->IsEnabled())) ||
978 (ni->reftype2 == NR_ENGINE && (!Engine::IsValidID(ni->ref2) || !Engine::Get(ni->ref2)->IsEnabled()))) {
979 DeleteNewsItem(ni);
980 }
981 ni = next;
982 }
983 }
984
985 static void RemoveOldNewsItems()
986 {
987 NewsItem *next;
988 for (NewsItem *cur = _oldest_news; _total_news > MIN_NEWS_AMOUNT && cur != nullptr; cur = next) {
989 next = cur->next;
990 if (_date - _news_type_data[cur->type].age * _settings_client.gui.news_message_timeout > cur->date) DeleteNewsItem(cur);
991 }
992 }
993
1000 void ChangeVehicleNews(VehicleID from_index, VehicleID to_index)
1001 {
1002 for (NewsItem *ni = _oldest_news; ni != nullptr; ni = ni->next) {
1003 if (ni->reftype1 == NR_VEHICLE && ni->ref1 == from_index) ni->ref1 = to_index;
1004 if (ni->reftype2 == NR_VEHICLE && ni->ref2 == from_index) ni->ref2 = to_index;
1005 if (ni->flags & NF_VEHICLE_PARAM0 && ni->params[0] == from_index) ni->params[0] = to_index;
1006 }
1007 }
1008
1009 void NewsLoop()
1010 {
1011 /* no news item yet */
1012 if (_total_news == 0) return;
1013
1014 static byte _last_clean_month = 0;
1015
1016 if (_last_clean_month != _cur_month) {
1017 RemoveOldNewsItems();
1018 _last_clean_month = _cur_month;
1019 }
1020
1021 if (ReadyForNextTickerItem()) MoveToNextTickerItem();
1022 if (ReadyForNextNewsItem()) MoveToNextNewsItem();
1023 }
1024
1026 static void ShowNewsMessage(const NewsItem *ni)
1027 {
1028 assert(_total_news != 0);
1029
1030 /* Delete the news window */
1031 CloseWindowById(WC_NEWS_WINDOW, 0);
1032
1033 /* setup forced news item */
1034 _forced_news = ni;
1035
1036 if (_forced_news != nullptr) {
1037 CloseWindowById(WC_NEWS_WINDOW, 0);
1038 ShowNewspaper(ni);
1039 }
1040 }
1041
1046 bool HideActiveNewsMessage() {
1047 NewsWindow *w = (NewsWindow*)FindWindowById(WC_NEWS_WINDOW, 0);
1048 if (w == nullptr) return false;
1049 w->Close();
1050 return true;
1051 }
1052
1054 void ShowLastNewsMessage()
1055 {
1056 const NewsItem *ni = nullptr;
1057 if (_total_news == 0) {
1058 return;
1059 } else if (_forced_news == nullptr) {
1060 /* Not forced any news yet, show the current one, unless a news window is
1061 * open (which can only be the current one), then show the previous item */
1062 if (_current_news == nullptr) {
1063 /* No news were shown yet resp. the last shown one was already deleted.
1064 * Threat this as if _forced_news reached _oldest_news; so, wrap around and start anew with the latest. */
1065 ni = _latest_news;
1066 } else {
1067 const Window *w = FindWindowById(WC_NEWS_WINDOW, 0);
1068 ni = (w == nullptr || (_current_news == _oldest_news)) ? _current_news : _current_news->prev;
1069 }
1070 } else if (_forced_news == _oldest_news) {
1071 /* We have reached the oldest news, start anew with the latest */
1072 ni = _latest_news;
1073 } else {
1074 /* 'Scrolling' through news history show each one in turn */
1075 ni = _forced_news->prev;
1076 }
1077 bool wrap = false;
1078 for (;;) {
1079 if (_news_type_data[ni->type].GetDisplay() != ND_OFF) {
1080 ShowNewsMessage(ni);
1081 break;
1082 }
1083
1084 ni = ni->prev;
1085 if (ni == nullptr) {
1086 if (wrap) break;
1087 /* We have reached the oldest news, start anew with the latest */
1088 ni = _latest_news;
1089 wrap = true;
1090 }
1091 }
1092 }
1093
1094
1104 static void DrawNewsString(uint left, uint right, int y, TextColour colour, const NewsItem *ni)
1105 {
1106 char buffer[512], buffer2[512];
1107 StringID str;
1108
1109 CopyInDParam(0, ni->params, lengthof(ni->params));
1110 str = ni->string_id;
1111
1112 GetString(buffer, str, lastof(buffer));
1113 /* Copy the just gotten string to another buffer to remove any formatting
1114 * from it such as big fonts, etc. */
1115 const char *ptr = buffer;
1116 char *dest = buffer2;
1117 WChar c_last = '\0';
1118 for (;;) {
1119 WChar c = Utf8Consume(&ptr);
1120 if (c == 0) break;
1121 /* Make a space from a newline, but ignore multiple newlines */
1122 if (c == '\n' && c_last != '\n') {
1123 dest[0] = ' ';
1124 dest++;
1125 } else if (c == '\r') {
1126 dest[0] = dest[1] = dest[2] = dest[3] = ' ';
1127 dest += 4;
1128 } else if (IsPrintable(c)) {
1129 dest += Utf8Encode(dest, c);
1130 }
1131 c_last = c;
1132 }
1133
1134 *dest = '\0';
1135 /* Truncate and show string; postfixed by '...' if necessary */
1136 DrawString(left, right, y, buffer2, colour);
1137 }
1138
1139 struct MessageHistoryWindow : Window {
1140 int line_height;
1141 int date_width;
1142
1143 Scrollbar *vscroll;
1144
1145 MessageHistoryWindow(WindowDesc *desc) : Window(desc)
1146 {
1147 this->CreateNestedTree();
1148 this->vscroll = this->GetScrollbar(WID_MH_SCROLLBAR);
1149 this->FinishInitNested(); // Initializes 'this->line_height' and 'this->date_width'.
1150 this->OnInvalidateData(0);
1151 }
1152
1153 void UpdateWidgetSize(int widget, Dimension *size, const Dimension &padding, Dimension *fill, Dimension *resize) override
1154 {
1155 if (widget == WID_MH_BACKGROUND) {
1156 this->line_height = FONT_HEIGHT_NORMAL + WidgetDimensions::scaled.vsep_normal;
1157 resize->height = this->line_height;
1158
1159 /* Months are off-by-one, so it's actually 8. Not using
1160 * month 12 because the 1 is usually less wide. */
1161 SetDParam(0, ConvertYMDToDate(ORIGINAL_MAX_YEAR, 7, 30));
1162 this->date_width = GetStringBoundingBox(STR_SHORT_DATE).width + WidgetDimensions::scaled.hsep_wide;
1163
1164 size->height = 4 * resize->height + WidgetDimensions::scaled.framerect.Vertical(); // At least 4 lines are visible.
1165 size->width = std::max(200u, size->width); // At least 200 pixels wide.
1166 }
1167 }
1168
1169 void OnPaint() override
1170 {
1171 this->OnInvalidateData(0);
1172 this->DrawWidgets();
1173 }
1174
1175 void DrawWidget(const Rect &r, int widget) const override
1176 {
1177 if (widget != WID_MH_BACKGROUND || _total_news == 0) return;
1178
1179 /* Find the first news item to display. */
1180 NewsItem *ni = _latest_news;
1181 for (int n = this->vscroll->GetPosition(); n > 0; n--) {
1182 ni = ni->prev;
1183 if (ni == nullptr) return;
1184 }
1185
1186 /* Fill the widget with news items. */
1187 bool rtl = _current_text_dir == TD_RTL;
1188 Rect news = r.Shrink(WidgetDimensions::scaled.framerect).Indent(this->date_width + WidgetDimensions::scaled.hsep_wide, rtl);
1189 Rect date = r.Shrink(WidgetDimensions::scaled.framerect).WithWidth(this->date_width, rtl);
1190 int y = news.top;
1191 for (int n = this->vscroll->GetCapacity(); n > 0; n--) {
1192 SetDParam(0, ni->date);
1193 DrawString(date.left, date.right, y, STR_SHORT_DATE);
1194
1195 DrawNewsString(news.left, news.right, y, TC_WHITE, ni);
1196 y += this->line_height;
1197
1198 ni = ni->prev;
1199 if (ni == nullptr) return;
1200 }
1201 }
1202
1208 void OnInvalidateData(int data = 0, bool gui_scope = true) override
1209 {
1210 if (!gui_scope) return;
1211 this->vscroll->SetCount(_total_news);
1212 }
1213
1214 void OnClick(Point pt, int widget, int click_count) override
1215 {
1216 if (widget == WID_MH_BACKGROUND) {
1217 NewsItem *ni = _latest_news;
1218 if (ni == nullptr) return;
1219
1220 for (int n = this->vscroll->GetScrolledRowFromWidget(pt.y, this, WID_MH_BACKGROUND, WidgetDimensions::scaled.framerect.top); n > 0; n--) {
1221 ni = ni->prev;
1222 if (ni == nullptr) return;
1223 }
1224
1225 ShowNewsMessage(ni);
1226 }
1227 }
1228
1229 void OnResize() override
1230 {
1231 this->vscroll->SetCapacityFromWidget(this, WID_MH_BACKGROUND);
1232 }
1233 };
1234
1235 static const NWidgetPart _nested_message_history[] = {
1236 NWidget(NWID_HORIZONTAL),
1237 NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
1238 NWidget(WWT_CAPTION, COLOUR_BROWN), SetDataTip(STR_MESSAGE_HISTORY, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
1239 NWidget(WWT_SHADEBOX, COLOUR_BROWN),
1240 NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
1241 NWidget(WWT_STICKYBOX, COLOUR_BROWN),
1242 EndContainer(),
1243
1244 NWidget(NWID_HORIZONTAL),
1245 NWidget(WWT_PANEL, COLOUR_BROWN, WID_MH_BACKGROUND), SetMinimalSize(200, 125), SetDataTip(0x0, STR_MESSAGE_HISTORY_TOOLTIP), SetResize(1, 12), SetScrollbar(WID_MH_SCROLLBAR),
1246 EndContainer(),
1247 NWidget(NWID_VERTICAL),
1248 NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_MH_SCROLLBAR),
1249 NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
1250 EndContainer(),
1251 EndContainer(),
1252 };
1253
1254 static WindowDesc _message_history_desc(
1255 WDP_AUTO, "list_news", 400, 140,
1256 WC_MESSAGE_HISTORY, WC_NONE,
1257 0,
1258 _nested_message_history, lengthof(_nested_message_history)
1259 );
1260
1262 void ShowMessageHistory()
1263 {
1264 CloseWindowById(WC_MESSAGE_HISTORY, 0);
1265 new MessageHistoryWindow(&_message_history_desc);
1266 }
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:267
NewsWindow::SetStringParameters
void SetStringParameters(int widget) const override
Initialize string parameters for a widget.
Definition: news_gui.cpp:422
PC_WHITE
static const uint8 PC_WHITE
White palette colour.
Definition: gfx_func.h:245
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:1208
WID_MH_SCROLLBAR
@ WID_MH_SCROLLBAR
Scrollbar for the list.
Definition: news_widget.h:41
NewsWindow::chat_height
uint16 chat_height
Height of the chat window.
Definition: news_gui.cpp:265
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:806
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:3252
EIT_PREVIEW
@ EIT_PREVIEW
Vehicle drawn in preview window, news, ...
Definition: vehicle_type.h:92
sound_func.h
news_cmd.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:938
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:2456
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:139
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:36
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:1724
Vehicle::y_pos
int32 y_pos
y coordinate.
Definition: vehicle_base.h:284
CompanyNewsInformation::colour
byte colour
The colour related to the company.
Definition: news_type.h:164
SetWindowDirty
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
Definition: window.cpp:3154
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:348
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:140
NR_TILE
@ NR_TILE
Reference tile. Scroll to tile when clicking on the news.
Definition: news_type.h:52
SetScrollbar
static NWidgetPart SetScrollbar(int index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1208
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:268
Vehicle::x_pos
int32 x_pos
x coordinate.
Definition: vehicle_base.h:283
NewsWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: news_gui.cpp:427
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:667
command_func.h
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:1104
PackEngineNameDParam
uint64 PackEngineNameDParam(EngineID engine_id, EngineNameContext context, uint32 extra_data=0)
Combine an engine ID and a name context to an engine name dparam.
Definition: engine_type.h:196
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:1141
CMD_ERROR
static const CommandCost CMD_ERROR
Define a default return value for a failed command.
Definition: command_func.h:28
Window::GetScrollbar
const Scrollbar * GetScrollbar(uint widnum) const
Return the Scrollbar to a widget index.
Definition: window.cpp:320
dropdown_func.h
Rect::Shrink
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
Definition: geometry_type.hpp:92
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:1420
_news_window_layout
static WindowDesc * _news_window_layout[]
Window layouts for news items.
Definition: news_gui.cpp:212
guitimer_func.h
statusbar_gui.h
NewsItem
Information about a single item of news.
Definition: news_type.h:126
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:160
NWidgetViewport
Nested widget to display a viewport in a window.
Definition: widget_type.h:620
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:285
NewsAllocatedData
Container for any custom data that must be deleted after the news item has reached end-of-life.
Definition: news_type.h:120
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:137
NewsTypeData
Per-NewsType data.
Definition: news_type.h:98
WF_DISABLE_VP_SCROLL
@ WF_DISABLE_VP_SCROLL
Window does not do autoscroll,.
Definition: window_gui.h:175
Window::viewport
ViewportData * viewport
Pointer to viewport data, if present.
Definition: window_gui.h:255
ND_SHADE_DIMMED
@ ND_SHADE_DIMMED
Bit value of the 'dimmed colours' flag.
Definition: widget_type.h:302
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:296
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:1771
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:1157
INVALID_TILE
static constexpr TileIndex INVALID_TILE
The very nice invalid tile marker.
Definition: tile_type.h:108
ND_FULL
@ ND_FULL
Show newspaper.
Definition: news_type.h:92
TileIndex
The index/ID of a Tile.
Definition: tile_type.h:85
Scrollbar::SetCount
void SetCount(int num)
Sets the number of elements in the list.
Definition: widget_type.h:715
_ctrl_pressed
bool _ctrl_pressed
Is Ctrl pressed?
Definition: gfx.cpp:38
Utf8Encode
size_t Utf8Encode(T buf, WChar c)
Encode a unicode character and place it in the buffer.
Definition: string.cpp:635
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:40
ShowMessageHistory
void ShowMessageHistory()
Display window with news messages history.
Definition: news_gui.cpp:1262
TextColour
TextColour
Colour of the strings, see _string_colourmap in table/string_colours.h or docs/ottd-colourtext-palett...
Definition: gfx_type.h:257
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:1000
SetResize
static NWidgetPart SetResize(int16 dx, int16 dy)
Widget part function for setting the resize step.
Definition: widget_type.h:995
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:265
SpecializedStation< Station, false >::Get
static Station * Get(size_t index)
Gets station with given index.
Definition: base_station_base.h:218
_settings_client
ClientSettings _settings_client
The current settings for this game.
Definition: settings.cpp:53
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:644
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:209
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:253
NFB_WINDOW_LAYOUT
@ NFB_WINDOW_LAYOUT
First bit for window layout.
Definition: news_type.h:68
NewsItem::reftype2
NewsReferenceType reftype2
Type of ref2.
Definition: news_type.h:135
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:75
MessageHistoryWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: news_gui.cpp:1229
NewsWindow::SetWindowTop
void SetWindowTop(int newtop)
Moves the window to a new top coordinate.
Definition: news_gui.cpp:574
settings_internal.h
Rect::Expand
Rect Expand(int s) const
Copy and expand Rect by s pixels.
Definition: geometry_type.hpp:147
VEH_ROAD
@ VEH_ROAD
Road vehicle type.
Definition: vehicle_type.h:25
Vehicle
Vehicle data structure.
Definition: vehicle_base.h:224
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:2353
Owner
Owner
Enum for all companies/owners.
Definition: company_type.h:18
Scrollbar
Scrollbar data structure.
Definition: widget_type.h:634
NewsWindow::TIMER_INTERVAL
static const uint TIMER_INTERVAL
Scrolling interval, scaled by line text line height. This value chosen to maintain the 15ms at normal...
Definition: news_gui.cpp:270
DC_EXEC
@ DC_EXEC
execute the given command
Definition: command_type.h:357
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:973
DoCommandFlag
DoCommandFlag
List of flags for a command.
Definition: command_type.h:355
SetDataTip
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1109
NWidgetCore::widget_data
uint32 widget_data
Data of the widget.
Definition: widget_type.h:338
GetStringBoundingBox
Dimension GetStringBoundingBox(const char *str, FontSize start_fontsize)
Return the string dimension in pixels.
Definition: gfx.cpp:890
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:789
NewsWindow::OnInvalidateData
void OnInvalidateData(int data=0, bool gui_scope=true) override
Some data on this window has become invalid.
Definition: news_gui.cpp:546
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:1143
NR_ENGINE
@ NR_ENGINE
Reference engine.
Definition: news_type.h:57
NR_NONE
@ NR_NONE
Empty reference.
Definition: news_type.h:51
NewsItem::flags
NewsFlag flags
NewsFlags bits.
Definition: news_type.h:132
NF_NO_TRANSPARENT
@ NF_NO_TRANSPARENT
Bit value for disabling transparency.
Definition: news_type.h:73
NewsTypeData::age
const byte age
Maximum age of news items (in days)
Definition: news_type.h:100
NewsTypeData::sound
const SoundFx sound
Sound.
Definition: news_type.h:101
WindowDesc
High level window description.
Definition: window_gui.h:102
NR_TOWN
@ NR_TOWN
Reference town. Scroll to town when clicking on the news.
Definition: news_type.h:56
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:50
NewsWindow
Window class displaying a news item.
Definition: news_gui.cpp:264
NT_END
@ NT_END
end-of-array marker
Definition: news_type.h:38
NewsItem::type
NewsType type
Type of the news.
Definition: news_type.h:131
PositionNewsMessage
int PositionNewsMessage(Window *w)
(Re)position news message window at the screen.
Definition: window.cpp:3453
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:90
DeleteVehicleNews
void DeleteVehicleNews(VehicleID vid, StringID news)
Delete a news item type about a vehicle.
Definition: news_gui.cpp:919
Window::resize
ResizeInfo resize
Resize information.
Definition: window_gui.h:251
CommandCost
Common return value for all commands.
Definition: command_type.h:24
_date
Date _date
Current date in days (day counter)
Definition: date.cpp:28
NWidgetViewport::UpdateViewportCoordinates
void UpdateViewportCoordinates(Window *w)
Update the position and size of the viewport (after eg a resize).
Definition: widget.cpp:2331
ClientSettings::sound
SoundSettings sound
sound effect settings
Definition: settings_type.h:607
CmdCustomNewsItem
CommandCost CmdCustomNewsItem(DoCommandFlag flags, NewsType type, NewsReferenceType reftype1, CompanyID company, uint32 reference, const std::string &text)
Create a new custom news item.
Definition: news_gui.cpp:865
NF_INCOLOUR
@ NF_INCOLOUR
Bit value for coloured news.
Definition: news_type.h:72
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:1142
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:249
NewsType
NewsType
Type of news.
Definition: news_type.h:21
SBI_NEWS_DELETED
@ SBI_NEWS_DELETED
abort current news display (active news were deleted)
Definition: statusbar_gui.h:19
ScrollWindowToTile
bool ScrollWindowToTile(TileIndex tile, Window *w, bool instant)
Scrolls the viewport in a window to a given location.
Definition: viewport.cpp:2445
ConvertYMDToDate
Date ConvertYMDToDate(Year year, Month month, Day day)
Converts a tuple of Year, Month and Day to a Date.
Definition: date.cpp:149
RectPadding::Horizontal
uint Horizontal() const
Get total horizontal padding of RectPadding.
Definition: geometry_type.hpp:59
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:48
NewsReferenceType
NewsReferenceType
References to objects in news.
Definition: news_type.h:50
WID_N_TITLE
@ WID_N_TITLE
Title of the company news.
Definition: news_widget.h:18
NewsTypeData::name
const char *const name
Name.
Definition: news_type.h:99
SoundSettings::news_full
bool news_full
Play sound effects associated to certain news types.
Definition: settings_type.h:214
DeleteNewsItem
static void DeleteNewsItem(NewsItem *ni)
Delete a news item from the queue.
Definition: news_gui.cpp:749
WidgetDimensions::hsep_wide
int hsep_wide
Wide horizontal spacing.
Definition: window_gui.h:64
MessageHistoryWindow::OnPaint
void OnPaint() override
The window must be repainted.
Definition: news_gui.cpp:1169
PALETTE_NEWSPAPER
static const PaletteID PALETTE_NEWSPAPER
Recolour sprite for newspaper-greying.
Definition: sprites.h:1597
MoveToNextTickerItem
static void MoveToNextTickerItem()
Move to the next ticker item.
Definition: news_gui.cpp:679
MAX_NEWS_AMOUNT
static uint MAX_NEWS_AMOUNT
Do not exceed this number of news messages.
Definition: news_gui.cpp:49
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:342
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:484
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:147
NewsTypeData::GetDisplay
NewsDisplay GetDisplay() const
Return the news display option.
Definition: news_gui.cpp:256
_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:625
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:246
NewsWindow::status_height
uint16 status_height
Height of the status bar window.
Definition: news_gui.cpp:266
IsValidTile
static bool IsValidTile(TileIndex tile)
Checks if a tile is valid.
Definition: tile_map.h:161
Rect::Indent
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Definition: geometry_type.hpp:192
WidgetDimensions::captiontext
RectPadding captiontext
Offsets of text within a caption.
Definition: window_gui.h:56
NewsItem::string_id
StringID string_id
Message text.
Definition: news_type.h:129
Rect::WithWidth
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
Definition: geometry_type.hpp:179
NewsItem::prev
NewsItem * prev
Previous news item.
Definition: news_type.h:127
MessageHistoryWindow
Definition: news_gui.cpp:1139
ND_OFF
@ ND_OFF
Only show a reminder in the status bar.
Definition: news_type.h:90
GetStringMultiLineBoundingBox
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Definition: gfx.cpp:755
NewsWindow::OnResize
void OnResize() override
Called after the window got resized.
Definition: news_gui.cpp:529
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:1883
_forced_news
static const NewsItem * _forced_news
Forced news item.
Definition: news_gui.cpp:60
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:1153
DeleteIndustryNews
void DeleteIndustryNews(IndustryID iid)
Remove news regarding given industry.
Definition: news_gui.cpp:955
stdafx.h
NewsItem::next
NewsItem * next
Next news item.
Definition: news_type.h:128
PC_BLACK
static const uint8 PC_BLACK
Black palette colour.
Definition: gfx_func.h:242
Window::window_number
WindowNumber window_number
Window number within the window class.
Definition: window_gui.h:241
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:116
SoundFx
SoundFx
Sound effects from baseset.
Definition: sound_type.h:37
RectPadding::Vertical
uint Vertical() const
Get total vertical padding of RectPadding.
Definition: geometry_type.hpp:65
viewport_func.h
NF_NORMAL
@ NF_NORMAL
Normal news item. (Newspaper with text only)
Definition: news_type.h:79
WC_NONE
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
Definition: window_type.h:38
NewsDisplay
NewsDisplay
News display options.
Definition: news_type.h:89
PC_GREY
static const uint8 PC_GREY
Grey palette colour.
Definition: gfx_func.h:244
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:993
NewsWindow::OnRealtimeTick
void OnRealtimeTick(uint delta_ms) override
Called periodically.
Definition: news_gui.cpp:555
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:91
string_func.h
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:72
EndContainer
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1094
station_base.h
CompanyNewsInformation
Data that needs to be stored for company news messages.
Definition: news_type.h:158
engine_gui.h
strings_func.h
NWID_VSCROLLBAR
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:82
NR_INDUSTRY
@ NR_INDUSTRY
Reference industry. Scroll to industry when clicking on the news. Delete news when industry is delete...
Definition: news_type.h:55
NWidgetCore::disp_flags
NWidgetDisplay disp_flags
Flags that affect display and interaction with the widget.
Definition: widget_type.h:335
NewsWindow::ni
const NewsItem * ni
News item to display.
Definition: news_gui.cpp:267
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:1026
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:1183
WID_MH_BACKGROUND
@ WID_MH_BACKGROUND
Background of the window.
Definition: news_widget.h:40
FONT_HEIGHT_NORMAL
#define FONT_HEIGHT_NORMAL
Height of characters in the normal (FS_NORMAL) font.
Definition: gfx_func.h:206
ScaleZoomGUI
static ZoomLevel ScaleZoomGUI(ZoomLevel value)
Scale zoom level relative to GUI zoom.
Definition: zoom_func.h:87
ShowNewspaper
static void ShowNewspaper(const NewsItem *ni)
Open up an own newspaper window for the news item.
Definition: news_gui.cpp:616
NWidget
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1227
MessageHistoryWindow::DrawWidget
void DrawWidget(const Rect &r, int widget) const override
Draw the contents of a nested widget.
Definition: news_gui.cpp:1175
geometry_func.hpp
SetMinimalSize
static NWidgetPart SetMinimalSize(int16 x, int16 y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1012
NWidgetViewport::InitializeViewport
void InitializeViewport(Window *w, uint32 follow_flags, ZoomLevel zoom)
Initialize the viewport of the window.
Definition: widget.cpp:2322
WWT_PANEL
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:48
ShowLastNewsMessage
void ShowLastNewsMessage()
Show previous news item.
Definition: news_gui.cpp:1054
CompanyNewsInformation::face
uint32 face
The face of the president.
Definition: news_type.h:163
DrawCompanyManagerFace
void DrawCompanyManagerFace(CompanyManagerFace cmf, int colour, int x, int y)
Draws the face of a company manager's face.
Definition: company_gui.cpp:1179
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:1141
NFB_WINDOW_LAYOUT_COUNT
@ NFB_WINDOW_LAYOUT_COUNT
Number of bits for window layout.
Definition: news_type.h:69
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:676
FindWindowByClass
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
Definition: window.cpp:1172
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:63
Window::FinishInitNested
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
Definition: window.cpp:1787
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:161
IntSettingDesc::Read
int32 Read(const void *object) const
Read the integer from the the actual setting.
Definition: settings.cpp:519
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:247
WidgetDimensions::framerect
RectPadding framerect
Offsets within frame area.
Definition: window_gui.h:47
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:130
SoundSettings::news_ticker
bool news_ticker
Play a ticker sound when a news item is published.
Definition: settings_type.h:213
NewsWindow::OnInit
void OnInit() override
Notification that the nested widget tree gets initialized.
Definition: news_gui.cpp:325
NR_VEHICLE
@ NR_VEHICLE
Reference vehicle. Scroll to vehicle when clicking on the news. Delete news when vehicle is deleted.
Definition: news_type.h:53
WC_SEND_NETWORK_MSG
@ WC_SEND_NETWORK_MSG
Chatbox; Window numbers:
Definition: window_type.h:490
ShowVehicleViewWindow
void ShowVehicleViewWindow(const Vehicle *v)
Shows the vehicle view window of the given vehicle.
Definition: vehicle_gui.cpp:3295
window_func.h
CenterBounds
static int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
Definition: gfx_func.h:178
SA_CENTER
@ SA_CENTER
Center both horizontally and vertically.
Definition: gfx_type.h:345
lengthof
#define lengthof(x)
Return the length of an fixed size array.
Definition: stdafx.h:386
Window::width
int width
width of the window (number of pixels to the right in x direction)
Definition: window_gui.h:248
_latest_news
NewsItem * _latest_news
tail of news items queue
Definition: news_gui.cpp:52
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:2427
WDP_MANUAL
@ WDP_MANUAL
Manually align the window (so no automatic location finding)
Definition: window_gui.h:89
ReadyForNextNewsItem
static bool ReadyForNextNewsItem()
Are we ready to show another news item? Only if no newspaper is displayed.
Definition: news_gui.cpp:669
ZOOM_LVL_NEWS
@ ZOOM_LVL_NEWS
Default zoom level for the news messages.
Definition: zoom_type.h:34
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:1187
NF_SHADE
@ NF_SHADE
Bit value for enabling shading.
Definition: news_type.h:74
RoadVehicle::IsBus
bool IsBus() const
Check whether a roadvehicle is a bus.
Definition: roadveh_cmd.cpp:81
engine_base.h
NewsItem::params
uint64 params[10]
Parameters for string resolving.
Definition: news_type.h:141
HideActiveNewsMessage
bool HideActiveNewsMessage()
Close active news message window.
Definition: news_gui.cpp:1046
MoveToNextNewsItem
static void MoveToNextNewsItem()
Move to the next news item.
Definition: news_gui.cpp:713
ND_SHADE_GREY
@ ND_SHADE_GREY
Bit value of the 'shade to grey' flag.
Definition: widget_type.h:301
NewsStringData::string
std::string string
The string to retain.
Definition: news_type.h:148
NewsFlag
NewsFlag
Various OR-able news-item flags.
Definition: news_type.h:64
_oldest_news
static NewsItem * _oldest_news
head of news items queue
Definition: news_gui.cpp:51
SetFill
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1078
_news_type_data
static NewsTypeData _news_type_data[]
Per-NewsType data.
Definition: news_gui.cpp:230
DrawCaption
void DrawCaption(const Rect &r, Colours colour, Owner owner, TextColour text_colour, StringID str, StringAlignment align)
Draw a caption bar.
Definition: widget.cpp:804
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:827
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:213
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:57
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:971
Window::DrawWidgets
void DrawWidgets() const
Paint all widgets of a window.
Definition: widget.cpp:858
WC_NEWS_WINDOW
@ WC_NEWS_WINDOW
News window; Window numbers:
Definition: window_type.h:241
SettingDesc::IsIntSetting
virtual bool IsIntSetting() const
Check whether this setting is an integer type setting.
Definition: settings_internal.h:97
WidgetDimensions::scaled
static WidgetDimensions scaled
Widget dimensions scaled for current zoom level.
Definition: window_gui.h:68
NWidgetCore
Base class for a 'real' widget.
Definition: widget_type.h:314
InitNewsItemStructs
void InitNewsItemStructs()
Initialize the news-items data structures.
Definition: news_gui.cpp:634
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:136
Rect
Specification of a rectangle with absolute coordinates of all edges.
Definition: geometry_type.hpp:69
_cur_month
Month _cur_month
Current month (0..11)
Definition: date.cpp:27
SND_1D_APPLAUSE
@ SND_1D_APPLAUSE
27 == 0x1B News: first vehicle at station
Definition: sound_type.h:66
NR_STATION
@ NR_STATION
Reference station. Scroll to station when clicking on the news. Delete news when station is deleted.
Definition: news_type.h:54
lastof
#define lastof(x)
Get the last element of an fixed size array.
Definition: stdafx.h:402
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:49
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:297
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:129
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:297
WWT_TEXTBTN
@ WWT_TEXTBTN
(Toggle) Button with text
Definition: widget_type.h:53
GUISettings::coloured_news_year
Year coloured_news_year
when does newspaper become coloured?
Definition: settings_type.h:154
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:604
PreviewNews
@ PreviewNews
Name is shown in exclusive preview or newspaper.
Definition: engine_type.h:192
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:1214
NewsItem::reftype1
NewsReferenceType reftype1
Type of ref1.
Definition: news_type.h:134
SettingDesc::AsIntSetting
const struct IntSettingDesc * AsIntSetting() const
Get the setting description of this setting as an integer setting.
Definition: settings.cpp:833
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:300
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:655
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:1103
WidgetDimensions::vsep_normal
int vsep_normal
Normal vertical spacing.
Definition: window_gui.h:61