Protected Member Functions
void	NotificationSystem ()
NotificationData	GetNotificationData (NotificationType type)

Static Protected Member Functions
static void	AddNotification (NotificationType type, float show_time, string detail_text="")
	Send notification from default types to local player.
static void	AddNotificationExtended (float show_time, string title_text, string detail_text="", string icon="")
	Send custom notification from to local player.
static void	CleanupInstance ()
static NotificationSystem	GetInstance ()
static void	InitInstance ()
static void	LoadNotificationData ()
static void	SendNotificationToPlayer (Man player, NotificationType type, float show_time, string detail_text="")
	Send notification from default types to player from server.
static void	SendNotificationToPlayerExtended (Man player, float show_time, string title_text, string detail_text="", string icon="")
	Send custom notification to player from server.
static void	SendNotificationToPlayerIdentity (PlayerIdentity player, NotificationType type, float show_time, string detail_text="")
	Send notification from default types to player identity from server.
static void	SendNotificationToPlayerIdentityExtended (PlayerIdentity player, float show_time, string title_text, string detail_text="", string icon="")
	Send custom notification to player identity from server.
static void	Update (float timeslice)

Protected Attributes
ref map< NotificationType, ref NotificationData >	m_DataArray
ref array< ref NotificationRuntimeData >	m_DeferredArray
ref ScriptInvoker	m_OnNotificationAdded = new ScriptInvoker()
ref ScriptInvoker	m_OnNotificationRemoved = new ScriptInvoker()
ref array< ref NotificationRuntimeData >	m_TimeArray
float	m_TimeElapsed

Static Protected Attributes
static const string	JSON_FILE_PATH = "scripts/data/notifications.json"
static ref NotificationSystem	m_Instance
static const int	MAX_NOTIFICATIONS = 5

Private Attributes
const int	DEFAULT_TIME_DISPLAYED = 10
const float	NOTIFICATION_FADE_TIME = 3.0

Static Private Attributes
static const float	UPDATE_INTERVAL_THRESHOLD = 1.0

Detailed Description

Definition at line 69 of file notificationsystem.c.

Constructor & Destructor Documentation

◆ NotificationSystem()

void NotificationSystem ( )

inlineprotected

Definition at line 109 of file notificationsystem.c.

References m_DeferredArray, m_TimeArray, and m_TimeElapsed.

Referenced by GetInstance(), and InitInstance().

Member Function Documentation

◆ AddNotification()

void AddNotification	(	NotificationType	type,
		float	show_time,
		string	detail_text = "" )

inlinestaticprotected

Send notification from default types to local player.

Parameters

type	the type of notification to send - these can be viewed in /Scripts/Data/Notifications.json
show_time	amount of time this notification is displayed
detail_text	additional text that can be added to the notification under the title - will not display additional text if not set

Definition at line 192 of file notificationsystem.c.

References m_Instance, MAX_NOTIFICATIONS, and NotificationRuntimeData().

Referenced by BiosUserManager::CheckUserSwitchResult(), CGame::DisconnectSessionEx(), OnlineServices::OnFriendsAsync(), BiosSessionService::OnGetGameplaySession(), and CGame::OnRPC().

◆ AddNotificationExtended()

void AddNotificationExtended	(	float	show_time,
		string	title_text,
		string	detail_text = "",
		string	icon = "" )

inlinestaticprotected

Send custom notification from to local player.

Parameters

show_time	amount of time this notification is displayed
title_text	the title text that is displayed in the notification
detail_text	additional text that can be added to the notification under the title - will not display additional text if not set
icon	the icon that is displayed in the notification - will use default icon if not set

Definition at line 215 of file notificationsystem.c.

References m_Instance, MAX_NOTIFICATIONS, and NotificationRuntimeData().

Referenced by CGame::OnRPC().

◆ CleanupInstance()

void CleanupInstance ( )

inlinestaticprotected

Definition at line 99 of file notificationsystem.c.

References m_Instance.

Referenced by CGame::~DayZGame().

◆ GetInstance()

NotificationSystem GetInstance ( )

inlinestaticprotected

Definition at line 104 of file notificationsystem.c.

References NotificationSystem(), and m_Instance.

Referenced by NotificationUI::NotificationUI(), and NotificationUI::~NotificationUI().

◆ GetNotificationData()

NotificationData GetNotificationData ( NotificationType type )

inlineprotected

Definition at line 272 of file notificationsystem.c.

References m_DataArray.

◆ InitInstance()

void InitInstance ( )

inlinestaticprotected

Definition at line 90 of file notificationsystem.c.

References NotificationSystem(), and m_Instance.

Referenced by CGame::InitNotifications().

◆ LoadNotificationData()

void LoadNotificationData ( )

inlinestaticprotected

Definition at line 280 of file notificationsystem.c.

References ErrorEx, JSON_FILE_PATH, and m_Instance.

◆ SendNotificationToPlayer()

void SendNotificationToPlayer	(	Man	player,
		NotificationType	type,
		float	show_time,
		string	detail_text = "" )

inlinestaticprotected

Send notification from default types to player from server.

Parameters

player	the target player to send notification to
type	the type of notification to send - these can be viewed in /Scripts/Data/Notifications.json
show_time	amount of time this notification is displayed
detail_text	additional text that can be added to the notification under the title - will not display additional text if not set

Definition at line 160 of file notificationsystem.c.

References SendNotificationToPlayerIdentity().

◆ SendNotificationToPlayerExtended()

void SendNotificationToPlayerExtended	(	Man	player,
		float	show_time,
		string	title_text,
		string	detail_text = "",
		string	icon = "" )

inlinestaticprotected

Send custom notification to player from server.

Parameters

player	the target player to send notification to
show_time	amount of time this notification is displayed
title_text	the title text that is displayed in the notification
detail_text	additional text that can be added to the notification under the title - will not display additional text if not set
icon	the icon that is displayed in the notification - will use default icon if not set

Definition at line 125 of file notificationsystem.c.

References SendNotificationToPlayerIdentityExtended().

◆ SendNotificationToPlayerIdentity()

void SendNotificationToPlayerIdentity	(	PlayerIdentity	player,
		NotificationType	type,
		float	show_time,
		string	detail_text = "" )

inlinestaticprotected

Send notification from default types to player identity from server.

Parameters

player	the target player to send notification to - if null, will send to all players
type	the type of notification to send - these can be viewed in /Scripts/Data/Notifications.json
show_time	amount of time this notification is displayed
detail_text	additional text that can be added to the notification under the title - will not display additional text if not set

Definition at line 175 of file notificationsystem.c.

References ScriptRPC::Send(), and Serializer::Write().

Referenced by SendNotificationToPlayer().

◆ SendNotificationToPlayerIdentityExtended()

void SendNotificationToPlayerIdentityExtended	(	PlayerIdentity	player,
		float	show_time,
		string	title_text,
		string	detail_text = "",
		string	icon = "" )

inlinestaticprotected

Send custom notification to player identity from server.

Parameters

player	the target player to send notification to - if null, will send to all players
show_time	amount of time this notification is displayed
title_text	the title text that is displayed in the notification
detail_text	additional text that can be added to the notification under the title - will not display additional text if not set
icon	the icon that is displayed in the notification - will use default icon if not set