Open 3D Engine LmbrCentral Gem API Reference  24.09
O3DE is an open-source, fully-featured, high-fidelity, modular 3D engine for building games and simulations, available to every industry.
Public Member Functions | Static Public Member Functions | List of all members
LmbrCentral::AudioEnvironmentComponent Class Reference

#include <AudioEnvironmentComponent.h>

Inherits AZ::Component, and AudioEnvironmentComponentRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (AudioEnvironmentComponent, "{D5085D04-2522-4585-9E65-D337C5BBB8A7}")
 
void Activate () override
 
void Deactivate () override
 
 AudioEnvironmentComponent (const AZStd::string &environmentName)
 
void SetAmount (float amount) override
 
void SetEnvironmentAmount (const char *environmentName, float amount) override
 

Static Public Member Functions

static void GetProvidedServices (AZ::ComponentDescriptor::DependencyArrayType &provided)
 
static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
static void GetRequiredServices (AZ::ComponentDescriptor::DependencyArrayType &required)
 
static void GetIncompatibleServices (AZ::ComponentDescriptor::DependencyArrayType &incompatible)
 
static void Reflect (AZ::ReflectContext *context)
 

Detailed Description

AudioEnvironmentComponent Allows "sending" an amount of sound signal through effects. Typically this is done via auxillary effects bus sends. The signal goes through the bus and comes out 'wet' and is mixed into the original 'dry' sound. Only 1 AudioEnvironmentComponent is allowed on an Entity, but the api supports multiple Environment sends.

Member Function Documentation

◆ AZ_COMPONENT()

LmbrCentral::AudioEnvironmentComponent::AZ_COMPONENT ( AudioEnvironmentComponent  ,
"{D5085D04-2522-4585-9E65-D337C5BBB8A7}"   
)

AZ::Component

◆ SetAmount()

void LmbrCentral::AudioEnvironmentComponent::SetAmount ( float  amount)
override

AudioEnvironmentComponentRequestBus::Handler Interface

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