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

Inheritance diagram for SCR_CaptureAndHoldObjectiveDisplay:

[legend]

Public 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.

Public Member Functions inherited from SCR_InfoDisplayExtended
void	SetEnabled (bool isEnabled)

override void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.

Public Member Functions inherited from SCR_InfoDisplay
SCR_InfoDisplayHandler	GetHandler (TypeName handlerType)

SCR_InfoDisplayInvoker	GetOnStart ()

SCR_InfoDisplayInvoker	GetOnStop ()

IEntity	GetOwnerEntity ()

Widget	GetContentWidget ()

string	GetContentWidgetName ()

void	SetRootWidget (notnull Widget root)

void	SetContentWidget (notnull Widget content)

void	Show (bool show, float speed=UIConstants.FADE_RATE_INSTANT, EAnimationCurve curve=EAnimationCurve.LINEAR)
	Show/hide InfoDisplay properly, not breaking other systems like AdaptiveOpacity or ConditionalVisibility.

bool	IsShown ()

Widget	GetRootWidget ()

bool	GetDimensions (out float width, out float height, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.

bool	GetAnchorPosition (out float x, out float y, EWidgetAnchor anchor=EWidgetAnchor.TOPLEFT, bool addSafezones=true)
	Get width and height of the InfoDisplay element, optionally with safezones adjustments.

void	RegisterToHudManager ()

Public Member Functions inherited from GroupInfoDisplay
proto external int	GetInfoDisplays (out notnull array< BaseInfoDisplay > outInfoDisplays)

Public Member Functions inherited from BaseInfoDisplay
proto external GenericComponent	FindComponentInParentContainer (TypeName typeName)

Protected Member Functions
void	CreateObjectiveDisplays (array< SCR_CaptureAndHoldArea > areas)
	Creates and fills the objective collection using provided areas.

void	ClearObjectiveDisplays (bool emptyOnly)
	Removes objective displays from the collection.

Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)

void	DisplayStartDraw (IEntity owner)

void	DisplayStopDraw (IEntity owner)

void	DisplayInit (IEntity owner)

void	DisplayUpdate (IEntity owner, float timeSlice)

void	DisplayControlledEntityChanged (IEntity from, IEntity to)

void	DisplayConsciousnessChanged (bool conscious, bool init=false)

void	DisplayOnSuspended ()
	Called when GUI is temporarily suspended due to visibility flags; e.g. GM entered and GUI marked as not to show in GM.

void	DisplayOnResumed ()

void	InitializeInterfaceSettings ()

void	OnSettingsChanged ()

Protected Member Functions inherited from SCR_InfoDisplay
void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)

override void	OnStartDraw (IEntity owner)

void	AdaptiveOpacity_Update (float opacity, float sceneBrightness, bool init=false)

override void	OnStopDraw (IEntity owner)

override void	UpdateValues (IEntity owner, float timeSlice)

override void	OnInit (IEntity owner)

void	OnInit (IEntity owner)

void	UpdateValues (IEntity owner, float timeSlice)

void	OnStartDraw (IEntity owner)

void	OnStopDraw (IEntity owner)

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.

Protected Attributes inherited from SCR_InfoDisplayExtended
bool	m_bIsEnabled

string	m_sInterfaceSettingName

SCR_PlayerController	m_PlayerController

SCR_CharacterControllerComponent	m_CharacterController

SCR_CharacterCameraHandlerComponent	m_CameraHandler

MenuManager	m_MenuManager

EventHandlerManagerComponent	m_EventHandlerManager

SCR_EditorManagerEntity	m_EditorManager

bool	m_bAttachedToPlayerController

bool	m_bInThirdPerson

bool	m_bInADS

bool	m_bIsUnconscious

bool	m_bInPauseMenu

bool	m_bInEditor

bool	m_bCanShow

bool	m_bIsEnabledInSettings = true

bool	m_bShowInAllCameras = true

Protected Attributes inherited from SCR_InfoDisplay
string	m_sParentSlot

string	m_sContentWidget

int	m_iContentWidthAdjustment

int	m_iContentHeightAdjustment

string	m_sAdaptiveOpacityWidgetName

ref array< ref SCR_InfoDisplayHandler >	m_aHandlers

bool	m_bShown

Widget	m_wRoot

Widget	m_wContent

Widget	m_wSlot

SCR_HUDManagerComponent	m_HUDManager

int	m_iChildDisplays = 0

ref array< BaseInfoDisplay >	m_aChildDisplays = new array<BaseInfoDisplay>

SCR_InfoDisplay	m_pParentDisplay

bool	m_bRegistered = false

IEntity	m_OwnerEntity

ref array< ref SCR_InfoDisplayHandler >	m_aUpdatableHandlers = {}

ref SCR_InfoDisplayInvoker	m_OnStart = new SCR_InfoDisplayInvoker()

ref SCR_InfoDisplayInvoker	m_OnStop = new SCR_InfoDisplayInvoker()

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath

EHudLayers	m_eLayer

int	m_iOverrideZOrder

Detailed Description

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

Member Function Documentation

◆ ClearObjectiveDisplays()

void SCR_CaptureAndHoldObjectiveDisplay.ClearObjectiveDisplays ( bool emptyOnly )

protected

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.

◆ CreateObjectiveDisplays()

void SCR_CaptureAndHoldObjectiveDisplay.CreateObjectiveDisplays ( array< SCR_CaptureAndHoldArea > areas )

protected

Creates and fills the objective collection using provided areas.

◆ DisplayStartDraw()

override void SCR_CaptureAndHoldObjectiveDisplay.DisplayStartDraw ( IEntity owner )

Creates HUD elements for individual areas.

Implements SCR_InfoDisplayExtended.

◆ DisplayStartDrawInit()

override bool SCR_CaptureAndHoldObjectiveDisplay.DisplayStartDrawInit ( IEntity owner )

Checks whether prerequisites for this InfoDisplay are met.

Implements SCR_InfoDisplayExtended.

◆ DisplayStopDraw()

override void SCR_CaptureAndHoldObjectiveDisplay.DisplayStopDraw ( IEntity owner )

Destroys HUD elements of individual areas.

Implements SCR_InfoDisplayExtended.

◆ DisplayUpdate()

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

Updates and manages individual HUD elements.

Implements SCR_InfoDisplayExtended.

Member Data Documentation

◆ m_aObjectiveElements

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

protected

Individual element wrappers.

◆ m_AreaManager

SCR_CaptureAndHoldManager SCR_CaptureAndHoldObjectiveDisplay.m_AreaManager

protected

Area manager provides us with necessary API.

◆ m_GameMode

SCR_BaseGameMode SCR_CaptureAndHoldObjectiveDisplay.m_GameMode

protected

Game mode instance.

◆ m_rObjectiveHUDLayout

ResourceName SCR_CaptureAndHoldObjectiveDisplay.m_rObjectiveHUDLayout

protected

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

Game/UI/CaptureAndHold/SCR_CaptureAndHoldObjectiveDisplay.c

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ClearObjectiveDisplays()

◆ CreateObjectiveDisplays()

◆ DisplayStartDraw()

◆ DisplayStartDrawInit()

◆ DisplayStopDraw()

◆ DisplayUpdate()

Member Data Documentation

◆ m_aObjectiveElements

◆ m_AreaManager

◆ m_GameMode

◆ m_rObjectiveHUDLayout