UIInfo used by the Notifications system. More...

Inheritance diagram for SCR_UINotificationInfo:

Public Member Functions
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
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)

Detailed Description

UIInfo used by the Notifications system.

Member Function Documentation

ENotificationSetPositionData SCR_UINotificationInfo.GetEditorSetPositionData ( )

Get type of: if and how the teleport to notification works.

Returns: Teleport enum that the Notification message to: Go to location, go to updated location or never go to location

ENotificationColor SCR_UINotificationInfo.GetNotificationColor ( )

Get the notification color enum to set the widgets to in the notification message.

Returns: Notification widget color in enum that the Notification log converts to a color

ENotificationColor SCR_UINotificationInfo.m_cNotificationColor

protected

ENotificationSetPositionData SCR_UINotificationInfo.m_EditorSetPositionData

protected

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