1. Epic GamesDeveloper
  3. FPreLoadSettingsContainerBase

FPreLoadSettingsContainerBase

This is a helper class that we use to hold values we parse from the .ini.

API > API/Runtime > API/Runtime/PreLoadScreen

This is a helper class that we use to hold values we parse from the .ini. Clean way to access things like dynamic image brushes / fonts / etc used in our UI that we want to be somewhat data driven but we can't rely on UObject support to implement(as the PreLoad stuff happens too early for UObject support) This lets us set easy to change values in our .ini that are parsed at runtime and stored in this container

   
Name FPreLoadSettingsContainerBase
Type class
Header File /Engine/Source/Runtime/PreLoadScreen/Public/PreLoadSettingsContainer.h
Include Path #include "PreLoadSettingsContainer.h"

Syntax

class FPreLoadSettingsContainerBase :  
    public FDeferredCleanupInterface ,  
    public FGCObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

FPreLoadSettingsContainerBase()

   PreLoadSettingsContainer.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~FPreLoadSettingsContainerBase()

   PreLoadSettingsContainer.h  

Structs

Name Remarks
FCustomBrushDefine Helper struct to store information required to construct a CustomSlateImageBrush. Parsed from our .ini.
FCustomBrushLoadingGroup Helper struct to store all BrushDefines we need to load for a given BrushLoadingGroup.
FScreenGroupingBase Helper struct to store groups of things we want to display together in the UI so that we can parse it easily in the .ini.
FScreenOrderByLoadingGroup This is a listing of ScreenGroupings (stored by Identifier) that should be displayed in this order during a particular LoadingGroup.

Constants

Name Type Remarks Include Path
DefaultInitialLoadingGroupIdentifier FString If we supply no loading groups, use this identifier by default. PreLoadSettingsContainer.h
Instance FPreLoadSettingsContainerBase * Singleton Instance This is only not a TSharedPtr as it needs to be cleaned up by a deferredcleanup call which directly destroys the underlying object, causing a SharedPtr crash at shutdown. PreLoadSettingsContainer.h
UseSystemFontOverride FString If our Font filepath is set to this, we use the system font instead of a custom font we load in. PreLoadSettingsContainer.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
TimeToDisplayEachBackground float   PreLoadSettingsContainer.h  
TimeToRecheckNotificationsPermission float   PreLoadSettingsContainer.h  
TimeToShowNotificationsPermissionModal float   PreLoadSettingsContainer.h  
TimeToUpdateDownloadedDataSize float   PreLoadSettingsContainer.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual void AddLocalizedText ( const FString& Identifier,
FText LocalizedText
)

   PreLoadSettingsContainer.h  

virtual void AddScreenGrouping ( const FString& Identifier,
FScreenGroupingBase& ScreenGrouping
)

   PreLoadSettingsContainer.h  

virtual void BuildCustomFont ( const FString& FontIdentifier,
const FString& Language,
const FString& FilePath
)

 Maps the given font file to the given language and stores it under the FontIdentifier. PreLoadSettingsContainer.h  

virtual bool BuildSystemFontFile()

   PreLoadSettingsContainer.h  

virtual FString ConvertIfPluginRelativeContentPath ( const FString& FilePath
)

 Helper function that takes in a file path and tries to reconsile it to be Plugin Specific if applicable. PreLoadSettingsContainer.h  

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

   PreLoadSettingsContainer.h  

virtual const FSlateDynamicImageBrush * GetBrush ( const FString& Identifier
)

   PreLoadSettingsContainer.h  

FName GetCurrentLoadGrouping()

   PreLoadSettingsContainer.h  

virtual TSharedPtr< FCompositeFont > GetFont ( const FString& Identifier
)

   PreLoadSettingsContainer.h  

virtual FText GetLocalizedText ( const FString& Identifier
)

   PreLoadSettingsContainer.h  

int GetNumScreenGroupings()

   PreLoadSettingsContainer.h  

virtual const FScreenGroupingBase * GetScreenAtIndex ( int index
) const

   PreLoadSettingsContainer.h  

virtual FScreenGroupingBase * GetScreenGrouping ( const FString& Identifier
)

   PreLoadSettingsContainer.h  

virtual const FString GetSystemFontFilePath()

   PreLoadSettingsContainer.h  

virtual bool IsValidScreenIndex ( int index
) const

   PreLoadSettingsContainer.h  

void LoadGrouping ( FName Identifier
)

   PreLoadSettingsContainer.h  

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

   PreLoadSettingsContainer.h  

virtual void ParseBrushConfigEntry ( const FString& BrushConfigEntry
)

 Helper functions that parse a .ini config entry and call the appropriate create function to. PreLoadSettingsContainer.h  

virtual void ParseFontConfigEntry ( const FString& SplitConfigEntry
)

   PreLoadSettingsContainer.h  

virtual void ParseLoadingGroups ( TArray< FString >& LoadingGroupIdentifiers
)

 Helper function to parse all .ini entries for LoadingGroups and ScreenOrder. PreLoadSettingsContainer.h  

virtual void ParseLocalizedTextConfigString ( const FString& SplitConfigEntry
)

   PreLoadSettingsContainer.h  

virtual void ParseScreenGroupingConfigString ( const FString& SplitConfigEntry
)

   PreLoadSettingsContainer.h  

virtual void ParseScreenOrderConfigString ( const FString& ScreenOrderEntry
)

   PreLoadSettingsContainer.h  

void PerformInitialAssetLoad()

   PreLoadSettingsContainer.h  

virtual void SetPluginContentDir ( const FString& PluginContentDirIn
)

 Sets the PluginContent dir so that when parsing config entries we can accept plugin relative file paths. PreLoadSettingsContainer.h  

virtual void SetShouldLoadBrushes ( bool bInShouldLoadBrushes
)

 Tells the container rather it should actually load image brushes. PreLoadSettingsContainer.h  

Overridden from FGCObject

Name Remarks Include Path Unreal Specifiers

virtual void AddReferencedObjects ( FReferenceCollector& Collector
)

   PreLoadSettingsContainer.h  

virtual FString GetReferencerName()

   PreLoadSettingsContainer.h  

Protected

Name Remarks Include Path Unreal Specifiers

virtual bool IsValidBrushConfig ( TArray< FString >& SplitConfigEntry
)

 Helper functions that verify if the supplied .ini config entry is valid to create a resource out of it. PreLoadSettingsContainer.h  

virtual bool IsValidFontConfigString ( TArray< FString >& SplitConfigEntry
)

   PreLoadSettingsContainer.h  

virtual bool IsValidLocalizedTextConfigString ( TArray< FString >& SplitConfigEntry
)

   PreLoadSettingsContainer.h  

virtual bool IsValidScreenGrooupingConfigString ( TArray< FString >& SplitConfigEntry
)

   PreLoadSettingsContainer.h  

Static

Name Remarks Include Path Unreal Specifiers

static void Destroy()

   PreLoadSettingsContainer.h  
  PreLoadSettingsContainer.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page