#include <CoreRedirects.h>

Static Public Member Functions
static COREUOBJECT_API void	Initialize ()

static COREUOBJECT_API FCoreRedirectObjectName	GetRedirectedName (ECoreRedirectFlags Type, const FCoreRedirectObjectName &OldObjectName, ECoreRedirectMatchFlags MatchFlags=ECoreRedirectMatchFlags::None)

static COREUOBJECT_API const TMap< FString, FString > *	GetValueRedirects (ECoreRedirectFlags Type, const FCoreRedirectObjectName &OldObjectName, ECoreRedirectMatchFlags MatchFlags=ECoreRedirectMatchFlags::None)

static COREUOBJECT_API bool	RedirectNameAndValues (ECoreRedirectFlags Type, const FCoreRedirectObjectName &OldObjectName, FCoreRedirectObjectName &NewObjectName, const FCoreRedirect **FoundValueRedirect, ECoreRedirectMatchFlags MatchFlags=ECoreRedirectMatchFlags::None)

static COREUOBJECT_API bool	IsKnownMissing (ECoreRedirectFlags Type, const FCoreRedirectObjectName &ObjectName)

static COREUOBJECT_API bool	AddKnownMissing (ECoreRedirectFlags Type, const FCoreRedirectObjectName &ObjectName, ECoreRedirectFlags Channel=ECoreRedirectFlags::Option_MissingLoad)

static COREUOBJECT_API bool	RemoveKnownMissing (ECoreRedirectFlags Type, const FCoreRedirectObjectName &ObjectName, ECoreRedirectFlags Channel=ECoreRedirectFlags::Option_MissingLoad)

static COREUOBJECT_API void	ClearKnownMissing (ECoreRedirectFlags Type, ECoreRedirectFlags Channel=ECoreRedirectFlags::Option_MissingLoad)

static COREUOBJECT_API bool	FindPreviousNames (ECoreRedirectFlags Type, const FCoreRedirectObjectName &NewObjectName, TArray< FCoreRedirectObjectName > &PreviousNames)

static COREUOBJECT_API bool	GetMatchingRedirects (ECoreRedirectFlags Type, const FCoreRedirectObjectName &OldObjectName, TArray< const FCoreRedirect * > &FoundRedirects, ECoreRedirectMatchFlags MatchFlags=ECoreRedirectMatchFlags::None)

static COREUOBJECT_API bool	ReadRedirectsFromIni (const FString &IniName)

static COREUOBJECT_API bool	AddRedirectList (TArrayView< const FCoreRedirect > Redirects, const FString &SourceString)

static COREUOBJECT_API bool	RemoveRedirectList (TArrayView< const FCoreRedirect > Redirects, const FString &SourceString)

static COREUOBJECT_API bool	IsInitialized ()

static COREUOBJECT_API bool	IsInDebugMode ()

static COREUOBJECT_API void	ValidateRedirectList (TArrayView< const FCoreRedirect > Redirects, const FString &SourceString)

static COREUOBJECT_API void	ValidateAllRedirects ()

static COREUOBJECT_API bool	ValidateAssetRedirects ()

static COREUOBJECT_API const TMap< FName, ECoreRedirectFlags > &	GetConfigKeyMap ()

static COREUOBJECT_API ECoreRedirectFlags	GetFlagsForTypeName (FName PackageName, FName TypeName)

static COREUOBJECT_API ECoreRedirectFlags	GetFlagsForTypeClass (UClass *TypeClass)

static COREUOBJECT_API bool	RunTests ()

static COREUOBJECT_API void	AddAssetRedirects (const TMap< FSoftObjectPath, FSoftObjectPath > &InRedirects)

static COREUOBJECT_API void	RemoveAllAssetRedirects ()

Friends
struct	FCoreRedirectsContext

Detailed Description

A container for all of the registered core-level redirects

Member Function Documentation

◆ AddAssetRedirects()

void FCoreRedirects::AddAssetRedirects ( const TMap< FSoftObjectPath, FSoftObjectPath > & InRedirects )

static

Adds a collection of redirects as Type_Asset. These allow FCoreRedirects to support the functions of UObjectRedirector. Any duplicate sources are logged and discarded (only the first redirect from a path is used) Package redirects corresponding to the soft object paths are implicitly created.

◆ AddKnownMissing()

bool FCoreRedirects::AddKnownMissing	(	ECoreRedirectFlags	Type,
		const FCoreRedirectObjectName &	ObjectName,
		ECoreRedirectFlags	Channel = `ECoreRedirectFlags::Option_MissingLoad`
	)

static

Adds the given combination of (Type, ObjectName, Channel) as a missing name; IsKnownMissing queries will now find it

Parameters

Type	Combination of the ECoreRedirectFlags::Type_* flags specifying the type of the object now known to be missing
ObjectName	The name of the object now known to be missing
Channel	may be Option_MissingLoad or Option_None; used to distinguish between detected-at-runtime and specified-by-ini

◆ AddRedirectList()

bool FCoreRedirects::AddRedirectList	(	TArrayView< const FCoreRedirect >	Redirects,
		const FString &	SourceString
	)

static

Adds an array of redirects to global list

◆ ClearKnownMissing()

void FCoreRedirects::ClearKnownMissing	(	ECoreRedirectFlags	Type,
		ECoreRedirectFlags	Channel = `ECoreRedirectFlags::Option_MissingLoad`
	)

static

◆ FindPreviousNames()

bool FCoreRedirects::FindPreviousNames	(	ECoreRedirectFlags	Type,
		const FCoreRedirectObjectName &	NewObjectName,
		TArray< FCoreRedirectObjectName > &	PreviousNames
	)

static

Returns list of names it may have been before

◆ GetConfigKeyMap()

const TMap< FName, ECoreRedirectFlags > & FCoreRedirects::GetConfigKeyMap ( )

static

Gets map from config key -> Flags. It may only be accessed once it becomes constant data after the system is initialized

◆ GetFlagsForTypeClass()

ECoreRedirectFlags FCoreRedirects::GetFlagsForTypeClass ( UClass * TypeClass )

static

Goes from UClass Type to the type flag

◆ GetFlagsForTypeName()

ECoreRedirectFlags FCoreRedirects::GetFlagsForTypeName	(	FName	PackageName,
		FName	TypeName
	)

static

Goes from the containing package and name of the type to the type flag

◆ GetMatchingRedirects()

bool FCoreRedirects::GetMatchingRedirects	(	ECoreRedirectFlags	Type,
		const FCoreRedirectObjectName &	OldObjectName,
		TArray< const FCoreRedirect * > &	FoundRedirects,
		ECoreRedirectMatchFlags	MatchFlags = `ECoreRedirectMatchFlags::None`
	)

static

Returns list of all core redirects that match requirements

◆ GetRedirectedName()

FCoreRedirectObjectName FCoreRedirects::GetRedirectedName	(	ECoreRedirectFlags	Type,
		const FCoreRedirectObjectName &	OldObjectName,
		ECoreRedirectMatchFlags	MatchFlags = `ECoreRedirectMatchFlags::None`
	)

static

Returns a redirected version of the object name. If there are no valid redirects, it will return the original name

◆ GetValueRedirects()

const TMap< FString, FString > * FCoreRedirects::GetValueRedirects	(	ECoreRedirectFlags	Type,
		const FCoreRedirectObjectName &	OldObjectName,
		ECoreRedirectMatchFlags	MatchFlags = `ECoreRedirectMatchFlags::None`
	)

static

Returns map of String->String value redirects for the object name, or nullptr if none found

◆ Initialize()

void FCoreRedirects::Initialize ( )

static

Run initialization steps that are needed before any data can be stored in FCoreRedirects. Reads can occur before this, but no redirects will exist and redirect queries will all return empty.

◆ IsInDebugMode()

bool FCoreRedirects::IsInDebugMode ( )

static

Returns true if this is in debug mode that slows loading and adds additional warnings

◆ IsInitialized()

bool FCoreRedirects::IsInitialized ( )

static

Returns true if this has ever been initialized

◆ IsKnownMissing()

bool FCoreRedirects::IsKnownMissing	(	ECoreRedirectFlags	Type,
		const FCoreRedirectObjectName &	ObjectName
	)

static

Returns true if this name has been registered as explicitly missing

◆ ReadRedirectsFromIni()

bool FCoreRedirects::ReadRedirectsFromIni ( const FString & IniName )

static

Parse all redirects out of a given ini file

◆ RedirectNameAndValues()

bool FCoreRedirects::RedirectNameAndValues	(	ECoreRedirectFlags	Type,
		const FCoreRedirectObjectName &	OldObjectName,
		FCoreRedirectObjectName &	NewObjectName,
		const FCoreRedirect **	FoundValueRedirect,
		ECoreRedirectMatchFlags	MatchFlags = `ECoreRedirectMatchFlags::None`
	)

static

Performs both a name redirect and gets a value redirect struct if it exists. Returns true if either redirect found

◆ RemoveAllAssetRedirects()

void FCoreRedirects::RemoveAllAssetRedirects ( )

static

Clears all redirects added via AddAssetRedirects

◆ RemoveKnownMissing()

bool FCoreRedirects::RemoveKnownMissing	(	ECoreRedirectFlags	Type,
		const FCoreRedirectObjectName &	ObjectName,
		ECoreRedirectFlags	Channel = `ECoreRedirectFlags::Option_MissingLoad`
	)

static

Removes the given combination of (Type, ObjectName, Channel) as a missing name

Parameters

Type	Combination of the ECoreRedirectFlags::Type_* flags specifying the type of the object that has just been loaded.
ObjectName	The name of the object that has just been loaded.
Channel	may be Option_MissingLoad or Option_None; used to distinguish between detected-at-runtime and specified-by-ini

◆ RemoveRedirectList()

bool FCoreRedirects::RemoveRedirectList	(	TArrayView< const FCoreRedirect >	Redirects,
		const FString &	SourceString
	)

static

Removes an array of redirects from global list

◆ RunTests()

bool FCoreRedirects::RunTests ( )

static

Runs set of redirector tests, returns false on failure

◆ ValidateAllRedirects()

void FCoreRedirects::ValidateAllRedirects ( )

static

Validates all known redirects and warn if they seem to point to missing things or violate other constraints

◆ ValidateAssetRedirects()

bool FCoreRedirects::ValidateAssetRedirects ( )

static

Validates asset redirects and warns if chains are detected. Chains should be resolved before adding asset redirects.

◆ ValidateRedirectList()

void FCoreRedirects::ValidateRedirectList	(	TArrayView< const FCoreRedirect >	Redirects,
		const FString &	SourceString
	)

static

Validate a named list of redirects

Friends And Related Symbol Documentation

◆ FCoreRedirectsContext

friend struct FCoreRedirectsContext

friend

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

Engine/Source/Runtime/CoreUObject/Public/UObject/CoreRedirects.h
Engine/Source/Runtime/CoreUObject/Private/UObject/CoreRedirects.cpp

Static Public Member Functions

Friends

Detailed Description

Member Function Documentation

◆ AddAssetRedirects()

◆ AddKnownMissing()

◆ AddRedirectList()

◆ ClearKnownMissing()

◆ FindPreviousNames()

◆ GetConfigKeyMap()

◆ GetFlagsForTypeClass()

◆ GetFlagsForTypeName()

◆ GetMatchingRedirects()

◆ GetRedirectedName()

◆ GetValueRedirects()

◆ Initialize()

◆ IsInDebugMode()

◆ IsInitialized()

◆ IsKnownMissing()

◆ ReadRedirectsFromIni()

◆ RedirectNameAndValues()

◆ RemoveAllAssetRedirects()

◆ RemoveKnownMissing()

◆ RemoveRedirectList()

◆ RunTests()

◆ ValidateAllRedirects()

◆ ValidateAssetRedirects()

◆ ValidateRedirectList()

Friends And Related Symbol Documentation

◆ FCoreRedirectsContext