documentation

Visometry.DesignSystem.Notification Class Reference

MonoBehaviour that is used with the VLNotification.prefab and which is managing its UI components. Its appearance and behaviour is set during instantiation by its NotificationObject. More...

Inherits MonoBehaviour.

Public Types

enum  Kind { Error , Warning , Success , Info }
 
enum  Position { Bottom , Ceiling }
 
enum  Type { Inline }
 

Public Member Functions

void ApplyOffset (bool applyInPositiveDirection, int order)
 
delegate void NotificationDelegate (Notification notification)
 Delegate for event texts.
 
void SetAction (System.Action action)
 
void SetColor (Color color)
 
void SetIcon (string icon)
 
void SetPosition (Position position)
 
void SetTexts (string titleText, string captionText)
 
void SetVisibilityOfChildren (bool show)
 
void TriggerDestroyAfterSeconds (float seconds)
 

Data Fields

bool isDisabled = false
 

Events

NotificationDelegate OnDeleted
 Event which will be emitted after the notification has been deleted externally.
 
NotificationDelegate OnWaitingForDestroyFinished
 Event which will be emitted as soon as the notification reached its time to be destroyed.
 

Detailed Description

MonoBehaviour that is used with the VLNotification.prefab and which is managing its UI components. Its appearance and behaviour is set during instantiation by its NotificationObject.