Blam::BuildInfo Namespace Reference

Namespace containing functions which provide engine build information. More...

Functions
BLAM BlamRuntimeConfiguration	GetCurrentRuntimeConfig ()
	Retrieves the current runtime configuration. More...
BLAM BlamContentSource	GetContentSource ()
	Retrieves the current content source. More...
BLAM BlamBuildType	GetBuildType ()
	Retrieves the current build type. More...
BLAM std::string	GetVersionBuildString (BlamVersionStringDisplayMode display_mode)
	Retrieves the build string of the engine. More...
BLAM std::string	GetBuildDateTime ()
	Retrieves the build date and time of the engine, pulled directly from the __DATE__ and __TIME__ macros. More...
BLAM std::string	GetReleaseType ()
	Retrieves the release type of the engine. More...

Detailed Description

Namespace containing functions which provide engine build information.

Function Documentation

GetBuildDateTime()

std::string Blam::BuildInfo::GetBuildDateTime

(

)

Retrieves the build date and time of the engine, pulled directly from the __DATE__ and __TIME__ macros.

Returns

The engine build date/time. Ex: Apr 14 2019 18:35:12

Here is the caller graph for this function:

GetBuildType()

BlamBuildType Blam::BuildInfo::GetBuildType

(

)

Retrieves the current build type.

This function allows for easier checking the build type of the engine - rather than checking the runtime configuration directly.

Returns

The current build type. See BlamBuildType for details.

Here is the call graph for this function:

GetContentSource()

BlamContentSource Blam::BuildInfo::GetContentSource

(

)

Retrieves the current content source.

When running under different runtime configurations, the engine will load content from loose tag files, or from cache files. For cases where we don't need the exact runtime configuration and simply need to know how to load content, we can use this as an easier check.

Returns

The current content source. See BlamContentSource for details.

Here is the call graph for this function:

Here is the caller graph for this function:

GetCurrentRuntimeConfig()

BlamRuntimeConfiguration Blam::BuildInfo::GetCurrentRuntimeConfig

(

)

Retrieves the current runtime configuration.

The value of this will depend on the configuration used to compile the engine. See BlamRuntimeConfiguration for details.

Returns

The current runtime configuration.

Here is the caller graph for this function:

GetReleaseType()

std::string Blam::BuildInfo::GetReleaseType

(

)

Retrieves the release type of the engine.

Returns

The engine release type.

Here is the call graph for this function:

Here is the caller graph for this function:

GetVersionBuildString()

std::string Blam::BuildInfo::GetVersionBuildString

(

BlamVersionStringDisplayMode

display_mode

)

Retrieves the build string of the engine.

The build string will be in the following format:

sapien debug pc 11122.07.08.24.1808.main Aug 24 2007 18:10:16

<product> <rel type> <platform> <version> <build date> <build time>

Parameters

display_mode

- The display mode to use for the string. See BlamVersionStringDisplayMode for details.

Returns

The build string.

Here is the call graph for this function:

Here is the caller graph for this function: