Navigation
API > API/Runtime > API/Runtime/Overlay
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UOverlays
- UBasicOverlays
References
| Module | Overlay |
| Header | /Engine/Source/Runtime/Overlay/Public/BasicOverlays.h |
| Include | #include "BasicOverlays.h" |
Syntax
class UBasicOverlays : public UOverlays
Remarks
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)
Variables
| Type | Name | Description | |
|---|---|---|---|
| TObjectPtr< UAssetImportData > | AssetImportData | The import data used to make this overlays asset | |
| TArray< FOverlayItem > | Overlays | The overlay data held by this asset. Contains info on timing, position, and the subtitle to display |
Overridden from UOverlays
| Type | Name | Description | |
|---|---|---|---|
| TArray< FOverlayItem > | Retrieves the set of overlays that should be used by this object (must be implemented by child classes) | ||
| void | GetOverlaysForTime
(
const FTimespan& Time, |
Retrieves the set of overlays associated with this object for the given timespan (must be implemented by child classes) |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
| void | GetAssetRegistryTags
(
TArray< FAssetRegistryTag >& OutTags |
Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects | |
| void | Called after the C++ constructor and after the properties have been initialized, including those loaded from config. |