SCR_CaptureAndHoldTeamScoreDisplay Class Reference

Inheritance diagram for SCR_CaptureAndHoldTeamScoreDisplay:

Protected Member Functions
override bool	DisplayStartDrawInit (IEntity owner)
	Checks the prerequisites for this InfoDisplay.
void	SortAreas (array< SCR_CaptureAndHoldArea > areas)
void	ClearObjectiveDisplays (bool emptyOnly)
void	CreateObjectiveDisplays (array< SCR_CaptureAndHoldArea > areas)
	Creates and fills the objective collection using provided areas.
override void	DisplayStartDraw (IEntity owner)
	Creates individual hud elements.
override void	DisplayStopDraw (IEntity owner)
	Clears all hud elements.
override void	DisplayUpdate (IEntity owner, float timeSlice)
	Updates the progress and state of all available elements.

Protected Attributes
ResourceName	m_rObjectiveHUDLayout
HorizontalLayoutWidget	m_wAreaLayoutWidget
	Parent frame that holds all area markers.
ref array< ref SCR_CaptureAndHoldObjectiveDisplayObject >	m_aObjectiveElements = {}
	Array of all wrappers for the individual objective areas.
ref array< ref SCR_CaptureAndHoldTeamScoreDisplayObject >	m_aScoringElements = {}
	Array of all wrappers for the individual teams.
Widget	m_wScoringFrame
	Parent frame that holds all scoring widgets.
TextWidget	m_wRemainingTimeWidget
	Used to display remaining time (if any).
SCR_CaptureAndHoldManager	m_pAreaManager
	Area manager provides us with necessary API.
SCR_BaseGameMode	m_pGameMode
	Game mode instance.
const float	POINTS_LAYOUT_FADE_SPEED = 5.0
	Speed used to fade areas hud when hints are shown.

Detailed Description

This InfoDisplay allows drawing of individual HUD scoring elements for individual Capture & Hold factions. In addition it draws all available objectives in the screen space.

Note: This HUD element only supports two factions at a single given time. In addition only the US, USSR and FIA factions are supported. Using more than two factions will yield unexpected results.

Similar approach can be taken, but a list of elements or any other dynamically filled element would be a much more preferable choice.

Definition at line 14 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

Member Function Documentation

ClearObjectiveDisplays()

void SCR_CaptureAndHoldTeamScoreDisplay::ClearObjectiveDisplays ( bool emptyOnly )

inlineprotected

Removes objective displays from the collection.

Parameters

emptyOnly

If true, empty (not linking to area) objects are removed. If false, all objects are flushed immediately.

Definition at line 91 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

CreateObjectiveDisplays()

void SCR_CaptureAndHoldTeamScoreDisplay::CreateObjectiveDisplays ( array< SCR_CaptureAndHoldArea > areas )

inlineprotected

Creates and fills the objective collection using provided areas.

Definition at line 112 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

DisplayStartDraw()

override void SCR_CaptureAndHoldTeamScoreDisplay::DisplayStartDraw ( IEntity owner )

inlineprotected

Creates individual hud elements.

Definition at line 142 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

DisplayStartDrawInit()

override bool SCR_CaptureAndHoldTeamScoreDisplay::DisplayStartDrawInit ( IEntity owner )

inlineprotected

Checks the prerequisites for this InfoDisplay.

Definition at line 44 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

DisplayStopDraw()

override void SCR_CaptureAndHoldTeamScoreDisplay::DisplayStopDraw ( IEntity owner )

inlineprotected

Clears all hud elements.

Definition at line 198 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

DisplayUpdate()

override void SCR_CaptureAndHoldTeamScoreDisplay::DisplayUpdate ( IEntity owner, float timeSlice )

inlineprotected

Updates the progress and state of all available elements.

Definition at line 214 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

SortAreas()

void SCR_CaptureAndHoldTeamScoreDisplay::SortAreas ( array< SCR_CaptureAndHoldArea > areas )

inlineprotected

Sorts input array of areas by their name. Names must be unique!

Definition at line 64 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

Member Data Documentation

m_aObjectiveElements

ref array<ref SCR_CaptureAndHoldObjectiveDisplayObject> SCR_CaptureAndHoldTeamScoreDisplay::m_aObjectiveElements = {}

protected

Array of all wrappers for the individual objective areas.

Definition at line 23 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

m_aScoringElements

ref array<ref SCR_CaptureAndHoldTeamScoreDisplayObject> SCR_CaptureAndHoldTeamScoreDisplay::m_aScoringElements = {}

protected

Array of all wrappers for the individual teams.

Definition at line 26 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

m_pAreaManager

SCR_CaptureAndHoldManager SCR_CaptureAndHoldTeamScoreDisplay::m_pAreaManager

protected

Area manager provides us with necessary API.

Definition at line 35 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

m_pGameMode

SCR_BaseGameMode SCR_CaptureAndHoldTeamScoreDisplay::m_pGameMode

protected

Game mode instance.

Definition at line 37 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

m_rObjectiveHUDLayout

ResourceName SCR_CaptureAndHoldTeamScoreDisplay::m_rObjectiveHUDLayout

protected

Definition at line 17 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

m_wAreaLayoutWidget

HorizontalLayoutWidget SCR_CaptureAndHoldTeamScoreDisplay::m_wAreaLayoutWidget

protected

Parent frame that holds all area markers.

Definition at line 20 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

m_wRemainingTimeWidget

TextWidget SCR_CaptureAndHoldTeamScoreDisplay::m_wRemainingTimeWidget

protected

Used to display remaining time (if any).

Definition at line 32 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

m_wScoringFrame

Widget SCR_CaptureAndHoldTeamScoreDisplay::m_wScoringFrame

protected

Parent frame that holds all scoring widgets.

Definition at line 29 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

POINTS_LAYOUT_FADE_SPEED

const float SCR_CaptureAndHoldTeamScoreDisplay::POINTS_LAYOUT_FADE_SPEED = 5.0

protected

Speed used to fade areas hud when hints are shown.

Definition at line 40 of file SCR_CaptureAndHoldTeamScoreDisplay.c.

---

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

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