Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_FactionOutfitItemHintUIInfo Interface Reference
Inheritance diagram for SCR_FactionOutfitItemHintUIInfo:
SCR_InventoryItemHintUIInfo SCR_ColorUIInfo SCR_UIInfo SCR_UIDescription SCR_UIName

Public Member Functions

void SetFaction (notnull Faction faction, notnull SCR_OutfitFactionData outfitFactionData)
 
override bool SetIconTo (ImageWidget imageWidget)
 Set icon to given image widget.
 
override bool SetItemHintNameTo (InventoryItemComponent item, TextWidget textWidget)
 
- Public Member Functions inherited from SCR_InventoryItemHintUIInfo
bool CanBeShown (InventoryItemComponent item, SCR_InventorySlotUI focusedSlot)
 
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.
 
ResourceName GetImageSetPath ()
 Get Image Set.
 
string GetIconSetName ()
 Returns Icon Set name if imageset.
 
bool HasIcon ()
 Check if the info has an icon defined.
 
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.
 
- 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.
 

Protected Attributes

Faction m_Faction
 
int m_iValue
 
- Protected Attributes inherited from SCR_InventoryItemHintUIInfo
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)
 

Member Function Documentation

◆ SetFaction()

void SCR_FactionOutfitItemHintUIInfo.SetFaction ( notnull Faction faction,
notnull SCR_OutfitFactionData outfitFactionData )

◆ SetIconTo()

override bool SCR_FactionOutfitItemHintUIInfo.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
imageWidgetTarget image widget
Returns
True when the image was set

Implements SCR_InventoryItemHintUIInfo.

◆ SetItemHintNameTo()

override bool SCR_FactionOutfitItemHintUIInfo.SetItemHintNameTo ( InventoryItemComponent item,
TextWidget textWidget )
Parameters
item
textWidget
Returns

Implements SCR_InventoryItemHintUIInfo.

Member Data Documentation

◆ m_Faction

Faction SCR_FactionOutfitItemHintUIInfo.m_Faction
protected

◆ m_iValue

int SCR_FactionOutfitItemHintUIInfo.m_iValue
protected

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