SCR_NotificationRank Interface Reference

Notification Rank Displays a notification: %1 = Player rank SCR_NotificationData: m_iParam1 = player rank Can be used for: Player (m_iParam1) requests something. More...

Inheritance diagram for SCR_NotificationRank:

Public Member Functions
override string	GetText (SCR_NotificationData data)
	Returns the display text using the parameters set in SCR_NotificationData.
override void	SetPosition (SCR_NotificationData data)
	Set the position of the target entity the SCR_NotificationData.
string	GetPlayerRankName (int playerID)
	Return name of passed rank.
string	GetRankName (int playerID, SCR_ECharacterRank rank)
	Return name of passed rank.
Public Member Functions inherited from SCR_NotificationDisplayData
void	SetInitialDisplayData (SCR_NotificationData data)
	Sets the initial display data such as initial notification position and faction related color of notification.
void	GetDisplayVisualizationData (SCR_NotificationData data, out SCR_UINotificationInfo info=null, out ENotificationColor colorEnum=ENotificationColor.NEUTRAL)
	Returns the display data.
ENotificationColor	GetTextColor (SCR_NotificationData data)
	Returns the display data.
void	GetSplitNotificationTextColors (SCR_NotificationData data, out ENotificationColor leftTextColorEnum=ENotificationColor.NEUTRAL, out ENotificationColor rightTextColorEnum=ENotificationColor.NEUTRAL)
	Returns the display data.
string	GetText (SCR_NotificationData data)
	Returns the display text using the parameters set in SCR_NotificationData.
bool	MergeParam1With2 ()
	If true it will merge param1 with param2 using param2 as format (eg: Translate(param2, param1)) before constructing the full notification formatted string.
bool	GetPriority ()
	Get Priority.
SCR_UINotificationInfo	GetNotificationUIInfo ()
	Get UI info.
bool	GetPosition (SCR_NotificationData data, out vector position)
	Gives a position vector that is linked to the notification.
void	SetPosition (SCR_NotificationData data)
	Set the position of the target entity the SCR_NotificationData.
void	SetFactionRelatedColor (SCR_NotificationData data)
	Sets the color enum related to faction if SCR_NotificationDisplayData Color is set to: 'FACTION_RELATED_FRIENDLY_IS_NEGATIVE', 'FACTION_RELATED_FRIENDLY_IS_POSITIVE', 'FACTION_RELATED_ENEMY_IS_NEGATIVE_ONLY' or 'FACTION_RELATED_FRIENDLY_IS_POSITIVE_ONLY' and there is a target to check faction of.

Additional Inherited Members
Public Attributes inherited from SCR_NotificationDisplayData
ENotification	m_NotificationKey
bool	m_bPriorityNotification
ref SCR_UINotificationInfo	m_info
Static Public Attributes inherited from SCR_NotificationDisplayData
const int	MAX_USERNAME_CHARACTERS = 32
Protected Member Functions inherited from SCR_NotificationDisplayData
bool	GetPlayerName (int playerID, out string playerName)
bool	GetEditableEntityName (int entityRplID, out string entityName, bool useCharacterName=false)
bool	IsPlayerFriendlyToLocalPlayer (int notificationPlayerID, bool friendlyIfNoFaction=false)
bool	IsEntityFriendlyToLocalPlayer (IEntity notificationEntity, bool friendlyIfNoFaction=false)
bool	GetFactionName (int factionIndex, out string factionName)
bool	GetCharacterName (int entityRplID, out string format, out string firstname, out string alias, out string surname)
bool	GetEntityCallsign (int rplID, out string callsign)
bool	GetGroupNameFromGroupID (int playerGroupId, out string groupName)
bool	GetInventoryItemName (RplId rplId, out string itemName)
bool	CanSetPosition (SCR_NotificationData data)
void	SetPositionDataEditablePlayer (int playerID, SCR_NotificationData data)
void	SetPositionDataEditableEntity (int enditableEntityID, SCR_NotificationData data)
ENotificationColor	GetFactionRelatedColorPlayer (int notificationPlayerID, ENotificationColor colorType)
ENotificationColor	GetFactionRelatedColorEntity (int notificationEntityID, ENotificationColor colorType)
bool	AreEntitiesFriendly (int entity1ID, bool entity1IsPlayer, int entity2ID, bool entity2IsPlayer)
Protected Attributes inherited from SCR_NotificationDisplayData
bool	m_bAddFriendlyIndicator
Static Protected Attributes inherited from SCR_NotificationDisplayData
const LocalizedString	FRIENDLY_INDICATOR = "#AR-Notification_FriendlyIndicator"
	String used to indicate friendly entities together with the name eg: (Friendly) [PlayerName]. Used only if m_bAddFriendlyIndicator is true.

Detailed Description

Notification Rank Displays a notification: %1 = Player rank SCR_NotificationData: m_iParam1 = player rank Can be used for: Player (m_iParam1) requests something.

Member Function Documentation

GetPlayerRankName()

string SCR_NotificationRank.GetPlayerRankName

(

int

playerID

)

Return name of passed rank.

Parameters

[in]

playerID

Returns

GetRankName()

string SCR_NotificationRank.GetRankName	(	int	playerID,
		SCR_ECharacterRank	rank
	)

Return name of passed rank.

Parameters

[in]	playerID
[in]	rank

Returns

GetText()

override string SCR_NotificationRank.GetText

(

SCR_NotificationData

data

)

Returns the display text using the parameters set in SCR_NotificationData.

Parameters

data	SCR_NotificationData to get the parameters

Returns

string display text as shown in the notification

Implements SCR_NotificationDisplayData.

SetPosition()

override void SCR_NotificationRank.SetPosition

(

SCR_NotificationData

data

)

Set the position of the target entity the SCR_NotificationData.

Parameters

data	SCR_NotificationData to get the parameters

Implements SCR_NotificationDisplayData.

---

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

• Game/Network/Notifications/NotificationDisplayData/SCR_NotificationRank.c