SCR_ActionUIInfo Interface Reference

Inheritance diagram for SCR_ActionUIInfo:

Public Member Functions
bool	SetIconTo (ImageWidget imageWidget, ImageWidget glowWidget=null)
	Set icon to given image widgets.
void	SetImageSet (ResourceName imageset)
	Set the ImageSet to be used for the Image widget.
string	GetIconName ()
	Get the icon name if defined.
Public Member Functions inherited from UIInfo
proto external string	GetName ()
	Returns the text provided by this UI info.
proto external void	SetName (string name)
	Set the name of this UI Info.
proto external string	GetDescription ()
	Returns the description provided by this UI info.
proto external void	SetDescription (string description)
	Set the description of this UI Info.
proto external ResourceName	GetIconPath ()
	Returns the icon ResourceName provided by this UI info.

Protected Attributes
ResourceName	m_sInteractionIcon
ResourceName	m_sInteractionGlowIcon
string	m_sIconName

Member Function Documentation

GetIconName()

string SCR_ActionUIInfo.GetIconName

(

)

Get the icon name if defined.

Returns

string IconName

SetIconTo()

bool SCR_ActionUIInfo.SetIconTo	(	ImageWidget	imageWidget,
		ImageWidget	glowWidget = null )

Set icon to given image widgets.

Parameters

[in]	ImageWidget	Target image widget
[in]	ImageWidget	Target glow widget. Can be null

Returns

True when the image was set

SetImageSet()

void SCR_ActionUIInfo.SetImageSet

(

ResourceName

imageset

)

Set the ImageSet to be used for the Image widget.

Parameters

[in]

ResourceName

imageset

Member Data Documentation

m_sIconName

string SCR_ActionUIInfo.m_sIconName

protected

m_sInteractionGlowIcon

ResourceName SCR_ActionUIInfo.m_sInteractionGlowIcon

protected

m_sInteractionIcon

ResourceName SCR_ActionUIInfo.m_sInteractionIcon

protected

---

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

• Game/UI/SCR_ActionUIInfo.c