Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_UnconsciousScreenEffect Interface Reference
Inheritance diagram for SCR_UnconsciousScreenEffect:
[legend]

Public Member Functions

override void DisplayStartDraw (IEntity owner)
 
override void DisplayControlledEntityChanged (IEntity from, IEntity to)
 
- 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)
 

Public Attributes

EAnimationCurve m_eUnconsciousEffectAnimIn
 
EAnimationCurve m_eUnconsciousEffectAnimOut
 
- Public Attributes inherited from SCR_InfoDisplay
ResourceName m_LayoutPath
 
EHudLayers m_eLayer
 
int m_iOverrideZOrder
 

Protected Member Functions

override void DisplayConsciousnessChanged (bool conscious, bool init=false)
 
void UnconsciousnessEffect (bool conscious)
 
void PlayUnconAnim (float speed)
 
void OnAnimCycleComplete (WidgetAnimationBase anim)
 
float GetUnconProgress ()
 
void StopUnconAnim ()
 
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

bool m_bOverUnder
 
WidgetAnimationBase m_UnconMaskAnim
 
ImageWidget m_wDeath
 
SCR_CharacterDamageManagerComponent m_pDamageManager
 
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_InfoDisplayHandlerm_aHandlers
 
bool m_bShown
 
Widget m_wRoot
 
Widget m_wContent
 
Widget m_wSlot
 
SCR_HUDManagerComponent m_HUDManager
 
int m_iChildDisplays = 0
 
ref array< BaseInfoDisplaym_aChildDisplays = new array<BaseInfoDisplay>
 
SCR_InfoDisplay m_pParentDisplay
 
bool m_bRegistered = false
 
IEntity m_OwnerEntity
 
ref array< ref SCR_InfoDisplayHandlerm_aUpdatableHandlers = {}
 
ref SCR_InfoDisplayInvoker m_OnStart = new SCR_InfoDisplayInvoker()
 
ref SCR_InfoDisplayInvoker m_OnStop = new SCR_InfoDisplayInvoker()
 

Static Protected Attributes

const float UNCONSCIOUS_EFFECT_DURATION = 0.5
 
const float UNCONSCIOUS_FADEOUT_DURATION = 0.8
 
const float UNCONSCIOUS_OSCILIATION_OVERSHOOT = 0.2
 
const float UNCONSCIOUS_ALPHAMASK_MIN = 0.4
 
const float UNCONSCIOUS_ALPHAMASK_MAX = 0.7
 
const float UNCONSCIOUS_OPACITY_DIFF = 0.05
 

Member Function Documentation

◆ ClearEffects()

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

◆ DisplayConsciousnessChanged()

override void SCR_UnconsciousScreenEffect.DisplayConsciousnessChanged ( bool  conscious,
bool  init = false 
)
protected

◆ DisplayControlledEntityChanged()

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

Implements SCR_BaseScreenEffect.

◆ DisplayStartDraw()

override void SCR_UnconsciousScreenEffect.DisplayStartDraw ( IEntity  owner)

Implements SCR_BaseScreenEffect.

◆ GetUnconProgress()

float SCR_UnconsciousScreenEffect.GetUnconProgress ( )
protected

◆ OnAnimCycleComplete()

void SCR_UnconsciousScreenEffect.OnAnimCycleComplete ( WidgetAnimationBase  anim)
protected

◆ PlayUnconAnim()

void SCR_UnconsciousScreenEffect.PlayUnconAnim ( float  speed)
protected

◆ StopUnconAnim()

void SCR_UnconsciousScreenEffect.StopUnconAnim ( )
protected

◆ UnconsciousnessEffect()

void SCR_UnconsciousScreenEffect.UnconsciousnessEffect ( bool  conscious)
protected

Member Data Documentation

◆ m_bOverUnder

bool SCR_UnconsciousScreenEffect.m_bOverUnder
protected

◆ m_eUnconsciousEffectAnimIn

EAnimationCurve SCR_UnconsciousScreenEffect.m_eUnconsciousEffectAnimIn

◆ m_eUnconsciousEffectAnimOut

EAnimationCurve SCR_UnconsciousScreenEffect.m_eUnconsciousEffectAnimOut

◆ m_pCharacterEntity

ChimeraCharacter SCR_UnconsciousScreenEffect.m_pCharacterEntity
protected

◆ m_pDamageManager

SCR_CharacterDamageManagerComponent SCR_UnconsciousScreenEffect.m_pDamageManager
protected

◆ m_UnconMaskAnim

WidgetAnimationBase SCR_UnconsciousScreenEffect.m_UnconMaskAnim
protected

◆ m_wDeath

ImageWidget SCR_UnconsciousScreenEffect.m_wDeath
protected

◆ UNCONSCIOUS_ALPHAMASK_MAX

const float SCR_UnconsciousScreenEffect.UNCONSCIOUS_ALPHAMASK_MAX = 0.7
staticprotected

◆ UNCONSCIOUS_ALPHAMASK_MIN

const float SCR_UnconsciousScreenEffect.UNCONSCIOUS_ALPHAMASK_MIN = 0.4
staticprotected

◆ UNCONSCIOUS_EFFECT_DURATION

const float SCR_UnconsciousScreenEffect.UNCONSCIOUS_EFFECT_DURATION = 0.5
staticprotected

◆ UNCONSCIOUS_FADEOUT_DURATION

const float SCR_UnconsciousScreenEffect.UNCONSCIOUS_FADEOUT_DURATION = 0.8
staticprotected

◆ UNCONSCIOUS_OPACITY_DIFF

const float SCR_UnconsciousScreenEffect.UNCONSCIOUS_OPACITY_DIFF = 0.05
staticprotected

◆ UNCONSCIOUS_OSCILIATION_OVERSHOOT

const float SCR_UnconsciousScreenEffect.UNCONSCIOUS_OSCILIATION_OVERSHOOT = 0.2
staticprotected

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