UAudioGameplayVolumeProxyComponent

[UAudioGameplayVolumeProxyComponent](API\Plugins\AudioGameplayVolume\UAudioGameplayVolumeProxyCompone-) - Component used to drive interaction with AudioGameplayVolumeSubsystem.

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

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 UAudioGameplayVolumeProxyComponent : public UAudioGameplayComponent

Remarks

UAudioGameplayVolumeProxyComponent - Component used to drive interaction with AudioGameplayVolumeSubsystem.

Do not inherit from this class, use UAudioGameplayVolumeComponentBase to create extendable functionality

Variables

Name Description

Public variable UProperty Category BlueprintAssignable

FOnAudioGamepla...

 

OnProxyEnter

Blueprint event for proxy enter

Public variable UProperty Category BlueprintAssignable

FOnAudioGamepla...

 

OnProxyExit

Blueprint event for proxy exit

Protected variable UProperty Category, EditAnywhere, Meta BlueprintReadWrite instanced

UAudioGameplayV...

 

Proxy

A representation of this volume for the audio thread.

Destructors

Functions

Name Description

Protected function Const

void

 

AddProxy()

Public function Const

void

 

EnterProxy()

Called when the proxy is 'entered' - This is when the proxy goes from zero listeners to at lesat one.

Public function Const

void

 

ExitProxy()

Called when the proxy is 'exited' - This is when the proxy goes from at least one listeners to zero.

Public function

UAudioGamepl...

 

final

(
    const FObjectInitializer& ObjectIn...
)

Public function Const

UAudioGamepl...

 

GetProxy()

Protected function Const

UAudioGamepl...

 

GetSubsystem()

Public function

void

 

OnComponentDataChanged()

Called by a component on same actor to notify our proxy may need updating

Protected function Const

void

 

RemoveProxy()

Public function

void

 

SetProxy

(
    UAudioGameplayVolumeProxy* New...
)

Protected function Const

void

 

UpdateProxy()

Overridden from UAudioGameplayComponent

Name Description

Protected function Virtual

void

 

Disable()

Protected function Virtual

void

 

Enable()

Overridden from UActorComponent

Name Description

Protected function Virtual

void

 

OnUnregister()

Called when a component is unregistered.

Overridden from UObject

Name Description

Protected function Virtual

void

 

PostEditChangeProperty

(
    FPropertyChangedEvent& PropertyCha...
)

Called when a property on this object has been modified externally