NotificationEventHandler

A class to track the state of each notification event type and handle actions based on the player's settings

Index

Constructors

• constructor

Properties

• eventType
• popup
• raisedCount
• settings

Methods

• playAudio
• raise
• raisePopup
• reset

Constructors

constructor

• new NotificationEventHandler(eventType: NotificationEventType, settings: NotificationSetting): NotificationEventHandler

• Creates a new NotificationEventHandler for the specified event type

  ---

  Parameters

  • eventType: NotificationEventType

    The

  • settings: NotificationSetting

    The player settings corresponding to the event type

  Returns NotificationEventHandler

Properties

eventType

eventType: NotificationEventType

popup

popup: Notification

raisedCount

raisedCount: number

settings

settings: NotificationSetting

Methods

playAudio

• playAudio(): boolean

• Determines whether an audio alert shoud be played

  ---

  Returns boolean

  • Whether audio should be played

raise

• raise(data: NotificationData): void

• Raise a notification

  ---

  Parameters

  • data: NotificationData

    Data relating to the event that can be passed into a popup

  Returns void

  • Nothing

raisePopup

• raisePopup(data: NotificationData): void

• Raise a popup notification

  ---

  Parameters

  • data: NotificationData

    Data relating to the event passed into the popup

  Returns void

  • Nothing

reset

• reset(resetingAll: boolean): void

• Resets all raised notifications for this event

  ---

  Parameters

  • resetingAll: boolean

    Indicates if all notifications are being reset, to avoid unnecessarily repeating steps for each event type

  Returns void

  • Nothing