Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_NotificationDisplayData Interface Reference

Used to get the display information for each notification. More...

Inheritance diagram for SCR_NotificationDisplayData:
SCR_NotificationAproxNumber SCR_NotificationCharacterName SCR_NotificationEditableEntity SCR_NotificationEditableEntityAndNumber SCR_NotificationFaction SCR_NotificationGroupName SCR_NotificationInventoryItemName SCR_NotificationNumber SCR_NotificationPlayer SCR_NotificationPlayerBuildService SCR_NotificationPlayerTargetEditableEntity SCR_NotificationPlayerTargetFaction SCR_NotificationPlayerTargetPlayer SCR_NotificationPlayerTargetTwoEditableEntity SCR_NotificationRank SCR_NotificationSupportStationHitZoneGroup SCR_NotificationTaskStateChanged SCR_NotificationVoting

Public Member Functions

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.
 

Public Attributes

ENotification m_NotificationKey
 
bool m_bPriorityNotification
 
ref SCR_UINotificationInfo m_info
 

Static Public Attributes

const int MAX_USERNAME_CHARACTERS = 32
 

Protected Member Functions

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

bool m_bAddFriendlyIndicator
 

Static Protected Attributes

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.
 
const LocalizedString LOCAL_PLAYER_INDICATOR = "#AR-Notification_LocalPlayerIndicator"
 
static const float PLATFORM_ICON_SIZE = 2
 

Detailed Description

Used to get the display information for each notification.

This is the most basic of the SCR_NotificationDisplayData and can only display a simple string without references. SCR_NotificationData should not have any parameters set.

Member Function Documentation

◆ AreEntitiesFriendly()

bool SCR_NotificationDisplayData.AreEntitiesFriendly ( int entity1ID,
bool entity1IsPlayer,
int entity2ID,
bool entity2IsPlayer )
protected

◆ CanSetPosition()

bool SCR_NotificationDisplayData.CanSetPosition ( SCR_NotificationData data)
protected

◆ GetCharacterName()

bool SCR_NotificationDisplayData.GetCharacterName ( int entityRplID,
out string format,
out string firstname,
out string alias,
out string surname )
protected

◆ GetDisplayVisualizationData()

void SCR_NotificationDisplayData.GetDisplayVisualizationData ( SCR_NotificationData data,
out SCR_UINotificationInfo info = null,
out ENotificationColor colorEnum = ENotificationColor::NEUTRAL )

Returns the display data.

Parameters
dataSCR_NotificationData to get the parameters
[out]iconas ResourceName
[out]colorEnumas ENotificationColor to be used by the SCR_NotificationMessageUIComponent to get the color from SCR_NotificationsLogDisplay

◆ GetEditableEntityName()

bool SCR_NotificationDisplayData.GetEditableEntityName ( int entityRplID,
out string entityName,
bool useCharacterName = false )
protected

◆ GetEntityCallsign()

bool SCR_NotificationDisplayData.GetEntityCallsign ( int rplID,
out string callsign )
protected

◆ GetFactionName()

bool SCR_NotificationDisplayData.GetFactionName ( int factionIndex,
out string factionName )
protected

◆ GetFactionRelatedColorEntity()

ENotificationColor SCR_NotificationDisplayData.GetFactionRelatedColorEntity ( int notificationEntityID,
ENotificationColor colorType )
protected

◆ GetFactionRelatedColorPlayer()

ENotificationColor SCR_NotificationDisplayData.GetFactionRelatedColorPlayer ( int notificationPlayerID,
ENotificationColor colorType )
protected

◆ GetGroupNameFromGroupID()

bool SCR_NotificationDisplayData.GetGroupNameFromGroupID ( int playerGroupId,
out string groupName )
protected

◆ GetInventoryItemName()

bool SCR_NotificationDisplayData.GetInventoryItemName ( RplId rplId,
out string itemName )
protected

◆ GetNotificationUIInfo()

SCR_UINotificationInfo SCR_NotificationDisplayData.GetNotificationUIInfo ( )

Get UI info.

Returns
string Ui info holding various of display information for the notification

◆ GetPlayerName()

bool SCR_NotificationDisplayData.GetPlayerName ( int playerID,
out string playerName )
protected

If the local player is on PSN, show a platform Icon in front of the name.

◆ GetPosition()

bool SCR_NotificationDisplayData.GetPosition ( SCR_NotificationData data,
out vector position )

Gives a position vector that is linked to the notification.

This is for editor functionality so the GM can teleport to the notification positions Will return false if specific SCR_NotificationDisplayData does not have a linked position

Parameters
dataSCR_NotificationData to get the parameters
[out]positionvector the position linked to the notification
Returns
bool returns false if has no position saved

◆ GetPriority()

bool SCR_NotificationDisplayData.GetPriority ( )

Get Priority.

Returns
bool

◆ GetSplitNotificationTextColors()

void SCR_NotificationDisplayData.GetSplitNotificationTextColors ( SCR_NotificationData data,
out ENotificationColor leftTextColorEnum = ENotificationColor::NEUTRAL,
out ENotificationColor rightTextColorEnum = ENotificationColor::NEUTRAL )

Returns the display data.

Parameters
dataSCR_NotificationData to get the parameters
[out]leftTextColorEnumas ENotificationColor to be used by the SCR_SplitNotificationMessageUIComponent to get the color from SCR_NotificationsLogDisplay
[out]rightTextColorEnumas ENotificationColor to be used by the SCR_SplitNotificationMessageUIComponent to get the color from SCR_NotificationsLogDisplay

◆ GetText()

string SCR_NotificationDisplayData.GetText ( SCR_NotificationData data)

Returns the display text using the parameters set in SCR_NotificationData.

Parameters
dataSCR_NotificationData to get the parameters
Returns
string display text as shown in the notification

Implemented in SCR_NotificationAproxNumber, SCR_NotificationArsenalGameModeType, SCR_NotificationCharacterName, SCR_NotificationEditableEntity, SCR_NotificationEditableEntityAndNumber, SCR_NotificationEditableEntityEditableEntityTarget, SCR_NotificationEditableEntityTargetPlayer, SCR_NotificationEntityCallsign, SCR_NotificationFaction, SCR_NotificationGroupName, SCR_NotificationInventoryItemName, SCR_NotificationNumber, SCR_NotificationOnKillfeedChanged, SCR_NotificationPerceivedFactionKillPunishment, SCR_NotificationPlayer, SCR_NotificationPlayerAndAproxNumber, SCR_NotificationPlayerAndEntityCallsign, SCR_NotificationPlayerAndFaction, SCR_NotificationPlayerAndGroupName, SCR_NotificationPlayerAndLocation, SCR_NotificationPlayerAndNumber, SCR_NotificationPlayerBanned, SCR_NotificationPlayerBuildService, SCR_NotificationPlayerKicked, SCR_NotificationPlayerTargetEditableEntity, SCR_NotificationPlayerTargetFaction, SCR_NotificationPlayerTargetPlayer, SCR_NotificationPlayerTargetTwoEditableEntity, SCR_NotificationPlayerTargetTwoFactions, SCR_NotificationRank, SCR_NotificationSupportStationHitZoneGroup, SCR_NotificationTaskStateChanged, SCR_NotificationVoting, SCR_NotificationWeatherChanged, and SCR_NotificationWindChanged.

◆ GetTextColor()

ENotificationColor SCR_NotificationDisplayData.GetTextColor ( SCR_NotificationData data)

Returns the display data.

Only valid if UI info is SCR_ColoredTextNotificationUIInfo

Parameters
dataSCR_NotificationData to get the parameters
Returns
colorEnum as ENotificationColor to be used by the SCR_NotificationMessageUIComponent to get the color from SCR_NotificationsLogDisplay

◆ IsEntityFriendlyToLocalPlayer()

bool SCR_NotificationDisplayData.IsEntityFriendlyToLocalPlayer ( IEntity notificationEntity,
bool friendlyIfNoFaction = false )
protected

◆ IsPlayerFriendlyToLocalPlayer()

bool SCR_NotificationDisplayData.IsPlayerFriendlyToLocalPlayer ( int notificationPlayerID,
bool friendlyIfNoFaction = false )
protected

◆ MergeParam1With2()

bool SCR_NotificationDisplayData.MergeParam1With2 ( )

If true it will merge param1 with param2 using param2 as format (eg: Translate(param2, param1)) before constructing the full notification formatted string.

Param2 will need %1 to in the localization. Mainly used by TaskStateChanged as the objective name (param2) includes the location name (param1) which need to be formatted before formatting the entire string.

Returns
bool True if must merge

Implemented in SCR_NotificationTaskStateChanged.

◆ SetFactionRelatedColor()

void SCR_NotificationDisplayData.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.

Parameters
data

Implemented in SCR_NotificationCharacterName, SCR_NotificationEditableEntity, SCR_NotificationEditableEntityEditableEntityTarget, SCR_NotificationEditableEntityTargetPlayer, SCR_NotificationPlayer, SCR_NotificationPlayerAndFaction, SCR_NotificationPlayerTargetEditableEntity, and SCR_NotificationPlayerTargetPlayer.

◆ SetInitialDisplayData()

void SCR_NotificationDisplayData.SetInitialDisplayData ( SCR_NotificationData data)

Sets the initial display data such as initial notification position and faction related color of notification.

Parameters
dataSCR_NotificationData to get the parameters

◆ SetPosition()

void SCR_NotificationDisplayData.SetPosition ( SCR_NotificationData data)

Set the position of the target entity the SCR_NotificationData.

Parameters
dataSCR_NotificationData to get the parameters

Implemented in SCR_NotificationCharacterName, SCR_NotificationEditableEntity, SCR_NotificationPlayer, SCR_NotificationPlayerTargetEditableEntity, SCR_NotificationPlayerTargetFaction, SCR_NotificationPlayerTargetPlayer, SCR_NotificationPlayerTargetTwoEditableEntity, SCR_NotificationRank, and SCR_NotificationTaskStateChanged.

◆ SetPositionDataEditableEntity()

void SCR_NotificationDisplayData.SetPositionDataEditableEntity ( int enditableEntityID,
SCR_NotificationData data )
protected

◆ SetPositionDataEditablePlayer()

void SCR_NotificationDisplayData.SetPositionDataEditablePlayer ( int playerID,
SCR_NotificationData data )
protected

Member Data Documentation

◆ FRIENDLY_INDICATOR

const LocalizedString SCR_NotificationDisplayData.FRIENDLY_INDICATOR = "#AR-Notification_FriendlyIndicator"
staticprotected

String used to indicate friendly entities together with the name eg: (Friendly) [PlayerName]. Used only if m_bAddFriendlyIndicator is true.

◆ LOCAL_PLAYER_INDICATOR

const LocalizedString SCR_NotificationDisplayData.LOCAL_PLAYER_INDICATOR = "#AR-Notification_LocalPlayerIndicator"
staticprotected

◆ m_bAddFriendlyIndicator

bool SCR_NotificationDisplayData.m_bAddFriendlyIndicator
protected

◆ m_bPriorityNotification

bool SCR_NotificationDisplayData.m_bPriorityNotification

◆ m_info

ref SCR_UINotificationInfo SCR_NotificationDisplayData.m_info

◆ m_NotificationKey

ENotification SCR_NotificationDisplayData.m_NotificationKey

◆ MAX_USERNAME_CHARACTERS

const int SCR_NotificationDisplayData.MAX_USERNAME_CHARACTERS = 32
static

◆ PLATFORM_ICON_SIZE

const float SCR_NotificationDisplayData.PLATFORM_ICON_SIZE = 2
staticprotected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.11.0