FEngineVersionBase Class Reference

#include <EngineVersionBase.h>

Inheritance diagram for FEngineVersionBase:

Public Member Functions
	FEngineVersionBase ()=default
CORE_API	FEngineVersionBase (uint16 InMajor, uint16 InMinor, uint16 InPatch=0, uint32 InChangelist=0)
CORE_API uint32	GetChangelist () const
UE_FORCEINLINE_HINT uint16	GetMajor () const
UE_FORCEINLINE_HINT uint16	GetMinor () const
UE_FORCEINLINE_HINT uint16	GetPatch () const
CORE_API bool	IsLicenseeVersion () const
CORE_API bool	IsEmpty () const
CORE_API bool	HasChangelist () const

Static Public Member Functions
static CORE_API EVersionComparison	GetNewest (const FEngineVersionBase &First, const FEngineVersionBase &Second, EVersionComponent *OutComponent)
static CORE_API uint32	EncodeLicenseeChangelist (uint32 Changelist)

Protected Attributes
uint16	Major = 0
uint16	Minor = 0
uint16	Patch = 0
uint32	Changelist = 0

Detailed Description

Base class for the EngineVersion class. Holds basic version numbers.

Constructor & Destructor Documentation

FEngineVersionBase() [1/2]

FEngineVersionBase::FEngineVersionBase ( )

default

Empty constructor. Initializes the version to 0.0.0-0.

FEngineVersionBase() [2/2]

FEngineVersionBase::FEngineVersionBase	(	uint16	InMajor,
		uint16	InMinor,
		uint16	InPatch = 0,
		uint32	InChangelist = 0
	)

Constructs a version from the given components.

Member Function Documentation

EncodeLicenseeChangelist()

uint32 FEngineVersionBase::EncodeLicenseeChangelist ( uint32  Changelist )

static

Encodes a licensee changelist number (by setting the top bit)

GetChangelist()

uint32 FEngineVersionBase::GetChangelist

(

)

const

Returns the changelist number corresponding to this version.

GetMajor()

UE_FORCEINLINE_HINT uint16 FEngineVersionBase::GetMajor ( ) const

inline

Returns the Major version number corresponding to this version.

GetMinor()

UE_FORCEINLINE_HINT uint16 FEngineVersionBase::GetMinor ( ) const

inline

Returns the Minor version number corresponding to this version.

GetNewest()

EVersionComparison FEngineVersionBase::GetNewest ( const FEngineVersionBase &  First, const FEngineVersionBase &  Second, EVersionComponent *  OutComponent  )

static

Returns the newest of two versions, and the component at which they differ

GetPatch()

UE_FORCEINLINE_HINT uint16 FEngineVersionBase::GetPatch ( ) const

inline

Returns the Patch version number corresponding to this version.

HasChangelist()

bool FEngineVersionBase::HasChangelist

(

)

const

Returns whether the engine version has a changelist component.

IsEmpty()

bool FEngineVersionBase::IsEmpty

(

)

const

Returns whether the current version is empty.

IsLicenseeVersion()

bool FEngineVersionBase::IsLicenseeVersion

(

)

const

Checks if the changelist number represents licensee changelist number.

Member Data Documentation

Changelist

uint32 FEngineVersionBase::Changelist = 0

protected

Changelist number. This is used to arbitrate when Major/Minor/Patch version numbers match. Use GetChangelist() instead of using this member directly.

Major

uint16 FEngineVersionBase::Major = 0

protected

Major version number.

Minor

uint16 FEngineVersionBase::Minor = 0

protected

Minor version number.

Patch

uint16 FEngineVersionBase::Patch = 0

protected

Patch version number.

---

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

• Engine/Source/Runtime/Core/Public/Misc/EngineVersionBase.h
• Engine/Source/Runtime/Core/Private/Misc/EngineVersion.cpp