Inheritance diagram for SCR_HUDManagerComponent:

Public Member Functions
int	GetInfoDisplayCount ()

IEntity	GetOwner ()

SCR_HUDManagerHandler	FindHandler (TypeName handlerType)

void	RemoveHandlerFromUpdatableHandlers (notnull SCR_HUDManagerHandler handler)

Widget	GetHUDRootWidget ()

float	GetAdaptiveOpacity ()

float	GetSceneBrightness ()

string	GetInterfaceSettingsClass ()

ScriptInvokerBase< OnScreenBrightnessChanged >	GetSceneBrightnessChangedInvoker ()

SCR_InfoDisplay	FindInfoDisplay (TypeName type)
	Return hud component of given type.

SCR_InfoDisplay	FindInfoDisplayByResourceName (ResourceName path)
	Find layout by resorce name.

Widget	FindLayoutByResourceName (ResourceName path)
	Find layout by resorce name.

Widget	CreateLayout (ResourceName path, EHudLayers layer, int zOrder=0)

SCR_HUDElement	CreateFreeElement (ResourceName path, string parentName)

void	SetVisible (bool isVisible)
	Set visibility of HUD.

bool	IsVisible ()
	Check if HUD is visible.

void	SetVisibleLayers (EHudLayers layers=-1)
	Set which HUD layers should be visible.

EHudLayers	GetVisibleLayers ()
	Get which HUD layers are visible.

override array< ref WB_UIMenuItem >	_WB_GetContextMenuItems (IEntity owner)

override void	_WB_OnContextMenu (IEntity owner, int id)

Public Member Functions inherited from HUDManagerComponent
proto external bool	IsHUDEnabled ()

proto external bool	EnableHUD (bool state)

proto external bool	StartDrawing (BaseInfoDisplay display)

proto external void	StopDrawing (BaseInfoDisplay display)

proto external int	GetInfoDisplaysDrawn (out notnull array< BaseInfoDisplay > outInfoDisplays, bool getAllShown=false)

Public Member Functions inherited from SCR_BaseHUDComponent
void	RegisterHUDElement (SCR_InfoDisplay element)

void	UnregisterHUDElement (SCR_InfoDisplay element)

array< SCR_InfoDisplay >	GetHUDElements ()

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

proto external void	RegisterInfoDisplay (BaseInfoDisplay infoDisplay)

proto external void	UnregisterInfoDisplay (BaseInfoDisplay infoDisplay)

Public Member Functions inherited from GameComponent
bool	OnTicksOnRemoteProxy ()

Static Public Member Functions
static SCR_HUDManagerComponent	GetHUDManager ()

Public Attributes
string	m_sDefaultBackgroundLayer

string	m_sDefaultForegroundLayer

Static Public Attributes
const float	UPDATE_DELAY = 500

const float	ADAPTIVE_OPACITY_BRIGHTNESS_THROTTLE = 0.001

const float	ADAPTIVE_OPACITY_THROTTLE = 0.01

const int	CONTEXT_GENERATE_AVAILABLE_INPUT_ACTION = 0

Protected Member Functions
override void	OnInit (IEntity owner)
	Called during EOnInit.

override void	OnUpdate (IEntity owner)

void	~SCR_HUDManagerComponent ()

void	CreateHUDLayers ()

void	InitRootWidget (Widget root, string name)

Protected Member Functions inherited from HUDManagerComponent
void	OnControlledEntityChanged (IEntity from, IEntity to)

Protected Attributes
ref array< ref SCR_HUDManagerHandler >	m_aHandlers

ref array< SCR_HUDManagerHandler >	m_aUpdatableHandlers = {}

string	m_sInterfaceSettingsClassName

BaseWorld	m_World

ref ScriptInvokerBase< OnScreenBrightnessChanged >	m_OnSceneBrightnessChanged = new ScriptInvokerBase<OnScreenBrightnessChanged>()

float	m_fUpdateTime = -1

float	m_fSceneBrightness = -1

float	m_fOpacity = -1

IEntity	m_Owner

ref array< SCR_HUDManagerHandler >	m_aHandlersToRemoveFromUpdate = {}

Protected Attributes inherited from SCR_BaseHUDComponent
ref array< SCR_InfoDisplay >	m_aHUDElements = new array<SCR_InfoDisplay>

Constructor & Destructor Documentation

◆ ~SCR_HUDManagerComponent()

void SCR_HUDManagerComponent.~SCR_HUDManagerComponent ( )

protected

Member Function Documentation

◆ _WB_GetContextMenuItems()

override array< ref WB_UIMenuItem > SCR_HUDManagerComponent._WB_GetContextMenuItems ( IEntity owner )

◆ _WB_OnContextMenu()

override void SCR_HUDManagerComponent._WB_OnContextMenu	(	IEntity	owner,
		int	id )

◆ CreateFreeElement()

SCR_HUDElement SCR_HUDManagerComponent.CreateFreeElement	(	ResourceName	path,
		string	parentName )

◆ CreateHUDLayers()

void SCR_HUDManagerComponent.CreateHUDLayers ( )

protected

◆ CreateLayout()

Widget SCR_HUDManagerComponent.CreateLayout	(	ResourceName	path,
		EHudLayers	layer,
		int	zOrder = 0 )

◆ FindHandler()

SCR_HUDManagerHandler SCR_HUDManagerComponent.FindHandler ( TypeName handlerType )

◆ FindInfoDisplay()

SCR_InfoDisplay SCR_HUDManagerComponent.FindInfoDisplay ( TypeName type )

Return hud component of given type.

◆ FindInfoDisplayByResourceName()

SCR_InfoDisplay SCR_HUDManagerComponent.FindInfoDisplayByResourceName ( ResourceName path )

Find layout by resorce name.

◆ FindLayoutByResourceName()

Widget SCR_HUDManagerComponent.FindLayoutByResourceName ( ResourceName path )

Find layout by resorce name.

◆ GetAdaptiveOpacity()

float SCR_HUDManagerComponent.GetAdaptiveOpacity ( )

◆ GetHUDManager()

static SCR_HUDManagerComponent SCR_HUDManagerComponent.GetHUDManager ( )

static

◆ GetHUDRootWidget()

Widget SCR_HUDManagerComponent.GetHUDRootWidget ( )

◆ GetInfoDisplayCount()

int SCR_HUDManagerComponent.GetInfoDisplayCount ( )

◆ GetInterfaceSettingsClass()

string SCR_HUDManagerComponent.GetInterfaceSettingsClass ( )

◆ GetOwner()

IEntity SCR_HUDManagerComponent.GetOwner ( )

◆ GetSceneBrightness()

float SCR_HUDManagerComponent.GetSceneBrightness ( )

◆ GetSceneBrightnessChangedInvoker()

ScriptInvokerBase< OnScreenBrightnessChanged > SCR_HUDManagerComponent.GetSceneBrightnessChangedInvoker ( )

◆ GetVisibleLayers()

EHudLayers SCR_HUDManagerComponent.GetVisibleLayers ( )

Get which HUD layers are visible.

Returns visibility status of individual layer; it can still not be shown if the whole HUD is hidden (IsVisible()).

Parameters

layers Enum flag containing all visible layers

◆ InitRootWidget()

void SCR_HUDManagerComponent.InitRootWidget	(	Widget	root,
		string	name )

protected

◆ IsVisible()

bool SCR_HUDManagerComponent.IsVisible ( )

Check if HUD is visible.

Returns: True if visible

◆ OnInit()

override void SCR_HUDManagerComponent.OnInit ( IEntity owner )

protected

Called during EOnInit.

Parameters

owner Entity this component is attached to.

Implements HUDManagerComponent.

◆ OnUpdate()

override void SCR_HUDManagerComponent.OnUpdate ( IEntity owner )

protected

Implements HUDManagerComponent.

◆ RemoveHandlerFromUpdatableHandlers()

void SCR_HUDManagerComponent.RemoveHandlerFromUpdatableHandlers ( notnull SCR_HUDManagerHandler handler )

◆ SetVisible()

void SCR_HUDManagerComponent.SetVisible ( bool isVisible )

Set visibility of HUD.

Parameters

isVisible True if visible

◆ SetVisibleLayers()

void SCR_HUDManagerComponent.SetVisibleLayers ( EHudLayers layers = -1 )

Set which HUD layers should be visible.

Parameters

layers Enum flag containing all layers to be shown. Use -1 to show all layers

Member Data Documentation

◆ ADAPTIVE_OPACITY_BRIGHTNESS_THROTTLE

const float SCR_HUDManagerComponent.ADAPTIVE_OPACITY_BRIGHTNESS_THROTTLE = 0.001

static

◆ ADAPTIVE_OPACITY_THROTTLE

const float SCR_HUDManagerComponent.ADAPTIVE_OPACITY_THROTTLE = 0.01

static

◆ CONTEXT_GENERATE_AVAILABLE_INPUT_ACTION

const int SCR_HUDManagerComponent.CONTEXT_GENERATE_AVAILABLE_INPUT_ACTION = 0

static

◆ m_aHandlers

ref array<ref SCR_HUDManagerHandler> SCR_HUDManagerComponent.m_aHandlers

protected

◆ m_aHandlersToRemoveFromUpdate

ref array<SCR_HUDManagerHandler> SCR_HUDManagerComponent.m_aHandlersToRemoveFromUpdate = {}

protected

◆ m_aUpdatableHandlers

ref array<SCR_HUDManagerHandler> SCR_HUDManagerComponent.m_aUpdatableHandlers = {}

protected

◆ m_fOpacity

float SCR_HUDManagerComponent.m_fOpacity = -1

protected

◆ m_fSceneBrightness

float SCR_HUDManagerComponent.m_fSceneBrightness = -1

protected

◆ m_fUpdateTime

float SCR_HUDManagerComponent.m_fUpdateTime = -1

protected

◆ m_OnSceneBrightnessChanged

ref ScriptInvokerBase<OnScreenBrightnessChanged> SCR_HUDManagerComponent.m_OnSceneBrightnessChanged = new ScriptInvokerBase<OnScreenBrightnessChanged>()

protected

◆ m_Owner

IEntity SCR_HUDManagerComponent.m_Owner

protected

◆ m_sDefaultBackgroundLayer

string SCR_HUDManagerComponent.m_sDefaultBackgroundLayer

◆ m_sDefaultForegroundLayer

string SCR_HUDManagerComponent.m_sDefaultForegroundLayer

◆ m_sInterfaceSettingsClassName

string SCR_HUDManagerComponent.m_sInterfaceSettingsClassName

protected

◆ m_World

BaseWorld SCR_HUDManagerComponent.m_World

protected

◆ UPDATE_DELAY

const float SCR_HUDManagerComponent.UPDATE_DELAY = 500

static

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

Game/UI/HUD/SCR_HUDManagerComponent.c

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

◆ ~SCR_HUDManagerComponent()

Member Function Documentation

◆ _WB_GetContextMenuItems()

◆ _WB_OnContextMenu()

◆ CreateFreeElement()

◆ CreateHUDLayers()

◆ CreateLayout()

◆ FindHandler()

◆ FindInfoDisplay()

◆ FindInfoDisplayByResourceName()

◆ FindLayoutByResourceName()

◆ GetAdaptiveOpacity()

◆ GetHUDManager()

◆ GetHUDRootWidget()

◆ GetInfoDisplayCount()

◆ GetInterfaceSettingsClass()

◆ GetOwner()

◆ GetSceneBrightness()

◆ GetSceneBrightnessChangedInvoker()

◆ GetVisibleLayers()

◆ InitRootWidget()

◆ IsVisible()

◆ OnInit()

◆ OnUpdate()

◆ RemoveHandlerFromUpdatableHandlers()

◆ SetVisible()

◆ SetVisibleLayers()

Member Data Documentation

◆ ADAPTIVE_OPACITY_BRIGHTNESS_THROTTLE

◆ ADAPTIVE_OPACITY_THROTTLE

◆ CONTEXT_GENERATE_AVAILABLE_INPUT_ACTION

◆ m_aHandlers

◆ m_aHandlersToRemoveFromUpdate

◆ m_aUpdatableHandlers

◆ m_fOpacity

◆ m_fSceneBrightness

◆ m_fUpdateTime

◆ m_OnSceneBrightnessChanged

◆ m_Owner

◆ m_sDefaultBackgroundLayer

◆ m_sDefaultForegroundLayer

◆ m_sInterfaceSettingsClassName

◆ m_World

◆ UPDATE_DELAY