Framework for sending notifications to players. More...

Inheritance diagram for SCR_NotificationsComponent:

Public Member Functions
ScriptInvoker	GetOnNotification ()
	Get invoker called on player's machine when a notification is received.

int	GetHistoryNewToOld (out notnull array< SCR_NotificationData > outHistory)
	Get the list of previous notifications.

int	GetHistoryOldToNew (out notnull array< SCR_NotificationData > outHistory, int maxHistoryIndex=-1)
	Get the list of previous notifications.

bool	GetHistoryEntry (int index, out SCR_NotificationData data=null)
	Get the the specific history entry.

bool	GetLastNotificationLocation (out vector lastLocation)
	Get last ping location.

bool	SendToOwner (ENotification id, SCR_NotificationData data=null)
	Send notification to player who owns this player controller.

array< string >	GetStickyNotifications ()
	Get Sticky notificatons Widget names from Config.

array< ref SCR_NotificationDisplayColor >	GetNotificationDisplayColor ()
	Get Notification colors.

string	GetPlayerNameFromHistory (int playerID)
	Hotfix to Get player names when the name cannot be found anymore in the playerManager.

void	Update (float timeSlice)

override void	OnPostInit (IEntity owner)

override void	OnDelete (IEntity owner)

Static Public Member Functions
static SCR_NotificationsComponent	GetInstance ()
	Get local instance of the notifications system.

static bool	SendToEveryone (ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to all players.

static bool	SendToEveryone (ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to all players.

static bool	SendToPlayer (int playerID, ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to player with given ID.

static bool	SendToPlayer (int playerID, ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to player with given ID.

static bool	SendToFaction (notnull SCR_Faction faction, bool includeFriendlyFactions, ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to player with given ID.

static bool	SendToFaction (notnull SCR_Faction faction, bool includeFriendlyFactions, ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to player with given ID.

static bool	SendToUnlimitedEditorPlayers (ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to all players that have an unlimited editor.

static bool	SendToUnlimitedEditorPlayers (ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to all players that have an unlimited editor.

static bool	SendToUnlimitedEditorPlayersAndPlayer (int playerID, ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to all players that have an unlimited editor including the given player.

static bool	SendToUnlimitedEditorPlayersAndPlayer (int playerID, ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to all players that have an unlimited editor including the given player.

static bool	SendToGroup (int groupID, ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to all players in a group.

static bool	SendToGroup (int groupID, ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to all players in a group.

static bool	SendLocal (ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to the player on this machine.

static bool	SendLocal (ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to the player on this machine.

static bool	SendLocalUnlimitedEditor (ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to the player on this machine (if has Game master rights).

static bool	SendLocalUnlimitedEditor (ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to the player on this machine (if has Game master rights).

static bool	SendLocalLimitedEditor (ENotification notificationID, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to the player on this machine (if has Game master rights).

static bool	SendLocalLimitedEditor (ENotification notificationID, vector position, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)
	Send notification to the player on this machine (if has Game master rights).

Static Public Attributes
static const int	NOTIFICATION_DELETE_TIME = 30

static const int	NOTIFICATION_HISTORY_LENGTH = 10

Protected Member Functions
void	Rpc_SendToEveryone (ENotification notificationID, vector position, notnull array< int > paramArray)

void	Rpc_SendToPlayer (int playerID, ENotification notificationID, vector position, notnull array< int > paramArray)

void	Rpc_SendToFaction (int factionIndex, bool includeFriendlyFactions, ENotification notificationID, vector position, notnull array< int > paramArray)

void	Rpc_SendToUnlimitedEditorPlayers (ENotification notificationID, vector position, notnull array< int > paramArray)

void	Rpc_SendToUnlimitedEditorPlayersAndPlayer (int playerID, ENotification notificationID, vector position, notnull array< int > paramArray)

void	Rpc_SendToGroup (int groupID, ENotification notificationID, vector position, notnull array< int > paramArray)

void	ReceiveNotification (ENotification id)

void	ReceiveSCR_NotificationData (ENotification id, SCR_NotificationData data)

SCR_NotificationDisplayData	GetNotificationDisplayData (ENotification notificationID)

void	AddPlayerNameToHistory (int playerID)

void	UpdateNotificationData (bool updateNotificationData)

void	ConnectToNotificationsSystem ()

void	DisconnectFromNotificationsSystem ()

Static Protected Member Functions
static bool	SendToEveryoneData (ENotification notificationID, SCR_NotificationData data)

static bool	SendToPlayerData (int playerID, ENotification notificationID, SCR_NotificationData data)

static bool	SendToFactionData (notnull SCR_Faction faction, bool includeFriendlyFactions, ENotification notificationID, SCR_NotificationData data)

static bool	SendToUnlimitedEditorPlayersData (ENotification notificationID, SCR_NotificationData data, int playerID=-1)

static bool	SendToGroupData (ENotification notificationID, SCR_NotificationData data, int groupID)

static bool	SendLocalData (ENotification notificationID, SCR_NotificationData data)

static void	CreateParamArray (notnull out array< int > paramArray, int param1=0, int param2=0, int param3=0, int param4=0, int param5=0, int param6=0)

static void	GetParamsFromArray (notnull array< int > paramArray, out int param1=0, out int param2=0, out int param3=0, out int param4=0, out int param5=0, out int param6=0)

Protected Attributes
ref array< ref SCR_NotificationData >	m_aHistory = {}

ref ScriptInvoker	Event_OnNotification = new ScriptInvoker()

SCR_NotificationData	m_LastNotificationWithLocation

bool	m_bIsUpdatingNotificationData

ref map< int, string >	m_mPlayerNameHistory = new map <int, string>()

Detailed Description

Framework for sending notifications to players.

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.0/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

Member Function Documentation

◆ AddPlayerNameToHistory()

void SCR_NotificationsComponent.AddPlayerNameToHistory ( int playerID )

protected

◆ ConnectToNotificationsSystem()

void SCR_NotificationsComponent.ConnectToNotificationsSystem ( )

protected

◆ CreateParamArray()

static void SCR_NotificationsComponent.CreateParamArray	(	notnull out array< int >	paramArray,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

staticprotected

◆ DisconnectFromNotificationsSystem()

void SCR_NotificationsComponent.DisconnectFromNotificationsSystem ( )

protected

◆ GetHistoryEntry()

bool SCR_NotificationsComponent.GetHistoryEntry	(	int	index,
		out SCR_NotificationData	data = `null`
	)

Get the the specific history entry.

Parameters

[in]	index	int index of history entry
[out]	data	SCR_NotificationData of the history entry with given index

Returns: false if index was not found

◆ GetHistoryNewToOld()

int SCR_NotificationsComponent.GetHistoryNewToOld ( out notnull array< SCR_NotificationData > outHistory )

Get the list of previous notifications.

(new to old)

Parameters

[out] outHistory Array to be filled with notifications, newest first - not emptied before filling

Returns: Number of notifications

◆ GetHistoryOldToNew()

int SCR_NotificationsComponent.GetHistoryOldToNew	(	out notnull array< SCR_NotificationData >	outHistory,
		int	maxHistoryIndex = `-1`
	)

Get the list of previous notifications.

(old to new)

Parameters

[out]	outHistory	Array to be filled with notifications, oldest first - not emptied before filling
	how	far back the history needs to be taken from. -1 means this is ignored

Returns: Number of notifications

◆ GetInstance()

static SCR_NotificationsComponent SCR_NotificationsComponent.GetInstance ( )

static

Get local instance of the notifications system.

Returns: Notifications component

◆ GetLastNotificationLocation()

bool SCR_NotificationsComponent.GetLastNotificationLocation ( out vector lastLocation )

Get last ping location.

Parameters

[out] lastPingLocation last ping location vector

Returns: false if no last location

◆ GetNotificationDisplayColor()

array< ref SCR_NotificationDisplayColor > SCR_NotificationsComponent.GetNotificationDisplayColor ( )

Get Notification colors.

Returns: SCR_NotificationDisplayColor arr

◆ GetNotificationDisplayData()

SCR_NotificationDisplayData SCR_NotificationsComponent.GetNotificationDisplayData ( ENotification notificationID )

protected

◆ GetOnNotification()

ScriptInvoker SCR_NotificationsComponent.GetOnNotification ( )

Get invoker called on player's machine when a notification is received.

Returns: Script invoker

◆ GetParamsFromArray()

static void SCR_NotificationsComponent.GetParamsFromArray	(	notnull array< int >	paramArray,
		out int	param1 = `0`,
		out int	param2 = `0`,
		out int	param3 = `0`,
		out int	param4 = `0`,
		out int	param5 = `0`,
		out int	param6 = `0`
	)

staticprotected

◆ GetPlayerNameFromHistory()

string SCR_NotificationsComponent.GetPlayerNameFromHistory ( int playerID )

Hotfix to Get player names when the name cannot be found anymore in the playerManager.

Parameters

[in] playerID id of player to get name from

Returns: saved player name

◆ GetStickyNotifications()

array< string > SCR_NotificationsComponent.GetStickyNotifications ( )

Get Sticky notificatons Widget names from Config.

Returns: String arr

◆ OnDelete()

override void SCR_NotificationsComponent.OnDelete ( IEntity owner )

◆ OnPostInit()

override void SCR_NotificationsComponent.OnPostInit ( IEntity owner )

◆ ReceiveNotification()

void SCR_NotificationsComponent.ReceiveNotification ( ENotification id )

protected

◆ ReceiveSCR_NotificationData()

void SCR_NotificationsComponent.ReceiveSCR_NotificationData	(	ENotification	id,
		SCR_NotificationData	data
	)

protected

◆ Rpc_SendToEveryone()

void SCR_NotificationsComponent.Rpc_SendToEveryone	(	ENotification	notificationID,
		vector	position,
		notnull array< int >	paramArray
	)

protected

◆ Rpc_SendToFaction()

void SCR_NotificationsComponent.Rpc_SendToFaction	(	int	factionIndex,
		bool	includeFriendlyFactions,
		ENotification	notificationID,
		vector	position,
		notnull array< int >	paramArray
	)

protected

◆ Rpc_SendToGroup()

void SCR_NotificationsComponent.Rpc_SendToGroup	(	int	groupID,
		ENotification	notificationID,
		vector	position,
		notnull array< int >	paramArray
	)

protected

◆ Rpc_SendToPlayer()

void SCR_NotificationsComponent.Rpc_SendToPlayer	(	int	playerID,
		ENotification	notificationID,
		vector	position,
		notnull array< int >	paramArray
	)

protected

◆ Rpc_SendToUnlimitedEditorPlayers()

void SCR_NotificationsComponent.Rpc_SendToUnlimitedEditorPlayers	(	ENotification	notificationID,
		vector	position,
		notnull array< int >	paramArray
	)

protected

◆ Rpc_SendToUnlimitedEditorPlayersAndPlayer()

void SCR_NotificationsComponent.Rpc_SendToUnlimitedEditorPlayersAndPlayer	(	int	playerID,
		ENotification	notificationID,
		vector	position,
		notnull array< int >	paramArray
	)

protected

◆ SendLocal() [1/2]

static bool SCR_NotificationsComponent.SendLocal	(	ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to the player on this machine.

Parameters

[in]	notificationID	ID of the notification message
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendLocal() [2/2]

static bool SCR_NotificationsComponent.SendLocal	(	ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to the player on this machine.

Parameters

[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendLocalData()

static bool SCR_NotificationsComponent.SendLocalData	(	ENotification	notificationID,
		SCR_NotificationData	data
	)

staticprotected

◆ SendLocalLimitedEditor() [1/2]

static bool SCR_NotificationsComponent.SendLocalLimitedEditor	(	ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to the player on this machine (if has Game master rights).

Parameters

[in]	notificationID	ID of the notification message
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendLocalLimitedEditor() [2/2]

static bool SCR_NotificationsComponent.SendLocalLimitedEditor	(	ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to the player on this machine (if has Game master rights).

Parameters

[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendLocalUnlimitedEditor() [1/2]

static bool SCR_NotificationsComponent.SendLocalUnlimitedEditor	(	ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to the player on this machine (if has Game master rights).

Parameters

[in]	notificationID	ID of the notification message
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendLocalUnlimitedEditor() [2/2]

static bool SCR_NotificationsComponent.SendLocalUnlimitedEditor	(	ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to the player on this machine (if has Game master rights).

Parameters

[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToEveryone() [1/2]

static bool SCR_NotificationsComponent.SendToEveryone	(	ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to all players.

Parameters

[in]	notificationID	ID of the notification MessageBox
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

Examples: d:/jenkins/workspace/ar_data_branches_stable_1.2.0/A4Data/scripts/Game/GameMode/SCR_GameModeEditor.c.

◆ SendToEveryone() [2/2]

static bool SCR_NotificationsComponent.SendToEveryone	(	ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to all players.

Parameters

[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToEveryoneData()

static bool SCR_NotificationsComponent.SendToEveryoneData	(	ENotification	notificationID,
		SCR_NotificationData	data
	)

staticprotected

◆ SendToFaction() [1/2]

static bool SCR_NotificationsComponent.SendToFaction	(	notnull SCR_Faction	faction,
		bool	includeFriendlyFactions,
		ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to player with given ID.

Parameters

[in]	faction	Faction of players to send notification to
[in]	includeFriendlyFactions	If true it will also send the notification to factions friendly to the given faction
[in]	notificationID	ID of the notification message
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToFaction() [2/2]

static bool SCR_NotificationsComponent.SendToFaction	(	notnull SCR_Faction	faction,
		bool	includeFriendlyFactions,
		ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to player with given ID.

Parameters

[in]	faction	Faction of players to send notification to
[in]	includeFriendlyFactions	If true it will also send the notification to factions friendly to the given faction
[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToFactionData()

static bool SCR_NotificationsComponent.SendToFactionData	(	notnull SCR_Faction	faction,
		bool	includeFriendlyFactions,
		ENotification	notificationID,
		SCR_NotificationData	data
	)

staticprotected

◆ SendToGroup() [1/2]

static bool SCR_NotificationsComponent.SendToGroup	(	int	groupID,
		ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to all players in a group.

Parameters

[in]	groupID	ID of group which players need to be a part of to recieve the notification
[in]	notificationID	ID of the notification MessageBox
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToGroup() [2/2]

static bool SCR_NotificationsComponent.SendToGroup	(	int	groupID,
		ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to all players in a group.

Parameters

[in]	groupID	ID of group which players need to be a part of to recieve the notification
[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToGroupData()

static bool SCR_NotificationsComponent.SendToGroupData	(	ENotification	notificationID,
		SCR_NotificationData	data,
		int	groupID
	)

staticprotected

◆ SendToOwner()

bool SCR_NotificationsComponent.SendToOwner	(	ENotification	id,
		SCR_NotificationData	data = `null`
	)

Send notification to player who owns this player controller.

Parameters

[in]	id	ID of the notification message
[in]	data	Notification data

Returns: true if the notification was sent successfully

◆ SendToPlayer() [1/2]

static bool SCR_NotificationsComponent.SendToPlayer	(	int	playerID,
		ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to player with given ID.

Parameters

[in]	playerID	Id of the recipient
[in]	notificationID	ID of the notification message
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToPlayer() [2/2]

static bool SCR_NotificationsComponent.SendToPlayer	(	int	playerID,
		ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to player with given ID.

Parameters

[in]	playerID	Id of the recipient
[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToPlayerData()

static bool SCR_NotificationsComponent.SendToPlayerData	(	int	playerID,
		ENotification	notificationID,
		SCR_NotificationData	data
	)

staticprotected

◆ SendToUnlimitedEditorPlayers() [1/2]

static bool SCR_NotificationsComponent.SendToUnlimitedEditorPlayers	(	ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to all players that have an unlimited editor.

Parameters

[in]	notificationID	ID of the notification MessageBox
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToUnlimitedEditorPlayers() [2/2]

static bool SCR_NotificationsComponent.SendToUnlimitedEditorPlayers	(	ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to all players that have an unlimited editor.

Parameters

[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToUnlimitedEditorPlayersAndPlayer() [1/2]

static bool SCR_NotificationsComponent.SendToUnlimitedEditorPlayersAndPlayer	(	int	playerID,
		ENotification	notificationID,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to all players that have an unlimited editor including the given player.

Parameters

[in]	playerID	notification is also send to this player, regardless if they have an unlimited editor or not
[in]	notificationID	ID of the notification MessageBox
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToUnlimitedEditorPlayersAndPlayer() [2/2]

static bool SCR_NotificationsComponent.SendToUnlimitedEditorPlayersAndPlayer	(	int	playerID,
		ENotification	notificationID,
		vector	position,
		int	param1 = `0`,
		int	param2 = `0`,
		int	param3 = `0`,
		int	param4 = `0`,
		int	param5 = `0`,
		int	param6 = `0`
	)

static

Send notification to all players that have an unlimited editor including the given player.

Parameters

[in]	playerID	notification is also send to this player, regardless if they have an unlimited editor or not
[in]	notificationID	ID of the notification message
[in]	position	notification position
[in]	param1
[in]	param2
[in]	param3
[in]	param4
[in]	param5
[in]	param6

Returns: True if the notification was sent successfully

◆ SendToUnlimitedEditorPlayersData()

static bool SCR_NotificationsComponent.SendToUnlimitedEditorPlayersData	(	ENotification	notificationID,
		SCR_NotificationData	data,
		int	playerID = `-1`
	)

staticprotected

◆ Update()

void SCR_NotificationsComponent.Update ( float timeSlice )

Parameters

[in] timeSlice

◆ UpdateNotificationData()

void SCR_NotificationsComponent.UpdateNotificationData ( bool updateNotificationData )

protected

Member Data Documentation

◆ Event_OnNotification

ref ScriptInvoker SCR_NotificationsComponent.Event_OnNotification = new ScriptInvoker()

protected

◆ m_aHistory

ref array<ref SCR_NotificationData> SCR_NotificationsComponent.m_aHistory = {}

protected

◆ m_bIsUpdatingNotificationData

bool SCR_NotificationsComponent.m_bIsUpdatingNotificationData

protected

◆ m_LastNotificationWithLocation

SCR_NotificationData SCR_NotificationsComponent.m_LastNotificationWithLocation

protected

◆ m_mPlayerNameHistory

ref map<int, string> SCR_NotificationsComponent.m_mPlayerNameHistory = new map <int, string>()

protected

◆ NOTIFICATION_DELETE_TIME

const int SCR_NotificationsComponent.NOTIFICATION_DELETE_TIME = 30

static

◆ NOTIFICATION_HISTORY_LENGTH

const int SCR_NotificationsComponent.NOTIFICATION_HISTORY_LENGTH = 10

static

The documentation for this interface was generated from the following file:

Game/Network/Notifications/SCR_NotificationsComponent.c

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

◆ AddPlayerNameToHistory()

◆ ConnectToNotificationsSystem()

◆ CreateParamArray()

◆ DisconnectFromNotificationsSystem()

◆ GetHistoryEntry()

◆ GetHistoryNewToOld()

◆ GetHistoryOldToNew()

◆ GetInstance()

◆ GetLastNotificationLocation()

◆ GetNotificationDisplayColor()

◆ GetNotificationDisplayData()

◆ GetOnNotification()

◆ GetParamsFromArray()

◆ GetPlayerNameFromHistory()

◆ GetStickyNotifications()

◆ OnDelete()

◆ OnPostInit()

◆ ReceiveNotification()

◆ ReceiveSCR_NotificationData()

◆ Rpc_SendToEveryone()

◆ Rpc_SendToFaction()

◆ Rpc_SendToGroup()

◆ Rpc_SendToPlayer()

◆ Rpc_SendToUnlimitedEditorPlayers()

◆ Rpc_SendToUnlimitedEditorPlayersAndPlayer()

◆ SendLocal() [1/2]

◆ SendLocal() [2/2]

◆ SendLocalData()

◆ SendLocalLimitedEditor() [1/2]

◆ SendLocalLimitedEditor() [2/2]

◆ SendLocalUnlimitedEditor() [1/2]

◆ SendLocalUnlimitedEditor() [2/2]

◆ SendToEveryone() [1/2]

◆ SendToEveryone() [2/2]

◆ SendToEveryoneData()

◆ SendToFaction() [1/2]

◆ SendToFaction() [2/2]

◆ SendToFactionData()

◆ SendToGroup() [1/2]

◆ SendToGroup() [2/2]

◆ SendToGroupData()

◆ SendToOwner()

◆ SendToPlayer() [1/2]

◆ SendToPlayer() [2/2]

◆ SendToPlayerData()

◆ SendToUnlimitedEditorPlayers() [1/2]

◆ SendToUnlimitedEditorPlayers() [2/2]

◆ SendToUnlimitedEditorPlayersAndPlayer() [1/2]

◆ SendToUnlimitedEditorPlayersAndPlayer() [2/2]

◆ SendToUnlimitedEditorPlayersData()

◆ Update()

◆ UpdateNotificationData()

Member Data Documentation

◆ Event_OnNotification

◆ m_aHistory

◆ m_bIsUpdatingNotificationData

◆ m_LastNotificationWithLocation

◆ m_mPlayerNameHistory

◆ NOTIFICATION_DELETE_TIME

◆ NOTIFICATION_HISTORY_LENGTH