FPreLoadSettingsContainerBase Class Reference

#include <PreLoadSettingsContainer.h>

Inheritance diagram for FPreLoadSettingsContainerBase:

Classes
struct	FCustomBrushDefine
struct	FCustomBrushLoadingGroup
struct	FScreenGroupingBase
struct	FScreenOrderByLoadingGroup

Public Member Functions
virtual PRELOADSCREEN_API void	AddReferencedObjects (FReferenceCollector &Collector) override
virtual FString	GetReferencerName () const override
virtual PRELOADSCREEN_API const FSlateDynamicImageBrush *	GetBrush (const FString &Identifier)
virtual PRELOADSCREEN_API FText	GetLocalizedText (const FString &Identifier)
virtual PRELOADSCREEN_API TSharedPtr< FCompositeFont >	GetFont (const FString &Identifier)
virtual PRELOADSCREEN_API FScreenGroupingBase *	GetScreenGrouping (const FString &Identifier)
int	GetNumScreenGroupings () const
virtual PRELOADSCREEN_API const FScreenGroupingBase *	GetScreenAtIndex (int index) const
virtual PRELOADSCREEN_API bool	IsValidScreenIndex (int index) const
virtual PRELOADSCREEN_API void	CreateCustomSlateImageBrush (const FString &Identifier, const FString &TexturePath, const FVector2D &ImageDimensions)
virtual PRELOADSCREEN_API void	AddLocalizedText (const FString &Identifier, FText LocalizedText)
virtual PRELOADSCREEN_API void	AddScreenGrouping (const FString &Identifier, FScreenGroupingBase &ScreenGrouping)
virtual PRELOADSCREEN_API void	BuildCustomFont (const FString &FontIdentifier, const FString &Language, const FString &FilePath)
virtual PRELOADSCREEN_API bool	BuildSystemFontFile ()
virtual PRELOADSCREEN_API const FString	GetSystemFontFilePath () const
virtual PRELOADSCREEN_API void	ParseBrushConfigEntry (const FString &BrushConfigEntry)
virtual PRELOADSCREEN_API void	ParseFontConfigEntry (const FString &SplitConfigEntry)
virtual PRELOADSCREEN_API void	ParseLocalizedTextConfigString (const FString &SplitConfigEntry)
virtual PRELOADSCREEN_API void	ParseScreenGroupingConfigString (const FString &SplitConfigEntry)
virtual PRELOADSCREEN_API void	ParseLoadingGroups (TArray< FString > &LoadingGroupIdentifiers)
virtual PRELOADSCREEN_API void	ParseAllScreenOrderEntries (TArray< FString > &LoadingGroups, TArray< FString > &ScreenOrderEntries)
virtual PRELOADSCREEN_API void	ParseScreenOrderConfigString (const FString &ScreenOrderEntry)
virtual void	SetPluginContentDir (const FString &PluginContentDirIn)
virtual PRELOADSCREEN_API void	SetShouldLoadBrushes (bool bInShouldLoadBrushes)
FName	GetCurrentLoadGrouping () const
PRELOADSCREEN_API void	LoadGrouping (FName Identifier)
PRELOADSCREEN_API void	PerformInitialAssetLoad ()
virtual PRELOADSCREEN_API FString	ConvertIfPluginRelativeContentPath (const FString &FilePath)
Public Member Functions inherited from FDeferredCleanupInterface
virtual	~FDeferredCleanupInterface ()
Public Member Functions inherited from FGCObject
	FGCObject ()
	FGCObject (const FGCObject &Other)
	FGCObject (FGCObject &&Other)
	FGCObject (EFlags Flags)
virtual	~FGCObject ()
FGCObject &	operator= (const FGCObject &)
FGCObject &	operator= (FGCObject &&)
COREUOBJECT_API void	RegisterGCObject ()
COREUOBJECT_API void	UnregisterGCObject ()
virtual bool	GetReferencerPropertyName (UObject *Object, FString &OutPropertyName) const

Static Public Member Functions
static FPreLoadSettingsContainerBase &	Get ()
static void	Destroy ()
Static Public Member Functions inherited from FGCObject
static COREUOBJECT_API void	StaticInit ()

Public Attributes
float	TimeToDisplayEachBackground
float	TimeToUpdateDownloadedDataSize
float	TimeToRecheckNotificationsPermission
float	TimeToShowNotificationsPermissionModal

Protected Member Functions
virtual PRELOADSCREEN_API bool	IsValidBrushConfig (TArray< FString > &SplitConfigEntry)
virtual PRELOADSCREEN_API bool	IsValidFontConfigString (TArray< FString > &SplitConfigEntry)
virtual PRELOADSCREEN_API bool	IsValidLocalizedTextConfigString (TArray< FString > &SplitConfigEntry)
virtual PRELOADSCREEN_API bool	IsValidScreenGrooupingConfigString (TArray< FString > &SplitConfigEntry)

Protected Attributes
TArray< FString >	ParsedLoadingGroupIdentifiers
TMap< FName, FSlateDynamicImageBrush * >	BrushResources
TMap< FName, FText >	LocalizedTextResources
TMap< FName, TSharedPtr< FStandaloneCompositeFont > >	FontResources
TMap< FName, FScreenOrderByLoadingGroup >	ScreenOrderByLoadingGroups
TMap< FName, FScreenGroupingBase >	ScreenGroupings
TMap< FName, FCustomBrushLoadingGroup >	BrushLoadingGroups
FString	PluginContentDir
bool	bShouldLoadBrushes
FName	CurrentLoadGroup
bool	HasCreatedSystemFontFile

Static Protected Attributes
static PRELOADSCREEN_API FString	UseSystemFontOverride = TEXT("SYSTEM")
static PRELOADSCREEN_API FString	DefaultInitialLoadingGroupIdentifier = TEXT("InitialLoad")
static PRELOADSCREEN_API FPreLoadSettingsContainerBase *	Instance = nullptr

Additional Inherited Members
Public Types inherited from FGCObject
enum class	EFlags : uint32 { None = 0 , RegisterLater = 1 << 0 , AddStableNativeReferencesOnly = 1 << 1 }
Static Public Attributes inherited from FGCObject
static COREUOBJECT_API UGCObjectReferencer *	GGCObjectReferencer = nullptr

Member Function Documentation

AddLocalizedText()

void FPreLoadSettingsContainerBase::AddLocalizedText ( const FString &  Identifier, FText  LocalizedText  )

virtual

AddReferencedObjects()

void FPreLoadSettingsContainerBase::AddReferencedObjects ( FReferenceCollector &  Collector )

overridevirtual

Pure virtual that must be overloaded by the inheriting class. Use this method to serialize any UObjects contained that you wish to keep around.

Parameters

Collector

The collector of referenced objects.

Implements FGCObject.

AddScreenGrouping()

void FPreLoadSettingsContainerBase::AddScreenGrouping ( const FString &  Identifier, FScreenGroupingBase &  ScreenGrouping  )

virtual

BuildCustomFont()

void FPreLoadSettingsContainerBase::BuildCustomFont ( const FString &  FontIdentifier, const FString &  Language, const FString &  FilePath  )

virtual

BuildSystemFontFile()

bool FPreLoadSettingsContainerBase::BuildSystemFontFile ( )

virtual

ConvertIfPluginRelativeContentPath()

FString FPreLoadSettingsContainerBase::ConvertIfPluginRelativeContentPath ( const FString &  FilePath )

virtual

CreateCustomSlateImageBrush()

void FPreLoadSettingsContainerBase::CreateCustomSlateImageBrush ( const FString &  Identifier, const FString &  TexturePath, const FVector2D &  ImageDimensions  )

virtual

Destroy()

static void FPreLoadSettingsContainerBase::Destroy ( )

inlinestatic

Get()

static FPreLoadSettingsContainerBase & FPreLoadSettingsContainerBase::Get ( )

inlinestatic

GetBrush()

const FSlateDynamicImageBrush * FPreLoadSettingsContainerBase::GetBrush ( const FString &  Identifier )

virtual

GetCurrentLoadGrouping()

FName FPreLoadSettingsContainerBase::GetCurrentLoadGrouping ( ) const

inline

GetFont()

TSharedPtr< FCompositeFont > FPreLoadSettingsContainerBase::GetFont ( const FString &  Identifier )

virtual

GetLocalizedText()

FText FPreLoadSettingsContainerBase::GetLocalizedText ( const FString &  Identifier )

virtual

GetNumScreenGroupings()

int FPreLoadSettingsContainerBase::GetNumScreenGroupings ( ) const

inline

GetReferencerName()

virtual FString FPreLoadSettingsContainerBase::GetReferencerName ( ) const

inlineoverridevirtual

Overload this method to report a name for your referencer

Implements FGCObject.

GetScreenAtIndex()

const FPreLoadSettingsContainerBase::FScreenGroupingBase * FPreLoadSettingsContainerBase::GetScreenAtIndex ( int  index ) const

virtual

GetScreenGrouping()

FPreLoadSettingsContainerBase::FScreenGroupingBase * FPreLoadSettingsContainerBase::GetScreenGrouping ( const FString &  Identifier )

virtual

GetSystemFontFilePath()

const FString FPreLoadSettingsContainerBase::GetSystemFontFilePath ( ) const

virtual

IsValidBrushConfig()

bool FPreLoadSettingsContainerBase::IsValidBrushConfig ( TArray< FString > &  SplitConfigEntry )

protectedvirtual

IsValidFontConfigString()

bool FPreLoadSettingsContainerBase::IsValidFontConfigString ( TArray< FString > &  SplitConfigEntry )

protectedvirtual

IsValidLocalizedTextConfigString()

bool FPreLoadSettingsContainerBase::IsValidLocalizedTextConfigString ( TArray< FString > &  SplitConfigEntry )

protectedvirtual

IsValidScreenGrooupingConfigString()

bool FPreLoadSettingsContainerBase::IsValidScreenGrooupingConfigString ( TArray< FString > &  SplitConfigEntry )

protectedvirtual

IsValidScreenIndex()

bool FPreLoadSettingsContainerBase::IsValidScreenIndex ( int  index ) const

virtual

LoadGrouping()

void FPreLoadSettingsContainerBase::LoadGrouping

(

FName

Identifier

)

ParseAllScreenOrderEntries()

void FPreLoadSettingsContainerBase::ParseAllScreenOrderEntries ( TArray< FString > &  LoadingGroups, TArray< FString > &  ScreenOrderEntries  )

virtual

ParseBrushConfigEntry()

void FPreLoadSettingsContainerBase::ParseBrushConfigEntry ( const FString &  BrushConfigEntry )

virtual

ParseFontConfigEntry()

void FPreLoadSettingsContainerBase::ParseFontConfigEntry ( const FString &  SplitConfigEntry )

virtual

ParseLoadingGroups()

void FPreLoadSettingsContainerBase::ParseLoadingGroups ( TArray< FString > &  LoadingGroupIdentifiers )

virtual

ParseLocalizedTextConfigString()

void FPreLoadSettingsContainerBase::ParseLocalizedTextConfigString ( const FString &  SplitConfigEntry )

virtual

ParseScreenGroupingConfigString()

void FPreLoadSettingsContainerBase::ParseScreenGroupingConfigString ( const FString &  SplitConfigEntry )

virtual

ParseScreenOrderConfigString()

void FPreLoadSettingsContainerBase::ParseScreenOrderConfigString ( const FString &  ScreenOrderEntry )

virtual

PerformInitialAssetLoad()

void FPreLoadSettingsContainerBase::PerformInitialAssetLoad

(

)

SetPluginContentDir()

virtual void FPreLoadSettingsContainerBase::SetPluginContentDir ( const FString &  PluginContentDirIn )

inlinevirtual

SetShouldLoadBrushes()

void FPreLoadSettingsContainerBase::SetShouldLoadBrushes ( bool  bInShouldLoadBrushes )

virtual

Member Data Documentation

BrushLoadingGroups

TMap<FName, FCustomBrushLoadingGroup> FPreLoadSettingsContainerBase::BrushLoadingGroups

protected

BrushResources

TMap<FName, FSlateDynamicImageBrush*> FPreLoadSettingsContainerBase::BrushResources

protected

bShouldLoadBrushes

bool FPreLoadSettingsContainerBase::bShouldLoadBrushes

protected

CurrentLoadGroup

FName FPreLoadSettingsContainerBase::CurrentLoadGroup

protected

DefaultInitialLoadingGroupIdentifier

FString FPreLoadSettingsContainerBase::DefaultInitialLoadingGroupIdentifier = TEXT("InitialLoad")

staticprotected

FontResources

TMap<FName, TSharedPtr<FStandaloneCompositeFont> > FPreLoadSettingsContainerBase::FontResources

protected

HasCreatedSystemFontFile

bool FPreLoadSettingsContainerBase::HasCreatedSystemFontFile

protected

Instance

FPreLoadSettingsContainerBase * FPreLoadSettingsContainerBase::Instance = nullptr

staticprotected

LocalizedTextResources

TMap<FName, FText> FPreLoadSettingsContainerBase::LocalizedTextResources

protected

ParsedLoadingGroupIdentifiers

TArray<FString> FPreLoadSettingsContainerBase::ParsedLoadingGroupIdentifiers

protected

PluginContentDir

FString FPreLoadSettingsContainerBase::PluginContentDir

protected

ScreenGroupings

TMap<FName, FScreenGroupingBase> FPreLoadSettingsContainerBase::ScreenGroupings

protected

ScreenOrderByLoadingGroups

TMap<FName, FScreenOrderByLoadingGroup> FPreLoadSettingsContainerBase::ScreenOrderByLoadingGroups

protected

TimeToDisplayEachBackground

float FPreLoadSettingsContainerBase::TimeToDisplayEachBackground

TimeToRecheckNotificationsPermission

float FPreLoadSettingsContainerBase::TimeToRecheckNotificationsPermission

TimeToShowNotificationsPermissionModal

float FPreLoadSettingsContainerBase::TimeToShowNotificationsPermissionModal

TimeToUpdateDownloadedDataSize

float FPreLoadSettingsContainerBase::TimeToUpdateDownloadedDataSize

UseSystemFontOverride

FString FPreLoadSettingsContainerBase::UseSystemFontOverride = TEXT("SYSTEM")

staticprotected

---

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

• Engine/Source/Runtime/PreLoadScreen/Public/PreLoadSettingsContainer.h
• Engine/Source/Runtime/PreLoadScreen/Private/PreLoadSettingsContainer.cpp