1. Epic GamesDeveloper
  3. AAudioGameplayVolume

AAudioGameplayVolume

AudioGameplayVolume - A spatial volume used to notify audio gameplay systems when the nearest audio listener enters or exits the volume.

API > API/Plugins > API/Plugins/AudioGameplayVolume

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;HideCategories&61;&40;Advanced, Attachment, Collision, Volume&41;&41;  
class AAudioGameplayVolume : public AVolume

Remarks

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.

Variables

  Type Name Description
Public variable UProperty Category BlueprintAssignable FAudioGameplayVolumeEvent OnListenerEnterEvent  
Public variable UProperty Category BlueprintAssignable FAudioGameplayVolumeEvent OnListenerExitEvent  

Constructors

  Type Name Description
Public function  

AAudioGameplayVolume ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Protected function Const void  
Public function Const bool  
Public function Const bool  
Public function void Called by a child component to notify our proxy may need updating
Public function UFunction Category blueprintnativeevent void Blueprint event for listener enter
Public function UFunction Category blueprintnativeevent void Blueprint event for listener exit
Protected function Virtual UFunction void  
Protected function Const void  
Public function UFunction BlueprintCallable, Category void

SetEnabled ( bool bEnable
)

 Sets whether the volume is enabled
Protected function void

TransformUpdated ( USceneComponent* InRootComponent,
EUpdateTransformFlags UpdateTransformFlags,
ETeleportType Teleport
)

  
Protected function Const void  

Overridden from AVolume

  Type Name Description
Public function Virtual Const bool  

Overridden from AActor

  Type Name Description
Public function Virtual void Allow actors to initialize themselves on the C++ side after all of their components have been initialized, only called during gameplay
Public function Virtual void Called after all the components in the Components array are registered, called both in editor and during gameplay.
Public function Virtual void Called after all currently registered components are cleared

Overridden from UObject

  Type Name Description
Public function Virtual Const void Returns the properties used for network replication, this needs to be overridden by all actor classes with native replicated properties
Public function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page