FOperatingSystemNotificationManager
#include <OperatingSystemSimulator/Public/Core/OperatingSystemNotificationManager.h>class FOperatingSystemNotificationManagerDefined in OperatingSystemNotificationManager.h:23
Inherits:
NotThreadSafe >
Inheritance diagram
Section titled “Inheritance diagram”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class FOperatingSystemNotificationManager["FOperatingSystemNotificationManager"]
class TSharedFromThis__FOperatingSystemNotificationManager__ESPMode__NotThreadSafe["TSharedFromThis< FOperatingSystemNotificationManager, ESPMode::NotThreadSafe >"]
TSharedFromThis__FOperatingSystemNotificationManager__ESPMode__NotThreadSafe <|-- FOperatingSystemNotificationManager
Collaboration diagram
Section titled “Collaboration diagram”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class FOperatingSystemNotificationManager["FOperatingSystemNotificationManager"]
class FOperatingSystemNotification["FOperatingSystemNotification"]
FOperatingSystemNotificationManager *-- FOperatingSystemNotification
Class detail
Section titled “Class detail”---
config:
class:
hideEmptyMembersBox: true
---
classDiagram
class FOperatingSystemNotificationManager {
+OnShowNotification : FOnShowNotification()
+OnClearAllNotifications : FOnClearAllNotifications()
+FOperatingSystemNotificationManager(UWorld *ParentWorld, const float &TimeToDis
+LogNotification(const FOperatingSystemNotification &NewNoti bool
+ClearAllNotifications()
+GetNotificationsRef() const const TArray< FOperatingSystemNotificati
+CreateNotificationManager(UWorld *ParentWorld, const float &TimeToDis FOperatingSystemNotificationManagerRef()
+Notifications : TArray< FOperatingSystemNotification() >
+TimerHandle_Notifications : FTimerHandle
+World : TWeakObjectPtr< UWorld >
+TimeToDisplay : float
+Internal_ScheduleNextNotification()
+Internal_ShowNotification()
}
Manages operating system notifications for a specific world.
The FOperatingSystemNotificationManager class is responsible for managing operating system notifications for a specific world. It allows logging new notifications, clearing all notifications, and providing a reference to the list of notifications.
Public Attributes
Section titled “Public Attributes”| Return | Name | Description |
|---|---|---|
FOnShowNotification | OnShowNotification | |
FOnClearAllNotifications | OnClearAllNotifications |
OnShowNotification
Section titled “OnShowNotification”FOnShowNotification OnShowNotificationDefined in OperatingSystemNotificationManager.h:50
Referenced by
Section titled “Referenced by”OnClearAllNotifications
Section titled “OnClearAllNotifications”FOnClearAllNotifications OnClearAllNotificationsDefined in OperatingSystemNotificationManager.h:62
Referenced by
Section titled “Referenced by”Public Methods
Section titled “Public Methods”| Return | Name | Description |
|---|---|---|
FOperatingSystemNotificationManager | Constructor for the FOperatingSystemNotificationManager class. | |
bool | LogNotification | Logs a new notification. |
void | ClearAllNotifications | Clears all notifications. |
const TArray< FOperatingSystemNotification > & | GetNotificationsRef const inline | Returns a reference to the list of operating system notifications. |
FOperatingSystemNotificationManager
Section titled “FOperatingSystemNotificationManager”FOperatingSystemNotificationManager(UWorld * ParentWorld, const float & TimeToDisplay)Defined in OperatingSystemNotificationManager.h:38 Constructor for the FOperatingSystemNotificationManager class.
Parameters
Section titled “Parameters”-
ParentWorldA pointer to the parent world. -
TimeToDisplayThe time, in seconds, that notifications should be displayed.
LogNotification
Section titled “LogNotification”bool LogNotification(const FOperatingSystemNotification & NewNotification)Defined in OperatingSystemNotificationManager.h:86 Logs a new notification.
This method logs a new notification by adding it to the notifications list and triggering the display of the notification if needed.
Parameters
Section titled “Parameters”NewNotificationThe notification to be logged.
Returns
Section titled “Returns”True if the notification was logged successfully, false otherwise.
References
Section titled “References”ClearAllNotifications
Section titled “ClearAllNotifications”void ClearAllNotifications()Defined in OperatingSystemNotificationManager.h:95 Clears all notifications.
This method clears all notifications by resetting the Notifications array, clearing the timer for displaying notifications, and executing the OnClearAllNotifications delegate.
See also: OnClearAllNotifications
References
Section titled “References”GetNotificationsRef
Section titled “GetNotificationsRef”const inline
inline const TArray< FOperatingSystemNotification > & GetNotificationsRef() constDefined in OperatingSystemNotificationManager.h:111 Returns a reference to the list of operating system notifications.
This method returns a constant reference to the list of operating system notifications managed by the FOperatingSystemNotificationManager class.
Returns
Section titled “Returns”A constant reference to the list of operating system notifications.
References
Section titled “References”Public Static Methods
Section titled “Public Static Methods”| Return | Name | Description |
|---|---|---|
FOperatingSystemNotificationManagerRef | CreateNotificationManager static inline | Creates a notification manager for a specific world. |
CreateNotificationManager
Section titled “CreateNotificationManager”static inline
static inline FOperatingSystemNotificationManagerRef CreateNotificationManager(UWorld * ParentWorld, const float & TimeToDisplay)Defined in OperatingSystemNotificationManager.h:73 Creates a notification manager for a specific world.
This method creates an instance of the FOperatingSystemNotificationManager class and returns a shared reference to it.
Parameters
Section titled “Parameters”-
ParentWorldA pointer to the parent world. -
TimeToDisplayThe time, in seconds, that notifications should be displayed.
Returns
Section titled “Returns”A shared reference to the created FOperatingSystemNotificationManager.
Referenced by
Section titled “Referenced by”References
Section titled “References”Private Attributes
Section titled “Private Attributes”| Return | Name | Description |
|---|---|---|
TArray< FOperatingSystemNotification > | Notifications | |
FTimerHandle | TimerHandle_Notifications | |
TWeakObjectPtr< UWorld > | World | |
float | TimeToDisplay |
Notifications
Section titled “Notifications”TArray< FOperatingSystemNotification > NotificationsDefined in OperatingSystemNotificationManager.h:25
Referenced by
Section titled “Referenced by”ClearAllNotificationsGetNotificationsRefInternal_ScheduleNextNotificationInternal_ShowNotificationLogNotification~FOperatingSystemNotificationManager
TimerHandle_Notifications
Section titled “TimerHandle_Notifications”FTimerHandle TimerHandle_NotificationsDefined in OperatingSystemNotificationManager.h:26
Referenced by
Section titled “Referenced by”ClearAllNotificationsInternal_ShowNotificationLogNotification~FOperatingSystemNotificationManager
TWeakObjectPtr< UWorld > WorldDefined in OperatingSystemNotificationManager.h:27
Referenced by
Section titled “Referenced by”ClearAllNotificationsInternal_ShowNotificationLogNotification~FOperatingSystemNotificationManager
TimeToDisplay
Section titled “TimeToDisplay”float TimeToDisplayDefined in OperatingSystemNotificationManager.h:28
Referenced by
Section titled “Referenced by”Private Methods
Section titled “Private Methods”| Return | Name | Description |
|---|---|---|
void | Internal_ScheduleNextNotification | |
void | Internal_ShowNotification |
Internal_ScheduleNextNotification
Section titled “Internal_ScheduleNextNotification”void Internal_ScheduleNextNotification()Defined in OperatingSystemNotificationManager.h:99
Referenced by
Section titled “Referenced by”References
Section titled “References”Internal_ShowNotification
Section titled “Internal_ShowNotification”void Internal_ShowNotification()Defined in OperatingSystemNotificationManager.h:100