SCR_InventoryItemHintUIInfo Interface Reference

Inheritance diagram for SCR_InventoryItemHintUIInfo:

Public Member Functions
bool	CanBeShown (InventoryItemComponent item, SCR_InventorySlotUI focusedSlot)
override bool	SetIconTo (ImageWidget imageWidget)
	Set icon to given image widget.
bool	SetItemHintNameTo (InventoryItemComponent item, TextWidget textWidget)
string	GetItemHintName (InventoryItemComponent item)
	Function to override to get custom/dynamic item hint name.
Public Member Functions inherited from SCR_ColorUIInfo
Color	GetColor ()
	Get 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
SCR_EInventoryHintInputDevice	m_eShowWithInputDevice
bool	m_bHideInArsenal
SCR_InventorySlotUI	m_LastFocusedSlot
Protected Attributes inherited from SCR_ColorUIInfo
ref Color	m_cColor
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.
Protected Member Functions inherited from SCR_ColorUIInfo
override void	CopyFrom (SCR_UIName source)
override void	CopyFrom (SCR_UIName source)
override void	CopyFrom (SCR_UIName source)
void	CopyFrom (SCR_UIName source)

Member Function Documentation

CanBeShown()

bool SCR_InventoryItemHintUIInfo.CanBeShown	(	InventoryItemComponent	item,
		SCR_InventorySlotUI	focusedSlot
	)

Parameters

item
focusedSlot

Returns

Implemented in SCR_BaseSupplyItemHintUIInfo, SCR_FuelItemHintsUIInfo, SCR_SupplyAvailableItemHintUIInfo, SCR_SupplyCostItemHintUIInfo, SCR_SupplyMoveItemHintUIInfo, SCR_SupplyRefundItemHintUIInfo, and SCR_SupplyStoredItemHintUIInfo.

GetItemHintName()

string SCR_InventoryItemHintUIInfo.GetItemHintName

(

InventoryItemComponent

item

)

Function to override to get custom/dynamic item hint name.

Implemented in SCR_FuelItemHintsUIInfo, SCR_SupplyAvailableItemHintUIInfo, SCR_SupplyCostItemHintUIInfo, SCR_SupplyRefundItemHintUIInfo, and SCR_SupplyStoredItemHintUIInfo.

SetIconTo()

override bool SCR_InventoryItemHintUIInfo.SetIconTo

(

ImageWidget

imageWidget

)

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

Implements SCR_UIInfo.

SetItemHintNameTo()

bool SCR_InventoryItemHintUIInfo.SetItemHintNameTo	(	InventoryItemComponent	item,
		TextWidget	textWidget
	)

Parameters

item
textWidget

Returns

Member Data Documentation

m_bHideInArsenal

bool SCR_InventoryItemHintUIInfo.m_bHideInArsenal

protected

m_eShowWithInputDevice

SCR_EInventoryHintInputDevice SCR_InventoryItemHintUIInfo.m_eShowWithInputDevice

protected

m_LastFocusedSlot

SCR_InventorySlotUI SCR_InventoryItemHintUIInfo.m_LastFocusedSlot

protected

---

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

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