ULimenNotification
Overview
ULimenNotification is an abstract, non-blueprintable, and hidden Unreal Engine UObject class used primarily for UHT processing. It does not contain any functionality itself but is essential for ensuring proper header generation within the plugin.
Properties
This class has no relevant properties to document based on the provided code.
Functions
This class has no relevant functions to document based on the provided code.
FNotificationParams
Overview
FNotificationParams is a blueprint type struct that encapsulates various properties related to a notification's display characteristics. It allows users to customize the title, message, and display time of a notification through the Unreal Editor.
Properties
Type | Name | Access | Description |
|---|---|---|---|
bool | bUseCustomDisplayTime | EditAnywhere, BlueprintReadWrite | A boolean indicating whether a custom display time is set. |
float | DisplayTime | EditAnywhere, BlueprintReadWrite | The duration for which the notification should be displayed, in seconds. Default value is 3.0 seconds. |
FText | NotificationTitle | EditAnywhere, BlueprintReadWrite | The title text of the notification. |
FText | NotificationMessage | EditAnywhere, BlueprintReadWrite | The message text of the notification. |
Functions
This struct has no relevant functions to document based on the provided code.
FLimenNotification
Overview
FLimenNotification is a utility class designed to encapsulate and manage notification parameters. It provides methods to retrieve these parameters and compare notifications based on their titles and messages.
Properties
Type | Name | Access | Description |
|---|---|---|---|
FNotificationParams | Params | Private | The internal storage for the notification parameters. |
Functions
Return Type | Signature | Description |
|---|---|---|
bool | UseCustomDisplayTime() const | Returns whether a custom display time is set. |
float | GetDisplayTime() const | Retrieves the display time of the notification. |
const FText& | GetNotificationTitle() const | Retrieves the title text of the notification. |
const FText& | GetNotificationMessage() const | Retrieves the message text of the notification. |
bool | operator==(const FLimenNotification* Other) const | Compares two |
explicit operator FNotificationParams() const | Converts the current instance to an | |
const FNotificationParams& | GetParameters() const | Retrieves a reference to the internal |
Usage & Implementation Notes
This class is designed for use within the LimenCore plugin and should not be instantiated directly in blueprints.
The comparison operator (
operator==) checks if two notifications have the same title and message, which can be useful for managing notification queues or collections.