SCR_BlockUIInfo Class Reference

Inheritance diagram for SCR_BlockUIInfo:

Protected Member Functions
override bool	HasDescription ()
override LocalizedString	GetDescription ()
LocalizedString	GetUnformattedDescriptionBlockName (int index)
void	SetDescriptionBlockName (int index, LocalizedString text)

Protected Attributes
ref array< ref SCR_SubBlockUIName >	m_aDescriptionBlocks

Detailed Description

Definition at line 2 of file SCR_BlockUIInfo.c.

Member Function Documentation

GetDescription()

override LocalizedString SCR_BlockUIInfo::GetDescription ( )

inlineprotected

Definition at line 12 of file SCR_BlockUIInfo.c.

GetUnformattedDescriptionBlockName()

LocalizedString SCR_BlockUIInfo::GetUnformattedDescriptionBlockName ( int index )

inlineprotected

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.

Definition at line 40 of file SCR_BlockUIInfo.c.

HasDescription()

override bool SCR_BlockUIInfo::HasDescription ( )

inlineprotected

Definition at line 7 of file SCR_BlockUIInfo.c.

SetDescriptionBlockName()

void SCR_BlockUIInfo::SetDescriptionBlockName ( int index, LocalizedString text )

inlineprotected

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)

Definition at line 55 of file SCR_BlockUIInfo.c.

Member Data Documentation

m_aDescriptionBlocks

ref array<ref SCR_SubBlockUIName> SCR_BlockUIInfo::m_aDescriptionBlocks

protected

Definition at line 5 of file SCR_BlockUIInfo.c.

---

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

• scripts/Game/Editor/Containers/UIInfo/SCR_BlockUIInfo.c