Класс NotificationSystem

Защищенные члены
void	NotificationSystem ()
NotificationData	GetNotificationData (NotificationType type)

Защищенные статические члены
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 ()

Защищенные данные
ref array< ref NotificationRuntimeData >	m_TimeArray
ref array< ref NotificationRuntimeData >	m_DeferredArray
ref map< NotificationType, ref NotificationData >	m_DataArray
float	m_TimeElapsed
ref ScriptInvoker	m_OnNotificationAdded = new ScriptInvoker()
ref ScriptInvoker	m_OnNotificationRemoved = new ScriptInvoker()

Статические защищенные данные
static const string	JSON_FILE_PATH = "scripts/data/notifications.json"
static const int	MAX_NOTIFICATIONS = 5
static ref NotificationSystem	m_Instance

Закрытые данные
const int	DEFAULT_TIME_DISPLAYED = 10
const float	NOTIFICATION_FADE_TIME = 3.0

Закрытые статические данные
static const float	UPDATE_INTERVAL_THRESHOLD = 1.0

Подробное описание

Конструктор(ы)

NotificationSystem()

void NotificationSystem ( )

inlineprotected

    {
        m_TimeElapsed   = 0.0;
 
        m_TimeArray     = new array<ref NotificationRuntimeData>();
        m_DeferredArray = new array<ref NotificationRuntimeData>();
    }

Перекрестные ссылки m_DeferredArray, m_TimeArray и m_TimeElapsed.

Используется в InitInstance().

Методы

AddNotification()

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

inlinestaticprotected

Send notification from default types to local player.

Аргументы

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

    {
        if (m_Instance.m_TimeArray.Count() < MAX_NOTIFICATIONS)
        {
            NotificationRuntimeData data = new NotificationRuntimeData(show_time, m_Instance.GetNotificationData(type), detail_text);
            
            m_Instance.m_TimeArray.Insert(data);
            m_Instance.m_OnNotificationAdded.Invoke(data);
        }
        else
        {
            NotificationRuntimeData dataDeferred = new NotificationRuntimeData(show_time, m_Instance.GetNotificationData(type), detail_text);
            m_Instance.m_DeferredArray.Insert(dataDeferred);
        }
    }

Перекрестные ссылки m_Instance, MAX_NOTIFICATIONS и NotificationRuntimeData().

Используется в CGame::DisconnectSessionEx(), OnlineServices::OnFriendsAsync(), BiosSessionService::OnGetGameplaySession(), CGame::OnRPC() и BiosUserManager::SelectUserEx().

AddNotificationExtended()

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

inlinestaticprotected

Send custom notification from to local player.

Аргументы

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

    {
        if (m_Instance.m_TimeArray.Count() < MAX_NOTIFICATIONS)
        {
            NotificationData tempData = new NotificationData(icon, title_text);
            NotificationRuntimeData data = new NotificationRuntimeData(show_time, tempData, detail_text);
            
            m_Instance.m_TimeArray.Insert(data);
            m_Instance.m_OnNotificationAdded.Invoke(data);
        }
        else
        {
            NotificationData tempDataDeferred = new NotificationData(icon, title_text);
            NotificationRuntimeData dataDeferred = new NotificationRuntimeData(show_time, tempDataDeferred, detail_text);
            m_Instance.m_DeferredArray.Insert(dataDeferred);
        }
    }

Перекрестные ссылки m_Instance, MAX_NOTIFICATIONS и NotificationRuntimeData().

Используется в CGame::OnRPC().

CleanupInstance()

static void CleanupInstance ( )

inlinestaticprotected

    {
        m_Instance = null;
    }

Перекрестные ссылки m_Instance.

Используется в CGame::~DayZGame().

GetInstance()

static NotificationSystem GetInstance ( )

inlinestaticprotected

    {
        return m_Instance;
    }

Перекрестные ссылки m_Instance.

Используется в NotificationUI::NotificationUI() и NotificationUI::~NotificationUI().

GetNotificationData()

NotificationData GetNotificationData ( NotificationType type )

inlineprotected

    {
        if (m_DataArray.Contains(type))
            return m_DataArray.Get(type);
        
        return null;
    }

Перекрестные ссылки m_DataArray.

InitInstance()

static void InitInstance ( )

inlinestaticprotected

    {
        if (!m_Instance)
        {
            m_Instance = new NotificationSystem();
            m_Instance.LoadNotificationData();
        }
    }

Перекрестные ссылки m_Instance и NotificationSystem().

Используется в CGame::InitNotifications().

LoadNotificationData()

static void LoadNotificationData ( )

inlinestaticprotected

    {
        map<NotificationType, NotificationData> dataArray;
        m_Instance.m_DataArray = new map<NotificationType, ref NotificationData>();
        string errorMessage;
        if (!JsonFileLoader<map<NotificationType, NotificationData>>.LoadFile(JSON_FILE_PATH, dataArray, errorMessage))
            ErrorEx(errorMessage);
        
        m_Instance.m_DataArray.Copy(dataArray);
        
        array<int> notificationTypes = new array<int>();
        NotificationType notificationType = 0;
        while (notificationType != NotificationType.NOTIFICATIONS_END)
        {
            notificationTypes.Insert(notificationType);
            notificationType++;
        }
        
        for (int i = 0; i < m_Instance.m_DataArray.Count(); ++i)
        {
            notificationTypes.RemoveItem(m_Instance.m_DataArray.GetKey(i));
        }
        
        if (notificationTypes.Count() > 0)
        {
            foreach (NotificationType notificationType2 : notificationTypes)
            {
                NotificationData notificationData = new NotificationData(
                    "please_add_an_icon",
                    "please_add_a_title",
                    "optional_description",
                );
 
                m_Instance.m_DataArray.Insert(notificationType2, notificationData);
            }
 
            if (!JsonFileLoader<map<NotificationType, ref NotificationData>>.SaveFile(JSON_FILE_PATH, m_Instance.m_DataArray, errorMessage))
                ErrorEx(errorMessage);
        }
    }

Перекрестные ссылки ErrorEx, JSON_FILE_PATH и m_Instance.

SendNotificationToPlayer()

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

inlinestaticprotected

Send notification from default types to player from server.

Аргументы

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

    {
        if (player)
        {
            SendNotificationToPlayerIdentity(player.GetIdentity(), type, show_time, detail_text);
        }
    }

Перекрестные ссылки SendNotificationToPlayerIdentity().

SendNotificationToPlayerExtended()

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

inlinestaticprotected

Send custom notification to player from server.

Аргументы

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

    {
        if (player)
        {
            SendNotificationToPlayerIdentityExtended(player.GetIdentity(), show_time, title_text, detail_text, icon);
        }
    }

Перекрестные ссылки SendNotificationToPlayerIdentityExtended().

SendNotificationToPlayerIdentity()

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

inlinestaticprotected

Send notification from default types to player identity from server.

Аргументы

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

    {
        ScriptRPC rpc = new ScriptRPC();
        
        rpc.Write(type);
        rpc.Write(show_time);
        rpc.Write(detail_text);
 
        rpc.Send(null, ERPCs.RPC_SEND_NOTIFICATION, true, player);
    }

Используется в SendNotificationToPlayer().

SendNotificationToPlayerIdentityExtended()

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

inlinestaticprotected

Send custom notification to player identity from server.

Аргументы

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

    {
        ScriptRPC rpc = new ScriptRPC();
        
        rpc.Write(show_time);
        rpc.Write(title_text);
        rpc.Write(detail_text);
        rpc.Write(icon);
 
        rpc.Send(null, ERPCs.RPC_SEND_NOTIFICATION_EXTENDED, true, player);
    }

Используется в SendNotificationToPlayerExtended().

Update()

static void Update ( float timeslice )

inlinestaticprotected

    {
        if (m_Instance)
        {
            if (g_Game.GetGameState() != DayZGameState.IN_GAME && g_Game.GetGameState() != DayZGameState.MAIN_MENU)
                return;
    
            m_Instance.m_TimeElapsed += timeslice;
            if (m_Instance.m_TimeElapsed >= UPDATE_INTERVAL_THRESHOLD)
            {
                array<NotificationRuntimeData> expiredNotifications = new array<NotificationRuntimeData>();
                foreach (NotificationRuntimeData visibleNotificationData : m_Instance.m_TimeArray)
                {
                    if (visibleNotificationData.GetRemainingTime() <= 0.0)
                        expiredNotifications.Insert(visibleNotificationData);
                    else
                        visibleNotificationData.UpdateRemainingTime(UPDATE_INTERVAL_THRESHOLD);
                }
                
                foreach (NotificationRuntimeData expiredNotificationData : expiredNotifications)
                {
                    m_Instance.m_OnNotificationRemoved.Invoke(expiredNotificationData);
                    m_Instance.m_TimeArray.RemoveItem(expiredNotificationData);
                    
                    if (m_Instance.m_DeferredArray.Count() > 0)
                    {
                        int count = m_Instance.m_DeferredArray.Count();
                        NotificationRuntimeData deferredNotificationData = m_Instance.m_DeferredArray.Get(count - 1);
                        m_Instance.m_TimeArray.Insert(deferredNotificationData);
                        m_Instance.m_OnNotificationAdded.Invoke(deferredNotificationData);
                        m_Instance.m_DeferredArray.Remove(count - 1);
                    }
                }
    
                m_Instance.m_TimeElapsed = 0;
            }
        }
    }

Перекрестные ссылки g_Game, m_Instance, NotificationRuntimeData() и UPDATE_INTERVAL_THRESHOLD.

Используется в CGame::OnUpdate().

Поля

DEFAULT_TIME_DISPLAYED

const int DEFAULT_TIME_DISPLAYED = 10

private

Используется в CGame::DisconnectSessionEx(), OnlineServices::OnFriendsAsync(), BiosSessionService::OnGetGameplaySession() и BiosUserManager::SelectUserEx().

JSON_FILE_PATH

const string JSON_FILE_PATH = "scripts/data/notifications.json"

staticprotected

Используется в LoadNotificationData().

m_DataArray

ref map<NotificationType, ref NotificationData> m_DataArray

protected

Используется в GetNotificationData().

m_DeferredArray

ref array<ref NotificationRuntimeData> m_DeferredArray

protected

Используется в NotificationSystem().

m_Instance

ref NotificationSystem m_Instance

staticprotected

Используется в AddNotification(), AddNotificationExtended(), CleanupInstance(), GetInstance(), InitInstance(), LoadNotificationData() и Update().

m_OnNotificationAdded

ref ScriptInvoker m_OnNotificationAdded = new ScriptInvoker()

protected

m_OnNotificationRemoved

ref ScriptInvoker m_OnNotificationRemoved = new ScriptInvoker()

protected

m_TimeArray

ref array<ref NotificationRuntimeData> m_TimeArray

protected

Используется в NotificationSystem().

m_TimeElapsed

float m_TimeElapsed

protected

Используется в NotificationSystem().

MAX_NOTIFICATIONS

const int MAX_NOTIFICATIONS = 5

staticprotected

Используется в AddNotification() и AddNotificationExtended().

NOTIFICATION_FADE_TIME

const float NOTIFICATION_FADE_TIME = 3.0

private

Используется в NotificationUI::Update().

UPDATE_INTERVAL_THRESHOLD

const float UPDATE_INTERVAL_THRESHOLD = 1.0

staticprivate

Используется в Update().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/3_Game/Client/Notifications/NotificationSystem.c