SCR_CaptureAndHoldObjectiveDisplay Class Reference

Inheritance diagram for SCR_CaptureAndHoldObjectiveDisplay:

Protected Member Functions
override bool	DisplayStartDrawInit (IEntity owner)
	Checks whether prerequisites for this InfoDisplay are met.
override void	DisplayStartDraw (IEntity owner)
	Creates HUD elements for individual areas.
override void	DisplayStopDraw (IEntity owner)
	Destroys HUD elements of individual areas.
override void	DisplayUpdate (IEntity owner, float timeSlice)
	Updates and manages individual HUD elements.
void	CreateObjectiveDisplays (array< SCR_CaptureAndHoldArea > areas)
	Creates and fills the objective collection using provided areas.
void	ClearObjectiveDisplays (bool emptyOnly)

Protected Attributes
ResourceName	m_rObjectiveHUDLayout
ref array< ref SCR_CaptureAndHoldObjectiveDisplayObject >	m_aObjectiveElements = {}
	Individual element wrappers.
SCR_CaptureAndHoldManager	m_AreaManager
	Area manager provides us with necessary API.
SCR_BaseGameMode	m_GameMode
	Game mode instance.

Detailed Description

This InfoDisplay allows drawing of individual HUD objective elements for individual Capture & Hold areas by projecting their position from world to screen.

Definition at line 3 of file SCR_CaptureAndHoldObjectiveDisplay.c.

Member Function Documentation

ClearObjectiveDisplays()

void SCR_CaptureAndHoldObjectiveDisplay::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 95 of file SCR_CaptureAndHoldObjectiveDisplay.c.

CreateObjectiveDisplays()

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

inlineprotected

Creates and fills the objective collection using provided areas.

Definition at line 77 of file SCR_CaptureAndHoldObjectiveDisplay.c.

DisplayStartDraw()

override void SCR_CaptureAndHoldObjectiveDisplay::DisplayStartDraw ( IEntity owner )

inlineprotected

Creates HUD elements for individual areas.

Definition at line 34 of file SCR_CaptureAndHoldObjectiveDisplay.c.

DisplayStartDrawInit()

override bool SCR_CaptureAndHoldObjectiveDisplay::DisplayStartDrawInit ( IEntity owner )

inlineprotected

Checks whether prerequisites for this InfoDisplay are met.

Definition at line 18 of file SCR_CaptureAndHoldObjectiveDisplay.c.

DisplayStopDraw()

override void SCR_CaptureAndHoldObjectiveDisplay::DisplayStopDraw ( IEntity owner )

inlineprotected

Destroys HUD elements of individual areas.

Definition at line 44 of file SCR_CaptureAndHoldObjectiveDisplay.c.

DisplayUpdate()

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

inlineprotected

Updates and manages individual HUD elements.

Definition at line 52 of file SCR_CaptureAndHoldObjectiveDisplay.c.

Member Data Documentation

m_aObjectiveElements

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

protected

Individual element wrappers.

Definition at line 9 of file SCR_CaptureAndHoldObjectiveDisplay.c.

m_AreaManager

SCR_CaptureAndHoldManager SCR_CaptureAndHoldObjectiveDisplay::m_AreaManager

protected

Area manager provides us with necessary API.

Definition at line 12 of file SCR_CaptureAndHoldObjectiveDisplay.c.

m_GameMode

SCR_BaseGameMode SCR_CaptureAndHoldObjectiveDisplay::m_GameMode

protected

Game mode instance.

Definition at line 14 of file SCR_CaptureAndHoldObjectiveDisplay.c.

m_rObjectiveHUDLayout

ResourceName SCR_CaptureAndHoldObjectiveDisplay::m_rObjectiveHUDLayout

protected

Definition at line 6 of file SCR_CaptureAndHoldObjectiveDisplay.c.

---

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

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