3 Copyright (C) 2010-2013 kwolekr, Ryan Kwolek <kwolekr@minetest.net>
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU Lesser General Public License as published by
7 the Free Software Foundation; either version 2.1 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU Lesser General Public License for more details.
15 You should have received a copy of the GNU Lesser General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
29 MapSettingsManager is a centralized object for management (creating,
30 loading, storing, saving, etc.) of config settings related to the Map.
32 It has two phases: the initial r/w "gather and modify settings" state, and
33 the final r/o "read and save settings" state.
35 The typical use case is, in order, as follows:
36 - Create a MapSettingsManager object
37 - Try to load map metadata into it from the metadata file
38 - Manually view and modify the current configuration as desired through a
39 Settings-like interface
40 - When all modifications are finished, create a 'Parameters' object
41 containing the finalized, active parameters. This could be passed along
42 to whichever Map-related objects that may require it.
43 - Save these active settings to the metadata file when requested
45 class MapSettingsManager {
47 MapSettingsManager(Settings *user_settings,
48 const std::string &map_meta_path);
49 ~MapSettingsManager();
51 // Finalized map generation parameters
52 MapgenParams *mapgen_params = nullptr;
54 bool getMapSetting(const std::string &name, std::string *value_out);
56 bool getMapSettingNoiseParams(
57 const std::string &name, NoiseParams *value_out);
59 // Note: Map config becomes read-only after makeMapgenParams() gets called
60 // (i.e. mapgen_params is non-NULL). Attempts to set map config after
61 // params have been finalized will result in failure.
62 bool setMapSetting(const std::string &name,
63 const std::string &value, bool override_meta = false);
65 bool setMapSettingNoiseParams(const std::string &name,
66 const NoiseParams *value, bool override_meta = false);
70 MapgenParams *makeMapgenParams();
73 std::string m_map_meta_path;
74 Settings *m_map_settings;
75 Settings *m_user_settings;