SCR_SplitNotificationUIInfo Interface Reference

Inheritance diagram for SCR_SplitNotificationUIInfo:

Public Member Functions
string	GetSplitRightMessageText ()
	Get the text to display on the right side of the notification.
ENotificationColor	GetLeftTextColor ()
	Get the color enum of the left text.
ENotificationColor	GetRightTextColor ()
	Get the color enum of the right text.
bool	ShouldReplaceLeftColorWithRightColorIfAlly ()
	This is for notifications that involve two entities and the two entities are friendlies e.g: player1 Killed player2.
Public Member Functions inherited from SCR_UINotificationInfo
ENotificationColor	GetNotificationColor ()
	Get the notification color enum to set the widgets to in the notification message.
ENotificationSetPositionData	GetEditorSetPositionData ()
	Get type of: if and how the teleport to notification works.
Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.
ResourceName	GetImageSetPath ()
	Get Image Set.
string	GetIconSetName ()
	Returns Icon Set name if imageset.
bool	HasIcon ()
	Check if the info has an icon defined.
bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.
override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
Public Member Functions inherited from SCR_UIDescription
LocalizedString	GetUnformattedDescription ()
	Get the unformatted description from SCR_HintUIInfo instance.
void	SetDescription (LocalizedString description)
	Change the description from SCR_HintUIInfo instance.
LocalizedString	GetDescription ()
	Get description.
bool	HasDescription ()
	Check if the info has a description defined.
bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.
Public Member Functions inherited from SCR_UIName
LocalizedString	GetUnformattedName ()
	Get The unformatted Name from SCR_HintUIInfo instance.
void	SetName (LocalizedString name)
	Change the Name from SCR_HintUIInfo instance.
LocalizedString	GetName ()
	Get name.
bool	HasName ()
	Check if the info has a name defined.
bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.

Protected Attributes
LocalizedString	m_sSplitNotificationRightMessage
ENotificationColor	m_iLeftTextColor
ENotificationColor	m_iRightTextColor
bool	m_bReplaceLeftColorWithRightColorIfFactionsAreAlly
Protected Attributes inherited from SCR_UINotificationInfo
ENotificationColor	m_cNotificationColor
ENotificationSetPositionData	m_EditorSetPositionData
Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon
string	IconSetName
Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description
Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.
static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.
static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.
static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.
Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)

Member Function Documentation

GetLeftTextColor()

ENotificationColor SCR_SplitNotificationUIInfo.GetLeftTextColor

(

)

Get the color enum of the left text.

Returns

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

GetRightTextColor()

ENotificationColor SCR_SplitNotificationUIInfo.GetRightTextColor

(

)

Get the color enum of the right text.

Returns

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

GetSplitRightMessageText()

string SCR_SplitNotificationUIInfo.GetSplitRightMessageText

(

)

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

Parameters

text	to display

ShouldReplaceLeftColorWithRightColorIfAlly()

bool SCR_SplitNotificationUIInfo.ShouldReplaceLeftColorWithRightColorIfAlly

(

)

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

Member Data Documentation

m_bReplaceLeftColorWithRightColorIfFactionsAreAlly

bool SCR_SplitNotificationUIInfo.m_bReplaceLeftColorWithRightColorIfFactionsAreAlly

protected

m_iLeftTextColor

ENotificationColor SCR_SplitNotificationUIInfo.m_iLeftTextColor

protected

m_iRightTextColor

ENotificationColor SCR_SplitNotificationUIInfo.m_iRightTextColor

protected

m_sSplitNotificationRightMessage

LocalizedString SCR_SplitNotificationUIInfo.m_sSplitNotificationRightMessage

protected

---

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

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