SCR_DesaturationEffect Interface Reference

Inheritance diagram for SCR_DesaturationEffect:

Public Member Functions
override void	DisplayStartDraw (IEntity owner)
override 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)
Public Member Functions inherited from SCR_BaseScreenEffect
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	COLORS_PP_PRIORITY = 5

Protected Member Functions
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 ()
override void	UpdateEffect (float timeSlice)
	Called every frame from SCR_ScreenEffectsManager.
void	AddDesaturationEffect ()
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_fDesaturationStart
float	m_fDesaturationEnd
ChimeraCharacter	m_pCharacterEntity
SCR_CharacterBloodHitZone	m_BloodHZ
SCR_CharacterDamageManagerComponent	m_DamageManager
bool	m_bLocalPlayerOutsideCharacter
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	DESATURATION_EMAT = "{7C202A913EB8B1A9}UI/Materials/ScreenEffects_ColorPP.emat"

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

Member Function Documentation

AddDesaturationEffect()

void SCR_DesaturationEffect.AddDesaturationEffect ( )

protected

ClearEffects()

override void SCR_DesaturationEffect.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_DesaturationEffect.DisplayControlledEntityChanged	(	IEntity	from,
		IEntity	to )

Implements SCR_BaseScreenEffect.

DisplayOnResumed()

override void SCR_DesaturationEffect.DisplayOnResumed ( )

protected

Implements SCR_InfoDisplayExtended.

DisplayOnSuspended()

override void SCR_DesaturationEffect.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_DesaturationEffect.DisplayStartDraw

(

IEntity

owner

)

Implements SCR_BaseScreenEffect.

SettingsChanged()

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

Implements SCR_BaseScreenEffect.

UpdateEffect()

override void SCR_DesaturationEffect.UpdateEffect ( float timeSlice )

protected

Called every frame from SCR_ScreenEffectsManager.

Implements SCR_BaseScreenEffect.

Member Data Documentation

COLORS_PP_PRIORITY

const int SCR_DesaturationEffect.COLORS_PP_PRIORITY = 5

static

DESATURATION_EMAT

const string SCR_DesaturationEffect.DESATURATION_EMAT = "{7C202A913EB8B1A9}UI/Materials/ScreenEffects_ColorPP.emat"

staticprotected

m_bLocalPlayerOutsideCharacter

bool SCR_DesaturationEffect.m_bLocalPlayerOutsideCharacter

protected

m_BloodHZ

SCR_CharacterBloodHitZone SCR_DesaturationEffect.m_BloodHZ

protected

m_DamageManager

SCR_CharacterDamageManagerComponent SCR_DesaturationEffect.m_DamageManager

protected

m_fDesaturationEnd

float SCR_DesaturationEffect.m_fDesaturationEnd

protected

m_fDesaturationStart

float SCR_DesaturationEffect.m_fDesaturationStart

protected

m_pCharacterEntity

ChimeraCharacter SCR_DesaturationEffect.m_pCharacterEntity

protected

---

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

• Game/UI/ScreenEffects/SCR_DesaturationEffect.c