 |
Blamite Game Engine - blam!
00357.06.18.22.0809.blamite
The core library for the Blamite Game Engine.
|
Go to the documentation of this file.
7 #include <Strings/components/settings/config/config.h>
12 #define CONFIG_VER "1"
13 #define CONFIG_COMMENT_DELIMETER "#"
14 #define CONFIG_DEFAULT_NAME "engine.cfg"
15 #define CONFIG_COLOR_NAME "console_colors.cfg"
22 #define ENGINE_CFG Blam::Config::GetConfig()
29 #define ENGINE_CFG_SECTION(section_name) Blam::Settings::Config::GetEngineConfiguration()->GetConfigurationSection(section_name)
36 #define ENGINE_DATA_PATH(path) Blam::Settings::Paths::GetEngineDataPath(path)
43 #define USER_DATA_PATH(path) Blam::Settings::Paths::GetUserDataPath(path)
102 namespace Settings::Config
123 namespace Settings::Paths
243 std::string
GetString(std::string option);
265 int GetInt(std::string option);
Namespace surrounding all major engine components.
Definition: blam_api.h:27
@ Screenshots
Directory used to store engine screenshots. Defaults to {DataRoot}/screenshots/.
BLAM BlamConfigurationFile * GetEngineConfiguration()
Definition: config.cpp:58
@ Mods
Directory storing user-created mod packages. Defaults to {DataRoot}/mods/.
@ Cache
The engine will load all content from cache files.
BLAM BlamUserDataFolder GetUserDataFolderFromString(std::string folder)
Attempts to convert a string to the equivalent user data folder.
Definition: paths.cpp:321
@ Reports
Directory used to store the latest report (log) files. Defaults to {DataRoot}/reports/.
BLAM std::string GetDefaultEngineDataPath(BlamEngineDataFolder folder)
Retrieves a default value of a given engine data directory.
Definition: paths.cpp:130
@ DataRoot
The root of all game engine data. Defaults to ./
std::string filename
The legacy configuration file name.
Definition: config.h:223
BLAM bool IsConfigurationAvailable(std::string filename)
Definition: config.cpp:94
@ Plugins
Directory used to store plugin files for use with the Editing Kit. Defaults to {DataRoot}/plugins/.
BLAM ConfigFile * GetConfig()
Retrieves the engine configuration file.
Definition: compat.cpp:5
BLAM std::string GetEngineDataPath(BlamEngineDataFolder folder)
Retrieves the configured value of a given engine directory.
Definition: paths.cpp:187
@ Fonts
Directory used for game engine fonts. Defaults to ./maps/fonts/
@ LogArchives
Directory used to store previous log archives. Defaults to {DataRoot}/logs/.
BLAM BlamConfigurationFile * GetConfiguration(std::string filename)
Definition: config.cpp:70
int GetInt(std::string option)
Retrieves an integer option from a configuration file.
Definition: compat.cpp:98
BlamEngineDataFolder
Enumerator listing all possible engine data folders.
Definition: config.h:59
ConfigFile(std::string _filename)
Prepares a new legacy configuration file.
Definition: compat.cpp:33
BLAM BlamResult LoadConfiguration(std::string filename)
Definition: config.cpp:16
#define BLAM
Definition: config.h:46
BLAM std::string GetDefaultUserDataPath(BlamUserDataFolder folder)
Retrieves a default value of a given user data directory.
Definition: paths.cpp:61
BLAM void ExpandFilePlaceholders(BlamConfigurationFile *file)
Definition: placeholder_expand.cpp:143
@ Tags
The engine will load all content from tags.
BlamUserDataFolder
Enumerator listing all possible user data folders.
Definition: config.h:84
BLAM std::string ParseFolderPlaceholders(std::string string)
Parses any engine/user data folder placeholders within a string.
Definition: paths.cpp:359
BLAM void ExpandAllPlaceholders()
Definition: config.cpp:106
BLAM std::map< std::string, BlamConfigurationFile * > * GetConfigurationFiles()
Definition: config.cpp:116
@ Resources
Directory containing other resources and data, usually string tables and globals. Defaults to ....
@ Maps
Directory used for storing built-in cache files. Defaults to ./maps/
bool GetBoolean(std::string option)
Retrieves a boolean option from a configuration file.
Definition: compat.cpp:38
@ DefaultConfigs
Directory containing default configuration files. Defaults to ./content/blam/default_configs/
sock planetquake com All rights reserved Quake III Arena is a registered trademark of id Inc This level may be electronically distributed only at NO CHARGE to the recipient in its current MUST include this txt file
Definition: chiropteraDM.txt:95
BLAM BlamResult LoadEngineConfiguration()
Definition: config.cpp:11
BLAM std::string GetUserDataPath(BlamUserDataFolder folder)
Retrieves the configured value of a given user directory.
Definition: paths.cpp:252
std::string GetString(std::string option)
Retrieves a string option from a configuration file.
Definition: compat.cpp:58
Data structure representing a legacy configuration file.
Definition: config.h:221
@ Gallery
Directory containing general-purpose images. Defaults to ./content/Gallery/
@ Content
Directory containing general-purpose resources. Defaults to ./content/
BLAM bool IsEngineConfigurationAvailable()
Definition: config.cpp:82
float GetFloat(std::string option)
Retrieves a float option from a configuration file.
Definition: compat.cpp:78
BLAM BlamEngineDataFolder GetEngineDataFolderFromString(std::string folder)
Attempts to convert a string to the equivalent engine data folder.
Definition: paths.cpp:340