Inheritance diagram for SCR_BaseScreenEffect:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)

void	SettingsChanged ()
	Called when any settings are changed in the settings menu, upon DisplayStartDraw() Called from SCR_ScreenEffectsManager.

override void	DisplayControlledEntityChanged (IEntity from, IEntity to)

override void	DisplayUpdate (IEntity owner, float timeSlice)

void	UpdateEffect (float timeSlice)
	Called every frame from SCR_ScreenEffectsManager.

void	ClearEffects ()
	Automatically called upon DisplayStartDraw() and DisplayStopDraw() from SCR_ScreenEffectsManager Due to many screeneffects listening to invokers, ClearEffects() is often called manually OnControlledEntityChanged()

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

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	UpdateEffectVisibility (notnull ImageWidget effectWidget)
	The widget will be made visible or hidden based on its opacity.

void	AnimateEffectVisibility (notnull ImageWidget effectWidget, float opacity, float alpha, float opacitySpeed=1.0, float alphaSpeed=1.0, bool updateVisibility=true)

void	ShowSingleEffect (notnull ImageWidget effectWidget)

void	HideSingleEffect (notnull ImageWidget effectWidget)

Protected Member Functions inherited from SCR_InfoDisplayExtended
bool	DisplayStartDrawInit (IEntity owner)

void	DisplayStopDraw (IEntity owner)

void	DisplayInit (IEntity owner)

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)

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

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath

EHudLayers	m_eLayer

int	m_iOverrideZOrder

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

Member Function Documentation

◆ AnimateEffectVisibility()

void SCR_BaseScreenEffect.AnimateEffectVisibility	(	notnull ImageWidget	effectWidget,
		float	opacity,
		float	alpha,
		float	opacitySpeed = 1::0,
		float	alphaSpeed = 1::0,
		bool	updateVisibility = true )

protected

Parameters

[in]	effectWidget	to animate its opacity and alpha mask.
[in]	opacity	desired target value.
[in]	alpha	desired target value.
[in]	opacitySpeed	desired speed value (default is 0).
[in]	alphaSpeed	desired speed value (default is 0).
[in]	updateVisibility	Whether the visibility should be updated based on the final opacity (default is true).
[in]	updateVisibility	Whether the visibility should be updated based on the final opacity (default is true).

◆ ClearEffects()

void SCR_BaseScreenEffect.ClearEffects ( )

Automatically called upon DisplayStartDraw() and DisplayStopDraw() from SCR_ScreenEffectsManager Due to many screeneffects listening to invokers, ClearEffects() is often called manually OnControlledEntityChanged()

Implemented in SCR_BleedingScreenEffect, SCR_DamageBlurEffect, SCR_DeathScreenEffect, SCR_DepthOfFieldEffect, SCR_DesaturationEffect, SCR_DrowningScreenEffect, SCR_FadeInOutEffect, SCR_NoiseFilterEffect, SCR_RegenerationScreenEffect, SCR_StaminaBlurEffect, and SCR_UnconsciousScreenEffect.

◆ DisplayControlledEntityChanged()

override void SCR_BaseScreenEffect.DisplayControlledEntityChanged	(	IEntity	from,
		IEntity	to )

Implements SCR_InfoDisplayExtended.

Implemented in SCR_BleedingScreenEffect, SCR_DamageBlurEffect, SCR_DeathScreenEffect, SCR_DepthOfFieldEffect, SCR_DesaturationEffect, SCR_DrowningScreenEffect, SCR_NoiseFilterEffect, SCR_RegenerationScreenEffect, SCR_StaminaBlurEffect, and SCR_UnconsciousScreenEffect.

◆ DisplayStartDraw()

override void SCR_BaseScreenEffect.DisplayStartDraw ( IEntity owner )

Implements SCR_InfoDisplayExtended.

Implemented in SCR_BleedingScreenEffect, SCR_DamageBlurEffect, SCR_DeathScreenEffect, SCR_DepthOfFieldEffect, SCR_DesaturationEffect, SCR_DrowningScreenEffect, SCR_FadeInOutEffect, SCR_RegenerationScreenEffect, SCR_StaminaBlurEffect, and SCR_UnconsciousScreenEffect.

◆ DisplayUpdate()

override void SCR_BaseScreenEffect.DisplayUpdate	(	IEntity	owner,
		float	timeSlice )

Implements SCR_InfoDisplayExtended.

◆ HideSingleEffect()

void SCR_BaseScreenEffect.HideSingleEffect ( notnull ImageWidget effectWidget )

protected

◆ SettingsChanged()

void SCR_BaseScreenEffect.SettingsChanged ( )

Called when any settings are changed in the settings menu, upon DisplayStartDraw() Called from SCR_ScreenEffectsManager.

So not every effect has to listen for this individually Relevant when your effect needs to adapt when particular settings are changed, such as switching from normal DoF to Bokeh

Implemented in SCR_DepthOfFieldEffect, and SCR_DesaturationEffect.

◆ ShowSingleEffect()

void SCR_BaseScreenEffect.ShowSingleEffect ( notnull ImageWidget effectWidget )

protected

◆ UpdateEffect()

void SCR_BaseScreenEffect.UpdateEffect ( float timeSlice )

Called every frame from SCR_ScreenEffectsManager.

Implemented in SCR_DamageBlurEffect, SCR_DepthOfFieldEffect, SCR_DesaturationEffect, SCR_RegenerationScreenEffect, and SCR_StaminaBlurEffect.

◆ UpdateEffectVisibility()

void SCR_BaseScreenEffect.UpdateEffectVisibility ( notnull ImageWidget effectWidget )

protected

The widget will be made visible or hidden based on its opacity.

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

Game/UI/ScreenEffects/SCR_BaseScreenEffect.c

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ AnimateEffectVisibility()

◆ ClearEffects()

◆ DisplayControlledEntityChanged()

◆ DisplayStartDraw()

◆ DisplayUpdate()

◆ HideSingleEffect()

◆ SettingsChanged()

◆ ShowSingleEffect()

◆ UpdateEffect()

◆ UpdateEffectVisibility()