FOperatingSystemNotificationManager Class Reference

Manages operating system notifications for a specific world. More...

#include "OperatingSystemNotificationManager.h"

Inheritance diagram for FOperatingSystemNotificationManager:

Collaboration diagram for FOperatingSystemNotificationManager:

Public Member Functions
	FOperatingSystemNotificationManager (UWorld *ParentWorld, const float &TimeToDisplay)
	Constructor for the FOperatingSystemNotificationManager class.
	~FOperatingSystemNotificationManager ()
bool	LogNotification (const FOperatingSystemNotification &NewNotification)
	Logs a new notification.
void	ClearAllNotifications ()
	Clears all notifications.
FORCEINLINE const TArray< FOperatingSystemNotification > &	GetNotificationsRef () const
	Returns a reference to the list of operating system notifications.

Static Public Member Functions
static FORCEINLINE FOperatingSystemNotificationManagerRef	CreateNotificationManager (UWorld *ParentWorld, const float &TimeToDisplay)
	Creates a notification manager for a specific world.

Public Attributes
FOnShowNotification	OnShowNotification
FOnClearAllNotifications	OnClearAllNotifications

Detailed Description

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.

Constructor & Destructor Documentation

FOperatingSystemNotificationManager()

FOperatingSystemNotificationManager::FOperatingSystemNotificationManager	(	UWorld *	ParentWorld,
		const float &	TimeToDisplay )

Constructor for the FOperatingSystemNotificationManager class.

Parameters

ParentWorld	A pointer to the parent world.
TimeToDisplay	The time, in seconds, that notifications should be displayed.

~FOperatingSystemNotificationManager()

FOperatingSystemNotificationManager::~FOperatingSystemNotificationManager

(

)

Member Function Documentation

ClearAllNotifications()

void FOperatingSystemNotificationManager::ClearAllNotifications

(

)

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

CreateNotificationManager()

static FORCEINLINE FOperatingSystemNotificationManagerRef FOperatingSystemNotificationManager::CreateNotificationManager ( UWorld * ParentWorld, const float & TimeToDisplay )

inlinestatic

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

ParentWorld	A pointer to the parent world.
TimeToDisplay	The time, in seconds, that notifications should be displayed.

Returns

A shared reference to the created FOperatingSystemNotificationManager.

GetNotificationsRef()

FORCEINLINE const TArray< FOperatingSystemNotification > & FOperatingSystemNotificationManager::GetNotificationsRef ( ) const

inline

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

A constant reference to the list of operating system notifications.

LogNotification()

bool FOperatingSystemNotificationManager::LogNotification

(

const FOperatingSystemNotification &

NewNotification

)

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

NewNotification

The notification to be logged.

Returns

True if the notification was logged successfully, false otherwise.

Here is the call graph for this function:

Member Data Documentation

OnClearAllNotifications

FOnClearAllNotifications FOperatingSystemNotificationManager::OnClearAllNotifications

OnShowNotification

FOnShowNotification FOperatingSystemNotificationManager::OnShowNotification

---

The documentation for this class was generated from the following files:

• Source/OperatingSystemSimulator/Public/Core/OperatingSystemNotificationManager.h
• Source/OperatingSystemSimulator/Private/Core/OperatingSystemNotificationManager.cpp