SCR_UIDescription Interface Reference

Class used to hold UI name and description. More...

Inheritance diagram for SCR_UIDescription:

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

Protected Member Functions
override void	CopyFrom (SCR_UIName source)

Protected Attributes
LocalizedString	Description
Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Detailed Description

Class used to hold UI name and description.

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

Member Function Documentation

CopyFrom()

override void SCR_UIDescription.CopyFrom ( SCR_UIName source )

protected

Implements SCR_UIName.

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

GetDescription()

LocalizedString SCR_UIDescription.GetDescription

(

)

Get description.

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

Returns

Description text

Implemented in SCR_BlockUIInfo.

GetUnformattedDescription()

LocalizedString SCR_UIDescription.GetUnformattedDescription

(

)

Get the unformatted description from SCR_HintUIInfo instance.

Returns

LocalizedString description set in SCR_HintUIInfo instance.

HasDescription()

bool SCR_UIDescription.HasDescription

(

)

Check if the info has a description defined.

Returns

True when the description is defined

Implemented in SCR_BlockUIInfo.

Log()

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

Parameters

prefix
logLevel

Implements SCR_UIName.

Implemented in SCR_UIInfo.

SetDescription()

void SCR_UIDescription.SetDescription

(

LocalizedString

description

)

Change the description from SCR_HintUIInfo instance.

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

Parameters

LocalizedString

text to which discription should be updated to.

Implemented in SCR_OverridableUIInfo.

SetDescriptionTo()

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

Implemented in SCR_EditableDescriptorUIInfo, SCR_FormatUIInfo, and SCR_HintUIInfo.

Member Data Documentation

Description

LocalizedString SCR_UIDescription.Description

protected

---

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

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