Navigation
API > API/Plugins > API/Plugins/AudioGameplayVolume
Inheritance Hierarchy
- UObjectBase
- UObjectBaseUtility
- UObject
- UActorComponent
- UAudioGameplayComponent
- UAudioGameplayVolumeComponent
References
| Module | AudioGameplayVolume |
| Header | /Engine/Plugins/AudioGameplayVolume/Source/AudioGameplayVolume/Public/AudioGameplayVolumeComponent.h |
| Include | #include "AudioGameplayVolumeComponent.h" |
Syntax
UCLASS&40;Config&61;Game, ClassGroup&61;&40;"AudioGameplay"&41;,
Meta&61;&40;BlueprintSpawnableComponent, IsBlueprintBase&61;false, DisplayName&61;"Volume Proxy"&41;&41;
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 | |
|---|---|---|---|
  |
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 | Called by a component on same actor to notify our proxy may need updating | |
  |
void | RemoveProxy () |
|
 |
void | SetProxy
(
UAudioGameplayVolumeProxy* NewProxy |
|
  |
void | UpdateProxy () |
Overridden from UAudioGameplayComponent
Overridden from UActorComponent
| Type | Name | Description | |
|---|---|---|---|
  |
void | OnUnregister () |
Called when a component is unregistered. |
Overridden from UObject
| Type | Name | Description | |
|---|---|---|---|
  |
void | PostEditChangeProperty
(
FPropertyChangedEvent& PropertyChangedEvent |
Called when a property on this object has been modified externally |