FCustomVersionContainer Class Reference

#include <CustomVersion.h>

Collaboration diagram for FCustomVersionContainer:

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

Static Public Member Functions
static const FCustomVersionContainer &	GetRegistered ()

Private Attributes
FCustomVersionArray	Versions

Friends
struct	FStaticCustomVersionRegistry

Detailed Description

Container for all available/serialized custom versions.

Definition at line 103 of file CustomVersion.h.

Member Function Documentation

Empty()

void FCustomVersionContainer::Empty

(

)

Empties the custom version container.

GetAllVersions()

FORCEINLINE const FCustomVersionArray & FCustomVersionContainer::GetAllVersions ( ) const

inline

Gets available custom versions in this container.

Definition at line 109 of file CustomVersion.h.

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()

static 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::Type	Format = ECustomVersionSerializationFormat::Latest )

Serialization.

Serialize() [2/2]

void FCustomVersionContainer::Serialize	(	FStructuredArchive::FSlot	Slot,
		ECustomVersionSerializationFormat::Type	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

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

Definition at line 105 of file CustomVersion.h.

Member Data Documentation

Versions

FCustomVersionArray FCustomVersionContainer::Versions

private

Array containing custom versions.

Definition at line 167 of file CustomVersion.h.

---

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

• C:/Users/lachl/Downloads/ArkServerAPI_NEW/ASA/AsaApi/AsaApi/Core/Public/API/UE/Serialization/CustomVersion.h