UIInfo used by editor attribute system. More...

Inheritance diagram for SCR_EditorAttributeUIInfo:

Public Member Functions
void	CopyFromEditorAttributeUIInfo (notnull SCR_EditorAttributeUIInfo source, LocalizedString overwriteDescription=string.Empty, Color overwriteColor=null)
	Copy UI info from source with potential overwrites.

override void	CopyFrom (SCR_UIName source)

Color	GetDescriptionIconColor ()
	Get attribute description icon color.

Public Member Functions inherited from SCR_UIInfo
ResourceName	GetIconPath ()
	Get icon.

string	GetIconSetName ()
	Returns Icon Set name if imageset.

bool	HasIcon ()
	Check if the info has an icon defined.

bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.

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

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

void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
	Print out contents of this UI info.

Protected Attributes
ref Color	m_cDescriptionIconColor

Protected Attributes inherited from SCR_UIInfo
ResourceName	Icon

string	IconSetName

Protected Attributes inherited from SCR_UIDescription
LocalizedString	Description

Protected Attributes inherited from SCR_UIName
LocalizedString	Name

Additional Inherited Members
Static Public Member Functions inherited from SCR_UIInfo
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
	Get UIInfo from a source object.

static SCR_UIInfo	CreateInfo (UIInfo source)
	Create SCR_UIInfo from engine UIInfo.

static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
	Create SCR_UIInfo from basic params.

static SCR_UIInfo	CreatePlaceholderInfo (TypeName type)
	Get placeholder info.

override void	CopyFrom (SCR_UIName source)

override void	CopyFrom (SCR_UIName source)

void	CopyFrom (SCR_UIName source)

Detailed Description

UIInfo used by editor attribute system.

Member Function Documentation

◆ CopyFrom()

override void SCR_EditorAttributeUIInfo.CopyFrom ( SCR_UIName source )

Implements SCR_UIInfo.

◆ CopyFromEditorAttributeUIInfo()

void SCR_EditorAttributeUIInfo.CopyFromEditorAttributeUIInfo	(	notnull SCR_EditorAttributeUIInfo	source,
		LocalizedString	overwriteDescription = `string::Empty`,
		Color	overwriteColor = `null`
	)

Copy UI info from source with potential overwrites.

Parameters

source	Source to copy from
overwriteDescription	Optional description overwrite
overwriteColor	Optional description icon Color overwrite

◆ GetDescriptionIconColor()

Color SCR_EditorAttributeUIInfo.GetDescriptionIconColor ( )

Get attribute description icon color.

Returns: Attribute description icon color

Member Data Documentation

◆ m_cDescriptionIconColor

ref Color SCR_EditorAttributeUIInfo.m_cDescriptionIconColor

protected

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

Game/Editor/Containers/UIInfo/SCR_EditorAttributeUIInfo.c

Public Member Functions

Protected Attributes