EngineVersion.h

Go to the documentation of this file.

// Copyright Epic Games, Inc. All Rights Reserved.
 
#pragma once
 
#include "CoreTypes.h"
#include "Misc/EngineVersionBase.h"
#include "Containers/UnrealString.h"
#include "Serialization/StructuredArchive.h"
 
/** Utility functions. */
class FEngineVersion : public FEngineVersionBase
{
public:
 
    /** Empty constructor. Initializes the version to 0.0.0-0. */
    FEngineVersion() = default;
 
    /** Constructs a version from the given components. */
    FEngineVersion(uint16 InMajor, uint16 InMinor, uint16 InPatch, uint32 InChangelist, const FString &InBranch);
 
    /** Sets the version to the given values. */
    void Set(uint16 InMajor, uint16 InMinor, uint16 InPatch, uint32 InChangelist, const FString &InBranch);
 
    /** Clears the object. */
    void Empty();
 
    /** Checks whether this engine version is an exact match for another engine version */
    bool ExactMatch(const FEngineVersion& Other) const;
 
    /** Checks compatibility with another version object. */
    bool IsCompatibleWith(const FEngineVersionBase &Other) const;
 
    /** Generates a version string */
    FString ToString(EVersionComponent LastComponent = EVersionComponent::Branch) const;
 
    /** Parses a version object from a string. Returns true on success. */
    static bool Parse(const FString &Text, FEngineVersion &OutVersion);
 
    /** Gets the current engine version */
    static const FEngineVersion& Current();
 
    /** Gets the earliest version which this engine maintains strict API and package compatibility with */
    static const FEngineVersion& CompatibleWith();
 
    /** Clears the current and compatible-with engine versions */
    static void TearDown();
 
    /** Serialization functions */
    friend void operator<<(class FArchive &Ar, FEngineVersion &Version);
    friend void operator<<(FStructuredArchive::FSlot Slot, FEngineVersion &Version);
 
    /** Returns the branch name corresponding to this version. */
    const FString GetBranch() const
    {
        return Branch.Replace( TEXT( "+" ), TEXT( "/" ) );
    }
 
    const FString& GetBranchDescriptor() const;
 
 
private:
 
    /** Branch name. */
    FString Branch;
};