Creates an additional audio object managed by this component, allowing individual handling of effects IEntityAudioComponent will always create an audio object by default where audio will be played unless otherwise specified.

Executes the specified trigger on the entity

Parameters

audioTriggerId	The trigger we want to execute
audioAuxObjectId	Audio object within the component that we want to set, see IEntityAudioComponent::CreateAudioAuxObject. If not provided it is played on the default object.

#include 

// Simple example of how an audio trigger can be executed using IEntityAudioComponent 
void ExecuteTrigger(IEntity& entity)
{
    // Get the internal identifier for the trigger, computed at compile-time.
    // Note that the trigger itself is created by the Audio Controls Editor (ACE).
    constexpr CryAudio::ControlId triggerIdentifier = CryAudio::StringToId("MyTrigger");
    
    // Query whether an IEntityAudioComponent instance exists in the entity, if not create it.
    if (IEntityAudioComponent* pAudioComponent = entity.GetOrCreateComponent())
    {
        // Now execute the trigger on the entity, playing back anything contained within on the entities current transformation.
        pAudioComponent->ExecuteTrigger(triggerIdentifier);
    }
}

Sets the value of the specified parameter on the entity

Parameters

parameterId	Identifier of the parameter we want to modify the value of
audioAuxObjectId	Audio object within the component that we want to set, see IEntityAudioComponent::CreateAudioAuxObject. If not provided it is played on the default object.

#include 

void SetParameterValue(IEntity& entity)
{
    // Get the internal identifier for the parameter, computed at compile-time.
    // Note that the parameter itself is created by the Audio Controls Editor (ACE).
    constexpr CryAudio::ControlId parameterIdentifier = CryAudio::StringToId("MyParameter");
    // The new value of the parameter that we want to set.
    const float newParameterValue = 5.0f;

    // Query whether an IEntityAudioComponent instance exists in the entity, if not create it.
    if (IEntityAudioComponent* pAudioComponent = entity.GetOrCreateComponent())
    {
        // Now set the new value of the parameter, affecting any triggers being executed now or in the future.
        pAudioComponent->SetParameter(parameterIdentifier, newParameterValue);
    }
}

Sets the current state of a switch in the entity

Parameters

audioSwitchId	Identifier of the switch whose state we want to change
audioStateId	Identifier of the switch state we want to set to
audioAuxObjectId	Audio object within the component that we want to set, see IEntityAudioComponent::CreateAudioAuxObject. If not provided it is played on the default object.

#include 

void SetSwitchState(IEntity& entity)
{
    // Get the internal identifier for the switch, computed at compile-time.
    constexpr CryAudio::ControlId switchIdentifier = CryAudio::StringToId("MySwitch");
    // In addition, we need to get the identifier for any state we want to set on the switch as well.
    // Note that the switch and its states are created by the Audio Controls Editor (ACE) tool in the Editor. 
    constexpr CryAudio::SwitchStateId switchStateIdentifier = CryAudio::StringToId("MySwitchState");

    // Query whether an IEntityAudioComponent instance exists in the entity, if not create it.
    if (IEntityAudioComponent* pAudioComponent = entity.GetOrCreateComponent())
    {
        // Now set the new state of the switch, affecting any triggers being executed now or in the future.
        pAudioComponent->SetSwitchState(switchIdentifier, switchStateIdentifier);
    }
}