FPreLoadSettingsContainerBase

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

Windows
MacOS
Linux

Inheritance Hierarchy

FDeferredCleanupInterface

FPreLoadSettingsContainerBase

References

Module

PreLoadScreen

Header

/Engine/Source/Runtime/PreLoadScreen/Public/PreLoadSettingsContainer.h

Include

#include "PreLoadSettingsContainer.h"

Syntax

class FPreLoadSettingsContainerBase : public FDeferredCleanupInterface

Remarks

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

Variables

Name Description

Protected variable

TMap< FName, FC...

 

BrushLoadingGroups

Protected variable

TMap< FName, co...

 

BrushResources

Property Storage.

Protected variable

bool

 

bShouldLoadBrushes

Rather we should load image brushes.

Protected variable

FName

 

CurrentLoadGroup

Protected variable

TMap< FName, TS...

 

FontResources

Protected variable

bool

 

HasCreatedSystemFontFile

Protected variable

TMap< FName, FT...

 

LocalizedTextResources

Protected variable

TArray< FString...

 

ParsedLoadingGroupIdentifiers

Protected variable

FString

 

PluginContentDir

This string is used to make file paths relative to a particular Plugin's content directory when parsing file paths.

Protected variable

TMap< FName, FS...

 

ScreenGroupings

Protected variable

TMap< FName, FS...

 

ScreenOrderByLoadingGroups

Public variable

float

 

TimeToDisplayEachBackground

Constructors

Destructors

Functions

Name Description

Public function Virtual

void

 

AddLocalizedText

(
    const FString& Identifier,
    FText LocalizedText
)

Public function Virtual

void

 

AddScreenGrouping

(
    const FString& Identifier,
    FScreenGroupingBase& ScreenGroupin...
)

Public function 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.

Public function Virtual

bool

 

BuildSystemFontFile()

Public function 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.

Public function Virtual

void

 

CreateCustomSlateImageBrush

(
    const FString& Identifier,
    const FString& TexturePath,
    const FVector2D& ImageDimensions
)

Public function Static

void

 

Destroy()

Public function Static

FPreLoadSett...

 

Get()

Public function Virtual

const FSlate...

 

GetBrush

(
    const FString& Identifier
)

Public function Const

FName

 

GetCurrentLoadGrouping()

Public function Virtual

TSharedPtr< ...

 

GetFont

(
    const FString& Identifier
)

Public function Virtual

FText

 

GetLocalizedText

(
    const FString& Identifier
)

Public function Const

int

 

GetNumScreenGroupings()

Public function Virtual Const

const FScree...

 

GetScreenAtIndex

(
    int index
)

Public function Virtual

FScreenGroup...

 

GetScreenGrouping

(
    const FString& Identifier
)

Public function Virtual Const

const FStrin...

 

GetSystemFontFilePath()

Protected function Virtual

bool

 

IsValidBrushConfig

(
    TArray< FString >& SplitConfigEntr...
)

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

Protected function Virtual

bool

 

IsValidFontConfigString

(
    TArray< FString >& SplitConfigEntr...
)

Protected function Virtual

bool

 

IsValidLocalizedTextConfigString

(
    TArray< FString >& SplitConfigEntr...
)

Protected function Virtual

bool

 

IsValidScreenGrooupingConfigString

(
    TArray< FString >& SplitConfigEntr...
)

Public function Virtual Const

bool

 

IsValidScreenIndex

(
    int index
)

Public function

void

 

LoadGrouping

(
    FName Identifier
)

Public function Virtual

void

 

ParseAllScreenOrderEntries

(
    TArray< FString >& LoadingGroups,
    TArray< FString >& ScreenOrderEntr...
)

Public function Virtual

void

 

ParseBrushConfigEntry

(
    const FString& BrushConfigEntry
)

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

Public function Virtual

void

 

ParseFontConfigEntry

(
    const FString& SplitConfigEntry
)

Public function Virtual

void

 

ParseLoadingGroups

(
    TArray< FString >& LoadingGroupIde...
)

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

Public function Virtual

void

 

ParseLocalizedTextConfigString

(
    const FString& SplitConfigEntry
)

Public function Virtual

void

 

ParseScreenGroupingConfigString

(
    const FString& SplitConfigEntry
)

Public function Virtual

void

 

ParseScreenOrderConfigString

(
    const FString& ScreenOrderEntry
)

Public function

void

 

PerformInitialAssetLoad()

Public function Virtual

void

 

SetPluginContentDir

(
    const FString& PluginContentDirIn
)

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

Public function Virtual

void

 

SetShouldLoadBrushes

(
    bool bInShouldLoadBrushes
)

Tells the container rather it should actually load image brushes.

Classes

Name

Description

Public struct

FCustomBrushDefine

Helper struct to store information required to construct a CustomSlateImageBrush. Parsed from our .ini.

Public struct

FCustomBrushLoadingGroup

Helper struct to store all BrushDefines we need to load for a given BrushLoadingGroup.

Public struct

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.

Public struct

FScreenOrderByLoadingGroup

This is a listing of ScreenGroupings (stored by Identifier) that should be displayed in this order during a particular LoadingGroup.

Constants

Name

Description

DefaultInitialLoadingGroupIdentifier

If we supply no loading groups, use this identifier by default.

Instance

Singleton Instance This is only not a TSharedPtr as it needs to be cleaned up by a deferredcleanup call which directly nukes the underlying object, causing a SharedPtr crash at shutdown.

UseSystemFontOverride

If our Font filepath is set to this, we use the system font instead of a custom font we load in.

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