BuildSettings Namespace Reference

Functions
bool	IsLicenseeVersion ()
int	GetEngineVersionMajor ()
int	GetEngineVersionMinor ()
int	GetEngineVersionHotfix ()
const TCHAR *	GetEngineVersionString ()
int	GetCurrentChangelist ()
int	GetCompatibleChangelist ()
const TCHAR *	GetBranchName ()
const TCHAR *	GetBuildDate ()
const TCHAR *	GetBuildTime ()
const TCHAR *	GetBuildVersion ()
bool	IsPromotedBuild ()
bool	IsWithDebugInfo ()
const TCHAR *	GetBuildURL ()
const TCHAR *	GetBuildUser ()
const TCHAR *	GetBuildUserDomain ()
const TCHAR *	GetBuildMachine ()
const TCHAR *	GetLiveCodingEngineDir ()
const TCHAR *	GetLiveCodingProject ()
uint64	GetPersistentAllocatorReserveSize ()
const char *	GetVfsPaths ()
const TCHAR *	GetVfsPathsWide ()

Function Documentation

GetBranchName()

const TCHAR * BuildSettings::GetBranchName

(

)

The branch that this program is being built from.

Returns

Name of the current branch, with slashes escaped as '+' characters.

GetBuildDate()

const TCHAR * BuildSettings::GetBuildDate

(

)

The date timestamp of this build. Derived from the compiler's DATE macro, so only updated when the BuildSettings module is rebuilt (ie. whenever CL changes, etc...)

Returns

String representing the build timestamp

GetBuildMachine()

const TCHAR * BuildSettings::GetBuildMachine

(

)

Returns the name of the machine which created these binaries

GetBuildTime()

const TCHAR * BuildSettings::GetBuildTime

(

)

The time timestamp of this build. Derived from the compiler's TIME macro, so only updated when the BuildSettings module is rebuilt (ie. whenever CL changes, etc...)

Returns

String representing the build timestamp

GetBuildURL()

const TCHAR * BuildSettings::GetBuildURL

(

)

Returns a URL where the job which created these binaries on an automation system (e.g. Horde) can be found, or an empty string.

GetBuildUser()

const TCHAR * BuildSettings::GetBuildUser

(

)

Returns the name of the user which created these binaries

GetBuildUserDomain()

const TCHAR * BuildSettings::GetBuildUserDomain

(

)

Returns the domain name of the user which created these binaries

GetBuildVersion()

const TCHAR * BuildSettings::GetBuildVersion

(

)

Retrieves the user-defined build version for this application.

Returns

The current build version

GetCompatibleChangelist()

int BuildSettings::GetCompatibleChangelist

(

)

The compatible changelist version of the engine. This number identifies a particular API revision, and is used to determine module and package backwards compatibility. Hotfixes should retain the compatible version of the original release. This define is parsed by the build tools, and should be a number or BUILT_FROM_CHANGELIST, defined in this particular order for each alternative.

Returns

The changelist number that this engine version is compatible with

GetCurrentChangelist()

int BuildSettings::GetCurrentChangelist

(

)

The Perforce changelist being compiled. Use this value advisedly; it does not take into account out-of-order commits to engine release branches over development branches, licensee versions, or whether the engine version has been locked to maintain compatibility with a previous engine release. Prefer BUILD_VERSION where a unique, product-specific identifier is required, or FEngineVersion::CompatibleWith() where relational comparisons between two versions is required.

Returns

The changelist number being compiled

GetEngineVersionHotfix()

int BuildSettings::GetEngineVersionHotfix

(

)

The hotfix engine version.

Returns

The hotfix patch part of the engine version

GetEngineVersionMajor()

int BuildSettings::GetEngineVersionMajor

(

)

The major engine version.

Returns

The major part of the engine version

GetEngineVersionMinor()

int BuildSettings::GetEngineVersionMinor

(

)

The minor engine version.

Returns

The minor part of the engine version

GetEngineVersionString()

const TCHAR * BuildSettings::GetEngineVersionString

(

)

The engine version.

Returns

The engine version as a string in the format MAJOR.MINOR.HOTFIX-BUILD_VERSION

GetLiveCodingEngineDir()

const TCHAR * BuildSettings::GetLiveCodingEngineDir

(

)

Returns the live coding engine dir. Only set in monolithic builds (live coding engine dir is calculated differently in modular builds)

GetLiveCodingProject()

const TCHAR * BuildSettings::GetLiveCodingProject

(

)

Returns the live coding project. Only set in monolithic builds

GetPersistentAllocatorReserveSize()

uint64 BuildSettings::GetPersistentAllocatorReserveSize

(

)

Persistent linear allocator reserve size. Stored here to prevent rebuilds of Core when switching between projects

GetVfsPaths()

const char * BuildSettings::GetVfsPaths

(

)

Semicolon separated string containing virtual;local;virtual;local; paths. Ends with semicolon

GetVfsPathsWide()

const TCHAR * BuildSettings::GetVfsPathsWide

(

)

Semicolon separated string containing virtual;local;virtual;local; paths. Ends with semicolon

IsLicenseeVersion()

bool BuildSettings::IsLicenseeVersion

(

)

Determines if the changelist version numbers are from a licensee Perforce server. For the same major/minor/patch release of the engine, licensee changelists are always considered newer than Epic changelists for engine versions. This follows the assumption that content is developed by Epic leading up to a release, and which point we lock compatibility, and any subsequent licensee modifications to the engine will have a superset of its functionality even if the changelist numbers are lower.

Returns

Whether the changelist version numbers are from a licensee Perforce server

IsPromotedBuild()

bool BuildSettings::IsPromotedBuild

(

)

Identifies whether this build is a promoted build; a formal build of the engine from a clean source sync.

Returns

True if this is a promoted build of the engine.

IsWithDebugInfo()

bool BuildSettings::IsWithDebugInfo

(

)

Identifies whether this build was compiled with or without debug info. (e.g. pdb files on Microsoft platforms)