UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
LocalizedOverlays.h
Go to the documentation of this file.
1// Copyright Epic Games, Inc. All Rights Reserved.
2
3#pragma once
4
5#include "Containers/Array.h"
6#include "Containers/Map.h"
8#include "CoreTypes.h"
9#include "Misc/Timespan.h"
10#include "Overlays.h"
11#include "UObject/Object.h"
13#include "UObject/ObjectPtr.h"
16
17#include "LocalizedOverlays.generated.h"
18
19class FString;
21class UBasicOverlays;
22class UObject;
23
28UCLASS(BlueprintType, hidecategories = (Object), MinimalAPI)
31{
33
34public:
35
37 UPROPERTY(EditAnywhere, Category="Overlay Data")
38 TObjectPtr<UBasicOverlays> DefaultOverlays;
39
47 UPROPERTY(EditAnywhere, Category="Overlay Data")
48 TMap<FString, TObjectPtr<UBasicOverlays>> LocaleToOverlaysMap;
49
50#if WITH_EDITORONLY_DATA
51
53 UPROPERTY(VisibleAnywhere, Instanced, Category="Import Settings")
55
56#endif // WITH_EDITORONLY_DATA
57
58public:
59
60 //~ UOverlays interface
61
62 OVERLAY_API virtual TArray<FOverlayItem> GetAllOverlays() const override;
63 OVERLAY_API virtual void GetOverlaysForTime(const FTimespan& Time, TArray<FOverlayItem>& OutOverlays) const override;
64
65
66public:
67
68 //~ UObject interface
69
70 OVERLAY_API virtual void PostInitProperties() override;
72 UE_DEPRECATED(5.4, "Implement the version that takes FAssetRegistryTagsContext instead.")
74
76
80 UBasicOverlays* GetCurrentLocaleOverlays() const;
81};
#define UE_DEPRECATED(Version, Message)
Definition CoreMiscDefines.h:302
UE_FORCEINLINE_HINT TSharedRef< CastToType, Mode > StaticCastSharedRef(TSharedRef< CastFromType, Mode > const &InSharedRef)
Definition SharedPointer.h:127
#define UPROPERTY(...)
UObject definition macros.
Definition ObjectMacros.h:744
#define GENERATED_BODY(...)
Definition ObjectMacros.h:765
#define UCLASS(...)
Definition ObjectMacros.h:776
Definition AssetRegistryTagsContext.h:98
Definition Array.h:670
Definition UnrealString.h.inl:34
Definition AssetImportData.h:72
Definition BasicOverlays.h:27
Definition LocalizedOverlays.h:31
Definition Object.h:95
virtual COREUOBJECT_API void GetAssetRegistryTags(FAssetRegistryTagsContext Context) const
Definition Obj.cpp:2423
virtual COREUOBJECT_API void PostInitProperties()
Definition UObjectGlobals.cpp:3961
Definition Overlays.h:49
Definition Timespan.h:76
Definition ObjectPtr.h:488
Definition Object.h:827