Version

menu_open
Wwise SDK 2023.1.4

◆ GetMaxRadius() [1/2]

AKSOUNDENGINE_API AkReal32 AK::SoundEngine::Query::GetMaxRadius ( AkGameObjectID  in_GameObjId)

Returns the maximum distance used in attenuations associated to sounds playing using the specified game object. This may be used for example by the game to know if some processing need to be performed on the game side, that would not be required if the object is out of reach anyway.

Note: The returned value is NOT the distance from a listener to an object but the maximum attenuation distance of all sounds playing on this object.
Returns
  • A negative number if the game object specified is not playing.
  • 0, if the game object was only associated to sounds playing using no distance attenuation.
  • A positive number represents the maximum of all the distance attenuations playing on this game object.
Note: The Scaling factor (if one was specified on the game object) is included in the return value. The Scaling factor is not updated once a sound starts playing since it is computed only when the playback starts with the initial scaling factor of this game object. Scaling factor will be re-computed for every playback instance, always using the scaling factor available at this time.
See also
Parameters
in_GameObjIdGame object ID

Was this page helpful?

Need Support?

Questions? Problems? Need more info? Contact us, and we can help!

Visit our Support page

Tell us about your project. We're here to help.

Register your project and we'll help you get started with no strings attached!

Get started with Wwise