SCR_InfoDisplayExtended Interface Reference

Inheritance diagram for SCR_InfoDisplayExtended:

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

Member Function Documentation

DisplayConsciousnessChanged()

void SCR_InfoDisplayExtended.DisplayConsciousnessChanged ( bool  conscious, bool  init = false  )

protected

Implemented in SCR_NoiseFilterEffect, and SCR_UnconsciousScreenEffect.

DisplayControlledEntityChanged()

void SCR_InfoDisplayExtended.DisplayControlledEntityChanged ( IEntity  from, IEntity  to  )

protected

Implemented in SCR_VonDisplay, SCR_NameTagDisplay, SCR_BaseScreenEffect, SCR_BleedingScreenEffect, SCR_DamageBlurEffect, SCR_DeathScreenEffect, SCR_DepthOfFieldEffect, SCR_DesaturationEffect, SCR_DrowningScreenEffect, SCR_NoiseFilterEffect, SCR_RegenerationScreenEffect, SCR_StaminaBlurEffect, SCR_UnconsciousScreenEffect, and SCR_ScreenEffectsManager.

DisplayInit()

void SCR_InfoDisplayExtended.DisplayInit ( IEntity  owner )

protected

Implemented in SCR_AvailableActionsDisplay, SCR_NearbyContextDisplay, SCR_XPInfoDisplay, SCR_AnalogGauge, SCR_AnalogGaugeNonLinear, SCR_BaseAnalogGauge, SCR_BaseVehicleInfo, SCR_EngineHitZoneInfo, SCR_FuelTankInfo, SCR_GearboxHitZoneInfo, SCR_GearShiftInfo, SCR_HandBrakeInfo, SCR_HZInfoHeli, SCR_LightManagerInfo, SCR_LightManagerInfoMulti, SCR_VInfoAutoHover, SCR_VInfoParkingBrakeHeli, SCR_WheelHitZoneInfo, and SCR_NoiseFilterEffect.

DisplayOnResumed()

void SCR_InfoDisplayExtended.DisplayOnResumed ( )

protected

Implemented in SCR_BleedingScreenEffect, SCR_DamageBlurEffect, SCR_DepthOfFieldEffect, SCR_DesaturationEffect, SCR_InspectCasualtyWidget, SCR_NoiseFilterEffect, SCR_RegenerationScreenEffect, and SCR_StaminaBlurEffect.

DisplayOnSuspended()

void SCR_InfoDisplayExtended.DisplayOnSuspended ( )

protected

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

Implemented in SCR_SelectionMenuDisplay, SCR_BleedingScreenEffect, SCR_DamageBlurEffect, SCR_DepthOfFieldEffect, SCR_DesaturationEffect, SCR_InspectCasualtyWidget, SCR_NoiseFilterEffect, SCR_RegenerationScreenEffect, and SCR_StaminaBlurEffect.

DisplayStartDraw()

void SCR_InfoDisplayExtended.DisplayStartDraw ( IEntity  owner )

protected

Implemented in SCR_ActionMenuInteractionDisplay, SCR_CaptureAndHoldObjectiveDisplay, SCR_CaptureAndHoldTeamScoreDisplay, SCR_ChatHud, SCR_AvailableActionsDisplay, SCR_CompositionInfoDisplay, SCR_2DOpticsDisplay, SCR_CampaignInfoDisplay, SCR_CampaignMapInfoDisplay, SCR_HintInfoDisplay, SCR_NearbyContextDisplay, SCR_NotificationsLogDisplay, SCR_PlacedCommandInfoDisplay, SCR_VoiceoverSubtitles, SCR_VonDisplay, SCR_XPInfoDisplay, SCR_RadialMenuDisplay, SCR_SelectionMenuDisplay, SCR_VONRadialDisplay, SCR_StatsPanelBase, SCR_AnalogGauge, SCR_AnalogGaugeMultiSignal, SCR_AnalogGaugeNonLinear, SCR_BaseAnalogGauge, SCR_BaseVehicleInfo, SCR_GearShiftInfo, SCR_WeaponInfo, SCR_NameTagDisplay, SCR_ScenarioFrameworkTriggerCountdownDisplay, SCR_BaseScreenEffect, SCR_BleedingScreenEffect, SCR_DamageBlurEffect, SCR_DeathScreenEffect, SCR_DepthOfFieldEffect, SCR_DesaturationEffect, SCR_DrowningScreenEffect, SCR_FadeInOutEffect, SCR_InspectCasualtyWidget, SCR_RegenerationScreenEffect, SCR_StaminaBlurEffect, SCR_UnconsciousScreenEffect, SCR_ScreenEffectsManager, and SCR_PreviewRichText.

DisplayStartDrawInit()

bool SCR_InfoDisplayExtended.DisplayStartDrawInit ( IEntity  owner )

protected

Implemented in SCR_CaptureAndHoldObjectiveDisplay, SCR_CaptureAndHoldTeamScoreDisplay, SCR_CampaignInfoDisplay, SCR_VonDisplay, SCR_XPInfoDisplay, SCR_StatsPanel_FPS, SCR_StatsPanelBase, SCR_BaseAnalogGauge, SCR_BaseVehicleInfo, SCR_FuelTankInfo, SCR_GearShiftInfo, SCR_HitZoneInfo, SCR_LightManagerInfo, SCR_LightManagerInfoMulti, SCR_WeaponInfo, SCR_WeaponInfoVehicle, SCR_NameTagDisplay, and SCR_PreviewRichText.

DisplayStopDraw()

void SCR_InfoDisplayExtended.DisplayStopDraw ( IEntity  owner )

protected

Implemented in SCR_ActionMenuInteractionDisplay, SCR_CaptureAndHoldObjectiveDisplay, SCR_CaptureAndHoldTeamScoreDisplay, SCR_ChatHud, SCR_AvailableActionsDisplay, SCR_2DOpticsDisplay, SCR_CampaignMapInfoDisplay, SCR_HintInfoDisplay, SCR_NearbyContextDisplay, SCR_NotificationsLogDisplay, SCR_PlacedCommandInfoDisplay, SCR_VonDisplay, SCR_RadialMenuDisplay, SCR_BaseAnalogGauge, SCR_BaseVehicleInfo, SCR_HitZoneInfo, SCR_LightManagerInfo, SCR_WeaponInfo, SCR_NameTagDisplay, SCR_ScreenEffectsManager, and SCR_PreviewRichText.

DisplayUpdate()

void SCR_InfoDisplayExtended.DisplayUpdate ( IEntity  owner, float  timeSlice  )

protected

Implemented in SCR_ActionMenuInteractionDisplay, SCR_CaptureAndHoldObjectiveDisplay, SCR_CaptureAndHoldTeamScoreDisplay, SCR_ChatHud, SCR_AvailableActionsDisplay, SCR_CompositionInfoDisplay, SCR_2DOpticsDisplay, SCR_CampaignInfoDisplay, SCR_HintInfoDisplay, SCR_NearbyContextDisplay, SCR_NotificationsLogDisplay, SCR_PlacedCommandInfoDisplay, SCR_VonDisplay, SCR_RadialMenuDisplay, SCR_StatsPanelBase, SCR_BaseAnalogGauge, SCR_BaseVehicleInfo, SCR_GearShiftInfo, SCR_WeaponInfo, SCR_WeaponInfoVehicle, SCR_NameTagDisplay, SCR_ScenarioFrameworkTriggerCountdownDisplay, SCR_BaseScreenEffect, SCR_InspectCasualtyWidget, SCR_ScreenEffectsManager, SCR_PreviewRichText, and SCR_WaypointDisplay.

InitializeInterfaceSettings()

void SCR_InfoDisplayExtended.InitializeInterfaceSettings ( )

protected

OnSettingsChanged()

void SCR_InfoDisplayExtended.OnSettingsChanged ( )

protected

Implemented in SCR_ChatHud, and SCR_XPInfoDisplay.

SetEnabled()

void SCR_InfoDisplayExtended.SetEnabled

(

bool

isEnabled

)

Show()

override void SCR_InfoDisplayExtended.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

Implements SCR_InfoDisplay.

Member Data Documentation

m_bAttachedToPlayerController

bool SCR_InfoDisplayExtended.m_bAttachedToPlayerController

protected

m_bCanShow

bool SCR_InfoDisplayExtended.m_bCanShow

protected

m_bInADS

bool SCR_InfoDisplayExtended.m_bInADS

protected

m_bInEditor

bool SCR_InfoDisplayExtended.m_bInEditor

protected

m_bInPauseMenu

bool SCR_InfoDisplayExtended.m_bInPauseMenu

protected

m_bInThirdPerson

bool SCR_InfoDisplayExtended.m_bInThirdPerson

protected

m_bIsEnabled

bool SCR_InfoDisplayExtended.m_bIsEnabled

protected

m_bIsEnabledInSettings

bool SCR_InfoDisplayExtended.m_bIsEnabledInSettings = true

protected

m_bIsUnconscious

bool SCR_InfoDisplayExtended.m_bIsUnconscious

protected

m_bShowInAllCameras

bool SCR_InfoDisplayExtended.m_bShowInAllCameras = true

protected

m_CameraHandler

SCR_CharacterCameraHandlerComponent SCR_InfoDisplayExtended.m_CameraHandler

protected

m_CharacterController

SCR_CharacterControllerComponent SCR_InfoDisplayExtended.m_CharacterController

protected

m_EditorManager

SCR_EditorManagerEntity SCR_InfoDisplayExtended.m_EditorManager

protected

m_EventHandlerManager

EventHandlerManagerComponent SCR_InfoDisplayExtended.m_EventHandlerManager

protected

m_MenuManager

MenuManager SCR_InfoDisplayExtended.m_MenuManager

protected

m_PlayerController

SCR_PlayerController SCR_InfoDisplayExtended.m_PlayerController

protected

m_sInterfaceSettingName

string SCR_InfoDisplayExtended.m_sInterfaceSettingName

protected

---

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

• Game/UI/HUD/SCR_InfoDisplayExtended.c