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::AudioSwitchComponent Class Reference

#include <AudioSwitchComponent.h>

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

Public Member Functions

 AZ_COMPONENT (AudioSwitchComponent, "{85FD9037-A5EA-4783-B49A-7959BBB34011}")
 
void Activate () override
 
void Deactivate () override
 
 AudioSwitchComponent (const AZStd::string &switchName, const AZStd::string &stateName)
 
void SetState (const char *stateName) override
 
void SetSwitchState (const char *switchName, const char *stateName) override
 

Static Public Member Functions

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

Detailed Description

AudioSwitchComponent A 'Switch' is something that can be in one 'State' at a time, but "switched" at run-time. For example, a Switch called 'SurfaceMaterial' might have States such as 'Grass', 'Snow', 'Metal', 'Wood'. But a Footstep sound would only be in one of those States at a time.

Member Function Documentation

◆ AZ_COMPONENT()

LmbrCentral::AudioSwitchComponent::AZ_COMPONENT ( AudioSwitchComponent  ,
"{85FD9037-A5EA-4783-B49A-7959BBB34011}"   
)

AZ::Component

◆ SetState()

void LmbrCentral::AudioSwitchComponent::SetState ( const char *  stateName)
override

AudioSwitchComponentRequestBus::Handler Interface

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