Nuke.Unreal
Build Unreal apps in Style.
Loading...
Searching...
No Matches
Nuke.Unreal.EngineVersion Class Reference

High level representation of an Unreal Engine version. More...

Public Member Functions

 EngineVersion (string versionName)
 Parse a high-level version from an input version identifier (semantic, guid or path)
 
bool IsCompatibleWith (UnrealCompatibility compatibility)
 Check if given compatibility mask applies to this version too.
 

Public Attributes

string VersionName
 The canonical engine version name, only contains Major.Minor and may contain suffixes like how Unreal Engine 5 Early Access did once (5.0AE)
 
AbsolutePath EnginePath
 Cached engine path.
 

Properties

Version SemanticalVersion [get]
 Semantical version representation of the given Unreal Engine.
 
string VersionMinor [get]
 Only the Major.Minor version components, with extra information trimmed.
 
string VersionPatch [get]
 Only the full Major.Minor.Patch version components, with additional information trimmed.
 
int CompatibilityBaseExponent [get]
 
ulong CompatibilityFlag [get]
 
UnrealCompatibility Compatibility [get]
 Compatibility flag equivalent for this version.
 

Private Member Functions

Version GetEngineSemVersion ()
 

Private Attributes

Version? _semVersion = null
 

Detailed Description

High level representation of an Unreal Engine version.

Definition at line 16 of file EngineVersion.cs.

Constructor & Destructor Documentation

◆ EngineVersion()

Nuke.Unreal.EngineVersion.EngineVersion ( string versionName)

Parse a high-level version from an input version identifier (semantic, guid or path)

Definition at line 34 of file EngineVersion.cs.

Member Function Documentation

◆ GetEngineSemVersion()

Version Nuke.Unreal.EngineVersion.GetEngineSemVersion ( )
private

Definition at line 18 of file EngineVersion.cs.

◆ IsCompatibleWith()

bool Nuke.Unreal.EngineVersion.IsCompatibleWith ( UnrealCompatibility compatibility)

Check if given compatibility mask applies to this version too.

Definition at line 78 of file EngineVersion.cs.

Member Data Documentation

◆ _semVersion

Version? Nuke.Unreal.EngineVersion._semVersion = null
private

Definition at line 45 of file EngineVersion.cs.

◆ EnginePath

AbsolutePath Nuke.Unreal.EngineVersion.EnginePath

Cached engine path.

Definition at line 65 of file EngineVersion.cs.

◆ VersionName

string Nuke.Unreal.EngineVersion.VersionName

The canonical engine version name, only contains Major.Minor and may contain suffixes like how Unreal Engine 5 Early Access did once (5.0AE)

Definition at line 44 of file EngineVersion.cs.

Property Documentation

◆ Compatibility

UnrealCompatibility Nuke.Unreal.EngineVersion.Compatibility
get

Compatibility flag equivalent for this version.

Definition at line 73 of file EngineVersion.cs.

◆ CompatibilityBaseExponent

int Nuke.Unreal.EngineVersion.CompatibilityBaseExponent
getprivate

Definition at line 67 of file EngineVersion.cs.

◆ CompatibilityFlag

ulong Nuke.Unreal.EngineVersion.CompatibilityFlag
getprivate

Definition at line 68 of file EngineVersion.cs.

◆ SemanticalVersion

Version Nuke.Unreal.EngineVersion.SemanticalVersion
get

Semantical version representation of the given Unreal Engine.

Definition at line 50 of file EngineVersion.cs.

◆ VersionMinor

string Nuke.Unreal.EngineVersion.VersionMinor
get

Only the Major.Minor version components, with extra information trimmed.

Definition at line 55 of file EngineVersion.cs.

◆ VersionPatch

string Nuke.Unreal.EngineVersion.VersionPatch
get

Only the full Major.Minor.Patch version components, with additional information trimmed.

Definition at line 60 of file EngineVersion.cs.


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