class EffectSoundSource

EffectSound › Effect › Managed

All members, including inherited

Wrapper class for managing sound through SEffectManager

Constructors 2

void EffectSound()

ctor

References m_SoundAutodestroy, m_SoundDoppler, m_SoundFadedOut

Show 4 more

, m_SoundWaveKind, m_SoundWaveStopping, m_SoundWaveVolume, and m_SoundWaveVolumeMax

Referenced by CarScript.CreateSoundForAnimationSource(), CarScript.HandleEngineSound(), and SEffectManager.CreateSound()

void ~EffectSound()

dtor

Members 26

ref ScriptInvoker Event_OnSoundWaveStarted = new ScriptInvoker()

\name Event invokers ScriptInvonkers for certain events

Referenced by Event_OnSoundWaveStarted(), and ValidateSoundWave()

ref ScriptInvoker Event_OnSoundWaveEnded = new ScriptInvoker()

Referenced by Event_OnRegistered(), Event_OnSoundWaveEnded(), Event_OnUnregistered()

Show 1 more

, ValidateSoundWave()

ref ScriptInvoker Event_OnSoundFadeInStopped = new ScriptInvoker()

Referenced by Event_OnSoundFadeInStopped()

ref ScriptInvoker Event_OnSoundFadeOutStarted = new ScriptInvoker()

Referenced by Event_OnSoundFadeOutStarted()

protected ref SoundParams m_SoundParams

\name Sound objects and structures Objects and structures for the sound

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

protected ref SoundObjectBuilder m_SoundObjectBuilder

Referenced by SoundLoadEx(), and SoundPlayEx()

protected ref SoundObject m_SoundObject

Referenced by GetCurrentLocalPosition(), GetCurrentParent(), GetCurrentPosition()

Show 7 more

, GetParent(), GetPivotIndex(), SetCurrentLocalPosition(), SetCurrentPosition(), SetParent(), SoundLoadEx(), and SoundPlayEx()

protected AbstractWave m_SoundWaveObject

Referenced by Event_OnFrameUpdate(), SetSoundLoop(), SetSoundMaxVolume()

Show 6 more

, SetSoundVolume(), SoundPlayEx(), SoundReset(), SoundStop(), UpdateEvents(), and ValidateSoundWave()

protected WaveKind m_SoundWaveKind

\name Generic data Generic data for the sound

Referenced by EffectSound(), SetSoundWaveKind(), SoundLoadEx()

Show 1 more

, SoundPlayEx()

protected string m_SoundSetName

Referenced by GetDebugName(), GetSoundSet(), SetSoundSet()

Show 4 more

, SoundError(), SoundLoadEx(), SoundPlayEx(), and ValidateSoundWave()

protected bool m_SoundLoop

Referenced by SetSoundLoop(), and ValidateSoundWave()

protected bool m_SetEnvVariables

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

protected bool m_SoundAutodestroy

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

protected bool m_SoundWaveIsPlaying

Referenced by CanDestroy(), Event_OnSoundWaveEnded(), Event_OnSoundWaveStarted()

Show 2 more

, IsSoundPlaying(), and SoundReset()

protected float m_SoundWaveLenght

Referenced by GetSoundWaveLength(), and ValidateSoundWave()

protected float m_SoundWaveVolume

Referenced by EffectSound(), GetSoundVolume(), SetSoundMaxVolume()

Show 2 more

, SetSoundVolume(), and SoundReset()

protected float m_SoundWaveVolumeMax

Referenced by EffectSound(), Event_OnFrameUpdate(), SetSoundMaxVolume()

Show 1 more

, SoundReset()

protected float m_SoundWaveTime

Referenced by Event_OnFrameUpdate(), GetSoundWaveTime(), SoundReset()

Show 1 more

, SoundStop()

protected int m_SoundDoppler

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

protected bool m_SoundWaveStarting

\name Fading data Data for fadein/fadeout for the sound

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

protected bool m_SoundWaveStopping

Referenced by EffectSound(), Event_OnFrameUpdate(), SoundReset()

Show 1 more

, SoundStop()

protected bool m_SoundFadedOut

Referenced by EffectSound(), Event_OnFrameUpdate(), SoundReset()

Show 1 more

, SoundStop()

protected float m_SoundFadeInDuration

Referenced by Event_OnFrameUpdate(), SetSoundFadeIn(), SoundWaveValidation()

Show 1 more

, ValidateSoundWave()

protected float m_SoundFadeOutStartTime

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

protected float m_SoundFadeOutDuration

Referenced by CanDestroy(), Event_OnFrameUpdate(), SetSoundFadeOut()

Show 2 more

, SoundStop(), and SoundWaveValidation()

protected float m_SoundFadeOutInitVolume

Referenced by Event_OnFrameUpdate(), and SoundReset()

Methods 53

override void InitEffect()

init

References Effect.InitEffect(), ScriptInvoker.Remove(), ScriptInvoker.Remove()

Show 4 more

, Effect.Event_OnEffectEnded, Effect.Event_OnEffectStarted, Effect.Event_OnStarted, and Effect.Event_OnStopped

override string GetDebugName()

Override when getting debug information

References string.Format(), Class.GetDebugName(), and m_SoundSetName

override EffectType GetEffectType()

Get what type of effect the Effect is

Returns: EffectType What type of effect the Effect is

override bool IsSound()

Check whether the Effect is EffectSound without casting

Returns: bool Whether the Effect is EffectSound

bool SoundPlayEx(out SoundParams params)

Plays sound

params: SoundParams Sound Parameters for the sound

Returns: bool Whether the sound will start playing

Referenced by SoundPlay(), SEffectManager.PlaySoundCachedParams(), and SEffectManager.PlaySoundParams()

bool SoundPlay()

Plays sound

Returns: bool Whether the sound will start playing

References SoundPlayEx()

Referenced by AnniversaryMusicSource.PlayIntense(), AnniversaryMusicSource.PlayLight(), BoatScript.PlaySound()

Show 10 more

, CarScript.HandleDoorsSound(), CarScript.HandleEngineSound(), CarScript.HandleSeatAdjustmentSound(), CarScript.PlaySoundEx(), Start(), FlashbangEffect.PlaySound(), SEffectManager.PlaySound(), SEffectManager.PlaySoundEnviroment(), SEffectManager.PlaySoundOnObject(), and Truck_01_Base.OnAnimationPhaseStarted()

override void Start()

Plays sound

References SoundPlay()

Referenced by BoatScript.HandleBoatSplashSound()

void SoundStop()

Stops sound

NoteWill not be immediately if a SoundFadeOutDuration was set

References Effect.IsPendingDeletion(), IsSoundPlaying(), SoundReset()

Show 9 more

, AbstractWave.Stop(), Effect.Stop(), m_SoundFadedOut, m_SoundFadeOutDuration, m_SoundFadeOutStartTime, m_SoundWaveObject, m_SoundWaveStarting, m_SoundWaveStopping, and m_SoundWaveTime

override void Stop()

Stops sound

References SoundStop()

Referenced by BoatScript.OnVariablesSynchronized(), Edible_Base.SoundCookingStop(), FireworksLauncher.OnFiringStartClient()

Show 6 more

, FireworksLauncherClientEvent.PlayExplosionSound(), Land_Underground_Stairs_Exit.HandleAudioPlayback(), Land_WarheadStorage_Main.OnPowerOffClient(), ScriptConsoleSoundsTab.HandleKeys(), ScriptConsoleSoundsTab.OnClick(), and UndergroundHandlerClient.~UndergroundHandlerClient()

protected void SoundReset()

Resets EffectSound

References AbstractWave.SetVolumeRelative(), AbstractWave.Stop(), Effect.m_IsPlaying

Show 9 more

, m_SoundFadedOut, m_SoundFadeOutInitVolume, m_SoundFadeOutStartTime, m_SoundWaveIsPlaying, m_SoundWaveObject, m_SoundWaveStopping, m_SoundWaveTime, m_SoundWaveVolume, and m_SoundWaveVolumeMax

Referenced by SoundStop()

bool IsSoundPlaying()

Get whether EffectSound is currently playing

Returns: bool Whether EffectSound is currently playing

References m_SoundWaveIsPlaying

Referenced by ActionBuildShelter.PlayActionLoopSound(), BoatScript.PlaySound(), Bottle_Base.PlayEmptyingLoopSound()

Show 9 more

, Bottle_Base.PlayPouringLoopSound(), CarScript.PlaySoundEx(), Event_OnFrameUpdate(), IsPlaying(), SoundStop(), ItemBase.OnRPC(), LandMineTrap.PlayDisarmingLoopSound(), LargeTent.PlayRepackingLoopSound(), and LargeTentBackPack.PlayRepackingLoopSound()

override bool IsPlaying()

Returns true when the effect is playing, false otherwise

References IsSoundPlaying()

Referenced by BoatScript.OnVariablesSynchronized(), FlashbangEffect.PlaySound(), Land_WarheadStorage_Main.OnDoorCloseFinish()

Show 3 more

, Land_WarheadStorage_Main.OnDoorCloseStart(), Land_WarheadStorage_Main.OnDoorOpenFinish(), and Object.PlaySoundSetAtMemoryPointLoopedSafe()

bool SoundLoadEx(out SoundParams params)

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

References SoundObjectBuilder.AddEnvSoundVariables(), SoundObjectBuilder.BuildSoundObject(), Effect.GetPosition()

Show 14 more

, SoundParams.IsValid(), SoundObject.SetKind(), SoundObject.SetParent(), SoundError(), new SoundObjectBuilder(), new SoundParams(), Effect.m_ParentObject, Effect.m_PivotIndex, m_SetEnvVariables, m_SoundObject, m_SoundObjectBuilder, m_SoundParams, m_SoundSetName, and m_SoundWaveKind

Referenced by SoundLoad(), and SoundPlayEx()

bool SoundLoad()

Loads in the sound when it is requested for playing

NoteLegacy, backwards compatibility

References SoundLoadEx()

bool IsSoundValid()

Helper for checking if params are valid

References SoundParams.IsValid(), and m_SoundParams

protected void ValidateSoundWave()

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

NoteCalled from 'SoundPlayEx'

Referenced by SoundPlayEx()

protected bool SoundWaveValidation()

Validation of fade settings

NoteCalled from 'ValidateSoundWave'

References GetSoundWaveLength(), SoundError(), m_SoundFadeInDuration

Show 1 more

, m_SoundFadeOutDuration

Referenced by ValidateSoundWave()

protected void UpdateEvents()

Enables the frame event on the EffectSound

NoteCalled from 'ValidateSoundWave' when all is successful

NoteSo this is effectively enabling frame event on all valid EffectSound

References Effect.SetEnableEventFrame(), and m_SoundWaveObject

Referenced by ValidateSoundWave()

override void Event_OnFrameUpdate(float time_delta)

Event called on frame when enabled by SetEnableEventFrame(true)

time_delta: float Time passed since the previous frame

NoteIs always enabled on sound

NoteCalled from SEffectManager.Event_OnFrameUpdate in MissionGameplay.OnUpdate

References Event_OnSoundFadeInStopped(), Event_OnSoundFadeOutStarted(), GetSoundVolume()

Show 14 more

, IsSoundPlaying(), AbstractWave.SetDoppler(), SetSoundVolume(), AbstractWave.Stop(), m_SoundDoppler, m_SoundFadedOut, m_SoundFadeInDuration, m_SoundFadeOutDuration, m_SoundFadeOutInitVolume, m_SoundWaveObject, m_SoundWaveStarting, m_SoundWaveStopping, m_SoundWaveTime, and m_SoundWaveVolumeMax

override void Event_OnRegistered(int id)

Event called from SEffectManager when the Effect is registered

id: int ID registered in SEffectManager

NoteShould only ever be called by SEffectManager!

References Effect.Event_OnRegistered(), ScriptInvoker.Insert(), and Event_OnSoundWaveEnded

override void Event_OnUnregistered()

Event called from SEffectManager when the Effect is unregistered

NoteShould only ever be called by SEffectManager!

References Effect.Event_OnUnregistered(), ScriptInvoker.Remove(), and Event_OnSoundWaveEnded

void Event_OnSoundWaveStarted()

Event called when sound starts playing

NoteInserted into events of m_SoundWaveObject

References Effect.Event_OnEffectStarted(), ScriptInvoker.Invoke(), Event_OnSoundWaveStarted

Show 1 more

, m_SoundWaveIsPlaying

void Event_OnSoundWaveEnded()

Event called when sound stops playing

NoteInserted into events of m_SoundWaveObject

References Effect.Event_OnEffectEnded(), ScriptInvoker.Invoke(), Event_OnSoundWaveEnded

Show 1 more

, m_SoundWaveIsPlaying

void Event_OnSoundFadeInStopped()

Event called when sound fade in stops

NoteCalled from Event_OnFrameUpdate

References ScriptInvoker.Invoke(), and Event_OnSoundFadeInStopped

Referenced by Event_OnFrameUpdate()

void Event_OnSoundFadeOutStarted()

Event called when sound fade out starts

NoteCalled from Event_OnFrameUpdate

References ScriptInvoker.Invoke(), and Event_OnSoundFadeOutStarted

Referenced by Event_OnFrameUpdate()

override void SetAutodestroy(bool auto_destroy)

Sets whether Effect automatically cleans up when it stops

auto_destroy: bool Whether Effect automatically cleans up when it stops

NoteThis means that it will be unregistered from SEffectManager as well

References Effect.SetAutodestroy(), and m_SoundAutodestroy

Referenced by ActionBuildShelter.PlayActionFinishSound(), ActionBuildShelter.PlayActionStartSound(), BearTrap.PlaySoundBiteEmpty()

Show 41 more

, BearTrap.PlaySoundBiteLeg(), BearTrap.PlaySoundOpen(), BoatScript.HandleBoatSplashSound(), BoatScript.PlaySound(), Bottle_Base.StopEmptyingLoopSound(), CarScript.CreateSoundForAnimationSource(), CarScript.HandleEngineSound(), CarScript.PlaySoundEx(), CarWheel.OnWasAttached(), CarWheel.OnWasDetached(), CrashBase.EEInit(), DayZGame.DelayedMidAirDetonation(), DayZGame.OnRPC(), SetSoundAutodestroy(), EntityAI.SoundHardBushFallingPlay(), EntityAI.SoundHardTreeFallingPlay(), EntityAI.SoundSoftBushFallingPlay(), EntityAI.SoundSoftTreeFallingPlay(), FlashbangEffect.PlaySound(), HungerSoundHandlerClient.PlaySound(), ItemBase.PlayAttachSound(), ItemSoundHandler.PlayItemSoundClient(), Land_WarheadStorage_Main.OnDoorCloseFinish(), Land_WarheadStorage_Main.OnDoorCloseStart(), Land_WarheadStorage_Main.OnDoorOpenStart(), Land_WarheadStorage_Main.OnPowerOffClient(), Land_WarheadStorage_Main.OnPowerOnClient(), Land_WarheadStorage_PowerStation.OnVariablesSynchronized(), Land_WarheadStorage_PowerStation.PlayLeverSound(), LandMineTrap.OnActivate(), LandMineTrap.PlaySoundActivate(), LandMineTrap.StartActivate(), Object.PlaySoundSet(), PlayerBase.EEHitByRemote(), PlayerBase.OnPlayerRecievedHit(), ScriptConsoleSoundsTab.HandleKeys(), SpookyEventBase.Perform(), SpookyEventRustle.Do(), TreeEffecter.OnVariablesSynchronized(), TripwireTrap.OnSteppedOn(), and Weapon_Base.OnFireModeChange()

override bool IsAutodestroy()

Get whether Effect automatically cleans up when it stops

Returns: bool Whether Effect automatically cleans up when it stops

References IsSoundAutodestroy()

void SetSoundAutodestroy(bool auto_destroy)

Sets whether EffectSound automatically cleans up when sound stops

auto_destroy: bool Whether EffectSound automatically cleans up when sound stops

References SetAutodestroy()

bool IsSoundAutodestroy()

Get whether EffectSound automatically cleans up when sound stops

Returns: bool Whether EffectSound automatically cleans up when sound stops

References m_SoundAutodestroy

Referenced by IsAutodestroy()

override bool CanDestroy()

References m_SoundFadeOutDuration, and m_SoundWaveIsPlaying

override void SetParent(Object parent_obj, int pivot)

Set parent for the sound to follow

parent_obj: Object The parent for the sound to follow

References SoundObject.SetParent(), Effect.SetParent(), and m_SoundObject

Referenced by CarScript.CreateSoundForAnimationSource(), CarScript.HandleEngineSound(), FlashbangEffect.PlaySound()

Show 1 more

, SEffectManager.PlaySoundOnObject()

override Object GetParent()

Get parent for the EffectSound

Returns: Object The parent for the EffectSound

References Class.Cast(), SoundObject.GetParent(), Effect.GetParent()

Show 1 more

, m_SoundObject

Referenced by GetCurrentLocalPosition(), and SetCurrentPosition()

override int GetPivotIndex()

Get parent pivot of the Effect, only valid when there is some GetParent

Returns: int The parent pivot of the Effect

WarningOnly gets the cached variable

References SoundObject.GetHierarchyPivot(), Effect.GetPivotIndex(), and m_SoundObject

override Object GetCurrentParent()

Get parent for the EffectSound

Returns: Object The parent for the EffectSound

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

References Class.Cast(), SoundObject.GetParent(), Effect.GetParent()

Show 1 more

, m_SoundObject

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

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

References GetParent(), Effect.SetCurrentPosition(), SoundObject.SetPosition()

Show 2 more

, Object.WorldToModel(), and m_SoundObject

Referenced by BoatScript.PlaySound()

override vector GetCurrentPosition()

Get the current world position of the managed sound

Returns: vector The current world position of the managed sound

References Effect.GetPosition(), SoundObject.GetPosition(), Object.ModelToWorld()

Show 2 more

, Effect.m_ParentObject, and m_SoundObject

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

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

References Effect.SetCurrentLocalPosition(), SoundObject.SetPosition(), and m_SoundObject

Referenced by SoundPlayEx()

override vector GetCurrentLocalPosition()

Get the current local position of the managed sound

Returns: vector The current local position of the managed sound

References Effect.GetLocalPosition(), GetParent(), Effect.GetPosition()

Show 4 more

, SoundObject.GetPosition(), Object.WorldToModel(), m_SoundObject, and vector.Zero

Referenced by SoundPlayEx()

void SetSoundWaveKind(WaveKind wave_kind)

Set WaveKind for the sound

wave_kind: WaveKind The WaveKind for the sound

NoteNeeds to be set before playing

References m_SoundWaveKind

Referenced by CarScript.CreateSoundForAnimationSource(), CarScript.HandleEngineSound(), and FlashbangEffect.PlaySound()

void SetSoundSet(string snd)

Set soundset for the sound

snd: string Name of the soundset to play

NoteNeeds to be set before playing

References m_SoundSetName

Referenced by CarScript.HandleDoorsSound(), CarScript.HandleEngineSound(), CarScript.HandleSeatAdjustmentSound()

Show 2 more

, SEffectManager.CreateSound(), and Truck_01_Base.OnAnimationPhaseStarted()

string GetSoundSet()

Get soundset for the sound

Returns: string Name of the soundset

References m_SoundSetName

Referenced by BoatScript.HandleEngineSound(), and UndergroundHandlerClient.PlayAmbientSound()

void SetSoundLoop(bool loop)

Set if the sound loops

loop: bool Whether the sound should loop

References AbstractWave.Loop(), m_SoundLoop, and m_SoundWaveObject

Referenced by ValidateSoundWave(), FlashbangEffect.PlaySound(), and SEffectManager.CreateSound()

void SetEnviromentVariables(bool setEnvVariables)

Sets whether AddEnvSoundVariables needs to be called during Loading

setEnvVariables: bool Whether AddEnvSoundVariables is called

References m_SetEnvVariables

Referenced by SEffectManager.CreateSound()

float GetSoundWaveLenght()

Get the sound wave length

Returns: float The sound wave length

NoteLegacy, exists for backwards compatibility

References GetSoundWaveLength()

float GetSoundWaveLength()

Get the sound wave length

Returns: float The sound wave length

References m_SoundWaveLenght

Referenced by GetSoundWaveLenght(), and SoundWaveValidation()

void SetSoundVolume(float volume)

Set the RELATIVE volume for the sound

volume: float The relative volume for the sound

References AbstractWave.SetVolumeRelative(), m_SoundWaveObject, and m_SoundWaveVolume

Referenced by BoatScript.HandleBoatSplashSound(), Event_OnFrameUpdate(), and UndergroundHandlerClient.ProcessSound()

float GetSoundVolume()

Get the RELATIVE volume set by 'SetSoundVolume'

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

References m_SoundWaveVolume

Referenced by Event_OnFrameUpdate()

void SetSoundMaxVolume(float volume)

Set the sound max volume

volume: float The maximum volume for the sound

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

WarningAdjusts the current volume to this value as well

References AbstractWave.SetVolumeRelative(), m_SoundWaveObject, m_SoundWaveVolume

Show 1 more

, m_SoundWaveVolumeMax

Referenced by FlashbangEffect.PlaySound()

float GetSoundWaveTime()

Get the time since EffectSound started playing

Returns: float The time since EffectSound started playing

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

References m_SoundWaveTime

void SetSoundFadeIn(float fade_in)

Set the sound fade in duration

fade_in: float The fade in duration

References m_SoundFadeInDuration

Referenced by FlashbangEffect.PlaySound(), SEffectManager.CreateSound(), and Truck_01_Base.OnAnimationPhaseStarted()

void SetSoundFadeOut(float fade_out)

Set the sound fade out duration

fade_out: float The fade out duration

References m_SoundFadeOutDuration

Referenced by ActionBuildShelter.StopActionLoopSound(), CarScript.HandleEngineSound(), FlashbangEffect.PlaySound()

Show 5 more

, ItemSoundHandler.StopItemSoundClient(), LargeTent.StopRepackingLoopSound(), LargeTentBackPack.StopRepackingLoopSound(), SEffectManager.CreateSound(), and Truck_01_Base.OnAnimationPhaseStarted()

void SetDoppler(bool setDoppler)

Set if the sound has the doppler effect enabled

setDoppler: float If the doppler effect is enabled

References m_SoundDoppler

protected void SoundError(string err_msg)

Helper for throwing sound errors

References ErrorEx(), string.Format(), and m_SoundSetName

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