Version
menu_open
Wwise SDK 2023.1.8

◆ UnregisterGameObj()

AKSOUNDENGINE_API AKRESULT AK::SoundEngine::UnregisterGameObj ( AkGameObjectID  in_gameObjectID)

Unregisters a game object.

Returns
  • AK_Success if successful
  • AK_InvalidParameter if the specified AkGameObjectID is invalid. Range 0xFFFFFFFFFFFFFFE0 (-32) to 0xFFFFFFFFFFFFFFFF (-1) are invalid inclusively.
Remarks
Registering a game object twice does nothing. Unregistering it once unregisters it no matter how many times it has been registered. Unregistering a game object while it is in use is allowed, but the control over the parameters of this game object is lost. For example, say a sound associated with this game object is a 3D moving sound. This sound will stop moving when the game object is unregistered, and there will be no way to regain control over the game object.
See also
Parameters
in_gameObjectIDID of the game object to be unregistered. Valid range is [0 to 0xFFFFFFFFFFFFFFDF]. Use AK_INVALID_GAME_OBJECT to unregister all game objects.

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