SCR_DeathScreenEffect Interface Reference

Inheritance diagram for SCR_DeathScreenEffect:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)
override void	DisplayControlledEntityChanged (IEntity from, IEntity to)
void	DeathEffect ()
void	InstaDeathEffect ()
Public Member Functions inherited from SCR_BaseScreenEffect
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)
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
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()
Protected Member Functions inherited from SCR_InfoDisplayExtended
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
ImageWidget	m_wDeath
ImageWidget	m_wBlackOut
ChimeraCharacter	m_pCharacterEntity
SCR_HitZone	m_pHeadHitZone
SCR_CharacterDamageManagerComponent	m_pDamageManager
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	DEATHEFFECT_START_OPACITY = 0.7
const float	DEATHEFFECT_FADEIN_OPACITY_DURATION = 0.8
const float	DEATHEFFECT_FADEIN_PROGRESSION_DURACTION = 0.5
const float	DEATHEFFECT_FADEIN_OPACITY_TARGET = 1
const float	DEATHEFFECT_FADEIN_PROGRESSION_TARGET = 1
const float	INSTADEATHEFFECT_START_OPACITY = 0.4
const float	INSTADEATHEFFECT_START_PROGRESSION = 0.4
const float	INSTADEATHEFFECT_FADEIN_OPACITY_DURATION = 8.5
const float	INSTADEATHEFFECT_FADEIN_PROGRESSION_DURACTION = 10
const float	INSTADEATHEFFECT_FADEIN_OPACITY_TARGET = 1
const float	INSTADEATHEFFECT_FADEIN_PROGRESSION_TARGET = 1

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

Member Function Documentation

ClearEffects()

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

DeathEffect()

void SCR_DeathScreenEffect.DeathEffect

(

)

DisplayControlledEntityChanged()

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

Implements SCR_BaseScreenEffect.

DisplayStartDraw()

override void SCR_DeathScreenEffect.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_BaseScreenEffect.

InstaDeathEffect()

void SCR_DeathScreenEffect.InstaDeathEffect

(

)

Member Data Documentation

DEATHEFFECT_FADEIN_OPACITY_DURATION

const float SCR_DeathScreenEffect.DEATHEFFECT_FADEIN_OPACITY_DURATION = 0.8

staticprotected

DEATHEFFECT_FADEIN_OPACITY_TARGET

const float SCR_DeathScreenEffect.DEATHEFFECT_FADEIN_OPACITY_TARGET = 1

staticprotected

DEATHEFFECT_FADEIN_PROGRESSION_DURACTION

const float SCR_DeathScreenEffect.DEATHEFFECT_FADEIN_PROGRESSION_DURACTION = 0.5

staticprotected

DEATHEFFECT_FADEIN_PROGRESSION_TARGET

const float SCR_DeathScreenEffect.DEATHEFFECT_FADEIN_PROGRESSION_TARGET = 1

staticprotected

DEATHEFFECT_START_OPACITY

const float SCR_DeathScreenEffect.DEATHEFFECT_START_OPACITY = 0.7

staticprotected

INSTADEATHEFFECT_FADEIN_OPACITY_DURATION

const float SCR_DeathScreenEffect.INSTADEATHEFFECT_FADEIN_OPACITY_DURATION = 8.5

staticprotected

INSTADEATHEFFECT_FADEIN_OPACITY_TARGET

const float SCR_DeathScreenEffect.INSTADEATHEFFECT_FADEIN_OPACITY_TARGET = 1

staticprotected

INSTADEATHEFFECT_FADEIN_PROGRESSION_DURACTION

const float SCR_DeathScreenEffect.INSTADEATHEFFECT_FADEIN_PROGRESSION_DURACTION = 10

staticprotected

INSTADEATHEFFECT_FADEIN_PROGRESSION_TARGET

const float SCR_DeathScreenEffect.INSTADEATHEFFECT_FADEIN_PROGRESSION_TARGET = 1

staticprotected

INSTADEATHEFFECT_START_OPACITY

const float SCR_DeathScreenEffect.INSTADEATHEFFECT_START_OPACITY = 0.4

staticprotected

INSTADEATHEFFECT_START_PROGRESSION

const float SCR_DeathScreenEffect.INSTADEATHEFFECT_START_PROGRESSION = 0.4

staticprotected

m_pCharacterEntity

ChimeraCharacter SCR_DeathScreenEffect.m_pCharacterEntity

protected

m_pDamageManager

SCR_CharacterDamageManagerComponent SCR_DeathScreenEffect.m_pDamageManager

protected

m_pHeadHitZone

SCR_HitZone SCR_DeathScreenEffect.m_pHeadHitZone

protected

m_wBlackOut

ImageWidget SCR_DeathScreenEffect.m_wBlackOut

protected

m_wDeath

ImageWidget SCR_DeathScreenEffect.m_wDeath

protected

---

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

• Game/UI/ScreenEffects/SCR_DeathScreenEffect.c