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"

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.

static void	NewGRFConfirmationCallback (Window *w, bool confirmed)
	Callback function for the newgrf 'apply changes' confirmation window.

static void	ShowSavePresetWindow (const char *initial_text)
	Open the window for saving a preset.

void	ShowMissingContentWindow (const GRFConfig *list)
	Show the content list window with all missing grfs from the given list.

std::unique_ptr< NWidgetBase >	NewGRFDisplay ()
	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.

void	UpdateNewGRFScanStatus (uint num, const char *name)
	Update the NewGRF scan status.

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.

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.

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.

Typedef Documentation

◆ GrfIdMap

typedef std::map<uint32_t, const GRFConfig *> GrfIdMap

Map of grfid to the grf config.

Definition at line 583 of 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

c	Grf list to add.
grfid_map	Map to add them to.

Definition at line 590 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

Callback function for the newgrf 'apply changes' confirmation window.

Parameters

w	Window which is calling this callback
confirmed	boolean value, true when yes was clicked, false otherwise

Definition at line 1979 of file newgrf_gui.cpp.

References _gamelog, _grfconfig, NewGRFWindow::active_sel, NewGRFWindow::actives, NewGRFWindow::avails, CloseWindowByClass(), CopyGRFConfigList(), GUIList< T, P, F >::ForceRebuild(), GLAT_GRF, Gamelog::GRFUpdate(), Window::InvalidateData(), NewGRFWindow::modified, GRFConfig::next, NewGRFWindow::orig_list, ReInitAllWindows(), ReloadNewGRFData(), Gamelog::StartAction(), Gamelog::StopAction(), WC_BUILD_OBJECT, WC_GRF_PARAMETERS, and WC_TEXTFILE.

Referenced by NewGRFWindow::OnClick().

◆ NewGRFDisplay()

std::unique_ptr< NWidgetBase > NewGRFDisplay ( )

Construct nested container widget for managing the lists and the info panel of the NewGRF GUI.

Definition at line 1940 of file newgrf_gui.cpp.

References MakeNWidgets().

◆ OpenGRFParameterWindow()

void OpenGRFParameterWindow	(	bool	is_baseset,
		GRFConfig *	c,
		bool	editable
	)

Definition at line 550 of file newgrf_gui.cpp.

◆ ShowMissingContentWindow()

void ShowMissingContentWindow ( const GRFConfig * list )

Show the content list window with all missing grfs from the given list.

Parameters

list	The list of grfs to check for missing / not exactly matching ones.

Definition at line 1566 of file newgrf_gui.cpp.

References BSWAP32(), CONTENT_TYPE_NEWGRF, ContentInfo::DOES_NOT_EXIST, GRFConfig::flags, GCF_COMPATIBLE, GCS_NOT_FOUND, GRFConfig::GetName(), GRFIdentifier::grfid, HasBit(), GRFConfig::ident, ContentInfo::md5sum, GRFIdentifier::md5sum, ContentInfo::name, GRFConfig::next, GRFConfig::original_md5sum, ShowNetworkContentListWindow(), ContentInfo::state, GRFConfig::status, ContentInfo::type, and ContentInfo::unique_id.

Referenced by NewGRFWindow::OnClick().

◆ ShowNewGRFError()

void ShowNewGRFError ( )

Show the first NewGRF error we can find.

Definition at line 45 of file newgrf_gui.cpp.

References _grfconfig, INVALID_STRING_ID, GRFConfig::next, SetDParam(), SetDParamStr(), ShowErrorMessage(), WL_CRITICAL, and WL_ERROR.

Referenced by _GenerateWorld(), and InitializeWindowsAndCaches().

◆ ShowNewGRFInfo()

static void ShowNewGRFInfo	(	const GRFConfig *	c,
		const Rect &	r,
		bool	show_params
	)

static

Definition at line 71 of file newgrf_gui.cpp.

◆ ShowNewGRFSettings()

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

Setup the NewGRF gui.

Parameters

editable	allow the user to make changes to the grfconfig in the window
show_params	show information about what parameters are set for the grf files
exec_changes	if changes are made to the list (editable is true), apply these changes immediately or only update the list
config	pointer to a linked-list of grfconfig's that will be shown

Definition at line 2019 of file newgrf_gui.cpp.

References CloseWindowByClass(), and WC_GAME_OPTIONS.

Referenced by MenuClickSettings(), SaveLoadWindow::OnClick(), GenerateLandscapeWindow::OnClick(), SelectGameWindow::OnClick(), and NetworkGameWindow::OnClick().

◆ ShowNewGRFTextfileWindow()

void ShowNewGRFTextfileWindow	(	TextfileType	file_type,
		const GRFConfig *	c
	)

Definition at line 577 of file newgrf_gui.cpp.

◆ ShowSavePresetWindow()

static void ShowSavePresetWindow ( const char * initial_text )

static

Open the window for saving a preset.

Parameters

initial_text Initial text to display in the edit box, or nullptr.

Definition at line 2177 of file newgrf_gui.cpp.

References CloseWindowByClass(), and WC_SAVE_PRESET.

Referenced by NewGRFWindow::OnClick().

◆ UpdateNewGRFScanStatus()

void UpdateNewGRFScanStatus	(	uint	num,
		const char *	name
	)

Update the NewGRF scan status.

Parameters

num	The number of NewGRFs scanned so far.
name	The name of the last scanned NewGRF.

Definition at line 2285 of file newgrf_gui.cpp.

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

Referenced by GRFFileScanner::AddFile().

Variable Documentation

◆ _nested_newgrf_actives_widgets

constexpr NWidgetPart _nested_newgrf_actives_widgets[]

staticconstexpr

Definition at line 1809 of file newgrf_gui.cpp.

◆ _nested_newgrf_availables_widgets

constexpr NWidgetPart _nested_newgrf_availables_widgets[]

staticconstexpr

Definition at line 1864 of file newgrf_gui.cpp.

◆ _nested_newgrf_infopanel_widgets

constexpr NWidgetPart _nested_newgrf_infopanel_widgets[]

staticconstexpr

Definition at line 1897 of file newgrf_gui.cpp.

◆ _nested_newgrf_parameter_widgets

constexpr NWidgetPart _nested_newgrf_parameter_widgets[]

staticconstexpr

Definition at line 510 of file newgrf_gui.cpp.

◆ _nested_newgrf_widgets

constexpr NWidgetPart _nested_newgrf_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    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),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_MAUVE),
    NWidgetFunction(NewGRFDisplay), SetPadding(WidgetDimensions::unscaled.sparse_resize),
    
    NWidget(NWID_HORIZONTAL),
      NWidget(NWID_SPACER), SetFill(1, 0), SetResize(1, 0),
      NWidget(WWT_RESIZEBOX, COLOUR_MAUVE), SetDataTip(RWV_HIDE_BEVEL, STR_TOOLTIP_RESIZE),
    EndContainer(),
  EndContainer(),
}

Definition at line 1950 of file newgrf_gui.cpp.

◆ _nested_save_preset_widgets

constexpr NWidgetPart _nested_save_preset_widgets[]

staticconstexpr

Initial value:

= {
  NWidget(NWID_HORIZONTAL),
    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),
  EndContainer(),
  NWidget(WWT_PANEL, COLOUR_GREY),
    NWidget(NWID_HORIZONTAL),
      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(NWID_VSCROLLBAR, COLOUR_GREY, WID_SVP_SCROLLBAR),
    EndContainer(),
  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),
  EndContainer(),
  NWidget(NWID_HORIZONTAL),
    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),
  EndContainer(),
}

Widget parts of the save preset window.

Definition at line 2026 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(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_wide, 0), SetPadding(WidgetDimensions::unscaled.modalpopup),
      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),
    EndContainer(),
  EndContainer(),
}

Widgets for the progress window.

Definition at line 2184 of file newgrf_gui.cpp.

Data Structures

Typedefs

Functions

Variables

Detailed Description

Typedef Documentation

◆ GrfIdMap

Function Documentation

◆ FillGrfidMap()

◆ NewGRFConfirmationCallback()

◆ NewGRFDisplay()

◆ OpenGRFParameterWindow()

◆ ShowMissingContentWindow()

◆ ShowNewGRFError()

◆ ShowNewGRFInfo()

◆ ShowNewGRFSettings()

◆ ShowNewGRFTextfileWindow()

◆ ShowSavePresetWindow()

◆ UpdateNewGRFScanStatus()

Variable Documentation

◆ _nested_newgrf_actives_widgets

◆ _nested_newgrf_availables_widgets

◆ _nested_newgrf_infopanel_widgets

◆ _nested_newgrf_parameter_widgets

◆ _nested_newgrf_widgets

◆ _nested_save_preset_widgets

◆ _nested_scan_progress_widgets