SCR_UIDescription Class Reference

Inheritance diagram for SCR_UIDescription:

Protected Member Functions
LocalizedString	GetUnformattedDescription ()
void	SetDescription (LocalizedString description)
LocalizedString	GetDescription ()
bool	HasDescription ()
bool	SetDescriptionTo (TextWidget textWidget)
override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
void	CopyFrom (SCR_UIName source)

Protected Attributes
LocalizedString	Description

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.

Definition at line 5 of file SCR_UIDescription.c.

Member Function Documentation

CopyFrom()

void SCR_UIDescription::CopyFrom ( SCR_UIName source )

inlineprotected

Definition at line 75 of file SCR_UIDescription.c.

GetDescription()

LocalizedString SCR_UIDescription::GetDescription ( )

inlineprotected

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

Returns

Description text

Definition at line 31 of file SCR_UIDescription.c.

GetUnformattedDescription()

LocalizedString SCR_UIDescription::GetUnformattedDescription ( )

inlineprotected

Get the unformatted description from SCR_HintUIInfo instance.

Returns

LocalizedString description set in SCR_HintUIInfo instance.

Definition at line 13 of file SCR_UIDescription.c.

HasDescription()

bool SCR_UIDescription::HasDescription ( )

inlineprotected

Check if the info has a description defined.

Returns

True when the description is defined

Definition at line 39 of file SCR_UIDescription.c.

Log()

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

inlineprotected

Parameters

prefix
logLevel

Definition at line 68 of file SCR_UIDescription.c.

SetDescription()

void SCR_UIDescription::SetDescription ( LocalizedString description )

inlineprotected

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.

Definition at line 22 of file SCR_UIDescription.c.

SetDescriptionTo()

bool SCR_UIDescription::SetDescriptionTo ( TextWidget textWidget )

inlineprotected

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

Definition at line 53 of file SCR_UIDescription.c.

Member Data Documentation

Description

LocalizedString SCR_UIDescription::Description

protected

Definition at line 8 of file SCR_UIDescription.c.

---

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

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