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 Public Member Functions | List of all members
LmbrCentral::AudioTriggerComponent Class Reference

#include <AudioTriggerComponent.h>

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

Public Member Functions

 AZ_COMPONENT (AudioTriggerComponent, "{8CBBB54B-7435-4D33-844D-E7F201BD581A}")
 
void Activate () override
 
void Deactivate () override
 
 AudioTriggerComponent (const AZStd::string &playTriggerName, const AZStd::string &stopTriggerName, Audio::ObstructionType obstructionType, bool playsImmediately)
 
 AZ_DISABLE_COPY (AudioTriggerComponent)
 
void Play () override
 
void Stop () override
 
void ExecuteTrigger (const char *triggerName) override
 
void KillTrigger (const char *triggerName) override
 
void KillAllTriggers () override
 
void SetMovesWithEntity (bool shouldTrackEntity) override
 
void SetObstructionType (Audio::ObstructionType obstructionType) override
 

Static Public Member Functions

static void GetDependentServices (AZ::ComponentDescriptor::DependencyArrayType &dependent)
 
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

AudioTriggerComponent Allows controlling ATL Triggers, executing and stopping them. Trigger name can be serialized with the component, or manually specified at runtime for use in scripting. There is only 1 AudioTriggerComponent allowed on an Entity, but the interface supports firing multiple ATL Triggers.

Member Function Documentation

◆ AZ_COMPONENT()

LmbrCentral::AudioTriggerComponent::AZ_COMPONENT ( AudioTriggerComponent  ,
"{8CBBB54B-7435-4D33-844D-E7F201BD581A}"   
)

AZ::Component

◆ Play()

void LmbrCentral::AudioTriggerComponent::Play ( )
override

AudioTriggerComponentRequestBus::Handler Interface

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