ULimenSubtitleDisplay
Overview
ULimenSubtitleDisplay is an abstract class that inherits from ULimenWidget. It manages the addition, removal, and sorting of subtitles. Subtitles are added to the screen through the AddSubtitle function, which also handles their lifecycle events such as finishing and being dismissed.
Properties
Type | Name | Access | Description |
|---|---|---|---|
TArray<ULimenSubtitle*> | ActiveSubtitles | Private | Stores a list of currently active subtitles. |
Functions
Return Type | Signature | Description |
|---|---|---|
void | BeginDestroy() | Overrides the base class method to clean up any active subtitles before destroying the widget. |
void | AddSubtitle(ULimenSubtitle* InSubtitle) | Adds a new subtitle to the display and manages its lifecycle events. |
void | RemoveSubtitle(ULimenSubtitle* InSubtitle) | Removes a subtitle from the display and stops it from displaying. |
UFUNCTION(BlueprintImplementableEvent) | AddToScreen(ULimenSubtitle* NewSubtitle) | Blueprint-implementable event called when a new subtitle is added to the screen. |
UFUNCTION(BlueprintImplementableEvent) | RemoveFromScreen(ULimenSubtitle* NewSubtitle) | Blueprint-implementable event called when a subtitle is removed from the screen. |
UFUNCTION(BlueprintCallable) | TArray<ULimenSubtitle*> GetSortedSubtitles() const | Returns an array of active subtitles sorted in reverse order. |
Usage & Implementation Notes
Threading Constraints: This class should be used on the game thread as it interacts with Unreal Engine's UI system.
Replication Requirements: None, as this is a client-side widget.
Memory Lifetime Management: Ensure that
ULimenSubtitleobjects are properly managed and destroyed to avoid memory leaks.Initialization Dependencies: Depends on
ULimenWidgetfor its base functionality.