SCR_CaptureAndHoldTeamScoreDisplayObject Interface Reference

This object serves as a wrapper for individual HUD team score widgets. More...

Public Member Functions
void	SCR_CaptureAndHoldTeamScoreDisplayObject (notnull Widget root, notnull Faction faction)
	Creates new score object wrapper for provided faction.
void	Update (int score, int maxScore)
	Updates state of this object.
Faction	GetFaction ()
	Returns the Faction this object is affiliated with.

Protected Member Functions
Widget	FindScoreWidget (notnull Widget parent, string name)
	Finds a widget by name, either available variant (default, _Left, _Right)

Protected Attributes
Widget	m_wRoot
	Topmost frame of this object.
ImageWidget	m_wFactionImage
	Reference to fillable bar widget.
ImageWidget	m_wBarImage
	Reference to fillable bar widget.
TextWidget	m_wScoreText
	Reference to text widget that displays score.
Faction	m_pAffiliatedFaction
	Faction this object represents.

Detailed Description

This object serves as a wrapper for individual HUD team score widgets.

Constructor & Destructor Documentation

SCR_CaptureAndHoldTeamScoreDisplayObject()

void SCR_CaptureAndHoldTeamScoreDisplayObject.SCR_CaptureAndHoldTeamScoreDisplayObject	(	notnull Widget	root,
		notnull Faction	faction
	)

Creates new score object wrapper for provided faction.

Member Function Documentation

FindScoreWidget()

Widget SCR_CaptureAndHoldTeamScoreDisplayObject.FindScoreWidget ( notnull Widget  parent, string  name  )

protected

Finds a widget by name, either available variant (default, _Left, _Right)

GetFaction()

Faction SCR_CaptureAndHoldTeamScoreDisplayObject.GetFaction

(

)

Returns the Faction this object is affiliated with.

Update()

void SCR_CaptureAndHoldTeamScoreDisplayObject.Update	(	int	score,
		int	maxScore
	)

Updates state of this object.

Member Data Documentation

m_pAffiliatedFaction

Faction SCR_CaptureAndHoldTeamScoreDisplayObject.m_pAffiliatedFaction

protected

Faction this object represents.

m_wBarImage

ImageWidget SCR_CaptureAndHoldTeamScoreDisplayObject.m_wBarImage

protected

Reference to fillable bar widget.

m_wFactionImage

ImageWidget SCR_CaptureAndHoldTeamScoreDisplayObject.m_wFactionImage

protected

Reference to fillable bar widget.

m_wRoot

Widget SCR_CaptureAndHoldTeamScoreDisplayObject.m_wRoot

protected

Topmost frame of this object.

m_wScoreText

TextWidget SCR_CaptureAndHoldTeamScoreDisplayObject.m_wScoreText

protected

Reference to text widget that displays score.

---

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

• Game/UI/CaptureAndHold/SCR_CaptureAndHoldTeamScoreDisplayObject.c