Ark Server API (ASA) - Wiki
Loading...
Searching...
No Matches
FCustomVersion Struct Reference

#include <CustomVersion.h>

+ Collaboration diagram for FCustomVersion:

Public Member Functions

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

Public Attributes

FGuid Key
 
int32 Version
 
int32 ReferenceCount
 
CustomVersionValidatorFunc Validator
 

Private Attributes

FName FriendlyName
 

Friends

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

Detailed Description

Structure to hold unique custom key with its version.

Definition at line 42 of file CustomVersion.h.

Constructor & Destructor Documentation

◆ FCustomVersion() [1/2]

FORCEINLINE FCustomVersion::FCustomVersion ( )
inline

Constructor.

Definition at line 59 of file CustomVersion.h.

◆ FCustomVersion() [2/2]

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

Helper constructor.

Definition at line 65 of file CustomVersion.h.

Member Function Documentation

◆ GetFriendlyName()

const FName FCustomVersion::GetFriendlyName ( ) const

Gets the friendly name for error messages or whatever

◆ operator!=()

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

Inequality comparison operator for Key

Definition at line 81 of file CustomVersion.h.

◆ operator==()

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

Equality comparison operator for Key

Definition at line 75 of file CustomVersion.h.

Friends And Related Symbol Documentation

◆ FCustomVersionContainer

Definition at line 44 of file CustomVersion.h.

◆ operator<< [1/2]

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

◆ operator<< [2/2]

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

Member Data Documentation

◆ FriendlyName

FName FCustomVersion::FriendlyName
mutableprivate

Friendly name for error messages or whatever. Lazy initialized for serialized versions

Definition at line 95 of file CustomVersion.h.

◆ Key

FGuid FCustomVersion::Key

Unique custom key.

Definition at line 47 of file CustomVersion.h.

◆ ReferenceCount

int32 FCustomVersion::ReferenceCount

Number of times this GUID has been registered

Definition at line 53 of file CustomVersion.h.

◆ Validator

CustomVersionValidatorFunc FCustomVersion::Validator

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

Definition at line 56 of file CustomVersion.h.

◆ Version

int32 FCustomVersion::Version

Custom version.

Definition at line 50 of file CustomVersion.h.


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