Arma Reforger Explorer 1.7.0.54
Arma Reforger Code Explorer by Zeroy - Thanks to MisterOutofTime
Loading...
Searching...
No Matches
SCR_NotificationDisplayData Class Reference
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_NotificationTaskCreationText SCR_NotificationTaskName SCR_NotificationTaskStateChanged SCR_NotificationVoting

Protected Member Functions

void SetInitialDisplayData (SCR_NotificationData data)
void GetDisplayVisualizationData (SCR_NotificationData data, out SCR_UINotificationInfo info=null, out ENotificationColor colorEnum=ENotificationColor.NEUTRAL)
ENotificationColor GetTextColor (SCR_NotificationData data)
void GetSplitNotificationTextColors (SCR_NotificationData data, out ENotificationColor leftTextColorEnum=ENotificationColor.NEUTRAL, out ENotificationColor rightTextColorEnum=ENotificationColor.NEUTRAL)
string GetText (SCR_NotificationData data)
bool MergeParam1With2 ()
bool GetPriority ()
SCR_UINotificationInfo GetNotificationUIInfo ()
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 GetPosition (SCR_NotificationData data, out vector position)
void SetPosition (SCR_NotificationData data)
bool CanSetPosition (SCR_NotificationData data)
void SetPositionDataEditablePlayer (int playerID, SCR_NotificationData data)
void SetPositionDataEditableEntity (int enditableEntityID, SCR_NotificationData data)
void SetFactionRelatedColor (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
ref SCR_UINotificationInfo m_info
const int MAX_USERNAME_CHARACTERS = 32
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 Protected Attributes

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.

Definition at line 7 of file SCR_NotificationDisplayData.c.

Member Function Documentation

◆ AreEntitiesFriendly()

bool SCR_NotificationDisplayData::AreEntitiesFriendly ( int entity1ID,
bool entity1IsPlayer,
int entity2ID,
bool entity2IsPlayer )
inlineprotected

Definition at line 695 of file SCR_NotificationDisplayData.c.

◆ CanSetPosition()

bool SCR_NotificationDisplayData::CanSetPosition ( SCR_NotificationData data)
inlineprotected

Definition at line 506 of file SCR_NotificationDisplayData.c.

◆ GetCharacterName()

bool SCR_NotificationDisplayData::GetCharacterName ( int entityRplID,
out string format,
out string firstname,
out string alias,
out string surname )
inlineprotected

Definition at line 348 of file SCR_NotificationDisplayData.c.

◆ GetDisplayVisualizationData()

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

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

Definition at line 53 of file SCR_NotificationDisplayData.c.

◆ GetEditableEntityName()

bool SCR_NotificationDisplayData::GetEditableEntityName ( int entityRplID,
out string entityName,
bool useCharacterName = false )
inlineprotected

Definition at line 198 of file SCR_NotificationDisplayData.c.

◆ GetEntityCallsign()

bool SCR_NotificationDisplayData::GetEntityCallsign ( int rplID,
out string callsign )
inlineprotected

Definition at line 378 of file SCR_NotificationDisplayData.c.

◆ GetFactionName()

bool SCR_NotificationDisplayData::GetFactionName ( int factionIndex,
out string factionName )
inlineprotected

Definition at line 329 of file SCR_NotificationDisplayData.c.

◆ GetFactionRelatedColorEntity()

ENotificationColor SCR_NotificationDisplayData::GetFactionRelatedColorEntity ( int notificationEntityID,
ENotificationColor colorType )
inlineprotected

Definition at line 624 of file SCR_NotificationDisplayData.c.

◆ GetFactionRelatedColorPlayer()

ENotificationColor SCR_NotificationDisplayData::GetFactionRelatedColorPlayer ( int notificationPlayerID,
ENotificationColor colorType )
inlineprotected

Definition at line 561 of file SCR_NotificationDisplayData.c.

◆ GetGroupNameFromGroupID()

bool SCR_NotificationDisplayData::GetGroupNameFromGroupID ( int playerGroupId,
out string groupName )
inlineprotected

Definition at line 420 of file SCR_NotificationDisplayData.c.

◆ GetInventoryItemName()

bool SCR_NotificationDisplayData::GetInventoryItemName ( RplId rplId,
out string itemName )
inlineprotected

Definition at line 443 of file SCR_NotificationDisplayData.c.

◆ GetNotificationUIInfo()

SCR_UINotificationInfo SCR_NotificationDisplayData::GetNotificationUIInfo ( )
inlineprotected

Get UI info

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

Definition at line 154 of file SCR_NotificationDisplayData.c.

◆ GetPlayerName()

bool SCR_NotificationDisplayData::GetPlayerName ( int playerID,
out string playerName )
inlineprotected

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

Definition at line 160 of file SCR_NotificationDisplayData.c.

◆ GetPosition()

bool SCR_NotificationDisplayData::GetPosition ( SCR_NotificationData data,
out vector position )
inlineprotected

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

Definition at line 482 of file SCR_NotificationDisplayData.c.

◆ GetPriority()

bool SCR_NotificationDisplayData::GetPriority ( )
inlineprotected

Get Priority

Returns
bool

Definition at line 144 of file SCR_NotificationDisplayData.c.

◆ GetSplitNotificationTextColors()

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

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

Definition at line 90 of file SCR_NotificationDisplayData.c.

◆ GetText()

string SCR_NotificationDisplayData::GetText ( SCR_NotificationData data)
inlineprotected

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

Definition at line 117 of file SCR_NotificationDisplayData.c.

◆ GetTextColor()

ENotificationColor SCR_NotificationDisplayData::GetTextColor ( SCR_NotificationData data)
inlineprotected

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

Definition at line 69 of file SCR_NotificationDisplayData.c.

◆ IsEntityFriendlyToLocalPlayer()

bool SCR_NotificationDisplayData::IsEntityFriendlyToLocalPlayer ( IEntity notificationEntity,
bool friendlyIfNoFaction = false )
inlineprotected

Definition at line 291 of file SCR_NotificationDisplayData.c.

◆ IsPlayerFriendlyToLocalPlayer()

bool SCR_NotificationDisplayData::IsPlayerFriendlyToLocalPlayer ( int notificationPlayerID,
bool friendlyIfNoFaction = false )
inlineprotected

Definition at line 268 of file SCR_NotificationDisplayData.c.

◆ MergeParam1With2()

bool SCR_NotificationDisplayData::MergeParam1With2 ( )
inlineprotected

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

Definition at line 134 of file SCR_NotificationDisplayData.c.

◆ SetFactionRelatedColor()

void SCR_NotificationDisplayData::SetFactionRelatedColor ( SCR_NotificationData data)
inlineprotected

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

Definition at line 554 of file SCR_NotificationDisplayData.c.

◆ SetInitialDisplayData()

void SCR_NotificationDisplayData::SetInitialDisplayData ( SCR_NotificationData data)
inlineprotected

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

Parameters
dataSCR_NotificationData to get the parameters

Definition at line 36 of file SCR_NotificationDisplayData.c.

◆ SetPosition()

void SCR_NotificationDisplayData::SetPosition ( SCR_NotificationData data)
inlineprotected

Set the position of the target entity the SCR_NotificationData

Parameters
dataSCR_NotificationData to get the parameters

Definition at line 500 of file SCR_NotificationDisplayData.c.

◆ SetPositionDataEditableEntity()

void SCR_NotificationDisplayData::SetPositionDataEditableEntity ( int enditableEntityID,
SCR_NotificationData data )
inlineprotected

Definition at line 537 of file SCR_NotificationDisplayData.c.

◆ SetPositionDataEditablePlayer()

void SCR_NotificationDisplayData::SetPositionDataEditablePlayer ( int playerID,
SCR_NotificationData data )
inlineprotected

Definition at line 516 of file SCR_NotificationDisplayData.c.

Member Data Documentation

◆ FRIENDLY_INDICATOR

const LocalizedString SCR_NotificationDisplayData::FRIENDLY_INDICATOR = "#AR-Notification_FriendlyIndicator"
protected

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

Definition at line 25 of file SCR_NotificationDisplayData.c.

◆ LOCAL_PLAYER_INDICATOR

const LocalizedString SCR_NotificationDisplayData::LOCAL_PLAYER_INDICATOR = "#AR-Notification_LocalPlayerIndicator"
protected

Definition at line 27 of file SCR_NotificationDisplayData.c.

◆ m_bAddFriendlyIndicator

bool SCR_NotificationDisplayData::m_bAddFriendlyIndicator
protected

Definition at line 16 of file SCR_NotificationDisplayData.c.

◆ m_info

ref SCR_UINotificationInfo SCR_NotificationDisplayData::m_info
protected

Definition at line 19 of file SCR_NotificationDisplayData.c.

◆ MAX_USERNAME_CHARACTERS

const int SCR_NotificationDisplayData::MAX_USERNAME_CHARACTERS = 32
protected

Definition at line 22 of file SCR_NotificationDisplayData.c.

◆ PLATFORM_ICON_SIZE

const float SCR_NotificationDisplayData::PLATFORM_ICON_SIZE = 2
staticprotected

Definition at line 29 of file SCR_NotificationDisplayData.c.

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