SCR_UIInfo Class Reference

Inheritance diagram for SCR_UIInfo:

Protected Member Functions
ResourceName	GetIconPath ()
ResourceName	GetIcon ()
ResourceName	GetImageSetPath ()
string	GetIconSetName ()
bool	HasIcon ()
bool	SetIconTo (ImageWidget imageWidget)
override void	Log (string prefix=string.Empty, LogLevel logLevel=LogLevel.VERBOSE)
override void	CopyFrom (SCR_UIName source)

Static Protected Member Functions
static SCR_UIInfo	GetInfo (BaseContainer source, string varName)
static SCR_UIInfo	CreateInfo (UIInfo source)
static SCR_UIInfo	CreateInfo (LocalizedString name, LocalizedString description=LocalizedString.Empty, ResourceName icon=ResourceName.Empty, string iconSetName=string.Empty)
static SCR_UIInfo	CreatePlaceholderInfo (typename type)

Protected Attributes
ResourceName	Icon
string	IconSetName

Detailed Description

Class used to hold UI information. 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. Inspired by engine-driven UIInfo, but not related to it.

See also

UIInfo

Definition at line 7 of file SCR_UIInfo.c.

Member Function Documentation

CopyFrom()

override void SCR_UIInfo::CopyFrom ( SCR_UIName source )

inlineprotected

Definition at line 188 of file SCR_UIInfo.c.

CreateInfo() [1/2]

SCR_UIInfo SCR_UIInfo::CreateInfo ( LocalizedString name, LocalizedString description = LocalizedString.Empty, ResourceName icon = ResourceName.Empty, string iconSetName = string.Empty )

inlinestaticprotected

Create SCR_UIInfo from basic params.

Parameters

name
description
icon
iconSetName

Returns

SCR_UIInfo class

Definition at line 165 of file SCR_UIInfo.c.

CreateInfo() [2/2]

SCR_UIInfo SCR_UIInfo::CreateInfo ( UIInfo source )

inlinestaticprotected

Create SCR_UIInfo from engine UIInfo.

Parameters

source

Source info

Returns

SCR_UIInfo class

Definition at line 146 of file SCR_UIInfo.c.

CreatePlaceholderInfo()

SCR_UIInfo SCR_UIInfo::CreatePlaceholderInfo ( typename type )

inlinestaticprotected

Get placeholder info

Parameters

type	inherited from SCR_UIInfo

Returns

UIInfo class

Definition at line 179 of file SCR_UIInfo.c.

GetIcon()

ResourceName SCR_UIInfo::GetIcon ( )

inlineprotected

Definition at line 37 of file SCR_UIInfo.c.

GetIconPath()

ResourceName SCR_UIInfo::GetIconPath ( )

inlineprotected

Get icon. When using it to fill ImageWIdget, use SetIconTo() if possible. Especially important since the image can point to image set instead of plain texture!

Returns

Image path

Definition at line 20 of file SCR_UIInfo.c.

GetIconSetName()

string SCR_UIInfo::GetIconSetName ( )

inlineprotected

Returns Icon Set name if imageset

Returns

string empty if not a image set

Definition at line 65 of file SCR_UIInfo.c.

GetImageSetPath()

ResourceName SCR_UIInfo::GetImageSetPath ( )

inlineprotected

Get Image Set. When using it to fill ImageWIdget, use SetIconTo() if possible. Especially important since the image can point to image set instead of plain texture!

Returns

Image path

Definition at line 47 of file SCR_UIInfo.c.

GetInfo()

SCR_UIInfo SCR_UIInfo::GetInfo ( BaseContainer source, string varName )

inlinestaticprotected

Get UIInfo from a source object.

Parameters

source	Source object, most commonly entity or component source
varName	Variable name of UIInfo

Returns

UIInfo class

Definition at line 133 of file SCR_UIInfo.c.

HasIcon()

bool SCR_UIInfo::HasIcon ( )

inlineprotected

Check if the info has an icon defined.

Returns

True when the icon is defined

Definition at line 79 of file SCR_UIInfo.c.

Log()

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

inlineprotected

Parameters

prefix
logLevel

Definition at line 123 of file SCR_UIInfo.c.

SetIconTo()

bool SCR_UIInfo::SetIconTo ( ImageWidget imageWidget )

inlineprotected

Set icon to given image widget. Use this function instead of retrieving the texture using GetIconPath() and setting it manually! When the texture is an image set, manual setting would not work.

Parameters

imageWidget

Target image widget

Returns

True when the image was set

Definition at line 102 of file SCR_UIInfo.c.

Member Data Documentation

Icon

ResourceName SCR_UIInfo::Icon

protected

Definition at line 10 of file SCR_UIInfo.c.

IconSetName

string SCR_UIInfo::IconSetName

protected

Definition at line 13 of file SCR_UIInfo.c.

---

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

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