SCR_CaptureAndHoldTeamScoreDisplayObject Class Reference

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

Protected Member Functions
Widget	FindScoreWidget (notnull Widget parent, string name)
	Finds a widget by name, either available variant (default, _Left, _Right).
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 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.

Definition at line 2 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

Constructor & Destructor Documentation

SCR_CaptureAndHoldTeamScoreDisplayObject()

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

inlineprotected

Creates new score object wrapper for provided faction.

Definition at line 40 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

Member Function Documentation

FindScoreWidget()

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

inlineprotected

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

Definition at line 21 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

GetFaction()

Faction SCR_CaptureAndHoldTeamScoreDisplayObject::GetFaction ( )

inlineprotected

Returns the Faction this object is affiliated with.

Definition at line 92 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

Update()

void SCR_CaptureAndHoldTeamScoreDisplayObject::Update ( int score, int maxScore )

inlineprotected

Updates state of this object.

Definition at line 80 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

Member Data Documentation

m_pAffiliatedFaction

Faction SCR_CaptureAndHoldTeamScoreDisplayObject::m_pAffiliatedFaction

protected

Faction this object represents.

Definition at line 17 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

m_wBarImage

ImageWidget SCR_CaptureAndHoldTeamScoreDisplayObject::m_wBarImage

protected

Reference to fillable bar widget.

Definition at line 11 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

m_wFactionImage

ImageWidget SCR_CaptureAndHoldTeamScoreDisplayObject::m_wFactionImage

protected

Reference to fillable bar widget.

Definition at line 8 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

m_wRoot

Widget SCR_CaptureAndHoldTeamScoreDisplayObject::m_wRoot

protected

Topmost frame of this object.

Definition at line 5 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

m_wScoreText

TextWidget SCR_CaptureAndHoldTeamScoreDisplayObject::m_wScoreText

protected

Reference to text widget that displays score.

Definition at line 14 of file SCR_CaptureAndHoldTeamScoreDisplayObject.c.

---

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

• scripts/Game/UI/CaptureAndHold/SCR_CaptureAndHoldTeamScoreDisplayObject.c