Inheritance diagram for SCR_BlockUIInfo:

[legend]

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

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 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.

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

◆ GetDescription()

override LocalizedString SCR_BlockUIInfo.GetDescription ( )

Get description.

When using it to fill TextWidget, use SetDescriptionTo() if possible.

Returns: Description text

Implements SCR_UIDescription.

◆ GetUnformattedDescriptionBlockName()

LocalizedString SCR_BlockUIInfo.GetUnformattedDescriptionBlockName ( int index )

Get Name of selected description block without formatting (raw).

Parameters

Int	- index of Item in Description Block array

Returns: Unformatted Name set in selected Description block. - Empty if index out of bounce.

◆ HasDescription()

override bool SCR_BlockUIInfo.HasDescription ( )

Check if the info has a description defined.

Returns: True when the description is defined

Implements SCR_UIDescription.

◆ SetDescriptionBlockName()

void SCR_BlockUIInfo.SetDescriptionBlockName	(	int	index,
		LocalizedString	text
	)

Changes the Name (text) of selected Description Block.

Call SCR_HintManagerComponent.Refresh() to update shown hint to display changed text.

Parameters

Int	- index of Item in Description Block array
LocalizedString	- string that is going to be inserted in the Name. (Needs to be Localized)

Member Data Documentation

◆ m_aDescriptionBlocks

ref array<ref SCR_SubBlockUIName> SCR_BlockUIInfo.m_aDescriptionBlocks

protected

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

Game/Editor/Containers/UIInfo/SCR_BlockUIInfo.c

Public Member Functions

Protected Attributes