AAtomGameplayVolume Class Reference

#include <AtomGameplayVolume.h>

Inheritance diagram for AAtomGameplayVolume:

Public Member Functions
	AAtomGameplayVolume (const FObjectInitializer &ObjectInitializer)
bool	CanSupportProxy () const
bool	GetEnabled () const
virtual void	GetLifetimeReplicatedProps (TArray< FLifetimeProperty > &OutLifetimeProps) const override
void	OnComponentDataChanged ()
void	OnListenerEnter ()
void	OnListenerExit ()
virtual void	PostInitializeComponents () override
virtual void	PostRegisterAllComponents () override
virtual void	PostUnregisterAllComponents () override
void	SetEnabled (bool bEnable)

Public Attributes
FAtomGameplayVolumeEvent	OnListenerEnterEvent
FAtomGameplayVolumeEvent	OnListenerExitEvent

Protected Member Functions
void	AddProxy () const
virtual void	OnRep_bEnabled ()
void	RemoveProxy () const
void	TransformUpdated (USceneComponent *InRootComponent, EUpdateTransformFlags UpdateTransformFlags, ETeleportType Teleport)
void	UpdateProxy () const

Private Attributes
TObjectPtr< UAtomGameplayVolumeComponent >	AGVComponent = nullptr
bool	bEnabled = true

Detailed Description

AtomGameplayVolume - A spatial volume used to notify Atom gameplay systems when the nearest Atom audio listener enters or exits the volume. Additionally, these volumes can influence Atom sources depending on the relative position of the listener.

NOTE: Will only impact Atom sound sources that have "apply ambient volumes" set on their Atom sound category.

Constructor & Destructor Documentation

AAtomGameplayVolume()

AAtomGameplayVolume::AAtomGameplayVolume

(

const FObjectInitializer &

ObjectInitializer

)

Member Function Documentation

AddProxy()

void AAtomGameplayVolume::AddProxy ( ) const

protected

CanSupportProxy()

bool AAtomGameplayVolume::CanSupportProxy

(

)

const

GetEnabled()

bool AAtomGameplayVolume::GetEnabled ( ) const

inline

GetLifetimeReplicatedProps()

void AAtomGameplayVolume::GetLifetimeReplicatedProps ( TArray< FLifetimeProperty > & OutLifetimeProps ) const

overridevirtual

OnComponentDataChanged()

void AAtomGameplayVolume::OnComponentDataChanged

(

)

Called by a child component to notify our proxy may need updating

OnListenerEnter()

void AAtomGameplayVolume::OnListenerEnter

(

)

Blueprint event for listener enter

OnListenerExit()

void AAtomGameplayVolume::OnListenerExit

(

)

Blueprint event for listener exit

OnRep_bEnabled()

void AAtomGameplayVolume::OnRep_bEnabled ( )

protectedvirtual

PostInitializeComponents()

void AAtomGameplayVolume::PostInitializeComponents ( )

overridevirtual

PostRegisterAllComponents()

void AAtomGameplayVolume::PostRegisterAllComponents ( )

overridevirtual

PostUnregisterAllComponents()

void AAtomGameplayVolume::PostUnregisterAllComponents ( )

overridevirtual

RemoveProxy()

void AAtomGameplayVolume::RemoveProxy ( ) const

protected

SetEnabled()

void AAtomGameplayVolume::SetEnabled

(

bool

bEnable

)

Sets whether the volume is enabled

TransformUpdated()

void AAtomGameplayVolume::TransformUpdated ( USceneComponent * InRootComponent, EUpdateTransformFlags UpdateTransformFlags, ETeleportType Teleport )

protected

UpdateProxy()

void AAtomGameplayVolume::UpdateProxy ( ) const

protected

Member Data Documentation

AGVComponent

TObjectPtr<UAtomGameplayVolumeComponent> AAtomGameplayVolume::AGVComponent = nullptr

private

bEnabled

bool AAtomGameplayVolume::bEnabled = true

private

OnListenerEnterEvent

FAtomGameplayVolumeEvent AAtomGameplayVolume::OnListenerEnterEvent

OnListenerExitEvent

FAtomGameplayVolumeEvent AAtomGameplayVolume::OnListenerExitEvent

---

The documentation for this class was generated from the following files:

• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Public/Atom/Gameplay/AtomGameplayVolume.h
• C:/git/uev2/Engine/Plugins/Runtime/CriWare/CriWare/Source/CriWareCore/Private/Atom/Gameplay/AtomGameplayVolume.cpp