SCR_RegenerationScreenEffect Interface Reference

Inheritance diagram for SCR_RegenerationScreenEffect:

Public Member Functions
override void	UpdateEffect (float timeSlice)
	Called every frame from SCR_ScreenEffectsManager.
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)
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)

Static Public Attributes
static const int	CHROM_ABER_PRIORITY = 9

Protected Member Functions
override void	DisplayStartDraw (IEntity owner)
override void	DisplayControlledEntityChanged (IEntity from, IEntity to)
override 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.
override void	DisplayOnResumed ()
void	RegenerationEffect (float timeSlice)
void	OnDamageEffectAdded (notnull SCR_DamageEffect dmgEffect)
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_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	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
float	m_fRegenEffectDuration
ref Curve	m_Curve
ChimeraCharacter	m_pCharacterEntity
SCR_CharacterDamageManagerComponent	m_pDamageManager
bool	m_bRegenerationEffect
float	m_fRegenEffectTimeRemaining
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 string	CHROMATIC_ABERIATION_EMAT = "{A78A424C3179C706}UI/Materials/ScreenEffects_ChromAberrPP.emat"

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_RegenerationScreenEffect.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.

DisplayControlledEntityChanged()

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

protected

Implements SCR_BaseScreenEffect.

DisplayOnResumed()

override void SCR_RegenerationScreenEffect.DisplayOnResumed ( )

protected

Implements SCR_InfoDisplayExtended.

DisplayOnSuspended()

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

Implements SCR_InfoDisplayExtended.

DisplayStartDraw()

override void SCR_RegenerationScreenEffect.DisplayStartDraw ( IEntity owner )

protected

Implements SCR_BaseScreenEffect.

OnDamageEffectAdded()

void SCR_RegenerationScreenEffect.OnDamageEffectAdded ( notnull SCR_DamageEffect dmgEffect )

protected

RegenerationEffect()

void SCR_RegenerationScreenEffect.RegenerationEffect ( float timeSlice )

protected

UpdateEffect()

override void SCR_RegenerationScreenEffect.UpdateEffect

(

float

timeSlice

)

Called every frame from SCR_ScreenEffectsManager.

Implements SCR_BaseScreenEffect.

Member Data Documentation

CHROM_ABER_PRIORITY

const int SCR_RegenerationScreenEffect.CHROM_ABER_PRIORITY = 9

static

CHROMATIC_ABERIATION_EMAT

const string SCR_RegenerationScreenEffect.CHROMATIC_ABERIATION_EMAT = "{A78A424C3179C706}UI/Materials/ScreenEffects_ChromAberrPP.emat"

staticprotected

m_bRegenerationEffect

bool SCR_RegenerationScreenEffect.m_bRegenerationEffect

protected

m_Curve

ref Curve SCR_RegenerationScreenEffect.m_Curve

protected

m_fRegenEffectDuration

float SCR_RegenerationScreenEffect.m_fRegenEffectDuration

protected

m_fRegenEffectTimeRemaining

float SCR_RegenerationScreenEffect.m_fRegenEffectTimeRemaining

protected

m_pCharacterEntity

ChimeraCharacter SCR_RegenerationScreenEffect.m_pCharacterEntity

protected

m_pDamageManager

SCR_CharacterDamageManagerComponent SCR_RegenerationScreenEffect.m_pDamageManager

protected

---

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

• Game/UI/ScreenEffects/SCR_RegenerationScreenEffect.c