Navigation
API > API/Plugins > API/Plugins/AudioGameplayVolume
UFilterVolumeComponent - Audio Gameplay Volume component for occlusion settings (volume filter)
| Name | UFilterVolumeComponent |
| Type | class |
| Header File | /Engine/Plugins/AudioGameplayVolume/Source/AudioGameplayVolume/Public/FilterVolumeComponent.h |
| Include Path | #include "FilterVolumeComponent.h" |
Syntax
UCLASS (MinimalAPI, Blueprintable, Config=Game, ClassGroup=("AudioGameplayVolume"),
Meta=(BlueprintSpawnableComponent, DisplayName="Filter"))
class UFilterVolumeComponent : public UAudioGameplayVolumeMutator
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UActorComponent → UAudioGameplayComponent → UAudioGameplayVolumeMutator → UFilterVolumeComponent
Implements Interfaces
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UFilterVolumeComponent
(
const FObjectInitializer& ObjectInitializer |
FilterVolumeComponent.h |
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UFilterVolumeComponent() |
FilterVolumeComponent.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ExteriorLPF | float | The desired LPF frequency cutoff (in hertz) of sounds outside the volume when the player is inside the volume. | FilterVolumeComponent.h |
|
| ExteriorLPFTime | float | The time over which to interpolate from the current LPF to the desired LPF of sounds outside the volume when the player enters the volume. | FilterVolumeComponent.h |
|
| InteriorLPF | float | The desired LPF frequency cutoff (in hertz) of sounds inside the volume when the player is outside the volume. | FilterVolumeComponent.h |
|
| InteriorLPFTime | float | The time over which to interpolate from the current LPF to the desired LPF of sounds inside the volume when the player enters the volume. | FilterVolumeComponent.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
float GetExteriorLPF() |
FilterVolumeComponent.h | ||
float GetExteriorLPFTime() |
FilterVolumeComponent.h | ||
float GetInteriorLPF() |
FilterVolumeComponent.h | ||
float GetInteriorLPFTime() |
FilterVolumeComponent.h | ||
void SetExteriorLPF
(
UPARAM(DisplayName="Frequency") float Volume, |
FilterVolumeComponent.h |
|
|
void SetInteriorLPF
(
UPARAM(DisplayName="Frequency") float Volume, |
FilterVolumeComponent.h |
|