Navigation
API > API/Runtime > API/Runtime/Core
Stores the version information associated with a build
| Name | FBuildVersion |
| Type | class |
| Header File | /Engine/Source/Runtime/Core/Public/Modules/BuildVersion.h |
| Include Path | #include "Modules/BuildVersion.h" |
Syntax
class FBuildVersion
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FBuildVersion() |
Default constructor. Initializes the structure to empty. | Modules/BuildVersion.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| BranchName | FString | Name of the current branch, with '/' characters escaped as '+' | Modules/BuildVersion.h | |
| BuildId | FString | The current build id. | Modules/BuildVersion.h | |
| BuildUrl | FString | [Optional] A url to the web page for the build (if it was created by an automated build systme for example) | Modules/BuildVersion.h | |
| BuildVersion | FString | The build version string. | Modules/BuildVersion.h | |
| Changelist | int | The changelist that the engine is being built from | Modules/BuildVersion.h | |
| CompatibleChangelist | int | The changelist that the engine maintains compatibility with | Modules/BuildVersion.h | |
| IsLicenseeVersion | int | Whether the changelist numbers are a licensee changelist | Modules/BuildVersion.h | |
| IsPromotedBuild | int | Whether the current build is a promoted build, that is, built strictly from a clean sync of the given changelist | Modules/BuildVersion.h | |
| MajorVersion | int | The major engine version (4 for UE4) | Modules/BuildVersion.h | |
| MinorVersion | int | The minor engine version | Modules/BuildVersion.h | |
| PatchVersion | int | The hotfix/patch version | Modules/BuildVersion.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
FEngineVersion GetCompatibleEngineVersion() |
Get a compatible engine version object for this build version. | Modules/BuildVersion.h | |
int GetEffectiveCompatibleChangelist() |
Gets the compatible changelist if set, otherwise the default compatible changelist. | Modules/BuildVersion.h | |
FEngineVersion GetEngineVersion() |
Get an engine version object for this build version. | Modules/BuildVersion.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static FString GetDefaultFileName() |
Get the default path to the build.version file on disk. | Modules/BuildVersion.h | |
static FString GetFileNameForCurrentExecutable() |
Get the path to the version file for the current executable. | Modules/BuildVersion.h | |
static bool TryRead
(
const FString& FileName, |
Try to read a version file from disk | Modules/BuildVersion.h | |
static bool TryReadFromString
(
const FString& Text, |
Try to read version info from data stored in a string. | Modules/BuildVersion.h |