Version
menu_open
Warning: you were redirected to the latest documentation corresponding to your major release ( 2023.1.8.8601 ). Should you wish to access your specific version's documentation, please download the offline documentation from the Audiokinetic Launcher and check the Offline Documentation option in Wwise Authoring.
Wwise SDK 2023.1.8

◆ SetGameObjectToPortalObstruction()

AKSOUNDENGINE_API AKRESULT AK::SpatialAudio::SetGameObjectToPortalObstruction ( AkGameObjectID  in_gameObjectID,
AkPortalID  in_PortalID,
AkReal32  in_fObstruction 
)

Set the obstruction value of the path between a game object and a portal that has been created by Spatial Audio. The obstruction value is applied on one of the path segments of the sound between the emitter and the listener. Diffraction must be enabled on the sound for a diffraction path to be created. Also, there should not be any portals between the provided game object and portal ID parameters. The obstruction value is used to simulate objects between the portal and the game object that are obstructing the sound. Send an obstruction value of 0 to ensure the value is removed from the internal data structure.

See also
Parameters
in_gameObjectIDGame object ID
in_PortalIDPortal ID
in_fObstructionObstruction value. Valid range 0.f-1.f

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