SCR_KeyBlockUIName Interface Reference

Inheritance diagram for SCR_KeyBlockUIName:

Public Member Functions
override LocalizedString	GetName ()
	Get name.
Public Member Functions inherited from SCR_DeviceBlockUIName
override bool	HasName ()
	Check if the info has a name defined.
Public Member Functions inherited from SCR_SubBlockUIName
bool	IsInline ()
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.
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_KeyBlockEntry >	m_aKeys
Protected Attributes inherited from SCR_DeviceBlockUIName
int	m_iDevice
Protected Attributes inherited from SCR_SubBlockUIName
bool	m_bInline
Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Static Protected Attributes
const LocalizedString	m_sHoldModifier = "#ENF-HoldModifier"
const LocalizedString	m_sDoubleModifier = "#ENF-DoubleModifier"
const LocalizedString	m_sComboModifier = "#ENF-ComboModifier"
const LocalizedString	m_sEllipsisModifier = "..."
const LocalizedString	m_sDelimiter = "<br/>"

Additional Inherited Members
Protected Member Functions inherited from SCR_UIName
void	CopyFrom (SCR_UIName source)

Member Function Documentation

GetName()

override LocalizedString SCR_KeyBlockUIName.GetName

(

)

Get name.

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

Returns

Name text

Implements SCR_UIName.

Member Data Documentation

m_aKeys

ref array<ref SCR_KeyBlockEntry> SCR_KeyBlockUIName.m_aKeys

protected

m_sComboModifier

const LocalizedString SCR_KeyBlockUIName.m_sComboModifier = "#ENF-ComboModifier"

staticprotected

m_sDelimiter

const LocalizedString SCR_KeyBlockUIName.m_sDelimiter = "<br/>"

staticprotected

m_sDoubleModifier

const LocalizedString SCR_KeyBlockUIName.m_sDoubleModifier = "#ENF-DoubleModifier"

staticprotected

m_sEllipsisModifier

const LocalizedString SCR_KeyBlockUIName.m_sEllipsisModifier = "..."

staticprotected

m_sHoldModifier

const LocalizedString SCR_KeyBlockUIName.m_sHoldModifier = "#ENF-HoldModifier"

staticprotected

---

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

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