UIInfoAssetCard Interface Reference

Inheritance diagram for UIInfoAssetCard:

Public Member Functions
Color	GetTextColor ()
ResourceName	GetTitleBackgroundPath ()
ResourceName	GetImagePath ()
Color	GetFactionColor ()
ResourceName	GetIconBackgroundPath ()
bool	GetModded ()
ResourceName	GetModsetIcon ()
ResourceName	GetModsetFrame ()
ResourceName	GetModsetLabel ()
ResourceName	GetCardBackground ()
int	GetTraits (out notnull array< EAssetTrait > outTraits)
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.

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.
Protected Member Functions inherited from SCR_UIInfo
override void	CopyFrom (SCR_UIName source)
override void	CopyFrom (SCR_UIName source)
void	CopyFrom (SCR_UIName source)
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

Member Function Documentation

GetCardBackground()

ResourceName UIInfoAssetCard.GetCardBackground

(

)

Returns

the path to the card background texture

GetFactionColor()

Color UIInfoAssetCard.GetFactionColor

(

)

Returns

the faction color of the entity

GetIconBackgroundPath()

ResourceName UIInfoAssetCard.GetIconBackgroundPath

(

)

Returns

the path to the icon background texture

GetImagePath()

ResourceName UIInfoAssetCard.GetImagePath

(

)

Returns

the path to the entity texture

GetModded()

bool UIInfoAssetCard.GetModded

(

)

Returns

true if an entity is modded

GetModsetFrame()

ResourceName UIInfoAssetCard.GetModsetFrame

(

)

Returns

the path to the modset frame texture

GetModsetIcon()

ResourceName UIInfoAssetCard.GetModsetIcon

(

)

Returns

the path to the modset icon texture

GetModsetLabel()

ResourceName UIInfoAssetCard.GetModsetLabel

(

)

Returns

the path to the modset label texture

GetTextColor()

Color UIInfoAssetCard.GetTextColor

(

)

Returns

the color variable at which the title text is supposed to be set

GetTitleBackgroundPath()

ResourceName UIInfoAssetCard.GetTitleBackgroundPath

(

)

Returns

the path to the background of the title

GetTraits()

int UIInfoAssetCard.GetTraits

(

out notnull array< EAssetTrait >

outTraits

)

Returns

an array of traits linked to the entity.

---

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

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