ULimenHint
Overview
ULimenHint is an abstract class that serves as a blueprint for creating hint systems within the game. It manages the lifecycle of a hint widget, including initialization, enabling, disabling, and showing/hiding the hint. The class also provides delegates for handling hint dismissal events.
Properties
Type | Name | Access | Description |
|---|---|---|---|
| OnHintDismissed | Public | A delegate that is called when a hint is dismissed. |
Functions
Return Type | Signature | Description |
|---|---|---|
| SetHintWidgetClass(const TSubclassOf< ULimenHintWidget >& InClass) | Sets the class of the hint widget to be used. |
| Initialize() | Initializes the hint system by creating an instance of the hint widget and setting up its lifecycle events. |
| Enable() | Enables the hint system, showing it if it hasn't been shown before. |
| Disable() | Disables the hint system, hiding it if it is currently visible. |
| HasEverBeenVisible() const | Returns true if the hint has ever been shown at least once. |
| GetHintWidget() const | Gets the current instance of the hint widget. |
Usage & Implementation Notes
Threading Constraints: This class is designed to be used on the game thread.
Replication Requirements: None.
Memory Lifetime Management: The hint widget instance is managed internally and will be destroyed when the
HideHintInternalfunction is called withbDestroyWidgetset to true.Initialization Dependencies: The
Initializefunction requires that a validHintWidgetClasshas been set before it can create an instance of the hint widget.