Класс EffectSound

Wrapper class for managing sound through SEffectManager. Подробнее...

Граф наследования:EffectSound:

Защищенные члены
EffectType
Information about what type of effect the Effect is, without the need for casting
override EffectType	GetEffectType ()
	Get what type of effect the Effect is.
override bool	IsSound ()
	Check whether the Effect is EffectSound without casting.
Playback
Methods to Play/Stop sound Generally, SEffectManager.PlaySound methods are used instead of SoundPlay
bool	SoundPlayEx (out SoundParams params)
	Plays sound.
bool	SoundPlay ()
	Plays sound.
override void	Start ()
	Plays sound.
void	SoundStop ()
	Stops sound.
override void	Stop ()
	Stops sound.
void	SoundReset ()
	Resets EffectSound.
bool	IsSoundPlaying ()
	Get whether EffectSound is currently playing.
override bool	IsPlaying ()
	Returns true when the effect is playing, false otherwise.
Sound load
Methods regarding the loading of the sound, used in SoundPlay
bool	SoundLoadEx (out SoundParams params)
	Loads in the sound when it is requested for playing through 'SoundPlayEx'.
bool	SoundLoad ()
	Loads in the sound when it is requested for playing.
bool	IsSoundValid ()
	Helper for checking if params are valid.
void	ValidateSoundWave ()
	Gets called to fill in the necessary data when the header has finished loading.
bool	SoundWaveValidation ()
	Validation of fade settings.
void	UpdateEvents ()
	Enables the frame event on the EffectSound.
Events
Various events that can be overriden for custom behaviour
override void	Event_OnFrameUpdate (float time_delta)
	Event called on frame when enabled by SetEnableEventFrame(true)
override void	Event_OnRegistered (int id)
	Event called from SEffectManager when the Effect is registered.
override void	Event_OnUnregistered ()
	Event called from SEffectManager when the Effect is unregistered.
void	Event_OnSoundWaveStarted ()
	Event called when sound starts playing.
void	Event_OnSoundWaveEnded ()
	Event called when sound stops playing.
void	Event_OnSoundFadeInStopped ()
	Event called when sound fade in stops.
void	Event_OnSoundFadeOutStarted ()
	Event called when sound fade out starts.
AutoDestroy
Methods regarding automatic cleanup on stop
override void	SetAutodestroy (bool auto_destroy)
	Sets whether Effect automatically cleans up when it stops.
override bool	IsAutodestroy ()
	Get whether Effect automatically cleans up when it stops.
void	SetSoundAutodestroy (bool auto_destroy)
	Sets whether EffectSound automatically cleans up when sound stops.
bool	IsSoundAutodestroy ()
	Get whether EffectSound automatically cleans up when sound stops.
override bool	CanDestroy ()
Generic API
Setters and getters for generic data and properties
override void	SetParent (Object parent_obj)
	Set parent for the sound to follow.
override Object	GetParent ()
	Get parent for the EffectSound.
override Object	GetCurrentParent ()
	Get parent for the EffectSound.
override void	SetCurrentPosition (vector pos, bool updateCached=true)
	Set the world position of the managed sound.
override vector	GetCurrentPosition ()
	Get the current world position of the managed sound.
override void	SetCurrentLocalPosition (vector pos, bool updateCached=true)
	Set the current local position of the managed sound.
override vector	GetCurrentLocalPosition ()
	Get the current local position of the managed sound.
void	SetSoundWaveKind (WaveKind wave_kind)
	Set WaveKind for the sound.
void	SetSoundSet (string snd)
	Set soundset for the sound.
string	GetSoundSet ()
	Get soundset for the sound.
void	SetSoundLoop (bool loop)
	Set if the sound loops.
void	SetEnviromentVariables (bool setEnvVariables)
	Sets whether AddEnvSoundVariables needs to be called during Loading.
float	GetSoundWaveLenght ()
	Get the sound wave length.
float	GetSoundWaveLength ()
	Get the sound wave length.
void	SetSoundVolume (float volume)
	Set the RELATIVE volume for the sound.
float	GetSoundVolume ()
	Get the RELATIVE volume set by 'SetSoundVolume'.
void	SetSoundMaxVolume (float volume)
	Set the sound max volume.
float	GetSoundWaveTime ()
	Get the time since EffectSound started playing.
void	SetSoundFadeIn (float fade_in)
	Set the sound fade in duration.
void	SetSoundFadeOut (float fade_out)
	Set the sound fade out duration.
void	SetDoppler (bool setDoppler)
	Set if the sound has the doppler effect enabled.
void	SoundError (string err_msg)
	Helper for throwing sound errors.

Защищенные данные
Sound objects and structures
Objects and structures for the sound
ref SoundParams	m_SoundParams
ref SoundObjectBuilder	m_SoundObjectBuilder
ref SoundObject	m_SoundObject
AbstractWave	m_SoundWaveObject
Generic data
Generic data for the sound
WaveKind	m_SoundWaveKind
string	m_SoundSetName
bool	m_SoundLoop
bool	m_SetEnvVariables
bool	m_SoundAutodestroy
bool	m_SoundWaveIsPlaying
float	m_SoundWaveLenght
float	m_SoundWaveVolume
float	m_SoundWaveVolumeMax
float	m_SoundWaveTime
int	m_SoundDoppler

Закрытые данные
Event invokers
ScriptInvonkers for certain events
ref ScriptInvoker	Event_OnSoundWaveStarted = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveEnded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundFadeInStopped = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundFadeOutStarted = new ScriptInvoker()

Fading data
Data for fadein/fadeout for the sound
bool	m_SoundWaveStarting
bool	m_SoundWaveStopping
bool	m_SoundFadedOut
float	m_SoundFadeInDuration
float	m_SoundFadeOutStartTime
float	m_SoundFadeOutDuration
float	m_SoundFadeOutInitVolume
void	EffectSound ()
	ctor
void	~EffectSound ()
	dtor
override void	InitEffect ()
	init
override string	GetDebugName ()
	Override when getting debug information.

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

Wrapper class for managing sound through SEffectManager.

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

EffectSound()

void EffectSound ( )

inlineprotected

ctor

    {
        m_SoundWaveKind = WaveKind.WAVEEFFECTEX;
        m_SoundWaveVolume = 0;
        m_SoundWaveVolumeMax = 1;
        m_SoundAutodestroy = false;
        m_SoundWaveStopping = false;
        m_SoundFadedOut = false;
        m_SoundDoppler = -1;
    }

Перекрестные ссылки m_SoundAutodestroy, m_SoundDoppler, m_SoundFadedOut, m_SoundWaveKind, m_SoundWaveStopping, m_SoundWaveVolume и m_SoundWaveVolumeMax.

~EffectSound()

void ~EffectSound ( )

inlineprotected

dtor

    {
 
    }

Методы

CanDestroy()

override bool CanDestroy ( )

inlineprotected

    {
        return m_SoundFadeOutDuration <= 0 || m_SoundFadedOut;
    }

Перекрестные ссылки m_SoundFadedOut и m_SoundFadeOutDuration.

Event_OnFrameUpdate()

override void Event_OnFrameUpdate ( float time_delta )

inlineprotected

Event called on frame when enabled by SetEnableEventFrame(true)

Заметки

Is always enabled on sound

Called from SEffectManager.Event_OnFrameUpdate in MissionGameplay.OnUpdate

Аргументы

time_delta

float Time passed since the previous frame

    {
        if ( IsSoundPlaying() )
        {
            if (m_SoundDoppler != -1)
            {
                m_SoundWaveObject.SetDoppler(m_SoundDoppler);
            }   
            // FadeIn
            if ( m_SoundWaveStarting )
            {
                if ( m_SoundFadeInDuration > 0 )
                {
                    SetSoundVolume( GetSoundVolume() + (time_delta / m_SoundFadeInDuration) );
                    
                    if ( GetSoundVolume() >= m_SoundWaveVolumeMax )
                    {
                        Event_OnSoundFadeInStopped();
                        SetSoundVolume( m_SoundWaveVolumeMax );
                        m_SoundWaveStarting = false;
                    }
                }
                else
                {
                    SetSoundVolume( m_SoundWaveVolumeMax );
                    m_SoundWaveStarting = false;
                }
            }
            
            // FadeOut
            if ( m_SoundWaveStopping )
            {
                if ( m_SoundFadeOutDuration > 0 )
                {
                    if ( m_SoundFadeOutInitVolume == 0 )
                    {
                        m_SoundFadeOutInitVolume = GetSoundVolume();
                        Event_OnSoundFadeOutStarted();
                    }
                    SetSoundVolume( GetSoundVolume() - (m_SoundFadeOutInitVolume / m_SoundFadeOutDuration * time_delta) );
                }
                else
                {
                    SetSoundVolume( 0 );
                }
                
                if ( GetSoundVolume() <= 0 )
                {       
                    if ( m_SoundWaveObject )
                    {
                        m_SoundWaveObject.Stop();
                        m_SoundWaveStopping = false;
                        m_SoundFadedOut = true;
                    }
                }
            }
            
            // Counting timer here because loop play
            m_SoundWaveTime += time_delta;
        }
    }

Перекрестные ссылки Event_OnSoundFadeInStopped, Event_OnSoundFadeOutStarted, GetSoundVolume(), IsSoundPlaying(), m_SoundDoppler, m_SoundFadedOut, m_SoundFadeInDuration, m_SoundFadeOutDuration, m_SoundFadeOutInitVolume, m_SoundWaveObject, m_SoundWaveStarting, m_SoundWaveStopping, m_SoundWaveTime, m_SoundWaveVolumeMax, AbstractWave::SetDoppler(), SetSoundVolume() и AbstractWave::Stop().

Event_OnRegistered()

override void Event_OnRegistered ( int id )

inlineprotected

Event called from SEffectManager when the Effect is registered.

Заметки

Should only ever be called by SEffectManager!

Аргументы

id	int ID registered in SEffectManager

    {
        super.Event_OnRegistered(id);
        
        Event_OnSoundWaveEnded.Insert( SEffectManager.Event_OnSoundWaveEnded );
    }

Перекрестные ссылки SEffectManager::Event_OnSoundWaveEnded() и Event_OnSoundWaveEnded.

Event_OnSoundFadeInStopped()

void Event_OnSoundFadeInStopped ( )

inlineprotected

Event called when sound fade in stops.

Заметки

Called from Event_OnFrameUpdate

    {
        Event_OnSoundFadeInStopped.Invoke(this);
    }

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

Event_OnSoundFadeOutStarted()

void Event_OnSoundFadeOutStarted ( )

inlineprotected

Event called when sound fade out starts.

Заметки

Called from Event_OnFrameUpdate

    {
        Event_OnSoundFadeOutStarted.Invoke(this);
    }

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

Event_OnSoundWaveEnded()

void Event_OnSoundWaveEnded ( )

inlineprotected

Event called when sound stops playing.

Заметки

Inserted into events of m_SoundWaveObject

    {
        m_SoundWaveIsPlaying = false;
        
        Event_OnSoundWaveEnded.Invoke(this);
        
        Event_OnEffectEnded();
    }

Перекрестные ссылки Event_OnEffectEnded, Event_OnSoundWaveEnded и m_SoundWaveIsPlaying.

Event_OnSoundWaveStarted()

void Event_OnSoundWaveStarted ( )

inlineprotected

Event called when sound starts playing.

Заметки

Inserted into events of m_SoundWaveObject

    {
        m_SoundWaveIsPlaying = true;
        
        Event_OnSoundWaveStarted.Invoke(this);
        
        Event_OnEffectStarted();
    }

Перекрестные ссылки Event_OnEffectStarted, Event_OnSoundWaveStarted и m_SoundWaveIsPlaying.

Event_OnUnregistered()

override void Event_OnUnregistered ( )

inlineprotected

Event called from SEffectManager when the Effect is unregistered.

Заметки

Should only ever be called by SEffectManager!

    {
        super.Event_OnUnregistered();
        
        Event_OnSoundWaveEnded.Remove( SEffectManager.Event_OnSoundWaveEnded );
    }

Перекрестные ссылки SEffectManager::Event_OnSoundWaveEnded() и Event_OnSoundWaveEnded.

GetCurrentLocalPosition()

override vector GetCurrentLocalPosition ( )

inlineprotected

Get the current local position of the managed sound.

Возвращает

vector The current local position of the managed sound

    {
        Object parent = GetParent();
        
        if (m_SoundObject)
        {
            //TODO(kumarjac): Create and expose 'SoundObject.GetLocalPosition'
            if (parent)
                return parent.WorldToModel(m_SoundObject.GetPosition());
            else
                return m_SoundObject.GetPosition();
        }
        else
        {
            if (parent)
                return GetLocalPosition();
            else
                return GetPosition();
        }
        
        return vector.Zero;
    }

Перекрестные ссылки GetLocalPosition(), GetParent(), GetPosition, m_SoundObject и vector::Zero.

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

GetCurrentParent()

override Object GetCurrentParent ( )

inlineprotected

Get parent for the EffectSound.

Заметки

There is no real parenting with sound, so the setters and getters for parents do the exact same

Возвращает

Object The parent for the EffectSound

    {
        if (m_SoundObject)
            return Object.Cast(m_SoundObject.GetParent());
        else
            return super.GetParent(); // Yes, intentionally this one
    }

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

GetCurrentPosition()

override vector GetCurrentPosition ( )

inlineprotected

Get the current world position of the managed sound.

Возвращает

vector The current world position of the managed sound

    {
        if (m_SoundObject)
            return m_SoundObject.GetPosition();
        
        if (m_ParentObject)
            return m_ParentObject.ModelToWorld(GetPosition());
 
        return GetPosition();
    }

Перекрестные ссылки GetPosition, m_ParentObject и m_SoundObject.

GetDebugName()

override string GetDebugName ( )

inlineprotected

Override when getting debug information.

    {
        string identifier;
        if (m_SoundSetName != "")
        {
            identifier = m_SoundSetName;
        }
        else
        {
            identifier = "NO_SOUNDSET";
        }
        
        return string.Format("%1:%2", super.GetDebugName(), identifier);
    }

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

GetEffectType()

override EffectType GetEffectType ( )

inlineprotected

Get what type of effect the Effect is.

Возвращает

EffectType What type of effect the Effect is

    {
        return EffectType.SOUND;
    }

GetParent()

override Object GetParent ( )

inlineprotected

Get parent for the EffectSound.

Возвращает

Object The parent for the EffectSound

    {
        if (m_SoundObject)
            return Object.Cast(m_SoundObject.GetParent());
        else
            return super.GetParent();
    }

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

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

GetSoundSet()

string GetSoundSet ( )

inlineprotected

Get soundset for the sound.

Возвращает

string Name of the soundset

    {
        return m_SoundSetName;
    }

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

GetSoundVolume()

float GetSoundVolume ( )

inlineprotected

Get the RELATIVE volume set by 'SetSoundVolume'.

Возвращает

float The relative volume for the sound set by 'SetSoundVolume'

    {
        return m_SoundWaveVolume;
    }

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

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

GetSoundWaveLenght()

float GetSoundWaveLenght ( )

inlineprotected

Get the sound wave length.

Заметки

Legacy, exists for backwards compatibility

Возвращает

float The sound wave length

    {
        return GetSoundWaveLength();
    }

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

GetSoundWaveLength()

float GetSoundWaveLength ( )

inlineprotected

Get the sound wave length.

Возвращает

float The sound wave length

    {
        return m_SoundWaveLenght;
    }

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

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

GetSoundWaveTime()

float GetSoundWaveTime ( )

inlineprotected

Get the time since EffectSound started playing.

Предупреждения

May not reflect the actual time of the sound, as it can start at negative time to simulate speed of sound

Возвращает

float The time since EffectSound started playing

    {
        return m_SoundWaveTime;
    }

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

InitEffect()

override void InitEffect ( )

inlineprotected

init

    {
        super.InitEffect();
        
        // These will be called by the sound events
        Event_OnStarted.Remove(Event_OnEffectStarted);
        Event_OnStopped.Remove(Event_OnEffectEnded);
    }

Перекрестные ссылки Event_OnEffectEnded, Event_OnEffectStarted, Event_OnStarted и Event_OnStopped.

IsAutodestroy()

override bool IsAutodestroy ( )

inlineprotected

Get whether Effect automatically cleans up when it stops.

Возвращает

bool Whether Effect automatically cleans up when it stops

    {
        return IsSoundAutodestroy();
    }

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

IsPlaying()

override bool IsPlaying ( )

inlineprotected

Returns true when the effect is playing, false otherwise.

    {
        return IsSoundPlaying(); // Just in case, as that's what used to be the actual way to check
    }

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

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

IsSound()

override bool IsSound ( )

inlineprotected

Check whether the Effect is EffectSound without casting.

Возвращает

bool Whether the Effect is EffectSound

    {
        return true;
    }

IsSoundAutodestroy()

bool IsSoundAutodestroy ( )

inlineprotected

Get whether EffectSound automatically cleans up when sound stops.

Возвращает

bool Whether EffectSound automatically cleans up when sound stops

    {
        return m_SoundAutodestroy;
    }

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

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

IsSoundPlaying()

bool IsSoundPlaying ( )

inlineprotected

Get whether EffectSound is currently playing.

Возвращает

bool Whether EffectSound is currently playing

    {
        return m_SoundWaveIsPlaying;
    }

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

Используется в Event_OnFrameUpdate(), IsPlaying(), InventoryItem::OnRPC(), ActionBuildShelter::PlayActionLoopSound(), PlayEmptyingLoopSound(), PlayPouringLoopSound() и SoundStop().

IsSoundValid()

bool IsSoundValid ( )

inlineprotected

Helper for checking if params are valid.

    {
        return m_SoundParams.IsValid();
    }

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

SetAutodestroy()

override void SetAutodestroy ( bool auto_destroy )

inlineprotected

Sets whether Effect automatically cleans up when it stops.

Заметки

This means that it will be unregistered from SEffectManager as well

Аргументы

auto_destroy

bool Whether Effect automatically cleans up when it stops

    {
        super.SetAutodestroy(auto_destroy);
        m_SoundAutodestroy = auto_destroy;      
    }

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

Используется в InventoryItem::PlayDeployFinishSound(), InventoryItem::PlayDeployLoopSoundEx(), InventoryItem::PlayDeploySound(), InventoryItem::PlayPlaceSound(), FlashbangEffect::PlaySound(), PlaySound() и SetSoundAutodestroy().

SetCurrentLocalPosition()

override void SetCurrentLocalPosition ( vector pos, bool updateCached = true )

inlineprotected

Set the current local position of the managed sound.

Аргументы

pos	vector The current local position for the managed sound
updateCached	bool Whether to update the cached variable

    {
        super.SetCurrentLocalPosition(pos, updateCached);
                
        if (m_SoundObject)
        {
            m_SoundObject.SetPosition(pos);
        }
    }

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

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

SetCurrentPosition()

override void SetCurrentPosition ( vector pos, bool updateCached = true )

inlineprotected

Set the world position of the managed sound.

Аргументы

pos	vector The world position of the managed sound
updateCached	bool Whether to update the cached variable

    {
        super.SetCurrentPosition(pos, updateCached);
        
        if (m_SoundObject)
        {
            Object parent = GetParent();
            
            if (parent)
                pos = parent.WorldToModel(pos);
 
            m_SoundObject.SetPosition(pos);
        }
    }

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

SetDoppler()

void SetDoppler ( bool setDoppler )

inlineprotected

Set if the sound has the doppler effect enabled.

Аргументы

setDoppler

float If the doppler effect is enabled

bool is a fancy int, ensure the bool is 0 or 1 and don't allow -1 here since resetting isn't supported

    {
        m_SoundDoppler = 0;
        if (setDoppler)
        {
            m_SoundDoppler = 1;
        }
    }

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

SetEnviromentVariables()

void SetEnviromentVariables ( bool setEnvVariables )

inlineprotected

Sets whether AddEnvSoundVariables needs to be called during Loading.

Аргументы

setEnvVariables

bool Whether AddEnvSoundVariables is called

    {
        m_SetEnvVariables = setEnvVariables;
    }   

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

SetParent()

override void SetParent ( Object parent_obj )

inlineprotected

Set parent for the sound to follow.

Аргументы

parent_obj

Object The parent for the sound to follow

    {
        super.SetParent(parent_obj); // ...
 
        if (m_SoundObject)
        {
            m_SoundObject.SetParent(parent_obj);
        }
    }

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

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

SetSoundAutodestroy()

void SetSoundAutodestroy ( bool auto_destroy )

inlineprotected

Sets whether EffectSound automatically cleans up when sound stops.

Аргументы

auto_destroy

bool Whether EffectSound automatically cleans up when sound stops

    {
        SetAutodestroy(auto_destroy);
    }

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

SetSoundFadeIn()

void SetSoundFadeIn ( float fade_in )

inlineprotected

Set the sound fade in duration.

Аргументы

fade_in

float The fade in duration

    {
        m_SoundFadeInDuration = fade_in;
    }

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

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

SetSoundFadeOut()

void SetSoundFadeOut ( float fade_out )

inlineprotected

Set the sound fade out duration.

Аргументы

fade_out

float The fade out duration

    {
        m_SoundFadeOutDuration = fade_out;
    }

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

Используется в FlashbangEffect::PlaySound(), ActionBuildShelter::StopActionLoopSound() и InventoryItem::StopDeployLoopSoundEx().

SetSoundLoop()

void SetSoundLoop ( bool loop )

inlineprotected

Set if the sound loops.

Аргументы

loop	bool Whether the sound should loop

    {
        m_SoundLoop = loop;
        
        if ( m_SoundWaveObject )
            m_SoundWaveObject.Loop( loop );
    }

Перекрестные ссылки AbstractWave::Loop(), m_SoundLoop и m_SoundWaveObject.

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

SetSoundMaxVolume()

void SetSoundMaxVolume ( float volume )

inlineprotected

Set the sound max volume.

Предупреждения

Seems to purely be used for fade in effect, rather than really setting the max volume...

Adjusts the current volume to this value as well

Аргументы

volume

float The maximum volume for the sound

    {
        m_SoundWaveVolumeMax = volume;
        if ( m_SoundWaveObject )
            m_SoundWaveObject.SetVolumeRelative( m_SoundWaveVolume );
    }

Перекрестные ссылки m_SoundWaveObject, m_SoundWaveVolume, m_SoundWaveVolumeMax и AbstractWave::SetVolumeRelative().

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

SetSoundSet()

void SetSoundSet ( string snd )

inlineprotected

Set soundset for the sound.

Заметки

Needs to be set before playing

Аргументы

snd	string Name of the soundset to play

    {
        m_SoundSetName = snd;
    }

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

SetSoundVolume()

void SetSoundVolume ( float volume )

inlineprotected

Set the RELATIVE volume for the sound.

Аргументы

volume

float The relative volume for the sound

    {
        m_SoundWaveVolume = volume;
        if ( m_SoundWaveObject )
            m_SoundWaveObject.SetVolumeRelative( volume );
    }

Перекрестные ссылки m_SoundWaveObject, m_SoundWaveVolume и AbstractWave::SetVolumeRelative().

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

SetSoundWaveKind()

void SetSoundWaveKind ( WaveKind wave_kind )

inlineprotected

Set WaveKind for the sound.

Заметки

Needs to be set before playing

Аргументы

wave_kind

WaveKind The WaveKind for the sound

    {
        m_SoundWaveKind = wave_kind;
    }

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

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

SoundError()

void SoundError ( string err_msg )

inlineprotected

Helper for throwing sound errors.

    {
        ErrorEx(string.Format("%1: SoundSetName: '%2' :: %3", this, m_SoundSetName, err_msg));
    }

Перекрестные ссылки ErrorEx и m_SoundSetName.

Используется в SoundLoadEx(), SoundPlayEx() и SoundWaveValidation().

SoundLoad()

bool SoundLoad ( )

inlineprotected

Loads in the sound when it is requested for playing.

Заметки

Legacy, backwards compatibility

    {
        SoundParams params;
        return SoundLoadEx(params);
    }

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

SoundLoadEx()

bool SoundLoadEx ( out SoundParams params )

inlineprotected

Loads in the sound when it is requested for playing through 'SoundPlayEx'.

Аргументы

params

SoundParams Possibility of passing in an already existing SoundParams, else one will get created

    {       
        if ( !m_SoundParams || !m_SoundParams.IsValid() )
        {
            if (!params)
            {
                params = new SoundParams( m_SoundSetName );
            }
            
            //Print("SoundLoad is loading..");
            m_SoundParams = params;
            if ( !m_SoundParams.IsValid() )
            {
                SoundError("Invalid sound set.");
                return false;
            }
            
            m_SoundObjectBuilder = new SoundObjectBuilder( m_SoundParams );
            if (m_SetEnvVariables)
            {
                m_SoundObjectBuilder.AddEnvSoundVariables(GetPosition());
            }
            
            m_SoundObject = m_SoundObjectBuilder.BuildSoundObject();
            
            if ( m_SoundObject )
            {
                m_SoundObject.SetKind( m_SoundWaveKind );
                m_SoundObject.SetParent( m_ParentObject );
            }
            else
            {
                SoundError("m_SoundObject is null.");
            }
        }
        else
        {
            //Print("SoundLoad is loaded.");
        }
        
        return true;
    }

Перекрестные ссылки GetPosition, m_ParentObject, m_SetEnvVariables, m_SoundObject, m_SoundObjectBuilder, m_SoundParams, m_SoundSetName, m_SoundWaveKind, SoundError() и SoundObjectBuilder().

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

SoundPlay()

bool SoundPlay ( )

inlineprotected

Plays sound.

Возвращает

bool Whether the sound will start playing

    {
        SoundParams params;
        return SoundPlayEx(params);
    }

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

Используется в PlayIntense(), PlayLight(), FlashbangEffect::PlaySound() и Start().

SoundPlayEx()

bool SoundPlayEx ( out SoundParams params )

inlineprotected

Plays sound.

Аргументы

params

SoundParams Sound Parameters for the sound

Возвращает

bool Whether the sound will start playing

    {
        super.Start();
        
        if (m_SoundSetName != "")
        {
            vector position = GetCurrentLocalPosition();
 
            if ( SoundLoadEx(params) )
            {
                if (m_SetEnvVariables && m_SoundParams)
                {
                    m_SoundObjectBuilder.AddEnvSoundVariables(GetPosition());
                    m_SoundObject = m_SoundObjectBuilder.BuildSoundObject();
                    m_SoundObject.SetKind( m_SoundWaveKind );
                    m_SoundObject.SetParent( m_ParentObject );
                }
                
                if ( m_SoundObject )
                {
                    SetCurrentLocalPosition(position, false);
                    m_SoundWaveObject = GetGame().GetSoundScene().Play3D( m_SoundObject, m_SoundObjectBuilder );
                    if ( !m_SoundWaveObject )
                        return false;
 
                    // Wait for header to be loaded before asking for its length, else we block the main thread
                    if (m_SoundWaveObject.IsHeaderLoaded())
                        ValidateSoundWave();
                    else
                        m_SoundWaveObject.GetEvents().Event_OnSoundWaveHeaderLoaded.Insert(ValidateSoundWave);                  
                    
                    return true;
                }
                else
                {
                    SoundError("m_SoundObject is null.");
                }
            }
        }
        
        return false;
    }

Перекрестные ссылки GetCurrentLocalPosition(), AbstractWave::GetEvents(), GetGame(), GetPosition, AbstractWave::IsHeaderLoaded(), m_ParentObject, m_SetEnvVariables, m_SoundObject, m_SoundObjectBuilder, m_SoundParams, m_SoundSetName, m_SoundWaveKind, m_SoundWaveObject, SetCurrentLocalPosition(), SoundError(), SoundLoadEx() и ValidateSoundWave().

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

SoundReset()

void SoundReset ( )

inlineprotected

Resets EffectSound.

    {
        m_IsPlaying                 = false;
        m_SoundWaveIsPlaying        = false;
        m_SoundWaveStopping         = false;
        m_SoundFadedOut             = false;
        m_SoundWaveVolume           = m_SoundWaveVolumeMax;
        m_SoundWaveTime             = 0;
        m_SoundFadeOutInitVolume    = 0;
        m_SoundFadeOutStartTime     = 0;
        
        if ( m_SoundWaveObject )
        {
            m_SoundWaveObject.Stop();
            m_SoundWaveObject.SetVolumeRelative( m_SoundWaveVolumeMax );
        }
    }

Перекрестные ссылки m_IsPlaying, m_SoundFadedOut, m_SoundFadeOutInitVolume, m_SoundFadeOutStartTime, m_SoundWaveIsPlaying, m_SoundWaveObject, m_SoundWaveStopping, m_SoundWaveTime, m_SoundWaveVolume, m_SoundWaveVolumeMax, AbstractWave::SetVolumeRelative() и AbstractWave::Stop().

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

SoundStop()

void SoundStop ( )

inlineprotected

Stops sound.

Заметки

Will not be immediately if a SoundFadeOutDuration was set

    {
        super.Stop();
        
        if ( IsSoundPlaying() )
        {
            if ( m_SoundFadeOutDuration > 0 && !m_SoundWaveStopping )
            {
                m_SoundWaveStopping = true;
                m_SoundFadedOut = false;
                m_SoundWaveStarting = false;
                m_SoundFadeOutStartTime = m_SoundWaveTime;
            }
            else
            {
                m_SoundWaveObject.Stop();
            }
        }
        else
        {
            SoundReset();
        }   
    }

Перекрестные ссылки IsSoundPlaying(), m_SoundFadedOut, m_SoundFadeOutDuration, m_SoundFadeOutStartTime, m_SoundWaveObject, m_SoundWaveStarting, m_SoundWaveStopping, m_SoundWaveTime, SoundReset() и AbstractWave::Stop().

Используется в BuildingSuper::EEDelete(), ItemBase::OnIsCharged(), PlayIntense(), PlayLight(), Stop(), ActionBuildShelter::StopActionLoopSound(), StopAllMusic(), ItemBase::StopChargedAlarm(), ItemBase::StopChargingSound(), InventoryItem::StopDeployLoopSoundEx(), StopEmptyingLoopSound(), StopPouringLoopSound(), FlashbangEffect::StopSound(), FlareSimulation::~FlareSimulation() и InventoryItem::~ItemBase().

SoundWaveValidation()

bool SoundWaveValidation ( )

inlineprotected

Validation of fade settings.

Заметки

Called from 'ValidateSoundWave'

    {
        bool valid = true;
        
        if ( m_SoundFadeInDuration > GetSoundWaveLength() )
        {
            SoundError("FadeIn is longer than sound wave length.");
            valid = false;
        }
        
        if ( m_SoundFadeOutDuration > GetSoundWaveLength() )
        {
            SoundError("FadeOut is longer than sound wave length.");
            valid = false;
        }
        
        if ( m_SoundFadeOutDuration + m_SoundFadeInDuration > GetSoundWaveLength() )
        {
            SoundError("FadeIn & FadeOut are longer than sound wave length.");
            valid = false;
        }
        
        return valid;
    }

Перекрестные ссылки GetSoundWaveLength(), m_SoundFadeInDuration, m_SoundFadeOutDuration и SoundError().

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

Start()

override void Start ( )

inlineprotected

Plays sound.

    {       
        SoundPlay();
    }

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

Stop()

override void Stop ( )

inlineprotected

Stops sound.

    {
        SoundStop();        
    }

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

Используется в Land_Underground_Stairs_Exit::HandleAudioPlayback(), FireworksLauncher::OnFiringStartClient(), FireworksLauncherClientEvent::PlayExplosionSound(), Edible_Base::SoundCookingStop() и ~UndergroundHandlerClient().

UpdateEvents()

void UpdateEvents ( )

inlineprotected

Enables the frame event on the EffectSound.

Заметки

Called from 'ValidateSoundWave' when all is successful

So this is effectively enabling frame event on all valid EffectSound

    {
        if ( m_SoundWaveObject )
        {
            SetEnableEventFrame(true);
        }
        else
        {
            SetEnableEventFrame(false);
        }
    }

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

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

ValidateSoundWave()

void ValidateSoundWave ( )

inlineprotected

Gets called to fill in the necessary data when the header has finished loading.

Заметки

Called from 'SoundPlayEx'

    {
        m_SoundWaveLenght = m_SoundWaveObject.GetLength();
                    
        if ( SoundWaveValidation() )
        {
            if ( m_SoundFadeInDuration > 0 )
            {
                m_SoundWaveObject.SetVolumeRelative( 0 );
                m_SoundFadeOutStartTime = m_SoundWaveLenght - m_SoundFadeInDuration;
            }
                        
            SetSoundLoop( m_SoundLoop );
                        
            m_SoundWaveStarting = true;
                        
            AbstractWaveEvents events = m_SoundWaveObject.GetEvents();
            events.Event_OnSoundWaveStarted.Insert( Event_OnSoundWaveStarted );
            events.Event_OnSoundWaveEnded.Insert( Event_OnSoundWaveEnded );
                        
            UpdateEvents();
        }
        else
        {
            m_SoundWaveObject.Stop();
        }
    }

Перекрестные ссылки Event_OnSoundWaveEnded, Event_OnSoundWaveStarted, AbstractWave::GetEvents(), AbstractWave::GetLength(), m_SoundFadeInDuration, m_SoundFadeOutStartTime, m_SoundLoop, m_SoundWaveLenght, m_SoundWaveObject, m_SoundWaveStarting, SetSoundLoop(), AbstractWave::SetVolumeRelative(), SoundWaveValidation(), AbstractWave::Stop() и UpdateEvents().

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

Поля

Event_OnSoundFadeInStopped

ref ScriptInvoker Event_OnSoundFadeInStopped = new ScriptInvoker()

private

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

Event_OnSoundFadeOutStarted

ref ScriptInvoker Event_OnSoundFadeOutStarted = new ScriptInvoker()

private

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

Event_OnSoundWaveEnded

ref ScriptInvoker Event_OnSoundWaveEnded = new ScriptInvoker()

private

Используется в Event_OnRegistered(), Event_OnSoundWaveEnded(), Event_OnUnregistered() и ValidateSoundWave().

Event_OnSoundWaveStarted

ref ScriptInvoker Event_OnSoundWaveStarted = new ScriptInvoker()

private

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

m_SetEnvVariables

bool m_SetEnvVariables

protected

Используется в SetEnviromentVariables(), SoundLoadEx() и SoundPlayEx().

m_SoundAutodestroy

bool m_SoundAutodestroy

protected

Используется в EffectSound(), IsSoundAutodestroy() и SetAutodestroy().

m_SoundDoppler

int m_SoundDoppler

protected

Используется в EffectSound(), Event_OnFrameUpdate() и SetDoppler().

m_SoundFadedOut

bool m_SoundFadedOut

protected

Используется в CanDestroy(), EffectSound(), Event_OnFrameUpdate(), SoundReset() и SoundStop().

m_SoundFadeInDuration

float m_SoundFadeInDuration

protected

Используется в Event_OnFrameUpdate(), SetSoundFadeIn(), SoundWaveValidation() и ValidateSoundWave().

m_SoundFadeOutDuration

float m_SoundFadeOutDuration

protected

Используется в CanDestroy(), Event_OnFrameUpdate(), SetSoundFadeOut(), SoundStop() и SoundWaveValidation().

m_SoundFadeOutInitVolume

float m_SoundFadeOutInitVolume

protected

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

m_SoundFadeOutStartTime

float m_SoundFadeOutStartTime

protected

Используется в SoundReset(), SoundStop() и ValidateSoundWave().

m_SoundLoop

bool m_SoundLoop

protected

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

m_SoundObject

ref SoundObject m_SoundObject

protected

Используется в GetCurrentLocalPosition(), GetCurrentParent(), GetCurrentPosition(), GetParent(), SetCurrentLocalPosition(), SetCurrentPosition(), SetParent(), SoundLoadEx() и SoundPlayEx().

m_SoundObjectBuilder

ref SoundObjectBuilder m_SoundObjectBuilder

protected

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

m_SoundParams

ref SoundParams m_SoundParams

protected

Используется в IsSoundValid(), SoundLoadEx() и SoundPlayEx().

m_SoundSetName

string m_SoundSetName

protected

Используется в GetDebugName(), GetSoundSet(), SetSoundSet(), SoundError(), SoundLoadEx() и SoundPlayEx().

m_SoundWaveIsPlaying

bool m_SoundWaveIsPlaying

protected

Используется в Event_OnSoundWaveEnded(), Event_OnSoundWaveStarted(), IsSoundPlaying() и SoundReset().

m_SoundWaveKind

WaveKind m_SoundWaveKind

protected

Используется в EffectSound(), SetSoundWaveKind(), SoundLoadEx() и SoundPlayEx().

m_SoundWaveLenght

float m_SoundWaveLenght

protected

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

m_SoundWaveObject

AbstractWave m_SoundWaveObject

protected

Используется в Event_OnFrameUpdate(), SetSoundLoop(), SetSoundMaxVolume(), SetSoundVolume(), SoundPlayEx(), SoundReset(), SoundStop(), UpdateEvents() и ValidateSoundWave().

m_SoundWaveStarting

bool m_SoundWaveStarting

protected

Используется в Event_OnFrameUpdate(), SoundStop() и ValidateSoundWave().

m_SoundWaveStopping

bool m_SoundWaveStopping

protected

Используется в EffectSound(), Event_OnFrameUpdate(), SoundReset() и SoundStop().

m_SoundWaveTime

float m_SoundWaveTime

protected

Используется в Event_OnFrameUpdate(), GetSoundWaveTime(), SoundReset() и SoundStop().

m_SoundWaveVolume

float m_SoundWaveVolume

protected

Используется в EffectSound(), GetSoundVolume(), SetSoundMaxVolume(), SetSoundVolume() и SoundReset().

m_SoundWaveVolumeMax

float m_SoundWaveVolumeMax

protected

Используется в EffectSound(), Event_OnFrameUpdate(), SetSoundMaxVolume() и SoundReset().

---

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

• D:/Ishodniki/scripts/3_Game/Effects/EffectSound.c