Private Member Functions
void	NotificationSystem ()

protected NotificationData	GetNotificationData (NotificationType type)

Static Private Member Functions
static void	InitInstance ()

static void	CleanupInstance ()

static NotificationSystem	GetInstance ()

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	SendNotificationToPlayerIdentityExtended (PlayerIdentity player, float show_time, string title_text, string detail_text="", string icon="")
	Send custom notification to player identity from server.

static void	SendNotificationToPlayer (Man player, NotificationType type, float show_time, string detail_text="")
	Send notification from default types 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	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	Update (float timeslice)

static void	LoadNotificationData ()

Private Attributes
const int	DEFAULT_TIME_DISPLAYED = 10

const float	NOTIFICATION_FADE_TIME = 3.0

protected ref array< ref NotificationRuntimeData >	m_TimeArray

protected ref array< ref NotificationRuntimeData >	m_DeferredArray

protected ref map< NotificationType, ref NotificationData >	m_DataArray

protected float	m_TimeElapsed

ref ScriptInvoker	m_OnNotificationAdded = new ScriptInvoker()

ref ScriptInvoker	m_OnNotificationRemoved = new ScriptInvoker()

Static Private Attributes
static protected const string	JSON_FILE_PATH = "scripts/data/notifications.json"

static protected const int	MAX_NOTIFICATIONS = 5

static private const float	UPDATE_INTERVAL_THRESHOLD = 1.0

static protected ref NotificationSystem	m_Instance

Constructor & Destructor Documentation

◆ NotificationSystem()

void NotificationSystem ( )

inlineprivate

References m_DeferredArray, m_TimeArray, and m_TimeElapsed.

Referenced by InitInstance().

Member Function Documentation

◆ AddNotification()

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

inlinestaticprivate

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

References GetNotificationData(), ScriptInvoker::Invoke(), m_DeferredArray, m_Instance, m_OnNotificationAdded, m_TimeArray, MAX_NOTIFICATIONS, and NotificationRuntimeData().

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

◆ AddNotificationExtended()

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

inlinestaticprivate

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

References ScriptInvoker::Invoke(), m_DeferredArray, m_Instance, m_OnNotificationAdded, m_TimeArray, MAX_NOTIFICATIONS, and NotificationRuntimeData().

Referenced by CGame::OnRPC().

◆ CleanupInstance()

static void CleanupInstance ( )

inlinestaticprivate

References m_Instance.

Referenced by CGame::~DayZGame().

◆ GetInstance()

static NotificationSystem GetInstance ( )

inlinestaticprivate

References m_Instance.

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

◆ GetNotificationData()

protected NotificationData GetNotificationData ( NotificationType type )

inlineprivate

References m_DataArray.

Referenced by AddNotification().

◆ InitInstance()

static void InitInstance ( )

inlinestaticprivate

References LoadNotificationData(), m_Instance, and NotificationSystem().

Referenced by CGame::InitNotifications().

◆ LoadNotificationData()

static void LoadNotificationData ( )

inlinestaticprivate

References ErrorEx, JSON_FILE_PATH, m_DataArray, and m_Instance.

Referenced by InitInstance().

◆ SendNotificationToPlayer()

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

inlinestaticprivate

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

References SendNotificationToPlayerIdentity().

◆ SendNotificationToPlayerExtended()

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

inlinestaticprivate

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

References SendNotificationToPlayerIdentityExtended().

◆ SendNotificationToPlayerIdentity()

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

inlinestaticprivate

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

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

Referenced by SendNotificationToPlayer().

◆ SendNotificationToPlayerIdentityExtended()

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

inlinestaticprivate

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