1
0
mirror of https://github.com/OpenTTD/OpenTTD synced 2026-01-17 01:12:39 +01:00
Files
OpenTTD/src/news_gui.cpp
Peter Nelson e4cf6ca0ba Fix: Mis-sized widgets due to missing widget fill. (#14370)
In most places where we calculate and set widget resize step we neglect
to set widget fill step to match. Initial widget sizing uses fill step
instead of resize step, which means the initial size may not be a
multiple of the resize step as intended. In particular this will cause
WWT_MATRIX to be misrendered.

Whether or not this matters depends on the widget type being resized and
the window layout, however for consistency always set fill step to the
same as resize step when calculating.
2025-06-17 17:40:11 +01:00

1310 lines
45 KiB
C++

/*
* This file is part of OpenTTD.
* 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.
* 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.
* 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/>.
*/
/** @file news_gui.cpp GUI functions related to news messages. */
#include "stdafx.h"
#include "gui.h"
#include "viewport_func.h"
#include "strings_func.h"
#include "window_func.h"
#include "vehicle_base.h"
#include "vehicle_func.h"
#include "vehicle_gui.h"
#include "roadveh.h"
#include "station_base.h"
#include "industry.h"
#include "town.h"
#include "sound_func.h"
#include "string_func.h"
#include "statusbar_gui.h"
#include "company_manager_face.h"
#include "company_func.h"
#include "engine_base.h"
#include "engine_gui.h"
#include "core/geometry_func.hpp"
#include "command_func.h"
#include "company_base.h"
#include "settings_internal.h"
#include "group_gui.h"
#include "zoom_func.h"
#include "news_cmd.h"
#include "news_func.h"
#include "timer/timer.h"
#include "timer/timer_window.h"
#include "timer/timer_game_calendar.h"
#include "widgets/news_widget.h"
#include "table/strings.h"
#include "safeguards.h"
static const uint MIN_NEWS_AMOUNT = 30; ///< preferred minimum amount of news messages.
static const uint MAX_NEWS_AMOUNT = 1U << 10; ///< Do not exceed this number of news messages.
static NewsContainer _news; ///< List of news, with newest items at the start.
/**
* Forced news item.
* Users can force an item by accessing the history or "last message".
* If the message being shown was forced by the user, an iterator is stored
* in _forced_news. Otherwise, \a _forced_news variable is the end of \a _news.
*/
static NewsIterator _forced_news = std::end(_news);
/** Current news item (last item shown regularly). */
static NewsIterator _current_news = std::end(_news);
/** Current status bar news item. */
static NewsIterator _statusbar_news = std::end(_news);
/**
* Get pointer to the current status bar news item.
* @return Pointer to the current status bar news item, or nullptr if there is none.
*/
const NewsItem *GetStatusbarNews()
{
return (_statusbar_news == std::end(_news)) ? nullptr : &*_statusbar_news;
}
/**
* Get read-only reference to all news items.
* @return Read-only reference to all news items.
*/
const NewsContainer &GetNews()
{
return _news;
}
/**
* Get the position a news-reference is referencing.
* @param reference The reference.
* @return A tile for the referenced object, or INVALID_TILE if none.
*/
static TileIndex GetReferenceTile(const NewsReference &reference)
{
struct visitor {
TileIndex operator()(const std::monostate &) { return INVALID_TILE; }
TileIndex operator()(const TileIndex &t) { return t; }
TileIndex operator()(const VehicleID) { return INVALID_TILE; }
TileIndex operator()(const StationID s) { return Station::Get(s)->xy; }
TileIndex operator()(const IndustryID i) { return Industry::Get(i)->location.tile + TileDiffXY(1, 1); }
TileIndex operator()(const TownID t) { return Town::Get(t)->xy; }
TileIndex operator()(const EngineID) { return INVALID_TILE; }
};
return std::visit(visitor{}, reference);
}
/* Normal news items. */
static constexpr NWidgetPart _nested_normal_news_widgets[] = {
NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
NWidget(NWID_VERTICAL), SetPadding(WidgetDimensions::unscaled.fullbevel),
NWidget(NWID_LAYER, INVALID_COLOUR),
/* Layer 1 */
NWidget(NWID_VERTICAL), SetPIPRatio(0, 0, 1),
NWidget(NWID_HORIZONTAL), SetPIPRatio(0, 1, 0),
NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX),
NWidget(WWT_LABEL, INVALID_COLOUR, WID_N_DATE),
SetTextStyle(TC_BLACK, FS_SMALL),
SetAlignment(SA_RIGHT | SA_TOP),
EndContainer(),
EndContainer(),
/* Layer 2 */
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_MESSAGE),
SetMinimalTextLines(8, 0, FS_LARGE),
SetMinimalSize(400, 0),
SetPadding(WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.vsep_wide),
SetTextStyle(TC_BLACK, FS_LARGE),
EndContainer(),
EndContainer(),
EndContainer(),
};
static WindowDesc _normal_news_desc(
WDP_MANUAL, {}, 0, 0,
WC_NEWS_WINDOW, WC_NONE,
{},
_nested_normal_news_widgets
);
/* New vehicles news items. */
static constexpr NWidgetPart _nested_vehicle_news_widgets[] = {
NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
NWidget(NWID_VERTICAL), SetPadding(WidgetDimensions::unscaled.fullbevel),
NWidget(NWID_LAYER, INVALID_COLOUR),
/* Layer 1 */
NWidget(NWID_VERTICAL), SetPIPRatio(0, 0, 1),
NWidget(NWID_HORIZONTAL), SetPIPRatio(0, 1, 0),
NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX),
EndContainer(),
EndContainer(),
/* Layer 2 */
NWidget(WWT_LABEL, INVALID_COLOUR, WID_N_VEH_TITLE),
SetFill(1, 1),
SetMinimalTextLines(2, 0, FS_LARGE),
SetMinimalSize(400, 0),
SetPadding(WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.vsep_wide),
SetStringTip(STR_EMPTY),
SetTextStyle(TC_BLACK, FS_LARGE),
EndContainer(),
NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_VEH_BKGND), SetPadding(WidgetDimensions::unscaled.fullbevel),
NWidget(NWID_VERTICAL),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_NAME),
SetMinimalTextLines(1, 0, FS_LARGE),
SetMinimalSize(350, 0),
SetPadding(WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.vsep_wide),
SetFill(1, 0),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_SPR),
SetMinimalSize(350, 32),
SetFill(1, 0),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_VEH_INFO),
SetMinimalTextLines(3, 0, FS_NORMAL),
SetMinimalSize(350, 0),
SetPadding(WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.vsep_wide),
SetFill(1, 0),
EndContainer(),
EndContainer(),
EndContainer(),
EndContainer(),
};
static WindowDesc _vehicle_news_desc(
WDP_MANUAL, {}, 0, 0,
WC_NEWS_WINDOW, WC_NONE,
{},
_nested_vehicle_news_widgets
);
/* Company news items. */
static constexpr NWidgetPart _nested_company_news_widgets[] = {
NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
NWidget(NWID_VERTICAL), SetPadding(WidgetDimensions::unscaled.fullbevel),
NWidget(NWID_LAYER, INVALID_COLOUR),
/* Layer 1 */
NWidget(NWID_VERTICAL), SetPIPRatio(0, 0, 1),
NWidget(NWID_HORIZONTAL), SetPIPRatio(0, 1, 0),
NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX),
EndContainer(),
EndContainer(),
/* Layer 2 */
NWidget(WWT_LABEL, INVALID_COLOUR, WID_N_TITLE),
SetFill(1, 1),
SetMinimalTextLines(1, 0, FS_LARGE),
SetMinimalSize(400, 0),
SetPadding(WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.vsep_normal),
SetTextStyle(TC_BLACK, FS_LARGE),
EndContainer(),
NWidget(NWID_HORIZONTAL),
NWidget(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_normal, 0), SetPadding(2),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_MGR_FACE),
SetFill(0, 0),
SetMinimalSize(93, 119),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_MGR_NAME),
SetFill(0, 1),
SetMinimalTextLines(2, 0),
EndContainer(),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_COMPANY_MSG),
SetFill(1, 1),
SetPadding(WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.vsep_wide),
SetMinimalSize(300, 0),
SetTextStyle(TC_BLACK, FS_LARGE),
EndContainer(),
EndContainer(),
EndContainer(),
};
static WindowDesc _company_news_desc(
WDP_MANUAL, {}, 0, 0,
WC_NEWS_WINDOW, WC_NONE,
{},
_nested_company_news_widgets
);
/* Thin news items. */
static constexpr NWidgetPart _nested_thin_news_widgets[] = {
NWidget(WWT_PANEL, COLOUR_WHITE, WID_N_PANEL),
NWidget(NWID_VERTICAL), SetPadding(WidgetDimensions::unscaled.fullbevel),
NWidget(NWID_LAYER, INVALID_COLOUR),
/* Layer 1 */
NWidget(NWID_VERTICAL), SetPIPRatio(0, 0, 1),
NWidget(NWID_HORIZONTAL), SetPIPRatio(0, 1, 0),
NWidget(WWT_CLOSEBOX, COLOUR_WHITE, WID_N_CLOSEBOX),
NWidget(WWT_LABEL, INVALID_COLOUR, WID_N_DATE),
SetTextStyle(TC_BLACK, FS_SMALL),
SetAlignment(SA_RIGHT | SA_TOP),
EndContainer(),
EndContainer(),
/* Layer 2 */
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_MESSAGE),
SetMinimalTextLines(3, 0, FS_LARGE),
SetMinimalSize(400, 0),
SetPadding(WidgetDimensions::unscaled.hsep_indent, WidgetDimensions::unscaled.vsep_normal),
SetTextStyle(TC_BLACK, FS_LARGE),
EndContainer(),
NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_N_VIEWPORT), SetMinimalSize(426, 70),
SetPadding(WidgetDimensions::unscaled.fullbevel),
EndContainer(),
EndContainer(),
};
static WindowDesc _thin_news_desc(
WDP_MANUAL, {}, 0, 0,
WC_NEWS_WINDOW, WC_NONE,
{},
_nested_thin_news_widgets
);
/* Small news items. */
static constexpr NWidgetPart _nested_small_news_widgets[] = {
/* Caption + close box. The caption is not WWT_CAPTION as the window shall not be moveable and so on. */
NWidget(NWID_HORIZONTAL),
NWidget(WWT_CLOSEBOX, COLOUR_LIGHT_BLUE, WID_N_CLOSEBOX),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_CAPTION),
NWidget(WWT_TEXTBTN, COLOUR_LIGHT_BLUE, WID_N_SHOW_GROUP),
SetAspect(WidgetDimensions::ASPECT_VEHICLE_ICON),
SetResize(1, 0),
SetToolTip(STR_NEWS_SHOW_VEHICLE_GROUP_TOOLTIP),
EndContainer(),
/* Main part */
NWidget(WWT_PANEL, COLOUR_LIGHT_BLUE, WID_N_HEADLINE),
NWidget(NWID_VERTICAL),
SetPIP(0, WidgetDimensions::unscaled.vsep_normal, 0),
SetPadding(2),
NWidget(WWT_INSET, COLOUR_LIGHT_BLUE, WID_N_INSET),
NWidget(NWID_VIEWPORT, INVALID_COLOUR, WID_N_VIEWPORT),
SetMinimalSize(274, 47),
EndContainer(),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_N_MESSAGE),
SetMinimalTextLines(2, 0),
SetMinimalSize(275, 0),
SetTextStyle(TC_WHITE, FS_NORMAL),
EndContainer(),
EndContainer(),
};
static WindowDesc _small_news_desc(
WDP_MANUAL, {}, 0, 0,
WC_NEWS_WINDOW, WC_NONE,
{},
_nested_small_news_widgets
);
/**
* Window layouts for news items.
*/
static WindowDesc *_news_window_layout[] = {
&_thin_news_desc, // NewsStyle::Thin
&_small_news_desc, // NewsStyle::Small
&_normal_news_desc, // NewsStyle::Normal
&_vehicle_news_desc, // NewsStyle::Vehicle
&_company_news_desc, // NewsStyle::Company
};
static WindowDesc &GetNewsWindowLayout(NewsStyle style)
{
uint layout = to_underlying(style);
assert(layout < lengthof(_news_window_layout));
return *_news_window_layout[layout];
}
/**
* Per-NewsType data
*/
static const NewsTypeData _news_type_data[] = {
/* name, age, sound, */
NewsTypeData("news_display.arrival_player", 60, SND_1D_APPLAUSE ), ///< NewsType::ArrivalCompany
NewsTypeData("news_display.arrival_other", 60, SND_1D_APPLAUSE ), ///< NewsType::ArrivalOther
NewsTypeData("news_display.accident", 90, SND_BEGIN ), ///< NewsType::Accident
NewsTypeData("news_display.accident_other", 90, SND_BEGIN ), ///< NewsType::AccidentOther
NewsTypeData("news_display.company_info", 60, SND_BEGIN ), ///< NewsType::CompanyInfo
NewsTypeData("news_display.open", 90, SND_BEGIN ), ///< NewsType::IndustryOpen
NewsTypeData("news_display.close", 90, SND_BEGIN ), ///< NewsType::IndustryClose
NewsTypeData("news_display.economy", 30, SND_BEGIN ), ///< NewsType::Economy
NewsTypeData("news_display.production_player", 30, SND_BEGIN ), ///< NewsType::IndustryCompany
NewsTypeData("news_display.production_other", 30, SND_BEGIN ), ///< NewsType::IndustryOther
NewsTypeData("news_display.production_nobody", 30, SND_BEGIN ), ///< NewsType::IndustryNobody
NewsTypeData("news_display.advice", 150, SND_BEGIN ), ///< NewsType::Advice
NewsTypeData("news_display.new_vehicles", 30, SND_1E_NEW_ENGINE), ///< NewsType::NewVehicles
NewsTypeData("news_display.acceptance", 90, SND_BEGIN ), ///< NewsType::Acceptance
NewsTypeData("news_display.subsidies", 180, SND_BEGIN ), ///< NewsType::Subsidies
NewsTypeData("news_display.general", 60, SND_BEGIN ), ///< NewsType::General
};
static_assert(std::size(_news_type_data) == to_underlying(NewsType::End));
/**
* Return the news display option.
* @return display options
*/
NewsDisplay NewsTypeData::GetDisplay() const
{
const SettingDesc *sd = GetSettingFromName(this->name);
assert(sd != nullptr && sd->IsIntSetting());
return static_cast<NewsDisplay>(sd->AsIntSetting()->Read(nullptr));
}
/** Window class displaying a news item. */
struct NewsWindow : Window {
uint16_t chat_height = 0; ///< Height of the chat window.
uint16_t status_height = 0; ///< Height of the status bar window
const NewsItem *ni = nullptr; ///< News item to display.
static int duration; ///< Remaining time for showing the current news message (may only be access while a news item is displayed).
NewsWindow(WindowDesc &desc, const NewsItem *ni) : Window(desc), ni(ni)
{
NewsWindow::duration = 16650;
const Window *w = FindWindowByClass(WC_SEND_NETWORK_MSG);
this->chat_height = (w != nullptr) ? w->height : 0;
this->status_height = FindWindowById(WC_STATUS_BAR, 0)->height;
this->flags.Set(WindowFlag::DisableVpScroll);
this->CreateNestedTree();
NWidgetCore *nwid = this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP);
if (std::holds_alternative<VehicleID>(ni->ref1) && nwid != nullptr) {
const Vehicle *v = Vehicle::Get(std::get<VehicleID>(ni->ref1));
switch (v->type) {
case VEH_TRAIN:
nwid->SetString(STR_TRAIN);
break;
case VEH_ROAD:
nwid->SetString(RoadVehicle::From(v)->IsBus() ? STR_BUS : STR_LORRY);
break;
case VEH_SHIP:
nwid->SetString(STR_SHIP);
break;
case VEH_AIRCRAFT:
nwid->SetString(STR_PLANE);
break;
default:
break; // Do nothing
}
}
this->FinishInitNested(0);
/* Initialize viewport if it exists. */
NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_N_VIEWPORT);
if (nvp != nullptr) {
if (std::holds_alternative<VehicleID>(ni->ref1)) {
nvp->InitializeViewport(this, std::get<VehicleID>(ni->ref1), ScaleZoomGUI(ZoomLevel::News));
} else {
nvp->InitializeViewport(this, GetReferenceTile(ni->ref1), ScaleZoomGUI(ZoomLevel::News));
}
if (this->ni->flags.Test(NewsFlag::NoTransparency)) nvp->disp_flags.Set(NWidgetDisplayFlag::NoTransparency);
if (!this->ni->flags.Test(NewsFlag::InColour)) {
nvp->disp_flags.Set(NWidgetDisplayFlag::ShadeGrey);
} else if (this->ni->flags.Test(NewsFlag::Shaded)) {
nvp->disp_flags.Set(NWidgetDisplayFlag::ShadeDimmed);
}
}
PositionNewsMessage(this);
}
void DrawNewsBorder(const Rect &r) const
{
Rect ir = r.Shrink(WidgetDimensions::scaled.bevel);
GfxFillRect(ir, PC_WHITE);
ir = ir.Expand(1);
GfxFillRect( r.left, r.top, ir.left, r.bottom, PC_BLACK);
GfxFillRect(ir.right, r.top, r.right, r.bottom, PC_BLACK);
GfxFillRect( r.left, r.top, r.right, ir.top, PC_BLACK);
GfxFillRect( r.left, ir.bottom, r.right, r.bottom, PC_BLACK);
}
Point OnInitialPosition([[maybe_unused]] int16_t sm_width, [[maybe_unused]] int16_t sm_height, [[maybe_unused]] int window_number) override
{
Point pt = { 0, _screen.height };
return pt;
}
void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
{
FontSize fontsize = FS_NORMAL;
std::string str;
switch (widget) {
case WID_N_CAPTION: {
/* Caption is not a real caption (so that the window cannot be moved)
* thus it doesn't get the default sizing of a caption. */
Dimension d2 = GetStringBoundingBox(STR_NEWS_MESSAGE_CAPTION);
d2.height += WidgetDimensions::scaled.captiontext.Vertical();
size = maxdim(size, d2);
return;
}
case WID_N_MGR_FACE:
size = maxdim(size, GetScaledSpriteSize(SPR_GRADIENT));
break;
case WID_N_MESSAGE:
case WID_N_COMPANY_MSG:
fontsize = this->GetWidget<NWidgetLeaf>(widget)->GetFontSize();
str = this->ni->headline.GetDecodedString();
break;
case WID_N_VEH_NAME:
case WID_N_VEH_TITLE:
str = this->GetNewVehicleMessageString(widget);
break;
case WID_N_VEH_INFO: {
assert(std::holds_alternative<EngineID>(ni->ref1));
EngineID engine = std::get<EngineID>(this->ni->ref1);
str = GetEngineInfoString(engine);
break;
}
case WID_N_SHOW_GROUP:
if (std::holds_alternative<VehicleID>(ni->ref1)) {
Dimension d2 = GetStringBoundingBox(this->GetWidget<NWidgetCore>(WID_N_SHOW_GROUP)->GetString());
d2.height += WidgetDimensions::scaled.captiontext.Vertical();
d2.width += WidgetDimensions::scaled.captiontext.Horizontal();
size = d2;
} else {
/* Hide 'Show group window' button if this news is not about a vehicle. */
size.width = 0;
size.height = 0;
resize.width = 0;
resize.height = 0;
fill.width = 0;
fill.height = 0;
}
return;
default:
return; // Do nothing
}
/* Update minimal size with length of the multi-line string. */
Dimension d = size;
d.width = (d.width >= padding.width) ? d.width - padding.width : 0;
d.height = (d.height >= padding.height) ? d.height - padding.height : 0;
d = GetStringMultiLineBoundingBox(str, d, fontsize);
d.width += padding.width;
d.height += padding.height;
size = maxdim(size, d);
}
std::string GetWidgetString(WidgetID widget, StringID stringid) const override
{
if (widget == WID_N_DATE) {
return GetString(STR_JUST_DATE_LONG, this->ni->date);
} else if (widget == WID_N_TITLE) {
const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
return GetString(cni->title);
}
return this->Window::GetWidgetString(widget, stringid);
}
void DrawWidget(const Rect &r, WidgetID widget) const override
{
switch (widget) {
case WID_N_CAPTION:
DrawCaption(r, COLOUR_LIGHT_BLUE, this->owner, TC_FROMSTRING, GetString(STR_NEWS_MESSAGE_CAPTION), SA_CENTER, FS_NORMAL);
break;
case WID_N_PANEL:
this->DrawNewsBorder(r);
break;
case WID_N_MESSAGE:
case WID_N_COMPANY_MSG: {
const NWidgetLeaf &nwid = *this->GetWidget<NWidgetLeaf>(widget);
DrawStringMultiLine(r, this->ni->headline.GetDecodedString(), nwid.GetTextColour(), SA_CENTER, false, nwid.GetFontSize());
break;
}
case WID_N_MGR_FACE: {
const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
DrawCompanyManagerFace(cni->face, cni->colour, r);
GfxFillRect(r, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
break;
}
case WID_N_MGR_NAME: {
const CompanyNewsInformation *cni = static_cast<const CompanyNewsInformation*>(this->ni->data.get());
DrawStringMultiLine(r, GetString(STR_JUST_RAW_STRING, cni->president_name), TC_FROMSTRING, SA_CENTER);
break;
}
case WID_N_VEH_BKGND:
GfxFillRect(r, PC_GREY);
break;
case WID_N_VEH_NAME:
case WID_N_VEH_TITLE:
DrawStringMultiLine(r, this->GetNewVehicleMessageString(widget), TC_FROMSTRING, SA_CENTER);
break;
case WID_N_VEH_SPR: {
assert(std::holds_alternative<EngineID>(ni->ref1));
EngineID engine = std::get<EngineID>(this->ni->ref1);
DrawVehicleEngine(r.left, r.right, CentreBounds(r.left, r.right, 0), CentreBounds(r.top, r.bottom, 0), engine, GetEnginePalette(engine, _local_company), EIT_PREVIEW);
GfxFillRect(r, PALETTE_NEWSPAPER, FILLRECT_RECOLOUR);
break;
}
case WID_N_VEH_INFO: {
assert(std::holds_alternative<EngineID>(ni->ref1));
EngineID engine = std::get<EngineID>(this->ni->ref1);
DrawStringMultiLine(r, GetEngineInfoString(engine), TC_BLACK, SA_CENTER);
break;
}
}
}
void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
{
switch (widget) {
case WID_N_CLOSEBOX:
NewsWindow::duration = 0;
this->Close();
_forced_news = std::end(_news);
break;
case WID_N_CAPTION:
if (std::holds_alternative<VehicleID>(ni->ref1)) {
const Vehicle *v = Vehicle::Get(std::get<VehicleID>(this->ni->ref1));
ShowVehicleViewWindow(v);
}
break;
case WID_N_VIEWPORT:
break; // Ignore clicks
case WID_N_SHOW_GROUP:
if (std::holds_alternative<VehicleID>(ni->ref1)) {
const Vehicle *v = Vehicle::Get(std::get<VehicleID>(this->ni->ref1));
ShowCompanyGroupForVehicle(v);
}
break;
default:
if (std::holds_alternative<VehicleID>(ni->ref1)) {
const Vehicle *v = Vehicle::Get(std::get<VehicleID>(this->ni->ref1));
ScrollMainWindowTo(v->x_pos, v->y_pos, v->z_pos);
} else {
TileIndex tile1 = GetReferenceTile(this->ni->ref1);
TileIndex tile2 = GetReferenceTile(this->ni->ref2);
if (_ctrl_pressed) {
if (tile1 != INVALID_TILE) ShowExtraViewportWindow(tile1);
if (tile2 != INVALID_TILE) ShowExtraViewportWindow(tile2);
} else {
if ((tile1 == INVALID_TILE || !ScrollMainWindowToTile(tile1)) && tile2 != INVALID_TILE) {
ScrollMainWindowToTile(tile2);
}
}
}
break;
}
}
void OnResize() override
{
if (this->viewport != nullptr) {
NWidgetViewport *nvp = this->GetWidget<NWidgetViewport>(WID_N_VIEWPORT);
nvp->UpdateViewportCoordinates(this);
if (!std::holds_alternative<VehicleID>(ni->ref1)) {
ScrollWindowToTile(GetReferenceTile(ni->ref1), this, true); // Re-center viewport.
}
}
NWidgetResizeBase *wid = this->GetWidget<NWidgetResizeBase>(WID_N_MGR_NAME);
if (wid != nullptr) {
int y = GetStringHeight(GetString(STR_JUST_RAW_STRING, static_cast<const CompanyNewsInformation *>(this->ni->data.get())->president_name), wid->current_x);
if (wid->UpdateVerticalSize(y)) this->ReInit(0, 0);
}
}
/**
* Some data on this window has become invalid.
* @param data Information about the changed data.
* @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
*/
void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
{
if (!gui_scope) return;
/* The chatbar has notified us that is was either created or closed */
int newtop = this->top + this->chat_height - data;
this->chat_height = data;
this->SetWindowTop(newtop);
}
void OnRealtimeTick([[maybe_unused]] uint delta_ms) override
{
/* Decrement the news timer. We don't need to action an elapsed event here,
* so no need to use TimerElapsed(). */
if (NewsWindow::duration > 0) NewsWindow::duration -= delta_ms;
}
/**
* Scroll the news message slowly up from the bottom.
*
* The interval of 210ms is chosen to maintain 15ms at normal zoom: 210 / GetCharacterHeight(FS_NORMAL) = 15ms.
*/
const IntervalTimer<TimerWindow> scroll_interval = {std::chrono::milliseconds(210) / GetCharacterHeight(FS_NORMAL), [this](uint count) {
int newtop = std::max(this->top - 2 * static_cast<int>(count), _screen.height - this->height - this->status_height - this->chat_height);
this->SetWindowTop(newtop);
}};
private:
/**
* Moves the window to a new #top coordinate. Makes screen dirty where needed.
* @param newtop new top coordinate
*/
void SetWindowTop(int newtop)
{
if (this->top == newtop) return;
int mintop = std::min(newtop, this->top);
int maxtop = std::max(newtop, this->top);
if (this->viewport != nullptr) this->viewport->top += newtop - this->top;
this->top = newtop;
AddDirtyBlock(this->left, mintop, this->left + this->width, maxtop + this->height);
}
std::string GetNewVehicleMessageString(WidgetID widget) const
{
assert(std::holds_alternative<EngineID>(ni->ref1));
EngineID engine = std::get<EngineID>(this->ni->ref1);
switch (widget) {
case WID_N_VEH_TITLE:
return GetString(STR_NEWS_NEW_VEHICLE_NOW_AVAILABLE, GetEngineCategoryName(engine));
case WID_N_VEH_NAME:
return GetString(STR_NEWS_NEW_VEHICLE_TYPE, PackEngineNameDParam(engine, EngineNameContext::PreviewNews));
default:
NOT_REACHED();
}
}
};
/* static */ int NewsWindow::duration = 0; // Instance creation.
/** Open up an own newspaper window for the news item */
static void ShowNewspaper(const NewsItem *ni)
{
SoundFx sound = _news_type_data[to_underlying(ni->type)].sound;
if (sound != 0 && _settings_client.sound.news_full) SndPlayFx(sound);
new NewsWindow(GetNewsWindowLayout(ni->style), ni);
}
/** Show news item in the ticker */
static void ShowTicker(NewsIterator ni)
{
if (_settings_client.sound.news_ticker) SndPlayFx(SND_16_NEWS_TICKER);
_statusbar_news = ni;
InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_TICKER);
}
/** Initialize the news-items data structures */
void InitNewsItemStructs()
{
_news.clear();
_forced_news = std::end(_news);
_current_news = std::end(_news);
_statusbar_news = std::end(_news);
NewsWindow::duration = 0;
}
/**
* Are we ready to show another ticker item?
* Only if nothing is in the newsticker is displayed
*/
static bool ReadyForNextTickerItem()
{
const NewsItem *ni = GetStatusbarNews();
if (ni == nullptr) return true;
/* Ticker message
* Check if the status bar message is still being displayed? */
return !IsNewsTickerShown();
}
/**
* Are we ready to show another news item?
* Only if no newspaper is displayed
*/
static bool ReadyForNextNewsItem()
{
if (_forced_news == std::end(_news) && _current_news == std::end(_news)) return true;
/* neither newsticker nor newspaper are running */
return (NewsWindow::duration <= 0 || FindWindowById(WC_NEWS_WINDOW, 0) == nullptr);
}
/** Move to the next ticker item */
static void MoveToNextTickerItem()
{
/* There is no status bar, so no reason to show news;
* especially important with the end game screen when
* there is no status bar but possible news. */
if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
/* No news to move to. */
if (std::empty(_news)) return;
/* if we're not at the latest item, then move on */
while (_statusbar_news != std::begin(_news)) {
--_statusbar_news;
const NewsType type = _statusbar_news->type;
/* check the date, don't show too old items */
if (TimerGameEconomy::date - _news_type_data[to_underlying(type)].age > _statusbar_news->economy_date) continue;
switch (_news_type_data[to_underlying(type)].GetDisplay()) {
default: NOT_REACHED();
case NewsDisplay::Off: // Show nothing only a small reminder in the status bar.
InvalidateWindowData(WC_STATUS_BAR, 0, SBI_SHOW_REMINDER);
return;
case NewsDisplay::Summary: // Show ticker.
ShowTicker(_statusbar_news);
return;
case NewsDisplay::Full: // Show newspaper, skipped here.
break;;
}
}
}
/** Move to the next news item */
static void MoveToNextNewsItem()
{
/* There is no status bar, so no reason to show news;
* especially important with the end game screen when
* there is no status bar but possible news. */
if (FindWindowById(WC_STATUS_BAR, 0) == nullptr) return;
CloseWindowById(WC_NEWS_WINDOW, 0); // close the newspapers window if shown
_forced_news = std::end(_news);
/* No news to move to. */
if (std::empty(_news)) return;
/* if we're not at the latest item, then move on */
while (_current_news != std::begin(_news)) {
--_current_news;
const NewsType type = _current_news->type;
/* check the date, don't show too old items */
if (TimerGameEconomy::date - _news_type_data[to_underlying(type)].age > _current_news->economy_date) continue;
switch (_news_type_data[to_underlying(type)].GetDisplay()) {
default: NOT_REACHED();
case NewsDisplay::Off: // Show nothing only a small reminder in the status bar, skipped here.
break;
case NewsDisplay::Summary: // Show ticker, skipped here.
break;
case NewsDisplay::Full: // Sshow newspaper.
ShowNewspaper(&*_current_news);
return;
}
}
}
/** Delete a news item from the queue */
static std::list<NewsItem>::iterator DeleteNewsItem(std::list<NewsItem>::iterator ni)
{
bool update_current_news = (_forced_news == ni || _current_news == ni);
bool update_statusbar_news = (_statusbar_news == ni);
if (update_current_news) {
/* When we're the current news, go to the next older item first;
* we just possibly made that the last news item. */
if (_current_news == ni) ++_current_news;
if (_forced_news == ni) _forced_news = std::end(_news);
}
if (update_statusbar_news) {
/* When we're the current news, go to the next older item first;
* we just possibly made that the last news item. */
++_statusbar_news;
}
/* Delete the news from the news queue. */
ni = _news.erase(ni);
if (update_current_news) {
/* About to remove the currently forced item (shown as newspapers) ||
* about to remove the currently displayed item (newspapers) */
MoveToNextNewsItem();
}
if (update_statusbar_news) {
/* About to remove the currently displayed item (ticker, or just a reminder) */
InvalidateWindowData(WC_STATUS_BAR, 0, SBI_NEWS_DELETED); // invalidate the statusbar
MoveToNextTickerItem();
}
return ni;
}
/**
* Create a new newsitem to be shown.
* @param string_id String to display.
* @param type The type of news.
* @param flags Flags related to how to display the news.
* @param ref1 Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news, and for deleting the news when the object is deleted.
* @param ref2 Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news when the object is deleted.
* @param data Pointer to data that must be released once the news message is cleared.
* @param advice_type Sub-type in case the news type is #NewsType::Advice.
*
* @see NewsSubtype
*/
NewsItem::NewsItem(EncodedString &&headline, NewsType type, NewsStyle style, NewsFlags flags, NewsReference ref1, NewsReference ref2, std::unique_ptr<NewsAllocatedData> &&data, AdviceType advice_type) :
headline(std::move(headline)), date(TimerGameCalendar::date), economy_date(TimerGameEconomy::date), type(type), advice_type(advice_type), style(style), flags(flags), ref1(ref1), ref2(ref2), data(std::move(data))
{
/* show this news message in colour? */
if (TimerGameCalendar::year >= _settings_client.gui.coloured_news_year) this->flags.Set(NewsFlag::InColour);
}
std::string NewsItem::GetStatusText() const
{
if (this->data != nullptr) {
/* CompanyNewsInformation is the only type of additional data used. */
const CompanyNewsInformation &cni = *static_cast<const CompanyNewsInformation*>(this->data.get());
return GetString(STR_MESSAGE_NEWS_FORMAT, cni.title, this->headline.GetDecodedString());
}
return this->headline.GetDecodedString();
}
/**
* Add a new newsitem to be shown.
* @param string String to display
* @param type news category
* @param flags display flags for the news
* @param ref1 Reference 1 to some object: Used for a possible viewport, scrolling after clicking on the news, and for deleting the news when the object is deleted.
* @param ref2 Reference 2 to some object: Used for scrolling after clicking on the news, and for deleting the news when the object is deleted.
* @param data Pointer to data that must be released once the news message is cleared.
* @param advice_type Sub-type in case the news type is #NewsType::Advice.
*
* @see NewsSubtype
*/
void AddNewsItem(EncodedString &&headline, NewsType type, NewsStyle style, NewsFlags flags, NewsReference ref1, NewsReference ref2, std::unique_ptr<NewsAllocatedData> &&data, AdviceType advice_type)
{
if (_game_mode == GM_MENU) return;
/* Create new news item node */
_news.emplace_front(std::move(headline), type, style, flags, ref1, ref2, std::move(data), advice_type);
/* Keep the number of stored news items to a manageable number */
if (std::size(_news) > MAX_NEWS_AMOUNT) {
DeleteNewsItem(std::prev(std::end(_news)));
}
InvalidateWindowData(WC_MESSAGE_HISTORY, 0);
}
/**
* Encode a NewsReference for serialisation, e.g. for writing in the crash log.
* @param reference The reference to serialise.
* @return Reference serialised into a single uint32_t.
*/
uint32_t SerialiseNewsReference(const NewsReference &reference)
{
struct visitor {
uint32_t operator()(const std::monostate &) { return 0; }
uint32_t operator()(const TileIndex &t) { return t.base(); }
uint32_t operator()(const VehicleID v) { return v.base(); }
uint32_t operator()(const StationID s) { return s.base(); }
uint32_t operator()(const IndustryID i) { return i.base(); }
uint32_t operator()(const TownID t) { return t.base(); }
uint32_t operator()(const EngineID e) { return e.base(); }
};
return std::visit(visitor{}, reference);
}
/**
* Create a new custom news item.
* @param flags type of operation
* @aram type NewsType of the message.
* @param reftype1 NewsReferenceType of first reference.
* @param company Company this news message is for.
* @param reference_id First reference of the news message.
* @param text The text of the news message.
* @return the cost of this operation or an error
*/
CommandCost CmdCustomNewsItem(DoCommandFlags flags, NewsType type, CompanyID company, NewsReference reference, const EncodedString &text)
{
if (_current_company != OWNER_DEITY) return CMD_ERROR;
if (company != INVALID_OWNER && !Company::IsValidID(company)) return CMD_ERROR;
if (type >= NewsType::End) return CMD_ERROR;
if (text.empty()) return CMD_ERROR;
struct visitor {
bool operator()(const std::monostate &) { return true; }
bool operator()(const TileIndex t) { return IsValidTile(t); }
bool operator()(const VehicleID v) { return Vehicle::IsValidID(v); }
bool operator()(const StationID s) { return Station::IsValidID(s); }
bool operator()(const IndustryID i) { return Industry::IsValidID(i); }
bool operator()(const TownID t) { return Town::IsValidID(t); }
bool operator()(const EngineID e) { return Engine::IsValidID(e); }
};
if (!std::visit(visitor{}, reference)) return CMD_ERROR;
if (company != INVALID_OWNER && company != _local_company) return CommandCost();
if (flags.Test(DoCommandFlag::Execute)) {
AddNewsItem(EncodedString{text}, type, NewsStyle::Normal, {}, reference, {});
}
return CommandCost();
}
/**
* Delete news items by predicate, and invalidate the message history if necessary.
* @tparam Tmin Stop if the number of news items remaining reaches \a min items.
* @tparam Tpredicate Condition for a news item to be deleted.
*/
template <size_t Tmin = 0, class Tpredicate>
void DeleteNews(Tpredicate predicate)
{
bool dirty = false;
for (auto it = std::rbegin(_news); it != std::rend(_news); /* nothing */) {
if constexpr (Tmin > 0) {
if (std::size(_news) <= Tmin) break;
}
if (predicate(*it)) {
it = std::make_reverse_iterator(DeleteNewsItem(std::prev(it.base())));
dirty = true;
} else {
++it;
}
}
if (dirty) InvalidateWindowData(WC_MESSAGE_HISTORY, 0);
}
template <typename T>
static bool IsReferenceObject(const NewsReference &reference, T id)
{
return std::holds_alternative<T>(reference) && std::get<T>(reference) == id;
}
template <typename T>
static bool HasReferenceObject(const NewsItem &ni, T id)
{
return IsReferenceObject(ni.ref1, id) || IsReferenceObject(ni.ref2, id);
}
/**
* Delete news with a given advice type about a vehicle.
* When the advice_type is #AdviceType::Invalid all news about the vehicle gets deleted.
* @param vid The vehicle to remove the news for.
* @param advice_type The advice type to remove for.
*/
void DeleteVehicleNews(VehicleID vid, AdviceType advice_type)
{
DeleteNews([&](const auto &ni) {
return HasReferenceObject(ni, vid) && (advice_type == AdviceType::Invalid || ni.advice_type == advice_type);
});
}
/**
* Remove news regarding given station so there are no 'unknown station now accepts Mail'
* or 'First train arrived at unknown station' news items.
* @param sid station to remove news about
*/
void DeleteStationNews(StationID sid)
{
DeleteNews([&](const auto &ni) {
return HasReferenceObject(ni, sid);
});
}
/**
* Remove news regarding given industry
* @param iid industry to remove news about
*/
void DeleteIndustryNews(IndustryID iid)
{
DeleteNews([&](const auto &ni) {
return HasReferenceObject(ni, iid);
});
}
bool IsInvalidEngineNews(const NewsReference &reference)
{
if (!std::holds_alternative<EngineID>(reference)) return false;
EngineID eid = std::get<EngineID>(reference);
return !Engine::IsValidID(eid) || !Engine::Get(eid)->IsEnabled();
}
/**
* Remove engine announcements for invalid engines.
*/
void DeleteInvalidEngineNews()
{
DeleteNews([](const auto &ni) {
return IsInvalidEngineNews(ni.ref1) || IsInvalidEngineNews(ni.ref2);
});
}
static void RemoveOldNewsItems()
{
DeleteNews<MIN_NEWS_AMOUNT>([](const auto &ni) {
return TimerGameEconomy::date - _news_type_data[to_underlying(ni.type)].age * _settings_client.gui.news_message_timeout > ni.economy_date;
});
}
template <typename T>
static void ChangeObject(NewsReference reference, T from, T to)
{
if (!std::holds_alternative<T>(reference)) return;
if (std::get<T>(reference) == from) reference = to;
}
/**
* Report a change in vehicle IDs (due to autoreplace) to affected vehicle news.
* @note Viewports of currently displayed news is changed via #ChangeVehicleViewports
* @param from_index the old vehicle ID
* @param to_index the new vehicle ID
*/
void ChangeVehicleNews(VehicleID from_index, VehicleID to_index)
{
for (auto &ni : _news) {
ChangeObject(ni.ref1, from_index, to_index);
ChangeObject(ni.ref2, from_index, to_index);
if (ni.flags.Test(NewsFlag::VehicleParam0) && IsReferenceObject(ni.ref1, to_index)) ni.headline = ni.headline.ReplaceParam(0, to_index.base());
}
}
void NewsLoop()
{
/* no news item yet */
if (std::empty(_news)) return;
static TimerGameEconomy::Month _last_clean_month = 0;
if (_last_clean_month != TimerGameEconomy::month) {
RemoveOldNewsItems();
_last_clean_month = TimerGameEconomy::month;
}
if (ReadyForNextTickerItem()) MoveToNextTickerItem();
if (ReadyForNextNewsItem()) MoveToNextNewsItem();
}
/** Do a forced show of a specific message */
static void ShowNewsMessage(NewsIterator ni)
{
assert(!std::empty(_news));
/* Delete the news window */
CloseWindowById(WC_NEWS_WINDOW, 0);
/* setup forced news item */
_forced_news = ni;
if (_forced_news != std::end(_news)) {
CloseWindowById(WC_NEWS_WINDOW, 0);
ShowNewspaper(&*ni);
}
}
/**
* Close active news message window
* @return true if a window was closed.
*/
bool HideActiveNewsMessage()
{
NewsWindow *w = dynamic_cast<NewsWindow *>(FindWindowById(WC_NEWS_WINDOW, 0));
if (w == nullptr) return false;
w->Close();
return true;
}
/** Show previous news item */
void ShowLastNewsMessage()
{
if (std::empty(_news)) return;
NewsIterator ni;
if (_forced_news == std::end(_news)) {
/* Not forced any news yet, show the current one, unless a news window is
* open (which can only be the current one), then show the previous item */
if (_current_news == std::end(_news)) {
/* No news were shown yet resp. the last shown one was already deleted.
* Treat this as if _forced_news reached the oldest news; so, wrap around and start anew with the latest. */
ni = std::begin(_news);
} else {
const Window *w = FindWindowById(WC_NEWS_WINDOW, 0);
ni = (w == nullptr || (std::next(_current_news) == std::end(_news))) ? _current_news : std::next(_current_news);
}
} else if (std::next(_forced_news) == std::end(_news)) {
/* We have reached the oldest news, start anew with the latest */
ni = std::begin(_news);
} else {
/* 'Scrolling' through news history show each one in turn */
ni = std::next(_forced_news);
}
bool wrap = false;
for (;;) {
if (_news_type_data[to_underlying(ni->type)].GetDisplay() != NewsDisplay::Off) {
ShowNewsMessage(ni);
break;
}
++ni;
if (ni == std::end(_news)) {
if (wrap) break;
/* We have reached the oldest news, start anew with the latest */
ni = std::begin(_news);
wrap = true;
}
}
}
/**
* Draw an unformatted news message truncated to a maximum length. If
* length exceeds maximum length it will be postfixed by '...'
* @param left the left most location for the string
* @param right the right most location for the string
* @param y position of the string
* @param colour the colour the string will be shown in
* @param *ni NewsItem being printed
*/
static void DrawNewsString(uint left, uint right, int y, TextColour colour, const NewsItem &ni)
{
/* Get the string, replaces newlines with spaces and remove control codes from the string. */
std::string message = StrMakeValid(ni.GetStatusText(), StringValidationSetting::ReplaceTabCrNlWithSpace);
/* Truncate and show string; postfixed by '...' if necessary */
DrawString(left, right, y, message, colour);
}
struct MessageHistoryWindow : Window {
int line_height = 0; /// < Height of a single line in the news history window including spacing.
int date_width = 0; /// < Width needed for the date part.
Scrollbar *vscroll = nullptr;
MessageHistoryWindow(WindowDesc &desc) : Window(desc)
{
this->CreateNestedTree();
this->vscroll = this->GetScrollbar(WID_MH_SCROLLBAR);
this->FinishInitNested(); // Initializes 'this->line_height' and 'this->date_width'.
this->OnInvalidateData(0);
}
void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
{
if (widget == WID_MH_BACKGROUND) {
this->line_height = GetCharacterHeight(FS_NORMAL) + WidgetDimensions::scaled.vsep_normal;
fill.height = resize.height = this->line_height;
/* Months are off-by-one, so it's actually 8. Not using
* month 12 because the 1 is usually less wide. */
this->date_width = GetStringBoundingBox(GetString(STR_JUST_DATE_TINY, TimerGameCalendar::ConvertYMDToDate(CalendarTime::ORIGINAL_MAX_YEAR, 7, 30))).width + WidgetDimensions::scaled.hsep_wide;
size.height = 4 * resize.height + WidgetDimensions::scaled.framerect.Vertical(); // At least 4 lines are visible.
size.width = std::max(200u, size.width); // At least 200 pixels wide.
}
}
void DrawWidget(const Rect &r, WidgetID widget) const override
{
if (widget != WID_MH_BACKGROUND || std::empty(_news)) return;
/* Fill the widget with news items. */
bool rtl = _current_text_dir == TD_RTL;
Rect news = r.Shrink(WidgetDimensions::scaled.framerect).Indent(this->date_width + WidgetDimensions::scaled.hsep_wide, rtl);
Rect date = r.Shrink(WidgetDimensions::scaled.framerect).WithWidth(this->date_width, rtl);
int y = news.top;
auto [first, last] = this->vscroll->GetVisibleRangeIterators(_news);
for (auto ni = first; ni != last; ++ni) {
DrawString(date.left, date.right, y, GetString(STR_JUST_DATE_TINY, ni->date), TC_WHITE);
DrawNewsString(news.left, news.right, y, TC_WHITE, *ni);
y += this->line_height;
}
}
/**
* Some data on this window has become invalid.
* @param data Information about the changed data.
* @param gui_scope Whether the call is done from GUI scope. You may not do everything when not in GUI scope. See #InvalidateWindowData() for details.
*/
void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
{
if (!gui_scope) return;
this->vscroll->SetCount(std::size(_news));
}
void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
{
if (widget == WID_MH_BACKGROUND) {
/* Scheduled window invalidations currently occur after the input loop, which means the scrollbar count
* could be invalid, so ensure it's correct now. Potentially this means that item clicked on might be
* different as well. */
this->vscroll->SetCount(std::size(_news));
auto ni = this->vscroll->GetScrolledItemFromWidget(_news, pt.y, this, widget, WidgetDimensions::scaled.framerect.top);
if (ni == std::end(_news)) return;
ShowNewsMessage(ni);
}
}
void OnResize() override
{
this->vscroll->SetCapacityFromWidget(this, WID_MH_BACKGROUND, WidgetDimensions::scaled.framerect.Vertical());
}
};
static constexpr NWidgetPart _nested_message_history[] = {
NWidget(NWID_HORIZONTAL),
NWidget(WWT_CLOSEBOX, COLOUR_BROWN),
NWidget(WWT_CAPTION, COLOUR_BROWN), SetStringTip(STR_MESSAGE_HISTORY, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
NWidget(WWT_SHADEBOX, COLOUR_BROWN),
NWidget(WWT_DEFSIZEBOX, COLOUR_BROWN),
NWidget(WWT_STICKYBOX, COLOUR_BROWN),
EndContainer(),
NWidget(NWID_HORIZONTAL),
NWidget(WWT_PANEL, COLOUR_BROWN, WID_MH_BACKGROUND), SetMinimalSize(200, 125), SetToolTip(STR_MESSAGE_HISTORY_TOOLTIP), SetResize(1, 12), SetScrollbar(WID_MH_SCROLLBAR),
EndContainer(),
NWidget(NWID_VERTICAL),
NWidget(NWID_VSCROLLBAR, COLOUR_BROWN, WID_MH_SCROLLBAR),
NWidget(WWT_RESIZEBOX, COLOUR_BROWN),
EndContainer(),
EndContainer(),
};
static WindowDesc _message_history_desc(
WDP_AUTO, "list_news", 400, 140,
WC_MESSAGE_HISTORY, WC_NONE,
{},
_nested_message_history
);
/** Display window with news messages history */
void ShowMessageHistory()
{
CloseWindowById(WC_MESSAGE_HISTORY, 0);
new MessageHistoryWindow(_message_history_desc);
}