Inheritance diagram for SCR_InfoDisplay:

Public Member Functions
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)

Public Attributes
ResourceName	m_LayoutPath

EHudLayers	m_eLayer

int	m_iOverrideZOrder

Protected Member Functions
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)

Protected Attributes
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()

Member Function Documentation

◆ AdaptiveOpacity_Update()

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

protected

◆ GetAnchorPosition()

bool SCR_InfoDisplay.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.

Parameters

[out]	x
[out]	y
	anchor
	addSafezones

Returns: false if content widget is null, true otherwise

◆ GetContentWidget()

Widget SCR_InfoDisplay.GetContentWidget ( )

◆ GetContentWidgetName()

string SCR_InfoDisplay.GetContentWidgetName ( )

◆ GetDimensions()

bool SCR_InfoDisplay.GetDimensions	(	out float	width,
		out float	height,
		bool	addSafezones = true )

Get width and height of the InfoDisplay element, optionally with safezones adjustments.

Parameters

[out]	width
[out]	height
	addSafezones

Returns: false if content widget is null, true otherwise

◆ GetHandler()

SCR_InfoDisplayHandler SCR_InfoDisplay.GetHandler ( TypeName handlerType )

◆ GetOnStart()

SCR_InfoDisplayInvoker SCR_InfoDisplay.GetOnStart ( )

◆ GetOnStop()

SCR_InfoDisplayInvoker SCR_InfoDisplay.GetOnStop ( )

◆ GetOwnerEntity()

IEntity SCR_InfoDisplay.GetOwnerEntity ( )

◆ GetRootWidget()

Widget SCR_InfoDisplay.GetRootWidget ( )

◆ IsShown()

bool SCR_InfoDisplay.IsShown ( )

◆ OnInit()

override void SCR_InfoDisplay.OnInit ( IEntity owner )

protected

Implements BaseInfoDisplay.

◆ OnShownFinished()

void SCR_InfoDisplay.OnShownFinished	(	Widget	w,
		float	targetOpacity,
		WidgetAnimationOpacity	anim = null )

protected

Implemented in SCR_RadialMenuDisplay.

◆ OnStartDraw()

override void SCR_InfoDisplay.OnStartDraw ( IEntity owner )

protected

Implements BaseInfoDisplay.

Implemented in SCR_Crosshair, SCR_EditorPingInfoDisplay, SCR_RestrictionZoneWarningHUDComponent, SCR_WeaponSwitchingBaseUI, and StanceIndicator.

◆ OnStopDraw()

override void SCR_InfoDisplay.OnStopDraw ( IEntity owner )

protected

Implements BaseInfoDisplay.

Implemented in SCR_EditorPingInfoDisplay, and SCR_WeaponSwitchingBaseUI.

◆ RegisterToHudManager()

void SCR_InfoDisplay.RegisterToHudManager ( )

◆ SetContentWidget()

void SCR_InfoDisplay.SetContentWidget ( notnull Widget content )

◆ SetRootWidget()

void SCR_InfoDisplay.SetRootWidget ( notnull Widget root )

◆ Show()

void SCR_InfoDisplay.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.

Use this method instead of SetVisible/SetOpacity.

Parameters

show	true to show, false to hide
speed	fade rate, default 0
curve	hiding interpolation, default linear

Implemented in SCR_BallisticTableDisplay, SCR_BaseHeadingDisplay, SCR_InfoDisplayExtended, and SCR_WeaponSelectionMenu.

◆ UpdateValues()

override void SCR_InfoDisplay.UpdateValues	(	IEntity	owner,
		float	timeSlice )

protected

Implements BaseInfoDisplay.

Implemented in SCR_Crosshair, SCR_EditorPingInfoDisplay, SCR_WeaponSwitchingBaseUI, and StanceIndicator.

Member Data Documentation

◆ m_aChildDisplays

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

protected

◆ m_aHandlers

ref array<ref SCR_InfoDisplayHandler> SCR_InfoDisplay.m_aHandlers

protected

◆ m_aUpdatableHandlers

ref array<ref SCR_InfoDisplayHandler> SCR_InfoDisplay.m_aUpdatableHandlers = {}

protected

◆ m_bRegistered

bool SCR_InfoDisplay.m_bRegistered = false

protected

◆ m_bShown

bool SCR_InfoDisplay.m_bShown

protected

◆ m_eLayer

EHudLayers SCR_InfoDisplay.m_eLayer

◆ m_HUDManager

SCR_HUDManagerComponent SCR_InfoDisplay.m_HUDManager

protected

◆ m_iChildDisplays

int SCR_InfoDisplay.m_iChildDisplays = 0

protected

◆ m_iContentHeightAdjustment

int SCR_InfoDisplay.m_iContentHeightAdjustment

protected

◆ m_iContentWidthAdjustment

int SCR_InfoDisplay.m_iContentWidthAdjustment

protected

◆ m_iOverrideZOrder

int SCR_InfoDisplay.m_iOverrideZOrder

◆ m_LayoutPath

ResourceName SCR_InfoDisplay.m_LayoutPath

◆ m_OnStart

ref SCR_InfoDisplayInvoker SCR_InfoDisplay.m_OnStart = new SCR_InfoDisplayInvoker()

protected

◆ m_OnStop

ref SCR_InfoDisplayInvoker SCR_InfoDisplay.m_OnStop = new SCR_InfoDisplayInvoker()

protected

◆ m_OwnerEntity

IEntity SCR_InfoDisplay.m_OwnerEntity

protected

◆ m_pParentDisplay

SCR_InfoDisplay SCR_InfoDisplay.m_pParentDisplay

protected

◆ m_sAdaptiveOpacityWidgetName

string SCR_InfoDisplay.m_sAdaptiveOpacityWidgetName

protected

◆ m_sContentWidget

string SCR_InfoDisplay.m_sContentWidget

protected

◆ m_sParentSlot

string SCR_InfoDisplay.m_sParentSlot

protected

◆ m_wContent

Widget SCR_InfoDisplay.m_wContent

protected

◆ m_wRoot

Widget SCR_InfoDisplay.m_wRoot

protected

◆ m_wSlot

Widget SCR_InfoDisplay.m_wSlot

protected

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

Game/UI/HUD/SCR_InfoDisplay.c

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ AdaptiveOpacity_Update()

◆ GetAnchorPosition()

◆ GetContentWidget()

◆ GetContentWidgetName()

◆ GetDimensions()

◆ GetHandler()

◆ GetOnStart()

◆ GetOnStop()

◆ GetOwnerEntity()

◆ GetRootWidget()

◆ IsShown()

◆ OnInit()

◆ OnShownFinished()

◆ OnStartDraw()

◆ OnStopDraw()

◆ RegisterToHudManager()

◆ SetContentWidget()

◆ SetRootWidget()

◆ Show()

◆ UpdateValues()

Member Data Documentation

◆ m_aChildDisplays

◆ m_aHandlers

◆ m_aUpdatableHandlers

◆ m_bRegistered

◆ m_bShown

◆ m_eLayer

◆ m_HUDManager

◆ m_iChildDisplays

◆ m_iContentHeightAdjustment

◆ m_iContentWidthAdjustment

◆ m_iOverrideZOrder

◆ m_LayoutPath

◆ m_OnStart

◆ m_OnStop

◆ m_OwnerEntity

◆ m_pParentDisplay

◆ m_sAdaptiveOpacityWidgetName

◆ m_sContentWidget

◆ m_sParentSlot

◆ m_wContent

◆ m_wRoot

◆ m_wSlot