SCR_RestrictionZoneWarningHUDComponent Interface Reference

Inheritance diagram for SCR_RestrictionZoneWarningHUDComponent:

Public Member Functions
void	ShowZoneWarning (bool show, ERestrictionZoneWarningType warningType, vector zoneCenter, float warningRadiusSq, float zoneRadiusSq, float speed=UIConstants.FADE_RATE_DEFAULT)
	Show the restriction zone warning and set the correct UIInfo.
override void	OnStartDraw (IEntity owner)
void	~SCR_RestrictionZoneWarningHUDComponent ()
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	UpdateVisualWarning ()
Protected Member Functions inherited from SCR_InfoDisplay
void	OnShownFinished (Widget w, float targetOpacity, WidgetAnimationOpacity anim=null)
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
ref array< ref SCR_RestrictionZoneWarningInfo >	m_aWarningUIInfos
string	m_sIconWidgetName
string	m_sWarningWidgetName
string	m_sExplanationWidgetName
string	m_sWarningZoneDistanceVisualsName
string	m_sWarningVisualsHolderName
float	m_fWarningVisualsUpdateTime
float	m_fMinWarningDistanceVisualsOpacity
float	m_fMaxWarningDistanceVisualsOpacity
float	m_fWarningVisualsMinOpacity
Widget	m_WarningZoneDistanceVisuals
Widget	m_WarningVisualsHolder
ERestrictionZoneWarningType	m_iCurrentDisplayedWarning = -1
vector	m_vZoneCenter
float	m_fWarningRadiusSq
float	m_fZoneMinusWarningSq
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

Constructor & Destructor Documentation

~SCR_RestrictionZoneWarningHUDComponent()

void SCR_RestrictionZoneWarningHUDComponent.~SCR_RestrictionZoneWarningHUDComponent

(

)

Member Function Documentation

OnStartDraw()

override void SCR_RestrictionZoneWarningHUDComponent.OnStartDraw

(

IEntity

owner

)

Implements SCR_InfoDisplay.

ShowZoneWarning()

void SCR_RestrictionZoneWarningHUDComponent.ShowZoneWarning	(	bool	show,
		ERestrictionZoneWarningType	warningType,
		vector	zoneCenter,
		float	warningRadiusSq,
		float	zoneRadiusSq,
		float	speed = UIConstants::FADE_RATE_DEFAULT )

Show the restriction zone warning and set the correct UIInfo.

Parameters

show	If the warning should be shown or hidden
speed	fadeSpeed

UpdateVisualWarning()

void SCR_RestrictionZoneWarningHUDComponent.UpdateVisualWarning ( )

protected

Member Data Documentation

m_aWarningUIInfos

ref array<ref SCR_RestrictionZoneWarningInfo> SCR_RestrictionZoneWarningHUDComponent.m_aWarningUIInfos

protected

m_fMaxWarningDistanceVisualsOpacity

float SCR_RestrictionZoneWarningHUDComponent.m_fMaxWarningDistanceVisualsOpacity

protected

m_fMinWarningDistanceVisualsOpacity

float SCR_RestrictionZoneWarningHUDComponent.m_fMinWarningDistanceVisualsOpacity

protected

m_fWarningRadiusSq

float SCR_RestrictionZoneWarningHUDComponent.m_fWarningRadiusSq

protected

m_fWarningVisualsMinOpacity

float SCR_RestrictionZoneWarningHUDComponent.m_fWarningVisualsMinOpacity

protected

m_fWarningVisualsUpdateTime

float SCR_RestrictionZoneWarningHUDComponent.m_fWarningVisualsUpdateTime

protected

m_fZoneMinusWarningSq

float SCR_RestrictionZoneWarningHUDComponent.m_fZoneMinusWarningSq

protected

m_iCurrentDisplayedWarning

ERestrictionZoneWarningType SCR_RestrictionZoneWarningHUDComponent.m_iCurrentDisplayedWarning = -1

protected

m_sExplanationWidgetName

string SCR_RestrictionZoneWarningHUDComponent.m_sExplanationWidgetName

protected

m_sIconWidgetName

string SCR_RestrictionZoneWarningHUDComponent.m_sIconWidgetName

protected

m_sWarningVisualsHolderName

string SCR_RestrictionZoneWarningHUDComponent.m_sWarningVisualsHolderName

protected

m_sWarningWidgetName

string SCR_RestrictionZoneWarningHUDComponent.m_sWarningWidgetName

protected

m_sWarningZoneDistanceVisualsName

string SCR_RestrictionZoneWarningHUDComponent.m_sWarningZoneDistanceVisualsName

protected

m_vZoneCenter

vector SCR_RestrictionZoneWarningHUDComponent.m_vZoneCenter

protected

m_WarningVisualsHolder

Widget SCR_RestrictionZoneWarningHUDComponent.m_WarningVisualsHolder

protected

m_WarningZoneDistanceVisuals

Widget SCR_RestrictionZoneWarningHUDComponent.m_WarningZoneDistanceVisuals

protected

---

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

• Game/UI/HUD/SCR_RestrictionZoneWarningHUDComponent.c