Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine API Reference > Runtime > Overlay > UBasicOverlays

Light Theme

Dark Theme

UBasicOverlays

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)

Windows

MacOS

Linux

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

		Name	Description
	UAssetImportDat...	AssetImportData	The import data used to make this overlays asset
	TArray< FOverla...	Overlays	The overlay data held by this asset. Contains info on timing, position, and the subtitle to display

Overridden from UOverlays

		Name	Description
	TArray< FOve...	GetAllOverlays()	Retrieves the set of overlays that should be used by this object (must be implemented by child classes)
	void	GetOverlaysForTime ( const FTimespan& Time, TArray< FOverlayItem >& OutOverlay... )	Retrieves the set of overlays associated with this object for the given timespan (must be implemented by child classes)

Overridden from UObject

		Name	Description
	void	GetAssetRegistryTags ( TArray< FAssetRegistryTag >& OutTa... )	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	PostInitProperties()	Called after the C++ constructor and after the properties have been initialized, including those loaded from config.

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

Take our survey

Dismiss