SCR_DrowningScreenEffect Interface Reference

Inheritance diagram for SCR_DrowningScreenEffect:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)
override void	DisplayControlledEntityChanged (IEntity from, IEntity to)
Public Member Functions inherited from SCR_BaseScreenEffect
void	SettingsChanged ()
	Called when any settings are changed in the settings menu, upon DisplayStartDraw() Called from SCR_ScreenEffectsManager.
override void	DisplayUpdate (IEntity owner, float timeSlice)
void	UpdateEffect (float timeSlice)
	Called every frame from SCR_ScreenEffectsManager.
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	CreateEffect (float maxDrowningDuration, float drowningTimeStartFX)
void	ClearEffect ()
void	BlackoutEffect (float effectStrength, float drowningDuration)
void	OnDeath (EDamageState state)
override void	ClearEffects ()
	Automatically called upon DisplayStartDraw() and DisplayStopDraw() from SCR_ScreenEffectsManager Due to many screeneffects listening to invokers, ClearEffects() is often called manually OnControlledEntityChanged()
void	RemoveInvokers (IEntity prevEntity)
Protected Member Functions inherited from SCR_BaseScreenEffect
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)

Protected Attributes
ImageWidget	m_wDrowningEffect
ImageWidget	m_wBlackOut
ChimeraCharacter	m_pCharacterEntity
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()

Static Protected Attributes
const float	DROWNINGEFFECT_OPACITY_FADEOUT_1_DURATION = 0.2
const float	DROWNINGEFFECT_PROGRESSION_FADEOUT_1_DURATION = 0.2
const float	DROWNINGEFFECT_OPACITY_FADEIN_1_DURATION = 1
const float	DROWNINGEFFECT_PROGRESSION_FADEIN_1_DURATION = 4.5
const float	BLACKOUT_OPACITY_MULTIPLIER = 0.70
const float	DROWNINGEFFECT_STRENGTH = 1.0

Additional Inherited Members
Public Attributes inherited from SCR_InfoDisplay
ResourceName	m_LayoutPath
EHudLayers	m_eLayer
int	m_iOverrideZOrder

Member Function Documentation

BlackoutEffect()

void SCR_DrowningScreenEffect.BlackoutEffect ( float effectStrength, float drowningDuration )

protected

ClearEffect()

void SCR_DrowningScreenEffect.ClearEffect ( )

protected

ClearEffects()

override void SCR_DrowningScreenEffect.ClearEffects ( )

protected

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

Implements SCR_BaseScreenEffect.

CreateEffect()

void SCR_DrowningScreenEffect.CreateEffect ( float maxDrowningDuration, float drowningTimeStartFX )

protected

DisplayControlledEntityChanged()

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

Implements SCR_BaseScreenEffect.

DisplayStartDraw()

override void SCR_DrowningScreenEffect.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_BaseScreenEffect.

OnDeath()

void SCR_DrowningScreenEffect.OnDeath ( EDamageState state )

protected

RemoveInvokers()

void SCR_DrowningScreenEffect.RemoveInvokers ( IEntity prevEntity )

protected

Member Data Documentation

BLACKOUT_OPACITY_MULTIPLIER

const float SCR_DrowningScreenEffect.BLACKOUT_OPACITY_MULTIPLIER = 0.70

staticprotected

DROWNINGEFFECT_OPACITY_FADEIN_1_DURATION

const float SCR_DrowningScreenEffect.DROWNINGEFFECT_OPACITY_FADEIN_1_DURATION = 1

staticprotected

DROWNINGEFFECT_OPACITY_FADEOUT_1_DURATION

const float SCR_DrowningScreenEffect.DROWNINGEFFECT_OPACITY_FADEOUT_1_DURATION = 0.2

staticprotected

DROWNINGEFFECT_PROGRESSION_FADEIN_1_DURATION

const float SCR_DrowningScreenEffect.DROWNINGEFFECT_PROGRESSION_FADEIN_1_DURATION = 4.5

staticprotected

DROWNINGEFFECT_PROGRESSION_FADEOUT_1_DURATION

const float SCR_DrowningScreenEffect.DROWNINGEFFECT_PROGRESSION_FADEOUT_1_DURATION = 0.2

staticprotected

DROWNINGEFFECT_STRENGTH

const float SCR_DrowningScreenEffect.DROWNINGEFFECT_STRENGTH = 1.0

staticprotected

m_pCharacterEntity

ChimeraCharacter SCR_DrowningScreenEffect.m_pCharacterEntity

protected

m_wBlackOut

ImageWidget SCR_DrowningScreenEffect.m_wBlackOut

protected

m_wDrowningEffect

ImageWidget SCR_DrowningScreenEffect.m_wDrowningEffect

protected

---

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

• Game/UI/ScreenEffects/SCR_DrowningScreenEffect.c