SCR_UIName Class Reference

Inheritance diagram for SCR_UIName:

Protected Member Functions
LocalizedString	GetUnformattedName ()
void	SetName (LocalizedString name)
LocalizedString	GetName ()
bool	HasName ()
bool	SetNameTo (TextWidget textWidget)
void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
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.

Definition at line 5 of file SCR_UIName.c.

Member Function Documentation

CopyFrom()

void SCR_UIName::CopyFrom ( SCR_UIName source )

inlineprotected

Definition at line 74 of file SCR_UIName.c.

GetName()

LocalizedString SCR_UIName::GetName ( )

inlineprotected

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

Returns

Name text

Definition at line 31 of file SCR_UIName.c.

GetUnformattedName()

LocalizedString SCR_UIName::GetUnformattedName ( )

inlineprotected

Get The unformatted Name from SCR_HintUIInfo instance.

Returns

LocalizedString Name set in SCR_HintUIInfo instance.

Definition at line 13 of file SCR_UIName.c.

HasName()

bool SCR_UIName::HasName ( )

inlineprotected

Check if the info has a name defined.

Returns

True when the name is defined

Definition at line 39 of file SCR_UIName.c.

Log()

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

inlineprotected

Print out contents of this UI info

Parameters

prefix
logLevel

Definition at line 68 of file SCR_UIName.c.

SetName()

void SCR_UIName::SetName ( LocalizedString name )

inlineprotected

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.

Definition at line 22 of file SCR_UIName.c.

SetNameTo()

bool SCR_UIName::SetNameTo ( TextWidget textWidget )

inlineprotected

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

Definition at line 53 of file SCR_UIName.c.

Member Data Documentation

Name

LocalizedString SCR_UIName::Name

protected

Definition at line 8 of file SCR_UIName.c.

---

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

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