 |
Blamite Game Engine - blam!
00406.12.10.23.1457.blamite
The core library for the Blamite Game Engine.
|
Go to the documentation of this file.
6 #define PLACEHOLDERS_FILE_NAME "placeholders.xml"
@ Default
Indicates the build string should use the default format.
BLAM BlamConfigurationFile * GetEngineConfiguration()
Retrieves the main engine configuration file.
Definition: config.cpp:58
std::string id
The ID of the placeholder.
Definition: placeholders.h:35
BLAM void LogEvent(std::string message)
Logs a message to the log and/or console.
Definition: aliases.cpp:130
std::string value_parsed
The value of the placeholder after having environment variables expanded.
Definition: placeholders.h:37
bool reserved
Whether or not the placeholder's value is reserved and unmodifiable.
Definition: placeholders.h:38
#define BLAM
Definition: placeholders.h:9
bool parse_env_var
Whether or not to parse environment variables from the placeholder.
Definition: placeholders.h:39
@ TextLog
Indicates the build string should be formatted for plain text log files.
BLAM std::string ApplyPlaceholders(std::string string)
Replaces any and all placeholder tags in the specified string with their evaulated values.
Definition: placeholders.cpp:21
Namespace containing things related to the Placeholders system.
Definition: placeholders.h:28
BLAM Placeholder GetAt(int i)
Retrieves the placeholder at the specified index.
Definition: placeholders.cpp:42
#define PLACEHOLDERS_FILE_NAME
The file to read placeholder information from.
Definition: placeholders.h:6
@ Console
Indicates the build string should be formatted for the in-game console.
const BLAM char * GetCacheDirectory()
Retrieves the directory from which to load game levels.
Definition: engine_definitions.cpp:186
BLAM int LoadPlaceholders()
Load placeholder data from placeholders.xml.
Definition: placeholders.cpp:66
const BLAM char * GetBinkDirectory()
Retrieves the directory to read movies from.
Definition: engine_definitions.cpp:191
BLAM std::string GetVersionBuildString(BlamVersionStringDisplayMode display_mode)
Retrieves the build string of the engine.
Definition: engine_definitions.cpp:53
const BLAM char * GetPlatform()
Retrieves the target platform of the engine.
Definition: engine_definitions.cpp:180
Structure to contain Placeholder data.
Definition: placeholders.h:33
#define ENGINE_CFG
Macro to allow quicker access to the main configuration file.
Definition: config.h:20
const BLAM char * GameAffiliates()
Retrieves the game affiliates string.
Definition: engine_definitions.cpp:257
const BLAM char * GetVersion()
Retrieves the version of the engine in the following format:
Definition: engine_definitions.cpp:150
BLAM std::string GetBuildDateTime()
Retrieves the build date and time of the engine, pulled directly from the __DATE__ and __TIME__ macro...
Definition: engine_definitions.cpp:170
@ CrashScreen
Indicates the build string should be formatted for the crash screen.
void AddReservedPlaceholder(std::string id, std::string value)
Adds a reserved placeholder to the placeholder list.
Definition: placeholders.cpp:53
const BLAM char * GameDeveloper()
Retrieves the game developer.
Definition: engine_definitions.cpp:252
BLAM void ExpandAllPlaceholders()
Expands placeholders within all loaded configuration files.
Definition: config.cpp:106
const BLAM char * GetProductID()
Retrieves the product ID of the engine.
Definition: engine_definitions.cpp:155
BLAM int GetCount()
Retrieves the amount of placeholders loaded.
Definition: placeholders.cpp:37
std::vector< Blam::Placeholders::Placeholder > placeholders
The list of loaded placeholders.
Definition: placeholders.cpp:19
const BLAM char * GetBuildDate()
Retrieves the build date of the engine, pulled directly from the __DATE__ macro.
Definition: engine_definitions.cpp:160
const BLAM char * GameTitle()
Retrieves the game title.
Definition: engine_definitions.cpp:242
const BLAM char * GameCopyright()
Retrieves the game copyright string.
Definition: engine_definitions.cpp:262
const BLAM char * GetReleaseType()
Retrieves the release type of the engine.
Definition: engine_definitions.cpp:196
std::string value_raw
The raw value of the placeholder.
Definition: placeholders.h:36
const BLAM char * GamePublisher()
Retrieves the game publisher.
Definition: engine_definitions.cpp:247
1.8.17