OpenTTD Source  20241108-master-g80f628063a
newgrf_gui.cpp File Reference

GUI to change NewGRF settings. More...

#include "stdafx.h"
#include "error.h"
#include "settings_gui.h"
#include "newgrf.h"
#include "strings_func.h"
#include "window_func.h"
#include "gamelog.h"
#include "settings_type.h"
#include "settings_func.h"
#include "dropdown_type.h"
#include "dropdown_func.h"
#include "network/network.h"
#include "network/network_content.h"
#include "sortlist_type.h"
#include "stringfilter_type.h"
#include "querystring_gui.h"
#include "core/geometry_func.hpp"
#include "newgrf_text.h"
#include "textfile_gui.h"
#include "tilehighlight_func.h"
#include "fios.h"
#include "timer/timer.h"
#include "timer/timer_window.h"
#include "zoom_func.h"
#include "widgets/newgrf_widget.h"
#include "widgets/misc_widget.h"
#include "table/sprites.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures

struct  NewGRFParametersWindow
 Window for setting the parameters of a NewGRF. More...
 
struct  NewGRFTextfileWindow
 Window for displaying the textfile of a NewGRF. More...
 
struct  NewGRFWindow
 Window for showing NewGRF files. More...
 
class  NWidgetNewGRFDisplay
 Custom nested widget container for the NewGRF gui. More...
 
struct  SavePresetWindow
 Class for the save preset window. More...
 
struct  ScanProgressWindow
 Window for showing the progress of NewGRF scanning. More...
 

Typedefs

typedef std::map< uint32_t, const GRFConfig * > GrfIdMap
 Map of grfid to the grf config.
 

Functions

void ShowNewGRFError ()
 Show the first NewGRF error we can find.
 
static void ShowNewGRFInfo (const GRFConfig *c, const Rect &r, bool show_params)
 
void OpenGRFParameterWindow (bool is_baseset, GRFConfig *c, bool editable)
 
void ShowNewGRFTextfileWindow (TextfileType file_type, const GRFConfig *c)
 
static void FillGrfidMap (const GRFConfig *c, GrfIdMap *grfid_map)
 Add all grf configs from c into the map. More...
 
static void NewGRFConfirmationCallback (Window *w, bool confirmed)
 Callback function for the newgrf 'apply changes' confirmation window. More...
 
static void ShowSavePresetWindow (const char *initial_text)
 Open the window for saving a preset. More...
 
void ShowMissingContentWindow (const GRFConfig *list)
 Show the content list window with all missing grfs from the given list. More...
 
std::unique_ptr< NWidgetBaseNewGRFDisplay ()
 Construct nested container widget for managing the lists and the info panel of the NewGRF GUI.
 
void ShowNewGRFSettings (bool editable, bool show_params, bool exec_changes, GRFConfig **config)
 Setup the NewGRF gui. More...
 
void UpdateNewGRFScanStatus (uint num, const char *name)
 Update the NewGRF scan status. More...
 

Variables

static constexpr NWidgetPart _nested_newgrf_parameter_widgets []
 
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.
 
static constexpr NWidgetPart _nested_newgrf_actives_widgets []
 
static constexpr NWidgetPart _nested_newgrf_availables_widgets []
 
static constexpr NWidgetPart _nested_newgrf_infopanel_widgets []
 
static constexpr NWidgetPart _nested_newgrf_widgets []
 
static WindowDesc _newgrf_desc (WDP_CENTER, "settings_newgrf", 300, 263, WC_GAME_OPTIONS, WC_NONE, 0, _nested_newgrf_widgets)
 
static constexpr NWidgetPart _nested_save_preset_widgets []
 Widget parts of the save preset window. More...
 
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.
 
static constexpr NWidgetPart _nested_scan_progress_widgets []
 Widgets for the progress window. More...
 
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.
 

Detailed Description

GUI to change NewGRF settings.

Definition in file newgrf_gui.cpp.

Function Documentation

◆ FillGrfidMap()

static void FillGrfidMap ( const GRFConfig c,
GrfIdMap grfid_map 
)
static

Add all grf configs from c into the map.

Parameters
cGrf list to add.
grfid_mapMap to add them to.

Definition at line 591 of file newgrf_gui.cpp.

References GRFIdentifier::grfid, GRFConfig::ident, and GRFConfig::next.

Referenced by NewGRFWindow::CanUpgradeCurrent(), and NewGRFWindow::UpgradeCurrent().

◆ NewGRFConfirmationCallback()

static void NewGRFConfirmationCallback ( Window w,
bool  confirmed 
)
static

◆ ShowMissingContentWindow()

void ShowMissingContentWindow ( const GRFConfig list)

◆ ShowNewGRFSettings()

void ShowNewGRFSettings ( bool  editable,
bool  show_params,
bool  exec_changes,
GRFConfig **  config 
)

Setup the NewGRF gui.

Parameters
editableallow the user to make changes to the grfconfig in the window
show_paramsshow information about what parameters are set for the grf files
exec_changesif changes are made to the list (editable is true), apply these changes immediately or only update the list
configpointer to a linked-list of grfconfig's that will be shown

Definition at line 2020 of file newgrf_gui.cpp.

References CloseWindowByClass(), and WC_GAME_OPTIONS.

◆ ShowSavePresetWindow()

static void ShowSavePresetWindow ( const char *  initial_text)
static

Open the window for saving a preset.

Parameters
initial_textInitial text to display in the edit box, or nullptr.

Definition at line 2178 of file newgrf_gui.cpp.

References CloseWindowByClass(), and WC_SAVE_PRESET.

◆ UpdateNewGRFScanStatus()

void UpdateNewGRFScanStatus ( uint  num,
const char *  name 
)

Update the NewGRF scan status.

Parameters
numThe number of NewGRFs scanned so far.
nameThe name of the last scanned NewGRF.

Definition at line 2286 of file newgrf_gui.cpp.

References FindWindowByClass(), ScanProgressWindow::UpdateNewGRFScanStatus(), and WC_MODAL_PROGRESS.

Variable Documentation

◆ _nested_newgrf_widgets

constexpr NWidgetPart _nested_newgrf_widgets[]
staticconstexpr
Initial value:
= {
NWidget(WWT_CLOSEBOX, COLOUR_MAUVE),
NWidget(WWT_CAPTION, COLOUR_MAUVE), SetDataTip(STR_NEWGRF_SETTINGS_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
NWidget(WWT_DEFSIZEBOX, COLOUR_MAUVE),
NWidget(WWT_PANEL, COLOUR_MAUVE),
NWidget(WWT_RESIZEBOX, COLOUR_MAUVE), SetDataTip(RWV_HIDE_BEVEL, STR_TOOLTIP_RESIZE),
}
static const WidgetDimensions unscaled
Unscaled widget dimensions.
Definition: window_gui.h:67
constexpr NWidgetPart NWidgetFunction(NWidgetFunctionType *func_ptr)
Obtain a nested widget (sub)tree from an external source.
Definition: widget_type.h:1330
constexpr NWidgetPart SetFill(uint16_t fill_x, uint16_t fill_y)
Widget part function for setting filling.
Definition: widget_type.h:1181
constexpr NWidgetPart SetPadding(uint8_t top, uint8_t right, uint8_t bottom, uint8_t left)
Widget part function for setting additional space around a widget.
Definition: widget_type.h:1228
constexpr NWidgetPart SetDataTip(uint32_t data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1202
constexpr NWidgetPart NWidget(WidgetType tp, Colours col, WidgetID idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1309
constexpr NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME,...
Definition: widget_type.h:1191
constexpr NWidgetPart SetResize(int16_t dx, int16_t dy)
Widget part function for setting the resize step.
Definition: widget_type.h:1126
std::unique_ptr< NWidgetBase > NewGRFDisplay()
Construct nested container widget for managing the lists and the info panel of the NewGRF GUI.
@ NWID_SPACER
Invisible widget that takes some space.
Definition: widget_type.h:79
@ NWID_HORIZONTAL
Horizontal container.
Definition: widget_type.h:75
@ WWT_PANEL
Simple depressed panel.
Definition: widget_type.h:50
@ WWT_CAPTION
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
@ WWT_CLOSEBOX
Close box (at top-left of a window)
Definition: widget_type.h:69
@ WWT_RESIZEBOX
Resize box (normally at bottom-right of a window)
Definition: widget_type.h:68
@ WWT_DEFSIZEBOX
Default window size box (at top-right of a window, between WWT_SHADEBOX and WWT_STICKYBOX)
Definition: widget_type.h:65
@ RWV_HIDE_BEVEL
Bevel of resize box is hidden.
Definition: widget_type.h:40

Definition at line 1951 of file newgrf_gui.cpp.

◆ _nested_save_preset_widgets

constexpr NWidgetPart _nested_save_preset_widgets[]
staticconstexpr
Initial value:
= {
NWidget(WWT_CLOSEBOX, COLOUR_GREY),
NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_SAVE_PRESET_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
NWidget(WWT_DEFSIZEBOX, COLOUR_GREY),
NWidget(WWT_PANEL, COLOUR_GREY),
NWidget(WWT_INSET, COLOUR_GREY, WID_SVP_PRESET_LIST), SetPadding(2, 1, 2, 2),
SetDataTip(0x0, STR_SAVE_PRESET_LIST_TOOLTIP), SetResize(1, 10), SetScrollbar(WID_SVP_SCROLLBAR), EndContainer(),
NWidget(WWT_PANEL, COLOUR_GREY),
NWidget(WWT_EDITBOX, COLOUR_GREY, WID_SVP_EDITBOX), SetPadding(2, 2, 2, 2), SetFill(1, 0), SetResize(1, 0),
SetDataTip(STR_SAVE_PRESET_TITLE, STR_SAVE_PRESET_EDITBOX_TOOLTIP),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SVP_CANCEL), SetDataTip(STR_SAVE_PRESET_CANCEL, STR_SAVE_PRESET_CANCEL_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
NWidget(WWT_PUSHTXTBTN, COLOUR_GREY, WID_SVP_SAVE), SetDataTip(STR_SAVE_PRESET_SAVE, STR_SAVE_PRESET_SAVE_TOOLTIP), SetFill(1, 0), SetResize(1, 0),
NWidget(WWT_RESIZEBOX, COLOUR_GREY),
}
constexpr NWidgetPart SetScrollbar(WidgetID index)
Attach a scrollbar to a widget.
Definition: widget_type.h:1284
@ WID_SVP_SAVE
Button to save the preset.
Definition: newgrf_widget.h:71
@ WID_SVP_PRESET_LIST
List with available preset names.
Definition: newgrf_widget.h:67
@ WID_SVP_SCROLLBAR
Scrollbar for the list available preset names.
Definition: newgrf_widget.h:68
@ WID_SVP_CANCEL
Button to cancel saving the preset.
Definition: newgrf_widget.h:70
@ WID_SVP_EDITBOX
Edit box for changing the preset name.
Definition: newgrf_widget.h:69
@ WWT_PUSHTXTBTN
Normal push-button (no toggle button) with text caption.
Definition: widget_type.h:112
@ WWT_INSET
Pressed (inset) panel, most commonly used as combo box text area.
Definition: widget_type.h:51
@ WWT_EDITBOX
a textbox for typing
Definition: widget_type.h:71
@ NWID_VSCROLLBAR
Vertical scrollbar.
Definition: widget_type.h:84

Widget parts of the save preset window.

Definition at line 2027 of file newgrf_gui.cpp.

◆ _nested_scan_progress_widgets

constexpr NWidgetPart _nested_scan_progress_widgets[]
staticconstexpr
Initial value:
= {
NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_NEWGRF_SCAN_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
NWidget(WWT_PANEL, COLOUR_GREY),
NWidget(WWT_LABEL, INVALID_COLOUR), SetDataTip(STR_NEWGRF_SCAN_MESSAGE, STR_NULL), SetFill(1, 0),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SP_PROGRESS_BAR), SetFill(1, 0),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_SP_PROGRESS_TEXT), SetFill(1, 0), SetMinimalSize(400, 0),
}
constexpr NWidgetPart SetPIP(uint8_t pre, uint8_t inter, uint8_t post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1260
constexpr NWidgetPart SetMinimalSize(int16_t x, int16_t y)
Widget part function for setting the minimal size.
Definition: widget_type.h:1137
@ WID_SP_PROGRESS_BAR
Simple progress bar.
Definition: newgrf_widget.h:76
@ WID_SP_PROGRESS_TEXT
Text explaining what is happening.
Definition: newgrf_widget.h:77
@ WWT_LABEL
Centered label.
Definition: widget_type.h:57
@ NWID_VERTICAL
Vertical container.
Definition: widget_type.h:77
@ WWT_EMPTY
Empty widget, place holder to reserve space in widget tree.
Definition: widget_type.h:48

Widgets for the progress window.

Definition at line 2185 of file newgrf_gui.cpp.