You've already forked UnrealEngineUWP
mirror of
https://github.com/izzy2lost/UnrealEngineUWP.git
synced 2026-03-26 18:15:20 -07:00
#rnx #rb none #ROBOMERGE-OWNER: ryan.durand #ROBOMERGE-AUTHOR: ryan.durand #ROBOMERGE-SOURCE: CL 10869210 via CL 10869511 via CL 10869900 #ROBOMERGE-BOT: (v613-10869866) [CL 10870549 by ryan durand in Main branch]
66 lines
2.7 KiB
C++
66 lines
2.7 KiB
C++
// Copyright Epic Games, Inc. All Rights Reserved.
|
|
|
|
#pragma once
|
|
|
|
#include "CoreTypes.h"
|
|
|
|
namespace BuildSettings
|
|
{
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return Whether the changelist version numbers are from a licensee Perforce server
|
|
*/
|
|
BUILDSETTINGS_API bool IsLicenseeVersion();
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return The changelist number being compiled
|
|
*/
|
|
BUILDSETTINGS_API int GetCurrentChangelist();
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return The changelist number that this engine version is compatible with
|
|
*/
|
|
BUILDSETTINGS_API int GetCompatibleChangelist();
|
|
|
|
/**
|
|
* The branch that this program is being built from.
|
|
*
|
|
* @return Name of the current branch, with slashes escaped as '+' characters.
|
|
*/
|
|
BUILDSETTINGS_API const TCHAR* GetBranchName();
|
|
|
|
/**
|
|
* The 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...)
|
|
*
|
|
* @return String representing the build timestamp
|
|
*/
|
|
BUILDSETTINGS_API const TCHAR* GetBuildDate();
|
|
|
|
/**
|
|
* Retrieves the user-defined build version for this application.
|
|
*
|
|
* @return The current build version
|
|
*/
|
|
BUILDSETTINGS_API const TCHAR* GetBuildVersion();
|
|
|
|
/**
|
|
* Identifies whether this build is a promoted build; a formal build of the engine from a clean source sync.
|
|
*
|
|
* @return True if this is a promoted build of the engine.
|
|
*/
|
|
BUILDSETTINGS_API bool IsPromotedBuild();
|
|
}
|