EffectSound Class Reference

Wrapper class for managing sound through SEffectManager. More...

Inheritance diagram for EffectSound:

Collaboration diagram for EffectSound:

Protected Member Functions
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.

Protected Attributes
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

Private Attributes
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.

Detailed Description

Wrapper class for managing sound through SEffectManager.

Definition at line 4 of file EffectSound.c.

Constructor & Destructor Documentation

EffectSound()

void EffectSound::EffectSound ( )

inlineprotected

ctor

Definition at line 62 of file EffectSound.c.

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

References m_SoundAutodestroy, m_SoundDoppler, m_SoundFadedOut, m_SoundWaveKind, m_SoundWaveStopping, m_SoundWaveVolume, and m_SoundWaveVolumeMax.

~EffectSound()

void EffectSound::~EffectSound ( )

inlineprotected

dtor

Definition at line 76 of file EffectSound.c.

  {
 
  }

Member Function Documentation

CanDestroy()

override bool EffectSound::CanDestroy ( )

inlineprotected

Definition at line 598 of file EffectSound.c.

  {
    return m_SoundFadeOutDuration <= 0 || m_SoundFadedOut;
  }

References m_SoundFadedOut, and m_SoundFadeOutDuration.

Event_OnFrameUpdate()

override void EffectSound::Event_OnFrameUpdate ( float time_delta )

inlineprotected

Event called on frame when enabled by SetEnableEventFrame(true)

Note

Is always enabled on sound

Called from SEffectManager.Event_OnFrameUpdate in MissionGameplay.OnUpdate

Parameters

time_delta

float Time passed since the previous frame

Definition at line 427 of file EffectSound.c.

  {
    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;
    }
  }

References 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(), and AbstractWave::Stop().

Event_OnRegistered()

override void EffectSound::Event_OnRegistered ( int id )

inlineprotected

Event called from SEffectManager when the Effect is registered.

Note

Should only ever be called by SEffectManager!

Parameters

id	int ID registered in SEffectManager

Definition at line 490 of file EffectSound.c.

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

References SEffectManager::Event_OnSoundWaveEnded(), and Event_OnSoundWaveEnded.

Event_OnSoundFadeInStopped()

void EffectSound::Event_OnSoundFadeInStopped ( )

inlineprotected

Event called when sound fade in stops.

Note

Called from Event_OnFrameUpdate

Definition at line 538 of file EffectSound.c.

  {
    Event_OnSoundFadeInStopped.Invoke(this);
  }

References Event_OnSoundFadeInStopped.

Event_OnSoundFadeOutStarted()

void EffectSound::Event_OnSoundFadeOutStarted ( )

inlineprotected

Event called when sound fade out starts.

Note

Called from Event_OnFrameUpdate

Definition at line 547 of file EffectSound.c.

  {
    Event_OnSoundFadeOutStarted.Invoke(this);
  }

References Event_OnSoundFadeOutStarted.

Event_OnSoundWaveEnded()

void EffectSound::Event_OnSoundWaveEnded ( )

inlineprotected

Event called when sound stops playing.

Note

Inserted into events of m_SoundWaveObject

Definition at line 525 of file EffectSound.c.

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

References Event_OnEffectEnded, Event_OnSoundWaveEnded, and m_SoundWaveIsPlaying.

Event_OnSoundWaveStarted()

void EffectSound::Event_OnSoundWaveStarted ( )

inlineprotected

Event called when sound starts playing.

Note

Inserted into events of m_SoundWaveObject

Definition at line 512 of file EffectSound.c.

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

References Event_OnEffectStarted, Event_OnSoundWaveStarted, and m_SoundWaveIsPlaying.

Event_OnUnregistered()

override void EffectSound::Event_OnUnregistered ( )

inlineprotected

Event called from SEffectManager when the Effect is unregistered.

Note

Should only ever be called by SEffectManager!

Definition at line 501 of file EffectSound.c.

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

References SEffectManager::Event_OnSoundWaveEnded(), and Event_OnSoundWaveEnded.

GetCurrentLocalPosition()

override vector EffectSound::GetCurrentLocalPosition ( )

inlineprotected

Get the current local position of the managed sound.

Returns

vector The current local position of the managed sound

Definition at line 700 of file EffectSound.c.

  {
    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;
  }

References GetLocalPosition(), GetParent(), GetPosition, m_SoundObject, and vector::Zero.

Referenced by SoundPlayEx().

GetCurrentParent()

override Object EffectSound::GetCurrentParent ( )

inlineprotected

Get parent for the EffectSound.

Note

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

Returns

Object The parent for the EffectSound

Definition at line 640 of file EffectSound.c.

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

References m_SoundObject.

GetCurrentPosition()

override vector EffectSound::GetCurrentPosition ( )

inlineprotected

Get the current world position of the managed sound.

Returns

vector The current world position of the managed sound

Definition at line 672 of file EffectSound.c.

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

References GetPosition, m_ParentObject, and m_SoundObject.

GetDebugName()

override string EffectSound::GetDebugName ( )

inlineprotected

Override when getting debug information.

Definition at line 96 of file EffectSound.c.

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

References m_SoundSetName.

GetEffectType()

override EffectType EffectSound::GetEffectType ( )

inlineprotected

Get what type of effect the Effect is.

Returns

EffectType What type of effect the Effect is

Definition at line 117 of file EffectSound.c.

  {
    return EffectType.SOUND;
  }

GetParent()

override Object EffectSound::GetParent ( )

inlineprotected

Get parent for the EffectSound.

Returns

Object The parent for the EffectSound

Definition at line 627 of file EffectSound.c.

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

References m_SoundObject.

Referenced by GetCurrentLocalPosition(), and SetCurrentPosition().

GetSoundSet()

string EffectSound::GetSoundSet ( )

inlineprotected

Get soundset for the sound.

Returns

string Name of the soundset

Definition at line 747 of file EffectSound.c.

  {
    return m_SoundSetName;
  }

References m_SoundSetName.

GetSoundVolume()

float EffectSound::GetSoundVolume ( )

inlineprotected

Get the RELATIVE volume set by 'SetSoundVolume'.

Returns

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

Definition at line 807 of file EffectSound.c.

  {
    return m_SoundWaveVolume;
  }

References m_SoundWaveVolume.

Referenced by Event_OnFrameUpdate().

GetSoundWaveLenght()

float EffectSound::GetSoundWaveLenght ( )

inlineprotected

Get the sound wave length.

Note

Legacy, exists for backwards compatibility

Returns

float The sound wave length

Definition at line 778 of file EffectSound.c.

  {
    return GetSoundWaveLength();
  }

References GetSoundWaveLength().

GetSoundWaveLength()

float EffectSound::GetSoundWaveLength ( )

inlineprotected

Get the sound wave length.

Returns

float The sound wave length

Definition at line 787 of file EffectSound.c.

  {
    return m_SoundWaveLenght;
  }

References m_SoundWaveLenght.

Referenced by GetSoundWaveLenght(), and SoundWaveValidation().

GetSoundWaveTime()

float EffectSound::GetSoundWaveTime ( )

inlineprotected

Get the time since EffectSound started playing.

Warning

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

Returns

float The time since EffectSound started playing

Definition at line 830 of file EffectSound.c.

  {
    return m_SoundWaveTime;
  }

References m_SoundWaveTime.

InitEffect()

override void EffectSound::InitEffect ( )

inlineprotected

init

Definition at line 84 of file EffectSound.c.

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

References Event_OnEffectEnded, Event_OnEffectStarted, Event_OnStarted, and Event_OnStopped.

IsAutodestroy()

override bool EffectSound::IsAutodestroy ( )

inlineprotected

Get whether Effect automatically cleans up when it stops.

Returns

bool Whether Effect automatically cleans up when it stops

Definition at line 575 of file EffectSound.c.

  {
    return IsSoundAutodestroy();
  }

References IsSoundAutodestroy().

IsPlaying()

override bool EffectSound::IsPlaying ( )

inlineprotected

Returns true when the effect is playing, false otherwise.

Definition at line 269 of file EffectSound.c.

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

References IsSoundPlaying().

Referenced by FlashbangEffect::PlaySound().

IsSound()

override bool EffectSound::IsSound ( )

inlineprotected

Check whether the Effect is EffectSound without casting.

Returns

bool Whether the Effect is EffectSound

Definition at line 126 of file EffectSound.c.

  {
    return true;
  }

IsSoundAutodestroy()

bool EffectSound::IsSoundAutodestroy ( )

inlineprotected

Get whether EffectSound automatically cleans up when sound stops.

Returns

bool Whether EffectSound automatically cleans up when sound stops

Definition at line 593 of file EffectSound.c.

  {
    return m_SoundAutodestroy;
  }

References m_SoundAutodestroy.

Referenced by IsAutodestroy().

IsSoundPlaying()

bool EffectSound::IsSoundPlaying ( )

inlineprotected

Get whether EffectSound is currently playing.

Returns

bool Whether EffectSound is currently playing

Definition at line 261 of file EffectSound.c.

  {
    return m_SoundWaveIsPlaying;
  }

References m_SoundWaveIsPlaying.

Referenced by Event_OnFrameUpdate(), IsPlaying(), InventoryItem::OnRPC(), ActionBuildShelter::PlayActionLoopSound(), PlayEmptyingLoopSound(), PlayPouringLoopSound(), and SoundStop().

IsSoundValid()

bool EffectSound::IsSoundValid ( )

inlineprotected

Helper for checking if params are valid.

Definition at line 336 of file EffectSound.c.

  {
    return m_SoundParams.IsValid();
  }

References m_SoundParams.

SetAutodestroy()

override void EffectSound::SetAutodestroy ( bool auto_destroy )

inlineprotected

Sets whether Effect automatically cleans up when it stops.

Note

This means that it will be unregistered from SEffectManager as well

Parameters

auto_destroy

bool Whether Effect automatically cleans up when it stops

Definition at line 565 of file EffectSound.c.

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

References m_SoundAutodestroy.

Referenced by InventoryItem::PlayDeployFinishSound(), InventoryItem::PlayDeployLoopSoundEx(), InventoryItem::PlayDeploySound(), InventoryItem::PlayPlaceSound(), FlashbangEffect::PlaySound(), PlaySound(), and SetSoundAutodestroy().

SetCurrentLocalPosition()

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

inlineprotected

Set the current local position of the managed sound.

Parameters

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

Definition at line 688 of file EffectSound.c.

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

References m_SoundObject.

Referenced by SoundPlayEx().

SetCurrentPosition()

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

inlineprotected

Set the world position of the managed sound.

Parameters

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

Definition at line 653 of file EffectSound.c.

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

References GetParent(), and m_SoundObject.

SetDoppler()

void EffectSound::SetDoppler ( bool setDoppler )

inlineprotected

Set if the sound has the doppler effect enabled.

Parameters

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

Definition at line 857 of file EffectSound.c.

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

References m_SoundDoppler.

SetEnviromentVariables()

void EffectSound::SetEnviromentVariables ( bool setEnvVariables )

inlineprotected

Sets whether AddEnvSoundVariables needs to be called during Loading.

Parameters

setEnvVariables

bool Whether AddEnvSoundVariables is called

Definition at line 768 of file EffectSound.c.

  {
    m_SetEnvVariables = setEnvVariables;
  }

References m_SetEnvVariables.

SetParent()

override void EffectSound::SetParent ( Object parent_obj )

inlineprotected

Set parent for the sound to follow.

Parameters

parent_obj

Object The parent for the sound to follow

Definition at line 615 of file EffectSound.c.

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

References m_SoundObject.

Referenced by FlashbangEffect::PlaySound().

SetSoundAutodestroy()

void EffectSound::SetSoundAutodestroy ( bool auto_destroy )

inlineprotected

Sets whether EffectSound automatically cleans up when sound stops.

Parameters

auto_destroy

bool Whether EffectSound automatically cleans up when sound stops

Definition at line 584 of file EffectSound.c.

  {
    SetAutodestroy(auto_destroy);
  }

References SetAutodestroy().

SetSoundFadeIn()

void EffectSound::SetSoundFadeIn ( float fade_in )

inlineprotected

Set the sound fade in duration.

Parameters

fade_in

float The fade in duration

Definition at line 839 of file EffectSound.c.

  {
    m_SoundFadeInDuration = fade_in;
  }

References m_SoundFadeInDuration.

Referenced by FlashbangEffect::PlaySound().

SetSoundFadeOut()

void EffectSound::SetSoundFadeOut ( float fade_out )

inlineprotected

Set the sound fade out duration.

Parameters

fade_out

float The fade out duration

Definition at line 848 of file EffectSound.c.

  {
    m_SoundFadeOutDuration = fade_out;
  }

References m_SoundFadeOutDuration.

Referenced by FlashbangEffect::PlaySound(), ActionBuildShelter::StopActionLoopSound(), and InventoryItem::StopDeployLoopSoundEx().

SetSoundLoop()

void EffectSound::SetSoundLoop ( bool loop )

inlineprotected

Set if the sound loops.

Parameters

loop	bool Whether the sound should loop

Definition at line 756 of file EffectSound.c.

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

References AbstractWave::Loop(), m_SoundLoop, and m_SoundWaveObject.

Referenced by FlashbangEffect::PlaySound(), and ValidateSoundWave().

SetSoundMaxVolume()

void EffectSound::SetSoundMaxVolume ( float volume )

inlineprotected

Set the sound max volume.

Warning

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

Parameters

volume

float The maximum volume for the sound

Definition at line 818 of file EffectSound.c.

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

References m_SoundWaveObject, m_SoundWaveVolume, m_SoundWaveVolumeMax, and AbstractWave::SetVolumeRelative().

Referenced by FlashbangEffect::PlaySound().

SetSoundSet()

void EffectSound::SetSoundSet ( string snd )

inlineprotected

Set soundset for the sound.

Note

Needs to be set before playing

Parameters

snd	string Name of the soundset to play

Definition at line 738 of file EffectSound.c.

  {
    m_SoundSetName = snd;
  }

References m_SoundSetName.

SetSoundVolume()

void EffectSound::SetSoundVolume ( float volume )

inlineprotected

Set the RELATIVE volume for the sound.

Parameters

volume

float The relative volume for the sound

Definition at line 796 of file EffectSound.c.

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

References m_SoundWaveObject, m_SoundWaveVolume, and AbstractWave::SetVolumeRelative().

Referenced by Event_OnFrameUpdate(), and ProcessSound().

SetSoundWaveKind()

void EffectSound::SetSoundWaveKind ( WaveKind wave_kind )

inlineprotected

Set WaveKind for the sound.

Note

Needs to be set before playing

Parameters

wave_kind

WaveKind The WaveKind for the sound

Definition at line 728 of file EffectSound.c.

  {
    m_SoundWaveKind = wave_kind;
  }

References m_SoundWaveKind.

Referenced by FlashbangEffect::PlaySound().

SoundError()

void EffectSound::SoundError ( string err_msg )

inlineprotected

Helper for throwing sound errors.

Definition at line 871 of file EffectSound.c.

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

References ErrorEx, and m_SoundSetName.

Referenced by SoundLoadEx(), SoundPlayEx(), and SoundWaveValidation().

SoundLoad()

bool EffectSound::SoundLoad ( )

inlineprotected

Loads in the sound when it is requested for playing.

Note

Legacy, backwards compatibility

Definition at line 327 of file EffectSound.c.

  {
    SoundParams params;
    return SoundLoadEx(params);
  }

References SoundLoadEx().

SoundLoadEx()

bool EffectSound::SoundLoadEx ( out SoundParams params )

inlineprotected

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

Parameters

params

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

Definition at line 286 of file EffectSound.c.

  {
    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;
  }

References GetPosition, m_ParentObject, m_SetEnvVariables, m_SoundObject, m_SoundObjectBuilder, m_SoundParams, m_SoundSetName, m_SoundWaveKind, SoundError(), and SoundObjectBuilder().

Referenced by SoundLoad(), and SoundPlayEx().

SoundPlay()

bool EffectSound::SoundPlay ( )

inlineprotected

Plays sound.

Returns

bool Whether the sound will start playing

Definition at line 190 of file EffectSound.c.

  {
    SoundParams params;
    return SoundPlayEx(params);
  }

References SoundPlayEx().

Referenced by PlayIntense(), PlayLight(), FlashbangEffect::PlaySound(), and Start().

SoundPlayEx()

bool EffectSound::SoundPlayEx ( out SoundParams params )

inlineprotected

Plays sound.

Parameters

params

SoundParams Sound Parameters for the sound

Returns

bool Whether the sound will start playing

Definition at line 145 of file EffectSound.c.

  {
    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;
  }

References 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(), and ValidateSoundWave().

Referenced by SoundPlay().

SoundReset()

void EffectSound::SoundReset ( )

inlineprotected

Resets EffectSound.

Definition at line 239 of file EffectSound.c.

  {
    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);
    }
  }

References m_IsPlaying, m_SoundFadedOut, m_SoundFadeOutInitVolume, m_SoundFadeOutStartTime, m_SoundWaveIsPlaying, m_SoundWaveObject, m_SoundWaveStopping, m_SoundWaveTime, m_SoundWaveVolume, m_SoundWaveVolumeMax, AbstractWave::SetVolumeRelative(), and AbstractWave::Stop().

Referenced by SoundStop().

SoundStop()

void EffectSound::SoundStop ( )

inlineprotected

Stops sound.

Note

Will not be immediately if a SoundFadeOutDuration was set

Definition at line 208 of file EffectSound.c.

  {
    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();
  }

References IsSoundPlaying(), m_SoundFadedOut, m_SoundFadeOutDuration, m_SoundFadeOutStartTime, m_SoundWaveObject, m_SoundWaveStarting, m_SoundWaveStopping, m_SoundWaveTime, SoundReset(), and AbstractWave::Stop().

Referenced by BuildingSuper::EEDelete(), ItemBase::OnIsCharged(), PlayIntense(), PlayLight(), Stop(), ActionBuildShelter::StopActionLoopSound(), StopAllMusic(), ItemBase::StopChargedAlarm(), ItemBase::StopChargingSound(), InventoryItem::StopDeployLoopSoundEx(), StopEmptyingLoopSound(), StopPouringLoopSound(), FlashbangEffect::StopSound(), FlareSimulation::~FlareSimulation(), and InventoryItem::~ItemBase().

SoundWaveValidation()

bool EffectSound::SoundWaveValidation ( )

inlineprotected

Validation of fade settings.

Note

Called from 'ValidateSoundWave'

Definition at line 375 of file EffectSound.c.

  {
    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;
  }

References GetSoundWaveLength(), m_SoundFadeInDuration, m_SoundFadeOutDuration, and SoundError().

Referenced by ValidateSoundWave().

Start()

override void EffectSound::Start ( )

inlineprotected

Plays sound.

Definition at line 199 of file EffectSound.c.

  {
    SoundPlay();
  }

References SoundPlay().

Stop()

override void EffectSound::Stop ( )

inlineprotected

Stops sound.

Definition at line 231 of file EffectSound.c.

  {
    SoundStop();
  }

References SoundStop().

Referenced by Land_Underground_Stairs_Exit::HandleAudioPlayback(), FireworksLauncher::OnFiringStartClient(), FireworksLauncherClientEvent::PlayExplosionSound(), Edible_Base::SoundCookingStop(), and ~UndergroundHandlerClient().

UpdateEvents()

void EffectSound::UpdateEvents ( )

inlineprotected

Enables the frame event on the EffectSound.

Note

Called from 'ValidateSoundWave' when all is successful

So this is effectively enabling frame event on all valid EffectSound

Definition at line 405 of file EffectSound.c.

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

References m_SoundWaveObject, and SetEnableEventFrame().

Referenced by ValidateSoundWave().

ValidateSoundWave()

void EffectSound::ValidateSoundWave ( )

inlineprotected

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

Note

Called from 'SoundPlayEx'

Definition at line 345 of file EffectSound.c.

  {
    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();
  }

References 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(), and UpdateEvents().

Referenced by SoundPlayEx().

Member Data Documentation

Event_OnSoundFadeInStopped

ref ScriptInvoker EffectSound::Event_OnSoundFadeInStopped = new ScriptInvoker()

private

Definition at line 12 of file EffectSound.c.

Referenced by Event_OnFrameUpdate(), and Event_OnSoundFadeInStopped().

Event_OnSoundFadeOutStarted

ref ScriptInvoker EffectSound::Event_OnSoundFadeOutStarted = new ScriptInvoker()

private

Definition at line 13 of file EffectSound.c.

Referenced by Event_OnFrameUpdate(), and Event_OnSoundFadeOutStarted().

Event_OnSoundWaveEnded

ref ScriptInvoker EffectSound::Event_OnSoundWaveEnded = new ScriptInvoker()

private

Definition at line 11 of file EffectSound.c.

Referenced by Event_OnRegistered(), Event_OnSoundWaveEnded(), Event_OnUnregistered(), and ValidateSoundWave().

Event_OnSoundWaveStarted

ref ScriptInvoker EffectSound::Event_OnSoundWaveStarted = new ScriptInvoker()

private

Definition at line 10 of file EffectSound.c.

Referenced by Event_OnSoundWaveStarted(), and ValidateSoundWave().

m_SetEnvVariables

bool EffectSound::m_SetEnvVariables

protected

Definition at line 33 of file EffectSound.c.

Referenced by SetEnviromentVariables(), SoundLoadEx(), and SoundPlayEx().

m_SoundAutodestroy

bool EffectSound::m_SoundAutodestroy

protected

Definition at line 34 of file EffectSound.c.

Referenced by EffectSound(), IsSoundAutodestroy(), and SetAutodestroy().

m_SoundDoppler

int EffectSound::m_SoundDoppler

protected

Definition at line 40 of file EffectSound.c.

Referenced by EffectSound(), Event_OnFrameUpdate(), and SetDoppler().

m_SoundFadedOut

bool EffectSound::m_SoundFadedOut

protected

Definition at line 49 of file EffectSound.c.

Referenced by CanDestroy(), EffectSound(), Event_OnFrameUpdate(), SoundReset(), and SoundStop().

m_SoundFadeInDuration

float EffectSound::m_SoundFadeInDuration

protected

Definition at line 51 of file EffectSound.c.

Referenced by Event_OnFrameUpdate(), SetSoundFadeIn(), SoundWaveValidation(), and ValidateSoundWave().

m_SoundFadeOutDuration

float EffectSound::m_SoundFadeOutDuration

protected

Definition at line 54 of file EffectSound.c.

Referenced by CanDestroy(), Event_OnFrameUpdate(), SetSoundFadeOut(), SoundStop(), and SoundWaveValidation().

m_SoundFadeOutInitVolume

float EffectSound::m_SoundFadeOutInitVolume

protected

Definition at line 55 of file EffectSound.c.

Referenced by Event_OnFrameUpdate(), and SoundReset().

m_SoundFadeOutStartTime

float EffectSound::m_SoundFadeOutStartTime

protected

Definition at line 53 of file EffectSound.c.

Referenced by SoundReset(), SoundStop(), and ValidateSoundWave().

m_SoundLoop

bool EffectSound::m_SoundLoop

protected

Definition at line 32 of file EffectSound.c.

Referenced by SetSoundLoop(), and ValidateSoundWave().

m_SoundObject

ref SoundObject EffectSound::m_SoundObject

protected

Definition at line 22 of file EffectSound.c.

Referenced by GetCurrentLocalPosition(), GetCurrentParent(), GetCurrentPosition(), GetParent(), SetCurrentLocalPosition(), SetCurrentPosition(), SetParent(), SoundLoadEx(), and SoundPlayEx().

m_SoundObjectBuilder

ref SoundObjectBuilder EffectSound::m_SoundObjectBuilder

protected

Definition at line 21 of file EffectSound.c.

Referenced by SoundLoadEx(), and SoundPlayEx().

m_SoundParams

ref SoundParams EffectSound::m_SoundParams

protected

Definition at line 20 of file EffectSound.c.

Referenced by IsSoundValid(), SoundLoadEx(), and SoundPlayEx().

m_SoundSetName

string EffectSound::m_SoundSetName

protected

Definition at line 31 of file EffectSound.c.

Referenced by GetDebugName(), GetSoundSet(), SetSoundSet(), SoundError(), SoundLoadEx(), and SoundPlayEx().

m_SoundWaveIsPlaying

bool EffectSound::m_SoundWaveIsPlaying

protected

Definition at line 35 of file EffectSound.c.

Referenced by Event_OnSoundWaveEnded(), Event_OnSoundWaveStarted(), IsSoundPlaying(), and SoundReset().

m_SoundWaveKind

WaveKind EffectSound::m_SoundWaveKind

protected

Definition at line 30 of file EffectSound.c.

Referenced by EffectSound(), SetSoundWaveKind(), SoundLoadEx(), and SoundPlayEx().

m_SoundWaveLenght

float EffectSound::m_SoundWaveLenght

protected

Definition at line 36 of file EffectSound.c.

Referenced by GetSoundWaveLength(), and ValidateSoundWave().

m_SoundWaveObject

AbstractWave EffectSound::m_SoundWaveObject

protected

Definition at line 23 of file EffectSound.c.

Referenced by Event_OnFrameUpdate(), SetSoundLoop(), SetSoundMaxVolume(), SetSoundVolume(), SoundPlayEx(), SoundReset(), SoundStop(), UpdateEvents(), and ValidateSoundWave().

m_SoundWaveStarting

bool EffectSound::m_SoundWaveStarting

protected

Definition at line 47 of file EffectSound.c.

Referenced by Event_OnFrameUpdate(), SoundStop(), and ValidateSoundWave().

m_SoundWaveStopping

bool EffectSound::m_SoundWaveStopping

protected

Definition at line 48 of file EffectSound.c.

Referenced by EffectSound(), Event_OnFrameUpdate(), SoundReset(), and SoundStop().

m_SoundWaveTime

float EffectSound::m_SoundWaveTime

protected

Definition at line 39 of file EffectSound.c.

Referenced by Event_OnFrameUpdate(), GetSoundWaveTime(), SoundReset(), and SoundStop().

m_SoundWaveVolume

float EffectSound::m_SoundWaveVolume

protected

Definition at line 37 of file EffectSound.c.

Referenced by EffectSound(), GetSoundVolume(), SetSoundMaxVolume(), SetSoundVolume(), and SoundReset().

m_SoundWaveVolumeMax

float EffectSound::m_SoundWaveVolumeMax

protected

Definition at line 38 of file EffectSound.c.

Referenced by EffectSound(), Event_OnFrameUpdate(), SetSoundMaxVolume(), and SoundReset().

---

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

• scripts/3_Game/Effects/EffectSound.c