UAttenuationVolumeComponent | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/AudioGameplayVolume

Component driving the volume of sounds playing inside or outside the associated AGV according to where the audio listener lays relative to this spatial volume. Note: This component is only compatible with Audio Toggles using a "Listener in Primitives" or "Listener in Range" condition.


Name	UAttenuationVolumeComponent
Type	class
Header File	/Engine/Plugins/AudioGameplayVolume/Source/AudioGameplayVolume/Public/AttenuationVolumeComponent.h
Include Path	#include "AttenuationVolumeComponent.h"

Syntax

UCLASS (MinimalAPI, Blueprintable, Config=Game, ClassGroup=("AudioGameplayVolume"),  
       Meta=(BlueprintSpawnableComponent, DisplayName="Interior-Exterior Attenuation"))  
class UAttenuationVolumeComponent : public UAudioGameplayVolumeMutator

Inheritance Hierarchy

UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UAudioGameplayComponent → UAudioGameplayVolumeMutator → UAttenuationVolumeComponent

Implements Interfaces

Constructors

Name	Remarks	Include Path	Unreal Specifiers
UAttenuationVolumeComponent ( const FObjectInitializer& ObjectInitializer )		AttenuationVolumeComponent.h

Destructors

Name	Remarks	Include Path	Unreal Specifiers
virtual ~UAttenuationVolumeComponent()		AttenuationVolumeComponent.h

Variables

Protected

Name	Type	Remarks	Include Path	Unreal Specifiers
ExteriorTime	float	The time over which to interpolate from the current volume to the desired volume of sounds outside the volume when the player enters the volume.	AttenuationVolumeComponent.h	EditAnywhere BlueprintReadOnly Category="VolumeAttenuation" Meta=(AllowPrivateAccess="true")
ExteriorVolume	float	The desired volume of sounds outside the volume when the player is inside the volume.	AttenuationVolumeComponent.h	EditAnywhere BlueprintReadOnly Category="VolumeAttenuation" Meta=(AllowPrivateAccess="true")
InteriorTime	float	The time over which to interpolate from the current volume to the desired volume of sounds inside the volume when the player enters the volume.	AttenuationVolumeComponent.h	EditAnywhere BlueprintReadOnly Category="VolumeAttenuation" Meta=(AllowPrivateAccess="true")
InteriorVolume	float	The desired volume of sounds inside the volume when the player is outside the volume.	AttenuationVolumeComponent.h	EditAnywhere BlueprintReadOnly Category="VolumeAttenuation" Meta=(AllowPrivateAccess="true")

Functions

Public

Name	Include Path	Unreal Specifiers
float GetExteriorTime()	AttenuationVolumeComponent.h
float GetExteriorVolume()	AttenuationVolumeComponent.h
float GetInteriorTime()	AttenuationVolumeComponent.h
float GetInteriorVolume()	AttenuationVolumeComponent.h
void SetExteriorVolume ( float Volume, float InterpolateTime )	AttenuationVolumeComponent.h	BlueprintCallable Category="AudioGameplay"
void SetInteriorVolume ( float Volume, float InterpolateTime )	AttenuationVolumeComponent.h	BlueprintCallable Category="AudioGameplay"

Navigation