SCR_RestrictionZoneWarningHUDComponent Class Reference

Inheritance diagram for SCR_RestrictionZoneWarningHUDComponent:

Protected Member Functions
void	ShowZoneWarning (bool show, ERestrictionZoneWarningType warningType, vector zoneCenter, float warningRadiusSq, float zoneRadiusSq, float speed=UIConstants.FADE_RATE_DEFAULT)
void	UpdateVisualWarning ()
override event void	OnStartDraw (IEntity owner)
void	~SCR_RestrictionZoneWarningHUDComponent ()

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

Detailed Description

Definition at line 1 of file SCR_RestrictionZoneWarningHUDComponent.c.

Constructor & Destructor Documentation

~SCR_RestrictionZoneWarningHUDComponent()

void SCR_RestrictionZoneWarningHUDComponent::~SCR_RestrictionZoneWarningHUDComponent ( )

inlineprotected

Definition at line 161 of file SCR_RestrictionZoneWarningHUDComponent.c.

Member Function Documentation

OnStartDraw()

override event void SCR_RestrictionZoneWarningHUDComponent::OnStartDraw ( IEntity owner )

inlineprotected

Definition at line 130 of file SCR_RestrictionZoneWarningHUDComponent.c.

ShowZoneWarning()

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

inlineprotected

Show the restriction zone warning and set the correct UIInfo

Parameters

show	If the warning should be shown or hidden
speed	fadeSpeed

Definition at line 48 of file SCR_RestrictionZoneWarningHUDComponent.c.

UpdateVisualWarning()

void SCR_RestrictionZoneWarningHUDComponent::UpdateVisualWarning ( )

inlineprotected

Definition at line 89 of file SCR_RestrictionZoneWarningHUDComponent.c.

Member Data Documentation

m_aWarningUIInfos

ref array<ref SCR_RestrictionZoneWarningInfo> SCR_RestrictionZoneWarningHUDComponent::m_aWarningUIInfos

protected

Definition at line 4 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_fMaxWarningDistanceVisualsOpacity

float SCR_RestrictionZoneWarningHUDComponent::m_fMaxWarningDistanceVisualsOpacity

protected

Definition at line 28 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_fMinWarningDistanceVisualsOpacity

float SCR_RestrictionZoneWarningHUDComponent::m_fMinWarningDistanceVisualsOpacity

protected

Definition at line 25 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_fWarningRadiusSq

float SCR_RestrictionZoneWarningHUDComponent::m_fWarningRadiusSq

protected

Definition at line 39 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_fWarningVisualsMinOpacity

float SCR_RestrictionZoneWarningHUDComponent::m_fWarningVisualsMinOpacity

protected

Definition at line 31 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_fWarningVisualsUpdateTime

float SCR_RestrictionZoneWarningHUDComponent::m_fWarningVisualsUpdateTime

protected

Definition at line 22 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_fZoneMinusWarningSq

float SCR_RestrictionZoneWarningHUDComponent::m_fZoneMinusWarningSq

protected

Definition at line 40 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_iCurrentDisplayedWarning

ERestrictionZoneWarningType SCR_RestrictionZoneWarningHUDComponent::m_iCurrentDisplayedWarning = -1

protected

Definition at line 36 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_sExplanationWidgetName

string SCR_RestrictionZoneWarningHUDComponent::m_sExplanationWidgetName

protected

Definition at line 13 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_sIconWidgetName

string SCR_RestrictionZoneWarningHUDComponent::m_sIconWidgetName

protected

Definition at line 7 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_sWarningVisualsHolderName

string SCR_RestrictionZoneWarningHUDComponent::m_sWarningVisualsHolderName

protected

Definition at line 19 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_sWarningWidgetName

string SCR_RestrictionZoneWarningHUDComponent::m_sWarningWidgetName

protected

Definition at line 10 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_sWarningZoneDistanceVisualsName

string SCR_RestrictionZoneWarningHUDComponent::m_sWarningZoneDistanceVisualsName

protected

Definition at line 16 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_vZoneCenter

vector SCR_RestrictionZoneWarningHUDComponent::m_vZoneCenter

protected

Definition at line 38 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_WarningVisualsHolder

Widget SCR_RestrictionZoneWarningHUDComponent::m_WarningVisualsHolder

protected

Definition at line 34 of file SCR_RestrictionZoneWarningHUDComponent.c.

m_WarningZoneDistanceVisuals

Widget SCR_RestrictionZoneWarningHUDComponent::m_WarningZoneDistanceVisuals

protected

Definition at line 33 of file SCR_RestrictionZoneWarningHUDComponent.c.

---

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

• scripts/Game/UI/HUD/SCR_RestrictionZoneWarningHUDComponent.c