FCustomVersionContainer Class Reference

#include <CustomVersion.h>

Public Member Functions
UE_FORCEINLINE_HINT const FCustomVersionArray &	GetAllVersions () const
CORE_API const FCustomVersion *	GetVersion (FGuid CustomKey) const
CORE_API const FName	GetFriendlyName (FGuid CustomKey) const
CORE_API void	SetVersion (FGuid CustomKey, int32 Version, FName FriendlyName)
CORE_API void	SetVersionUsingRegistry (FGuid CustomKey, ESetCustomVersionFlags Options=ESetCustomVersionFlags::None)
CORE_API void	Serialize (FArchive &Ar, ECustomVersionSerializationFormat Format=ECustomVersionSerializationFormat::Latest)
CORE_API void	Serialize (FStructuredArchive::FSlot Slot, ECustomVersionSerializationFormat Format=ECustomVersionSerializationFormat::Latest)
CORE_API void	Empty ()
CORE_API void	SortByKey ()
CORE_API FString	ToString (const FString &Indent) const

Static Public Member Functions
static CORE_API const FCustomVersionContainer &	GetRegistered ()

Friends
struct	FStaticCustomVersionRegistry

Detailed Description

Container for all available/serialized custom versions.

Member Function Documentation

Empty()

void FCustomVersionContainer::Empty

(

)

Empties the custom version container.

GetAllVersions()

UE_FORCEINLINE_HINT const FCustomVersionArray & FCustomVersionContainer::GetAllVersions ( ) const

inline

Gets available custom versions in this container.

GetFriendlyName()

const FName FCustomVersionContainer::GetFriendlyName

(

FGuid

CustomKey

)

const

Gets a custom version friendly name from the container.

Parameters

CustomKey

Custom key for which to retrieve the version.

Returns

The friendly name for the specified custom key, or NAME_None if the key doesn't exist in the container.

GetRegistered()

const FCustomVersionContainer & FCustomVersionContainer::GetRegistered ( )

static

Gets a singleton with the registered versions.

Returns

The registered version container.

GetVersion()

const FCustomVersion * FCustomVersionContainer::GetVersion

(

FGuid

CustomKey

)

const

Gets a custom version from the container.

Parameters

CustomKey

Custom key for which to retrieve the version.

Returns

The FCustomVersion for the specified custom key, or nullptr if the key doesn't exist in the container.

Serialize() [1/2]

void FCustomVersionContainer::Serialize	(	FArchive &	Ar,
		ECustomVersionSerializationFormat	Format = ECustomVersionSerializationFormat::Latest
	)

Serialization.

Serialize() [2/2]

void FCustomVersionContainer::Serialize	(	FStructuredArchive::FSlot	Slot,
		ECustomVersionSerializationFormat	Format = ECustomVersionSerializationFormat::Latest
	)

SetVersion()

void FCustomVersionContainer::SetVersion	(	FGuid	CustomKey,
		int32	Version,
		FName	FriendlyName
	)

Sets a specific custom version in the container.

Parameters

CustomKey	Custom key for which to retrieve the version.
Version	The version number for the specified custom key
FriendlyName	A friendly name to assign to this version

SetVersionUsingRegistry()

void FCustomVersionContainer::SetVersionUsingRegistry	(	FGuid	CustomKey,
		ESetCustomVersionFlags	Options = ESetCustomVersionFlags::None
	)

Sets a specific custom version in the container. It queries the versions registry to get the version data for the provided key

Parameters

CustomKey	Custom key for which to retrieve the version.
Options	Optional flags used to alter the behavior of this method

SortByKey()

void FCustomVersionContainer::SortByKey

(

)

Sorts the custom version container by key.

ToString()

FString FCustomVersionContainer::ToString

(

const FString &

Indent

)

const

Return a string representation of custom versions. Used for debug.

Friends And Related Symbol Documentation

FStaticCustomVersionRegistry

friend struct FStaticCustomVersionRegistry

friend

---

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

• Engine/Source/Runtime/Core/Public/Serialization/CustomVersion.h
• Engine/Source/Runtime/Core/Private/Serialization/CustomVersion.cpp