Data Structures
class	AbstractSoundScene
class	AbstractWaveEvents
class	SoundObject

Functions
void	AbstractSoundScene ()
void	SoundObject (SoundParams soundParams)
void	~AbstractSoundScene ()
void	~AbstractSoundScene ()
void	AbstractSoundScene ()
void	AbstractWave ()
proto native void	AddEnvSoundVariables (vector position)
proto native void	AddVariable (string name, float value)
proto void	AddVariables (notnull array< string > names, array< float > values=null)
proto native SoundObject	BuildSoundObject (SoundObjectBuilder soundObjectbuilder)
SoundObject	BuildSoundObject ()
proto native SoundObject	BuildSoundObject (SoundObjectBuilder soundObjectbuilder)
proto native float	GetAudioLevel ()
proto native float	GetAudioLevel ()
proto float	GetCurrPosition ()
	Current position in percentage of total length.
AbstractWaveEvents	GetEvents ()
proto float	GetFrequency ()
proto native int	GetHierarchyPivot ()
proto native int	GetHierarchyPivot ()
proto float	GetLength ()
	WARNING: Blocking! Waits for header to load.
proto native float	GetMusicVolume ()
proto native float	GetMusicVolume ()
proto string	GetName ()
	Test name getter. Strictly for UI porposes!
proto native IEntity	GetParent ()
	Get parent of the Effect.
proto native IEntity	GetParent ()
proto native vector	GetPosition ()
	Get the world position of the Effect.
proto native vector	GetPosition ()
proto native float	GetRadioVolume ()
proto native float	GetRadioVolume ()
proto native float	GetSilenceThreshold ()
proto native float	GetSilenceThreshold ()
proto native float	GetSoundVolume ()
proto native float	GetSoundVolume ()
proto native float	GetSpeechExVolume ()
proto native float	GetSpeechExVolume ()
proto native vector	GetSpeed ()
proto native vector	GetSpeed ()
proto Managed	GetUserData ()
proto native float	GetVOIPVolume ()
proto native float	GetVOIPVolume ()
proto float	GetVolume ()
class AbstractWaveEvents	InitEvents ()
proto native void	Initialize (SoundParams soundParams)
proto native void	Initialize (SoundParams soundParams)
proto bool	IsHeaderLoaded ()
proto native bool	IsValid ()
	Checks if the ScriptCaller is valid.
proto native bool	Load (string name)
proto void	Loop (bool setLoop)
proto native void	MuteAllSoundControllers ()
	Overrides all the environment controllers to be muted.
void	OnEnd ()
void	OnHeaderLoad ()
void	OnLoad ()
void	OnPlay ()
void	OnStop ()
proto void	Play ()
proto native AbstractWave	Play2D (SoundObject soundObject, SoundObjectBuilder soundBuilder)
proto native AbstractWave	Play2D (SoundObject soundObject, SoundObjectBuilder soundBuilder)
proto native AbstractWave	Play3D (SoundObject soundObject, SoundObjectBuilder soundBuilder)
proto native AbstractWave	Play3D (SoundObject soundObject, SoundObjectBuilder soundBuilder)
void	PlayWithOffset (float offset)
proto native void	ResetAllSoundControllers ()
	Removes all the previously set overrides of sound controllers.
proto void	Restart ()
proto void	SetDoppler (bool setDoppler)
proto void	SetFadeInFactor (float volume)
proto void	SetFadeOutFactor (float volume)
proto void	SetFrequency (float value)
proto native void	SetKind (WaveKind kind)
proto native void	SetKind (WaveKind kind)
proto native void	SetMusicVolume (float vol, float time)
proto native void	SetMusicVolume (float vol, float time)
proto native void	SetOcclusionObstruction (float occlusion, float obstruction)
proto native void	SetOcclusionObstruction (float occlusion, float obstruction)
proto native void	SetParent (IEntity parent, int pivot=-1)
	Note: 'SoundObject' is not an Entity, and therefore can not be accessed by using 'IEntity.GetChildren', though internally 'SoundObject.SetParent' is similiar to 'IEntity.AddChild' by creating an 'EntityHierarchyComponent'.
proto native void	SetParent (IEntity parent, int pivot=-1)
	Note: 'SoundObject' is not an Entity, and therefore can not be accessed by using 'IEntity.GetChildren', though internally 'SoundObject.SetParent' is similiar to 'IEntity.AddChild' by creating an 'EntityHierarchyComponent'.
proto native void	SetPosition (vector position)
	Note: Sets the position locally if parented, retrieves globally with the sound offset.
proto void	SetPosition (vector position, vector velocity="0 0 0")
proto native void	SetPosition (vector position)
	Note: Sets the position locally if parented, retrieves globally with the sound offset.
proto native void	SetRadioVolume (float vol, float time)
proto native void	SetRadioVolume (float vol, float time)
	SetSoundControllerOverride (string controllerName, float value, SoundControllerAction action)
	Overrides or limits soundmap value for a sound cotroller.
proto native void	SetSoundVolume (float vol, float time)
proto native void	SetSoundVolume (float vol, float time)
proto native void	SetSpeechExVolume (float vol, float time)
proto native void	SetSpeechExVolume (float vol, float time)
proto native void	SetSpeed (vector speed)
	Note: Sets the speed locally if parented, retrieves globally with the parent speed.
proto native void	SetSpeed (vector speed)
	Note: Sets the speed locally if parented, retrieves globally with the parent speed.
proto void	SetStartOffset (float offset)
proto void	SetUserData (Managed inst)
void	SetVariable (string name, float value)
	Deprecated - same functionality, just poor naming.
proto native void	SetVOIPVolume (float vol, float time)
proto native void	SetVOIPVolume (float vol, float time)
proto void	SetVolume (float value)
proto void	SetVolumeRelative (float value)
proto void	Skip (float timeSec)
void	SoundObject (SoundParams soundParams)
class AbstractSoundScene	SoundObjectBuilder (SoundParams soundParams)
class SoundObject	SoundParams (string name)
proto void	Stop ()
	Stops all elements this effect consists of.
void	UpdateEnvSoundControllers (vector position)
	Deprecated - same functionality, just poor naming.
proto void	UpdateVariables (notnull array< float > values)
proto void	UpdateVariables (notnull array< float > values)

Variables
ref ScriptInvoker	Event_OnSoundWaveEnded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveEnded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveHeaderLoaded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveHeaderLoaded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveLoaded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveLoaded = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveStarted = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveStarted = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveStopped = new ScriptInvoker()
ref ScriptInvoker	Event_OnSoundWaveStopped = new ScriptInvoker()
	Limit
	None
	WAVEATTALWAYS
	WAVEEFFECT
	WAVEEFFECTEX
	WAVEENVIRONMENT
	WAVEENVIRONMENTEX
	WAVEMUSIC
	WAVESPEECH
	WAVESPEECHEX
	WAVEUI
	WAVEWEAPONS
	WAVEWEAPONSEX

Detailed Description

Function Documentation

◆ AbstractSoundScene() [1/2]

void AbstractSoundScene ( )

inlineprivate

Definition at line 55 of file sound.c.

◆ SoundObject() [1/2]

void SoundObject ( SoundParams soundParams )

private

References SoundParams().

◆ ~AbstractSoundScene() [1/2]

void ~AbstractSoundScene ( )

inlineprivate

Definition at line 56 of file sound.c.

◆ ~AbstractSoundScene() [2/2]

void ~AbstractSoundScene ( )

private

Definition at line 1 of file sound.c.

◆ AbstractSoundScene() [2/2]

void AbstractSoundScene ( )

private

Definition at line 0 of file sound.c.

◆ AbstractWave()

◆ AddEnvSoundVariables()

proto native void AddEnvSoundVariables ( vector position )

Referenced by UpdateEnvSoundControllers().

◆ AddVariable()

proto native void AddVariable	(	string	name,
		float	value )

References name.

Referenced by SetVariable().

◆ AddVariables()

proto void AddVariables	(	notnull array< string >	names,
		array< float >	values = null )

◆ BuildSoundObject() [1/3]

proto native SoundObject BuildSoundObject ( SoundObjectBuilder soundObjectbuilder )

private

References SoundObjectBuilder().

◆ BuildSoundObject() [2/3]

SoundObject BuildSoundObject ( )

Definition at line 86 of file sound.c.

References g_Game.

◆ BuildSoundObject() [3/3]

proto native SoundObject BuildSoundObject ( SoundObjectBuilder soundObjectbuilder )

private

References WAVESPEECH.

◆ GetAudioLevel() [1/2]

proto native float GetAudioLevel ( )

private

◆ GetAudioLevel() [2/2]

proto native float GetAudioLevel ( )

private

◆ GetCurrPosition()

proto float GetCurrPosition ( )

Current position in percentage of total length.

◆ GetEvents()

AbstractWaveEvents GetEvents ( )

Definition at line 201 of file sound.c.

References GetUserData().

◆ GetFrequency()

proto float GetFrequency ( )

◆ GetHierarchyPivot() [1/2]

proto native int GetHierarchyPivot ( )

References WAVEENVIRONMENT.

◆ GetHierarchyPivot() [2/2]

proto native int GetHierarchyPivot ( )

private

◆ GetLength()

proto float GetLength ( )

WARNING: Blocking! Waits for header to load.

◆ GetMusicVolume() [1/2]

proto native float GetMusicVolume ( )

private

Referenced by CGame::DeferredInit().

◆ GetMusicVolume() [2/2]

proto native float GetMusicVolume ( )

private

References WAVEUI.

◆ GetName()

proto string GetName ( )

Test name getter. Strictly for UI porposes!

Definition at line 50 of file syncedvalue.c.

◆ GetParent() [1/2]

proto native IEntity GetParent ( )

Get parent of the Effect.

Note: Same as GetAttachmentParent, but more generic name

Warning: Only gets the cached variable, for immediate effect use GetCurrent variant

Returns: Object The parent of the Effect

Definition at line 422 of file effect.c.

◆ GetParent() [2/2]

proto native IEntity GetParent ( )

private

◆ GetPosition() [1/2]

proto native vector GetPosition ( )

Get the world position of the Effect.

Warning: Only gets the cached variable, for immediate effect use GetCurrent variant

Returns: vector The world position of the Effect

Definition at line 473 of file effect.c.

References m_AreaPosition, and m_Position.

Referenced by FireplaceBase::AfterStoreLoad(), ManBase::AfterStoreLoad(), DayZInfected::ChaseAttackLogic(), DayZInfected::ComputeHitDirectionAngle(), DayZCreatureAI::ComputeHitDirectionAngleDeg(), DayZInfected::ComputeHitDirectionAngleEx(), CreateLight(), Grenade_Base::CreateLight(), ItemBase::CreateRope(), CreateTrigger(), DayZAnimal::DeathUpdate(), Entity::DeathUpdate(), BoatScript::DecayHealthTick(), DeferredInit(), KitBase::DisassembleKit(), ItemBase::DoMeasurement(), ManBase::DropItem(), House::EEInit(), ItemBase::EEItemAttached(), FlammableBase::EEItemDetached(), Ammo_40mm_Explosive::EEKilled(), EEOnCECreate(), Inventory_Base::EmptySeedPack(), InventoryItem::EOnContact(), DayZSpectator::EOnFrame(), DynamicArea_Flare::EOnFrame(), EOnTouch(), FireplaceBase::EOnTouch(), DayZInfected::EvaluateCrawlTransitionAnimation(), DayZPlayer::EvaluateDamageHitAnimation(), DayZPlayer::EvaluateDeathAnimation(), Hit_MeatBones::Event_OnStarted(), Explode(), ExplosivesBase(), DayZInfected::FightAttackLogic(), DayZInfected::FightLogic(), BoatScript::FlipVehicle(), Car::GenerateCarHornAINoise(), GeyserTrigger::GetAdjustedPosition(), DayZInfected::GetAttackPitch(), WorldData::GetBaseEnvTemperatureAtObject(), GetCeilingHeight(), IEntity::GetCenter(), Land_WarheadStorage_PowerStation::GetClosestBunker(), GetClosestCarWheel(), GetClosestDoor(), EffectSound::GetCurrentLocalPosition(), EffectSound::GetCurrentPosition(), GetEmptyingEndSoundset(), GetEmptyingLoopSoundset(), BaseBuildingBase::GetKitSpawnPosition(), ItemBase::GetKitSpawnPosition(), IEntity::GetSurfaceNoise(), Entity::GetUniversalTemperatureSourcePosition(), BoatScript::HandleBoatSplashSound(), EntityLightSource::HandleDancingShadows(), BaseBuildingBase::HandleRefreshers(), DayZPlayer::HandleView(), Heating(), BaseBuildingBase::InsertRefresherPosition(), BaseBuildingBase::IsFacingCamera(), BaseBuildingBase::IsFacingPlayer(), ManBase::IsFacingTarget(), BaseBuildingBase::IsPlayerInside(), TentBase::IsPlayerInside(), ItemBase::IsPlayerInVicinity(), RemoteDetonatorTrigger::OnActivatedByItem(), BaseBuildingBase::OnCEUpdate(), OnCEUpdate(), RemoteDetonatorTrigger::OnCEUpdate(), ManBase::OnConnect(), Grenade_ChemGas::OnDamageDestroyed(), OnDamageDestroyed(), ClaymoreMine::OnDebugSpawn(), FishingRod_Base_New::OnDebugSpawn(), KitBase::OnDebugSpawn(), OnDebugSpawn(), Crossbow_Base::OnDebugSpawnEx(), Anniversary_FireworksLauncher::OnEventServer(), FireworksLauncher::OnEventServer(), Grenade_ChemGas::OnExplode(), IEntity::OnExplodeClient(), Weapon::OnFireModeChange(), FireworksLauncher::OnFuseIgnitedClient(), FireplaceBase::OnIgnitedThis(), GardenBase::OnPlacementComplete(), KitBase::OnPlacementComplete(), InventoryItem::OnRPC(), DayZPlayer::OnStepEvent(), OnSteppedOn(), GardenBase::OnStoreLoad(), ItemBase::OnStoreLoad(), OnStoreLoadCustom(), OnStoreSave(), AlarmClock_ColorBase::OnUpdate(), BotStateBase::OnUpdate(), KitchenTimer::OnUpdate(), AnniversarySpotLight::OnVariablesSynchronized(), BoatScript::OnVariablesSynchronized(), InventoryItemSuper::OnWasAttached(), InventoryItemSuper::OnWasDetached(), OnWork(), OnWorkStart(), ItemBase::ParticleTest(), BaseBuildingBase::PerformRoofCheckForBase(), ItemBase::PlaceOnGround(), InventoryItem::PlayAttachSound(), PlayDisarmingLoopSound(), PlayerCheckRequestDst(), PlayerCheckRequestSrc(), PlayerCheckSwapItemsRequest(), EntityAI::PlayImpactSound(), Backpack_Base::PlayRepackingLoopSound(), PlayRepackingLoopSound(), BoatScript::PlaySound(), DayZCreature::PlaySound(), DayZPlayer::PlaySound(), EntityAI::PlaySound(), PlaySoundActivate(), TrapBase::PlaySoundBiteEmpty(), TrapBase::PlaySoundBiteLeg(), Car::PlaySoundEx(), TrapBase::PlaySoundOpen(), PlayVFX(), ItemBase::PrintSlots(), ProcessItemsDryness(), DayZCreature::ProcessSoundEvent(), DayZPlayer::ProcessSoundEvent(), DayZCreature::ProcessSoundVoiceEvent(), DayZInfected::ProcessSoundVoiceEvent(), DayZCreature::ProcessStepEvent(), RefreshFireplaceVisuals(), BaseBuildingBase::RemoveRefresherPosition(), House::RequestSoundEvent(), ManBase::SaySoundSet(), ManBase::SetContaminatedEffectEx(), SetParticlePosition(), BaseBuildingBase::SetRefresherActive(), Edible_Base::SoundCookingStart(), Entity::SoundHardBushFallingPlay(), Entity::SoundHardTreeFallingPlay(), EffectSound::SoundLoadEx(), EffectSound::SoundPlayEx(), Entity::SoundSoftBushFallingPlay(), Entity::SoundSoftTreeFallingPlay(), ManBase::SpawnEntityOnGroundOnCursorDir(), TentBase::SpawnKit(), CrashBase::SpawnRandomDeers(), UndergroundTriggerCarrier::SpawnTrigger(), HotSpringTrigger::SpawnVaporEffect(), VolcanicTrigger::SpawnVaporEffect(), FlammableBase::StandUp(), EffectParticle::Start(), StartActivate(), Particle::StopParticle(), EntityLightSource::TryShadowOptimization(), FlammableBase::TryTransformIntoStick(), AreaDamageTriggerBase::UpdateInsiders(), UpdateMusic(), ManBase::UpdatePlayerMeasures(), ScriptedWidgetEventHandler::UpdatePos(), and ItemBase::UpdatePreyPos().

◆ GetPosition() [2/2]

proto native vector GetPosition ( )

private

◆ GetRadioVolume() [1/2]

proto native float GetRadioVolume ( )

private

Referenced by CGame::DeferredInit().

◆ GetRadioVolume() [2/2]

proto native float GetRadioVolume ( )

private

References WAVESPEECHEX.

◆ GetSilenceThreshold() [1/2]

proto native float GetSilenceThreshold ( )

private

◆ GetSilenceThreshold() [2/2]

proto native float GetSilenceThreshold ( )

private

◆ GetSoundVolume() [1/2]

proto native float GetSoundVolume ( )

private

Referenced by CGame::DeferredInit().

◆ GetSoundVolume() [2/2]

proto native float GetSoundVolume ( )

private

◆ GetSpeechExVolume() [1/2]

proto native float GetSpeechExVolume ( )

private

Referenced by CGame::DeferredInit().

◆ GetSpeechExVolume() [2/2]

proto native float GetSpeechExVolume ( )

private

References WAVEWEAPONS.

◆ GetSpeed() [1/2]

proto native vector GetSpeed ( )

◆ GetSpeed() [2/2]

proto native vector GetSpeed ( )

private

◆ GetUserData()

proto Managed GetUserData ( )

Referenced by GetEvents().

◆ GetVOIPVolume() [1/2]

proto native float GetVOIPVolume ( )

private

Referenced by CGame::DeferredInit().

◆ GetVOIPVolume() [2/2]

proto native float GetVOIPVolume ( )

private

◆ GetVolume()

proto float GetVolume ( )

◆ InitEvents()

class AbstractWaveEvents InitEvents ( )

Definition at line 143 of file sound.c.

Referenced by AbstractWave().

◆ Initialize() [1/2]

proto native void Initialize ( SoundParams soundParams )

References SoundParams().

◆ Initialize() [2/2]

proto native void Initialize ( SoundParams soundParams )

private

References SoundParams().

◆ IsHeaderLoaded()

proto bool IsHeaderLoaded ( )

◆ IsValid()

proto native bool IsValid ( )

Checks if the ScriptCaller is valid.

Definition at line 251 of file catchingcontextbase.c.

References m_IsValid.

◆ Load()

proto native bool Load ( string name )

References name.

◆ Loop()

proto void Loop ( bool setLoop )

◆ MuteAllSoundControllers()

proto native void MuteAllSoundControllers ( )

Overrides all the environment controllers to be muted.

◆ OnEnd()

void OnEnd ( )

Definition at line 226 of file sound.c.

References GetEvents().

Referenced by ActionBase::End(), AnimatedActionBase::End(), and Play().

◆ OnHeaderLoad()

void OnHeaderLoad ( )

Definition at line 221 of file sound.c.

References GetEvents().

◆ OnLoad()

void OnLoad ( )

Definition at line 216 of file sound.c.

References GetEvents().

◆ OnPlay()

void OnPlay ( )

Definition at line 206 of file sound.c.

References GetEvents().

◆ OnStop()

void OnStop ( )

Definition at line 211 of file sound.c.

References GetEvents().

Referenced by PPERequesterBase::Stop().

◆ Play()

override EAnimPlayState Play ( )

◆ Play2D() [1/2]

proto native AbstractWave Play2D	(	SoundObject	soundObject,
		SoundObjectBuilder	soundBuilder )

private

References AbstractWave(), and SoundObjectBuilder().

◆ Play2D() [2/2]

proto native AbstractWave Play2D	(	SoundObject	soundObject,
		SoundObjectBuilder	soundBuilder )

private

References WAVEEFFECT.

◆ Play3D() [1/2]

proto native AbstractWave Play3D	(	SoundObject	soundObject,
		SoundObjectBuilder	soundBuilder )

private

References AbstractWave(), and SoundObjectBuilder().

◆ Play3D() [2/2]

proto native AbstractWave Play3D	(	SoundObject	soundObject,
		SoundObjectBuilder	soundBuilder )

private

References WAVEEFFECTEX.

◆ PlayWithOffset()

void PlayWithOffset ( float offset )

Definition at line 175 of file sound.c.

References Play(), and SetStartOffset().

◆ ResetAllSoundControllers()

proto native void ResetAllSoundControllers ( )

Removes all the previously set overrides of sound controllers.

◆ Restart()

proto void Restart ( )

◆ SetDoppler()

proto void SetDoppler ( bool setDoppler )

◆ SetFadeInFactor()

proto void SetFadeInFactor ( float volume )

◆ SetFadeOutFactor()

proto void SetFadeOutFactor ( float volume )

◆ SetFrequency()

proto void SetFrequency ( float value )

◆ SetKind() [1/2]

proto native void SetKind ( WaveKind kind )

◆ SetKind() [2/2]

proto native void SetKind ( WaveKind kind )

private

Referenced by DayZCreature::AttenuateSoundIfNecessary(), DayZPlayer::AttenuateSoundIfNecessary(), EntityAI::PlayImpactSound(), MissionBase::PlayMusic(), and PlayTrack().

◆ SetMusicVolume() [1/2]

proto native void SetMusicVolume	(	float	vol,
		float	time )

private

◆ SetMusicVolume() [2/2]

proto native void SetMusicVolume	(	float	vol,
		float	time )

private

◆ SetOcclusionObstruction() [1/2]

proto native void SetOcclusionObstruction	(	float	occlusion,
		float	obstruction )

◆ SetOcclusionObstruction() [2/2]

proto native void SetOcclusionObstruction	(	float	occlusion,
		float	obstruction )

private

◆ SetParent() [1/2]

proto native void SetParent	(	IEntity	parent,
		int	pivot = -1 )

Note: 'SoundObject' is not an Entity, and therefore can not be accessed by using 'IEntity.GetChildren', though internally 'SoundObject.SetParent' is similiar to 'IEntity.AddChild' by creating an 'EntityHierarchyComponent'.

References WAVEMUSIC.

◆ SetParent() [2/2]

proto native void SetParent	(	IEntity	parent,
		int	pivot = -1 )

private

Note: 'SoundObject' is not an Entity, and therefore can not be accessed by using 'IEntity.GetChildren', though internally 'SoundObject.SetParent' is similiar to 'IEntity.AddChild' by creating an 'EntityHierarchyComponent'.

◆ SetPosition() [1/3]

proto native void SetPosition ( vector pos )

Note: Sets the position locally if parented, retrieves globally with the sound offset.

Set the world position of the Effect.

Warning: Only sets the cached variable, for immediate effect use SetCurrent variant

Parameters

pos	`vector` The world position for the Effect

Definition at line 463 of file effect.c.

◆ SetPosition() [2/3]

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

◆ SetPosition() [3/3]

proto native void SetPosition ( vector position )

private

Note: Sets the position locally if parented, retrieves globally with the sound offset.

Referenced by DayZPlayer::HandleView(), DayZCreature::PlaySound(), DayZPlayer::PlaySound(), and EntityAI::PlaySound().

◆ SetRadioVolume() [1/2]

proto native void SetRadioVolume	(	float	vol,
		float	time )

private

◆ SetRadioVolume() [2/2]

proto native void SetRadioVolume	(	float	vol,
		float	time )

private

◆ SetSoundControllerOverride()

SetSoundControllerOverride	(	string	controllerName,
		float	value,
		SoundControllerAction	action )

Overrides or limits soundmap value for a sound cotroller.

Parameters

controllerName	the sound controller name. One of: rain,night,meadow,trees,hills,houses,windy,deadBody,sea,forest,altitudeGround,altitudeSea,altitudeSurface,daytime,shooting,coast,waterDepth,overcast,fog,snowfall,caveSmall,caveBig
action	what action will be used on the normal landscape sound controller value
value	the new value of sound controller

Referenced by PlayAmbientSound(), ManBase::SetContaminatedEffectEx(), and StopAmbientSound().

◆ SetSoundVolume() [1/2]

proto native void SetSoundVolume	(	float	vol,
		float	time )

private

◆ SetSoundVolume() [2/2]

proto native void SetSoundVolume	(	float	vol,
		float	time )

private

◆ SetSpeechExVolume() [1/2]

proto native void SetSpeechExVolume	(	float	vol,
		float	time )

private

◆ SetSpeechExVolume() [2/2]

proto native void SetSpeechExVolume	(	float	vol,
		float	time )

private

References WAVEWEAPONSEX.

◆ SetSpeed() [1/2]

proto native void SetSpeed ( vector speed )

Note: Sets the speed locally if parented, retrieves globally with the parent speed.

◆ SetSpeed() [2/2]

proto native void SetSpeed ( vector speed )

private

Note: Sets the speed locally if parented, retrieves globally with the parent speed.

◆ SetStartOffset()

proto void SetStartOffset ( float offset )

Referenced by PlayWithOffset().

◆ SetUserData()

proto void SetUserData ( Managed inst )

◆ SetVariable()

void SetVariable	(	string	name,
		float	value )

Deprecated - same functionality, just poor naming.

Definition at line 104 of file sound.c.

References AddVariable(), and name.

◆ SetVOIPVolume() [1/2]

proto native void SetVOIPVolume	(	float	vol,
		float	time )

private

◆ SetVOIPVolume() [2/2]

proto native void SetVOIPVolume	(	float	vol,
		float	time )

private

◆ SetVolume()

proto void SetVolume ( float value )

◆ SetVolumeRelative()

proto void SetVolumeRelative ( float value )

◆ Skip()

proto void Skip ( float timeSec )

◆ SoundObject() [2/2]

void SoundObject ( SoundParams soundParams )

◆ SoundObjectBuilder()

class AbstractSoundScene SoundObjectBuilder ( SoundParams soundParams )

Referenced by VegetationSound::VegetationSound(), AbstractSoundScene::BuildSoundObject(), AnimSoundObjectBuilderBank::GetBuilder(), DayZPlayerTypeAttachmentSoundLookupTable::GetSoundBuilder(), DayZPlayerTypeStepSoundLookupTable::GetSoundBuilder(), DayZPlayerTypeVoiceSoundLookupTable::GetSoundBuilder(), GetSoundBuilder(), SoundLookupTable::GetSoundBuilder(), VegetationSound::GetSoundObjectBuilder(), DayZPlayer::HandleView(), SoundLookupTable::LoadTable(), LoadVegetationSounds(), PluginBase::OnGUITimer(), DayZPlayer::OnStepEvent(), AbstractSoundScene::Play2D(), AbstractSoundScene::Play3D(), EntityAI::PlayImpactSound(), MissionBase::PlayMusic(), DayZCreature::PlaySound(), DayZPlayer::PlaySound(), EntityAI::PlaySound(), EntityAI::PlaySoundByAnimEvent(), PlayTrack(), DayZPlayer::ProcessAttachmentEvent(), DayZCreature::ProcessSoundEvent(), DayZPlayer::ProcessSoundEvent(), DayZCreature::ProcessSoundVoiceEvent(), DayZInfected::ProcessSoundVoiceEvent(), DayZCreature::ProcessStepEvent(), DayZPlayer::ProcessVoiceEvent(), DayZInfected::ProcessVoiceFX(), DayZPlayer::ProcessWeaponEvent(), ManBase::SaySoundSet(), DayZPlayer::SetVariablesLadderSoundObjectBuilder(), and EffectSound::SoundLoadEx().

◆ SoundParams()

class SoundObject SoundParams ( string name )

Referenced by SoundObject::SoundObject(), SEffectManager::GetCachedSoundParam(), DayZPlayer::HandleView(), Initialize(), SoundObject::Initialize(), LoadVegetationSounds(), PluginBase::OnGUITimer(), MissionBase::PlayMusic(), SEffectManager::PlaySoundCachedParams(), SEffectManager::PlaySoundParams(), PlayTrack(), DayZInfected::ProcessVoiceFX(), ManBase::SaySoundSet(), EffectSound::SoundLoad(), EffectSound::SoundLoadEx(), EffectSound::SoundPlay(), and EffectSound::SoundPlayEx().

◆ Stop()

proto void Stop ( )

Stops all elements this effect consists of.

Note: Alternatively use SEffectManager.Stop( effect_id )

Definition at line 183 of file effect.c.

References CALL_CATEGORY_GAMEPLAY, Event_OnStopped, g_Game, IsPlaying(), m_CommandSync, m_CurrentState, m_SoundSetCallback, m_time, Process(), and SetRunning().

Referenced by UIScriptedMenu::~CameraToolsMenu(), ~Effect(), Destroy(), UIScriptedMenu::OnClick(), UIScriptedMenu::OnKeyPress(), PPERequester_GameplayBase::OnUpdate(), and UIScriptedMenu::Update().

◆ UpdateEnvSoundControllers()

void UpdateEnvSoundControllers ( vector position )

Deprecated - same functionality, just poor naming.

Definition at line 98 of file sound.c.

References AddEnvSoundVariables().

◆ UpdateVariables() [1/2]

proto void UpdateVariables ( notnull array< float > values )

private

◆ UpdateVariables() [2/2]

proto void UpdateVariables ( notnull array< float > values )

Variable Documentation

◆ Event_OnSoundWaveEnded [1/2]

ref ScriptInvoker Event_OnSoundWaveEnded = new ScriptInvoker()

private

Definition at line 152 of file sound.c.

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

◆ Event_OnSoundWaveEnded [2/2]

ref ScriptInvoker Event_OnSoundWaveEnded = new ScriptInvoker()

Definition at line 162 of file sound.c.

◆ Event_OnSoundWaveHeaderLoaded [1/2]

ref ScriptInvoker Event_OnSoundWaveHeaderLoaded = new ScriptInvoker()

private

Definition at line 151 of file sound.c.

◆ Event_OnSoundWaveHeaderLoaded [2/2]

ref ScriptInvoker Event_OnSoundWaveHeaderLoaded = new ScriptInvoker()

Definition at line 161 of file sound.c.

◆ Event_OnSoundWaveLoaded [1/2]

ref ScriptInvoker Event_OnSoundWaveLoaded = new ScriptInvoker()

private

Definition at line 150 of file sound.c.

◆ Event_OnSoundWaveLoaded [2/2]

ref ScriptInvoker Event_OnSoundWaveLoaded = new ScriptInvoker()

Definition at line 160 of file sound.c.

◆ Event_OnSoundWaveStarted [1/2]

ref ScriptInvoker Event_OnSoundWaveStarted = new ScriptInvoker()

private

Definition at line 148 of file sound.c.

Referenced by EffectSound::ValidateSoundWave().

◆ Event_OnSoundWaveStarted [2/2]

ref ScriptInvoker Event_OnSoundWaveStarted = new ScriptInvoker()

Definition at line 158 of file sound.c.

◆ Event_OnSoundWaveStopped [1/2]

ref ScriptInvoker Event_OnSoundWaveStopped = new ScriptInvoker()

private

Definition at line 149 of file sound.c.

Referenced by Play().

◆ Event_OnSoundWaveStopped [2/2]

ref ScriptInvoker Event_OnSoundWaveStopped = new ScriptInvoker()

Definition at line 159 of file sound.c.

◆ Limit

Limit

Referenced by UpdateLRAngle(), UpdateLRAngleLookAt(), UpdateLRAngleUnlocked(), UpdateUDAngle(), and UpdateUDAngleUnlocked().

◆ None

None

◆ WAVEATTALWAYS

WAVEATTALWAYS

Definition at line 12 of file sound.c.

◆ WAVEEFFECT

WAVEEFFECT

Definition at line 3 of file sound.c.

Referenced by Play2D().

◆ WAVEEFFECTEX

WAVEEFFECTEX

Definition at line 4 of file sound.c.

Referenced by Play3D().

◆ WAVEENVIRONMENT

WAVEENVIRONMENT

Definition at line 8 of file sound.c.

Referenced by GetHierarchyPivot().

◆ WAVEENVIRONMENTEX

WAVEENVIRONMENTEX

Definition at line 9 of file sound.c.

◆ WAVEMUSIC

WAVEMUSIC

Definition at line 6 of file sound.c.

Referenced by SetParent().

◆ WAVESPEECH

WAVESPEECH

Definition at line 5 of file sound.c.

Referenced by BuildSoundObject().

◆ WAVESPEECHEX

WAVESPEECHEX

Definition at line 7 of file sound.c.

Referenced by GetRadioVolume().

◆ WAVEUI

WAVEUI

Definition at line 13 of file sound.c.

Referenced by GetMusicVolume().

◆ WAVEWEAPONS

WAVEWEAPONS

Definition at line 10 of file sound.c.

Referenced by GetSpeechExVolume().

◆ WAVEWEAPONSEX

WAVEWEAPONSEX

Definition at line 11 of file sound.c.

Referenced by SetSpeechExVolume().

Data Structures

Functions

Variables

Detailed Description

Function Documentation

◆ AbstractSoundScene() [1/2]

◆ SoundObject() [1/2]

◆ ~AbstractSoundScene() [1/2]

◆ ~AbstractSoundScene() [2/2]

◆ AbstractSoundScene() [2/2]

◆ AbstractWave()

◆ AddEnvSoundVariables()

◆ AddVariable()

◆ AddVariables()

◆ BuildSoundObject() [1/3]

◆ BuildSoundObject() [2/3]

◆ BuildSoundObject() [3/3]

◆ GetAudioLevel() [1/2]

◆ GetAudioLevel() [2/2]

◆ GetCurrPosition()

◆ GetEvents()

◆ GetFrequency()

◆ GetHierarchyPivot() [1/2]

◆ GetHierarchyPivot() [2/2]

◆ GetLength()

◆ GetMusicVolume() [1/2]

◆ GetMusicVolume() [2/2]

◆ GetName()

◆ GetParent() [1/2]

◆ GetParent() [2/2]

◆ GetPosition() [1/2]

◆ GetPosition() [2/2]

◆ GetRadioVolume() [1/2]

◆ GetRadioVolume() [2/2]

◆ GetSilenceThreshold() [1/2]

◆ GetSilenceThreshold() [2/2]

◆ GetSoundVolume() [1/2]

◆ GetSoundVolume() [2/2]

◆ GetSpeechExVolume() [1/2]

◆ GetSpeechExVolume() [2/2]

◆ GetSpeed() [1/2]

◆ GetSpeed() [2/2]

◆ GetUserData()

◆ GetVOIPVolume() [1/2]

◆ GetVOIPVolume() [2/2]

◆ GetVolume()

◆ InitEvents()

◆ Initialize() [1/2]

◆ Initialize() [2/2]

◆ IsHeaderLoaded()

◆ IsValid()

◆ Load()

◆ Loop()

◆ MuteAllSoundControllers()

◆ OnEnd()

◆ OnHeaderLoad()

◆ OnLoad()

◆ OnPlay()

◆ OnStop()

◆ Play()

◆ Play2D() [1/2]

◆ Play2D() [2/2]

◆ Play3D() [1/2]

◆ Play3D() [2/2]

◆ PlayWithOffset()

◆ ResetAllSoundControllers()

◆ Restart()

◆ SetDoppler()

◆ SetFadeInFactor()

◆ SetFadeOutFactor()

◆ SetFrequency()

◆ SetKind() [1/2]

◆ SetKind() [2/2]

◆ SetMusicVolume() [1/2]

◆ SetMusicVolume() [2/2]

◆ SetOcclusionObstruction() [1/2]

◆ SetOcclusionObstruction() [2/2]

◆ SetParent() [1/2]

◆ SetParent() [2/2]

◆ SetPosition() [1/3]