Navigation
API > API/Runtime > API/Runtime/Overlay
Implements an asset that contains a set of Basic Overlays that will be displayed in accordance with the current locale, or a default set if an appropriate locale is not found
| Name | ULocalizedOverlays |
| Type | class |
| Header File | /Engine/Source/Runtime/Overlay/Public/LocalizedOverlays.h |
| Include Path | #include "LocalizedOverlays.h" |
Syntax
UCLASS (BlueprintType, HideCategories=(Object), MinimalAPI)
class ULocalizedOverlays : public UOverlays
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UOverlays → ULocalizedOverlays
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetImportData | TObjectPtr< UAssetImportData > | The import data used to make this overlays asset | LocalizedOverlays.h |
|
| DefaultOverlays | TObjectPtr< UBasicOverlays > | The overlays to use if no overlays are found for the current culture | LocalizedOverlays.h |
|
| LocaleToOverlaysMap | TMap< FString, TObjectPtr< UBasicOverlays > > | Maps a set of cultures to specific BasicOverlays assets. | LocalizedOverlays.h |
|
Functions
Public
Overridden from UOverlays
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual TArray< FOverlayItem > GetAllOverlays() |
Retrieves the set of overlays that should be used by this object (must be implemented by child classes) | LocalizedOverlays.h | |
virtual void GetOverlaysForTime
(
const FTimespan& Time, |
Retrieves the set of overlays associated with this object for the given timespan (must be implemented by child classes) | LocalizedOverlays.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
LocalizedOverlays.h | ||
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
LocalizedOverlays.h | ||
virtual void PostInitProperties() |
LocalizedOverlays.h |