FEngineVersion Class Reference

#include <EngineVersion.h>

Inheritance diagram for FEngineVersion:

Public Member Functions
	FEngineVersion ()=default
CORE_API	FEngineVersion (uint16 InMajor, uint16 InMinor, uint16 InPatch, uint32 InChangelist, const FString &InBranch)
CORE_API void	Set (uint16 InMajor, uint16 InMinor, uint16 InPatch, uint32 InChangelist, const FString &InBranch)
CORE_API void	Empty ()
CORE_API bool	ExactMatch (const FEngineVersion &Other) const
CORE_API bool	IsCompatibleWith (const FEngineVersionBase &Other) const
CORE_API FString	ToString (EVersionComponent LastComponent=EVersionComponent::Branch) const
const FString	GetBranch () const
CORE_API const FString &	GetBranchDescriptor () const
Public Member Functions inherited from FEngineVersionBase
	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 bool	Parse (const FString &Text, FEngineVersion &OutVersion)
static CORE_API const FEngineVersion &	Current ()
static CORE_API const FEngineVersion &	CompatibleWith ()
static CORE_API void	TearDown ()
Static Public Member Functions inherited from FEngineVersionBase
static CORE_API EVersionComparison	GetNewest (const FEngineVersionBase &First, const FEngineVersionBase &Second, EVersionComponent *OutComponent)
static CORE_API uint32	EncodeLicenseeChangelist (uint32 Changelist)

Friends
CORE_API void	operator<< (class FArchive &Ar, FEngineVersion &Version)
CORE_API void	operator<< (FStructuredArchive::FSlot Slot, FEngineVersion &Version)

Additional Inherited Members
Protected Attributes inherited from FEngineVersionBase
uint16	Major = 0
uint16	Minor = 0
uint16	Patch = 0
uint32	Changelist = 0

Detailed Description

Utility functions.

Constructor & Destructor Documentation

FEngineVersion() [1/2]

FEngineVersion::FEngineVersion ( )

default

Empty constructor. Initializes the version to 0.0.0-0.

FEngineVersion() [2/2]

FEngineVersion::FEngineVersion	(	uint16	InMajor,
		uint16	InMinor,
		uint16	InPatch,
		uint32	InChangelist,
		const FString &	InBranch
	)

Constructs a version from the given components.

Member Function Documentation

CompatibleWith()

const FEngineVersion & FEngineVersion::CompatibleWith ( )

static

Gets the earliest version which this engine maintains strict API and package compatibility with

Current()

const FEngineVersion & FEngineVersion::Current ( )

static

Gets the current engine version

Empty()

void FEngineVersion::Empty

(

)

Clears the object.

ExactMatch()

bool FEngineVersion::ExactMatch

(

const FEngineVersion &

Other

)

const

Checks whether this engine version is an exact match for another engine version

GetBranch()

const FString FEngineVersion::GetBranch ( ) const

inline

Returns the branch name corresponding to this version.

GetBranchDescriptor()

const FString & FEngineVersion::GetBranchDescriptor

(

)

const

IsCompatibleWith()

bool FEngineVersion::IsCompatibleWith

(

const FEngineVersionBase &

Other

)

const

Checks compatibility with another version object.

Parse()

bool FEngineVersion::Parse ( const FString &  Text, FEngineVersion &  OutVersion  )

static

Parses a version object from a string. Returns true on success.

Set()

void FEngineVersion::Set	(	uint16	InMajor,
		uint16	InMinor,
		uint16	InPatch,
		uint32	InChangelist,
		const FString &	InBranch
	)

Sets the version to the given values.

TearDown()

void FEngineVersion::TearDown ( )

static

Clears the current and compatible-with engine versions

ToString()

FString FEngineVersion::ToString

(

EVersionComponent

LastComponent = EVersionComponent::Branch

)

const

Generates a version string

Friends And Related Symbol Documentation

operator<< [1/2]

CORE_API void operator<< ( class FArchive &  Ar, FEngineVersion &  Version  )

friend

Serialization functions

operator<< [2/2]

CORE_API void operator<< ( FStructuredArchive::FSlot  Slot, FEngineVersion &  Version  )

friend

---

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

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