CriWare Unreal Engine
Plug-ins for CriWare solutions.
Loading...
Searching...
No Matches
UAtomBusSendVolumeComponent Class Reference

#include <AtomBusSendVolumeComponent.h>

Inheritance diagram for UAtomBusSendVolumeComponent:

Public Member Functions

 UAtomBusSendVolumeComponent (const FObjectInitializer &ObjectInitializer)
virtual ~UAtomBusSendVolumeComponent ()=default
const TArray< FAtomVolumeBusSendSettings > & GetBusSendSettings () const
void SetBusSendSettings (const TArray< FAtomVolumeBusSendSettings > &NewBusSendSettings)
Public Member Functions inherited from UAtomGameplayVolumeMutator
 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

Private Member Functions

virtual void CopyAtomDataToMutator (TSharedPtr< FAtomProxyVolumeMutator > &Mutator) const override
virtual TSharedPtr< FAtomProxyVolumeMutator > FactoryMutator () const override

Private Attributes

TArray< FAtomVolumeBusSendSettings > BusSendSettings

Additional Inherited Members

Public Types inherited from UAtomGameplayComponent
using PayloadFlags = AtomGameplay::EComponentPayload
Protected Member Functions inherited from UAtomGameplayVolumeMutator
virtual void Enable () override
void NotifyDataChanged () const
Protected Member Functions inherited from UAtomGameplayComponent
virtual void Disable ()
Protected Attributes inherited from UAtomGameplayVolumeMutator
int32 Priority = 0
Protected Attributes inherited from UAtomGameplayComponent
PayloadFlags PayloadType = PayloadFlags::AGCP_None

Detailed Description

UAtomBusSendVolumeComponent - Atom Gameplay Volume component for bus sends

Constructor & Destructor Documentation

◆ UAtomBusSendVolumeComponent()

UAtomBusSendVolumeComponent::UAtomBusSendVolumeComponent ( const FObjectInitializer & ObjectInitializer)

◆ ~UAtomBusSendVolumeComponent()

virtual UAtomBusSendVolumeComponent::~UAtomBusSendVolumeComponent ( )
virtualdefault

Member Function Documentation

◆ CopyAtomDataToMutator()

void UAtomBusSendVolumeComponent::CopyAtomDataToMutator ( TSharedPtr< FAtomProxyVolumeMutator > & Mutator) const
overrideprivatevirtual

Override in child classes to copy additional data needed to mutators

Reimplemented from UAtomGameplayVolumeMutator.

◆ FactoryMutator()

TSharedPtr< FAtomProxyVolumeMutator > UAtomBusSendVolumeComponent::FactoryMutator ( ) const
overrideprivatevirtual

Create this component's type of mutator

Reimplemented from UAtomGameplayVolumeMutator.

◆ GetBusSendSettings()

const TArray< FAtomVolumeBusSendSettings > & UAtomBusSendVolumeComponent::GetBusSendSettings ( ) const
inline

◆ SetBusSendSettings()

void UAtomBusSendVolumeComponent::SetBusSendSettings ( const TArray< FAtomVolumeBusSendSettings > & NewBusSendSettings)

Member Data Documentation

◆ BusSendSettings

TArray<FAtomVolumeBusSendSettings> UAtomBusSendVolumeComponent::BusSendSettings
private

Bus send settings to use for this component. Allows audio to dynamically send to buses based on source and listener locations (relative to parent volume.)


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