SCR_UIName Interface Reference

Class used to hold UI name. More...

Inheritance diagram for SCR_UIName:

Public Member Functions
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 Member Functions
void	CopyFrom (SCR_UIName source)

Protected Attributes
LocalizedString	Name

Detailed Description

Class used to hold UI name.

Data are intentionally READ ONLY, because the class is often used on prefabs, not instances. Instead of adding SetXXX() methods here, consider using specialised inherited class.

Member Function Documentation

CopyFrom()

void SCR_UIName.CopyFrom ( SCR_UIName source )

protected

Implemented in SCR_ArsenalSaveTypeUIInfo, SCR_ColorUIInfo, SCR_EditableDescriptorUIInfo, SCR_EditableEntityUIInfo, SCR_EditableGroupUIInfo, SCR_EditorAttributeUIInfo, SCR_UIDescription, and SCR_UIInfo.

GetName()

LocalizedString SCR_UIName.GetName

(

)

Get name.

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

Returns

Name text

Implemented in SCR_ActionBlockUIName, SCR_BulletPointBlockUIName, SCR_EditableEntityUIInfo, SCR_EditableGroupUIInfo, SCR_FormatedUIInfo, SCR_ImageBlockUIName, SCR_KeyBlockUIName, SCR_PlayerUIInfo, SCR_SimpleTagBlockUIName, and SCR_TipBlockUIName.

GetUnformattedName()

LocalizedString SCR_UIName.GetUnformattedName

(

)

Get The unformatted Name from SCR_HintUIInfo instance.

Returns

LocalizedString Name set in SCR_HintUIInfo instance.

HasName()

bool SCR_UIName.HasName

(

)

Check if the info has a name defined.

Returns

True when the name is defined

Implemented in SCR_DeviceBlockUIName.

Log()

void SCR_UIName.Log	(	string	prefix = string::Empty,
		LogLevel	logLevel = LogLevel::VERBOSE )

Print out contents of this UI info.

Parameters

prefix
logLevel

Implemented in SCR_UIDescription, and SCR_UIInfo.

SetName()

void SCR_UIName.SetName

(

LocalizedString

name

)

Change the Name from SCR_HintUIInfo instance.

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

Parameters

LocalizedString

text to which name should be updated to.

Implemented in SCR_OverridableUIInfo.

SetNameTo()

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

Implemented in SCR_EditableDescriptorUIInfo, SCR_FormatedUIInfo, and SCR_FormatUIInfo.

Member Data Documentation

Name

LocalizedString SCR_UIName.Name

protected

---

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

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