SCR_NotificationsComponent.c File Reference

Go to the source code of this file.

Data Structures
class	SCR_NotificationsComponentClass

Functions
ScriptInvoker	GetOnNotification ()
int	GetHistoryNewToOld (out notnull array< SCR_NotificationData > outHistory)
int	GetHistoryOldToNew (out notnull array< SCR_NotificationData > outHistory, int maxHistoryIndex=-1)
bool	GetHistoryEntry (int index, out SCR_NotificationData data=null)
bool	GetLastNotificationLocation (out vector lastLocation)
protected void	Rpc_SendToEveryone (ENotification notificationID, vector position, notnull array< int > paramArray)
protected void	Rpc_SendToPlayer (int playerID, ENotification notificationID, vector position, notnull array< int > paramArray)
protected void	Rpc_SendToFaction (int factionIndex, bool includeFriendlyFactions, ENotification notificationID, vector position, notnull array< int > paramArray)
protected void	Rpc_SendToUnlimitedEditorPlayers (ENotification notificationID, vector position, notnull array< int > paramArray)
protected void	Rpc_SendToUnlimitedEditorPlayersAndPlayer (int playerID, ENotification notificationID, vector position, notnull array< int > paramArray)
protected void	Rpc_SendToGroup (int groupID, ENotification notificationID, vector position, notnull array< int > paramArray)
bool	SendToOwner (ENotification id, SCR_NotificationData data=null)
protected void	ReceiveNotification (ENotification id)
protected void	ReceiveSCR_NotificationData (ENotification id, SCR_NotificationData data)
array< string >	GetStickyNotifications ()
array< ref SCR_NotificationDisplayColor >	GetNotificationDisplayColor ()
protected SCR_NotificationDisplayData	GetNotificationDisplayData (ENotification notificationID)
string	GetPlayerNameFromHistory (int playerID)
protected void	AddPlayerNameToHistory (int playerID)
protected void	UpdateNotificationData (bool updateNotificationData)
protected void	ConnectToNotificationsSystem ()
protected void	DisconnectFromNotificationsSystem ()
void	Update (float timeSlice)
override void	OnPostInit (IEntity owner)
	Editable Mine. More...
override void	OnDelete (IEntity owner)

Variables
SCR_NotificationsComponentClass	m_aHistory = {}
	Framework for sending notifications to players. More...
protected ref ScriptInvoker	Event_OnNotification = new ScriptInvoker()
protected SCR_NotificationData	m_LastNotificationWithLocation
protected bool	m_bIsUpdatingNotificationData
protected ref map< int, string >	m_mPlayerNameHistory = new map <int, string>()

Function Documentation

AddPlayerNameToHistory()

protected void AddPlayerNameToHistory

(

int

playerID

)

Definition at line 1018 of file SCR_NotificationsComponent.c.

ConnectToNotificationsSystem()

protected void ConnectToNotificationsSystem

(

)

Definition at line 1044 of file SCR_NotificationsComponent.c.

DisconnectFromNotificationsSystem()

protected void DisconnectFromNotificationsSystem

(

)

Definition at line 1055 of file SCR_NotificationsComponent.c.

GetHistoryEntry()

bool 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

Definition at line 138 of file SCR_NotificationsComponent.c.

GetHistoryNewToOld()

int 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

Definition at line 105 of file SCR_NotificationsComponent.c.

GetHistoryOldToNew()

int 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

Definition at line 120 of file SCR_NotificationsComponent.c.

GetLastNotificationLocation()

bool GetLastNotificationLocation

(

out vector

lastLocation

)

Get last ping location

Parameters

[out]

lastPingLocation

last ping location vector

Returns

false if no last location

Definition at line 155 of file SCR_NotificationsComponent.c.

GetNotificationDisplayColor()

array<ref SCR_NotificationDisplayColor> GetNotificationDisplayColor

(

)

Get Notification colors

Returns

SCR_NotificationDisplayColor arr

Definition at line 983 of file SCR_NotificationsComponent.c.

GetNotificationDisplayData()

protected SCR_NotificationDisplayData GetNotificationDisplayData

(

ENotification

notificationID

)

Definition at line 993 of file SCR_NotificationsComponent.c.

GetOnNotification()

ScriptInvoker GetOnNotification

(

)

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

Returns

Script invoker

Definition at line 96 of file SCR_NotificationsComponent.c.

GetPlayerNameFromHistory()

string 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

Definition at line 1008 of file SCR_NotificationsComponent.c.

GetStickyNotifications()

array<string> GetStickyNotifications

(

)

Get Sticky notificatons Widget names from Config

Returns

String arr

Definition at line 971 of file SCR_NotificationsComponent.c.

ReceiveNotification()

protected void ReceiveNotification

(

ENotification

id

)

Definition at line 933 of file SCR_NotificationsComponent.c.

ReceiveSCR_NotificationData()

protected void ReceiveSCR_NotificationData	(	ENotification	id,
		SCR_NotificationData	data
	)

Definition at line 940 of file SCR_NotificationsComponent.c.

Rpc_SendToEveryone()

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

Definition at line 230 of file SCR_NotificationsComponent.c.

Rpc_SendToFaction()

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

Definition at line 402 of file SCR_NotificationsComponent.c.

Rpc_SendToGroup()

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

Definition at line 687 of file SCR_NotificationsComponent.c.

Rpc_SendToPlayer()

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

Definition at line 311 of file SCR_NotificationsComponent.c.

Rpc_SendToUnlimitedEditorPlayers()

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

Definition at line 525 of file SCR_NotificationsComponent.c.

Rpc_SendToUnlimitedEditorPlayersAndPlayer()

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

Definition at line 622 of file SCR_NotificationsComponent.c.

SendToOwner()

bool 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

Definition at line 921 of file SCR_NotificationsComponent.c.

Update()

void Update

(

float

timeSlice

)

Parameters

[in]

timeSlice

Definition at line 1068 of file SCR_NotificationsComponent.c.

UpdateNotificationData()

protected void UpdateNotificationData

(

bool

updateNotificationData

)

Definition at line 1030 of file SCR_NotificationsComponent.c.

Variable Documentation

Event_OnNotification

protected ref ScriptInvoker Event_OnNotification = new ScriptInvoker()

Definition at line 79 of file SCR_NotificationsComponent.c.

m_aHistory

SCR_NotificationsComponentClass m_aHistory = {}

Framework for sending notifications to players.

m_bIsUpdatingNotificationData

protected bool m_bIsUpdatingNotificationData

Definition at line 82 of file SCR_NotificationsComponent.c.

m_LastNotificationWithLocation

protected SCR_NotificationData m_LastNotificationWithLocation

Definition at line 81 of file SCR_NotificationsComponent.c.

m_mPlayerNameHistory

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

Definition at line 91 of file SCR_NotificationsComponent.c.