Inheritance diagram for SCR_DamageStateUIInfo:

[legend]

Public Member Functions
Color	GetColor ()
	Get color of Icon and Outline.

Color	GetBackgroundColor ()
	Get color of background.

Color	GetOutlineColor ()
	Get color of outline.

Color	GetBackgroundColorRegen ()
	Get regeneration color of background.

Color	GetOutlineColorRegen ()
	Get regeneration color of outline.

ResourceName	GetOutlineImage ()
	Get ResourceName of outline image.

ResourceName	GetBackgroundImage ()
	Get ResourceName of outline image.

string	GetOutlineQuadName ()
	Get name of outline image quad (if is from imageset)

string	GetBackgroundQuadName ()
	Get name of background image quad (if is from imageset)

bool	SetImageTo (ImageWidget imageWidget, ResourceName imageRes, string quadName=string.Empty)
	Set image to given image widget.

bool	SetIconTo (ImageWidget imageWidget, int iconIndex)
	SetIconTo() overload that accepts an index when m_aIconNames is not empty.

string	GetIconSetName (int iconIndex)
	GetIconSetName() overload specified by an array index.

Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.

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.

override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)

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.

void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

Protected Attributes
ref Color	m_Color

ref Color	m_BackgroundColor

ref Color	m_OutlineColor

ref Color	m_BackgroundColorRegen

ref Color	m_OutlineColorRegen

ResourceName	m_sOutlineImage

string	m_sOutlineQuadName

ResourceName	m_sBackgroundImage

string	m_sBackgroundQuadName

ref array< string >	m_aIconNames

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)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Member Function Documentation

◆ GetBackgroundColor()

Color SCR_DamageStateUIInfo.GetBackgroundColor ( )

Get color of background.

Returns: background colour

◆ GetBackgroundColorRegen()

Color SCR_DamageStateUIInfo.GetBackgroundColorRegen ( )

Get regeneration color of background.

Returns: background's regeneration colour

◆ GetBackgroundImage()

ResourceName SCR_DamageStateUIInfo.GetBackgroundImage ( )

Get ResourceName of outline image.

Returns: Outline image

◆ GetBackgroundQuadName()

string SCR_DamageStateUIInfo.GetBackgroundQuadName ( )

Get name of background image quad (if is from imageset)

Returns: Background image quad name

◆ GetColor()

Color SCR_DamageStateUIInfo.GetColor ( )

Get color of Icon and Outline.

Returns: icon/outline colour

◆ GetIconSetName()

string SCR_DamageStateUIInfo.GetIconSetName ( int iconIndex )

GetIconSetName() overload specified by an array index.

Parameters

iconIndex Index of an icon from m_aIconNames array

Returns

◆ GetOutlineColor()

Color SCR_DamageStateUIInfo.GetOutlineColor ( )

Get color of outline.

Returns: outline colour

◆ GetOutlineColorRegen()

Color SCR_DamageStateUIInfo.GetOutlineColorRegen ( )

Get regeneration color of outline.

Returns

◆ GetOutlineImage()

ResourceName SCR_DamageStateUIInfo.GetOutlineImage ( )

Get ResourceName of outline image.

Returns: Outline image

◆ GetOutlineQuadName()

string SCR_DamageStateUIInfo.GetOutlineQuadName ( )

Get name of outline image quad (if is from imageset)

Returns: Outline image quad name

◆ SetIconTo()

bool SCR_DamageStateUIInfo.SetIconTo	(	ImageWidget	imageWidget,
		int	iconIndex
	)

SetIconTo() overload that accepts an index when m_aIconNames is not empty.

Parameters

imageWidget	Target image widget
iconIndex	Index of an icon from m_aIconNames array

Returns: True when the image was set

◆ SetImageTo()

bool SCR_DamageStateUIInfo.SetImageTo	(	ImageWidget	imageWidget,
		ResourceName	imageRes,
		string	quadName = `string::Empty`
	)

Set image to given image widget.

Parameters

imageWidget	Target image widget
imageRes	Source image resource

Returns: True when the image was set

Member Data Documentation

◆ m_aIconNames

ref array<string> SCR_DamageStateUIInfo.m_aIconNames

protected

◆ m_BackgroundColor

ref Color SCR_DamageStateUIInfo.m_BackgroundColor

protected

◆ m_BackgroundColorRegen

ref Color SCR_DamageStateUIInfo.m_BackgroundColorRegen

protected

◆ m_Color

ref Color SCR_DamageStateUIInfo.m_Color

protected

◆ m_OutlineColor

ref Color SCR_DamageStateUIInfo.m_OutlineColor

protected

◆ m_OutlineColorRegen

ref Color SCR_DamageStateUIInfo.m_OutlineColorRegen

protected

◆ m_sBackgroundImage

ResourceName SCR_DamageStateUIInfo.m_sBackgroundImage

protected

◆ m_sBackgroundQuadName

string SCR_DamageStateUIInfo.m_sBackgroundQuadName

protected

◆ m_sOutlineImage

ResourceName SCR_DamageStateUIInfo.m_sOutlineImage

protected

◆ m_sOutlineQuadName

string SCR_DamageStateUIInfo.m_sOutlineQuadName

protected

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

Game/Editor/Containers/UIInfo/SCR_DamageStateUIInfo.c

Public Member Functions

Protected Attributes

Additional Inherited Members

Member Function Documentation

◆ GetBackgroundColor()

◆ GetBackgroundColorRegen()

◆ GetBackgroundImage()

◆ GetBackgroundQuadName()

◆ GetColor()

◆ GetIconSetName()

◆ GetOutlineColor()

◆ GetOutlineColorRegen()

◆ GetOutlineImage()

◆ GetOutlineQuadName()

◆ SetIconTo()

◆ SetImageTo()

Member Data Documentation

◆ m_aIconNames

◆ m_BackgroundColor

◆ m_BackgroundColorRegen

◆ m_Color

◆ m_OutlineColor

◆ m_OutlineColorRegen

◆ m_sBackgroundImage

◆ m_sBackgroundQuadName

◆ m_sOutlineImage

◆ m_sOutlineQuadName