IStringTableEngineBridge Class Reference

#include <StringTableCore.h>

Inheritance diagram for IStringTableEngineBridge:

Classes
struct	FScopedDeferFindOrLoad

Public Types
typedef TFunction< void(FName, FName)>	FLoadStringTableAssetCallback

Static Public Member Functions
static bool	CanFindOrLoadStringTableAsset ()
static int32	LoadStringTableAsset (const FName InTableId, FLoadStringTableAssetCallback InLoadedCallback=FLoadStringTableAssetCallback())
static void	FullyLoadStringTableAsset (FName &InOutTableId)
static void	RedirectStringTableAsset (FName &InOutTableId)
static void	CollectStringTableAssetReferences (FName &InOutTableId, FStructuredArchive::FSlot Slot)
static void	CollectStringTableAssetSearchableName (const FName InTableId, const FTextKey InKey, const FArchive &Ar)
static bool	IsStringTableFromAsset (const FName InTableId)
static bool	IsStringTableAssetBeingReplaced (const UStringTable *InStringTableAsset)

Protected Member Functions
virtual	~IStringTableEngineBridge ()=default
virtual bool	CanFindOrLoadStringTableAssetImpl ()=0
virtual int32	LoadStringTableAssetImpl (const FName InTableId, FLoadStringTableAssetCallback InLoadedCallback)=0
virtual void	FullyLoadStringTableAssetImpl (FName &InOutTableId)=0
virtual void	RedirectStringTableAssetImpl (FName &InOutTableId)=0
virtual void	CollectStringTableAssetReferencesImpl (FName &InOutTableId, FStructuredArchive::FSlot Slot)=0
virtual void	CollectStringTableAssetSearchableNameImpl (const FName InTableId, const FTextKey InKey, const FArchive &Ar)=0
virtual bool	IsStringTableFromAssetImpl (const FName InTableId)=0
virtual bool	IsStringTableAssetBeingReplacedImpl (const UStringTable *InStringTableAsset)=0

Static Protected Attributes
static CORE_API IStringTableEngineBridge *	InstancePtr = nullptr
static CORE_API std::atomic< int8 >	DeferFindOrLoad

Detailed Description

Interface to allow Core code to access String Table assets from the Engine

Member Typedef Documentation

FLoadStringTableAssetCallback

typedef TFunction<void(FName, FName)> IStringTableEngineBridge::FLoadStringTableAssetCallback

Callback used when loading string table assets.

Parameters

The	name of the table we were asked to load.
The	name of the table we actually loaded (may be different if redirected; will be empty if the load failed).

Constructor & Destructor Documentation

~IStringTableEngineBridge()

virtual IStringTableEngineBridge::~IStringTableEngineBridge ( )

protectedvirtualdefault

Member Function Documentation

CanFindOrLoadStringTableAsset()

static bool IStringTableEngineBridge::CanFindOrLoadStringTableAsset ( )

inlinestatic

Check to see whether it is currently safe to attempt to find or load a string table asset.

Returns

True if it is safe to attempt to find or load a string table asset, false otherwise.

CanFindOrLoadStringTableAssetImpl()

virtual bool IStringTableEngineBridge::CanFindOrLoadStringTableAssetImpl ( )

protectedpure virtual

CollectStringTableAssetReferences()

static void IStringTableEngineBridge::CollectStringTableAssetReferences ( FName &  InOutTableId, FStructuredArchive::FSlot  Slot  )

inlinestatic

Collect a string table asset reference

CollectStringTableAssetReferencesImpl()

virtual void IStringTableEngineBridge::CollectStringTableAssetReferencesImpl ( FName &  InOutTableId, FStructuredArchive::FSlot  Slot  )

protectedpure virtual

CollectStringTableAssetSearchableName()

static void IStringTableEngineBridge::CollectStringTableAssetSearchableName ( const FName  InTableId, const FTextKey  InKey, const FArchive &  Ar  )

inlinestatic

Collect any searchable name data for a string table asset entry reference

CollectStringTableAssetSearchableNameImpl()

virtual void IStringTableEngineBridge::CollectStringTableAssetSearchableNameImpl ( const FName  InTableId, const FTextKey  InKey, const FArchive &  Ar  )

protectedpure virtual

FullyLoadStringTableAsset()

static void IStringTableEngineBridge::FullyLoadStringTableAsset ( FName &  InOutTableId )

inlinestatic

Fully load a string table asset by its name, synchronously.

Note

This should be used sparingly in places where it is definitely safe to perform a blocking load.

FullyLoadStringTableAssetImpl()

virtual void IStringTableEngineBridge::FullyLoadStringTableAssetImpl ( FName &  InOutTableId )

protectedpure virtual

IsStringTableAssetBeingReplaced()

static bool IStringTableEngineBridge::IsStringTableAssetBeingReplaced ( const UStringTable *  InStringTableAsset )

inlinestatic

Is this string table asset being replaced due to a hot-reload?

IsStringTableAssetBeingReplacedImpl()

virtual bool IStringTableEngineBridge::IsStringTableAssetBeingReplacedImpl ( const UStringTable *  InStringTableAsset )

protectedpure virtual

IsStringTableFromAsset()

static bool IStringTableEngineBridge::IsStringTableFromAsset ( const FName  InTableId )

inlinestatic

Is this string table from an asset?

IsStringTableFromAssetImpl()

virtual bool IStringTableEngineBridge::IsStringTableFromAssetImpl ( const FName  InTableId )

protectedpure virtual

LoadStringTableAsset()

static int32 IStringTableEngineBridge::LoadStringTableAsset ( const FName  InTableId, FLoadStringTableAssetCallback  InLoadedCallback = FLoadStringTableAssetCallback()  )

inlinestatic

Load a string table asset by its name, potentially doing so asynchronously.

Note

If the string table is already loaded, or loading is perform synchronously, then the callback will be called before this function returns.

Returns

The async loading ID of the asset, or INDEX_NONE if no async loading was performed.

LoadStringTableAssetImpl()

virtual int32 IStringTableEngineBridge::LoadStringTableAssetImpl ( const FName  InTableId, FLoadStringTableAssetCallback  InLoadedCallback  )

protectedpure virtual

RedirectStringTableAsset()

static void IStringTableEngineBridge::RedirectStringTableAsset ( FName &  InOutTableId )

inlinestatic

Redirect string table asset by its name

RedirectStringTableAssetImpl()

virtual void IStringTableEngineBridge::RedirectStringTableAssetImpl ( FName &  InOutTableId )

protectedpure virtual

Member Data Documentation

DeferFindOrLoad

std::atomic< int8 > IStringTableEngineBridge::DeferFindOrLoad

staticprotected

Whether String Table find/load is currently deferred (eg, during module load)

InstancePtr

IStringTableEngineBridge * IStringTableEngineBridge::InstancePtr = nullptr

staticprotected

Singleton instance, populated by the derived type

---

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

• Engine/Source/Runtime/Core/Public/Internationalization/StringTableCore.h
• Engine/Source/Runtime/Core/Private/Internationalization/StringTableCore.cpp