FCoreRedirects

A container for all of the registered core-level redirects

Windows
MacOS
Linux

References

Module

CoreUObject

Header

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

Include

#include "UObject/CoreRedirects.h"

Syntax

struct FCoreRedirects

Remarks

A container for all of the registered core-level redirects

Constructors

No constructors are accessible with public or protected access.

Functions

Name Description

Public function Static

bool

 

AddKnownMissing

(
    ECoreRedirectFlags Type,
    const FCoreRedirectObjectName& Obj...,
    ECoreRedirectFlags Channel
)

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

Public function Static

bool

 

AddRedirectList

(
    TArrayView< const FCoreRedirect > R...,
    const FString& SourceString
)

Adds an array of redirects to global list

Public function Static

void

 

ClearKnownMissing

(
    ECoreRedirectFlags Type,
    ECoreRedirectFlags Channel
)

Public function Static

bool

 

FindPreviousNames

(
    ECoreRedirectFlags Type,
    const FCoreRedirectObjectName& New...,
    TArray< FCoreRedirectObjectName >&...
)

Returns list of names it may have been before

Public function Static

const TMap< ...

 

GetConfigKeyMap()

Gets map from config key -> Flags

Public function Static

ECoreRedirec...

 

GetFlagsForTypeClass

(
    UClass* TypeClass
)

Goes from UClass Type to the type flag

Public function Static

ECoreRedirec...

 

GetFlagsForTypeName

(
    FName PackageName,
    FName TypeName
)

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

Public function Static

bool

 

GetMatchingRedirects

(
    ECoreRedirectFlags Type,
    const FCoreRedirectObjectName& Old...,
    TArray< const FCoreRedirect* >...
)

Returns list of all core redirects that match requirements

Public function Static

FCoreRedirec...

 

GetRedirectedName

(
    ECoreRedirectFlags Type,
    const FCoreRedirectObjectName& Old...
)

Returns a redirected version of the object name.

Public function Static

const TMap< ...

 

GetValueRedirects

(
    ECoreRedirectFlags Type,
    const FCoreRedirectObjectName& Old...
)

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

Public function Static

void

 

Initialize()

Run initialization steps that are needed before any data can be stored in FCoreRedirects.

Public function Static

bool

 

IsInitialized()

Returns true if this has ever been initialized

Public function Static

bool

 

IsKnownMissing

(
    ECoreRedirectFlags Type,
    const FCoreRedirectObjectName& Obj...
)

Returns true if this name has been registered as explicitly missing

Public function Static

bool

 

ReadRedirectsFromIni

(
    const FString& IniName
)

Parse all redirects out of a given ini file

Public function Static

bool

 

RedirectNameAndValues

(
    ECoreRedirectFlags Type,
    const FCoreRedirectObjectName& Old...,
    FCoreRedirectObjectName& NewObject...,
    const FCoreRedirect** Foun...
)

Performs both a name redirect and gets a value redirect struct if it exists.

Public function Static

bool

 

RemoveKnownMissing

(
    ECoreRedirectFlags Type,
    const FCoreRedirectObjectName& Obj...,
    ECoreRedirectFlags Channel
)

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

Public function Static

bool

 

RunTests()

Runs set of redirector tests, returns false on failure

Constants

Name

Description

bInitialized

Whether this has been initialized at least once

ConfigKeyMap

Map from config name to flag

KnownMissingLock

Lock to protect multithreaded access to *KnownMissing functions, which can be called from the async loading threads.

RedirectTypeMap

Map from name of thing being mapped to full list. List must be filtered further

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss