AbstractWave Class Reference

Private Member Functions
void	InitEvents ()
void	AbstractWave ()
proto void	SetUserData (Managed inst)
proto Managed	GetUserData ()
proto void	Play ()
void	PlayWithOffset (float offset)
proto void	Stop ()
proto void	Restart ()
proto void	SetStartOffset (float offset)
proto float	GetLength ()
	WARNING: Blocking! Waits for header to load.
proto float	GetCurrPosition ()
	Current position in percentage of total length.
proto void	Loop (bool setLoop)
proto float	GetVolume ()
proto void	SetVolume (float value)
proto void	SetVolumeRelative (float value)
proto void	SetFrequency (float value)
proto float	GetFrequency ()
proto void	SetPosition (vector position, vector velocity="0 0 0")
proto void	SetFadeInFactor (float volume)
proto void	SetFadeOutFactor (float volume)
proto void	SetDoppler (bool setDoppler)
proto void	Skip (float timeSec)
proto bool	IsHeaderLoaded ()
AbstractWaveEvents	GetEvents ()
void	OnPlay ()
void	OnStop ()
void	OnLoad ()
void	OnHeaderLoad ()
void	OnEnd ()

Detailed Description

Definition at line 118 of file Sound.c.

Constructor & Destructor Documentation

AbstractWave()

void AbstractWave::AbstractWave ( )

inlineprivate

Definition at line 130 of file Sound.c.

{ InitEvents(); }

References InitEvents().

Member Function Documentation

GetCurrPosition()

proto float AbstractWave::GetCurrPosition ( )

private

Current position in percentage of total length.

GetEvents()

AbstractWaveEvents AbstractWave::GetEvents ( )

inlineprivate

Definition at line 164 of file Sound.c.

  {
    return AbstractWaveEvents.Cast(GetUserData());
  }

References GetUserData().

Referenced by OnEnd(), OnHeaderLoad(), OnLoad(), OnPlay(), OnStop(), EffectSound::SoundPlayEx(), and EffectSound::ValidateSoundWave().

GetFrequency()

proto float AbstractWave::GetFrequency ( )

private

GetLength()

proto float AbstractWave::GetLength ( )

private

WARNING: Blocking! Waits for header to load.

Referenced by OnTick(), and EffectSound::ValidateSoundWave().

GetUserData()

proto Managed AbstractWave::GetUserData ( )

private

Referenced by GetEvents(), and Play().

GetVolume()

proto float AbstractWave::GetVolume ( )

private

InitEvents()

void AbstractWave::InitEvents ( )

inlineprivate

Definition at line 120 of file Sound.c.

  {
    AbstractWaveEvents events = new AbstractWaveEvents();
    SetUserData(events);
  }

References SetUserData().

Referenced by AbstractWave().

IsHeaderLoaded()

proto bool AbstractWave::IsHeaderLoaded ( )

private

Referenced by EffectSound::SoundPlayEx().

Loop()

proto void AbstractWave::Loop ( bool setLoop )

private

Referenced by MissionBase::PlayMusic(), EffectSound::SetSoundLoop(), and SoftStop().

OnEnd()

void AbstractWave::OnEnd ( )

inlineprivate

Definition at line 189 of file Sound.c.

  {
    GetEvents().Event_OnSoundWaveEnded.Invoke(this);
  }

References GetEvents().

OnHeaderLoad()

void AbstractWave::OnHeaderLoad ( )

inlineprivate

Definition at line 184 of file Sound.c.

  {
    GetEvents().Event_OnSoundWaveHeaderLoaded.Invoke(this);
  }

References GetEvents().

OnLoad()

void AbstractWave::OnLoad ( )

inlineprivate

Definition at line 179 of file Sound.c.

  {
    GetEvents().Event_OnSoundWaveLoaded.Invoke(this);
  }

References GetEvents().

OnPlay()

void AbstractWave::OnPlay ( )

inlineprivate

Definition at line 169 of file Sound.c.

  {
    GetEvents().Event_OnSoundWaveStarted.Invoke(this);
  }

References GetEvents().

OnStop()

void AbstractWave::OnStop ( )

inlineprivate

Definition at line 174 of file Sound.c.

  {
    GetEvents().Event_OnSoundWaveStopped.Invoke(this);
  }

References GetEvents().

Play()

proto void AbstractWave::Play ( )

private

Referenced by MissionBase::PlayMusic(), and PlayWithOffset().

PlayWithOffset()

void AbstractWave::PlayWithOffset ( float offset )

inlineprivate

Definition at line 138 of file Sound.c.

  {
    Play();
    SetStartOffset(offset);
  }

References Play(), and SetStartOffset().

Restart()

proto void AbstractWave::Restart ( )

private

SetDoppler()

proto void AbstractWave::SetDoppler ( bool setDoppler )

private

Referenced by EffectSound::Event_OnFrameUpdate().

SetFadeInFactor()

proto void AbstractWave::SetFadeInFactor ( float volume )

private

SetFadeOutFactor()

proto void AbstractWave::SetFadeOutFactor ( float volume )

private

SetFrequency()

proto void AbstractWave::SetFrequency ( float value )

private

SetPosition()

proto void AbstractWave::SetPosition ( vector position, vector velocity = "0 0 0" )

private

Referenced by OnTick(), and PosUpdate().

SetStartOffset()

proto void AbstractWave::SetStartOffset ( float offset )

private

Referenced by PlayWithOffset().

SetUserData()

proto void AbstractWave::SetUserData ( Managed inst )

private

Referenced by InitEvents().

SetVolume()

proto void AbstractWave::SetVolume ( float value )

private

SetVolumeRelative()

proto void AbstractWave::SetVolumeRelative ( float value )

private

Referenced by PlayerSoundEventBase::OnPlay(), EffectSound::SetSoundMaxVolume(), EffectSound::SetSoundVolume(), EffectSound::SoundReset(), and EffectSound::ValidateSoundWave().

Skip()

proto void AbstractWave::Skip ( float timeSec )

private

Stop()

proto void AbstractWave::Stop ( )

private

Referenced by EffectSound::Event_OnFrameUpdate(), DayZInfected::OnSoundVoiceEvent(), EffectSound::SoundReset(), EffectSound::SoundStop(), Stop(), SoundEventBase::Stop(), MissionBase::StopMusic(), EffectSound::ValidateSoundWave(), ~InfectedSoundEventBase(), and SoundEventBase::~SoundEventBase().

---

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

• scripts/3_Game/Sound.c