SCR_SplitNotificationUIInfo Class Reference

Inheritance diagram for SCR_SplitNotificationUIInfo:

Protected Member Functions
string	GetSplitRightMessageText ()
ENotificationColor	GetLeftTextColor ()
ENotificationColor	GetRightTextColor ()
bool	ShouldReplaceLeftColorWithRightColorIfAlly ()

Protected Attributes
LocalizedString	m_sSplitNotificationRightMessage
ENotificationColor	m_iLeftTextColor
ENotificationColor	m_iRightTextColor
bool	m_bReplaceLeftColorWithRightColorIfFactionsAreAlly

Detailed Description

Definition at line 2 of file SCR_SplitNotificationUIInfo.c.

Member Function Documentation

GetLeftTextColor()

ENotificationColor SCR_SplitNotificationUIInfo::GetLeftTextColor ( )

inlineprotected

Get the color enum of the left text

Returns

Color enum so the system knows what to color the left text

Definition at line 27 of file SCR_SplitNotificationUIInfo.c.

GetRightTextColor()

ENotificationColor SCR_SplitNotificationUIInfo::GetRightTextColor ( )

inlineprotected

Get the color enum of the right text

Returns

Color enum so the system knows what to color the right text

Definition at line 35 of file SCR_SplitNotificationUIInfo.c.

GetSplitRightMessageText()

string SCR_SplitNotificationUIInfo::GetSplitRightMessageText ( )

inlineprotected

Get the text to display on the right side of the notification

Parameters

text	to display

Definition at line 19 of file SCR_SplitNotificationUIInfo.c.

ShouldReplaceLeftColorWithRightColorIfAlly()

bool SCR_SplitNotificationUIInfo::ShouldReplaceLeftColorWithRightColorIfAlly ( )

inlineprotected

This is for notifications that involve two entities and the two entities are friendlies e.g: player1 Killed player2. If player2 is friendly with player1 then player1 will be coloured the same as player2. If there are only one or less entities involved this will be ignored Supported notification classes: SCR_NotificationPlayerTargetPlayer, SCR_NotificationPlayerTargetEditableEntity, SCR_NotificationEditableEntityTargetPlayer and SCR_NotificationEditableEntityEditableEntityTarget

Returns

whether or not it should check if factions are friendly and replace the colors if so

Definition at line 46 of file SCR_SplitNotificationUIInfo.c.

Member Data Documentation

m_bReplaceLeftColorWithRightColorIfFactionsAreAlly

bool SCR_SplitNotificationUIInfo::m_bReplaceLeftColorWithRightColorIfFactionsAreAlly

protected

Definition at line 14 of file SCR_SplitNotificationUIInfo.c.

m_iLeftTextColor

ENotificationColor SCR_SplitNotificationUIInfo::m_iLeftTextColor

protected

Definition at line 8 of file SCR_SplitNotificationUIInfo.c.

m_iRightTextColor

ENotificationColor SCR_SplitNotificationUIInfo::m_iRightTextColor

protected

Definition at line 11 of file SCR_SplitNotificationUIInfo.c.

m_sSplitNotificationRightMessage

LocalizedString SCR_SplitNotificationUIInfo::m_sSplitNotificationRightMessage

protected

Definition at line 5 of file SCR_SplitNotificationUIInfo.c.

---

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

• scripts/Game/Editor/Containers/UIInfo/SCR_SplitNotificationUIInfo.c