Navigation
API > API/Plugins > API/Plugins/AudioGameplayVolume
Abstract condition type for Audio Toggles (UAudioGameplayVolumeComponent).
The way Audio Toggles evaluate to On or Off is implemented in child classes by overriding the ContainsPosition function (because toggles were originally only implemented as the audio listener being inside or outside some 3D area (or "volume")).
| Name | UAudioGameplayVolumeProxy |
| Type | class |
| Header File | /Engine/Plugins/AudioGameplayVolume/Source/AudioGameplayVolume/Public/AudioGameplayVolumeProxy.h |
| Include Path | #include "AudioGameplayVolumeProxy.h" |
Syntax
UCLASS (MinimalAPI, Abstract, EditInlineNew, HideDropDown)
class UAudioGameplayVolumeProxy : public UObject
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → UAudioGameplayVolumeProxy
Derived Classes
Destructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual ~UAudioGameplayVolumeProxy() |
AudioGameplayVolumeProxy.h |
Typedefs
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| PayloadFlags | AudioGameplay::EComponentPayload | AudioGameplayVolumeProxy.h | |
| ProxyMutatorList | TArray< TSharedPtr< FProxyVolumeMutator > > | AudioGameplayVolumeProxy.h |
Variables
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| AGVOwnerKey | FObjectKey | Only for profiling use. | AudioGameplayVolumeProxy.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddPayloadType
(
PayloadFlags InType |
AudioGameplayVolumeProxy.h | ||
void CollectMutators
(
ProxyMutatorList& OutMutators |
AudioGameplayVolumeProxy.h | ||
FName GetOwnerName() |
AudioGameplayVolumeProxy.h | ||
uint32 GetVolumeID() |
AudioGameplayVolumeProxy.h | ||
uint32 GetWorldID() |
AudioGameplayVolumeProxy.h | ||
bool HasPayloadType
(
PayloadFlags InType |
AudioGameplayVolumeProxy.h |
Public Virtual
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual bool ContainsPosition
(
const FVector& Position |
AudioGameplayVolumeProxy.h | ||
virtual void DrawVisualization
(
const UActorComponent* Component, |
Used for debug visualization of UAudioGameplayVolumeProxy in the editor | AudioGameplayVolumeProxy.h | |
virtual void InitFromComponent
(
const UAudioGameplayVolumeComponent* Component |
AudioGameplayVolumeProxy.h |