Класс FlashbangEffect

Защищенные члены
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)
void	PlaySound ()
void	SetAttenuationFilter ()
void	ResetAttenuationFilter ()
void	StopSound ()
void	ClearVisual ()
void	SetVisual (float val)
void	Stop ()
void	Update (float deltatime)

Защищенные данные
const float	ALPHA_MIN = 0.0
const float	ALPHA_MAX = 1.0
const float	SOUND_DEFER_TIME = 0.4
float	m_HitDuration
	SFX will be played ~0.5s AFTER VFX.
float	m_BreakPoint
float	m_TimeActive
float	m_DayTimeToggle
float	m_AlphaMaxActual
float	m_SoundMaxActual
float	m_ProgressMultiplier
bool	m_Visual
bool	m_Initialized
PlayerBase	m_Player
EffectSound	m_FlashbangEffectSound
float	m_SoundStopTime
ref Timer	m_DeferAttenuation
PPERequester_FlashbangEffects	m_Requester

Подробное описание

Конструктор(ы)

FlashbangEffect()

void FlashbangEffect ( PlayerBase player, bool visual = true )

inlineprotected

naive time of the day selector

-1: night; 1: day

    {
        m_Player = player;
        m_Visual = visual;
        m_Initialized = false;
 
        m_HitDuration = 8.0;
        m_BreakPoint = 2.5;
        m_AlphaMaxActual = ALPHA_MAX;
        m_SoundMaxActual = 1.0;
        m_ProgressMultiplier = 1.0;
        
        m_FlashbangEffectSound = null;
        
        if (m_Visual)
        {
            Class.CastTo(m_Requester,PPERequesterBank.GetRequester(PPERequester_FlashbangEffects));
            m_Requester.Start();
        }
        
        m_DeferAttenuation = new ref Timer();
        m_DeferAttenuation.Run(SOUND_DEFER_TIME, this, "PlaySound", null, false);
        
        m_DayTimeToggle = 5; 
        if ( g_Game.GetDayTime() >= 22.0 || g_Game.GetDayTime() < 7.0 )
        {
            m_DayTimeToggle = 10;
        }
    }

Перекрестные ссылки 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 и SOUND_DEFER_TIME.

~FlashbangEffect()

void ~FlashbangEffect ( )

inlineprotected

    {
        if ( m_Visual )
        {
            ClearVisual();
        }
        
        if ( m_Player )
        {
            m_Player.OnPlayerReceiveFlashbangHitEnd();
        }
 
        if ( m_DeferAttenuation.IsRunning() )
        {
            m_DeferAttenuation.Stop();
        }
        
        m_DeferAttenuation = null;
        SEffectManager.DestroyEffect(m_FlashbangEffectSound);
    }

Перекрестные ссылки ClearVisual(), SEffectManager::DestroyEffect(), m_DeferAttenuation, m_FlashbangEffectSound, m_Player и m_Visual.

Методы

ClearVisual()

void ClearVisual ( )

inlineprotected

    {
        if (m_Requester)
        {
            m_Requester.Stop();
        }
    }

Перекрестные ссылки m_Requester.

Используется в ~FlashbangEffect().

PlaySound()

void PlaySound ( )

inlineprotected

    {
        if ( !m_Initialized )
        {
            Error("" + this + " not initialized");
            return;
        }
        
        vector pos;
        MiscGameplayFunctions.GetHeadBonePos(m_Player, pos);
        
        if (!m_FlashbangEffectSound)
        {
            m_FlashbangEffectSound = SEffectManager.CreateSound("Tinnitus_SoundSet", pos);
        }
        
        if (!m_FlashbangEffectSound.IsPlaying())
        {
            m_FlashbangEffectSound.SetParent(m_Player);
            m_FlashbangEffectSound.SetAttachedLocalPos(m_Player.WorldToModel(pos));
            m_FlashbangEffectSound.SetSoundWaveKind(WaveKind.WAVEEFFECTEX);
            m_FlashbangEffectSound.SetSoundFadeIn(4 * Math.Clamp(m_ProgressMultiplier,0.5,1.0)); //TODO
            m_SoundStopTime = 2 * Math.Clamp(m_ProgressMultiplier,0.5,1.0);
            m_FlashbangEffectSound.SetSoundFadeOut(m_SoundStopTime); //TODO
            m_FlashbangEffectSound.SetSoundMaxVolume(Math.Clamp(m_SoundMaxActual,0.1,1.0)); //TODO
            m_FlashbangEffectSound.SetSoundLoop(true);
            m_FlashbangEffectSound.SoundPlay();
            m_FlashbangEffectSound.SetAutodestroy(true);
            
            SetAttenuationFilter();
        }
    }

Перекрестные ссылки 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() и EffectSound::SoundPlay().

ResetAttenuationFilter()

void ResetAttenuationFilter ( )

inlineprotected

    {
        m_Player.SetMasterAttenuation("");
    }

Перекрестные ссылки m_Player.

Используется в Update().

SetAttenuationFilter()

void SetAttenuationFilter ( )

inlineprotected

    {
        if ( !m_DeferAttenuation.IsRunning() || m_Player.GetMasterAttenuation() != "FlashbangAttenuation" )
        {
            m_Player.SetMasterAttenuation("FlashbangAttenuation");
        }
    }

Перекрестные ссылки m_DeferAttenuation и m_Player.

Используется в PlaySound().

SetupFlashbangValues()

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

inlineprotected

    {
        if ( !m_Initialized )
        {
            m_Initialized = true;
            m_ProgressMultiplier = progress_mult;
            m_AlphaMaxActual = visual_value_max;
            m_SoundMaxActual = sound_value_max;
            
            m_HitDuration *= m_ProgressMultiplier;
            m_BreakPoint *= m_ProgressMultiplier;
        }
    }

Перекрестные ссылки m_AlphaMaxActual, m_BreakPoint, m_HitDuration, m_Initialized, m_ProgressMultiplier и m_SoundMaxActual.

SetVisual()

void SetVisual ( float val )

inlineprotected

    {
        if (m_Requester && m_Requester.IsRequesterRunning())
        {
            m_Requester.SetFlashbangIntensity(val, m_DayTimeToggle);
        }
    }

Перекрестные ссылки m_DayTimeToggle и m_Requester.

Используется в Update().

Stop()

void Stop ( )

inlineprotected

    {
        StopSound();
    }

Перекрестные ссылки StopSound().

StopSound()

void StopSound ( )

inlineprotected

    {
        if (m_FlashbangEffectSound)
        {
            m_FlashbangEffectSound.SoundStop();
            SEffectManager.DestroyEffect(m_FlashbangEffectSound);
        }
    }

Перекрестные ссылки SEffectManager::DestroyEffect(), m_FlashbangEffectSound и EffectSound::SoundStop().

Используется в Stop() и Update().

Update()

void Update ( float deltatime )

inlineprotected

    {
        if ( !m_Initialized )
        {
            Error("" + this + " not initialized");
        }
        else if ( m_Visual )
        {
            float value;
 
            if ( m_TimeActive <= m_BreakPoint )
            {
                value = m_AlphaMaxActual;
                //Print("Flashbango | m_AlphaMaxActual: " + value);
            }
            else
            {
                value = Math.InverseLerp(m_HitDuration - m_BreakPoint, m_HitDuration, m_TimeActive);
                value = Math.Clamp(value,0.0,1.0);
                value = m_AlphaMaxActual - value * m_AlphaMaxActual;
                //Print("Flashbango | tmp_value: " + value);
            }
            SetVisual(value);
        }
 
        m_TimeActive += deltatime;
 
        if (m_TimeActive >= m_HitDuration - m_SoundStopTime)
        {
            StopSound();
        }
        
        if (m_TimeActive >= m_HitDuration)
        {
            ResetAttenuationFilter();
            delete this;
        }
    }

Перекрестные ссылки Math::Clamp(), Error(), Math::InverseLerp(), m_AlphaMaxActual, m_BreakPoint, m_HitDuration, m_Initialized, m_SoundStopTime, m_TimeActive, m_Visual, ResetAttenuationFilter(), SetVisual() и StopSound().

Поля

ALPHA_MAX

const float ALPHA_MAX = 1.0

protected

Используется в FlashbangEffect().

ALPHA_MIN

const float ALPHA_MIN = 0.0

protected

m_AlphaMaxActual

float m_AlphaMaxActual

protected

Используется в FlashbangEffect(), SetupFlashbangValues() и Update().

m_BreakPoint

float m_BreakPoint

protected

Используется в FlashbangEffect(), SetupFlashbangValues() и Update().

m_DayTimeToggle

float m_DayTimeToggle

protected

Используется в FlashbangEffect() и SetVisual().

m_DeferAttenuation

ref Timer m_DeferAttenuation

protected

Используется в FlashbangEffect(), SetAttenuationFilter() и ~FlashbangEffect().

m_FlashbangEffectSound

EffectSound m_FlashbangEffectSound

protected

Используется в FlashbangEffect(), PlaySound(), StopSound() и ~FlashbangEffect().

m_HitDuration

float m_HitDuration

protected

SFX will be played ~0.5s AFTER VFX.

Используется в FlashbangEffect(), SetupFlashbangValues() и Update().

m_Initialized

bool m_Initialized

protected

Используется в FlashbangEffect(), PlaySound(), SetupFlashbangValues() и Update().

m_Player

PlayerBase m_Player

protected

Используется в FlashbangEffect(), PlaySound(), ResetAttenuationFilter(), SetAttenuationFilter() и ~FlashbangEffect().

m_ProgressMultiplier

float m_ProgressMultiplier

protected

Используется в FlashbangEffect(), PlaySound() и SetupFlashbangValues().

m_Requester

PPERequester_FlashbangEffects m_Requester

protected

Используется в ClearVisual(), FlashbangEffect() и SetVisual().

m_SoundMaxActual

float m_SoundMaxActual

protected

Используется в FlashbangEffect(), PlaySound() и SetupFlashbangValues().

m_SoundStopTime

float m_SoundStopTime

protected

Используется в PlaySound() и Update().

m_TimeActive

float m_TimeActive

protected

Используется в Update().

m_Visual

bool m_Visual

protected

Используется в FlashbangEffect(), Update() и ~FlashbangEffect().

SOUND_DEFER_TIME

const float SOUND_DEFER_TIME = 0.4

protected

Используется в FlashbangEffect().

---

Объявления и описания членов класса находятся в файле:

• D:/Ishodniki/scripts/4_World/Classes/Explosions/FlashbangEffect.c