 |
Blamite Game Engine - blam!
00423.10.27.24.0533.blamite
The core library for the Blamite Game Engine.
|
Go to the documentation of this file.
11 #define MENUBAR_FILE "menu_bar_init.xml"
58 std::vector<BlamMenubarItem>
items;
71 color = BlamColor(255, 255, 255, 255);
84 std::vector<BlamMenubarItem>
items;
void verify_engine_folder_mappings()
Definition: paths.cpp:28
@ Screenshots
Directory used to store engine screenshots. Defaults to {DataRoot}/screenshots/.
BLAM BlamConfigurationFile * GetEngineConfiguration()
Retrieves the main engine configuration file.
Definition: config.cpp:60
@ Mods
Directory storing user-created mod packages. Defaults to {DataRoot}/mods/.
BLAM std::string LookupString(std::string id)
Finds a string with a given ID.
Definition: engine_text.cpp:34
#define ENGINE_CFG_SECTION(section_name)
Macro to quickly access a configuration section from the engine configuration file.
Definition: config.h:27
BLAM BlamUserDataFolder GetUserDataFolderFromString(std::string folder)
Attempts to convert a string to the equivalent user data folder.
Definition: paths.cpp:350
@ 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:139
BLAM void LogEvent(std::string message)
Logs a message to the log and/or console.
Definition: aliases.cpp:130
@ DataRoot
The root of all game engine data. Defaults to ./
@ Extensions
Directory storing user-created extensions. Defaults to {DataRoot}/extensions/.
@ Tags
Directory used for reading engine tags. Defaults to ./tags/
@ Plugins
Directory used to store customized plugin files for use with the Editing Kit. Defaults to {DataRoot}/...
#define USER_DATA_PATH(path)
Macro to quickly access a user data folder.
Definition: config.h:41
BLAM std::string GetEngineDataPath(BlamEngineDataFolder folder)
Retrieves the configured value of a given engine directory.
Definition: paths.cpp:211
@ Fonts
Directory used for game engine fonts. Defaults to ./maps/fonts/
@ LogArchives
Directory used to store previous log archives. Defaults to {DataRoot}/logs/.
BlamEngineDataFolder
Enumerator listing all possible engine data folders.
Definition: config.h:57
@ Cache
Directory used to store any cached data used by the engine (not to be confused with ....
std::map< BlamUserDataFolder, std::string > user_folder_mappings
Definition: paths.cpp:8
BLAM std::string GetDefaultUserDataPath(BlamUserDataFolder folder)
Retrieves a default value of a given user data directory.
Definition: paths.cpp:65
@ Movies
Directory used to store video files, typically played at startup, credits, etc. Defaults to ....
BlamUserDataFolder
Enumerator listing all possible user data folders.
Definition: config.h:85
BLAM bool StringExists(std::string id)
Looks through the list of loaded engine strings to see if a given string has been loaded.
Definition: engine_text.cpp:68
std::string verify_path(std::string _path)
Definition: paths.cpp:46
#define ENGINE_DATA_PATH(path)
Macro to quickly access a game engine data folder.
Definition: config.h:34
std::map< BlamEngineDataFolder, std::string > engine_folder_mappings
Definition: paths.cpp:9
BLAM std::string ParseFolderPlaceholders(std::string string)
Parses any engine/user data folder placeholders within a string.
Definition: paths.cpp:388
@ Resources
Directory containing other resources and data, usually string tables and globals. Defaults to ....
@ Maps
Directory storing user-installed cache files. Defaults to {DataRoot}/maps/.
void verify_user_folder_mappings()
Definition: paths.cpp:11
@ Extensions
Directory used for engine extensions. Defaults to ./extensions/
@ Maps
Directory used for storing built-in cache files. Defaults to ./maps/
@ DefaultConfigs
Directory containing default configuration files. Defaults to ./content/blam/default_configs/
@ Undefined
Unknown pass type. Usually indicates an error.
@ Plugins
Directory used to store built-in plugin files for use with the Editing Kit. Defaults to ....
BLAM std::string GetUserDataPath(BlamUserDataFolder folder)
Retrieves the configured value of a given user directory.
Definition: paths.cpp:281
@ DataRoot
The root of all user data. Defaults to BlamStrings::Utils::IO::GetEngineDataRoot().
@ Gallery
Directory containing general-purpose images. Defaults to ./content/Gallery/
@ Content
Directory containing general-purpose resources. Defaults to ./content/
@ Tags
Directory storing user-created tags. Defaults to {DataRoot}/tags/.
BLAM BlamEngineDataFolder GetEngineDataFolderFromString(std::string folder)
Attempts to convert a string to the equivalent engine data folder.
Definition: paths.cpp:369