Navigation
API > API/Plugins > API/Plugins/AudioGameplayVolume
AudioGameplayVolume - A spatial volume used to notify audio gameplay systems when the nearest audio listener enters or exits the volume. Additionally, these volumes can influence audio sources depending on the relative position of the listener.
NOTE: Will only impact audio sources that have "apply ambient volumes" set on their sound class.
| Name | AAudioGameplayVolume |
| Type | class |
| Header File | /Engine/Plugins/AudioGameplayVolume/Source/AudioGameplayVolume/Public/AudioGameplayVolume.h |
| Include Path | #include "AudioGameplayVolume.h" |
Syntax
UCLASS (MinimalAPI, HideCategories=(Advanced, Attachment, Collision, Volume))
class AAudioGameplayVolume : public AVolume
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → AActor → ABrush → AVolume → AAudioGameplayVolume
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
AAudioGameplayVolume
(
const FObjectInitializer& ObjectInitializer |
AudioGameplayVolume.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnListenerEnterEvent | FAudioGameplayVolumeEvent | AudioGameplayVolume.h |
|
|
| OnListenerExitEvent | FAudioGameplayVolumeEvent | AudioGameplayVolume.h |
|
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AGVComponent | TObjectPtr< UAudioGameplayVolumeComponent > | A representation of this volume for the audio thread. | AudioGameplayVolume.h |
|
| bEnabled | bool | Whether this volume is currently enabled. | AudioGameplayVolume.h |
|
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
bool CanSupportProxy() |
AudioGameplayVolume.h | ||
bool GetEnabled() |
AudioGameplayVolume.h | ||
virtual void GetLifetimeReplicatedProps
(
TArray< FLifetimeProperty >& OutLifetimeProps |
AudioGameplayVolume.h | ||
void OnComponentDataChanged() |
Called by a child component to notify our proxy may need updating | AudioGameplayVolume.h | |
void OnListenerEnter() |
Blueprint event for listener enter | AudioGameplayVolume.h |
|
void OnListenerExit() |
Blueprint event for listener exit | AudioGameplayVolume.h |
|
virtual void PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
AudioGameplayVolume.h | ||
virtual void PostInitializeComponents() |
AudioGameplayVolume.h | ||
virtual void PostRegisterAllComponents() |
AudioGameplayVolume.h | ||
virtual void PostUnregisterAllComponents() |
AudioGameplayVolume.h | ||
void SetEnabled
(
bool bEnable |
Sets whether the volume is enabled | AudioGameplayVolume.h |
|
virtual bool ShouldCheckCollisionComponentForErrors() |
AudioGameplayVolume.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddProxy() |
AudioGameplayVolume.h | ||
virtual void OnRep_bEnabled() |
AudioGameplayVolume.h | ||
void RemoveProxy() |
AudioGameplayVolume.h | ||
void TransformUpdated
(
USceneComponent* InRootComponent, |
AudioGameplayVolume.h | ||
void UpdateProxy() |
AudioGameplayVolume.h |