Open 3D Engine LmbrCentral Gem API Reference 23.10.0
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 Protected Member Functions | List of all members
LmbrCentral::AudioProxyComponent Class Reference

#include <AudioProxyComponent.h>

Inherits AZ::Component, AZ::TransformNotificationBus::Handler, and AudioProxyComponentRequestBus::Handler.

Public Member Functions

 AZ_COMPONENT (AudioProxyComponent, "{0EE6EE0F-7939-4AB8-B0E3-F9B3925D61EE}")
 
void Activate () override
 
void Deactivate () override
 
void OnTransformChanged (const AZ::Transform &, const AZ::Transform &) override
 
bool ExecuteTrigger (const Audio::TAudioControlID triggerID) override
 
bool ExecuteSourceTrigger (const Audio::TAudioControlID triggerID, const Audio::SAudioSourceInfo &sourceInfo) override
 
void KillTrigger (const Audio::TAudioControlID triggerID) override
 
void KillAllTriggers () override
 
void SetRtpcValue (const Audio::TAudioControlID rtpcID, float value) override
 
void SetSwitchState (const Audio::TAudioControlID switchID, const Audio::TAudioSwitchStateID stateID) override
 
void SetEnvironmentAmount (const Audio::TAudioEnvironmentID environmentID, float amount) override
 
void SetMovesWithEntity (bool shouldTrackEntity) override
 
void SetObstructionCalcType (const Audio::ObstructionType type) override
 
void SetPosition (const Audio::SATLWorldPosition &position) override
 
void SetMultiplePositions (const Audio::MultiPositionParams &params) override
 

Static Protected Member Functions

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

Detailed Description

AudioProxyComponent A component wrapper for an AudioProxy, which acts as a proxy for a logical Audio Object. ATL components 'share' the AudioProxyComponent on an Entity. There is only 1 AudioProxyComponent allowed on an Entity.

Member Function Documentation

◆ AZ_COMPONENT()

LmbrCentral::AudioProxyComponent::AZ_COMPONENT ( AudioProxyComponent  ,
"{0EE6EE0F-7939-4AB8-B0E3-F9B3925D61EE}"   
)

AZ::Component

◆ ExecuteTrigger()

bool LmbrCentral::AudioProxyComponent::ExecuteTrigger ( const Audio::TAudioControlID  triggerID)
override

AudioProxyComponentRequestBus::Handler Required Interface

◆ OnTransformChanged()

void LmbrCentral::AudioProxyComponent::OnTransformChanged ( const AZ::Transform &  ,
const AZ::Transform &   
)
override

AZ::TransformNotificationBus::Handler Required Interface

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