FBuildVersion

Stores the version information associated with a build

Choose your operating system:

Windows

macOS

Linux

References

Module

Core

Header

/Engine/Source/Runtime/Core/Public/Modules/BuildVersion.h

Include

#include "Modules/BuildVersion.h"

Syntax

class FBuildVersion

Remarks

Stores the version information associated with a build

Variables

Name Description

Public variable

FString

 

BranchName

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

Public variable

FString

 

BuildId

The current build id.

Public variable

FString

 

BuildVersion

The build version string.

Public variable

int

 

Changelist

The changelist that the engine is being built from

Public variable

int

 

CompatibleChangelist

The changelist that the engine maintains compatibility with

Public variable

int

 

IsLicenseeVersion

Whether the changelist numbers are a licensee changelist

Public variable

int

 

IsPromotedBuild

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

Public variable

int

 

MajorVersion

The major engine version (4 for UE4)

Public variable

int

 

MinorVersion

The minor engine version

Public variable

int

 

PatchVersion

The hotfix/patch version

Constructors

Name Description

Public function

FBuildVersion()

Default constructor. Initializes the structure to empty.

Functions

Name Description

Public function Const

FEngineVersi...

 

GetCompatibleEngineVersion()

Get a compatible engine version object for this build version

Public function Static

FString

 

GetDefaultFileName()

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

Public function Const

int

 

GetEffectiveCompatibleChangelist()

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

Public function Const

FEngineVersi...

 

GetEngineVersion()

Get an engine version object for this build version

Public function Static

FString

 

GetFileNameForCurrentExecutable()

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

Public function Static

bool

 

TryRead

(
    const FString& FileName,
    FBuildVersion& OutVersion
)

Try to read a version file from disk