#include <AtomGameplayVolumeMutator.h>

Inheritance diagram for UAtomGameplayVolumeMutator:

Public Member Functions
	UAtomGameplayVolumeMutator (const FObjectInitializer &ObjectInitializer)
virtual	~UAtomGameplayVolumeMutator ()=default
virtual TSharedPtr< FAtomProxyVolumeMutator >	CreateMutator () const final
int32	GetPriority () const
void	SetPriority (int32 InPriority)
Public Member Functions inherited from UAtomGameplayComponent
	UAtomGameplayComponent (const FObjectInitializer &ObjectInitializer)
virtual	~UAtomGameplayComponent ()=default
virtual void	Activate (bool bReset=false) override
virtual void	Deactivate () override
virtual void	EndPlay (const EEndPlayReason::Type EndPlayReason) override
virtual bool	HasPayloadType (PayloadFlags InType) const

Protected Member Functions
virtual void	CopyAtomDataToMutator (TSharedPtr< FAtomProxyVolumeMutator > &Mutator) const
virtual void	Enable () override
virtual TSharedPtr< FAtomProxyVolumeMutator >	FactoryMutator () const
void	NotifyDataChanged () const
Protected Member Functions inherited from UAtomGameplayComponent
virtual void	Disable ()

Protected Attributes
int32	Priority = 0
Protected Attributes inherited from UAtomGameplayComponent
PayloadFlags	PayloadType = PayloadFlags::AGCP_None

Private Member Functions
void	CopyAtomDataToMutatorBase (TSharedPtr< FAtomProxyVolumeMutator > &Mutator) const

Additional Inherited Members
Public Types inherited from UAtomGameplayComponent
using	PayloadFlags = AtomGameplay::EComponentPayload

Detailed Description

UAtomGameplayVolumeMutator - These components are used for more complex interactions with AtomGameplayVolumes. Currently, components inheriting this base can affect interior settings as well as active sounds or the Atom listener(s) inside the volume. See also: AtomFilterVolumeComponent, AtomAttenuationVolumeComponent, AtomBusSendComponent, AtomAisacVolumeComponent, and AtomReverbVolumeComponent

Constructor & Destructor Documentation

◆ UAtomGameplayVolumeMutator()

UAtomGameplayVolumeMutator::UAtomGameplayVolumeMutator ( const FObjectInitializer & ObjectInitializer )

◆ ~UAtomGameplayVolumeMutator()

virtual UAtomGameplayVolumeMutator::~UAtomGameplayVolumeMutator ( )

virtualdefault

Member Function Documentation

◆ CopyAtomDataToMutator()

virtual void UAtomGameplayVolumeMutator::CopyAtomDataToMutator ( TSharedPtr< FAtomProxyVolumeMutator > & Mutator ) const

inlineprotectedvirtual

Override in child classes to copy additional data needed to mutators

Reimplemented in UAtomAisacVolumeComponent, UAtomAttenuationVolumeComponent, UAtomBusSendVolumeComponent, UAtomFilterVolumeComponent, UAtomPortalVolumeComponent, and UAtomRoomVolumeComponent.

◆ CopyAtomDataToMutatorBase()

void UAtomGameplayVolumeMutator::CopyAtomDataToMutatorBase ( TSharedPtr< FAtomProxyVolumeMutator > & Mutator ) const

private

Called for you during mutator creation. See CopyAtomDataToMutator for adding data to derived classes

◆ CreateMutator()

TSharedPtr< FAtomProxyVolumeMutator > UAtomGameplayVolumeMutator::CreateMutator ( ) const

finalvirtual

Create and fill the appropriate proxy mutator for this component

◆ Enable()

void UAtomGameplayVolumeMutator::Enable ( )

overrideprotectedvirtual

Reimplemented from UAtomGameplayComponent.

◆ FactoryMutator()

TSharedPtr< FAtomProxyVolumeMutator > UAtomGameplayVolumeMutator::FactoryMutator ( ) const

protectedvirtual

Create this component's type of mutator

Reimplemented in UAtomAisacVolumeComponent, UAtomAttenuationVolumeComponent, UAtomBusSendVolumeComponent, UAtomFilterVolumeComponent, UAtomPortalVolumeComponent, and UAtomRoomVolumeComponent.

◆ GetPriority()

int32 UAtomGameplayVolumeMutator::GetPriority ( ) const

inline

◆ NotifyDataChanged()

void UAtomGameplayVolumeMutator::NotifyDataChanged ( ) const

protected

Notify our parent volume our proxy may need updating

◆ SetPriority()

void UAtomGameplayVolumeMutator::SetPriority ( int32 InPriority )

Member Data Documentation

◆ Priority

int32 UAtomGameplayVolumeMutator::Priority = 0