UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FCustomVersion Struct Reference

#include <CustomVersion.h>

Public Member Functions

UE_FORCEINLINE_HINT FCustomVersion ()
 
 FCustomVersion (FGuid InKey, int32 InVersion, FName InFriendlyName, CustomVersionValidatorFunc InValidatorFunc=nullptr)
 
UE_FORCEINLINE_HINT bool operator== (FGuid InKey) const
 
UE_FORCEINLINE_HINT bool operator!= (FGuid InKey) const
 
CORE_API const FName GetFriendlyName () const
 

Public Attributes

FGuid Key
 
int32 Version
 
int32 ReferenceCount
 
CustomVersionValidatorFunc Validator
 

Friends

class FCustomVersionContainer
 
CORE_API friend FArchiveoperator<< (FArchive &Ar, FCustomVersion &Version)
 
CORE_API friend void operator<< (FStructuredArchive::FSlot Slot, FCustomVersion &Version)
 

Detailed Description

Structure to hold unique custom key with its version.

Constructor & Destructor Documentation

◆ FCustomVersion() [1/2]

UE_FORCEINLINE_HINT FCustomVersion::FCustomVersion ( )
inline

Constructor.

◆ FCustomVersion() [2/2]

FCustomVersion::FCustomVersion ( FGuid  InKey,
int32  InVersion,
FName  InFriendlyName,
CustomVersionValidatorFunc  InValidatorFunc = nullptr 
)
inline

Helper constructor.

Member Function Documentation

◆ GetFriendlyName()

const FName FCustomVersion::GetFriendlyName ( ) const

Gets the friendly name for error messages or whatever

◆ operator!=()

UE_FORCEINLINE_HINT bool FCustomVersion::operator!= ( FGuid  InKey) const
inline

Inequality comparison operator for Key

◆ operator==()

UE_FORCEINLINE_HINT bool FCustomVersion::operator== ( FGuid  InKey) const
inline

Equality comparison operator for Key

Friends And Related Symbol Documentation

◆ FCustomVersionContainer

◆ operator<< [1/2]

CORE_API friend FArchive & operator<< ( FArchive Ar,
FCustomVersion Version 
)
friend

◆ operator<< [2/2]

CORE_API friend void operator<< ( FStructuredArchive::FSlot  Slot,
FCustomVersion Version 
)
friend

Member Data Documentation

◆ Key

FGuid FCustomVersion::Key

Unique custom key.

◆ ReferenceCount

int32 FCustomVersion::ReferenceCount

Number of times this GUID has been registered

◆ Validator

CustomVersionValidatorFunc FCustomVersion::Validator

An optional validator that will be called if a package has a given version that can prevent it from loading

◆ Version

int32 FCustomVersion::Version

Custom version.


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