OpenTTD Source
20240917-master-g9ab0a47812
|
Go to the documentation of this file.
48 if (_game_mode == GM_MENU)
return;
52 if (!c->error.has_value() || (c->error->severity != STR_NEWGRF_ERROR_MSG_FATAL && c->error->severity != STR_NEWGRF_ERROR_MSG_ERROR))
continue;
55 SetDParam (1, c->error->message != STR_NULL ? c->error->message : STR_JUST_RAW_STRING);
59 for (uint i = 0; i < c->error->param_value.size(); i++) {
60 SetDParam(5 + i, c->error->param_value[i]);
62 if (c->error->severity == STR_NEWGRF_ERROR_MSG_FATAL) {
71 static void ShowNewGRFInfo(
const GRFConfig *c,
const Rect &r,
bool show_params)
74 if (c->
error.has_value()) {
78 for (uint i = 0; i < c->
error->param_value.size(); i++) {
115 SetDParam(0, STR_NEWGRF_SETTINGS_PARAMETER_NONE);
170 this->GetWidget<NWidgetCore>(
WID_NP_CAPTION)->SetDataTip(is_baseset ? STR_BASEGRF_PARAMETERS_CAPTION : STR_NEWGRF_PARAMETERS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS);
199 return nr < this->grf_config->
param_info.size() && this->grf_config->
param_info[nr].has_value();
226 d.width += padding.width;
227 d.height += padding.height;
243 for (
const auto &par_info : this->grf_config->
param_info) {
244 if (!par_info.has_value())
continue;
246 if (desc ==
nullptr)
continue;
249 suggestion =
maxdim(d, suggestion);
251 size.height = suggestion.height;
256 void SetStringParameters(
WidgetID widget)
const override
265 void DrawWidget(
const Rect &r,
WidgetID widget)
const override
271 if (desc ==
nullptr)
return;
287 uint32_t current_value = par_info.
GetValue(this->grf_config);
291 DrawBoolButton(buttons_left, ir.top + button_y_offset, current_value != 0, this->editable);
292 SetDParam(2, par_info.
GetValue(this->grf_config) == 0 ? STR_CONFIG_SETTING_OFF : STR_CONFIG_SETTING_ON);
295 DrawDropDownButton(buttons_left, ir.top + button_y_offset, COLOUR_YELLOW, this->clicked_row == i && this->clicked_dropdown, this->editable);
297 DrawArrowButtons(buttons_left, ir.top + button_y_offset, COLOUR_YELLOW, (this->clicked_button == i) ? 1 + (this->clicked_increase != rtl) : 0, this->editable && current_value > par_info.
min_value, this->editable && current_value < par_info.
max_value);
301 auto it = par_info.
value_names.find(current_value);
304 if (label !=
nullptr) {
312 if (name !=
nullptr) {
316 SetDParam(0, STR_NEWGRF_PARAMETERS_DEFAULT_NAME);
320 DrawString(tr.left, tr.right, ir.top + text_y_offset, STR_NEWGRF_PARAMETERS_SETTING, selected ? TC_WHITE : TC_LIGHT_BLUE);
327 if (this->closing_dropdown) {
328 this->closing_dropdown =
false;
329 this->clicked_dropdown =
false;
334 void OnClick([[maybe_unused]]
Point pt,
WidgetID widget, [[maybe_unused]]
int click_count)
override
338 if (this->editable && !this->action14present && this->grf_config->
num_params > 0) {
356 if (!this->editable)
break;
358 if (num >= this->vscroll->
GetCount())
break;
360 if (this->clicked_row != num) {
363 this->clicked_row = num;
364 this->clicked_dropdown =
false;
368 int x = pt.x - r.left;
374 uint32_t old_val = par_info.
GetValue(this->grf_config);
376 if (this->clicked_dropdown) {
379 this->clicked_dropdown =
false;
380 this->closing_dropdown =
false;
382 int rel_y = (pt.y - r.top) % this->line_height;
391 if (pt.y >= wi_rect.top && pt.y <= wi_rect.bottom) {
392 this->clicked_dropdown =
true;
393 this->closing_dropdown =
false;
404 uint32_t val = old_val;
411 this->clicked_increase =
true;
415 this->clicked_increase =
false;
418 if (val != old_val) {
419 par_info.
SetValue(this->grf_config, val);
421 this->clicked_button = num;
434 if (!this->editable)
break;
446 void OnQueryTextFinished(std::optional<std::string> str)
override
448 if (!str.has_value() || str->empty())
return;
449 int32_t value = atoi(str->c_str());
452 par_info.
SetValue(this->grf_config, val);
456 void OnDropdownSelect(
WidgetID widget,
int index)
override
459 assert(this->clicked_dropdown);
461 par_info.
SetValue(this->grf_config, index);
472 assert(this->clicked_dropdown);
473 this->closing_dropdown =
true;
487 void OnInvalidateData([[maybe_unused]]
int data = 0, [[maybe_unused]]
bool gui_scope =
true)
override
489 if (!gui_scope)
return;
490 if (!this->action14present) {
496 if (this->clicked_row != INT32_MAX && this->clicked_row >= this->vscroll->
GetCount()) {
497 this->clicked_row = INT32_MAX;
504 this->clicked_button = INT32_MAX;
511 static constexpr
NWidgetPart _nested_newgrf_parameter_widgets[] = {
522 NWidget(
WWT_TEXT, COLOUR_MAUVE,
WID_NP_NUMPAR),
SetResize(1, 0),
SetFill(1, 0),
SetPadding(0, 0, 0, 4),
SetDataTip(STR_NEWGRF_PARAMETERS_NUM_PARAM, STR_NULL),
527 NWidget(
WWT_MATRIX, COLOUR_MAUVE,
WID_NP_BACKGROUND),
SetMinimalSize(188, 182),
SetResize(1, 1),
SetFill(1, 0),
SetMatrixDataTip(1, 0, STR_NULL),
SetScrollbar(
WID_NP_SCROLLBAR),
545 WDP_CENTER,
"settings_newgrf_config", 500, 208,
548 _nested_newgrf_parameter_widgets
551 void OpenGRFParameterWindow(
bool is_baseset,
GRFConfig *c,
bool editable)
563 this->ConstructWindow();
569 void SetStringParameters(
WidgetID widget)
const override
584 typedef std::map<uint32_t, const GRFConfig *>
GrfIdMap;
593 while (c !=
nullptr) {
608 static const uint EDITBOX_MAX_SIZE = 50;
612 static const std::initializer_list<GUIGRFConfigList::SortFunction * const>
sorter_funcs;
613 static const std::initializer_list<GUIGRFConfigList::FilterFunction * const>
filter_funcs;
639 this->avail_sel =
nullptr;
640 this->avail_pos = -1;
641 this->active_sel =
nullptr;
642 this->actives =
nullptr;
648 this->active_over = -1;
657 this->GetWidget<NWidgetStacked>(
WID_NS_SHOW_REMOVE)->SetDisplayedPlane(this->editable ? 0 : 1);
678 void Close([[maybe_unused]]
int data = 0)
override
684 if (this->editable && this->modified && !this->execute && !_exit_game) {
709 GrfIdMap::const_iterator iter = grfid_map.find(a->ident.grfid);
710 if (iter != grfid_map.end() && a->version > iter->second->version)
return true;
722 GrfIdMap::iterator iter = grfid_map.find(a->ident.grfid);
723 if (iter == grfid_map.end() || iter->second->version >= a->version)
continue;
726 while (*c != iter->second) c = &(*c)->
next;
734 if (this->active_sel == *c) {
737 this->active_sel =
nullptr;
752 size.height = std::max(size.height, padding.height + 6 *
resize.height);
760 size.height = std::max(size.height, padding.height + 8 *
resize.height);
777 for (
const auto &i : this->grf_presets) {
781 d.width += padding.width;
790 size.width += padding.width;
791 size.height += padding.height;
803 void SetStringParameters(
WidgetID widget)
const override
807 if (this->preset == -1) {
830 pal = PALETTE_TO_RED;
833 pal = PALETTE_TO_GREEN;
836 pal = PALETTE_TO_BLUE;
841 if (pal != PALETTE_TO_RED) {
843 pal = PALETTE_TO_GREY;
845 pal = PALETTE_TO_ORANGE;
852 void DrawWidget(
const Rect &r,
WidgetID widget)
const override
860 uint step_height = this->GetWidget<NWidgetBase>(
WID_NS_FILE_LIST)->resize_y;
863 int square_offset_y = (step_height - square.height) / 2;
864 int warning_offset_y = (step_height - warning.height) / 2;
868 uint text_left = rtl ? tr.left : tr.left + square.width + 13;
869 uint text_right = rtl ? tr.right - square.width - 13 : tr.right;
870 uint square_left = rtl ? tr.right - square.width - 3 : tr.left + 3;
871 uint warning_left = rtl ? tr.right - square.width - warning.width - 8 : tr.left + square.width + 8;
874 for (
const GRFConfig *c = this->actives; c !=
nullptr; c = c->
next, i++) {
876 const char *text = c->
GetName();
877 bool h = (this->active_sel == c);
882 }
else if (i == this->active_over) {
884 int active_sel_pos = 0;
886 if (active_sel_pos != this->active_over) {
887 uint
top = this->active_over < active_sel_pos ? tr.top + 1 : tr.top + step_height - 2;
891 DrawSprite(SPR_SQUARE, pal, square_left, tr.top + square_offset_y);
892 if (c->
error.has_value())
DrawSprite(SPR_WARNING_SIGN, 0, warning_left, tr.top + warning_offset_y);
893 uint txtoffset = !c->
error.has_value() ? 0 : warning.width;
894 DrawString(text_left + (rtl ? 0 : txtoffset), text_right - (rtl ? txtoffset : 0), tr.top + offset_y, text, h ? TC_WHITE : TC_ORANGE);
895 tr.top += step_height;
898 if (i == this->active_over && this->vscroll->
IsVisible(i)) {
913 for (
auto it = first; it != last; ++it) {
916 const char *text = c->
GetName();
919 DrawString(tr.left, tr.right, tr.top + offset_y, text, h ? TC_WHITE : TC_SILVER);
920 tr.top += step_height;
934 if (selected ==
nullptr) selected = this->
avail_sel;
935 if (selected !=
nullptr) {
936 ShowNewGRFInfo(selected, r, this->show_params);
943 void OnClick([[maybe_unused]]
Point pt,
WidgetID widget, [[maybe_unused]]
int click_count)
override
946 if (this->active_sel ==
nullptr && this->avail_sel ==
nullptr)
return;
957 list.push_back(MakeDropDownListStringItem(STR_NONE, -1));
959 for (uint i = 0; i < this->grf_presets.size(); i++) {
960 list.push_back(MakeDropDownListStringItem(this->grf_presets[i], i));
969 const GRFConfig *c = (this->avail_sel ==
nullptr) ? this->active_sel : this->avail_sel;
980 if (this->preset == -1)
return;
990 if (this->active_sel ==
nullptr || !this->editable)
break;
993 for (
GRFConfig **pc = &this->actives; *pc !=
nullptr; pc = &(*pc)->
next, pos++) {
995 if (c->
next == this->active_sel) {
997 this->active_sel->
next = c;
1009 if (this->active_sel ==
nullptr || !this->editable)
break;
1012 for (
GRFConfig **pc = &this->actives; *pc !=
nullptr; pc = &(*pc)->
next, pos++) {
1014 if (c == this->active_sel) {
1033 for (c = this->actives; c !=
nullptr && i > 0; c = c->
next, i--) {}
1035 if (this->active_sel != c) {
1039 this->active_sel = c;
1040 this->avail_sel =
nullptr;
1041 this->avail_pos = -1;
1044 if (click_count == 1) {
1053 if (this->active_sel ==
nullptr || !this->editable)
break;
1059 for (
GRFConfig **pc = &this->actives; *pc !=
nullptr; pc = &(*pc)->
next) {
1063 if (newsel ==
nullptr && c->
next == this->active_sel) newsel = c;
1065 if (c == this->active_sel) {
1066 if (newsel == c) newsel =
nullptr;
1074 this->active_sel = newsel;
1076 this->avail_pos = -1;
1077 this->avail_sel =
nullptr;
1084 if (!this->editable || this->actives ==
nullptr)
break;
1094 this->active_sel =
nullptr;
1096 if (it != this->avails.end()) {
1098 this->avail_sel = *it;
1099 this->avail_pos = it - this->avails.begin();
1102 if (click_count == 1) {
1117 if (!this->editable)
break;
1118 if (this->execute) {
1120 STR_NEWGRF_POPUP_CAUTION_CAPTION,
1121 STR_NEWGRF_CONFIRMATION_TEXT,
1136 if (this->active_sel ==
nullptr || !this->show_params || this->active_sel->
num_valid_params == 0)
break;
1138 OpenGRFParameterWindow(
false, this->active_sel, this->editable);
1144 if (this->active_sel !=
nullptr && this->editable) {
1172 this->avail_sel =
nullptr;
1173 this->avail_pos = -1;
1178 void OnDropdownSelect(
WidgetID widget,
int index)
override
1181 if (!this->editable)
return;
1184 this->preset = index;
1194 this->active_sel =
nullptr;
1198 void OnQueryTextFinished(std::optional<std::string> str)
override
1200 if (!str.has_value())
return;
1206 for (uint i = 0; i < this->grf_presets.size(); i++) {
1207 if (this->grf_presets[i] == str) {
1223 for (
const GRFConfig *c = this->actives; c !=
nullptr; c = c->
next, i++) {}
1227 if (this->avail_pos >= 0) this->vscroll2->
ScrollTowards(this->avail_pos);
1235 void OnInvalidateData([[maybe_unused]]
int data = 0, [[maybe_unused]]
bool gui_scope =
true)
override
1237 if (!gui_scope)
return;
1245 for (
GRFConfig **l = &this->actives; *l !=
nullptr; l = &(*l)->
next) {
1254 (*l)->next = c->
next;
1256 if (this->active_sel == c) this->active_sel = *l;
1265 this->modified =
false;
1277 this->modified =
true;
1283 this->modified =
false;
1287 this->BuildAvailables();
1297 bool disable_all = this->active_sel ==
nullptr || !this->
editable;
1304 const GRFConfig *selected_config = (this->avail_sel ==
nullptr) ? this->active_sel : this->avail_sel;
1305 for (
TextfileType tft = TFT_CONTENT_BEGIN; tft < TFT_CONTENT_END; tft++) {
1323 bool has_missing =
false;
1324 bool has_compatible =
false;
1325 for (
const GRFConfig *c = this->actives; !has_missing && c !=
nullptr; c = c->
next) {
1329 uint32_t widget_data;
1331 if (has_missing || has_compatible) {
1332 widget_data = STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_BUTTON;
1333 tool_tip = STR_NEWGRF_SETTINGS_FIND_MISSING_CONTENT_TOOLTIP;
1335 widget_data = STR_INTRO_ONLINE_CONTENT;
1336 tool_tip = STR_INTRO_TOOLTIP_ONLINE_CONTENT;
1346 EventState OnKeyPress([[maybe_unused]] char32_t key, uint16_t keycode)
override
1352 if (this->avail_pos >= 0) {
1353 this->active_sel =
nullptr;
1356 this->avail_sel = this->avails[this->
avail_pos];
1364 void OnEditboxChanged(
WidgetID widget)
override
1366 if (!this->editable)
return;
1378 if (!this->editable)
return;
1381 if (this->active_sel !=
nullptr) {
1385 for (from_prev = &this->actives; *from_prev != this->
active_sel; from_prev = &(*from_prev)->
next, from_pos++) {}
1389 if (to_pos != from_pos) {
1392 for (
int i = from_pos < to_pos ? -1 : 0; *to_prev !=
nullptr && i < to_pos; to_prev = &(*to_prev)->
next, i++) {}
1395 *from_prev = this->active_sel->
next;
1398 this->active_sel->
next = *to_prev;
1405 }
else if (this->avail_sel !=
nullptr) {
1411 Point dummy = {-1, -1};
1417 if (this->active_over != -1) {
1420 this->active_over = -1;
1426 if (!this->editable)
return;
1428 if (widget ==
WID_NS_FILE_LIST && (this->active_sel !=
nullptr || this->avail_sel !=
nullptr)) {
1432 to_pos = std::min(to_pos, this->vscroll->
GetCount() - (this->active_sel !=
nullptr ? 2 : 1));
1434 if (to_pos != this->active_over) {
1435 this->active_over = to_pos;
1439 this->active_over = -2;
1441 }
else if (this->active_over != -1) {
1443 this->active_over = -1;
1452 if (i != 0)
return i < 0;
1455 if (i != 0)
return i < 0;
1464 filter.
AddLine((*a)->GetName());
1465 filter.
AddLine((*a)->filename);
1466 filter.
AddLine((*a)->GetDescription());
1470 void BuildAvailables()
1474 this->avails.clear();
1479 if (found)
continue;
1482 this->avails.push_back(c);
1486 assert(best !=
nullptr);
1496 this->avails.push_back(c);
1501 this->avails.
Filter(this->string_filter);
1503 this->avails.
Sort();
1505 if (this->avail_sel !=
nullptr) {
1506 this->avail_pos =
find_index(this->avails, this->avail_sel);
1507 if (this->avail_pos == -1) {
1508 this->avail_sel =
nullptr;
1512 this->vscroll2->
SetCount(this->avails.size());
1522 if (this->avail_sel ==
nullptr || !this->editable ||
HasBit(this->avail_sel->
flags,
GCF_INVALID))
return false;
1530 for (list = &this->actives; *list !=
nullptr; list = &(*list)->
next, ins_pos--) {
1531 if (ins_pos == 0) entry = list;
1532 if ((*list)->ident.grfid == this->avail_sel->ident.grfid) {
1538 if (entry ==
nullptr) entry = list;
1552 int new_pos = this->avail_pos + 1;
1553 if (new_pos >= (
int)this->avails.size()) new_pos = this->avail_pos - 1;
1554 this->avail_pos = new_pos;
1555 if (new_pos >= 0) this->avail_sel = this->avails[new_pos];
1571 for (
const GRFConfig *c = list; c !=
nullptr; c = c->
next) {
1607 std::unique_ptr<NWidgetBase>
avs;
1608 std::unique_ptr<NWidgetBase>
acs;
1609 std::unique_ptr<NWidgetBase>
inf;
1627 this->avs->SetupSmallestSize(w);
1628 this->acs->SetupSmallestSize(w);
1629 this->inf->SetupSmallestSize(w);
1631 uint min_avs_width = this->avs->smallest_x + this->avs->padding.Horizontal();
1632 uint min_acs_width = this->acs->smallest_x + this->acs->padding.Horizontal();
1633 uint min_inf_width = this->inf->smallest_x + this->inf->padding.Horizontal();
1635 uint min_avs_height = this->avs->smallest_y + this->avs->padding.Vertical();
1636 uint min_acs_height = this->acs->smallest_y + this->acs->padding.Vertical();
1637 uint min_inf_height = this->inf->smallest_y + this->inf->padding.Vertical();
1644 this->
fill_x = std::lcm(this->avs->fill_x, this->acs->fill_x);
1645 if (this->inf->fill_x > 0 && (this->fill_x == 0 || this->fill_x > this->inf->fill_x)) this->
fill_x = this->inf->fill_x;
1647 this->
fill_y = this->avs->fill_y;
1648 if (this->acs->fill_y > 0 && (this->fill_y == 0 || this->fill_y > this->acs->fill_y)) this->
fill_y = this->acs->fill_y;
1649 this->
fill_y = std::lcm(this->
fill_y, this->inf->fill_y);
1652 this->
resize_x = std::lcm(this->avs->resize_x, this->acs->resize_x);
1653 if (this->inf->resize_x > 0 && (this->resize_x == 0 || this->resize_x > this->inf->resize_x)) this->
resize_x = this->inf->resize_x;
1655 this->
resize_y = this->avs->resize_y;
1656 if (this->acs->resize_y > 0 && (this->resize_y == 0 || this->resize_y > this->acs->resize_y)) this->
resize_y = this->acs->resize_y;
1667 uint min_avs_width = this->avs->smallest_x + this->avs->padding.Horizontal();
1668 uint min_acs_width = this->acs->smallest_x + this->acs->padding.Horizontal();
1669 uint min_inf_width = this->inf->smallest_x + this->inf->padding.Horizontal();
1671 uint min_list_width = std::max(min_avs_width, min_acs_width);
1672 uint avs_extra_width = min_list_width - min_avs_width;
1673 uint acs_extra_width = min_list_width - min_acs_width;
1681 uint extra_width, inf_width;
1682 if (use_three_columns) {
1683 extra_width = given_width - min_three_columns;
1686 extra_width = given_width - min_two_columns;
1689 inf_width =
ComputeMaxSize(this->inf->smallest_x, this->inf->smallest_x + inf_width, this->inf->GetHorizontalStepSize(sizing));
1690 extra_width -= inf_width - this->inf->smallest_x;
1692 uint inf_height =
ComputeMaxSize(this->inf->smallest_y, given_height, this->inf->GetVerticalStepSize(sizing));
1694 if (use_three_columns) {
1697 uint avs_width = std::min(avs_extra_width, extra_width);
1698 extra_width -= avs_width;
1699 extra_width -= std::min(acs_extra_width, extra_width);
1700 avs_width += extra_width / 2;
1702 avs_width =
ComputeMaxSize(this->avs->smallest_x, this->avs->smallest_x + avs_width, this->avs->GetHorizontalStepSize(sizing));
1704 uint acs_width = given_width -
1705 inf_width - this->inf->padding.Horizontal() -
1707 acs_width =
ComputeMaxSize(min_acs_width, acs_width, this->acs->GetHorizontalStepSize(sizing)) -
1708 this->acs->padding.Horizontal();
1711 uint avs_height =
ComputeMaxSize(this->avs->smallest_y, given_height, this->avs->resize_y);
1712 uint acs_height =
ComputeMaxSize(this->acs->smallest_y, given_height, this->acs->resize_y);
1716 x += this->inf->padding.left;
1717 this->inf->AssignSizePosition(sizing, x, y + this->inf->padding.top, inf_width, inf_height, rtl);
1720 x += this->avs->padding.left;
1721 this->avs->AssignSizePosition(sizing, x, y + this->avs->padding.top, avs_width, avs_height, rtl);
1725 x += this->acs->padding.left;
1726 this->acs->AssignSizePosition(sizing, x, y + this->acs->padding.top, acs_width, acs_height, rtl);
1730 x += this->avs->padding.left;
1731 this->avs->AssignSizePosition(sizing, x, y + this->avs->padding.top, avs_width, avs_height, rtl);
1733 x += this->inf->padding.left;
1734 this->inf->AssignSizePosition(sizing, x, y + this->inf->padding.top, inf_width, inf_height, rtl);
1739 uint avs_width =
ComputeMaxSize(this->avs->smallest_x, this->avs->smallest_x + avs_extra_width + extra_width,
1740 this->avs->GetHorizontalStepSize(sizing));
1741 uint acs_width =
ComputeMaxSize(this->acs->smallest_x, this->acs->smallest_x + acs_extra_width + extra_width,
1742 this->acs->GetHorizontalStepSize(sizing));
1745 uint min_acs_height = this->acs->smallest_y + this->acs->padding.Vertical();
1746 uint extra_height = given_height - min_acs_height - min_avs_height;
1749 uint avs_height =
ComputeMaxSize(this->avs->smallest_y, this->avs->smallest_y + extra_height / 2, this->avs->resize_y);
1750 if (this->editable) extra_height -= avs_height - this->avs->smallest_y;
1751 uint acs_height =
ComputeMaxSize(this->acs->smallest_y, this->acs->smallest_y + extra_height, this->acs->resize_y);
1755 x += this->inf->padding.left;
1756 this->inf->AssignSizePosition(sizing, x, y + this->inf->padding.top, inf_width, inf_height, rtl);
1759 this->acs->AssignSizePosition(sizing, x + this->acs->padding.left, y + this->acs->padding.top, acs_width, acs_height, rtl);
1760 if (this->editable) {
1761 this->avs->AssignSizePosition(sizing, x + this->avs->padding.left, y + given_height - avs_height - this->avs->padding.bottom, avs_width, avs_height, rtl);
1763 this->avs->AssignSizePosition(sizing, 0, 0, this->avs->smallest_x, this->avs->smallest_y, rtl);
1766 this->acs->AssignSizePosition(sizing, x + this->acs->padding.left, y + this->acs->padding.top, acs_width, acs_height, rtl);
1767 if (this->editable) {
1768 this->avs->AssignSizePosition(sizing, x + this->avs->padding.left, y + given_height - avs_height - this->avs->padding.bottom, avs_width, avs_height, rtl);
1770 this->avs->AssignSizePosition(sizing, 0, 0, this->avs->smallest_x, this->avs->smallest_y, rtl);
1772 uint dx = this->acs->current_x + this->acs->padding.Horizontal();
1773 if (this->editable) {
1774 dx = std::max(dx, this->avs->current_x + this->avs->padding.Horizontal());
1777 this->inf->AssignSizePosition(sizing, x, y + this->inf->padding.top, inf_width, inf_height, rtl);
1784 this->avs->FillWidgetLookup(widget_lookup);
1785 this->acs->FillWidgetLookup(widget_lookup);
1786 this->inf->FillWidgetLookup(widget_lookup);
1801 if (this->editable) this->avs->Draw(w);
1810 static constexpr
NWidgetPart _nested_newgrf_actives_widgets[] = {
1818 SetDataTip(STR_JUST_STRING1, STR_NEWGRF_SETTINGS_PRESET_LIST_TOOLTIP),
1822 SetDataTip(STR_NEWGRF_SETTINGS_PRESET_SAVE, STR_NEWGRF_SETTINGS_PRESET_SAVE_TOOLTIP),
1824 SetDataTip(STR_NEWGRF_SETTINGS_PRESET_DELETE, STR_NEWGRF_SETTINGS_PRESET_DELETE_TOOLTIP),
1843 SetDataTip(STR_NEWGRF_SETTINGS_REMOVE, STR_NEWGRF_SETTINGS_REMOVE_TOOLTIP),
1846 SetDataTip(STR_NEWGRF_SETTINGS_MOVEUP, STR_NEWGRF_SETTINGS_MOVEUP_TOOLTIP),
1848 SetDataTip(STR_NEWGRF_SETTINGS_MOVEDOWN, STR_NEWGRF_SETTINGS_MOVEDOWN_TOOLTIP),
1851 SetDataTip(STR_NEWGRF_SETTINGS_UPGRADE, STR_NEWGRF_SETTINGS_UPGRADE_TOOLTIP),
1856 SetDataTip(STR_NEWGRF_SETTINGS_RESCAN_FILES, STR_NEWGRF_SETTINGS_RESCAN_FILES_TOOLTIP),
1858 SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
1865 static constexpr
NWidgetPart _nested_newgrf_availables_widgets[] = {
1871 SetDataTip(STR_LIST_FILTER_OSKTITLE, STR_LIST_FILTER_TOOLTIP),
1887 SetDataTip(STR_NEWGRF_SETTINGS_ADD, STR_NEWGRF_SETTINGS_ADD_FILE_TOOLTIP),
1890 SetDataTip(STR_NEWGRF_SETTINGS_RESCAN_FILES, STR_NEWGRF_SETTINGS_RESCAN_FILES_TOOLTIP),
1892 SetDataTip(STR_INTRO_ONLINE_CONTENT, STR_INTRO_TOOLTIP_ONLINE_CONTENT),
1898 static constexpr
NWidgetPart _nested_newgrf_infopanel_widgets[] = {
1910 SetDataTip(STR_CONTENT_OPEN_URL, STR_CONTENT_OPEN_URL_TOOLTIP),
1912 SetDataTip(STR_TEXTFILE_VIEW_README, STR_TEXTFILE_VIEW_README_TOOLTIP),
1916 SetDataTip(STR_TEXTFILE_VIEW_CHANGELOG, STR_TEXTFILE_VIEW_CHANGELOG_TOOLTIP),
1918 SetDataTip(STR_TEXTFILE_VIEW_LICENCE, STR_TEXTFILE_VIEW_LICENCE_TOOLTIP),
1927 SetDataTip(STR_NEWGRF_SETTINGS_SET_PARAMETERS, STR_NULL),
1929 SetDataTip(STR_NEWGRF_SETTINGS_TOGGLE_PALETTE, STR_NEWGRF_SETTINGS_TOGGLE_PALETTE_TOOLTIP),
1932 SetDataTip(STR_NEWGRF_SETTINGS_APPLY_CHANGES, STR_NULL),
1935 SetDataTip(STR_NEWGRF_SETTINGS_SHOW_PARAMETERS, STR_NULL),
1943 std::unique_ptr<NWidgetBase> avs =
MakeNWidgets(_nested_newgrf_availables_widgets,
nullptr);
1944 std::unique_ptr<NWidgetBase> acs =
MakeNWidgets(_nested_newgrf_actives_widgets,
nullptr);
1945 std::unique_ptr<NWidgetBase> inf =
MakeNWidgets(_nested_newgrf_infopanel_widgets,
nullptr);
1947 return std::make_unique<NWidgetNewGRFDisplay>(std::move(avs), std::move(acs), std::move(inf));
1951 static constexpr
NWidgetPart _nested_newgrf_widgets[] = {
1972 _nested_newgrf_widgets
1998 for (c = nw->
actives; c !=
nullptr && i > 0; c = c->
next, i--) {}
2023 new NewGRFWindow(_newgrf_desc, editable, show_params, exec_changes, config);
2041 NWidget(
WWT_EDITBOX, COLOUR_GREY,
WID_SVP_EDITBOX),
SetPadding(2, 2, 2, 2),
SetFill(1, 0),
SetResize(1, 0),
2042 SetDataTip(STR_SAVE_PRESET_TITLE, STR_SAVE_PRESET_EDITBOX_TOOLTIP),
2073 this->selected = -1;
2074 if (initial_text !=
nullptr) {
2075 for (uint i = 0; i < this->presets.size(); i++) {
2076 if (this->presets[i] == initial_text) {
2091 this->vscroll->
SetCount(this->presets.size());
2093 if (initial_text !=
nullptr) this->presetname_editbox.text.
Assign(initial_text);
2106 for (uint i = 0; i < this->presets.size(); i++) {
2108 size.width = std::max(size.width, d.width + padding.width);
2111 size.height =
ClampU((uint)this->presets.size(), 5, 20) *
resize.height + padding.height;
2117 void DrawWidget(
const Rect &r,
WidgetID widget)
const override
2129 for (
auto it = first; it != last; ++it) {
2130 int row =
static_cast<int>(std::distance(std::begin(this->presets), it));
2133 DrawString(tr.left, tr.right, tr.top + offset_y, *it, (row == this->selected) ? TC_WHITE : TC_SILVER);
2134 tr.top += step_height;
2141 void OnClick([[maybe_unused]]
Point pt,
WidgetID widget, [[maybe_unused]]
int click_count)
override
2146 if (it != this->presets.end()) {
2147 this->selected = it - this->presets.begin();
2148 this->presetname_editbox.text.
Assign(*it);
2238 void DrawWidget(
const Rect &r,
WidgetID widget)
const override
2269 if (name ==
nullptr) {
2270 this->last_name =
GetString(STR_NEWGRF_SCAN_ARCHIVES);
2272 this->last_name = name;
2274 this->scanned = num;
@ ES_HANDLED
The passed event is handled.
GRFParameterInfo & GetParameterInfo(uint nr) const
Get GRF Parameter Info exists for a given parameter index.
void DrawArrowButtons(int x, int y, Colours button_colour, uint8_t state, bool clickable_left, bool clickable_right)
Draw [<][>] boxes.
@ GRFP_USE_MASK
Bitmask to get only the use palette use states.
bool AddGRFToActive(int ins_pos=-1)
Insert a GRF into the active list.
void CloseWindowByClass(WindowClass cls, int data)
Close all windows of a given class.
static const uint8_t PC_DARK_BLUE
Dark blue palette colour.
std::string name
Name of the content.
StringFilter string_filter
Filter for available grf.
int ok_button
Widget button of parent window to simulate when pressing OK in OSK.
ContentType type
Type of content.
@ GOID_NEWGRF_CHANGES_MADE
Changes have been made to a given NewGRF either through the palette or its parameters.
void SetWindowDirty(WindowClass cls, WindowNumber number)
Mark window as dirty (in need of repainting)
void ReloadNewGRFData()
Reload all NewGRF files during a running game.
void ShowQuery(StringID caption, StringID message, Window *parent, QueryCallbackProc *callback, bool focus)
Show a confirmation window with standard 'yes' and 'no' buttons The window is aligned to the centre o...
Window for showing the progress of NewGRF scanning.
bool newgrf_developer_tools
activate NewGRF developer tools and allow modifying NewGRFs in an existing game
uint8_t num_valid_params
NOSAVE: Number of valid parameters (action 0x14)
void SetDParamMaxDigits(size_t n, uint count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
static WindowDesc _save_preset_desc(WDP_CENTER, "save_preset", 140, 110, WC_SAVE_PRESET, WC_GAME_OPTIONS, WDF_MODAL, _nested_save_preset_widgets)
Window description of the preset save window.
void OnNewGRFsScanned() override
Called whenever the NewGRF scan completed.
Dimensions (a width and height) of a rectangle in 2D.
constexpr bool IsInsideMM(const T x, const size_t min, const size_t max) noexcept
Checks if a value is in an interval.
@ GCS_ACTIVATED
GRF file has been activated.
void ShowErrorMessage(StringID summary_msg, int x, int y, CommandCost cc)
Display an error message in a window.
void SetFilterState(bool state)
Enable or disable the filter.
Rect Shrink(int s) const
Copy and shrink Rect by s pixels.
void ClearGRFConfigList(GRFConfig **config)
Clear a GRF Config list, freeing all nodes.
bool IsEmpty() const
Check whether any filter words were entered.
@ DOES_NOT_EXIST
The content does not exist in the content system.
void SetFilterTerm(const char *str)
Set the term to filter on.
Class for the save preset window.
Gamelog _gamelog
Gamelog instance.
void UpdateNewGRFScanStatus(uint num, const char *name)
Update the NewGRF scan status.
void SetWidgetDirty(WidgetID widget_index) const
Invalidate a widget, i.e.
static void ShowSavePresetWindow(const char *initial_text)
Open the window for saving a preset.
uint32_t GetValue(struct GRFConfig *config) const
Get the value of this user-changeable parameter from the given config.
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
static WindowDesc _scan_progress_desc(WDP_CENTER, nullptr, 0, 0, WC_MODAL_PROGRESS, WC_NONE, 0, _nested_scan_progress_widgets)
Description of the widgets and other settings of the window.
void Assign(StringID string)
Render a string into the textbuffer.
void CloseWindowById(WindowClass cls, WindowNumber number, bool force, int data)
Close a window by its class and window number (if it is open).
std::vector< std::unique_ptr< const DropDownListItem > > DropDownList
A drop down list is a collection of drop down list items.
GRFConfig * _all_grfs
First item in list of all scanned NewGRFs.
void ShowNetworkContentListWindow(ContentVector *cv=nullptr, ContentType type1=CONTENT_TYPE_END, ContentType type2=CONTENT_TYPE_END)
Show the content list window with a given set of content.
Window for showing NewGRF files.
void OnInvalidateData([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) override
Some data on this window has become invalid.
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
virtual void Close(int data=0)
Hide the window and all its child windows, and mark them for a later deletion.
@ CONTENT_TYPE_NEWGRF
The content consists of a NewGRF.
Window * FindWindowById(WindowClass cls, WindowNumber number)
Find a window by its class and window number.
std::vector< ContentInfo * > ContentVector
Vector with content info.
void ShowMissingContentWindow(const GRFConfig *list)
Show the content list window with all missing grfs from the given list.
SavePresetWindow(const char *initial_text)
Constructor of the save preset window.
std::string filename
Filename - either with or without full path.
bool modified
The list of active NewGRFs has been modified since the last time they got saved.
GRFConfig * actives
Temporary active grf list to which changes are made.
bool RequestNewGRFScan(NewGRFScanCallback *callback)
Request a new NewGRF scan.
int StrNaturalCompare(std::string_view s1, std::string_view s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
@ GCS_NOT_FOUND
GRF file was not found in the local cache.
ScanProgressWindow()
Create the window.
GRFIdentifier ident
grfid and md5sum to uniquely identify newgrfs
ClientSettings _settings_client
The current settings for this game.
bool editable
Allow editing parameters.
GRFStatus status
NOSAVE: GRFStatus, enum.
constexpr uint Vertical() const
Get total vertical padding of RectPadding.
@ GRFP_GRF_UNSET
The NewGRF provided no information.
constexpr uint ClampU(const uint a, const uint min, const uint max)
Clamp an unsigned integer between an interval.
void AddLine(const char *str)
Pass another text line from the current item to the filter.
bool execute
On pressing 'apply changes' are grf changes applied immediately, or only list is updated.
@ FR_LOWERED
If set the frame is lowered and the background colour brighter (ie. buttons when pressed)
std::unique_ptr< NWidgetBase > NewGRFDisplay()
Construct nested container widget for managing the lists and the info panel of the NewGRF GUI.
uint32_t min_loadable_version
NOSAVE: Minimum compatible version a NewGRF can define.
static bool NameSorter(const GRFConfig *const &a, const GRFConfig *const &b)
Sort grfs by name.
int preset
Selected preset or -1 if none selected.
GRFParameterType type
The type of this parameter.
bool clicked_dropdown
Whether the dropdown is open.
const Scrollbar * GetScrollbar(WidgetID widnum) const
Return the Scrollbar to a widget index.
MD5Hash md5sum
The MD5 checksum.
bool StrEmpty(const char *s)
Check if a string buffer is empty.
uint32_t PaletteID
The number of the palette.
TextfileType file_type
Type of textfile to view.
@ TFT_CHANGELOG
Content changelog.
@ WN_GAME_OPTIONS_NEWGRF_STATE
NewGRF settings.
void SetFilterFuncs(std::span< FilterFunction *const > n_funcs)
Hand the filter function pointers to the GUIList.
GRFConfig * active_sel
Selected active grf item.
uint32_t min_value
The minimal value this parameter can have.
bool NeedRebuild() const
Check if a rebuild is needed.
Data stored about a string that can be modified in the GUI.
@ WC_GRF_PARAMETERS
NewGRF parameters; Window numbers:
int active_over
Active GRF item over which another one is dragged, -1 if none.
@ WC_SAVE_PRESET
Save preset; Window numbers:
@ GCF_COMPATIBLE
GRF file does not exactly match the requested GRF (different MD5SUM), but grfid matches)
char *const buf
buffer in which text is saved
@ GCF_INVALID
GRF is unusable with this version of OpenTTD.
void OnPaint() override
The window must be repainted.
int find_index(Container const &container, typename Container::const_reference item)
Helper function to get the index of an item Consider using std::set, std::unordered_set or std::flat_...
bool clicked_increase
True if the increase button was clicked, false for the decrease button.
int selected
Selected entry in the preset list, or -1 if none selected.
High level window description.
constexpr uint Horizontal() const
Get total horizontal padding of RectPadding.
void Reset()
Reset the timer, so it will fire again after the timeout.
std::optional< std::string > GetTextfile(TextfileType type) const
Search a textfile file next to this NewGRF.
virtual void OnQueryTextFinished([[maybe_unused]] std::optional< std::string > str)
The query window opened from this window has closed.
@ WC_MODAL_PROGRESS
Progress report of landscape generation; Window numbers:
int ScaleGUITrad(int value)
Scale traditional pixel dimensions to GUI zoom level.
bool HasParameterInfo(uint nr) const
Test if GRF Parameter Info exists for a given parameter index.
static const uint NETWORK_MAX_GRF_COUNT
Maximum number of GRFs that can be sent.
static constexpr NWidgetPart _nested_scan_progress_widgets[]
Widgets for the progress window.
StringList GetGRFPresetList()
Get the list of known NewGrf presets.
constexpr bool IsInsideBS(const T x, const size_t base, const size_t size)
Checks if a value is between a window started at some base point.
void SetValue(struct GRFConfig *config, uint32_t value)
Set the value of this user-changeable parameter in the given config.
@ WC_QUERY_STRING
Query string window; Window numbers:
uint32_t version
NOSAVE: Version a NewGRF can set so only the newest NewGRF is shown.
std::map< uint32_t, GRFTextList > value_names
Names for each value.
void DrawDropDownButton(int x, int y, Colours button_colour, bool state, bool clickable)
Draw a dropdown button.
int32_t clicked_row
The selected parameter, or INT_MAX when none is selected.
Data structure describing how to show the list (what sort direction and criteria).
bool CanUpgradeCurrent()
Test whether the currently active set of NewGRFs can be upgraded with the available NewGRFs.
uint8_t param_nr
GRF parameter to store content in.
ResizeInfo resize
Resize information.
static uint32_t BSWAP32(uint32_t x)
Perform a 32 bits endianness bitswap on x.
@ GOID_NEWGRF_CURRENT_LOADED
The current list of active NewGRF has been loaded.
void UpdateNewGRFScanStatus(uint num, const char *name)
Update the NewGRF scan status.
void UpdateScrollBars()
Updates the scroll bars for the active and inactive NewGRF lists.
Information about GRF, used in the game and (part of it) in savegames.
static Listing last_sorting
Default sorting of #GUIGRFConfigList.
@ FS_NORMAL
Index of the normal font in the font tables.
Window for setting the parameters of a NewGRF.
void InitNested(WindowNumber number=0)
Perform complete initialization of the Window with nested widgets, to allow use.
std::string FormatArrayAsHex(std::span< const uint8_t > data)
Format a byte array into a continuous hex string.
static GRFParameterInfo & GetDummyParameterInfo(uint nr)
Get a dummy parameter-info object with default information.
bool Filter(FilterFunction *decide, F filter_data)
Filter the list.
void ReInitAllWindows(bool zoom_changed)
Re-initialize all windows.
static const std::initializer_list< GUIGRFConfigList::FilterFunction *const > filter_funcs
Filter functions of the #GUIGRFConfigList.
@ GOID_NEWGRF_LIST_EDITED
List of active NewGRFs is being edited.
void SetDirty() const
Mark entire window as dirty (in need of re-paint)
void SetParameterDefaults()
Set the default value for all parameters as specified by action14.
Container for all important information about a piece of content.
@ GRFP_USE_WINDOWS
The palette state is set to use the Windows palette.
static void FillGrfidMap(const GRFConfig *c, GrfIdMap *grfid_map)
Add all grf configs from c into the map.
MD5Hash md5sum
MD5 checksum of file to distinguish files with the same GRF ID (eg. newer version of GRF)
@ ES_NOT_HANDLED
The passed event is not handled.
GRFConfig ** CopyGRFConfigList(GRFConfig **dst, const GRFConfig *src, bool init_only)
Copy a GRF Config list.
const char * GetGRFStringFromGRFText(const GRFTextList &text_list)
Get a C-string from a GRFText-list.
void ShowDropDownListAt(Window *w, DropDownList &&list, int selected, WidgetID button, Rect wi_rect, Colours wi_colour, bool instant_close, bool persist)
Show a drop down list.
void ShowNewGRFError()
Show the first NewGRF error we can find.
Data structure describing what to show in the list (filter criteria).
Information about one grf parameter.
virtual void LoadTextfile(const std::string &textfile, Subdirectory dir)
Loads the textfile text from file and setup lines.
std::optional< GRFError > error
NOSAVE: Error/Warning during GRF loading (Action 0x0B)
@ WL_INFO
Used for DoCommand-like (and some non-fatal AI GUI) errors/information.
std::vector< std::string > StringList
Type for a list of strings.
void UpgradeCurrent()
Upgrade the currently active set of NewGRFs.
static WindowDesc _newgrf_parameters_desc(WDP_CENTER, "settings_newgrf_config", 500, 208, WC_GRF_PARAMETERS, WC_NONE, 0, _nested_newgrf_parameter_widgets)
Window definition for the change grf parameters window.
@ GOID_NEWGRF_CHANGES_APPLIED
The active NewGRF list changes have been applied.
void ShowQueryString(StringID str, StringID caption, uint maxsize, Window *parent, CharSetFilter afilter, QueryStringFlags flags)
Show a query popup window with a textbox in it.
@ GRFP_BLT_32BPP
The NewGRF prefers a 32 bpp blitter.
Rect Indent(int indent, bool end) const
Copy Rect and indent it from its position.
Rect WithWidth(int width, bool end) const
Copy Rect and set its width.
std::string last_name
The name of the last 'seen' NewGRF.
void DrawSprite(SpriteID img, PaletteID pal, int x, int y, const SubSprite *sub, ZoomLevel zoom)
Draw a sprite, not in a viewport.
@ WDF_MODAL
The window is a modal child of some other window, meaning the parent is 'inactive'.
bool IsCompatible(uint32_t old_version) const
Return whether this NewGRF can replace an older version of the same NewGRF.
void DeleteGRFPresetFromConfig(const char *config_name)
Delete a NewGRF configuration by preset name.
Dimension GetStringMultiLineBoundingBox(StringID str, const Dimension &suggestion)
Calculate string bounding box for multi-line strings.
Coordinates of a point in 2D.
static void NewGRFConfirmationCallback(Window *w, bool confirmed)
Callback function for the newgrf 'apply changes' confirmation window.
const char * GetURL() const
Get the grf url.
int CenterBounds(int min, int max, int size)
Determine where to draw a centred object inside a widget.
@ GRFP_GRF_MASK
Bitmask to get only the NewGRF supplied information.
#define SETTING_BUTTON_WIDTH
Width of setting buttons.
TimeoutTimer< TimerWindow > unclick_timeout
When reset, unclick the button after a small timeout.
void GRFUpdate(const GRFConfig *oldg, const GRFConfig *newg)
Compares two NewGRF lists and logs any change.
void CopyParams(const GRFConfig &src)
Copy the parameter information from the src config.
bool SetFocusedWidget(WidgetID widget_index)
Set focus within this window to the given widget.
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.
@ TFT_README
Content readme.
GRFConfig ** orig_list
List active grfs in the game. Used as initial value, may be updated by the window.
void InvalidateData(int data=0, bool gui_scope=true)
Mark this window's data as invalid (in need of re-computing)
@ NEWGRF_DIR
Subdirectory for all NewGRFs.
QueryString presetname_editbox
Edit box of the save preset.
@ WC_NONE
No window, redirects to WC_MAIN_WINDOW.
int scanned
The number of NewGRFs that we have seen.
uint8_t palette
GRFPalette, bitset.
@ SA_HOR_CENTER
Horizontally center the text.
std::vector< std::optional< GRFParameterInfo > > param_info
NOSAVE: extra information about the parameters.
GRFConfig * LoadGRFPresetFromConfig(const char *config_name)
Load a NewGRF configuration by preset-name.
@ HT_DRAG
dragging items in the depot windows
void SetWidgetDisabledState(WidgetID widget_index, bool disab_stat)
Sets the enabled/disabled status of a widget.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
bool newgrf_show_old_versions
whether to show old versions in the NewGRF list
void ForceRebuild()
Force that a rebuild is needed.
@ TFT_LICENSE
Content license.
QueryString filter_editbox
Filter editbox;.
void StartAction(GamelogActionType at)
Stores information about new action, but doesn't allocate it Action is allocated only when there is a...
@ GCS_DISABLED
GRF file is disabled.
void StopAction()
Stops logging of any changes.
std::map< WidgetID, QueryString * > querystrings
QueryString associated to WWT_EDITBOX widgets.
int cancel_button
Widget button of parent window to simulate when pressing CANCEL in OSK.
int DrawStringMultiLine(int left, int right, int top, int bottom, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly over multiple lines.
uint32_t max_value
The maximal value of this parameter.
@ WC_GAME_OPTIONS
Game options window; Window numbers:
int line_height
Height of a row in the matrix widget.
uint8_t flags
NOSAVE: GCF_Flags, bitset.
void CreateNestedTree()
Perform the first part of the initialization of a nested widget tree.
void OnResize() override
Called after the window got resized.
const GRFConfig * avail_sel
Currently selected available grf. nullptr is none is selected.
std::array< uint32_t, 0x80 > param
GRF parameters.
GRFTextList desc
The description of this parameter.
bool closing_dropdown
True, if the dropdown list is currently closing.
void DisableWidget(WidgetID widget_index)
Sets a widget to disabled.
void CloseChildWindows(WindowClass wc=WC_INVALID) const
Close all children a window might have in a head-recursive manner.
void SetDParamMaxValue(size_t n, uint64_t max_value, uint min_count, FontSize size)
Set DParam n to some number that is suitable for string size computations.
std::string GRFBuildParamList(const GRFConfig *c)
Build a string containing space separated parameter values, and terminate.
const char * GetDescription() const
Get the grf info.
void SetDParam(size_t n, uint64_t v)
Set a string parameter v at index n in the global string parameter array.
void OnInvalidateData([[maybe_unused]] int data=0, [[maybe_unused]] bool gui_scope=true) override
Some data on this window has become invalid.
StringList grf_presets
List of known NewGRF presets.
@ GOID_NEWGRF_RESCANNED
NewGRFs were just rescanned.
void ShowNewGRFSettings(bool editable, bool show_params, bool exec_changes, GRFConfig **config)
Setup the NewGRF gui.
struct GRFConfig * next
NOSAVE: Next item in the linked list.
void ResetState()
Reset the matching state to process a new item.
bool HasGrfIdentifier(uint32_t grfid, const MD5Hash *md5sum) const
Does the identification match the provided values?
static const std::initializer_list< GUIGRFConfigList::SortFunction *const > sorter_funcs
Sort functions of the #GUIGRFConfigList.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with all the associated DParam lookups and formatting.
EventState
State of handling an event.
@ FGCM_NEWEST
Find newest Grf.
@ FGCM_NEWEST_VALID
Find newest Grf, ignoring Grfs with GCF_INVALID set.
GRFTextList name
The name of this parameter.
Window * FindWindowByClass(WindowClass cls)
Find any window by its class.
static const uint8_t PC_GREY
Grey palette colour.
bool show_params
Are the grf-parameters shown in the info-panel?
bool GetState() const
Get the matching state of the current item.
bool action14present
True if action14 information is present.
void SetDParamStr(size_t n, const char *str)
This function is used to "bind" a C string to a OpenTTD dparam slot.
std::map< uint32_t, const GRFConfig * > GrfIdMap
Map of grfid to the grf config.
void FinishInitNested(WindowNumber window_number=0)
Perform the second part of the initialization of a nested widget tree.
static const uint8_t PC_BLACK
Black palette colour.
void ShowDropDownList(Window *w, DropDownList &&list, int selected, WidgetID button, uint width, bool instant_close, bool persist)
Show a drop down list.
@ WL_ERROR
Errors (eg. saving/loading failed)
static const int ACTION_CLEAR
Clear editbox.
int top
y position of top edge of the window
uint32_t last_newgrf_count
the numbers of NewGRFs we found during the last scan
static constexpr NWidgetPart _nested_save_preset_widgets[]
Widget parts of the save preset window.
bool complete_labels
True if all values have a label.
GRFConfig * _grfconfig
First item in list of current GRF set up.
State state
Whether the content info is selected (for download)
const GRFConfig * grf_config
View the textfile of this GRFConfig.
int GetCharacterHeight(FontSize size)
Get height of a character for a given font size.
Callback for NewGRF scanning.
int width
width of the window (number of pixels to the right in x direction)
uint32_t grfid
GRF ID (defined by Action 0x08)
void RebuildDone()
Notify the sortlist that the rebuild is done.
@ WC_BUILD_OBJECT
Build object; Window numbers:
uint8_t num_params
Number of used parameters.
static Filtering last_filtering
Default filtering of #GUIGRFConfigList.
bool editable
Is the window editable?
@ PTYPE_BOOL
The parameter is either 0 or 1.
MD5Hash original_md5sum
MD5 checksum of original file if only a 'compatible' file was loaded.
int DrawString(int left, int right, int top, std::string_view str, TextColour colour, StringAlignment align, bool underline, FontSize fontsize)
Draw string, possibly truncated to make it fit in its allocated space.
void SetObjectToPlaceWnd(CursorID icon, PaletteID pal, HighLightStyle mode, Window *w)
Change the cursor and mouse click/drag handling to a mode for performing special operations like tile...
void OnDropdownClose(Point, WidgetID widget, int, bool) override
A dropdown window associated to this window has been closed.
bool scenario_developer
activate scenario developer: allow modifying NewGRFs in an existing game
Window for displaying a textfile.
GRFConfig * grf_config
Set the parameters of this GRFConfig.
static const CursorID SPR_CURSOR_MOUSE
Cursor sprite numbers.
@ PTYPE_UINT_ENUM
The parameter allows a range of numbers, each of which can have a special name.
Data structure for an opened window.
TextfileType
Additional text files accompanying Tar archives.
void ResetGRFConfig(bool defaults)
Reset the current GRF Config to either blank or newgame settings.
void DrawWidgets() const
Paint all widgets of a window.
@ FGCM_EXACT
Only find Grfs matching md5sum.
static const uint8_t PC_DARK_GREY
Dark grey palette colour.
void DrawBoolButton(int x, int y, bool state, bool clickable)
Draw a toggle button.
bool _network_available
is network mode available?
int Width() const
Get width of Rect.
Window for displaying the textfile of a NewGRF.
Dimension GetScaledSpriteSize(SpriteID sprid)
Scale sprite size for GUI.
PaletteID GetPalette(const GRFConfig *c) const
Pick the palette for the sprite of the grf to display.
Specification of a rectangle with absolute coordinates of all edges.
@ WC_DROPDOWN_MENU
Drop down menu; Window numbers:
bool Sort(Comp compare)
Sort the list.
void OnResize() override
Called after the window got resized.
void SetWidgetsDisabledState(bool disab_stat, Args... widgets)
Sets the enabled/disabled status of a list of widgets.
const GRFConfig * FindGRFConfig(uint32_t grfid, FindGRFConfigMode mode, const MD5Hash *md5sum, uint32_t desired_version)
Find a NewGRF in the scanned list.
int avail_pos
Index of avail_sel if existing, else -1.
@ WC_TEXTFILE
textfile; Window numbers:
void ResetObjectToPlace()
Reset the cursor and mouse mode handling back to default (normal cursor, only clicking in windows).
void SaveGRFPresetToConfig(const char *config_name, GRFConfig *config)
Save a NewGRF configuration with a preset name.
Scrollbar * vscroll
Pointer to the scrollbar widget.
@ WDP_CENTER
Center the window.
#define SETTING_BUTTON_HEIGHT
Height of setting buttons.
void SetFiltering(Filtering f)
Import filter conditions.
@ TD_RTL
Text is written right-to-left by default.
TextDirection _current_text_dir
Text direction of the currently selected language.
@ CS_NUMERAL
Only numeric ones.
static bool TagNameFilter(const GRFConfig *const *a, StringFilter &filter)
Filter grfs by tags/name.
uint32_t unique_id
Unique ID; either GRF ID or shortname.
Dimension GetStringBoundingBox(std::string_view str, FontSize start_fontsize)
Return the string dimension in pixels.
StringList presets
Available presets.
int32_t clicked_button
The row in which a button was clicked or INT_MAX when none is selected.
void OnResize() override
Called after the window got resized.
static const StringID INVALID_STRING_ID
Constant representing an invalid string (16bit in case it is used in savegames)
@ GCF_STATIC
GRF file is used statically (can be used in any MP game)
GUISettings gui
settings related to the GUI
@ WL_CRITICAL
Critical errors, the MessageBox is shown in all cases.
void SetSortFuncs(std::span< SortFunction *const > n_funcs)
Hand the sort function pointers to the GUIList.
@ FR_BORDERONLY
Draw border only, no background.
const char * GetName() const
Get the name of this grf.
void SetListing(Listing l)
Import sort conditions.
GUIGRFConfigList avails
Available (non-active) grfs.
static GRFParameterInfo dummy_parameter_info
Dummy info in case a newgrf didn't provide info about some parameter.
constexpr debug_inline bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.