config.h File Reference

#include <map>
#include <string>
#include <Windows.h>
#include "components/resources/engine_globals/globals.h"
#include "components/diagnostics/errors/errors.h"

Go to the source code of this file.

Classes
class	BlamConfigurationSetting
	Class representing a configuration setting. More...
class	BlamConfigurationSection
	Structure representing a configuration section. More...
class	BlamConfigurationFile
struct	Blam::Config::ConfigFile

Namespaces
	Blam
	Namespace surrounding all major engine components.
	Blam::Settings
	Blam::Settings::Config
	Namespace for anything related to engine configuration files.
	Blam::Config
	Namespace for legacy configuration compatiability.

Macros
#define	CONFIG_VER   "1"
	The current version of the main engine configuration. More...
#define	CONFIG_COMMENT_DELIMETER   "#"
	The character that indicates a commented-out line. More...
#define	CONFIG_DEFAULT_NAME   "engine.cfg"
	The filename of the default engine configuration. More...
#define	CONFIG_COLOR_NAME   "console_colors.cfg"
	The filename of the default console color configuration. More...
#define	ENGINE_CFG   Blam::Config::GetConfig()
	Macro to allow quicker access to the main configuration file. More...
#define	BLAM

Enumerations
enum	BlamConfigurationSettingType {   BlamConfigurationSettingType::String, BlamConfigurationSettingType::Boolean, BlamConfigurationSettingType::Float, BlamConfigurationSettingType::Int,   BlamConfigurationSettingType::Color, BlamConfigurationSettingType::Comment }

Functions
BLAM BlamResult	Blam::Settings::Config::LoadEngineConfiguration ()
BLAM BlamResult	Blam::Settings::Config::LoadConfiguration (std::string filename)
BLAM BlamResult	Blam::Settings::Config::LoadConfiguration (std::string filename, int defaults_resource_id)
BLAM BlamResult	Blam::Settings::Config::LoadConfiguration (std::string filename, int defaults_resource_id, std::string defaults_resource_type)
BLAM BlamResult	Blam::Settings::Config::LoadConfiguration (std::string filename, HMODULE dll_handle, int defaults_resource_id)
BLAM BlamResult	Blam::Settings::Config::LoadConfiguration (std::string filename, HMODULE dll_handle, int defaults_resource_id, std::string defaults_resource_type)
BLAM BlamConfigurationFile *	Blam::Settings::Config::GetEngineConfiguration ()
BLAM BlamConfigurationFile *	Blam::Settings::Config::GetConfiguration (std::string filename)
BLAM bool	Blam::Settings::Config::IsEngineConfigurationAvailable ()
BLAM bool	Blam::Settings::Config::IsConfigurationAvailable (std::string filename)
BLAM void	Blam::Settings::Config::ExpandAllPlaceholders ()
BLAM std::map< std::string, BlamConfigurationFile > *	Blam::Settings::Config::GetConfigurationFiles ()
BLAM ConfigFile *	Blam::Config::GetConfig ()
	Retrieves the default engine configuration file. More...
BLAM ConfigFile *	Blam::Config::GetConfig (std::string filename)
	Retrieves the specified configuration file. More...

Macro Definition Documentation

BLAM

#define BLAM

CONFIG_COLOR_NAME

#define CONFIG_COLOR_NAME   "console_colors.cfg"

The filename of the default console color configuration.

CONFIG_COMMENT_DELIMETER

#define CONFIG_COMMENT_DELIMETER   "#"

The character that indicates a commented-out line.

CONFIG_DEFAULT_NAME

#define CONFIG_DEFAULT_NAME   "engine.cfg"

The filename of the default engine configuration.

CONFIG_VER

#define CONFIG_VER   "1"

The current version of the main engine configuration.

ENGINE_CFG

#define ENGINE_CFG   Blam::Config::GetConfig()

Macro to allow quicker access to the main configuration file.

Deprecated:

Will be removed in the future, only works using legacy configuration system.

Enumeration Type Documentation

BlamConfigurationSettingType

enum BlamConfigurationSettingType

strong

Enumerator
String
Boolean
Float
Int
Color
Comment