game_config_manager Class Reference

#include <game_config_manager.hpp>

Public Types
enum	FORCE_RELOAD_CONFIG { FORCE_RELOAD, NO_FORCE_RELOAD, NO_INCLUDE_RELOAD }

Public Member Functions
	game_config_manager (const commandline_options &cmdline_opts, const bool jump_to_editor)
	~game_config_manager ()
const config &	game_config () const
const preproc_map &	old_defines_map () const
const ter_data_cache &	terrain_types () const
bool	init_game_config (FORCE_RELOAD_CONFIG force_reload)
void	reload_changed_game_config ()
void	load_game_config_for_editor ()
void	load_game_config_for_game (const game_classification &classification)
void	load_game_config_for_create (bool is_mp, bool is_test=false)

Static Public Member Functions
static game_config_manager *	get ()

Private Member Functions
	game_config_manager (const game_config_manager &)
void	operator= (const game_config_manager &)
void	load_game_config (FORCE_RELOAD_CONFIG force_reload, game_classification const *classification=nullptr)
void	load_game_config_with_loadscreen (FORCE_RELOAD_CONFIG force_reload, game_classification const *classification=nullptr)
void	load_addons_cfg ()
void	set_multiplayer_hashes ()
void	set_unit_data ()

Private Attributes
const commandline_options &	cmdline_opts_
const bool	jump_to_editor_
config	game_config_
preproc_map	old_defines_map_
filesystem::binary_paths_manager	paths_manager_
game_config::config_cache &	cache_
ter_data_cache	tdata_

Detailed Description

Definition at line 25 of file game_config_manager.hpp.

Member Enumeration Documentation

FORCE_RELOAD_CONFIG

enum game_config_manager::FORCE_RELOAD_CONFIG

Enumerator
FORCE_RELOAD	Always reload config.
NO_FORCE_RELOAD	Don't reload if the previous defines equal the new defines.
NO_INCLUDE_RELOAD	Don't reload if the previous defines include the new defines.

Definition at line 30 of file game_config_manager.hpp.

Constructor & Destructor Documentation

game_config_manager() [1/2]

game_config_manager::game_config_manager	(	const commandline_options &	cmdline_opts,
		const bool	jump_to_editor
	)

Definition at line 49 of file game_config_manager.cpp.

References cache_, cmdline_opts_, commandline_options::nocache, game_config::config_cache::set_force_valid_cache(), game_config::config_cache::set_use_cache(), and commandline_options::validcache.

Referenced by terrain_types().

~game_config_manager()

game_config_manager::~game_config_manager

(

)

Definition at line 70 of file game_config_manager.cpp.

game_config_manager() [2/2]

game_config_manager::game_config_manager ( const game_config_manager &  )

private

Member Function Documentation

game_config()

const config& game_config_manager::game_config ( ) const

inline

Definition at line 40 of file game_config_manager.hpp.

References game_config_.

Referenced by saved_game::expand_scenario(), mp::game_info::game_info(), game_lua_kernel::impl_game_config_get(), game_lua_kernel::impl_game_config_set(), init_game_config(), mp::initial_level_config(), load_game_config(), and mp::start_client().

get()

game_config_manager * game_config_manager::get ( )

static

Definition at line 76 of file game_config_manager.cpp.

References singleton.

Referenced by replay_controller::add_replay_theme(), gui2::dialogs::title_screen::button_callback_cores(), movetype::terrain_info::data::calc_value(), ng::create_engine::create_engine(), events::chat_command_handler::do_display(), saved_game::expand_scenario(), gui2::dialogs::mp_join_game::fetch_game_config(), mp::game_info::game_info(), gui2::dialogs::title_screen::hotkey_callback_select_tests(), game_lua_kernel::impl_game_config_get(), game_lua_kernel::impl_game_config_set(), ng::create_engine::init_all_levels(), mp::initial_level_config(), intf_get_era(), game_launcher::launch_game(), game_launcher::load_game(), saved_game::load_mod(), help::load_terrain_types_data(), game_launcher::play_multiplayer(), game_launcher::play_multiplayer_commandline(), game_launcher::play_render_image_mode(), game_launcher::play_replay(), game_launcher::play_screenshot_mode(), game_launcher::play_test(), gui2::dialogs::mp_create_game::post_show(), gui2::dialogs::title_screen::pre_show(), ng::create_engine::prepare_for_saved_game(), gui2::dialogs::faction_select::profile_button_callback(), ng::scenario::set_metadata(), game_launcher::show_preferences(), preferences::show_theme_dialog(), game_launcher::single_unit_test(), mp::start_client(), game_launcher::start_editor(), and mp::start_local_game_commandline().

init_game_config()

bool game_config_manager::init_game_config

(

FORCE_RELOAD_CONFIG

force_reload

)

Definition at line 80 of file game_config_manager.cpp.

References config::child(), cmdline_opts_, hotkey::deactivate_all_scopes(), game_config::editor, game_config(), game_config_, lg::general(), ai::configuration::init(), init_textdomains(), jump_to_editor_, game_config::load_config(), load_game_config_with_loadscreen(), hotkey::load_hotkeys(), preferences::load_hotkeys(), commandline_options::mptest, commandline_options::multiplayer, game_config::reset_color_info(), hotkey::SCOPE_MAIN_MENU, about::set_about(), hotkey::set_scope_active(), and commandline_options::test.

Referenced by reload_changed_game_config(), and terrain_types().

load_addons_cfg()

void game_config_manager::load_addons_cfg ( )

private

Definition at line 349 of file game_config_manager.cpp.

References _n(), config::all_children_range(), config::append(), cache_, events::call_in_main_thread(), config::child_or_empty(), cmdline_opts_, preferences::core_id(), gui2::dialogs::wml_error::display(), e, config::empty(), filesystem::ENTIRE_FILE_PATH, lg::err(), ERR_CONFIG, filesystem::file_exists(), filesystem::FILE_NAME_ONLY, game_config_, get_addon_pbl_info(), filesystem::get_addons_dir(), game_config::config_cache::get_config(), filesystem::get_files_in_dir(), filesystem::get_wml_location(), have_addon_pbl_info(), utils::join(), log_config, log_scope2, game::error::message, invalid_pbl_exception::message, n, schema_validation::schema_validator::set_create_exceptions(), version_info::str(), and commandline_options::validate_addon.

Referenced by load_game_config(), and terrain_types().

load_game_config()

void game_config_manager::load_game_config ( FORCE_RELOAD_CONFIG  force_reload, game_classification const *  classification = nullptr  )

private

Definition at line 146 of file game_config_manager.cpp.

References _(), config::add_child(), game_config::add_color_info(), config::append(), cache_, events::call_in_main_thread(), game_classification::campaign, config::child_range(), config::clear_children(), cmdline_opts_, preferences::core_id(), create_cache, filesystem::data_tree_checksum(), gui2::dialogs::wml_error::display(), e, filesystem::ENTIRE_FILE_PATH, ERR_CONFIG, game_lua_kernel::extract_preload_scripts(), filesystem::file_exists(), config::find_child(), game_config(), game_config_, filesystem::get_addons_dir(), game_config::config_cache::get_config(), filesystem::get_files_in_dir(), game_config::config_cache::get_preproc_map(), filesystem::get_wml_location(), init_strings(), load_addons_cfg(), game_config::config_cache_transaction::lock(), game::error::message, game_config::no_addons, commandline_options::noaddons, old_defines_map_, game_config::path, paths_manager_, gui2::dialogs::loading_screen::progress(), preferences::set_core_id(), schema_validation::schema_validator::set_create_exceptions(), theme::set_known_themes(), set_multiplayer_hashes(), filesystem::binary_paths_manager::set_paths(), terrain_builder::set_terrain_rules_cfg(), set_unit_data(), config::splice_children(), tdata_, commandline_options::validate_core, and verify_cache.

Referenced by load_game_config_with_loadscreen(), and terrain_types().

load_game_config_for_create()

void game_config_manager::load_game_config_for_create	(	bool	is_mp,
		bool	is_test = false
	)

During an mp game the default difficuly define is also defined so better already load it now if we alreeady must reload config cache.

Definition at line 602 of file game_config_manager.cpp.

References cache_, game_config::config_cache::clear_defines(), cmdline_opts_, DEFAULT_DIFFICULTY, game_config::config_cache::get_preproc_map(), load_game_config_with_loadscreen(), commandline_options::mptest, NO_FORCE_RELOAD, NO_INCLUDE_RELOAD, and old_defines_map_.

Referenced by ng::create_engine::create_engine(), gui2::dialogs::title_screen::hotkey_callback_select_tests(), game_launcher::play_multiplayer(), and terrain_types().

load_game_config_for_editor()

void game_config_manager::load_game_config_for_editor

(

)

Definition at line 542 of file game_config_manager.cpp.

References game_config::editor, load_game_config_with_loadscreen(), and NO_FORCE_RELOAD.

Referenced by game_launcher::play_screenshot_mode(), game_launcher::start_editor(), and terrain_types().

load_game_config_for_game()

void game_config_manager::load_game_config_for_game

(

const game_classification &

classification

)

Definition at line 548 of file game_config_manager.cpp.

References cache_, events::call_in_main_thread(), game_classification::campaign_define, game_classification::campaign_xtra_defines, game_config::config_cache::clear_defines(), cmdline_opts_, game_classification::difficulty, preferences::era(), game_classification::era_define, image::flush_cache(), load_game_config_with_loadscreen(), game_classification::mod_defines, commandline_options::mptest, NO_FORCE_RELOAD, old_defines_map_, and game_classification::scenario_define.

Referenced by saved_game::expand_scenario(), gui2::dialogs::mp_join_game::fetch_game_config(), ng::create_engine::prepare_for_saved_game(), mp::start_client(), mp::start_local_game_commandline(), and terrain_types().

load_game_config_with_loadscreen()

void game_config_manager::load_game_config_with_loadscreen ( FORCE_RELOAD_CONFIG  force_reload, game_classification const *  classification = nullptr  )

private

Definition at line 125 of file game_config_manager.cpp.

References cache_, game_config::debug, gui2::dialogs::loading_screen::display(), config::empty(), game_config_, game_config::config_cache::get_preproc_map(), load_game_config(), game_config::mp_debug, NO_FORCE_RELOAD, NO_INCLUDE_RELOAD, and old_defines_map_.

Referenced by init_game_config(), load_game_config_for_create(), load_game_config_for_editor(), load_game_config_for_game(), and terrain_types().

old_defines_map()

const preproc_map& game_config_manager::old_defines_map ( ) const

inline

Definition at line 41 of file game_config_manager.hpp.

References old_defines_map_.

operator=()

void game_config_manager::operator= ( const game_config_manager &  )

private

Referenced by terrain_types().

reload_changed_game_config()

void game_config_manager::reload_changed_game_config

(

)

Definition at line 527 of file game_config_manager.cpp.

References cache_, filesystem::clear_binary_paths_cache(), sound::flush_cache(), image::flush_cache(), FORCE_RELOAD, init_game_config(), old_defines_map_, game_config::config_cache::recheck_filetree_checksum(), and refresh_addon_version_info_cache().

Referenced by gui2::dialogs::title_screen::button_callback_cores(), gui2::dialogs::title_screen::pre_show(), mp::start_client(), game_launcher::start_editor(), and terrain_types().

set_multiplayer_hashes()

void game_config_manager::set_multiplayer_hashes ( )

private

Definition at line 510 of file game_config_manager.cpp.

References config::add_child(), config::child_range(), game_config_, and config::hash().

Referenced by load_game_config(), and terrain_types().

set_unit_data()

void game_config_manager::set_unit_data ( )

private

Definition at line 518 of file game_config_manager.cpp.

References config::child(), game_config_, load_unit_types, config::merge_children(), gui2::dialogs::loading_screen::progress(), unit_type_data::set_config(), and unit_types.

Referenced by load_game_config(), and terrain_types().

terrain_types()

const ter_data_cache& game_config_manager::terrain_types ( ) const

inline

Definition at line 42 of file game_config_manager.hpp.

References resources::classification, game_config_manager(), init_game_config(), load_addons_cfg(), load_game_config(), load_game_config_for_create(), load_game_config_for_editor(), load_game_config_for_game(), load_game_config_with_loadscreen(), operator=(), reload_changed_game_config(), set_multiplayer_hashes(), set_unit_data(), and tdata_.

Referenced by movetype::terrain_info::data::calc_value(), and help::load_terrain_types_data().

Member Data Documentation

cache_

game_config::config_cache& game_config_manager::cache_

private

Definition at line 77 of file game_config_manager.hpp.

Referenced by game_config_manager(), load_addons_cfg(), load_game_config(), load_game_config_for_create(), load_game_config_for_game(), load_game_config_with_loadscreen(), and reload_changed_game_config().

cmdline_opts_

const commandline_options& game_config_manager::cmdline_opts_

private

Definition at line 68 of file game_config_manager.hpp.

Referenced by game_config_manager(), init_game_config(), load_addons_cfg(), load_game_config(), load_game_config_for_create(), and load_game_config_for_game().

game_config_

config game_config_manager::game_config_

private

Definition at line 71 of file game_config_manager.hpp.

Referenced by game_config(), init_game_config(), load_addons_cfg(), load_game_config(), load_game_config_with_loadscreen(), set_multiplayer_hashes(), and set_unit_data().

jump_to_editor_

const bool game_config_manager::jump_to_editor_

private

Definition at line 69 of file game_config_manager.hpp.

Referenced by init_game_config().

old_defines_map_

preproc_map game_config_manager::old_defines_map_

private

Definition at line 73 of file game_config_manager.hpp.

Referenced by load_game_config(), load_game_config_for_create(), load_game_config_for_game(), load_game_config_with_loadscreen(), old_defines_map(), and reload_changed_game_config().

paths_manager_

filesystem::binary_paths_manager game_config_manager::paths_manager_

private

Definition at line 75 of file game_config_manager.hpp.

Referenced by load_game_config().

tdata_

ter_data_cache game_config_manager::tdata_

private

Definition at line 79 of file game_config_manager.hpp.

Referenced by load_game_config(), and terrain_types().

---

The documentation for this class was generated from the following files:

• game_config_manager.hpp
• game_config_manager.cpp