OpenTTD
Data Structures | Enumerations | Functions | Variables
genworld_gui.cpp File Reference

GUI to configure and show progress during map generation. More...

#include "stdafx.h"
#include "heightmap.h"
#include "debug.h"
#include "genworld.h"
#include "network/network.h"
#include "strings_func.h"
#include "window_func.h"
#include "date_func.h"
#include "sound_func.h"
#include "fios.h"
#include "string_func.h"
#include "widgets/dropdown_type.h"
#include "widgets/dropdown_func.h"
#include "querystring_gui.h"
#include "town.h"
#include "core/geometry_func.hpp"
#include "core/random_func.hpp"
#include "saveload/saveload.h"
#include "progress.h"
#include "error.h"
#include "widgets/genworld_widget.h"
#include "safeguards.h"

Go to the source code of this file.

Data Structures

struct  GenerateLandscapeWindow
 
struct  CreateScenarioWindow
 
struct  GenWorldStatus
 
struct  GenerateProgressWindow
 

Enumerations

enum  GenerateLandscapeWindowMode { GLWM_GENERATE, GLWM_HEIGHTMAP, GLWM_SCENARIO }
 Enum for the modes we can generate in. More...
 

Functions

void MakeNewgameSettingsLive ()
 
void SetNewLandscapeType (byte landscape)
 Changes landscape type and sets genworld window dirty. More...
 
static void StartGeneratingLandscape (GenerateLandscapeWindowMode mode)
 
static void LandscapeGenerationCallback (Window *w, bool confirmed)
 
static DropDownListBuildMapsizeDropDown ()
 
 assert_compile (lengthof(_num_inds)==ID_END+1)
 
static void _ShowGenerateLandscape (GenerateLandscapeWindowMode mode)
 
void ShowGenerateLandscape ()
 Start with a normal game. More...
 
void ShowHeightmapLoad ()
 Start with loading a heightmap. More...
 
void StartScenarioEditor ()
 Start with a scenario editor. More...
 
void StartNewGameWithoutGUI (uint seed)
 Start a normal game without the GUI. More...
 
void ShowCreateScenario ()
 Show the window to create a scenario. More...
 
 assert_compile (lengthof(_generation_class_table)==GWP_CLASS_COUNT)
 
static void AbortGeneratingWorldCallback (Window *w, bool confirmed)
 
void PrepareGenerateWorldProgress ()
 Initializes the progress counters to the starting point.
 
void ShowGenerateWorldProgress ()
 Show the window where a user can follow the process of the map generation.
 
static void _SetGeneratingWorldProgress (GenWorldProgress cls, uint progress, uint total)
 
void SetGeneratingWorldProgress (GenWorldProgress cls, uint total)
 Set the total of a stage of the world generation. More...
 
void IncreaseGeneratingWorldProgress (GenWorldProgress cls)
 Increases the current stage of the world generation with one. More...
 

Variables

static const NWidgetPart _nested_generate_landscape_widgets []
 Widgets of GenerateLandscapeWindow when generating world.
 
static const NWidgetPart _nested_heightmap_load_widgets []
 Widgets of GenerateLandscapeWindow when loading heightmap.
 
static const StringID _elevations [] = {STR_TERRAIN_TYPE_VERY_FLAT, STR_TERRAIN_TYPE_FLAT, STR_TERRAIN_TYPE_HILLY, STR_TERRAIN_TYPE_MOUNTAINOUS, STR_TERRAIN_TYPE_ALPINIST, INVALID_STRING_ID}
 
static const StringID _sea_lakes [] = {STR_SEA_LEVEL_VERY_LOW, STR_SEA_LEVEL_LOW, STR_SEA_LEVEL_MEDIUM, STR_SEA_LEVEL_HIGH, STR_SEA_LEVEL_CUSTOM, INVALID_STRING_ID}
 
static const StringID _rivers [] = {STR_RIVERS_NONE, STR_RIVERS_FEW, STR_RIVERS_MODERATE, STR_RIVERS_LOT, INVALID_STRING_ID}
 
static const StringID _smoothness [] = {STR_CONFIG_SETTING_ROUGHNESS_OF_TERRAIN_VERY_SMOOTH, STR_CONFIG_SETTING_ROUGHNESS_OF_TERRAIN_SMOOTH, STR_CONFIG_SETTING_ROUGHNESS_OF_TERRAIN_ROUGH, STR_CONFIG_SETTING_ROUGHNESS_OF_TERRAIN_VERY_ROUGH, INVALID_STRING_ID}
 
static const StringID _tree_placer [] = {STR_CONFIG_SETTING_TREE_PLACER_NONE, STR_CONFIG_SETTING_TREE_PLACER_ORIGINAL, STR_CONFIG_SETTING_TREE_PLACER_IMPROVED, INVALID_STRING_ID}
 
static const StringID _rotation [] = {STR_CONFIG_SETTING_HEIGHTMAP_ROTATION_COUNTER_CLOCKWISE, STR_CONFIG_SETTING_HEIGHTMAP_ROTATION_CLOCKWISE, INVALID_STRING_ID}
 
static const StringID _landscape [] = {STR_CONFIG_SETTING_LAND_GENERATOR_ORIGINAL, STR_CONFIG_SETTING_LAND_GENERATOR_TERRA_GENESIS, INVALID_STRING_ID}
 
static const StringID _num_towns [] = {STR_NUM_VERY_LOW, STR_NUM_LOW, STR_NUM_NORMAL, STR_NUM_HIGH, STR_NUM_CUSTOM, INVALID_STRING_ID}
 
static const StringID _num_inds [] = {STR_FUNDING_ONLY, STR_MINIMAL, STR_NUM_VERY_LOW, STR_NUM_LOW, STR_NUM_NORMAL, STR_NUM_HIGH, INVALID_STRING_ID}
 
static const StringID _variety [] = {STR_VARIETY_NONE, STR_VARIETY_VERY_LOW, STR_VARIETY_LOW, STR_VARIETY_MEDIUM, STR_VARIETY_HIGH, STR_VARIETY_VERY_HIGH, INVALID_STRING_ID}
 
static WindowDesc _generate_landscape_desc (WDP_CENTER, NULL, 0, 0, WC_GENERATE_LANDSCAPE, WC_NONE, 0, _nested_generate_landscape_widgets, lengthof(_nested_generate_landscape_widgets))
 
static WindowDesc _heightmap_load_desc (WDP_CENTER, NULL, 0, 0, WC_GENERATE_LANDSCAPE, WC_NONE, 0, _nested_heightmap_load_widgets, lengthof(_nested_heightmap_load_widgets))
 
static const NWidgetPart _nested_create_scenario_widgets []
 
static WindowDesc _create_scenario_desc (WDP_CENTER, NULL, 0, 0, WC_GENERATE_LANDSCAPE, WC_NONE, 0, _nested_create_scenario_widgets, lengthof(_nested_create_scenario_widgets))
 
static const NWidgetPart _nested_generate_progress_widgets []
 
static WindowDesc _generate_progress_desc (WDP_CENTER, NULL, 0, 0, WC_MODAL_PROGRESS, WC_NONE, 0, _nested_generate_progress_widgets, lengthof(_nested_generate_progress_widgets))
 
static GenWorldStatus _gws
 
static const StringID _generation_class_table []
 

Detailed Description

GUI to configure and show progress during map generation.

Definition in file genworld_gui.cpp.

Enumeration Type Documentation

◆ GenerateLandscapeWindowMode

Enum for the modes we can generate in.

Enumerator
GLWM_GENERATE 

Generate new game.

GLWM_HEIGHTMAP 

Load from heightmap.

GLWM_SCENARIO 

Generate flat land.

Definition at line 41 of file genworld_gui.cpp.

Function Documentation

◆ IncreaseGeneratingWorldProgress()

void IncreaseGeneratingWorldProgress ( GenWorldProgress  cls)

Increases the current stage of the world generation with one.

Parameters
clsthe current class we are in.

Warning: this function isn't clever. Don't go from class 4 to 3. Go upwards, always. Also, progress works if total is zero, total works if progress is zero.

Definition at line 1354 of file genworld_gui.cpp.

Referenced by CreateRivers(), and GenerateTerrainPerlin().

◆ SetGeneratingWorldProgress()

void SetGeneratingWorldProgress ( GenWorldProgress  cls,
uint  total 
)

Set the total of a stage of the world generation.

Parameters
clsthe current class we are in.
totalSet the total expected items for this class.

Warning: this function isn't clever. Don't go from class 4 to 3. Go upwards, always. Also, progress works if total is zero, total works if progress is zero.

Definition at line 1340 of file genworld_gui.cpp.

Referenced by CreateRivers().

◆ SetNewLandscapeType()

void SetNewLandscapeType ( byte  landscape)

Changes landscape type and sets genworld window dirty.

Parameters
landscapenew landscape type

Definition at line 51 of file genworld_gui.cpp.

References _settings_newgame, GameSettings::game_creation, InvalidateWindowClassesData(), GameCreationSettings::landscape, WC_GENERATE_LANDSCAPE, and WC_SELECT_GAME.

Referenced by GenerateLandscapeWindow::OnClick(), and CreateScenarioWindow::OnClick().

◆ ShowCreateScenario()

void ShowCreateScenario ( )

Show the window to create a scenario.

Definition at line 1120 of file genworld_gui.cpp.

References DeleteWindowByClass(), GLWM_SCENARIO, and WC_GENERATE_LANDSCAPE.

◆ ShowGenerateLandscape()

void ShowGenerateLandscape ( )

Start with a normal game.

Definition at line 852 of file genworld_gui.cpp.

Referenced by SelectGameWindow::OnClick().

◆ ShowHeightmapLoad()

void ShowHeightmapLoad ( )

Start with loading a heightmap.

Definition at line 858 of file genworld_gui.cpp.

◆ StartNewGameWithoutGUI()

void StartNewGameWithoutGUI ( uint  seed)

Start a normal game without the GUI.

Parameters
seedThe seed of the new game.

Definition at line 873 of file genworld_gui.cpp.

References _settings_newgame, GameSettings::game_creation, and GameCreationSettings::generation_seed.

Referenced by NetworkCheckRestartMap(), and SelectGameWindow::OnClick().

◆ StartScenarioEditor()

void StartScenarioEditor ( )

Start with a scenario editor.

Definition at line 864 of file genworld_gui.cpp.

Referenced by SelectGameWindow::OnClick().

Variable Documentation

◆ _generation_class_table

const StringID _generation_class_table[]
static
Initial value:
= {
STR_GENERATION_WORLD_GENERATION,
STR_SCENEDIT_TOOLBAR_LANDSCAPE_GENERATION,
STR_GENERATION_RIVER_GENERATION,
STR_GENERATION_CLEARING_TILES,
STR_SCENEDIT_TOOLBAR_TOWN_GENERATION,
STR_SCENEDIT_TOOLBAR_INDUSTRY_GENERATION,
STR_GENERATION_OBJECT_GENERATION,
STR_GENERATION_TREE_GENERATION,
STR_GENERATION_SETTINGUP_GAME,
STR_GENERATION_PREPARING_TILELOOP,
STR_GENERATION_PREPARING_SCRIPT,
STR_GENERATION_PREPARING_GAME
}

Definition at line 1157 of file genworld_gui.cpp.

◆ _nested_generate_progress_widgets

const NWidgetPart _nested_generate_progress_widgets[]
static
Initial value:
= {
NWidget(WWT_CAPTION, COLOUR_GREY), SetDataTip(STR_GENERATION_WORLD, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
NWidget(WWT_PANEL, COLOUR_GREY),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GP_PROGRESS_BAR), SetFill(1, 0),
NWidget(WWT_EMPTY, INVALID_COLOUR, WID_GP_PROGRESS_TEXT), SetFill(1, 0),
NWidget(WWT_TEXTBTN, COLOUR_WHITE, WID_GP_ABORT), SetDataTip(STR_GENERATION_ABORT, STR_NULL), SetFill(1, 0),
}
Empty widget, place holder to reserve space in widget array.
Definition: widget_type.h:48
Progress bar.
Horizontal container.
Definition: widget_type.h:75
Text with the progress bar.
static NWidgetPart SetDataTip(uint32 data, StringID tip)
Widget part function for setting the data and tooltip.
Definition: widget_type.h:1014
Simple depressed panel.
Definition: widget_type.h:50
static NWidgetPart NWidget(WidgetType tp, Colours col, int16 idx=-1)
Widget part function for starting a new 'real' widget.
Definition: widget_type.h:1114
Window caption (window title between closebox and stickybox)
Definition: widget_type.h:61
Abort button.
Vertical container.
Definition: widget_type.h:77
static NWidgetPart EndContainer()
Widget part function for denoting the end of a container (horizontal, vertical, WWT_FRAME, WWT_INSET, or WWT_PANEL).
Definition: widget_type.h:999
static NWidgetPart SetFill(uint fill_x, uint fill_y)
Widget part function for setting filling.
Definition: widget_type.h:983
static NWidgetPart SetPIP(uint8 pre, uint8 inter, uint8 post)
Widget part function for setting a pre/inter/post spaces.
Definition: widget_type.h:1076
(Toggle) Button with text
Definition: widget_type.h:55

Definition at line 1126 of file genworld_gui.cpp.