FlashbangEffect Class Reference

Private Member Functions
void	FlashbangEffect (PlayerBase player, bool visual=true)
void	~FlashbangEffect ()
void	SetupFlashbangValues (float progress_mult=1.0, float visual_value_max=1.0, float sound_value_max=1.0)
protected void	PlaySound ()
protected void	SetAttenuationFilter ()
protected void	ResetAttenuationFilter ()
protected void	StopSound ()
protected void	ClearVisual ()
protected void	SetVisual (float val)
void	Stop ()
void	Update (float deltatime)

Private Attributes
protected const float	ALPHA_MIN = 0.0
protected const float	ALPHA_MAX = 1.0
protected const float	SOUND_DEFER_TIME = 0.4
protected float	m_HitDuration
	SFX will be played ~0.5s AFTER VFX.
protected float	m_BreakPoint
protected float	m_TimeActive
protected float	m_DayTimeToggle
protected float	m_AlphaMaxActual
protected float	m_SoundMaxActual
protected float	m_ProgressMultiplier
protected bool	m_Visual
protected bool	m_Initialized
protected PlayerBase	m_Player
protected EffectSound	m_FlashbangEffectSound
protected float	m_SoundStopTime
protected ref Timer	m_DeferAttenuation
protected PPERequester_FlashbangEffects	m_Requester

Constructor & Destructor Documentation

FlashbangEffect()

void FlashbangEffect ( PlayerBase  player, bool  visual = true  )

inlineprivate

naive time of the day selector

-1: night; 1: day

References ALPHA_MAX, Class::CastTo(), g_Game, m_AlphaMaxActual, m_BreakPoint, m_DayTimeToggle, m_DeferAttenuation, m_FlashbangEffectSound, m_HitDuration, m_Initialized, m_Player, m_ProgressMultiplier, m_Requester, m_SoundMaxActual, m_Visual, and SOUND_DEFER_TIME.

~FlashbangEffect()

void ~FlashbangEffect ( )

inlineprivate

References ClearVisual(), SEffectManager::DestroyEffect(), m_DeferAttenuation, m_FlashbangEffectSound, m_Player, m_Visual, and Timer::Stop().

Member Function Documentation

ClearVisual()

protected void ClearVisual ( )

inlineprivate

References m_Requester.

Referenced by ~FlashbangEffect().

PlaySound()

protected void PlaySound ( )

inlineprivate

References Math::Clamp(), SEffectManager::CreateSound(), Error(), EffectSound::IsPlaying(), m_FlashbangEffectSound, m_Initialized, m_Player, m_ProgressMultiplier, m_SoundMaxActual, m_SoundStopTime, SetAttenuationFilter(), EffectSound::SetAutodestroy(), EffectSound::SetParent(), EffectSound::SetSoundFadeIn(), EffectSound::SetSoundFadeOut(), EffectSound::SetSoundLoop(), EffectSound::SetSoundMaxVolume(), EffectSound::SetSoundWaveKind(), and EffectSound::SoundPlay().

ResetAttenuationFilter()

protected void ResetAttenuationFilter ( )

inlineprivate

References m_Player.

Referenced by Update().

SetAttenuationFilter()

protected void SetAttenuationFilter ( )

inlineprivate

References m_DeferAttenuation, and m_Player.

Referenced by PlaySound().

SetupFlashbangValues()

void SetupFlashbangValues ( float  progress_mult = 1.0, float  visual_value_max = 1.0, float  sound_value_max = 1.0  )

inlineprivate

References m_AlphaMaxActual, m_BreakPoint, m_HitDuration, m_Initialized, m_ProgressMultiplier, and m_SoundMaxActual.

SetVisual()

protected void SetVisual ( float  val )

inlineprivate

References m_DayTimeToggle, and m_Requester.

Referenced by Update().

Stop()

void Stop ( )

inlineprivate

References StopSound().

StopSound()

protected void StopSound ( )

inlineprivate

References SEffectManager::DestroyEffect(), m_FlashbangEffectSound, and EffectSound::SoundStop().

Referenced by Stop(), and Update().

Update()

void Update ( float  deltatime )

inlineprivate

References Math::Clamp(), Error(), Math::InverseLerp(), m_AlphaMaxActual, m_BreakPoint, m_HitDuration, m_Initialized, m_SoundStopTime, m_TimeActive, m_Visual, ResetAttenuationFilter(), SetVisual(), and StopSound().

Field Documentation

ALPHA_MAX

protected const float ALPHA_MAX = 1.0

private

Referenced by FlashbangEffect().

ALPHA_MIN

protected const float ALPHA_MIN = 0.0

private

m_AlphaMaxActual

protected float m_AlphaMaxActual

private

Referenced by FlashbangEffect(), SetupFlashbangValues(), and Update().

m_BreakPoint

protected float m_BreakPoint

private

Referenced by FlashbangEffect(), SetupFlashbangValues(), and Update().

m_DayTimeToggle

protected float m_DayTimeToggle

private

Referenced by FlashbangEffect(), and SetVisual().

m_DeferAttenuation

protected ref Timer m_DeferAttenuation

private

Referenced by FlashbangEffect(), SetAttenuationFilter(), and ~FlashbangEffect().

m_FlashbangEffectSound

protected EffectSound m_FlashbangEffectSound

private

Referenced by FlashbangEffect(), PlaySound(), StopSound(), and ~FlashbangEffect().

m_HitDuration

protected float m_HitDuration

private

SFX will be played ~0.5s AFTER VFX.

Referenced by FlashbangEffect(), SetupFlashbangValues(), and Update().

m_Initialized

protected bool m_Initialized

private

Referenced by FlashbangEffect(), PlaySound(), SetupFlashbangValues(), and Update().

m_Player

protected PlayerBase m_Player

private

Referenced by FlashbangEffect(), PlaySound(), ResetAttenuationFilter(), SetAttenuationFilter(), and ~FlashbangEffect().

m_ProgressMultiplier

protected float m_ProgressMultiplier

private

Referenced by FlashbangEffect(), PlaySound(), and SetupFlashbangValues().

m_Requester

protected PPERequester_FlashbangEffects m_Requester

private

Referenced by ClearVisual(), FlashbangEffect(), and SetVisual().

m_SoundMaxActual

protected float m_SoundMaxActual

private

Referenced by FlashbangEffect(), PlaySound(), and SetupFlashbangValues().

m_SoundStopTime

protected float m_SoundStopTime

private

Referenced by PlaySound(), and Update().

m_TimeActive

protected float m_TimeActive

private

Referenced by Update().

m_Visual

protected bool m_Visual

private

Referenced by FlashbangEffect(), Update(), and ~FlashbangEffect().

SOUND_DEFER_TIME

protected const float SOUND_DEFER_TIME = 0.4

private

Referenced by FlashbangEffect().

---

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

• P:/scripts/4_World/Classes/Explosions/FlashbangEffect.c