UAudioGameplayVolumeComponent | Unreal Engine 5.5 Documentation

Unreal Engine C++ API Reference > Plugins > AudioGameplayVolume

Inheritance Hierarchy

UActorComponent
UAudioGameplayComponent
UAudioGameplayVolumeComponent

References


Module	AudioGameplayVolume
Header	/Engine/Plugins/AudioGameplayVolume/Source/AudioGameplayVolume/Public/AudioGameplayVolumeComponent.h
Include	#include "AudioGameplayVolumeComponent.h"

Syntax

UCLASS (Config=Game, ClassGroup=("AudioGameplay"),  
       Meta=(BlueprintSpawnableComponent, IsBlueprintBase=false, DisplayName="Volume Proxy"))  
class UAudioGameplayVolumeComponent : public UAudioGameplayComponent

Remarks

UAudioGameplayVolumeComponent - Component used to drive interaction with AudioGameplayVolumeSubsystem. NOTE: Do not inherit from this class, use UAudioGameplayVolumeComponentBase or UAudioGameplayVolumeMutator to create extendable functionality

Variables

Type	Name	Description
FOnAudioGameplayVolumeProxyStateChange	OnProxyEnter	Blueprint event for proxy enter
FOnAudioGameplayVolumeProxyStateChange	OnProxyExit	Blueprint event for proxy exit
TObjectPtr< UAudioGameplayVolumeProxy >	Proxy	A representation of this volume for the audio thread.

Destructors

	Type	Name	Description
		~UAudioGameplayVolumeComponent ()

Functions

Type	Name	Description
void	AddProxy ()
void	EnterProxy ()	Called when the proxy is 'entered' - This is when the proxy goes from zero listeners to at least one.
void	ExitProxy ()	Called when the proxy is 'exited' - This is when the proxy goes from at least one listeners to zero.
UAudioGameplayVolumeComponent	final ( const FObjectInitializer& ObjectInitializer )
UAudioGameplayVolumeProxy *	GetProxy ()
UAudioGameplayVolumeSubsystem *	GetSubsystem ()
void	OnComponentDataChanged ()	Called by a component on same actor to notify our proxy may need updating
void	OnUnregister ()
void	PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent )
void	RemoveProxy ()
void	SetProxy ( UAudioGameplayVolumeProxy* NewProxy )
void	UpdateProxy ()