SCR_FormatUIInfo Interface Reference

Inheritance diagram for SCR_FormatUIInfo:

Public Member Functions
override bool	SetNameTo (TextWidget textWidget)
	Set name to given text widget.
override bool	SetDescriptionTo (TextWidget textWidget)
	Set description to given text widget.
Public Member Functions inherited from SCR_BlockUIInfo
override bool	HasDescription ()
	Check if the info has a description defined.
override LocalizedString	GetDescription ()
	Get description.
LocalizedString	GetUnformattedDescriptionBlockName (int index)
	Get Name of selected description block without formatting (raw).
void	SetDescriptionBlockName (int index, LocalizedString text)
	Changes the Name (text) of selected Description Block.
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.
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.

Protected Member Functions
string	Param (int index)
Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)

Protected Attributes
ref array< ref SCR_BaseFormatParam >	m_aParams
Protected Attributes inherited from SCR_BlockUIInfo
ref array< ref SCR_SubBlockUIName >	m_aDescriptionBlocks
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.

Member Function Documentation

Param()

string SCR_FormatUIInfo.Param ( int index )

protected

Parameters

index

Returns

SetDescriptionTo()

override bool SCR_FormatUIInfo.SetDescriptionTo

(

TextWidget

textWidget

)

Set description to given text widget.

When possible, use this function instead of retrieving the description using GetDescription() and setting it manually. Custom UI info classes may be using parameters which would not be applied otherwise.

Parameters

textWidget

Target text widget

Returns

True when the description was set

Implements SCR_UIDescription.

SetNameTo()

override bool SCR_FormatUIInfo.SetNameTo

(

TextWidget

textWidget

)

Set name to given text widget.

When possible, use this function instead of retrieving the name using GetName() and setting it manually. Custom UI info classes may be using parameters which would not be applied otherwise.

Parameters

textWidget

Target text widget

Returns

True when the name was set

Implements SCR_UIName.

Member Data Documentation

m_aParams

ref array<ref SCR_BaseFormatParam> SCR_FormatUIInfo.m_aParams

protected

---

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

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