class MAGES::UIs::NotificationSystem¶

Overview¶

Notification system. More…

class NotificationSystem: public MonoBehaviour
{
public:
    // enums

    enum NotificationType;

    // classes

    class NotificationInfo;

    // properties

    NotificationSystem Instance;

    // methods

    void SpawnNotification(
        NotificationType notificationType,
        string text,
        bool priority = false,
        float time = 4.0f,
        float height = 1.2f
    );

    void StopAllNotifications();
};

Detailed Documentation¶

Notification system.

Properties¶

NotificationSystem Instance

Gets the instance of the notification system.

Methods¶

void SpawnNotification(
    NotificationType notificationType,
    string text,
    bool priority = false,
    float time = 4.0f,
    float height = 1.2f
)

Spawns a notification.

Parameters:

notificationType	The notification type.
text	The text that the notification will display.
priority	Set true to spawn it immediately. Otherwise if there is another notification it will wait.
time	The duration where the notification stays active in the scene.
height	The height where the notification will spawn.

void StopAllNotifications()

This method will stop the current active notification.