Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Private Attributes | Friends | List of all members
FEngineVersion Class Reference

#include <EngineVersion.h>

+ Inheritance diagram for FEngineVersion:
+ Collaboration diagram for FEngineVersion:

Public Member Functions

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

Private Attributes

FString Branch
 

Friends

void operator<< (class FArchive &Ar, FEngineVersion &Version)
 
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.

Definition at line 11 of file EngineVersion.h.

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

static const FEngineVersion & FEngineVersion::CompatibleWith ( )
static

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

◆ Current()

static 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.

Definition at line 53 of file EngineVersion.h.

◆ GetBranchDescriptor()

const FString & FEngineVersion::GetBranchDescriptor ( ) const

◆ IsCompatibleWith()

bool FEngineVersion::IsCompatibleWith ( const FEngineVersionBase & Other) const

Checks compatibility with another version object.

◆ Parse()

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

static 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]

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

Serialization functions

◆ operator<< [2/2]

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

Member Data Documentation

◆ Branch

FString FEngineVersion::Branch
private

Branch name.

Definition at line 64 of file EngineVersion.h.

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