Blam::Settings::Config Namespace Reference

Namespace for anything related to engine configuration files. More...

Functions
BLAM BlamResult	LoadEngineConfiguration ()
	Loads the default game engine configuration (engine.cfg). More...
BLAM BlamResult	LoadConfiguration (std::string filename)
	Loads a configuration file from a file path. More...
BLAM BlamResult	LoadConfiguration (std::string filename, std::string defaults_filename)
	Loads a configuration file from a file path. More...
BLAM BlamConfigurationFile *	GetEngineConfiguration ()
	Retrieves the main engine configuration file. More...
BLAM BlamConfigurationFile *	GetConfiguration (std::string filename)
	Retrieves a configuration file from a file path. More...
BLAM bool	IsEngineConfigurationAvailable ()
	Checks whether or not the main engine configuration is currently available. More...
BLAM bool	IsConfigurationAvailable (std::string filename)
	Checks whether or not a given configuration file is currently available. More...
BLAM void	ExpandAllPlaceholders ()
	Expands placeholders within all loaded configuration files. More...
BLAM void	ExpandFilePlaceholders (BlamConfigurationFile *file)
	Expands placeholders within a specific configuration file. More...
BLAM std::map< std::string, BlamConfigurationFile * > *	GetConfigurationFiles ()
	Retrieves the map of all loaded configuration files. More...

Detailed Description

Namespace for anything related to engine configuration files.

Function Documentation

ExpandAllPlaceholders()

void Blam::Settings::Config::ExpandAllPlaceholders

(

)

Expands placeholders within all loaded configuration files.

Deprecated:

Placeholders are no longer supported and will be removed in the future.

Here is the call graph for this function:

Here is the caller graph for this function:

ExpandFilePlaceholders()

void Blam::Settings::Config::ExpandFilePlaceholders

(

BlamConfigurationFile *

file

)

Expands placeholders within a specific configuration file.

Parameters

file	- The configuration file to expand placeholders within.

Deprecated:

Placeholders are no longer supported and will be removed in the future.

Here is the call graph for this function:

Here is the caller graph for this function:

GetConfiguration()

BlamConfigurationFile * Blam::Settings::Config::GetConfiguration

(

std::string

filename

)

Retrieves a configuration file from a file path.

Parameters

filename

- The file path of the desired configuration file. Note that this must EXACTLY match the path that was provided to LoadConfiguration() when the file was first loaded.

Returns

Pointer to the desired configuration file, or nullptr if the specified configuration file could not be found.

Here is the caller graph for this function:

GetConfigurationFiles()

std::map< std::string, BlamConfigurationFile * > * Blam::Settings::Config::GetConfigurationFiles

(

)

Retrieves the map of all loaded configuration files.

Returns

Pointer to the map of all loaded configuration files.

Here is the caller graph for this function:

GetEngineConfiguration()

BlamConfigurationFile * Blam::Settings::Config::GetEngineConfiguration

(

)

Retrieves the main engine configuration file.

Returns

Pointer to the engine configuration file, or nullptr if the engine config is not yet loaded or failed to load.

Here is the caller graph for this function:

IsConfigurationAvailable()

bool Blam::Settings::Config::IsConfigurationAvailable

(

std::string

filename

)

Checks whether or not a given configuration file is currently available.

Parameters

filename

- The file path of the desired configuration file. Note that this must EXACTLY match the path that was provided to LoadConfiguration() when the file was first loaded.

Returns

true if the specified configuration file is available, otherwise returns false.

IsEngineConfigurationAvailable()

bool Blam::Settings::Config::IsEngineConfigurationAvailable

(

)

Checks whether or not the main engine configuration is currently available.

Returns

true if the engine configuration is available, otherwise returns false.

LoadConfiguration() [1/2]

BlamResult Blam::Settings::Config::LoadConfiguration

(

std::string

filename

)

Loads a configuration file from a file path.

Parameters

filename

- The file path of the configuration file.

Returns

BlamResult::Success_OK if the config file was loaded successfully, otherwise returns an error code.

Here is the call graph for this function:

Here is the caller graph for this function:

LoadConfiguration() [2/2]

BlamResult Blam::Settings::Config::LoadConfiguration	(	std::string	filename,
		std::string	defaults_filename
	)

Loads a configuration file from a file path.

Parameters

filename	- The file path of the configuration file.
defaults_filename	- The file path of the configuration file which contains all default options.

Returns

BlamResult::Success_OK if the config file was loaded successfully, otherwise returns an error code.

Here is the call graph for this function:

LoadEngineConfiguration()

BlamResult Blam::Settings::Config::LoadEngineConfiguration

(

)

Loads the default game engine configuration (engine.cfg).

Returns

BlamResult::Success_OK if the config file was loaded successfully, otherwise returns an error code.

Here is the call graph for this function:

Here is the caller graph for this function: