Navigation
API > API/Runtime > API/Runtime/Overlay
Implements an asset that contains a set of overlay data (which includes timing, text, and position) to be displayed for any given source (including, but not limited to, audio, dialog, and movies)
| Name | UBasicOverlays |
| Type | class |
| Header File | /Engine/Source/Runtime/Overlay/Public/BasicOverlays.h |
| Include Path | #include "BasicOverlays.h" |
Syntax
UCLASS (BlueprintType, HideCategories=(Object), MinimalAPI)
class UBasicOverlays : public UOverlays
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UOverlays → UBasicOverlays
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AssetImportData | TObjectPtr< UAssetImportData > | The import data used to make this overlays asset | BasicOverlays.h |
|
| Overlays | TArray< FOverlayItem > | The overlay data held by this asset. Contains info on timing, position, and the subtitle to display | BasicOverlays.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) | BasicOverlays.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) | BasicOverlays.h |
Overridden from UObject
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void GetAssetRegistryTags
(
FAssetRegistryTagsContext Context |
BasicOverlays.h | ||
virtual void GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
BasicOverlays.h | ||
virtual void PostInitProperties() |
BasicOverlays.h |