Blamite Game Engine - blam!  00263.10.17.20.0001.blamite
The core library for the Blamite Game Engine.
Classes | Namespaces | Macros | Functions
config.h File Reference
#include <map>
#include <string>

Go to the source code of this file.

Classes

struct  Blam::Config::ConfigOption
 Structure to contain data for an option within a Config file. More...
 
class  Blam::Config::ConfigFile
 Class to contain data related to a Config file. More...
 

Namespaces

 Blam
 Namespace surrounding all major engine components.
 
 Blam::Settings
 
 Blam::Settings::Config
 Namespace for anything related to engine configuration files.
 
 Blam::Config
 Namespace to contain anything related to Configuration files.
 

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
 

Functions

BLAM int Blam::Config::CheckDefaultConfig ()
 Checks if the default engine configuration file exists. More...
 
BLAM bool Blam::Config::IsDefaultConfigReady ()
 
BLAM int Blam::Config::LoadConfig (std::string filename)
 Loads a configuration file from the specified path. More...
 
BLAM int Blam::Config::LoadConfig (std::string filename, bool load_defaults)
 Loads a configuration file from the specified path. More...
 
BLAM int Blam::Config::LoadConfig (std::string filename, bool load_defaults, int defaults_resource_id)
 Loads a configuration file from the specified path. More...
 
BLAM int Blam::Config::LoadConfig (std::string filename, bool load_defaults, int defaults_resource_id, const char *defaults_res_type)
 Loads a configuration file from the specified path. More...
 
BLAM int Blam::Config::LoadConfig ()
 Loads the default engine configuration file (engine.cfg) More...
 
BLAM ConfigFile * Blam::Config::GetConfig (std::string filename)
 Retrieves the specified configuration file. More...
 
BLAM ConfigFile * Blam::Config::GetConfig ()
 Retrieves the default engine configuration file. More...
 
BLAM void Blam::Config::ApplyPlaceholdersToAllConfigFiles ()
 Applies placeholder values to all configuration files. More...
 
BLAM void Blam::Config::ExpandConfigOptionPlaceholders ()
 Expands all placeholders, and converts them to their evaluated values. More...
 
BLAM void Blam::Config::InsertConfigFile (ConfigFile config)
 Inserts a loaded ConfigFile into the map of loaded configuration files. More...
 
BLAM ConfigFile * Blam::Config::GetConfigData (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.