Open 3D Engine EMotionFX 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 Attributes | List of all members
EMotionFX::Integration::AnimAudioComponentRequests Class Referenceabstract

#include <AnimAudioComponentBus.h>

Inherits AZ::ComponentBus.

Public Member Functions

virtual void AddTriggerEvent (const AZStd::string &eventName, const AZStd::string &triggerName, const AZStd::string &jointName)=0
 Adds audio support to when an anim event is fired.
 
virtual void ClearTriggerEvents ()=0
 Clears all audio support for anim events.
 
virtual void RemoveTriggerEvent (const AZStd::string &eventName)=0
 Removes audio support from an anim event.
 
virtual bool ExecuteSourceTrigger (const Audio::TAudioControlID triggerID, const Audio::TAudioControlID &sourceId, const AZStd::string &jointName)=0
 Execute a single ATL source trigger on a joint proxy.
 
virtual bool ExecuteTrigger (const Audio::TAudioControlID triggerID, const AZStd::string &jointName)=0
 Execute a single ATL trigger on a joint proxy.
 
virtual void KillTrigger (const Audio::TAudioControlID triggerID, const AZStd::string *jointName=nullptr)=0
 Kill a single or all ATL triggers on a joint proxy. If a joint name is provided, only kill on provided joint. Otherwise, kill all joints' audio triggers.
 
virtual void KillAllTriggers (const AZStd::string *jointName=nullptr)=0
 
virtual void SetRtpcValue (const Audio::TAudioControlID rtpcID, float value, const AZStd::string *jointName=nullptr)=0
 Set an Rtpc on a joint proxy. If a joint name is provided, only set on provided joint. Otherwise, set on all joints.
 
virtual void SetSwitchState (const Audio::TAudioControlID switchID, const Audio::TAudioSwitchStateID stateID, const AZStd::string *jointName=nullptr)=0
 Set a Switch State on a joint proxy. If a joint name is provided, only set on provided joint. Otherwise, set on all joints.
 
virtual void SetEnvironmentAmount (const Audio::TAudioEnvironmentID environmentID, float amount, const AZStd::string *jointName=nullptr)=0
 Set an Environment amount on a joint proxy. If a joint name is provided, only set on provided joint. Otherwise, set on all joints.
 

Static Public Attributes

static const AZ::EBusHandlerPolicy HandlerPolicy = AZ::EBusHandlerPolicy::Single
 

Detailed Description

EMotionFX Anim Audio Component Request Bus Used for making requests to the EMotionFX Anim Audio Components.

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