ULimenSubtitle
Overview
ULimenSubtitle is an abstract class that inherits from ULimenWidget. It handles the logic for displaying and hiding subtitles based on data provided by a UDataTable. The class uses timers to manage the timing of subtitle cues and broadcasts a delegate when all subtitles have been displayed.
Properties
Type | Name | Access | Description |
|---|---|---|---|
TStrongObjectPtr | SubtitleData | Protected | Holds the data table containing subtitle information. |
FTimerHandle | CurrentCueTimerHandle | Private | Timer handle for showing the current subtitle. |
FTimerHandle | NextCueTimerHandle | Private | Timer handle for transitioning to the next subtitle. |
int32 | SubtitleIndex | Private | Index of the currently displayed subtitle. |
Functions
Return Type | Signature | Description |
|---|---|---|
void | SetSubtitleData(const UDataTable* InSubtitleData) | Sets the data table containing subtitle information. |
void | StartDisplayingSubtitles() | Starts displaying subtitles based on the data table. |
void | StopDisplayingSubtitles() | Stops displaying subtitles and clears any timers. |
Usage & Implementation Notes
Threading Constraints: This class uses Unreal Engine's
FTimerManager, which is thread-safe.Replication Requirements: None.
Memory Lifetime Management: The class manages memory for the subtitle data table and handles the lifecycle of timers.
Initialization Dependencies: Depends on a valid
UDataTablecontaining subtitle cues.