FBuildVersion Class Reference

#include <BuildVersion.h>

Public Member Functions
CORE_API	FBuildVersion ()
CORE_API int	GetEffectiveCompatibleChangelist () const
	Gets the compatible changelist if set, otherwise the default compatible changelist.
CORE_API FEngineVersion	GetEngineVersion () const
	Get an engine version object for this build version.
CORE_API FEngineVersion	GetCompatibleEngineVersion () const
	Get a compatible engine version object for this build version.

Static Public Member Functions
static CORE_API FString	GetDefaultFileName ()
	Get the default path to the build.version file on disk.
static CORE_API FString	GetFileNameForCurrentExecutable ()
	Get the path to the version file for the current executable.
static CORE_API bool	TryRead (const FString &FileName, FBuildVersion &OutVersion)
static CORE_API bool	TryReadFromString (const FString &Text, FBuildVersion &OutVersion)

Public Attributes
int	MajorVersion
int	MinorVersion
int	PatchVersion
int	Changelist
int	CompatibleChangelist
int	IsLicenseeVersion
int	IsPromotedBuild
FString	BranchName
FString	BuildId
FString	BuildVersion
FString	BuildUrl

Detailed Description

Stores the version information associated with a build

Constructor & Destructor Documentation

FBuildVersion()

FBuildVersion::FBuildVersion

(

)

Default constructor. Initializes the structure to empty.

Member Function Documentation

GetCompatibleEngineVersion()

FEngineVersion FBuildVersion::GetCompatibleEngineVersion

(

)

const

Get a compatible engine version object for this build version.

Returns

New engine version object

GetDefaultFileName()

FString FBuildVersion::GetDefaultFileName ( )

static

Get the default path to the build.version file on disk.

Returns

Path to the Build.version file

GetEffectiveCompatibleChangelist()

int FBuildVersion::GetEffectiveCompatibleChangelist

(

)

const

Gets the compatible changelist if set, otherwise the default compatible changelist.

Returns

The compatible changelist

GetEngineVersion()

FEngineVersion FBuildVersion::GetEngineVersion

(

)

const

Get an engine version object for this build version.

Returns

New engine version object

GetFileNameForCurrentExecutable()

FString FBuildVersion::GetFileNameForCurrentExecutable ( )

static

Get the path to the version file for the current executable.

Returns

Path to the target's version file

TryRead()

bool FBuildVersion::TryRead ( const FString &  FileName, FBuildVersion &  OutVersion  )

static

Try to read a version file from disk

Parameters

FileName	Path to the version file
OutVersion	The version information

Returns

True if the version was read successfully, false otherwise

TryReadFromString()

bool FBuildVersion::TryReadFromString ( const FString &  Text, FBuildVersion &  OutVersion  )

static

Try to read version info from data stored in a string.

Parameters

Text	The version info stored in string form
OutVersion	The version information

Returns

True if the version was read successfully, false otherwise

Member Data Documentation

BranchName

FString FBuildVersion::BranchName

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

BuildId

FString FBuildVersion::BuildId

The current build id. This will be generated automatically whenever engine binaries change if not set in the default Engine/Build/Build.version.

BuildUrl

FString FBuildVersion::BuildUrl

[Optional] A url to the web page for the build (if it was created by an automated build systme for example)

BuildVersion

FString FBuildVersion::BuildVersion

The build version string.

Changelist

int FBuildVersion::Changelist

The changelist that the engine is being built from

CompatibleChangelist

int FBuildVersion::CompatibleChangelist

The changelist that the engine maintains compatibility with

IsLicenseeVersion

int FBuildVersion::IsLicenseeVersion

Whether the changelist numbers are a licensee changelist

IsPromotedBuild

int FBuildVersion::IsPromotedBuild

Whether the current build is a promoted build, that is, built strictly from a clean sync of the given changelist

MajorVersion

int FBuildVersion::MajorVersion

The major engine version (4 for UE4)

MinorVersion

int FBuildVersion::MinorVersion

The minor engine version

PatchVersion

int FBuildVersion::PatchVersion

The hotfix/patch version

---

The documentation for this class was generated from the following files:

• Engine/Source/Runtime/Core/Public/Modules/BuildVersion.h
• Engine/Source/Runtime/Core/Private/Modules/BuildVersion.cpp