MagazineUIInfo Interface Reference

Forward declaration of UIInfo Serves as a container of data to be displayed on player UI. More...

Inheritance diagram for MagazineUIInfo:

Public Member Functions
string	GetAmmoCaliber ()
string	GetAmmoType ()
bool	ShowAmmoTypeText ()
EAmmoType	GetAmmoTypeFlags ()
Public Member Functions inherited from UIInfo
proto external string	GetName ()
	Returns the text provided by this UI info.
proto external void	SetName (string name)
	Set the name of this UI Info.
proto external string	GetDescription ()
	Returns the description provided by this UI info.
proto external void	SetDescription (string description)
	Set the description of this UI Info.
proto external ResourceName	GetIconPath ()
	Returns the icon ResourceName provided by this UI info.

Public Attributes
EAmmoType	m_eAmmoTypeFlags
	Magazine ammo type flags, used for displaying ammo type icons on weapon UI.
ref SCR_MagazineIndicatorConfiguration	m_MagIndicator

Protected Attributes
string	m_sAmmoCaliber
	Magazine background icon, created for WeaponInfo HUD element.
string	m_sAmmoType
	Magazine type string (AP, tracer, ball), as if it was written on this magazine. Used for Weapon Info UI.
bool	m_bShowAmmoTypeText

Detailed Description

Forward declaration of UIInfo Serves as a container of data to be displayed on player UI.

Member Function Documentation

GetAmmoCaliber()

string MagazineUIInfo.GetAmmoCaliber

(

)

GetAmmoType()

string MagazineUIInfo.GetAmmoType

(

)

GetAmmoTypeFlags()

EAmmoType MagazineUIInfo.GetAmmoTypeFlags

(

)

ShowAmmoTypeText()

bool MagazineUIInfo.ShowAmmoTypeText

(

)

Member Data Documentation

m_bShowAmmoTypeText

bool MagazineUIInfo.m_bShowAmmoTypeText

protected

m_eAmmoTypeFlags

EAmmoType MagazineUIInfo.m_eAmmoTypeFlags

Magazine ammo type flags, used for displaying ammo type icons on weapon UI.

m_MagIndicator

ref SCR_MagazineIndicatorConfiguration MagazineUIInfo.m_MagIndicator

m_sAmmoCaliber

string MagazineUIInfo.m_sAmmoCaliber

protected

Magazine background icon, created for WeaponInfo HUD element.

m_sAmmoType

string MagazineUIInfo.m_sAmmoType

protected

Magazine type string (AP, tracer, ball), as if it was written on this magazine. Used for Weapon Info UI.

---

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

• Game/UI/MagazineUIInfo.c