FEngineVersionBase Class Reference

#include <EngineVersionBase.h>

Inheritance diagram for FEngineVersionBase:

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

Static Public Member Functions
static EVersionComparison	GetNewest (const FEngineVersionBase &First, const FEngineVersionBase &Second, EVersionComponent *OutComponent)
static 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.

Definition at line 28 of file EngineVersionBase.h.

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()

static 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()

FORCEINLINE uint16 FEngineVersionBase::GetMajor ( ) const

inline

Returns the Major version number corresponding to this version.

Definition at line 42 of file EngineVersionBase.h.

GetMinor()

FORCEINLINE uint16 FEngineVersionBase::GetMinor ( ) const

inline

Returns the Minor version number corresponding to this version.

Definition at line 48 of file EngineVersionBase.h.

GetNewest()

static 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()

FORCEINLINE uint16 FEngineVersionBase::GetPatch ( ) const

inline

Returns the Patch version number corresponding to this version.

Definition at line 54 of file EngineVersionBase.h.

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.

Definition at line 86 of file EngineVersionBase.h.

Major

uint16 FEngineVersionBase::Major = 0

protected

Major version number.

Definition at line 77 of file EngineVersionBase.h.

Minor

uint16 FEngineVersionBase::Minor = 0

protected

Minor version number.

Definition at line 80 of file EngineVersionBase.h.

Patch

uint16 FEngineVersionBase::Patch = 0

protected

Patch version number.

Definition at line 83 of file EngineVersionBase.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Misc/EngineVersionBase.h